diff --git a/.gitignore b/.gitignore index da5b4c4..feb6b02 100644 --- a/.gitignore +++ b/.gitignore @@ -262,3 +262,6 @@ __pycache__/ # Ubuntu headers (for IntelliSense) /linux/include + +# Release packages +/*.zip diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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 +. diff --git a/COPYING.PuTTY b/COPYING.PuTTY new file mode 100644 index 0000000..ca78cb4 --- /dev/null +++ b/COPYING.PuTTY @@ -0,0 +1,29 @@ +Part of weasel-pageant is derived from the PuTTY program, whose original +license is reproduced below. + + +PuTTY is copyright 1997-2011 Simon Tatham. + +Portions copyright Robert de Bath, Joris van Rantwijk, Delian +Delchev, Andreas Schultz, Jeroen Massar, Wez Furlong, Nicolas Barry, +Justin Bradford, Ben Harris, Malcolm Smith, Ahmad Khalifa, Markus +Kuhn, Colin Watson, and CORE SDI S.A. + +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 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad0674a --- /dev/null +++ b/README.md @@ -0,0 +1,171 @@ +weasel-pageant +-------------- + +`weasel-pageant` allows you to use SSH keys held by [PuTTY's](https://www.chiark.greenend.org.uk/~sgtatham/putty/) +Pageant "daemon" (or compatible, such as the version of Pageant included in +[PuTTY-CAC](https://github.com/NoMoreFood/putty-cac) or the SSH agent mode in +[Gpg4win](https://www.gpg4win.org/)) from inside the +[Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about). + +The source (and this documentation) is heavily based on +[`ssh-pageant`](https://github.com/cuviper/ssh-pageant) 1.4 by Josh Stone, which allows +interacting with Pageant from Cygwin/MSYS programs. + +`weasel-pageant` works like `ssh-agent`, except that it leaves the key storage to +PuTTY's Pageant. It sets up an authentication socket and prints the environment +variables, which allows the OpenSSH client to use it. It works by executing from the +WSL side a Win32 helper program which interfaces with Pageant and communicating with +it through pipes. + +It is probably the most useful if your SSH keys can't be copied to the WSL environment, +such as when using a smart card for SSH authentication. Both Pageant-CAC and Gpg4win +have been tested (note that when using Gpg4win, only the SSH authentication functionality +will be forwarded; the Windows-side `gpg-agent` will not be available on the WSL side). + +**SECURITY NOTICE:** All the usual security caveats applicable to WSL apply here too. +Most importantly, all interaction with the Win32 world happens with the credentials of +the user who started the WSL environment. In practice, *if you allow someone else to +log in to your WSL environment remotely, they can access the SSH keys stored in your +Pageant with `weasel-pageant`.* This is a fundamental part of how WSL works; if you +are not sure of what you're doing, do not allow remote access to your WSL enviroment +(i.e. by starting an SSH server). + +**COMPATIBILITY NOTICE:** `weasel-pageant` does not, and will never work on +a version of Windows 10 older than 1703 ("Creators Update"), because +it requires the new [Windows/Ubuntu interoperability support](https://blogs.msdn.microsoft.com/wsl/2016/10/19/windows-and-ubuntu-interoperability/) +feature shipped with version 1703 (compatibility with older Insider +builds is unclear). Presumably it should work with newer Insider builds, +but has not been tested on anything more recent than build 15063.413. + +If you are still using Anniversary Update, you may be able to use the (unrelated) +[wsl-ssh-pageant](https://github.com/benpye/wsl-ssh-pageant). + +## Installation + +### From binaries + +Download the zip file from the releases page and unpack it in a convenient location +*on the Windows part of your drive*. Because WSL can only execute Win32 binaries from +`drvfs` locations, `weasel-pageant` *will not work* if unpacked inside the WSL +filesystem (onto an `lxfs` mount). (Advanced users may place only `helper.exe` on +`drvfs`, but in general it is easier to keep the pieces together.) + +### From source + +A VS2017 project is included. You will need the "Desktop development with C++" and +"Linux development with C++" features. + +1. In VS2017, set up a connection to your WSL environment (or a remote Linux machine) + in Options → Cross Platform → Connection Manager. + +2. Optional: If you intend to work on the Linux sources, copy the contents of + `/usr/include` into `weasel-pageant/include` under the project directory. + This is not required for the build, but will make Intellisense more useful. + +3. Hit Build Solution and both the Linux executable and the Win32 helper will be built. + +If you want to create a binary package, you can use the `create_pkg.py` script +at the root of the project. This should work with Python 3.4 or newer on either +Windows or Linux. + +Alternatively you can build the Linux executable directly on Linux and only use +Visual Studio for the Win32 helper (no Makefile or similar is supplied at the moment). +In theory the helper should be buildable with MinGW-w64 for a fully Linux-based +build, but this has not been tested. + +The release binaries have been built with VS2017 15.3.0 Preview 2.0. + +## Usage + +Using `weasel-pageant` is generally similar to using `ssh-agent` on Linux and +similar operating systems. + +1. Ensure that PuTTY's Pageant is running (and holds your SSH keys). + * ssh-pageant does not start Pageant itself. + * Recommended: Add Pageant to your Windows startup/Autostart configuration + so it is always available. + +2. Edit your `~/.bashrc` (or `~/.bash_profile`) to add the following: + + eval $(/weasel-pageant -r -a "/tmp/.weasel-pageant-$USERNAME") + + To explain: + + * This leverages the `-r`/`--reuse` option in combination with `-a SOCKET`, + which will only start a new daemon if the specified path does not accept connections + already. If the socket appears to be active, it will just set `SSH_AUTH_SOCK` and exit. + + * The exact path used for `-a` is arbitrary. The socket will be created + with only user-accessible permissions, but you may still want to use a more + private path than shown above if multiple users can access your WSL instance. + + * When using this, the `weasel-pageant` daemon and its helper process `helper.exe` + remains active (both will be visible in the Windows task manager). You should not + kill these processes, since open shells might still be using the socket. + + * Using `eval` will set the environment variables in the current shell. + By default, `weasel-pageant` tries to detect the current shell and output + appropriate commands. If detection fails, then use the `-S SHELL` option + to define a shell type manually. + +3. Restart your shell or type (when using bash) `. ~/.bashrc`. Typing `ssh-add -l` + should now list the keys you have registered in Pageant. + +## Options + +`weasel-pageant` aims to be compatible with `ssh-agent` options, with a few extras: + + $ weasel-pageant -h + Usage: weasel-pageant [options] [command [arg ...]] + Options: + -h, --help Show this help. + -v, --version Display version information. + -c Generate C-shell commands on stdout. + -s Generate Bourne shell commands on stdout. + -S SHELL Generate shell command for "bourne", "csh", or "fish". + -k Kill the current weasel-pageant. + -d Enable debug mode. + -q Enable quiet mode. + -a SOCKET Create socket on a specific path. + -r, --reuse Allow to reuse an existing -a SOCKET. + -H, --helper Path to the Win32 helper binary (default: /mnt/c/Program Files/weasel-pageant/helper.exe). + -t TIME Limit key lifetime in seconds (not supported by Pageant). + +By default, the Win32 helper will be searched for in the same directory where `weasel-pageant` +is stored. If you have placed it elsewhere, the `-H` flag can be used to set the location. + +## Known issues + +* The Win32 helper cannot be restarted if it's killed or crashes. There appears to be a bug + in WSL that causes pipes passed to Win32 executables to be unusable after some point + in program execution (possibly related to forking processes or opening sockets). Currently, + `weasel-pageant` will exit if it detects that the helper has exited. + +## Uninstallation + +To uninstall, just remove the extracted files and any modifications you made +to your shell initialization files (i.e. `.bashrc`). + +## Version History + +* 2017-06-25: 1.0 - Initial release. + +## Contributions + +Please send bug reports using Github's Issues feature. Pull requests are also +welcome, though if you intend to do major changes it's recommended to open an +issue first. + +------------------------------------------------------------------------------ +Copyright 2017 Valtteri Vuorikoski + +Based on `ssh-pageant`, copyright (C) 2009-2014 Josh Stone + +Licensed under the GNU GPL version 3 or later, http://gnu.org/licenses/gpl.html + +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +See the `COPYING` file for license details. +Part of `weasel-pageant` is derived from the PuTTY program, whose original license is +in the file `COPYING.PuTTY`. \ No newline at end of file diff --git a/create_pkg.py b/create_pkg.py new file mode 100644 index 0000000..db72c21 --- /dev/null +++ b/create_pkg.py @@ -0,0 +1,55 @@ +# +# weasel-pageant packaging script. +# +# Copyright 2017 Valtteri Vuorikoski +# +# This file is part of weasel-pageant, and 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. +# + +import sys +import zipfile + +CURRENT_VERSION = '1.0' + +try: + reltype = sys.argv[1] +except IndexError: + reltype = 'release' + +if reltype not in ('release', 'debug'): + print('usage: create_pkg release|debug', file=sys.stderr) + sys.exit(1) + +manifest = [ + 'COPYING', + 'COPYING.PuTTY', + 'README.md' +] + +if reltype == 'release': + dirname = 'weasel-pageant-%s' % CURRENT_VERSION + manifest.extend([ + 'x64/Release/helper.exe', + 'linux/bin/x64/Release/weasel-pageant' + ]) +else: + dirname = 'weasel-pageant-%s-%s' % (reltype, CURRENT_VERSION) + manifest.extend([ + 'x64/Debug/helper.exe', + 'linux/bin/x64/Debug/weasel-pageant' + ]) + +outname = dirname + '.zip' +zipf = zipfile.ZipFile(outname, 'w', compression=zipfile.ZIP_DEFLATED) + +def basename(x): + return x.rsplit('/')[-1] + +for fname in manifest: + zipf.write(fname, '%s/%s' % (dirname, basename(fname))) + +zipf.close() +sys.exit(0) diff --git a/linux/common.h b/linux/common.h new file mode 100644 index 0000000..01a9a2c --- /dev/null +++ b/linux/common.h @@ -0,0 +1,30 @@ +#pragma once + +/* +* weasel-pageant Linux/Win32 common header. +* Copyright 2017 Valtteri Vuorikoski +* Based on ssh-pageant, copyright 2009,2014 Josh Stone +* +* This file is part of weasel-pageant, and 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 file may be included from both the Linux and the Win32 code. + +#define AGENT_MAX_MSGLEN 8192 + +#define WSLP_CHILD_FLAG_DEBUG (1 << 0) + +#ifdef __cplusplus +extern "C" { +#endif + + static inline uint32_t msglen(const void *p) { + return 4 + ntohl(*(const uint32_t *)p); + } + +#ifdef __cplusplus +}; +#endif diff --git a/linux/linux.vcxproj b/linux/linux.vcxproj index 5696aa8..860160e 100644 --- a/linux/linux.vcxproj +++ b/linux/linux.vcxproj @@ -69,13 +69,31 @@ gcc gcc $(IncludePath);$(ProjectDir)include\x86_64-linux-gnu;$(ProjectDir)include;$(ISenseIncludePath) + weasel-pageant + + + + $(IncludePath);$(ProjectDir)include\x86_64-linux-gnu;$(ProjectDir)include;$(ISenseIncludePath) + weasel-pageant + + + + + + + - _GNU_SOURCE=1;%(PreprocessorDefinitions) + _GNU_SOURCE=1 + + + + + _GNU_SOURCE=1 diff --git a/linux/main.c b/linux/main.c index f784909..d92fdec 100644 --- a/linux/main.c +++ b/linux/main.c @@ -1,21 +1,28 @@ /* - * ssh-pageant main code. - * Copyright (C) 2009-2015 Josh Stone + * weasel-pageant Linux-side main code. + * + * Copyright 2017 Valtteri Vuorikoski + * Based on ssh-pageant, Copyright 2009-2015 Josh Stone * - * This file is part of ssh-pageant, and is free software: you can + * This file is part of weasel-pageant, and 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. */ #include +#include #include #include #include #include #include +#include #include #include +#include +#include +#include #include #include #include @@ -23,33 +30,59 @@ #include #include #include +#include // needed by common.h -#define AGENT_MAX_MSGLEN 8192 +#include "common.h" + +// WSL (at least as of CU) seems to have a strange problem with pipe passing +// when multiple sockets are open (the handles are non-functional when they +// arrive on the Win32 side). When this is defined, the helper is started +// early and restart won't be attempted if the helper exits. +#define HELPER_EARLY_START 1 #define FD_FOREACH(fd, set) \ for (fd = 0; fd < FD_SETSIZE; ++fd) \ if (FD_ISSET(fd, set)) -typedef enum {BOURNE, C_SH, FISH} shell_type; +typedef enum {UNKNOWN, BOURNE, C_SH, FISH} shell_type; struct fd_buf { - int recv, send; - char buf[AGENT_MAX_MSGLEN]; + ssize_t recv, send; + uint8_t buf[AGENT_MAX_MSGLEN]; }; +static int opt_debug = 0; + +static pid_t subcommand_pid = 0; +static pid_t win32_pid = 0; +static int win32_in = -1; // input from the win32 helper (connected to its stdout) +static int win32_out = -1; // output to the win32 helper (connected to its stdin) +static char win32_helper_path[PATH_MAX] = "./helper.exe"; + static char cleanup_tempdir[PATH_MAX] = ""; static char cleanup_sockpath[PATH_MAX] = ""; static void cleanup_exit(int status) __attribute__((noreturn)); static void cleanup_warn(const char *prefix) __attribute__((noreturn)); -static void cleanup_signal(int sig) __attribute__((noreturn)); +static void cleanup_signal(int sig); static void do_agent_loop(int sockfd) __attribute__((noreturn)); -static inline int msglen(const void *p) { - return 4 + ntohl(*(const uint32_t *)p); +static void +debug_print(const char *fmt, ...) +{ + if (!opt_debug) + return; + + va_list ap; + + fprintf(stderr, "main DEBUG: "); + va_start(ap, fmt); + vfprintf(stderr, fmt, ap); + va_end(ap); + fprintf(stderr, "\n"); } @@ -70,6 +103,33 @@ cleanup_warn(const char *prefix) } +static void +cleanup_win32(int need_wait) +{ +#if HELPER_EARLY_START + // When early start is necessary we have no hope of restarting + warnx("win32 helper has stopped; bailing out"); + cleanup_exit(1); +#else + if (win32_in > 0) { + close(win32_in); + win32_in = 0; + } + + if (win32_out > 0) { + close(win32_out); + win32_out = 0; + } + + // used is used by the query function if it detects an EOF + if (need_wait && win32_pid > 0) + waitpid(win32_pid, NULL, 0); + + win32_pid = 0; +#endif +} + + static void cleanup_signal(int sig) { @@ -77,11 +137,20 @@ cleanup_signal(int sig) // but when a child exits, copy its exit status so ssh-pageant is more // effective as a command wrapper. int status = 0; - if (sig == SIGCHLD && wait(&status) > 0) { - if (WIFEXITED(status)) - status = WEXITSTATUS(status); - else if (WIFSIGNALED(status)) - status = 128 + WTERMSIG(status); + if (sig == SIGCHLD) { + if (subcommand_pid > 0 && waitpid(subcommand_pid, &status, WNOHANG) > 0) { + // The subcommand exited. Fall through to cleanup. + if (WIFEXITED(status)) + status = WEXITSTATUS(status); + else if (WIFSIGNALED(status)) + status = 128 + WTERMSIG(status); + } + else if (win32_pid > 0 && waitpid(win32_pid, NULL, WNOHANG) > 0) { + // The win32 helper process exited. Clean up after it, the message handler + // will restart it. + cleanup_win32(0); + return; + } } cleanup_exit(status); } @@ -96,7 +165,7 @@ create_socket_path(char* sockpath, size_t len) cleanup_warn("mkdtemp"); // NB: Don't set cleanup_tempdir until after it's created - strlcpy(cleanup_tempdir, tempdir, sizeof(cleanup_tempdir)); + strncpy(cleanup_tempdir, tempdir, sizeof(cleanup_tempdir)); snprintf(sockpath, len, "%s/agent.%d", tempdir, getpid()); } @@ -114,7 +183,7 @@ open_auth_socket(const char* sockpath) if (fd < 0) cleanup_warn("socket"); - strlcpy(addr.sun_path, sockpath, sizeof(addr.sun_path)); + strncpy(addr.sun_path, sockpath, sizeof(addr.sun_path)); addr.sun_family = AF_UNIX; um = umask(S_IXUSR | S_IRWXG | S_IRWXO); @@ -123,7 +192,7 @@ open_auth_socket(const char* sockpath) umask(um); // NB: Don't set cleanup_sockpath until after it's bound - strlcpy(cleanup_sockpath, sockpath, sizeof(cleanup_sockpath)); + strncpy(cleanup_sockpath, sockpath, sizeof(cleanup_sockpath)); if (listen(fd, 128) < 0) cleanup_warn("listen"); @@ -132,6 +201,18 @@ open_auth_socket(const char* sockpath) } +static int +path_is_socket(const char *path) +{ + struct stat st; + if (stat(path, &st) == 0) { + if (S_ISSOCK(st.st_mode)) + return 1; + } + return 0; +} + + // Try to reuse an existing socket path. For now, just being able to connect // will be deemed good enough. If it can't connect, but is still a socket, try // to remove it. Return 0 if the path was simply not connectible, else exit. @@ -139,42 +220,213 @@ static int reuse_socket_path(const char* sockpath) { struct sockaddr_un addr; - int fd; + int fd; fd = socket(PF_LOCAL, SOCK_STREAM | SOCK_CLOEXEC, 0); if (fd < 0) cleanup_warn("socket"); addr.sun_family = AF_UNIX; - strlcpy(addr.sun_path, sockpath, sizeof(addr.sun_path)); - if (connect(fd, (struct sockaddr *)&addr, sizeof(addr)) == 0) { - // The sockpath is already accepting connections -- reuse! - close(fd); - return 1; - } - else if (errno == ENOENT) - return 0; - else if (errno == ECONNREFUSED) { - // Either it's not listening, or not a socket at all. If it was at - // least a socket, remove it so it can be replaced. - if (path_is_socket(sockpath)) { - if (unlink(sockpath) < 0) - cleanup_warn("unlink"); - return 0; - } + strncpy(addr.sun_path, sockpath, sizeof(addr.sun_path)); + if (connect(fd, (struct sockaddr *)&addr, sizeof(addr)) == 0) { + // The sockpath is already accepting connections -- reuse! + close(fd); + return 1; + } + else if (errno == ENOENT) { + close(fd); + return 0; + } + else if (errno == ECONNREFUSED) { + // Either it's not listening, or not a socket at all. If it was at + // least a socket, remove it so it can be replaced. + if (path_is_socket(sockpath)) { + if (unlink(sockpath) < 0) + cleanup_warn("unlink"); + + close(fd); + return 0; + } + + // Restore the errno before warning out. + errno = ECONNREFUSED; + } + cleanup_warn("connect"); +} - // Restore the errno before warning out. - errno = ECONNREFUSED; - } - cleanup_warn("connect"); + +static int +start_win32_helper() +{ + posix_spawn_file_actions_t action; + int out_pipe[2], in_pipe[2]; + char child_arg[9]; + char *argv[] = { win32_helper_path, child_arg, NULL }; + char *cwd; + int result = 0; + + if (win32_in > 0 && win32_out > 0) + return result; // already running + + // Serialize flags to child + int child_flags = 0; + if (opt_debug) + child_flags |= WSLP_CHILD_FLAG_DEBUG; + snprintf(child_arg, 9, "%08d", child_flags); + + // Set up the pipes to be used as stdin/stdout + if (pipe2(out_pipe, O_CLOEXEC) < 0 || pipe2(in_pipe, O_CLOEXEC) < 0) + cleanup_warn("start_win32_helper pipe"); + + win32_in = in_pipe[0]; // our input, helper's output + win32_out = out_pipe[1]; // our output, helper's input + + posix_spawn_file_actions_init(&action); + + // Set up stdin/stdout. The original files will be closed at exec. + posix_spawn_file_actions_adddup2(&action, in_pipe[1], STDOUT_FILENO); + posix_spawn_file_actions_adddup2(&action, out_pipe[0], STDIN_FILENO); + + // Change to (hopefully) a DrvFs filesystem. Otherwise a warning about changing + // the directory may be shown. In the future, this should check /proc/mounts for + // a DrvFs path instead of assuming the C: drive is present. + if ((cwd = get_current_dir_name()) != NULL) { + if (chdir("/mnt/c") < 0) + debug_print("could not chdir to DrvFs (%d)\n", errno); + } + + // Start it + if (posix_spawn(&win32_pid, win32_helper_path, &action, NULL, argv, environ) != 0) { + // Display warning and clean up instead of exiting, in case the user is updating the helper + warn("start_win32_helper failed to start helper %s", win32_helper_path); + cleanup_win32(0); + result = -1; + } + + // Restore the original working directory. It would be nice if spawn() supported + // this directly. + if (cwd != NULL) { + chdir(cwd); + free(cwd); + } + + // Close the files passed to the child. + close(in_pipe[1]); + close(out_pipe[0]); + posix_spawn_file_actions_destroy(&action); + + if (result == 0) { + // Read the initialization byte from the child to verify that it has started + ssize_t initcnt; + char initchar; + + initcnt = read(win32_in, &initchar, 1); + if (initcnt < 0) + cleanup_warn("could not read init byte from win32 helper"); + else if (initcnt == 0) { + warnx("win32 helper died immediately"); + cleanup_exit(1); + } + else if (initchar != 'a') { + warnx("win32 helper returned unexpected init byte %x", initchar); + cleanup_exit(1); + } + debug_print("got init byte %x='%c'", initchar, initchar); + } + + return result; } static int agent_query(void *buf) { - // TODO: start process (if needed) - // TODO: hand query to process +#if !HELPER_EARLY_START + if (start_win32_helper() != 0) + return -1; +#endif + + // Subprocess has been started (though it may still fail, but at least the spawn finished) + + size_t rem = msglen(buf); + ssize_t cnt; + void *bufp = buf; + int first_done = 0; + + while (rem > 0) { + cnt = write(win32_out, bufp, rem); + if (cnt < 0) { + switch (errno) { + case EINTR: + continue; + + case EPIPE: + // The helper has closed its input; try to restart + cleanup_win32(1); +#if !HELPER_EARLY_START + if (!first_done) { + warn("win32 helper had exited; trying to restart"); + if (start_win32_helper() != 0) + return -1; + first_done = 1; // not actually done, but don't retry infinitely + continue; + } +#endif + warn("win32 helper exited during query (write); aborting"); + return -1; + + default: + // These shouldn't happen, bail completely + cleanup_warn("agent_query write"); + break; + } + } + + // Write succeeded + first_done = 1; + rem -= (size_t) cnt; + bufp += cnt; + } + + first_done = 0; + rem = 4; // start with 4-byte length + bufp = buf; + while (rem > 0) { + cnt = read(win32_in, bufp, rem); + if (cnt < 0) { + switch (errno) { + case EINTR: + continue; + + default: + cleanup_warn("agent_query read"); + break; + } + } + else if (cnt == 0) { + // End of file on pipe, the helper went away + warn("win32 helper exited during query (read, rem=%llu); aborting", rem); + cleanup_win32(1); + return -1; + } + + rem -= (size_t) cnt; + bufp += cnt; + + if (!first_done) { + // Waiting for body size, see if we have it + if (rem != 0) + continue; // nope + + rem = msglen(buf) - 4; // yep, reset remaining to body size + if (rem > (AGENT_MAX_MSGLEN - 4)) { // dummy size + warn("win32 helper tried to return %llu bytes; aborting"); + cleanup_win32(1); + return -1; + } + first_done = 1; + } + } return 0; } @@ -183,7 +435,7 @@ agent_query(void *buf) static int agent_recv(int fd, struct fd_buf *p) { - int len = recv(fd, p->buf + p->recv, sizeof(p->buf) - p->recv, 0); + ssize_t len = recv(fd, p->buf + p->recv, sizeof(p->buf) - (size_t)p->recv, 0); if (len <= 0) { if (len < 0) warn("recv(%d)", fd); @@ -192,7 +444,7 @@ agent_recv(int fd, struct fd_buf *p) p->recv += len; if (p->recv < 4 || p->recv < msglen(p->buf)) - return 0; + return 0; // more to recv if (p->recv > msglen(p->buf)) { warnx("recv(%d) = %d (expected %d)", @@ -205,14 +457,14 @@ agent_recv(int fd, struct fd_buf *p) return -1; p->send = 0; - return 1; + return 1; // recv done, move to send phase } static int agent_send(int fd, struct fd_buf *p) { - int len = send(fd, p->buf + p->send, msglen(p->buf) - p->send, 0); + ssize_t len = send(fd, p->buf + p->send, (size_t)(msglen(p->buf) - p->send), 0); if (len < 0) { warn("send(%d)", fd); return -1; @@ -220,7 +472,7 @@ agent_send(int fd, struct fd_buf *p) p->send += len; if (p->send < msglen(p->buf)) - return 0; + return 0; // more to send if (p->send > msglen(p->buf)) { warnx("send(%d) = %d (expected %d)", @@ -344,6 +596,7 @@ get_shell_guess() return detected_shell; } + static void output_unset_env(const shell_type opt_sh) { @@ -360,6 +613,8 @@ output_unset_env(const shell_type opt_sh) printf("set -e SSH_AUTH_SOCK;\n"); printf("set -e SSH_PAGEANT_PID;\n"); break; + case UNKNOWN: + break; } } @@ -383,6 +638,8 @@ output_set_env(const shell_type opt_sh, const int p_set_pid_env, const char *esc if (p_set_pid_env) printf("set -x SSH_PAGEANT_PID %d;\n", pid); break; + case UNKNOWN: + break; } } @@ -398,6 +655,7 @@ parse_shell_option(const char *shell_name) return BOURNE; } else { errx(1, "unrecognized shell \"%s\"", shell_name); + return UNKNOWN; // not reached } } @@ -409,20 +667,34 @@ main(int argc, char *argv[]) { "help", no_argument, 0, 'h' }, { "version", no_argument, 0, 'v' }, { "reuse", no_argument, 0, 'r' }, + { "helper", required_argument, 0, 'H' }, { 0, 0, 0, 0 } }; int sockfd = -1; int opt; - int opt_debug = 0; int opt_quiet = 0; int opt_kill = 0; int opt_reuse = 0; int opt_lifetime = 0; + char exec_dir[PATH_MAX]; + ssize_t exec_dir_len; shell_type opt_sh = get_shell_guess(); - while ((opt = getopt_long(argc, argv, "+hvcsS:kdqa:rt:", + exec_dir_len = readlink("/proc/self/exe", exec_dir, PATH_MAX - 1); + if (exec_dir_len > 0) { + exec_dir[exec_dir_len] = 0; + strcpy(exec_dir, dirname(exec_dir)); + } + else { + strcpy(exec_dir, "."); + } + + // Assume that the helper binary is next to the main executable + snprintf(win32_helper_path, PATH_MAX, "%s/%s", exec_dir, "helper.exe"); + + while ((opt = getopt_long(argc, argv, "+hvcsS:kdqa:rt:H:", long_options, NULL)) != -1) switch (opt) { case 'h': @@ -438,6 +710,7 @@ main(int argc, char *argv[]) printf(" -q Enable quiet mode.\n"); printf(" -a SOCKET Create socket on a specific path.\n"); printf(" -r, --reuse Allow to reuse an existing -a SOCKET.\n"); + printf(" -H, --helper Path to the Win32 helper binary (default: %s).\n", win32_helper_path); printf(" -t TIME Limit key lifetime in seconds (not supported by Pageant).\n"); return 0; @@ -490,6 +763,11 @@ main(int argc, char *argv[]) opt_lifetime = 1; break; + case 'H': + if (realpath(optarg, win32_helper_path) == NULL) + err(1, "invalid helper path (use --helper to specify the Win32 helper path)"); + break; + case '?': errx(1, "try --help for more information"); break; @@ -520,15 +798,24 @@ main(int argc, char *argv[]) if (opt_lifetime && !opt_quiet) warnx("option is not supported by Pageant -- t"); + // Preflight the helper path + if (access(win32_helper_path, X_OK) < 0) + errx(1, "file %s is not an executable; use --helper to specify the Win32 helper path", win32_helper_path); + signal(SIGINT, cleanup_signal); signal(SIGHUP, cleanup_signal); signal(SIGTERM, cleanup_signal); + signal(SIGPIPE, SIG_IGN); int p_sock_reused = opt_reuse && reuse_socket_path(sockpath); if (!p_sock_reused) { if (!sockpath[0]) create_socket_path(sockpath, sizeof(sockpath)); sockfd = open_auth_socket(sockpath); + +#if HELPER_EARLY_START + start_win32_helper(); +#endif } // If the sockpath is actually reused, don't daemonize, don't set @@ -539,7 +826,7 @@ main(int argc, char *argv[]) if (optind < argc) { // Subcommand exeuction mode - const char **subargv = (const char **)argv + optind; + char * const* subargv = argv + optind; setenv("SSH_AUTH_SOCK", sockpath, 1); if (p_set_pid_env) { char pidstr[16]; @@ -547,8 +834,21 @@ main(int argc, char *argv[]) setenv("SSH_PAGEANT_PID", pidstr, 1); } signal(SIGCHLD, cleanup_signal); - if (spawnvp(_P_NOWAIT, subargv[0], subargv) < 0) // TODO: use posix_spawnp - cleanup_warn(argv[optind]); + + // Have spawn clean up ignored signals + posix_spawnattr_t sp_attr; + sigset_t sp_sigs; + sigemptyset(&sp_sigs); + sigaddset(&sp_sigs, SIGPIPE); + + posix_spawnattr_init(&sp_attr); + posix_spawnattr_setsigdefault(&sp_attr, &sp_sigs); + posix_spawnattr_setflags(&sp_attr, POSIX_SPAWN_SETSIGDEF); + + if (posix_spawnp(&subcommand_pid, subargv[0], NULL, &sp_attr, subargv, environ) < 0) + cleanup_warn(subargv[0]); + + posix_spawnattr_destroy(&sp_attr); } else { // Daemon mode diff --git a/win32/main.c b/win32/main.c new file mode 100644 index 0000000..0dfaac0 --- /dev/null +++ b/win32/main.c @@ -0,0 +1,183 @@ +/* + * weasel-pageant Win32-side main code. + * + * Copyright 2017 Valtteri Vuorikoski + * + * This file is part of weasel-pageant, and 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. + */ + +#include "targetver.h" + +#include +#include + +#include + +#include "winpgntc.h" +#include "../linux/common.h" + +static uint32_t flags = 0; + + +// Send a (narrow) string to standard error, which is expected to be connected to stderr +// on the linux side. +void print_error(const char *fmt, ...) +{ + va_list ap; + + fprintf(stderr, "win32 helper: "); + va_start(ap, fmt); + vfprintf(stderr, fmt, ap); + va_end(ap); + fprintf(stderr, "\n"); +} + + +void print_debug(const char *fmt, ...) +{ + if (!(flags & WSLP_CHILD_FLAG_DEBUG)) + return; + + va_list ap; + + fprintf(stderr, "win32 helper DEBUG: "); + va_start(ap, fmt); + vfprintf(stderr, fmt, ap); + va_end(ap); + fprintf(stderr, "\n"); +} + + +static DWORD read_packet(const HANDLE input, uint8_t *buf) +{ + DWORD cnt, rem = 4, got_length = 0; + DWORD error_code = ERROR_SUCCESS; + uint8_t *bufp = buf; + + // Documentation indicates that ReadFile() returns when a "write operation completes + // on the write end of the pipe". Since the linux side may call write() multiple times, + // loop until everything has been read. + while (rem > 0) { + print_debug("start read with rem=%d", rem); + if (!ReadFile(input, bufp, rem, &cnt, NULL)) { + error_code = GetLastError(); + + if (error_code != ERROR_BROKEN_PIPE) // EOF + print_error("reading packet data failed with code %d", error_code); + else + print_debug("Broken pipe on input"); + + return 0; + } + + if (cnt == 0) { + print_debug("EOF on input"); + return 0; + } + + bufp += cnt; + rem -= cnt; + + if (rem > 0) + continue; // more to read + + if (!got_length) { + rem = msglen(buf) - 4; + if (rem > (AGENT_MAX_MSGLEN - 4)) { + print_error("got packet with length %d exceeding maximum", rem); + return 0; + } + print_debug("input packet length is 4+%d", rem); + got_length = 1; + } + } + + return 1; +} + + +static DWORD write_packet(const HANDLE output, uint8_t *buf) +{ + DWORD rem = msglen(buf), cnt; + DWORD error_code; + + // Assume that WriteFile will write everything given to it + if (!WriteFile(output, buf, rem, &cnt, NULL)) { + error_code = GetLastError(); + + if (error_code != ERROR_BROKEN_PIPE) // linux side is gone + print_error("writing %d bytes of packet data failed with code %d", rem, error_code); + return 0; + } + + if (cnt != rem) { + print_error("short write: wanted to write %d byte packet, wrote %d bytes", rem, cnt); + return 0; + } + + return 1; +} + + +static void main_loop(const HANDLE output, const HANDLE input) +{ + uint8_t buf[AGENT_MAX_MSGLEN]; + + print_debug("main loop starting"); + + while (1) { + // Get packet from linux side. + if (!read_packet(input, buf)) + return; + + print_debug("got packet, querying pageant"); + + // We should have a valid packet in buf. Send it to the agent and + // buf will be filled with the response. + agent_query(buf); + + // Return response to linux side. + if (!write_packet(output, buf)) + return; + } +} + + +int main(const int argc, const char **argv) +{ + LPCWSTR test_error = L"This program is part of weasel-pageant and cannot be executed directly."; + + const HANDLE out_handle = GetStdHandle(STD_OUTPUT_HANDLE); // expected to be a pipe where the linux side is listening + const HANDLE in_handle = GetStdHandle(STD_INPUT_HANDLE); // ...and where the linux side is sending + + if (out_handle == INVALID_HANDLE_VALUE || in_handle == INVALID_HANDLE_VALUE) { + print_error("GetStdHandle failed (code %d)", GetLastError()); + return 1; + } + + // Flags bitmask from parent. + if (argc > 1) { + flags = strtoul(argv[1], NULL, 16); + print_debug("flags: %08x", flags); + } + + // If this succeeds, STD_OUTPUT_HANDLE is attached to a console, meaning that this program + // is being called manually. + if (WriteConsoleW(out_handle, test_error, (DWORD) wcslen(test_error), NULL, NULL)) + return 1; + + // Write an initialization byte to inform the parent that we are alive. + char initbyte = 'a'; + if (!WriteFile(out_handle, &initbyte, 1, NULL, NULL)) { + print_error("failed to write init byte to output (error %d); exiting", GetLastError()); + return 1; + } + + main_loop(out_handle, in_handle); + + return 0; +} + diff --git a/win32/main.cpp b/win32/main.cpp deleted file mode 100644 index 468695c..0000000 --- a/win32/main.cpp +++ /dev/null @@ -1,11 +0,0 @@ -// weasel-pageant-win32.cpp : Defines the entry point for the console application. -// - -#include "stdafx.h" - - -int main() -{ - return 0; -} - diff --git a/win32/stdafx.cpp b/win32/stdafx.cpp deleted file mode 100644 index d1af538..0000000 --- a/win32/stdafx.cpp +++ /dev/null @@ -1,8 +0,0 @@ -// stdafx.cpp : source file that includes just the standard includes -// weasel-pageant-win32.pch will be the pre-compiled header -// stdafx.obj will contain the pre-compiled type information - -#include "stdafx.h" - -// TODO: reference any additional headers you need in STDAFX.H -// and not in this file diff --git a/win32/stdafx.h b/win32/stdafx.h deleted file mode 100644 index b005a83..0000000 --- a/win32/stdafx.h +++ /dev/null @@ -1,15 +0,0 @@ -// stdafx.h : include file for standard system include files, -// or project specific include files that are used frequently, but -// are changed infrequently -// - -#pragma once - -#include "targetver.h" - -#include -#include - - - -// TODO: reference additional headers your program requires here diff --git a/win32/win32.vcxproj b/win32/win32.vcxproj index a168a33..7e60846 100644 --- a/win32/win32.vcxproj +++ b/win32/win32.vcxproj @@ -76,12 +76,14 @@ true + helper false false + helper @@ -102,9 +104,11 @@ Level3 Disabled _DEBUG;_CONSOLE;%(PreprocessorDefinitions) + MultiThreadedDebug Console + Ws2_32.lib;%(AdditionalDependencies) @@ -132,25 +136,24 @@ true true NDEBUG;_CONSOLE;%(PreprocessorDefinitions) + MultiThreaded Console true true + Ws2_32.lib;%(AdditionalDependencies) - - - - + - - + + - + \ No newline at end of file diff --git a/win32/win32.vcxproj.filters b/win32/win32.vcxproj.filters index 7bfb189..ea9246d 100644 --- a/win32/win32.vcxproj.filters +++ b/win32/win32.vcxproj.filters @@ -15,21 +15,18 @@ - - - - + Header Files - + Header Files - + Source Files - + Source Files diff --git a/win32/winpgntc.c b/win32/winpgntc.c index a244813..1f327c2 100644 --- a/win32/winpgntc.c +++ b/win32/winpgntc.c @@ -1,8 +1,9 @@ /* * Pageant client code. - * Copyright (C) 2009, 2011 Josh Stone + * Copyright 2017 Valtteri Vuorikoski + * Based on ssh-pageant, Copyright 2009, 2011 Josh Stone * - * This file is part of ssh-pageant, and is free software: you can + * This file is part of weasel-pageant, and 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. @@ -13,8 +14,11 @@ #include #include +#include +#include #include +#include "../linux/common.h" #include "winpgntc.h" #define AGENT_COPYDATA_ID 0x804e50ba /* random goop */ @@ -58,10 +62,11 @@ get_user_sid(void) void agent_query(void *buf) { - HWND hwnd = FindWindow("Pageant", "Pageant"); + HWND hwnd = FindWindow(L"Pageant", L"Pageant"); if (hwnd) { - char mapname[] = "PageantRequest12345678"; - sprintf(mapname, "PageantRequest%08x", (unsigned)GetCurrentThreadId()); + // The mapping name needs to be ANSI or bad stuff happens + char mapname[] = "PageantRequest12345678"; + sprintf_s(mapname, sizeof(mapname), "PageantRequest%08x", (unsigned)GetCurrentThreadId()); PSECURITY_DESCRIPTOR psd = NULL; SECURITY_ATTRIBUTES sa, *psa = NULL; @@ -81,9 +86,10 @@ agent_query(void *buf) } } - HANDLE filemap = CreateFileMapping(INVALID_HANDLE_VALUE, psa, + HANDLE filemap = CreateFileMappingA(INVALID_HANDLE_VALUE, psa, PAGE_READWRITE, 0, AGENT_MAX_MSGLEN, mapname); + BOOL need_free = 1; if (filemap != NULL && filemap != INVALID_HANDLE_VALUE) { void *p = MapViewOfFile(filemap, FILE_MAP_WRITE, 0, 0, 0); @@ -91,12 +97,12 @@ agent_query(void *buf) COPYDATASTRUCT cds = { .dwData = AGENT_COPYDATA_ID, - .cbData = 1 + strlen(mapname), + .cbData = 1 + (DWORD) strlen(mapname), .lpData = mapname, }; - int id = SendMessage(hwnd, WM_COPYDATA, - (WPARAM) NULL, (LPARAM) &cds); + LRESULT id = SendMessage(hwnd, WM_COPYDATA, + (WPARAM) NULL, (LPARAM) &cds); if (msglen(p) > AGENT_MAX_MSGLEN) id = 0; @@ -108,13 +114,16 @@ agent_query(void *buf) CloseHandle(filemap); LocalFree(psd); free(usersid); + need_free = 0; if (id > 0) return; } - LocalFree(psd); - free(usersid); + if (need_free) { + LocalFree(psd); + free(usersid); + } } static const char reply_error[5] = { 0, 0, 0, 1, SSH_AGENT_FAILURE }; diff --git a/win32/winpgntc.h b/win32/winpgntc.h new file mode 100644 index 0000000..5bcdbc0 --- /dev/null +++ b/win32/winpgntc.h @@ -0,0 +1,11 @@ +#pragma once + +#ifdef __cplusplus +extern "C" { +#endif + + void agent_query(void *buf); + +#ifdef __cplusplus +} +#endif