pax_global_header00006660000000000000000000000064146710201630014512gustar00rootroot0000000000000052 comment=aea1245e8ebc0d9480707717ea58766ee329a3a7 minijks-1.2.0/000077500000000000000000000000001467102016300131565ustar00rootroot00000000000000minijks-1.2.0/.gitignore000066400000000000000000000000441467102016300151440ustar00rootroot00000000000000# don't add the executable /minijks minijks-1.2.0/COPYING000066400000000000000000001045131467102016300142150ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . minijks-1.2.0/LICENSE000066400000000000000000000020621467102016300141630ustar00rootroot00000000000000MIT License Copyright (c) 2022 Laurence Withers. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. minijks-1.2.0/README.md000066400000000000000000000120771467102016300144440ustar00rootroot00000000000000# minijks Java keytool replacement This is a replacement for the Java `keytool` program that manipulates `.jks` (Java keystore) files. Its purpose is to reduce the pain of DevOps burdened by Java deployments. ## Usage To install: ``` go get github.com/lwithers/minijks ``` Simply running the `minijks` command with no arguments produces a usage screen. To inspect the content of a `.jks` file: ``` $ minijks inspect my.jks # … shows certificates $ minijks inspect --password foo my.jks # … shows certificates, verifies the digest, shows keys encrypted with the common password ``` To unpack a `.jks` file: ``` $ minijks unpack --password foo --key-password server:bar my.jks $ tree my.jks.d my.jks.d/ ├── certs │   └── ca.pem ├── keys │   └── server │   ├── cert-0001.pem │   ├── cert-0002.pem │   └── privkey.pem └── password 3 directories, 5 files ``` ### Inspect The `inspect` command will show details about the certificates and possibly the private keys embedded in the `.jks` file. Without a password, the tool is able to display all the certificates and can show which private keys are in the file (alias, timestamp, and associated certificate chain), but it cannot decrypt the private keys to inspect them or verify the integrity digest over the file. If the keystore password is given, then the integrity digest can be verified. Furthermore, this password will be used to attempt to decrypt each private key embedded in the file. It is possible that one or more keys were encrypted using different passwords; in that case, the `--key-password ` option may be used. ### Unpack The `unpack` command will unpack each certificate (and private key if the password is given) into a directory tree. It could be considered similar to a `tar x` operation. The output directory name is derived by taking the source filename and adding a `.d` onto the end. If the directory already exists the command will refuse to run. The directory tree format is suitable for use with the `pack` command. ### Pack The `pack` command will pack a directory tree into a `.jks` file. It takes two arguments: the name of the input directory, and the name of the output file. It could be considered similar to a `tar c` operation. TODO: explain directory format. ### Pack key file The `keyfile` command will pack a single private key and associated certificate chain into a `.jks` file. It takes two or more arguments: the name of the output file, and then one or more `.pem` input files. The certificates are packed in the order they are named on the command line, and then the order they appear in the input file(s). The first certificate (leaf certificate) is expected to match the private key. This command is a shortcut to packing a `.jks` file containing a single client or server keypair. ## TODO list Pull requests accepted! - OpenJDK appears to have a second key encryption algorithm available for private keys using 3DES. This needs to be implemented for decryption purposes. - Validation hints: - Check that certificate entries are valid CA certificates (intermediate or otherwise). - Check private key certificate chains have correct corresponding public key, correct order, and do not include the final root CA. - Write clear file format specifications in a document. - Testcases! I have some internal ones but they're not data I can share, so it would be good to gather some real-world examples and check that we can process them correctly. - Unit tests for the functions would be good. - PKCS#8 library: either find an existing one and extend it with the algorithms we need for Java, or write a new one. - Programmable mode? Auto-generate a new .jks file based on a set of instructions. ## References ### Keystore format The `.jks` file format doesn't appear to be explicitly documented, but the OpenJDK source is clear enough. It has a comment giving the file structure as well as code for parsing and creating `.jks` files: - http://hg.openjdk.java.net/jdk8/jdk8/jdk/file/687fd7c7986d/src/share/classes/sun/security/provider/JavaKeyStore.java#l492 ### PKCS#8 Private keys are wrapped in PKCS#8, which is actually incredibly simple. It's an ASN.1 object that has an algorithm OID followed by a blob of encrypted data. Details in RFC5208 §6: - https://tools.ietf.org/html/rfc5208#section-6 ### Key encryption type 1 There appear to be two types of encryption that can be used to encrypt the private keys. One of them seems to be custom crypto (you should *never* do this): - identified by algorithm OID 1.3.6.1.4.1.42.2.17.1.1 - http://hg.openjdk.java.net/jdk8/jdk8/jdk/file/687fd7c7986d/src/share/classes/com/sun/crypto/provider/KeyProtector.java#l192 ### Key encryption type 2 Another type of encryption used to encrypt private keys. This might be specific to OpenJDK. It appears to be a custom combination of existing algorithms: - identified by algorithm OID 1.3.6.1.4.1.42.2.19.1 - http://hg.openjdk.java.net/jdk8/jdk8/jdk/file/687fd7c7986d/src/share/classes/com/sun/crypto/provider/PBEWithMD5AndTripleDESCipher.java minijks-1.2.0/go.mod000066400000000000000000000004311467102016300142620ustar00rootroot00000000000000module github.com/lwithers/minijks go 1.23 require github.com/urfave/cli/v2 v2.27.4 require ( github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect ) minijks-1.2.0/go.sum000066400000000000000000000034161467102016300143150ustar00rootroot00000000000000github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= github.com/cpuguy83/go-md2man/v2 v2.0.1 h1:r/myEWzV9lfsM1tFLgDyu0atFtJ1fXn261LKYj/3DxU= github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4= github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M= github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= github.com/urfave/cli/v2 v2.27.4 h1:o1owoI+02Eb+K107p27wEX9Bb8eqIoZCfLXloLUSWJ8= github.com/urfave/cli/v2 v2.27.4/go.mod h1:m4QzxcD2qpra4z7WhzEGn74WZLViBnMpb1ToCAKdGRQ= github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4= github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= minijks-1.2.0/inspect.go000066400000000000000000000130551467102016300151560ustar00rootroot00000000000000package main import ( "crypto/ecdsa" "crypto/rsa" "errors" "fmt" "io/ioutil" "strings" "time" "github.com/lwithers/minijks/jks" "github.com/urfave/cli/v2" ) func addJksOptsFlags(in []cli.Flag) []cli.Flag { return append(in, &cli.StringFlag{ Name: "password", Usage: "keystore password", }, &cli.StringSliceFlag{ Name: "key-password", Usage: "password for a given key, as 'alias:password'", }, ) } func jksOptsFlags(c *cli.Context) (*jks.Options, error) { opts := &jks.Options{ KeyPasswords: make(map[string]string), } if c.IsSet("password") { opts.Password = c.String("password") } else { opts.SkipVerifyDigest = true } for _, keypass := range c.StringSlice("key-password") { p := strings.Split(keypass, ":") if len(p) != 2 { return nil, errors.New("invalid --key-password argument") } opts.KeyPasswords[p[0]] = p[1] } return opts, nil } var InspectCommand = &cli.Command{ Name: "inspect", Usage: "inspect the contents of a keystore file", ArgsUsage: "keystore.jks", Action: Inspect, } func init() { InspectCommand.Flags = addJksOptsFlags(InspectCommand.Flags) } func Inspect(c *cli.Context) error { switch c.NArg() { case 0: cli.ShowSubcommandHelp(c) return errors.New("need name of file to inspect") case 1: // OK default: return errors.New("can only inspect one file") } opts, err := jksOptsFlags(c) if err != nil { return err } return inspect(opts, c.Args().Get(0)) } func inspect(opts *jks.Options, filename string) error { fmt.Printf("======== %s ========\n", filename) raw, err := ioutil.ReadFile(filename) if err != nil { return err } ks, err := jks.Parse(raw, opts) // any error will be returned below, after printing anything from ks if ks != nil { for i, cert := range ks.Certs { fmt.Printf("---- certificate #%d ----\n", i+1) inspectCert(cert) fmt.Println("") } for i, kp := range ks.Keypairs { fmt.Printf("---- keypair #%d ----\n", i+1) inspectKeypair(kp) fmt.Println("") } } return err // error from jks.Parse } func inspectCert(cert *jks.Cert) { c := cert.Cert fmt.Printf("Alias:\t\t%q\n", cert.Alias) fmt.Printf("Timestamp:\t%s\n", cert.Timestamp.Format(time.RFC3339Nano)) if cert.CertErr != nil { fmt.Println("Unable to parse certificate:") fmt.Printf(" Error:\t%v\n", cert.CertErr) fmt.Printf(" Length:\t%d bytes\n", len(cert.Raw)) return } fmt.Printf("Common name:\t%q\n", c.Subject.CommonName) if len(c.SubjectKeyId) != 0 { fmt.Printf("Subject key ID:\t%X\n", c.SubjectKeyId) } // in theory, we should only really have self-signed certs if err := c.CheckSignatureFrom(c); err != nil { fmt.Println("Not self-signed:") fmt.Printf(" Verify error:\t%v\n", err) fmt.Printf(" Issuer name:\t%q\n", c.Issuer.CommonName) if len(c.AuthorityKeyId) != 0 { fmt.Printf(" Issuer key ID:\t%X\n", c.AuthorityKeyId) } } fmt.Println("Validity:") fmt.Printf(" From:\t%s\n", c.NotBefore.Format(time.RFC3339Nano)) fmt.Printf(" Until:\t%s\n", c.NotAfter.Format(time.RFC3339Nano)) inspectPublicKey("", c.PublicKey) // because intended usage is that certs should be root CAs, we don't // print any extra info like key usage, basic constraints or SANs } func inspectPublicKey(pfx string, pub interface{}) { fmt.Printf("%sPublic key:\n", pfx) switch pub := pub.(type) { case *rsa.PublicKey: fmt.Printf("%s Type:\tRSA\n", pfx) fmt.Printf("%s Size:\t%d bits\n", pfx, pub.N.BitLen()) case *ecdsa.PublicKey: fmt.Printf("%s Type:\tEC\n", pfx) fmt.Printf("%s Size:\t%d bits\n", pfx, pub.Params().BitSize) fmt.Printf("%s Curve:\t%s\n", pfx, pub.Params().Name) default: fmt.Printf("%s Unknown type:\t%T\n", pfx, pub) } } func inspectKeypair(kp *jks.Keypair) { fmt.Printf("Alias:\t\t%q\n", kp.Alias) fmt.Printf("Timestamp:\t%s\n", kp.Timestamp.Format(time.RFC3339Nano)) if kp.PrivKeyErr != nil { fmt.Println("Unable to parse private key (wrong password?):") fmt.Printf(" Error:\t%v\n", kp.PrivKeyErr) fmt.Printf(" Ciphertext:\t%d bytes\n", len(kp.EncryptedKey)) if len(kp.RawKey) == 0 { fmt.Println(" Failed to decrypt ciphertext") } else { fmt.Printf(" Plaintext:\t%d bytes\n", len(kp.RawKey)) } } else { inspectPrivateKey(kp.PrivateKey) } if len(kp.CertChain) == 0 { fmt.Println("No certificates present!") } for i, cert := range kp.CertChain { fmt.Printf(" ---- certificate #%d ----\n", i+1) if cert.CertErr != nil { fmt.Printf("\tParse error:\t%v\n", cert.CertErr) fmt.Printf("\tRaw length:\t%d bytes\n", len(cert.Raw)) continue } c := cert.Cert fmt.Printf(" Common name:\t%q\n", c.Subject.CommonName) if len(c.SubjectKeyId) != 0 { fmt.Printf(" Subject key ID:\t%X\n", c.SubjectKeyId) } fmt.Println(" Validity:") fmt.Printf("\tFrom:\t%s\n", c.NotBefore.Format(time.RFC3339Nano)) fmt.Printf("\tUntil:\t%s\n", c.NotAfter.Format(time.RFC3339Nano)) fmt.Println(" Subject alternate names:") for i, name := range c.DNSNames { fmt.Printf("\tDNS #%d:\t%s\n", i+1, name) } for i, ip := range c.IPAddresses { fmt.Printf("\tIP #%d:\t%s\n", i+1, ip) } inspectPublicKey(" ", c.PublicKey) } } func inspectPrivateKey(priv interface{}) { fmt.Println("Private key:") switch priv := priv.(type) { case *rsa.PrivateKey: fmt.Println(" Type:\tRSA") fmt.Printf(" Size:\t%d bits\n", priv.N.BitLen()) case *ecdsa.PrivateKey: fmt.Println(" Type:\tEC") fmt.Printf(" Size:\t%d bits\n", priv.Params().BitSize) fmt.Printf(" Curve:\t%s\n", priv.Params().Name) default: fmt.Printf(" Unknown type:\t%T\n", priv) } } minijks-1.2.0/jks/000077500000000000000000000000001467102016300137455ustar00rootroot00000000000000minijks-1.2.0/jks/jks.go000066400000000000000000000117601467102016300150700ustar00rootroot00000000000000/* Package jks provides routines for manipulating Java Keystore files. */ package jks import ( "crypto/sha1" "crypto/x509" "time" "unicode/utf16" ) const ( // MagicNumber is written at the start of each .jks file. MagicNumber uint32 = 0xFEEDFEED // DigestSeparator is used to build the file's verification digest. The // digest is over the keystore password encoded as UTF-16, then this // string (yes, really — check the OpenJDK source) encoded as UTF-8, and // then the actual file data. DigestSeparator = "Mighty Aphrodite" // CertType is the certificate type string that is encoded into each // certificate's header in the keystore. CertType = "X.509" ) // Keystore represents a single JKS file. It holds a list of certificates and a // list of keypairs (private keys with associated certificate chains). type Keystore struct { // Certs is a list of CA certificates to trust. It may contain either // root or intermediate CA certificates. It should not contain end-user // certificates. Certs []*Cert // Keypairs is a list of private keys. Each key may have a certificate // chain associated with it. Keypairs []*Keypair } // Options for manipulating a keystore. These allow the caller to specify the // password(s) used, or to skip the digest verification if the password is // unknown. type Options struct { // Password is used as part of a SHA-1 digest over the .jks file. Password string // SkipVerifyDigest can be set to skip digest verification when loading // a keystore file. This will inhibit errors from Parse if you don't // know the password. SkipVerifyDigest bool // KeyPasswords are used to generate the "encryption" keys for stored // private keys. The map's key is the alias of the private key, and the // value is the password. If there is no entry in the map for a given // alias, then the top-level Password is inherited. Empty strings are // interpreted as an empty password, so use delete() if you truly want // to delete values. KeyPasswords map[string]string } // Cert holds a certificate to trust. type Cert struct { // Alias is a name used to refer to this certificate. Alias string // Timestamp records when this record was created. Timestamp time.Time // Raw is the raw X.509 certificate marshalled in DER form. Raw []byte // CertErr is set if there is an error parsing the certificate. CertErr error // Cert is the parsed X.509 certificate. Cert *x509.Certificate } // Keypair holds a private key and an associated certificate chain. type Keypair struct { // Alias is a name used to refer to this keypair. Alias string // Timestamp records when this record was created. Timestamp time.Time // PrivKeyErr is set if an error is encountered during decryption or // unmarshalling of the decrypted key. PrivKeyErr error // EncryptedKey is the raw PKCS#8 marshalled EncryptedPrivateKeyInfo. EncryptedKey []byte // RawKey is the raw PKCS#8 marshalled PrivateKeyInfo, after it has // been decrypted. It will not have been set if decryption failed. RawKey []byte // PrivateKey is the unmarshalled private key. It will not have been // set if decryption failed or if unmarshalling failed. PrivateKey interface{} // CertChain is a chain of certificates associated with the private key. // The first entry in the chain (index 0) should correspond to // PrivateKey; there should then follow any intermediate CAs. In // general the root CA should not be part of the chain. CertChain []*KeypairCert } // KeypairCert is an entry in the certificate chain associated with a Keypair. type KeypairCert struct { // Raw X.509 certificate data (in DER form). Raw []byte // Cert is the parsed X.509 certificate. It is nil if the certificate // could not be parsed. Cert *x509.Certificate // CertErr records any error encountered while parsing a certificate. CertErr error } var defaultOptions = Options{ SkipVerifyDigest: true, } // ComputeDigest performs the custom hash function over the given file data. // DO NOT RE-USE THIS CODE: this is an atrocious way to perform message // authentication. Use the HMAC example from // https://github.com/lwithers/go-crypto-examples instead. Note this construct // is vulnerable to a length extension attack, which is actually exploitable if // the JKS reader code does not properly check the "number of entries" value. func ComputeDigest(raw []byte, passwd string) []byte { // compute SHA-1 digest over the construct: // UTF-16(password) + UTF-8(DigestSeparator) + raw md := sha1.New() p := PasswordUTF16(passwd) md.Write(p) md.Write([]byte(DigestSeparator)) md.Write(raw) return md.Sum(nil) } // PasswordUTF16 returns a password encoded in UTF-16, big-endian byte order. func PasswordUTF16(passwd string) []byte { var u []byte for _, r := range passwd { if r < 0x10000 { u = append(u, byte((r>>8)&0xFF)) u = append(u, byte(r&0xFF)) } else { r1, r2 := utf16.EncodeRune(r) u = append(u, byte((r1>>8)&0xFF)) u = append(u, byte(r1&0xFF)) u = append(u, byte((r2>>8)&0xFF)) u = append(u, byte(r2&0xFF)) } } return u } minijks-1.2.0/jks/jks_test.go000066400000000000000000000037231467102016300161270ustar00rootroot00000000000000package jks import ( "bytes" "encoding/binary" "encoding/hex" "testing" "unicode/utf16" ) // TestComputeDigest is a regression test for the digest function. func TestComputeDigest(t *testing.T) { t.Run("empty", testComputeDigest("", "", "569D05A766C473698C0B58EBAEAE0A25EB10BACC")) t.Run("regr", testComputeDigest("input data", "password", "74DDD13B68919674D4409A19AB284019A1DA57C8")) } func testComputeDigest(in, passwd, expHex string) func(*testing.T) { return func(t *testing.T) { exp, err := hex.DecodeString(expHex) if err != nil { t.Fatalf("error decoding expHex: %v", err) } out := ComputeDigest([]byte(in), passwd) if !bytes.Equal(out, exp) { t.Errorf("output sequence (len %d) ≠ expected", len(out)) t.Errorf("out %X", out) } } } // TestPasswordUTF16 checks that our UTF-16 encoding routine works as expected. // The test cases incorporate empty strings and Unicode strings with characters // outside the BMP (basic multilingual plane), i.e. ones that need encoding as // UTF-16 surrogate pairs. func TestPasswordUTF16(t *testing.T) { t.Run("empty", testPasswordBytes("", nil)) t.Run("ascii-1", testPasswordBytes("ascii", []byte{0, 'a', 0, 's', 0, 'c', 0, 'i', 0, 'i'})) t.Run("ascii-2", testPasswordUTF16("ascii")) t.Run("utf8", testPasswordUTF16("a≤b")) t.Run("surrogate", testPasswordUTF16("z1\U00016000\u2340•—@.µ")) } func testPasswordBytes(in string, exp []byte) func(*testing.T) { return func(t *testing.T) { out := PasswordUTF16(in) if !bytes.Equal(out, exp) { t.Errorf("output sequence ‘%X’ ≠ expected ‘%X’", out, exp) } } } func testPasswordUTF16(in string) func(*testing.T) { return func(t *testing.T) { out := PasswordUTF16(in) expStr := utf16.Encode([]rune(in)) exp := make([]byte, len(expStr)*2) for i, v := range expStr { binary.BigEndian.PutUint16(exp[i*2:], v) } if !bytes.Equal(out, exp) { t.Errorf("output sequence ‘%X’ ≠ expected ‘%X’", out, exp) } } } minijks-1.2.0/jks/pkcs8.go000066400000000000000000000210161467102016300153240ustar00rootroot00000000000000package jks import ( "bytes" "crypto/ecdsa" "crypto/rand" "crypto/rsa" "crypto/sha1" "crypto/x509" "crypto/x509/pkix" "encoding/asn1" "errors" "fmt" ) var ( // JavaKeyEncryptionOID1 is the object identifier for one type of // password-based encryption used in .jks files. JavaKeyEncryptionOID1 = asn1.ObjectIdentifier{ 1, 3, 6, 1, 4, 1, 42, 2, 17, 1, 1, } // JavaKeyEncryptionOID2 is the object identifier for one type of // password-based encryption used in .jks files. JavaKeyEncryptionOID2 = asn1.ObjectIdentifier{ 1, 3, 6, 1, 4, 1, 42, 2, 19, 1, } // RFC 3279 § 2.3 oidPublicKeyRSA = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 1} // RFC 5480 § 2.1.1 oidPublicKeyECDSA = asn1.ObjectIdentifier{1, 2, 840, 10045, 2, 1} oidNamedCurveP224 = asn1.ObjectIdentifier{1, 3, 132, 0, 33} oidNamedCurveP256 = asn1.ObjectIdentifier{1, 2, 840, 10045, 3, 1, 7} oidNamedCurveP384 = asn1.ObjectIdentifier{1, 3, 132, 0, 34} oidNamedCurveP521 = asn1.ObjectIdentifier{1, 3, 132, 0, 35} // Java appears to want unused parameters structures encoded as an // ASN.1 NULL type. asn1NULL = asn1.RawValue{ FullBytes: []byte{0x05, 0x00}, } ) // EncryptedPrivateKeyInfo is the ASN.1 structure used to hold an encrypted // private key. It is defined in RFC 5208 § 6: // https://tools.ietf.org/html/rfc5208#section-6 type EncryptedPrivateKeyInfo struct { // Algo identifies the encryption algorithm (and any associated // parameters) used to encrypt EncryptedData. Algo pkix.AlgorithmIdentifier // EncryptedData is an encrypted, marshalled PrivateKeyInfo. EncryptedData []byte } // PrivateKeyInfo is the ASN.1 structure used to hold a private key. It is // defined in RFC 52080 § 5: // https://tools.ietf.org/html/rfc5208#section-5 type PrivateKeyInfo struct { // Version of structure. Should be zero. Version int // Algo denotes the private key algorithm (e.g. RSA). Algo pkix.AlgorithmIdentifier // PrivateKey is the marshalled private key. It should be interpreted // according to Algo. PrivateKey []byte } // DecryptPKCS8 decrypts a PKCS#8 EncryptedPrivateKeyInfo, presumably returning // a marshalled PrivateKeyInfo structure. It only knows how to handle the two // encryption algorithms that are used by the Java keytool program. func DecryptPKCS8(raw []byte, password string) ([]byte, error) { // unmarshal the ASN.1 structure, ensure there's no trailing data var keyInfo EncryptedPrivateKeyInfo rest, err := asn1.Unmarshal(raw, &keyInfo) if err != nil { // asn1 package errors are not actually that helpful return nil, errors.New("malformed PKCS#8 private key structure") } if len(rest) != 0 { return nil, errors.New("trailing data after PKCS#8 private key") } switch { case keyInfo.Algo.Algorithm.Equal(JavaKeyEncryptionOID1): // this algorithm doesn't have any parameters if len(keyInfo.Algo.Parameters.Bytes) != 0 { return nil, errors.New("unexpected algorithm " + "params present") } return DecryptJavaKeyEncryption1(keyInfo.EncryptedData, password) case keyInfo.Algo.Algorithm.Equal(JavaKeyEncryptionOID2): // TODO: need to implement this return nil, errors.New("not implemented yet") default: return nil, fmt.Errorf("unhandled encryption algorithm %v", keyInfo.Algo.Algorithm) } } // MarshalPKCS8 marshals an RSA or EC private key into an (unencrypted) // PKCS#8 PrivateKeyInfo structure. It returns the DER-encoded structure. func MarshalPKCS8(key interface{}) ([]byte, error) { var ki PrivateKeyInfo switch key := key.(type) { case *rsa.PrivateKey: // we simply put the PKCS#1-encoded key into a wrapper that // says it's an RSA key ki.Algo = pkix.AlgorithmIdentifier{ Algorithm: oidPublicKeyRSA, Parameters: asn1NULL, } ki.PrivateKey = x509.MarshalPKCS1PrivateKey(key) case *ecdsa.PrivateKey: // the PKCS#8 wrapper (PrivateKeyInfo) has algorithm set to // identify the elliptic curve key, but needs a parameter to // state the curve. c, err := oidFromNamedCurve(key) if err != nil { return nil, err } ki.Algo = pkix.AlgorithmIdentifier{ Algorithm: oidPublicKeyECDSA, } ki.Algo.Parameters.FullBytes, err = asn1.Marshal(c) if err != nil { return nil, fmt.Errorf("marshal EC private key "+ "params: %v", err) } ki.PrivateKey, err = x509.MarshalECPrivateKey(key) if err != nil { return nil, fmt.Errorf("marshal EC private key: %v", err) } default: return nil, fmt.Errorf("unhandled private key type %T", key) } raw, err := asn1.Marshal(ki) if err != nil { return nil, fmt.Errorf("marshal PrivateKeyInfo: %v", err) } return raw, nil } // oidFromNamedCurve returns an OID which identifies the curve used in the // given key. func oidFromNamedCurve(key *ecdsa.PrivateKey) (asn1.ObjectIdentifier, error) { switch key.Params().Name { case "P-224": return oidNamedCurveP224, nil case "P-256": return oidNamedCurveP256, nil case "P-384": return oidNamedCurveP384, nil case "P-521": return oidNamedCurveP521, nil } return nil, fmt.Errorf("unknown named curve %q", key.Params().Name) } // DecryptJavaKeyEncryption1 decrypts ciphertext encrypted with one of the Java // key encryption algorithms. // // PLEASE NOTE: this appears to be custom crypto. You should *never* do this. DO // NOT RE-USE THIS CODE. If you want an example of how to encrypt a blob of data // or a file with a password, then see the password-encrypt example at: // https://github.com/lwithers/go-crypto-examples func DecryptJavaKeyEncryption1(ciphertext []byte, password string, ) ([]byte, error) { // split the blob into salt:ciphertext:digest if len(ciphertext) <= 40 { return nil, errors.New("not enough data for encryption type 1") } salt := ciphertext[:20] digest := ciphertext[len(ciphertext)-20:] ciphertext = ciphertext[20 : len(ciphertext)-20] // XOR the SHA-1-derived bytestream with the "ciphertext" to recover // the plaintext passwd := PasswordUTF16(password) xorStream := xorStreamForJavaKeyEncryption1(len(ciphertext), passwd, salt) plaintext := make([]byte, len(ciphertext)) for i := range ciphertext { plaintext[i] = ciphertext[i] ^ xorStream[i] } // test that the SHA-1 hash over (passwd+plaintext) matches the recorded // digest md := sha1.New() md.Write(passwd) md.Write(plaintext) computed := md.Sum(nil) if !bytes.Equal(computed, digest) { return nil, errors.New("invalid password") } return plaintext, nil } // EncryptJavaKeyEncryption1 encrypts plaintext with one of the Java key // encryption algorithms. // // PLEASE NOTE: this appears to be custom crypto. You should *never* do this. DO // NOT RE-USE THIS CODE. If you want an example of how to encrypt a blob of data // or a file with a password, then see the password-encrypt example at: // https://github.com/lwithers/go-crypto-examples func EncryptJavaKeyEncryption1(plaintext []byte, password string, ) ([]byte, error) { // generate a salt var salt [20]byte if _, err := rand.Read(salt[:]); err != nil { return nil, err } // XOR the SHA-1-derived bytestream with the plaintext to derive the // "ciphertext" passwd := PasswordUTF16(password) xorStream := xorStreamForJavaKeyEncryption1(len(plaintext), passwd, salt[:]) ciphertext := make([]byte, len(plaintext)) for i := range ciphertext { ciphertext[i] = plaintext[i] ^ xorStream[i] } // compute the SHA-1 hash over (passwd+plaintext) md := sha1.New() md.Write(passwd) md.Write(plaintext) digest := md.Sum(nil) // return salt:ciphertext:digest result := make([]byte, 0, len(salt)+len(ciphertext)+len(digest)) result = append(result, salt[:]...) result = append(result, ciphertext...) result = append(result, digest...) return result, nil } // xorStreamForJavaKeyEncryption1 returns a stream of bytes that is XORed with // the plaintext to produce the ciphertext. We iteratively use a SHA-1 hash // over (passwd+lastHash) to produce a stream of bytes we then XOR with the // "ciphertext". For the first block we use ‘salt’ in place of ‘last_hash’. // // PLEASE NOTE: this appears to be custom crypto. You should *never* do this. DO // NOT RE-USE THIS CODE. If you want an example of how to encrypt a blob of data // or a file with a password, then see the password-encrypt example at: // https://github.com/lwithers/go-crypto-examples func xorStreamForJavaKeyEncryption1(strlen int, passwd, salt []byte) []byte { xorStream := make([]byte, strlen) wrXor := xorStream lastHash := make([]byte, 20) copy(lastHash, salt) for len(wrXor) > 0 { md := sha1.New() md.Write(passwd) md.Write(lastHash) lastHash = md.Sum(lastHash[:0]) copy(wrXor, lastHash) if len(wrXor) <= 20 { break } wrXor = wrXor[20:] } return xorStream } minijks-1.2.0/jks/pkcs8_test.go000066400000000000000000000017451467102016300163720ustar00rootroot00000000000000package jks import ( "crypto/ecdsa" "crypto/elliptic" "crypto/rand" "encoding/asn1" "testing" ) // TestOIDFromNamedCurve ensures that we return the correct OID identifying the // curve for ECDSA private keys. func TestOIDFromNamedCurve(t *testing.T) { t.Run("P-224", testOIDFromNamedCurve(oidNamedCurveP224, elliptic.P224())) t.Run("P-256", testOIDFromNamedCurve(oidNamedCurveP256, elliptic.P256())) t.Run("P-384", testOIDFromNamedCurve(oidNamedCurveP384, elliptic.P384())) t.Run("P-521", testOIDFromNamedCurve(oidNamedCurveP521, elliptic.P521())) } func testOIDFromNamedCurve(exp asn1.ObjectIdentifier, curve elliptic.Curve, ) func(*testing.T) { return func(t *testing.T) { k, err := ecdsa.GenerateKey(curve, rand.Reader) if err != nil { t.Fatalf("failed to generate key: %v", err) } oid, err := oidFromNamedCurve(k) switch { case err != nil: t.Errorf("could not find OID: %v", err) case !oid.Equal(exp): t.Errorf("OID %v ≠ expected %v", oid, exp) } } } minijks-1.2.0/jks/read.go000066400000000000000000000163231467102016300152140ustar00rootroot00000000000000/* Package jks provides routines for manipulating Java Keystore files. */ package jks import ( "bytes" "crypto/hmac" "crypto/x509" "encoding/binary" "errors" "fmt" "io" "time" ) // Parse a JKS file. If desired, opts may be specified to provide more control // over the parsing. If nil, then we will use an empty password when attempting // to decrypt keys and will not attempt to verify the digest stored in the file. // // Errors encountered when parsing a certificate, or decrypting or parsing a // private key, are stored within the returned Keystore structure. These do not // lead to the parse failing and will not be returned as an error by the top // level function. Unrecoverable errors (i.e. malformed file) will result in the // Parse function returning an error. If digest verification is requested and // the password or the digest is incorrect, an error will also be returned. If // any useful data has been extracted it will be returned as a partial Keystore. func Parse(raw []byte, opts *Options) (*Keystore, error) { if opts == nil { opts = &defaultOptions } buf := bytes.NewReader(raw) ks := new(Keystore) // read file header magic, _, err := readUint32(buf, "magic header") if err != nil { return nil, err } if magic != MagicNumber { return nil, fmt.Errorf("invalid magic; expected 0x%08X "+ "but got 0x%08X", MagicNumber, magic) } version, _, err := readUint32(buf, "file version") if err != nil { return nil, err } if version != 2 { return nil, fmt.Errorf("found version %d file, but expected "+ "version 2", version) } numEnts, _, err := readUint32(buf, "number of entries") if err != nil { return nil, err } // read each entry in turn for n := uint32(0); n < numEnts; n++ { etype, pos, err := readUint32(buf, "entry type") if err != nil { return ks, err } switch etype { case 1: // it's a private key + cert chain kp, err := readKeypair(buf, opts) if err != nil { return ks, err } ks.Keypairs = append(ks.Keypairs, kp) case 2: // it's a certificate cert, err := readCert(buf) if err != nil { return ks, err } ks.Certs = append(ks.Certs, cert) default: return nil, fmt.Errorf("unrecognised entry type %d "+ "at file position %d", etype, pos) } } switch { // there should be exactly 20 bytes left case buf.Len() != 20: return ks, errors.New("malformed digest at end of file") case opts.SkipVerifyDigest: return ks, nil default: digest := ComputeDigest(raw[:len(raw)-20], opts.Password) if !hmac.Equal(digest, raw[len(raw)-20:]) { return ks, errors.New("digest mismatch") } return ks, nil } } func readUint32(buf *bytes.Reader, desc string, ) (value uint32, offset int64, err error) { offset, _ = buf.Seek(0, io.SeekCurrent) if buf.Len() < 4 { return 0, offset, fmt.Errorf("unexpected EOF at position %d "+ "while reading %s", offset, desc) } var raw [4]byte _, _ = buf.Read(raw[:]) return binary.BigEndian.Uint32(raw[:]), offset, nil } func readUint64(buf *bytes.Reader, desc string, ) (value uint64, offset int64, err error) { offset, _ = buf.Seek(0, io.SeekCurrent) if buf.Len() < 8 { return 0, offset, fmt.Errorf("unexpected EOF at position %d "+ "while reading %s", offset, desc) } var raw [8]byte _, _ = buf.Read(raw[:]) return binary.BigEndian.Uint64(raw[:]), offset, nil } func readTimestamp(buf *bytes.Reader) (ts time.Time, offset int64, err error) { ums, offset, err := readUint64(buf, "timestamp") if err != nil { return time.Time{}, offset, err } ms := int64(ums) return time.Unix(ms/1000, (ms%1000)*1e6), offset, nil } func readStr(buf *bytes.Reader, desc string, ) (value string, offset int64, err error) { offset, _ = buf.Seek(0, io.SeekCurrent) if buf.Len() < 2 { return "", offset, fmt.Errorf("unexpected EOF at position %d "+ "while reading %s", offset, desc) } var raw [2]byte _, _ = buf.Read(raw[:]) strlen := binary.BigEndian.Uint16(raw[:]) if buf.Len() < 2 { return "", offset, fmt.Errorf("unexpected EOF at position %d "+ "while reading %s (stored length %d)", offset, desc, strlen) } str := make([]byte, strlen) _, _ = buf.Read(str) return string(str), offset, nil } func readCert(buf *bytes.Reader) (*Cert, error) { var ( offset int64 err error cert = new(Cert) ) cert.Alias, offset, err = readStr(buf, "certificate alias") if err != nil { return nil, err } cert.Timestamp, _, err = readTimestamp(buf) if err != nil { return nil, err } certType, _, err := readStr(buf, "certificate type") if certType != CertType { return nil, fmt.Errorf("unexpected certificate type at "+ "position %d; found %q, expected %q", offset, certType, CertType) } elen, _, err := readUint32(buf, "encoded certificate length") if err != nil { return nil, err } if buf.Len() < int(elen) { return nil, fmt.Errorf("not enough data to read "+ "certificate %q at position %d (length %d bytes)", cert.Alias, offset, elen) } cert.Raw = make([]byte, elen) _, _ = buf.Read(cert.Raw) cert.Cert, cert.CertErr = x509.ParseCertificate(cert.Raw) return cert, nil } func readKeypair(buf *bytes.Reader, opts *Options) (*Keypair, error) { var ( offset int64 err error certType string kp = new(Keypair) ) // retrive the key's alias, and use this to search for a password kp.Alias, offset, err = readStr(buf, "certificate alias") if err != nil { return nil, err } passwd, ok := opts.KeyPasswords[kp.Alias] if !ok { // no specific password for this alias, so use the file password passwd = opts.Password } kp.Timestamp, _, err = readTimestamp(buf) if err != nil { return nil, err } elen, _, err := readUint32(buf, "encrypted private key length") if err != nil { return nil, err } if buf.Len() < int(elen) { return nil, fmt.Errorf("not enough data to read "+ "private key %q at position %d (length %d bytes)", kp.Alias, offset, elen) } kp.EncryptedKey = make([]byte, elen) _, _ = buf.Read(kp.EncryptedKey) kp.RawKey, kp.PrivKeyErr = DecryptPKCS8(kp.EncryptedKey, passwd) if kp.PrivKeyErr == nil { // we should now have a PKCS#8 PrivateKeyInfo, which Go can // parse for us kp.PrivateKey, kp.PrivKeyErr = x509.ParsePKCS8PrivateKey( kp.RawKey) } ncerts, _, err := readUint32(buf, "length of certificate chain") if err != nil { return nil, err } for n := uint32(0); n < ncerts; n++ { certType, offset, err = readStr(buf, fmt.Sprintf( "certificate type (chain entry #%d for %q)", n+1, kp.Alias)) if err != nil { return nil, err } if certType != CertType { return nil, fmt.Errorf("unexpected certificate type "+ "%q (expected %q at position %d for chain "+ "entry #%d for %q)", certType, CertType, offset, n+1, kp.Alias) } elen, _, err = readUint32(buf, fmt.Sprintf( "encoded certificate length (chain entry #%d for %q)", n+1, kp.Alias)) if err != nil { return nil, err } if buf.Len() < int(elen) { return nil, fmt.Errorf("not enough data to read "+ "certificate chain entry #%d for %q at "+ "position %d (length %d bytes)", n+1, kp.Alias, offset, elen) } kpc := new(KeypairCert) kpc.Raw = make([]byte, elen) _, _ = buf.Read(kpc.Raw) kpc.Cert, kpc.CertErr = x509.ParseCertificate(kpc.Raw) kp.CertChain = append(kp.CertChain, kpc) } return kp, nil } minijks-1.2.0/jks/write.go000066400000000000000000000105601467102016300154300ustar00rootroot00000000000000package jks import ( "bytes" "crypto/x509/pkix" "encoding/asn1" "encoding/binary" "errors" "fmt" "io" "time" ) // Pack writes a JKS file. opts must be specified, and the SkipVerifyDigest // option will be ignored. The password will always be taken from opts, and if // it is an empty string then an empty string will be used for the password. // This function requires that all certificates and private keys are present, so // be sure to check this if you have obtained a Keystore using Parse(). Each // record should have a unique alias (not checked). If a record's Timestamp is // zero then the current system time will be queried and be used. func (ks *Keystore) Pack(opts *Options) ([]byte, error) { var buf bytes.Buffer writeUint32(&buf, MagicNumber) writeUint32(&buf, 2) // version writeUint32(&buf, uint32(len(ks.Certs)+len(ks.Keypairs))) for _, cert := range ks.Certs { if err := writeCert(&buf, cert); err != nil { return nil, err } } for _, kp := range ks.Keypairs { if err := writeKeypair(&buf, kp, opts); err != nil { return nil, err } } digest := ComputeDigest(buf.Bytes(), opts.Password) buf.Write(digest) return buf.Bytes(), nil } // writeCert writes out a certificate record. func writeCert(w io.Writer, cert *Cert) error { writeUint32(w, 2) // type = certificate if err := writeStr(w, cert.Alias); err != nil { return fmt.Errorf("failed to write alias (%v): %q", err, cert.Alias) } ts := cert.Timestamp if ts.IsZero() { ts = time.Now() } writeTimestamp(w, ts) if err := writeStr(w, CertType); err != nil { return fmt.Errorf("failed to write certificate type (%v)", err) } writeUint32(w, uint32(len(cert.Cert.Raw))) w.Write(cert.Cert.Raw) return nil } // writeKeypair writes out a private key and associated certificate chain. func writeKeypair(w io.Writer, kp *Keypair, opts *Options) error { writeUint32(w, 1) // type = private key + cert chain if err := writeStr(w, kp.Alias); err != nil { return fmt.Errorf("failed to write alias (%v): %q", err, kp.Alias) } // use specific key password if present, fall back to global passwd, ok := opts.KeyPasswords[kp.Alias] if !ok { passwd = opts.Password } ts := kp.Timestamp if ts.IsZero() { ts = time.Now() } writeTimestamp(w, ts) // marshal the key into ‘raw’ raw, err := MarshalPKCS8(kp.PrivateKey) if err != nil { return fmt.Errorf("key %q: %v", kp.Alias, err) } // encrypt the marshalled key, then wrap into a PKCS#8 // EncryptedPrivateKeyInfo structure ciphertext, err := EncryptJavaKeyEncryption1(raw, passwd) if err != nil { return fmt.Errorf("failed to marshal private key: %v", err) } keyInfo := EncryptedPrivateKeyInfo{ Algo: pkix.AlgorithmIdentifier{ Algorithm: JavaKeyEncryptionOID1, Parameters: asn1NULL, }, EncryptedData: ciphertext, } raw, err = asn1.Marshal(keyInfo) if err != nil { return fmt.Errorf("failed to marshal PKCS#8 encrypted "+ "private key info: %v", err) } writeUint32(w, uint32(len(raw))) w.Write(raw) // write out the certificate chain writeUint32(w, uint32(len(kp.CertChain))) for _, cert := range kp.CertChain { if err := writeStr(w, CertType); err != nil { return fmt.Errorf("failed to write certificate "+ "type (%v)", err) } writeUint32(w, uint32(len(cert.Cert.Raw))) w.Write(cert.Cert.Raw) } return nil } // writeUint32 writes a 32-bit unsigned integer in big-endian format. func writeUint32(w io.Writer, u uint32) { var raw [4]byte binary.BigEndian.PutUint32(raw[:], u) w.Write(raw[:]) } // writeUint64 writes a 64-bit unsigned integer in big-endian format. func writeUint64(w io.Writer, u uint64) { var raw [8]byte binary.BigEndian.PutUint64(raw[:], u) w.Write(raw[:]) } // writeTimestamp converts the timestamp to a 64-bit unsigned number (ms elapsed // since the Unix epoch) and writes it in big-endian format. func writeTimestamp(w io.Writer, ts time.Time) { ms := ts.UnixNano() / 1e6 writeUint64(w, uint64(ms)) } // writeStr writes a UTF-8 string. The string is encoded as an octet length // (16-bit unsigned big-endian integer) followed by the UTF-8 octets. This // function will return an error if there are too many octets to fit into the // 16-bit length field. func writeStr(w io.Writer, s string) error { if len(s) > 0xFFFF { return errors.New("string too long") } var raw [2]byte binary.BigEndian.PutUint16(raw[:], uint16(len(s))) w.Write(raw[:]) w.Write([]byte(s)) return nil } minijks-1.2.0/keyfile.go000066400000000000000000000046251467102016300151440ustar00rootroot00000000000000package main import ( "crypto/x509" "encoding/pem" "errors" "fmt" "os" "github.com/lwithers/minijks/jks" "github.com/urfave/cli/v2" ) var KeyfileCommand = &cli.Command{ Name: "keyfile", Usage: "pack a single keypair/cert chain into a keystore file", ArgsUsage: "out.jks in.pem [in2.pem ...]", Action: Keyfile, Flags: []cli.Flag{ &cli.StringFlag{ Name: "password", Required: true, Usage: "Password to encrypt .jks file", }, &cli.StringFlag{ Name: "alias", DefaultText: "key", Usage: "Alias of key within keystore file", }, }, } func Keyfile(c *cli.Context) error { switch c.NArg() { case 0, 1: cli.ShowSubcommandHelp(c) return errors.New("need output file name and at least one input filename") } outFn := c.Args().Get(0) opts := &jks.Options{ Password: c.String("password"), } kp, err := keyfileKeypair(c.Args().Slice()[1:]) if err != nil { return err } kp.Alias = c.String("alias") ks := &jks.Keystore{ Keypairs: []*jks.Keypair{kp}, } raw, err := ks.Pack(opts) if err != nil { return err } return os.WriteFile(outFn, raw, 0600) } func keyfileKeypair(infiles []string) (*jks.Keypair, error) { kp := &jks.Keypair{} for _, fn := range infiles { raw, err := os.ReadFile(fn) if err != nil { return nil, err } for { block, rest := pem.Decode(raw) if block == nil { break } raw = rest switch block.Type { case "PRIVATE KEY": if kp.PrivateKey != nil { return nil, errors.New("multiple private keys encountered") } kp.PrivateKey, err = x509.ParsePKCS8PrivateKey(block.Bytes) case "RSA PRIVATE KEY": if kp.PrivateKey != nil { return nil, errors.New("multiple private keys encountered") } kp.PrivateKey, err = x509.ParsePKCS1PrivateKey(block.Bytes) case "EC PRIVATE KEY": if kp.PrivateKey != nil { return nil, errors.New("multiple private keys encountered") } kp.PrivateKey, err = x509.ParseECPrivateKey(block.Bytes) case "CERTIFICATE": cert, err := x509.ParseCertificate(block.Bytes) if err != nil { return nil, fmt.Errorf("%s: %w", fn, err) } kp.CertChain = append(kp.CertChain, &jks.KeypairCert{ Raw: block.Bytes, Cert: cert, }) } } } if kp.PrivateKey == nil { return nil, errors.New("no private key found") } if len(kp.CertChain) > 0 { // TODO: match first cert against keypair } return kp, nil } minijks-1.2.0/main.go000066400000000000000000000006201467102016300144270ustar00rootroot00000000000000package main import ( "fmt" "os" "github.com/urfave/cli/v2" ) func main() { app := &cli.App{ Name: "minijks", Version: "1.1.0", Usage: "inspect, unpack and pack Java keystore files", Commands: []*cli.Command{ InspectCommand, UnpackCommand, PackCommand, KeyfileCommand, }, } if err := app.Run(os.Args); err != nil { fmt.Fprintln(os.Stderr, err) os.Exit(1) } } minijks-1.2.0/pack.go000066400000000000000000000124131467102016300144240ustar00rootroot00000000000000package main import ( "crypto/x509" "encoding/pem" "errors" "fmt" "io" "io/ioutil" "os" "path/filepath" "strings" "unicode/utf8" "github.com/lwithers/minijks/jks" "github.com/urfave/cli/v2" ) var PackCommand = &cli.Command{ Name: "pack", Usage: "pack a directory into a keystore file", ArgsUsage: "in.d out.jks", Action: Pack, } func Pack(c *cli.Context) error { switch c.NArg() { case 0: cli.ShowSubcommandHelp(c) return errors.New("need input directory and output file name") case 2: // OK default: return errors.New("need input directory and output file name") } inDir := c.Args().Get(0) outFn := c.Args().Get(1) st, err := os.Stat(inDir) if err != nil { return err } else if !st.IsDir() { return fmt.Errorf("%q must be a directory", inDir) } f, err := os.OpenFile(outFn, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600) if err != nil { return err } if err = pack(f, inDir); err != nil { _ = f.Close() _ = os.Remove(outFn) return err } if err = f.Close(); err != nil { _ = os.Remove(outFn) return err } return nil } func pack(out io.Writer, inDir string) error { certDir := filepath.Join(inDir, "certs") keyDir := filepath.Join(inDir, "keys") var ( err error ks jks.Keystore opts = jks.Options{ KeyPasswords: make(map[string]string), } ) opts.Password, err = packPassword(inDir) if err != nil { return err } if _, err = os.Stat(certDir); err == nil { if err = packCerts(&opts, &ks, certDir); err != nil { return err } } if _, err = os.Stat(keyDir); err == nil { var keyDirs []string f, err := ioutil.ReadDir(keyDir) if err != nil { return err } for _, fi := range f { if !fi.IsDir() { continue } if fi.Name()[0] == '.' { continue } keyDirs = append(keyDirs, filepath.Join(keyDir, fi.Name())) } for _, d := range keyDirs { kp, err := packKeypair(&opts, d) if err != nil { return err } ks.Keypairs = append(ks.Keypairs, kp) } } raw, err := ks.Pack(&opts) if err != nil { return err } _, err = out.Write(raw) return err } func packPassword(dirname string) (string, error) { fn := filepath.Join(dirname, "password") p, err := ioutil.ReadFile(fn) if err != nil { return "", err } // strip a possible trailing newline if len(p) > 0 && p[len(p)-1] == '\n' { p = p[:len(p)-1] } // ensure it's valid UTF-8 if !utf8.Valid(p) { return "", fmt.Errorf("%s: not valid UTF-8", fn) } return string(p), nil } func packCerts(opts *jks.Options, ks *jks.Keystore, certDir string) error { f, err := ioutil.ReadDir(certDir) if err != nil { return err } for _, fi := range f { if fi.IsDir() || fi.Name()[0] == '.' || filepath.Ext(fi.Name()) != ".pem" { fmt.Fprintf(os.Stderr, "ignoring %q (must be "+ "non-dot-file ending .pem)\n", fi.Name()) continue } cert, err := packLoadCert(filepath.Join(certDir, fi.Name())) if err != nil { return err } alias := filepath.Base(fi.Name()) alias = alias[:len(alias)-4] // strip ".pem" ks.Certs = append(ks.Certs, &jks.Cert{ Alias: alias, Timestamp: fi.ModTime(), Cert: cert, }) } return nil } func packKeypair(opts *jks.Options, dir string) (*jks.Keypair, error) { kp := &jks.Keypair{ Alias: filepath.Base(dir), } fname := filepath.Join(dir, "password") fi, err := os.Stat(fname) if err == nil { opts.KeyPasswords[kp.Alias], err = packPassword(dir) if err != nil { return nil, err } } fname = filepath.Join(dir, "privkey.pem") if fi, err = os.Stat(fname); err != nil { return nil, err } kp.Timestamp = fi.ModTime() block, err := packLoadPem(fname) switch block.Type { case "PRIVATE KEY": kp.PrivateKey, err = x509.ParsePKCS8PrivateKey(block.Bytes) case "RSA PRIVATE KEY": kp.PrivateKey, err = x509.ParsePKCS1PrivateKey(block.Bytes) case "EC PRIVATE KEY": kp.PrivateKey, err = x509.ParseECPrivateKey(block.Bytes) default: err = fmt.Errorf("%q: unknown private key type %q", fname, block.Type) } if err != nil { return nil, err } f, err := ioutil.ReadDir(dir) if err != nil { return nil, err } for _, fi := range f { if fi.Name()[0] == '.' || fi.IsDir() || fi.Name() == "privkey.pem" || filepath.Ext(fi.Name()) != ".pem" { continue } fname = filepath.Join(dir, fi.Name()) if !strings.HasPrefix(fi.Name(), "cert-") { fmt.Fprintf(os.Stderr, "warning: ignoring %q", fname) continue } cert, err := packLoadCert(fname) if err != nil { return nil, err } kp.CertChain = append(kp.CertChain, &jks.KeypairCert{ Cert: cert, }) } return kp, nil } func packLoadPem(fname string) (*pem.Block, error) { pemraw, err := ioutil.ReadFile(fname) if err != nil { return nil, err } block, rest := pem.Decode(pemraw) if block == nil { return nil, fmt.Errorf("%q: not a PEM file", fname) } else if len(rest) != 0 { return nil, fmt.Errorf("%q: has data beyond first PEM block", fname) } return block, nil } func packLoadCert(fname string) (*x509.Certificate, error) { block, err := packLoadPem(fname) if err != nil { return nil, err } if block.Type != "CERTIFICATE" { return nil, fmt.Errorf("%q: expected CERTIFICATE but found %q", fname, block.Type) } cert, err := x509.ParseCertificate(block.Bytes) if err != nil { return nil, fmt.Errorf("%q: %v", fname, err) } return cert, nil } minijks-1.2.0/unpack.go000066400000000000000000000130631467102016300147710ustar00rootroot00000000000000package main import ( "bytes" "crypto/ecdsa" "crypto/rsa" "crypto/x509" "encoding/pem" "errors" "fmt" "io/ioutil" "os" "path/filepath" "time" "github.com/lwithers/minijks/jks" "github.com/urfave/cli/v2" ) var UnpackCommand = &cli.Command{ Name: "unpack", Usage: "unpack a keystore file into a directory", ArgsUsage: "keystore.jks", Action: Unpack, } func init() { UnpackCommand.Flags = addJksOptsFlags(UnpackCommand.Flags) } func Unpack(c *cli.Context) error { switch c.NArg() { case 0: cli.ShowSubcommandHelp(c) return errors.New("need name of file to unpack") case 1: // OK default: return errors.New("can only unpack one file") } out := c.String("out") if out == "" { out = c.Args().Get(0) + ".d" } opts, err := jksOptsFlags(c) if err != nil { return err } return unpack(opts, c.Args().Get(0), out) } func unpack(opts *jks.Options, filename, outdir string) error { raw, err := ioutil.ReadFile(filename) if err != nil { return err } ks, err := jks.Parse(raw, opts) // any error will be returned below, after unpacking ks if ks != nil { if err = os.MkdirAll(outdir, 0700); err != nil { return err } // the directory must be empty fi, err := ioutil.ReadDir(outdir) if err != nil { return err } if len(fi) != 0 { return errors.New("output directory not empty") } if err := unpackInto(opts, ks, outdir); err != nil { return err } } return err } func unpackInto(opts *jks.Options, ks *jks.Keystore, outdir string) error { var retErr error reportErr := func(err error) { if err != nil { fmt.Fprintln(os.Stderr, err) retErr = errors.New("error(s) encountered") } } if opts == nil { opts = &jks.Options{ SkipVerifyDigest: true, } } // if we have a password, then save it if !opts.SkipVerifyDigest { err := unpackPassword(opts.Password, outdir, "password") reportErr(err) } // save the certificates usedFilenames := make(map[string]int) for _, cert := range ks.Certs { if cert.CertErr != nil { reportErr(fmt.Errorf("certificate %q: %v", cert.Alias, cert.CertErr)) continue } n := uniqueName(cert.Alias, usedFilenames) fn, err := unpackCertificate(cert.Raw, outdir, "certs", n+".pem") reportErr(err) _ = os.Chtimes(fn, time.Now(), cert.Timestamp) // errors ignored } // save the private keys usedFilenames = make(map[string]int) for _, kp := range ks.Keypairs { if kp.PrivKeyErr != nil { reportErr(fmt.Errorf("keypair %q: %v", kp.Alias, kp.PrivKeyErr)) continue } // save the private key itself n := uniqueName(kp.Alias, usedFilenames) fn, err := unpackPrivateKey(kp.PrivateKey, outdir, "keys", n, "privkey.pem") reportErr(err) _ = os.Chtimes(fn, time.Now(), kp.Timestamp) // errors ignored // if there is a specific password for this key, save it passwd, ok := opts.KeyPasswords[kp.Alias] if ok { err = unpackPassword(passwd, outdir, "keys", n, "password") reportErr(err) } // save the certificate chain for i, cert := range kp.CertChain { _, err = unpackCertificate(cert.Raw, outdir, "keys", n, fmt.Sprintf("cert-%04d.pem", i+1)) reportErr(err) } } return retErr } func unpackPassword(password string, pathParts ...string) error { fn, f, err := unpackOpen(0600, pathParts...) if err != nil { return err } if _, err = fmt.Fprintf(f, "%s\n", password); err != nil { _ = f.Close() // ignore errors; return orig err only _ = os.Remove(fn) return err } if err = f.Close(); err != nil { _ = os.Remove(fn) return err } return nil } func unpackCertificate(der []byte, pathParts ...string) (string, error) { fn, f, err := unpackOpen(0666, pathParts...) if err != nil { return "", err } if err = pem.Encode(f, &pem.Block{ Type: "CERTIFICATE", Bytes: der, }); err != nil { _ = f.Close() // ignore errors; return orig err only _ = os.Remove(fn) return "", err } if err = f.Close(); err != nil { _ = os.Remove(fn) return "", err } return fn, nil } func unpackPrivateKey(key interface{}, pathParts ...string) (string, error) { var ( err error block pem.Block ) switch key := key.(type) { case *rsa.PrivateKey: block.Type = "RSA PRIVATE KEY" block.Bytes = x509.MarshalPKCS1PrivateKey(key) case *ecdsa.PrivateKey: block.Type = "EC PRIVATE KEY" block.Bytes, err = x509.MarshalECPrivateKey(key) if err != nil { return "", err } default: return "", fmt.Errorf("unknown private key type %T", key) } fn, f, err := unpackOpen(0600, pathParts...) if err != nil { return "", err } if err = pem.Encode(f, &block); err != nil { _ = f.Close() // ignore errors; return orig err only _ = os.Remove(fn) return "", err } if err = f.Close(); err != nil { _ = os.Remove(fn) return "", err } return fn, nil } func uniqueName(in string, used map[string]int) string { // only allow alphanumeric and a couple of specific punctuation chars var b bytes.Buffer for _, r := range in { switch { case r >= 'A' && r <= 'Z', r >= 'a' && r <= 'z', r >= '0' && r <= '9', r == '.' && b.Len() != 0, r == '-', r == '_': b.WriteRune(r) } } if b.Len() == 0 { b.WriteString("XXX") } out := b.String() if used[out] > 0 { out = fmt.Sprintf("%s.%d", out, used[out]) } used[out] = used[out] + 1 return out } func unpackOpen(mode os.FileMode, buildPath ...string, ) (filename string, f *os.File, err error) { filename = filepath.Join(buildPath...) dirname := filepath.Dir(filename) if err = os.MkdirAll(dirname, 0777); err != nil { return filename, nil, err } f, err = os.OpenFile(filename, os.O_CREATE|os.O_EXCL|os.O_WRONLY, mode) return filename, f, err }