diff --git a/Cargo.lock b/Cargo.lock index 1284077..872cbbe 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -333,6 +333,19 @@ version = "0.4.19" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b06a4cde4c0f271a446782e3eff8de789548ce57dbc8eca9292c27f4a42004b4" +[[package]] +name = "mskey" +version = "0.1.0" +dependencies = [ + "anyhow", + "clap", + "log", + "serde", + "serde_json", + "simple_logger", + "umskt", +] + [[package]] name = "num-bigint" version = "0.4.3" @@ -708,19 +721,6 @@ version = "0.48.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a" -[[package]] -name = "xpkey" -version = "0.1.0" -dependencies = [ - "anyhow", - "clap", - "log", - "serde", - "serde_json", - "simple_logger", - "umskt", -] - [[package]] name = "zeroize" version = "1.6.0" diff --git a/Cargo.toml b/Cargo.toml index 582ac5a..31a9228 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,5 +3,13 @@ resolver = "2" members = [ "umskt", - "xpkey", + "mskey", ] + +[profile.release] +lto = true + +[profile.release.package.mskey] +strip = true +opt-level = "z" +codegen-units = 1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1ce8758 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0bd7a37 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Universal MS Key Toolkit (UMSKT) Rust Edition + +This is an unofficial Rust port of the [UMSKT project](https://github.com/UMSKT/UMSKT/). It is a pure Rust implementation rather than a binding, so it does not require any C or C++ dependencies and can be built for any platform supported by Rust and std. + +It does not include the required keys.json file used by UMSKT. That needs to be found elsewhere, most likely in the UMSKT codebase. + +## Credits +These contributors helped create the UMSKT project that this codebase was based on: +* z22 +* MSKey +* sk00ter +* diamondggg +* pottzman +* Endermanch +* Neo-Desktop +* WitherOrNot +* TheTank20 + +## Development Requirements +* [The Rust toolchain](https://rustup.rs/) + +## Build Steps +1. `cargo build` \ No newline at end of file diff --git a/xpkey/Cargo.toml b/mskey/Cargo.toml similarity index 77% rename from xpkey/Cargo.toml rename to mskey/Cargo.toml index 16d7f27..7f5325a 100644 --- a/xpkey/Cargo.toml +++ b/mskey/Cargo.toml @@ -1,14 +1,8 @@ [package] -name = "xpkey" +name = "mskey" version = "0.1.0" edition = "2021" -[profile.release] -strip = true -opt-level = "z" -lto = true -codegen-units = 1 - [dependencies] umskt = { path = "../umskt" } anyhow = "1.0.71" diff --git a/xpkey/src/cli.rs b/mskey/src/cli.rs similarity index 100% rename from xpkey/src/cli.rs rename to mskey/src/cli.rs diff --git a/xpkey/src/keys.rs b/mskey/src/keys.rs similarity index 100% rename from xpkey/src/keys.rs rename to mskey/src/keys.rs diff --git a/xpkey/src/main.rs b/mskey/src/main.rs similarity index 100% rename from xpkey/src/main.rs rename to mskey/src/main.rs diff --git a/umskt/src/bink1998.rs b/umskt/src/bink1998.rs index 3c893ec..67cd059 100644 --- a/umskt/src/bink1998.rs +++ b/umskt/src/bink1998.rs @@ -1,3 +1,4 @@ +//! Structs to deal with older BINK (< `0x40`) product keys use std::{ cmp::Ordering, fmt::{Display, Formatter}, @@ -12,10 +13,9 @@ use rand::Rng; use sha1::{Digest, Sha1}; use crate::{ - crypto::{EllipticCurve, PrivateKey}, + crypto::{EllipticCurve, Point, PrivateKey}, key::{base24_decode, base24_encode, strip_key}, math::bitmask, - weierstrass_curve::{Point, WeierstrassCurve}, }; const FIELD_BITS: u64 = 384; @@ -27,6 +27,9 @@ const SERIAL_LENGTH_BITS: u8 = 30; const UPGRADE_LENGTH_BITS: u8 = 1; const EVERYTHING_ELSE: u8 = HASH_LENGTH_BITS + SERIAL_LENGTH_BITS + UPGRADE_LENGTH_BITS; +/// A product key for a BINK ID less than `0x40` +/// +/// Every `ProductKey` contains a valid key for its given parameters. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub struct ProductKey { upgrade: bool, @@ -37,6 +40,9 @@ pub struct ProductKey { } impl ProductKey { + /// Generates a new product key for the given parameters. + /// + /// The key is verified to be valid before being returned. pub fn new( curve: &EllipticCurve, private_key: &PrivateKey, @@ -62,7 +68,7 @@ impl ProductKey { // Generate a new random key let product_key = Self::generate( - &curve.curve, + curve, &curve.gen_point, &private_key.gen_order, &private, @@ -72,24 +78,30 @@ impl ProductKey { )?; // Make sure the key is valid - product_key.verify(&curve.curve, &curve.gen_point, &curve.pub_point)?; + product_key.verify(curve, &curve.gen_point, &curve.pub_point)?; // Ship it Ok(product_key) } + /// Validates an existing product key string and tried to create a new `ProductKey` from it. + /// + /// # Arguments + /// + /// * `curve` - The elliptic curve to use for verification. + /// * `key` - Should be 25 characters long, not including the (optional) hyphens. pub fn from_key(curve: &EllipticCurve, key: &str) -> Result { let key = strip_key(key)?; let Ok(packed_key) = base24_decode(&key) else { bail!("Product key is in an incorrect format!") }; let product_key = Self::from_packed(&packed_key)?; - product_key.verify(&curve.curve, &curve.gen_point, &curve.pub_point)?; + product_key.verify(curve, &curve.gen_point, &curve.pub_point)?; Ok(product_key) } fn generate( - e_curve: &WeierstrassCurve, + e_curve: &EllipticCurve, base_point: &Point, gen_order: &BigInt, private_key: &BigInt, @@ -103,16 +115,11 @@ impl ProductKey { let mut rng = rand::thread_rng(); let product_key = loop { - // Generate a random number c consisting of 384 bits without any constraints. let c: BigUint = rng.sample(RandomBits::new(FIELD_BITS)); let c: BigInt = c.into(); - // Pick a random derivative of the base point on the elliptic curve. - // R = cG; let r = e_curve.multiply_point(&c, base_point); - // Acquire its coordinates. - // x = R.x; y = R.y; let (x, y) = match r { Point::Point { x, y } => (x, y), Point::Infinity => bail!("Point at infinity!"), @@ -175,7 +182,7 @@ impl ProductKey { fn verify( &self, - e_curve: &WeierstrassCurve, + e_curve: &EllipticCurve, base_point: &Point, public_key: &Point, ) -> Result { diff --git a/umskt/src/bink2002.rs b/umskt/src/bink2002.rs index 8e182b9..924ad25 100644 --- a/umskt/src/bink2002.rs +++ b/umskt/src/bink2002.rs @@ -1,3 +1,4 @@ +//! Structs to deal with newer BINK (>= `0x40`) product keys use std::{ cmp::Ordering, fmt::{Display, Formatter}, @@ -12,11 +13,9 @@ use rand::Rng; use sha1::{Digest, Sha1}; use crate::{ - crypto::{EllipticCurve, PrivateKey}, + crypto::{mod_sqrt, EllipticCurve, Point, PrivateKey}, key::{base24_decode, base24_encode, strip_key}, math::{bitmask, by_dword, next_sn_bits}, - msr::mod_sqrt, - weierstrass_curve::{Point, WeierstrassCurve}, }; const FIELD_BITS: u64 = 512; @@ -30,6 +29,9 @@ const UPGRADE_LENGTH_BITS: u8 = 1; const EVERYTHING_ELSE: u8 = SIGNATURE_LENGTH_BITS + HASH_LENGTH_BITS + CHANNEL_ID_LENGTH_BITS + UPGRADE_LENGTH_BITS; +/// A product key for a BINK ID `0x40` or higher +/// +/// Every `ProductKey` contains a valid key for its given parameters. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub struct ProductKey { upgrade: bool, @@ -40,6 +42,9 @@ pub struct ProductKey { } impl ProductKey { + /// Generates a new product key for the given parameters. + /// + /// The key is verified to be valid before being returned. pub fn new( curve: &EllipticCurve, private_key: &PrivateKey, @@ -63,7 +68,7 @@ impl ProductKey { // Generate a new random key let product_key = Self::generate( - &curve.curve, + curve, &curve.gen_point, &private_key.gen_order, &private_key.private_key, @@ -73,19 +78,25 @@ impl ProductKey { )?; // Make sure the key is valid - product_key.verify(&curve.curve, &curve.gen_point, &curve.pub_point)?; + product_key.verify(curve, &curve.gen_point, &curve.pub_point)?; // Ship it Ok(product_key) } + /// Validates an existing product key string and tried to create a new `ProductKey` from it. + /// + /// # Arguments + /// + /// * `curve` - The elliptic curve to use for verification. + /// * `key` - Should be 25 characters long, not including the (optional) hyphens. pub fn from_key(curve: &EllipticCurve, key: &str) -> Result { let key = strip_key(key)?; let Ok(packed_key) = base24_decode(&key) else { bail!("Product key is in an incorrect format!") }; let product_key = Self::from_packed(&packed_key)?; - let verified = product_key.verify(&curve.curve, &curve.gen_point, &curve.pub_point)?; + let verified = product_key.verify(curve, &curve.gen_point, &curve.pub_point)?; if !verified { bail!("Product key is invalid! Wrong BINK ID?"); } @@ -93,7 +104,7 @@ impl ProductKey { } fn generate( - e_curve: &WeierstrassCurve, + e_curve: &EllipticCurve, base_point: &Point, gen_order: &BigInt, private_key: &BigInt, @@ -223,7 +234,7 @@ impl ProductKey { fn verify( &self, - e_curve: &WeierstrassCurve, + e_curve: &EllipticCurve, base_point: &Point, public_key: &Point, ) -> Result { diff --git a/umskt/src/confid/mod.rs b/umskt/src/confid/mod.rs index 710668d..4b81a92 100644 --- a/umskt/src/confid/mod.rs +++ b/umskt/src/confid/mod.rs @@ -1,3 +1,13 @@ +//! Code to generate a Confirmation ID for a given Installation ID +//! +//! ## History +//! The algorithm this uses was originally provided to the UMSKT project by diamondggg. +//! The history provided by diamondggg is that they are the originator of the code +//! and was created in tandem with an acquaintance who knows number theory. +//! The file dates suggest this code was written sometime in 2017/2018. +//! +//! The Rust version of the code was created by running the original through C2Rust +//! and then manually fixing up the result. use thiserror::Error; mod black_box; @@ -18,6 +28,10 @@ pub enum ConfirmationIdError { Unlucky, } +/// Generates a confirmation ID from the given installation ID +/// +/// # Arguments +/// * `installation_id` - A string with 7 groups of 6 digits, with or without hyphens pub fn generate(installation_id: &str) -> Result { if installation_id.len() < 54 { return Err(ConfirmationIdError::TooShort); diff --git a/umskt/src/crypto.rs b/umskt/src/crypto.rs index f817858..5ad2491 100644 --- a/umskt/src/crypto.rs +++ b/umskt/src/crypto.rs @@ -1,15 +1,33 @@ +//! Code that deals with elliptic curve cryptography use anyhow::Result; use num_bigint::BigInt; -use num_traits::Num; +use num_integer::Integer; +use num_traits::{Num, One, Zero}; -use crate::weierstrass_curve::{Point, WeierstrassCurve}; +/// Represents a point (possibly) on an elliptic curve. +/// +/// This is either the point at infinity, or a point with affine coordinates `x` and `y`. +/// It is not guaranteed to be on the curve. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum Point { + Infinity, + Point { x: BigInt, y: BigInt }, +} +/// Represents an elliptic curve of the form `y^2 = x^3 + ax + b (mod p)` +/// +/// `b` is not used in any of the calculations, so is not stored. +/// +/// This implements all the necessary elliptic curve arithmetic for verifying and generating +/// product keys. pub struct EllipticCurve { - pub curve: WeierstrassCurve, + a: BigInt, + p: BigInt, pub gen_point: Point, pub pub_point: Point, } +/// Stores the additional data necessary to generate product keys. pub struct PrivateKey { pub gen_order: BigInt, pub private_key: BigInt, @@ -27,6 +45,7 @@ impl PrivateKey { } impl EllipticCurve { + /// Creates a new elliptic curve from the given parameters. `b` is not necessary. pub fn new( p: &str, a: &str, @@ -42,8 +61,6 @@ impl EllipticCurve { let public_key_x = BigInt::from_str_radix(public_key_x, 10)?; let public_key_y = BigInt::from_str_radix(public_key_y, 10)?; - let curve = WeierstrassCurve::new(a, p); - let gen_point = Point::Point { x: generator_x, y: generator_y, @@ -55,9 +72,152 @@ impl EllipticCurve { }; Ok(Self { - curve, + a, + p, gen_point, pub_point, }) } + + fn mod_inverse(a: &BigInt, p: &BigInt) -> BigInt { + let egcd = a.extended_gcd(p); + egcd.x.mod_floor(p) + } + + fn double_point(&self, point: &Point) -> Point { + match point { + Point::Point { x, y } => { + if y.is_zero() { + Point::Infinity + } else { + let three = BigInt::from(3); + let two = BigInt::from(2); + + let lambda = (three * x * x + &self.a) * Self::mod_inverse(&(two * y), &self.p); + let lamba_sqr = (&lambda * &lambda).mod_floor(&self.p); + let x3 = (&lamba_sqr - x - x).mod_floor(&self.p); + let y3 = (&lambda * (x - &x3) - y).mod_floor(&self.p); + + Point::Point { x: x3, y: y3 } + } + } + Point::Infinity => Point::Infinity, + } + } + + /// Adds two points on the curve together. + /// + /// If the points are the same, it doubles the point. + /// + /// If one of the points is the point at infinity, it returns the other point. + /// + /// If both points are the point at infinity, it returns the point at infinity. + pub(crate) fn add_points(&self, point1: &Point, point2: &Point) -> Point { + match (point1, point2) { + (Point::Point { x: x1, y: y1 }, Point::Point { x: x2, y: y2 }) => { + if point1 == point2 { + self.double_point(point1) + } else { + let lambda = (y2 - y1) * Self::mod_inverse(&(x2 - x1), &self.p); + let x3 = ((&lambda * &lambda) - x1 - x2).mod_floor(&self.p); + let y3: BigInt = ((&lambda * (x1 - &x3)) - y1).mod_floor(&self.p); + + Point::Point { x: x3, y: y3 } + } + } + (Point::Point { x, y }, Point::Infinity) | (Point::Infinity, Point::Point { x, y }) => { + Point::Point { + x: x.clone(), + y: y.clone(), + } + } + (Point::Infinity, Point::Infinity) => Point::Infinity, + } + } + + /// Multiplies a point by a scalar. + /// + /// Uses the double-and-add algorithm. + pub(crate) fn multiply_point(&self, s: &BigInt, point: &Point) -> Point { + let mut res = Point::Infinity; + let mut temp = point.clone(); + + let mut s = s.clone(); + + while s > BigInt::zero() { + if (&s % BigInt::from(2)) == BigInt::one() { + res = self.add_points(&res, &temp); + } + temp = self.double_point(&temp); + + s >>= 1; + } + + res + } +} + +/// Calculates the legendre symbol of `p`: `1`, `0`, or `-1 mod p` +fn ls(a: &BigInt, p: &BigInt) -> BigInt { + let exp = (p - BigInt::one()) / BigInt::from(2); + a.modpow(&exp, p) +} + +/// Calculates the modular square root of `n` such that `result^2 = n (mod p)` +/// using the Tonelli-Shanks algorithm. Returns `None` if `p` is not prime. +/// +/// # Arguments +/// +/// * `n` - The number to find the square root of +/// * `p` - The prime modulus (_must_ be prime) +pub(crate) fn mod_sqrt(n: &BigInt, p: &BigInt) -> Option { + if !ls(n, p).is_one() { + return None; + } + + let mut q = p - 1; + let mut s = BigInt::zero(); + while (&q & &BigInt::one()).is_zero() { + s += 1; + q >>= 1 + } + + if s.is_one() { + let exp = (p + 1) / 4; + let r1 = n.modpow(&exp, p); + return Some(p - &r1); + } + + let mut z = BigInt::from(2); + while ls(&z, p) != p - 1 { + z += 1 + } + let mut c = z.modpow(&q, p); + + let mut r = n.modpow(&((&q + 1) / 2), p); + let mut t = n.modpow(&q, p); + let mut m = s; + + loop { + if t.is_one() { + return Some(p - &r); + } + + let mut i = BigInt::zero(); + let mut z = t.clone(); + let mut b = c.clone(); + while !z.is_one() && i < &m - 1 { + z = &z * &z % p; + i += 1; + } + let mut e = &m - &i - 1; + while e > BigInt::zero() { + b = &b * &b % p; + e -= 1; + } + r = &r * &b % p; + c = &b * &b % p; + t = &t * &c % p; + m = i; + } } diff --git a/umskt/src/lib.rs b/umskt/src/lib.rs index df0ac79..1a1a8ca 100644 --- a/umskt/src/lib.rs +++ b/umskt/src/lib.rs @@ -1,8 +1,16 @@ +//! # Universal MS Key Toolkit (UMSKT) Rust Edition Rust Edition +//! +//! This is an unofficial Rust port of the [UMSKT project](https://github.com/UMSKT/UMSKT/). +//! It is a pure Rust implementation rather than a binding, so it does not require any C or +//! C++ dependencies and can be built for any platform supported by Rust and `std`. +//! +//! It does not include the required `keys.json` file used by UMSKT. That needs to be found elsewhere. +//! +//! See `README.md` for more information. +//! pub mod bink1998; pub mod bink2002; pub mod confid; pub mod crypto; mod key; mod math; -mod msr; -mod weierstrass_curve; diff --git a/umskt/src/msr.rs b/umskt/src/msr.rs deleted file mode 100644 index 780b216..0000000 --- a/umskt/src/msr.rs +++ /dev/null @@ -1,61 +0,0 @@ -use num_bigint::BigInt; -use num_traits::{One, Zero}; - -// Legendre symbol, returns 1, 0, or -1 mod p -fn ls(a: &BigInt, p: &BigInt) -> BigInt { - let exp = (p - BigInt::one()) / BigInt::from(2); - a.modpow(&exp, p) -} - -// Tonelli-Shanks algorithm -pub fn mod_sqrt(n: &BigInt, p: &BigInt) -> Option { - if !ls(n, p).is_one() { - return None; - } - - let mut q = p - 1; - let mut s = BigInt::zero(); - while (&q & &BigInt::one()).is_zero() { - s += 1; - q >>= 1 - } - - if s.is_one() { - let exp = (p + 1) / 4; - let r1 = n.modpow(&exp, p); - return Some(p - &r1); - } - - let mut z = BigInt::from(2); - while ls(&z, p) != p - 1 { - z += 1 - } - let mut c = z.modpow(&q, p); - - let mut r = n.modpow(&((&q + 1) / 2), p); - let mut t = n.modpow(&q, p); - let mut m = s; - - loop { - if t.is_one() { - return Some(p - &r); - } - - let mut i = BigInt::zero(); - let mut z = t.clone(); - let mut b = c.clone(); - while !z.is_one() && i < &m - 1 { - z = &z * &z % p; - i += 1; - } - let mut e = &m - &i - 1; - while e > BigInt::zero() { - b = &b * &b % p; - e -= 1; - } - r = &r * &b % p; - c = &b * &b % p; - t = &t * &c % p; - m = i; - } -} diff --git a/umskt/src/weierstrass_curve.rs b/umskt/src/weierstrass_curve.rs deleted file mode 100644 index c03fe01..0000000 --- a/umskt/src/weierstrass_curve.rs +++ /dev/null @@ -1,88 +0,0 @@ -use num_bigint::BigInt; -use num_integer::Integer; -use num_traits::{One, Zero}; - -#[derive(Debug, Clone, PartialEq, Eq)] -pub enum Point { - Infinity, - Point { x: BigInt, y: BigInt }, -} - -#[derive(Debug, Clone)] -pub struct WeierstrassCurve { - a: BigInt, - p: BigInt, -} - -impl WeierstrassCurve { - pub fn new(a: BigInt, p: BigInt) -> Self { - WeierstrassCurve { a, p } - } - - fn mod_inverse(a: &BigInt, p: &BigInt) -> BigInt { - let egcd = a.extended_gcd(p); - egcd.x.mod_floor(p) - } - - fn double_point(&self, point: &Point) -> Point { - match point { - Point::Point { x, y } => { - if y.is_zero() { - Point::Infinity - } else { - let three = BigInt::from(3); - let two = BigInt::from(2); - - let lambda = (three * x * x + &self.a) * Self::mod_inverse(&(two * y), &self.p); - let lamba_sqr = (&lambda * &lambda).mod_floor(&self.p); - let x3 = (&lamba_sqr - x - x).mod_floor(&self.p); - let y3 = (&lambda * (x - &x3) - y).mod_floor(&self.p); - - Point::Point { x: x3, y: y3 } - } - } - Point::Infinity => Point::Infinity, - } - } - - pub fn add_points(&self, point1: &Point, point2: &Point) -> Point { - match (point1, point2) { - (Point::Point { x: x1, y: y1 }, Point::Point { x: x2, y: y2 }) => { - if point1 == point2 { - self.double_point(point1) - } else { - let lambda = (y2 - y1) * Self::mod_inverse(&(x2 - x1), &self.p); - let x3 = ((&lambda * &lambda) - x1 - x2).mod_floor(&self.p); - let y3: BigInt = ((&lambda * (x1 - &x3)) - y1).mod_floor(&self.p); - - Point::Point { x: x3, y: y3 } - } - } - (Point::Point { x, y }, Point::Infinity) | (Point::Infinity, Point::Point { x, y }) => { - Point::Point { - x: x.clone(), - y: y.clone(), - } - } - (Point::Infinity, Point::Infinity) => Point::Infinity, - } - } - - pub fn multiply_point(&self, s: &BigInt, point: &Point) -> Point { - let mut res = Point::Infinity; - let mut temp = point.clone(); - - let mut s = s.clone(); - - while s > BigInt::zero() { - if (&s % BigInt::from(2)) == BigInt::one() { - res = self.add_points(&res, &temp); - } - temp = self.double_point(&temp); - - s >>= 1; - } - - res - } -}