From 457c2bf135be68b3c49ff20d3f23a6f8507aeda5 Mon Sep 17 00:00:00 2001 From: elijah Date: Mon, 24 Dec 2012 02:02:24 -0800 Subject: initial commit --- .gitignore | 3 + Gemfile | 4 + LICENSE.txt | 676 +++++++++++++++++++++++++++++++++++ README.md | 77 ++++ Rakefile | 83 +++++ lib/nickserver.rb | 10 + lib/nickserver/config.rb | 14 + lib/nickserver/hkp/fetch_key.rb | 51 +++ lib/nickserver/hkp/fetch_key_info.rb | 66 ++++ lib/nickserver/hkp/key_info.rb | 69 ++++ lib/nickserver/server.rb | 70 ++++ lib/nickserver/version.rb | 3 + nickserver.gemspec | 27 ++ test/files/hkp_vindex_result | 21 ++ test/files/leap_public_key | 46 +++ test/files/leap_vindex_result | 4 + test/test_helper.rb | 75 ++++ test/unit/hkp_test.rb | 120 +++++++ test/unit/server_test.rb | 34 ++ test/unit/test_helper.rb | 1 + 20 files changed, 1454 insertions(+) create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100644 lib/nickserver.rb create mode 100644 lib/nickserver/config.rb create mode 100644 lib/nickserver/hkp/fetch_key.rb create mode 100644 lib/nickserver/hkp/fetch_key_info.rb create mode 100644 lib/nickserver/hkp/key_info.rb create mode 100644 lib/nickserver/server.rb create mode 100644 lib/nickserver/version.rb create mode 100644 nickserver.gemspec create mode 100644 test/files/hkp_vindex_result create mode 100644 test/files/leap_public_key create mode 100644 test/files/leap_vindex_result create mode 100644 test/test_helper.rb create mode 100644 test/unit/hkp_test.rb create mode 100644 test/unit/server_test.rb create mode 100644 test/unit/test_helper.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6dfed3c --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +pkg +Gemfile.lock +NOTES \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..619272b --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in keymachine.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..193e67f --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,676 @@ +Copyright (c) 2013 LEAP Encryption Access Project + + 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/README.md b/README.md new file mode 100644 index 0000000..344c3cc --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +Nickserver +================================== + +Nickserver is the opposite of a key server. A key server allows you to lookup +keys, and the UIDs associated with a particular key. A nickserver allows you +to query a particular 'nick' (e.g. username@example.org) and get back relevant +public key information for that nick. + +Nickserver has the following properties: + +* Written in Ruby, licensed GPLv3 +* Lightweight and scalable +* Uses asynchronous network IO for both server and client connections (via EventMachine) +* Attempts to reply to queries using four different methods: + * Cached key in CouchDB (coming soon) + * Webfinger (coming soon) + * DNS (maybe?) + * HKP keyserver pool (https://hkps.pool.sks-keyservers.net) + +Why Nickserver? +---------------------------------- + +Why bother writing Nickserver instead of just using the existing HKP keyservers? + +* Keyservers are fundamentally different: Nickserver is a registry of 1:1 + mapping from nick (uid) to public key. Keyservers are directories of public + keys, which happen to have some uid information in the subkeys, but there is + no way to query for an exact uid. + +* Support clients: the goal is to provide clients with a cloud-based method of + rapidly and easily converting nicks to keys. Client code can stay simple by + pushing more of the work to the server. + +* Enhancements over keyservers: the goal with Nickserver is to support future + enhancements like webfinger, DNS key lookup, mail-back verification, network + perspective, and fast distribution of short lived keys. + +* Scalable: the goal is for a service that can handle many simultaneous + requests very quickly with low memory consumption. + +API +================================== + +You query the nickserver via HTTP. The API is very minimal at the moment: + + curl -X GET hostname:6425/key/ + +Returns the OpenPGP public key for uid. + +Installation +================================== + +You have three fine options for installing nickserver: + +Install the gem: + + $ gem install nickserver + +Install from source: + + $ git clone git://leap.se/nickserver + $ cd nickserver + $ rake build + $ rake install + +Install for development: + + $ git clone git://leap.se/nickserver + $ cd nickserver + $ bundle + +Usage +================================== + +None yet, just a bunch of unit tests. + + rake test \ No newline at end of file diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..6bfd0d9 --- /dev/null +++ b/Rakefile @@ -0,0 +1,83 @@ +#require "bundler/gem_tasks" + +require "rubygems" +require "pty" +require "fileutils" +require "rake/testtask" + +## +## TESTING +## + +Rake::TestTask.new do |t| + t.pattern = "test/unit/*_test.rb" +end +task :default => :test + +## +## GEM BUILDING AND INSTALLING +## + +$spec_path = 'nickserver.gemspec' +$base_dir = File.dirname(__FILE__) +$spec = eval(File.read(File.join($base_dir, $spec_path))) +$gem_path = File.join($base_dir, 'pkg', "#{$spec.name}-#{$spec.version}.gem") + +def run(cmd) + PTY.spawn(cmd) do |output, input, pid| + begin + while line = output.gets do + puts line + end + rescue Errno::EIO + end + end +rescue PTY::ChildExited +end + +def built_gem_path + Dir[File.join($base_dir, "#{$spec.name}-*.gem")].sort_by{|f| File.mtime(f)}.last +end + +desc "Build #{$spec.name}-#{$spec.version}.gem into the pkg directory" +task 'build' do + FileUtils.mkdir_p(File.join($base_dir, 'pkg')) + FileUtils.rm($gem_path) if File.exists?($gem_path) + run "gem build -V '#{$spec_path}'" + file_name = File.basename(built_gem_path) + FileUtils.mv(built_gem_path, 'pkg') + puts "#{$spec.name} #{$spec.version} built to pkg/#{file_name}" +end + +desc "Install #{$spec.name}-#{$spec.version}.gem into either system-wide or user gems" +task 'install' do + if !File.exists?($gem_path) + puts("Could not file #{$gem_path}. Try running 'rake build'") + else + options = '--verbose --conservative --no-rdoc --no-ri' + if ENV["USER"] == "root" + run "gem install #{options} '#{$gem_path}'" + else + home_gem_path = Gem.path.grep(/home/).first + puts "You are installing as an unprivileged user, which will result in the installation being placed in '#{home_gem_path}'." + print "Do you want to continue installing to #{home_gem_path}? [y/N] " + input = STDIN.readline + if input =~ /[yY]/ + run "gem install #{$gem_path} #{options} --install-dir '#{home_gem_path}' " + else + puts "bailing out." + end + end + end +end + +desc "Uninstall #{$spec.name}-#{$spec.version}.gem from either system-wide or user gems" +task 'uninstall' do + if ENV["USER"] == "root" + puts "Removing #{$spec.name}-#{$spec.version}.gem from system-wide gems" + run "gem uninstall '#{$spec.name}' --version #{$spec.version} --verbose -x -I" + else + puts "Removing #{$spec.name}-#{$spec.version}.gem from user's gems" + run "gem uninstall '#{$spec.name}' --version #{$spec.version} --verbose --user-install -x -I" + end +end diff --git a/lib/nickserver.rb b/lib/nickserver.rb new file mode 100644 index 0000000..9ddc839 --- /dev/null +++ b/lib/nickserver.rb @@ -0,0 +1,10 @@ + +require "nickserver/version" +require "nickserver/config" + +require "nickserver/hkp/key_info" +require "nickserver/hkp/fetch_key_info" +require "nickserver/hkp/fetch_key" + +require "nickserver/server" + diff --git a/lib/nickserver/config.rb b/lib/nickserver/config.rb new file mode 100644 index 0000000..d47fc68 --- /dev/null +++ b/lib/nickserver/config.rb @@ -0,0 +1,14 @@ +module Nickserver + class Config + class << self + attr_accessor :sks_url + attr_accessor :port + end + end + + # + # set reasonable defaults + # + Config.sks_url = 'https://hkps.pool.sks-keyservers.net:/pks/lookup' + Config.port = 6425 # aka "NICK" +end diff --git a/lib/nickserver/hkp/fetch_key.rb b/lib/nickserver/hkp/fetch_key.rb new file mode 100644 index 0000000..c72ee11 --- /dev/null +++ b/lib/nickserver/hkp/fetch_key.rb @@ -0,0 +1,51 @@ +require 'em-http' + +module Nickserver; module HKP + + class FetchKey + include EM::Deferrable + + def get(uid) + FetchKeyInfo.new.search(uid).callback {|key_info_list| + best = pick_best_key(key_info_list) + get_key_by_fingerprint(best.keyid) {|key| + self.succeed key + } + }.errback {|msg| + self.fail msg + } + self + end + + # + # fetches ascii armored OpenPGP public key from the keyserver + # + def get_key_by_fingerprint(key_id) + params = {:op => 'get', :search => "0x" + key_id, :exact => 'on', :options => 'mr'} + http = EventMachine::HttpRequest.new(Config.sks_url).get(:query => params) + http.callback { + if http.response_header.status != 200 + self.fail http.response_header.status #"Request failed with #{http.response_header.status}: #{http.response}" + else + yield http.response + end + } + http.errback { + self.fail http.error + } + end + + protected + + # + # for now, just pick the newest key. + # + # in the future, we should perhaps pick the newest key + # that is signed by the oldest key. + # + def pick_best_key(key_info_list) + key_info_list.sort {|a,b| a.creationdate <=> b.creationdate}.last + end + end + +end; end \ No newline at end of file diff --git a/lib/nickserver/hkp/fetch_key_info.rb b/lib/nickserver/hkp/fetch_key_info.rb new file mode 100644 index 0000000..48ef48a --- /dev/null +++ b/lib/nickserver/hkp/fetch_key_info.rb @@ -0,0 +1,66 @@ +require 'em-http' + +# +# used to fetch an array of KeyInfo objects that match the given uid. +# + +module Nickserver; module HKP + class FetchKeyInfo + include EM::Deferrable + + # for this regexp to work, the source text must end in a trailing "\n", + # which the output of sks does. + MATCH_PUB_KEY = /(^pub:.+?\n(^uid:.+?\n)+)/m + + def search(uid) + # in practice, exact=on seems to have no effect + params = {:op => 'vindex', :search => uid, :exact => 'on', :options => 'mr', :fingerprint => 'on'} + EventMachine::HttpRequest.new(Config.sks_url).get(:query => params).callback {|http| + if http.response_header.status != 200 + self.fail http.response_header.status + else + self.succeed parse(uid, http.response) + end + }.errback {|http| + self.fail http.error + } + self + end + + # + # input: + # uid -- uid to search for + # vindex_result -- raw output from a vindex hkp query (machine readable) + # + # returns: + # an array of eligible keys (as HKPKeyInfo objects) matching uid. + # + # keys are eliminated from eligibility for a number of reasons, including expiration, + # revocation, uid match, key length, and so on... + # + def parse(uid, vindex_result) + keys = [] + now = Time.now + vindex_result.scan(MATCH_PUB_KEY).each do |match| + key_info = KeyInfo.new(match[0]) + if key_info.uids.include?(uid) + if key_info.keylen <= 1024 + #puts 'key length is too short' + elsif key_info.expired? + #puts 'ignoring expired key' + elsif key_info.revoked? + #puts 'ignoring revoked key' + elsif key_info.disabled? + #puts 'ignoring disabled key' + elsif key_info.expirationdate && key_info.expirationdate < now + #puts 'ignoring expired key' + else + keys << key_info + end + end + end + keys + end + end + +end; end \ No newline at end of file diff --git a/lib/nickserver/hkp/key_info.rb b/lib/nickserver/hkp/key_info.rb new file mode 100644 index 0000000..adb75d8 --- /dev/null +++ b/lib/nickserver/hkp/key_info.rb @@ -0,0 +1,69 @@ +require 'cgi' + +# +# Class to represent the key information result from a query to a key server +# (but not the key itself). +# +# The initialize method parses the hkp 'machine readable' output. +# +# format definition of machine readable index output is here: +# http://tools.ietf.org/html/draft-shaw-openpgp-hkp-00#section-5.2 +# +module Nickserver; module HKP + class KeyInfo + attr_accessor :uids, :keyid, :algo, :keylen, :creationdate, :expirationdate, :flags + + def initialize(hkp_record) + uid_lines = hkp_record.split("\n") + pub_line = uid_lines.shift + @keyid, @algo, @keylen_s, @creationdate_s, @expirationdate_s, @flags = pub_line.split(':')[1..-1] + @uids = [] + uid_lines.each do |uid_line| + uid, creationdate, expirationdate, flags = uid_line.split(':')[1..-1] + # for now, ignore the expirationdate and flags of uids. sks does return them anyway + @uids << CGI.unescape(uid.sub(/.*<(.+)>.*/, '\1')) + end + end + + def keylen + @keylen ||= @keylen_s.to_i + end + + def creationdate + @creationdate ||= begin + if @creationdate_s + Time.at(@creationdate_s.to_i) + end + end + end + + def expirationdate + @expirationdate ||= begin + if @expirationdate_s + Time.at(@expirationdate_s.to_i) + end + end + end + + def rsa? + @algo == "1" + end + + def dsa? + @algo == "17" + end + + def revoked? + @flags =~ /r/ + end + + def disabled? + @flags =~ /d/ + end + + def expired? + @flags =~ /e/ + end + end + +end; end diff --git a/lib/nickserver/server.rb b/lib/nickserver/server.rb new file mode 100644 index 0000000..4201cef --- /dev/null +++ b/lib/nickserver/server.rb @@ -0,0 +1,70 @@ +require 'eventmachine' +require 'evma_httpserver' + + +# +# This is the main HTTP server that clients connect to in order to fetch keys +# +module Nickserver + class Server < EM::Connection + include EM::HttpServer + + def post_init + super + no_environment_strings + end + + def process_http_request + # the http request details are available via the following instance variables: + # @http_protocol + # @http_request_method + # @http_cookie + # @http_if_none_match + # @http_content_type + # @http_path_info + # @http_request_uri + # @http_query_string + # @http_post_content + # @http_headers + if @http_request_method == "GET" + if @http_path_info =~ /^\/key\// + send_key + else + send_error("malformed path: #{@http_path_info}") + end + else + send_error("only GET is supported") + end + end + + private + + def send_error(msg = "not supported") + send_response(:status => 500, :content => msg) + end + + def send_key + uid = CGI.unescape @http_path_info.sub(/^\/key\/(.*)/, '\1') + get_key_from_uid(uid) do |key| + send_response(:content => key) + end + end + + def send_response(opts = {}) + options = {:status => 200, :content_type => 'text/plain', :content => ''}.merge(opts) + response = EM::DelegatedHttpResponse.new(self) + response.status = options[:status] + response.content_type options[:content_type] + response.content = options[:content] + response.send_response + end + + def get_key_from_uid(uid) + Nickserver::HKP::FetchKey.new.get(uid).callback {|key| + yield key + }.errback {|status| + send_response(:status => status, :content => 'could not fetch key') + } + end + end +end \ No newline at end of file diff --git a/lib/nickserver/version.rb b/lib/nickserver/version.rb new file mode 100644 index 0000000..799ca6c --- /dev/null +++ b/lib/nickserver/version.rb @@ -0,0 +1,3 @@ +module Nickserver + VERSION = "0.0.1" +end diff --git a/nickserver.gemspec b/nickserver.gemspec new file mode 100644 index 0000000..5d0d807 --- /dev/null +++ b/nickserver.gemspec @@ -0,0 +1,27 @@ +# -*- encoding: utf-8 -*- +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'nickserver/version' + +Gem::Specification.new do |gem| + gem.name = "nickserver" + gem.version = Nickserver::VERSION + gem.authors = ["elijah"] + gem.email = ["elijah@riseup.net"] + gem.description = %q{Provides a directory service to map uid to public key.} + gem.summary = %q{Nickserver provides the ability to map a uid (user@domain.org) to a public key. This is the opposite of a key server, whose job it is to map public key to uid. Nickserver is lightweight and asynchronous.} + gem.homepage = "https://leap.se" + + gem.files = `git ls-files`.split($/) + gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) } + gem.test_files = gem.files.grep(%r{^(test|spec|features)/}) + gem.require_paths = ["lib"] + + gem.add_development_dependency 'rake' + gem.add_development_dependency 'minitest' + gem.add_development_dependency 'webmock' + + gem.add_dependency 'eventmachine' + gem.add_dependency 'em-http-request' + gem.add_dependency 'eventmachine_httpserver' +end diff --git a/test/files/hkp_vindex_result b/test/files/hkp_vindex_result new file mode 100644 index 0000000..677c242 --- /dev/null +++ b/test/files/hkp_vindex_result @@ -0,0 +1,21 @@ +info:1:7 +pub:0EE5BE979282D80B9F7540F1CCD2ED94D21739E9:1:4096:1180812858:1424970931: +uid:Lemur :1330362947:: +uid:Lemur :1330362946:: +uat:::: +pub:B59941F741EAEAF8726F45D88974E514A54B6365:1:2048:944761959:1180812858: +uid:Lemur :1032066007:: +uid:Lemur :1165682982:: +uat:::: +pub:3790027A:1:4096:1354554342:: +uid:Gazelle :1354554342:: +pub:997FA77F:1:4096:1243472517:: +uid:Gazelle :1304892367:: +uid:Gazelle :1354352902:: +pub:3A893F69:1:4096:1304037659:: +uid:Frog :1304037659:: +pub:00440025:1:4096:1243467172:: +uid:Frog :1243467172:: +pub:2518C3B5:17:1024:1089226421:: +uid:Frog :1089226421:: + diff --git a/test/files/leap_public_key b/test/files/leap_public_key new file mode 100644 index 0000000..d58631c --- /dev/null +++ b/test/files/leap_public_key @@ -0,0 +1,46 @@ +-----BEGIN PGP PUBLIC KEY BLOCK----- +mQINBFCCWqkBEACrs4OtFflza37rQR8s9NWdhvU/DCwDWKV08RjOWqIlcc2Y/nfIkQnSsqZR +Bv5n7AVwSPvlMNPC3AHA19HtrN7OKWCbWhIAy0Pu1snIO9ETItCl5F5Jv0dXPrL/iJQLJvv0 +rI+uLivFJ4ovn+y6WQum5/toP4SMxbePQfmpB/qhJZPCWQabP6TK3uryHv+BdJRY8Z+Vx9M5 +GPHqRnC+3DvlRW/dUFze0YLa1X0aQ6oWX5Fa9bGmMWCt0Z9xvNk0eghe7yz3woE7QPQ+ajeX +sTeLFDKTSJCuL1soA1UqsFQFtiOYzBkTOlrkkv7HTSyBNbQ/kTFGNsarcAJXnup++wSnDKWb +s0Cux2dwDukdpffN3y1RTPPHHeUEh2kmX44/EOpB1PtCaJALXPu3z+HmVBoE75vTZi7r+tES +Kb8NYe3cYAsp2jiE5veNLibps0emK+w+wpnRaibKL1EG6BdOR5nhIG7TxE/RhDVBBdiWO/8Z +OiXFGVN9vwiK1zP1kuQR4LcFPu32an49mTUROlkuGMhTw0fbMzfMvU31JDBR9uX0Qfo8uVpc +drG+Bs9XYOlYnjnbP26izy78RdwuNrcAU3WJMF3cVdYj3aGhhyv62tXSdjJEdDnagRXWDxAh +crj94vu5vSpgzV4yJeIaXnHxNKmMBiyTLsBFe7hc/hgnXbVSPwARAQABtFlDbG91ZGFkbWlu +IGF0IExFQVAuc2UgKENvbGxlY3RpdmUga2V5IGZvciBpbmZyYXN0cnVjdHVyZSBhdCBMRUFQ +LnNlKSA8Y2xvdWRhZG1pbkBsZWFwLnNlPokCPQQTAQgAJwUCUIJaqQIbAwUJAeEzgAULCQgH +AwUVCgkICwUWAgMBAAIeAQIXgAAKCRDQQesRsWR0kFwvEACei5oOFs0k3PNQrOEmJLTWE7sp +AGxwUJF4pkXSXmIiFLPeMgtmarvCpfZGqthxvaDXlU/emwpgGyylm6TBWUuUGdBM0APUWb8y +9AxObbtHgyXUi5Wur158pDoPuLXEptwEbgnWxO0N32GO06wdBO9uMnZP/aZo6lpM3Cl+s8UD +3D5QqqxcDdqM0exg2cOOLLrYqTXMXLdba+svZ8Johdl319cbNp+qJKC8PaSy46y+4trPljzg +va0buLsofWQ3wY185OzJEcND3jvQnLZYfTTy0fTcqILwZB/eT/ZHScDoWB5gRaqfceCX65jm +Qj46DuFzY7XItSU1nL8G0xH/P+o6cukFdNCBRCEEeVHKoEzGl9CcuHbISiDp0OIKQTiULQ5p +eB58rwlgRXK0jHwJxaTmQtWhpxZdIS6dWTXkcqobQAKMHgSZaRol5ahhEHpNQN3x0WyQm6nF +vZhjofg/dPCw6JC/f4hv+KgQtbkMDrEo0O6uIb8OGYOouPqsJe20/MN90ZrtQzQDxe2+cXiC +YoL/JhvMet/duJHPX62U1Dq2BmPj/9VgI3z+/Opj1UX5LyxGz5YknmVwMP/6VOGcOMcvuxF6 +GK4c49+opu7kG8g7sqX7jnQT31HgIM/Jr8Kw9NLY6QUx1F7mmJSq+7+6hRF3u4FCEJvUemlz ++u8q0CiHAbkCDQRQglqpARAA9isHdOqV0rC1nCghFXQkRTLyLfrcAiGMST608WXXL+Vw68HK +kRZKoYEOFNGJkT8gxNX/8chCjeN9+j3pTnBPCGQkRaY1mHyN12nVKM5s4pvsJHJntD+Km3Dw +B/uyB2iFjkkBruKSzihgCMsv0gU/dqc3Du9yqmSy7xcUGmpd4px4khJN4MuwyAxZfTjInKxI +4ooSWzOmZ5Vu7y1Yt0KzB/G/SEqPRwUMoS4b0zGbbha2E+5pl08c0JlADEoQYxWXVlkySCq0 +WqXDG9Th7XJt9rwj5BcrlIR8pUurzZIE1m4IC9BqMbXugav5fJY02PQILSOf+2nD+3jIQw5J +c2FdvoRfAM6gAfMNuLRg78i8eMtqjgwnqG4OLm/0VQ81Hwv+ihyedX/7fXjFl4KAn6Qsw9c/ +L/V6AG1HrFFZMzDDkcenVOZFlTyENu2NiTYkwxCw4qwpMSK0dSvjBanuQTsMzHWbgvVK8z9E +GI5K8JDyhA29/4baCpPEgWgnGTwBOYTk3g6QsX2eZqq+SodYNMARORmw3B+vOFH2assFmbXh +qVoEtIHLKZ/S8lPe2Tlg1WxNUPpft2KbsElpiW8S9mhQQpY9o0keLLwV7hoyU8CdPXk9jdNL +32oWEnnrR7pmG+Tw6VzbPjlRxHLa2AppI4YTdvpqdrI8mqKnXb6rsogWoR8AEQEAAYkCJQQY +AQgADwUCUIJaqQIbDAUJAeEzgAAKCRDQQesRsWR0kEJPD/9g8Qp5Rz0c16PxER7kNsK+Ej6u +2AXo+TOtc3caZ3nbGWUfm0o3OrhAQIRvoFHyAQjcaXnRh/v2GRbZ1L3ZVIwjeQXN/iGSve87 +h/Im2UHZIXj92N2xU0zIPNqPrVUeMJ63ubOnUL+4syzxkqJFKUcNIUFwAY4caaT04AYw6dRW +Fc5ns7CGwqxUoxNUIIwUsHw0ntzukxsABOMqchinDWWliduokDZUY209VYu1XCnYY7tLFmCu +K2pdyo5ax7E9DoaAxbfLTLDYrLwlli8G0pI0H1sOUkeqeWKQcezGow7KEjKdSVXsUcNDqZLB +Ap1fS0tMLJokZOebL+yDTSsQfS6+MGMo9wv/QYQ/D/dV6vjZxR8T6g5ZkU5JD6EA3wep2HbB +h6G9GdVNE0K/3gBm9XeJ4blwWbx6n9TaevixV0WBe2iCxDFgVPiqG0Sc+f1+3ejcaRDcgDjI +c38O1z9Z0WxjSTh1Qben+D5zWHZvw/jRIokBltVS2yQqweZJffb4JCI2zuOpRo73YqRlKc45 +Kg3tIzmnlSwJLs5XjRuXhG+SZ/qydwWQ8KBL1FPUIb6oKDfkChga9WIrawVa2SNU6IngSBw2 +m+Jfd21IVScX2mzLzATe1GMDs9RY7GoxD0cznbv2HXzFvdOSI8ukWatlw3S4AICetp44dEJi +eFpdYglTIA== +=wcWV +-----END PGP PUBLIC KEY BLOCK----- \ No newline at end of file diff --git a/test/files/leap_vindex_result b/test/files/leap_vindex_result new file mode 100644 index 0000000..cdb4e46 --- /dev/null +++ b/test/files/leap_vindex_result @@ -0,0 +1,4 @@ +info:1:1 +pub:E818C478D3141282F7590D29D041EB11B1647490:1:4096:1350720169:1382256169: +uid:Cloudadmin at LEAP.se (Collective key for infrastructure at LEAP.se) :1350720169:: + diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..031a90f --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,75 @@ +$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib') + +require 'rubygems' +require 'minitest/autorun' +require 'webmock/minitest' +require 'nickserver' + +class MiniTest::Unit::TestCase + # Add global extensions to the test case class here + + def setup + # by default, mock all non-localhost network connections + WebMock.disable_net_connect!(:allow_localhost => true) + end + + def file_content(filename) + (@file_contents ||= {})[filename] ||= File.read("%s/files/%s" % [File.dirname(__FILE__), filename]) + end + + def real_network + if ENV['REAL_NET'] == 'true' + WebMock.allow_net_connect! + yield + WebMock.disable_net_connect! + end + end + + def stub_vindex_response(uid, opts = {}) + options = {:status => 200, :body => ""}.merge(opts) + stub_http_request(:get, Nickserver::Config.sks_url).with( + :query => {:op => 'vindex', :search => uid, :exact => 'on', :options => 'mr', :fingerprint => 'on'} + ).to_return(options) + end + + def stub_get_response(key_id, opts = {}) + options = {:status => 200, :body => ""}.merge(opts) + stub_http_request(:get, Nickserver::Config.sks_url).with( + :query => {:op => 'get', :search => "0x"+key_id, :exact => 'on', :options => 'mr'} + ).to_return(options) + end + + #def without_webmock + # WebMock.disable_net_connect!(:allow_localhost => true) + # yield + # WebMock.disable_net_connect! + #end +end + +# +# a simple EM connection with callbacks for various lifecycle stages, +# useful for testing +# +class TestSocketClient < EventMachine::Connection + attr_writer :onopen, :onclose, :onmessage + attr_reader :data + + def initialize + @state = :new + @data = [] + end + + def receive_data(data) + @data << data + if @state == :new + @onopen.call if @onopen + @state = :open + else + @onmessage.call(data) if @onmessage + end + end + + def unbind + @onclose.call if @onclose + end +end diff --git a/test/unit/hkp_test.rb b/test/unit/hkp_test.rb new file mode 100644 index 0000000..c9c28cf --- /dev/null +++ b/test/unit/hkp_test.rb @@ -0,0 +1,120 @@ +require File.expand_path('test_helper', File.dirname(__FILE__)) + +class HkpTest < MiniTest::Unit::TestCase + + def test_key_info_expired + fetch_key_info(:hkp_vindex_result, 'lemur@leap.se') do |keys| + assert_equal 1, keys.length, 'should find a single key' + assert_equal ['lemur@example.org', 'lemur@leap.se'].sort, keys.first.uids.sort, 'should find both uids' + assert_equal '0EE5BE979282D80B9F7540F1CCD2ED94D21739E9', keys.first.keyid + end + end + + def test_key_info_multiple_valid_results + fetch_key_info :hkp_vindex_result, 'gazelle@leap.se' do |keys| + assert_equal 2, keys.length, 'should find two keys' + assert_equal ['gazelle@leap.se'], keys.first.uids + assert_equal '3790027A', keys.first.keyid + assert keys.last.uids.include? 'gazelle@leap.se' + end + end + + def test_key_info_reject_keysize + fetch_key_info :hkp_vindex_result, 'frog@leap.se' do |keys| + assert_equal 1, keys.length, 'should find one key' + assert_equal '00440025', keys.first.keyid + end + end + + def test_key_info_not_found + uid = 'leaping_lemur@leap.se' + stub_vindex_response(uid, :status => 404) + test_em_errback "Nickserver::HKP::FetchKeyInfo.new.search '#{uid}'" do |error| + assert_equal 404, error + end + end + + def test_key_info_real_network + real_network do + uid = 'elijah@riseup.net' + test_em_callback "Nickserver::HKP::FetchKeyInfo.new.search '#{uid}'" do |keys| + assert_equal 1, keys.size + assert keys.first.keyid =~ /00440025$/ + end + end + end + + def test_fetch_key + uid = 'cloudadmin@leap.se' + key_id = 'E818C478D3141282F7590D29D041EB11B1647490' + stub_vindex_response(uid, :body => file_content(:leap_vindex_result)) + stub_get_response(key_id, :body => file_content(:leap_public_key)) + + test_em_callback "Nickserver::HKP::FetchKey.new.get '#{uid}'" do |key_text| + assert_equal file_content(:leap_public_key), key_text + end + end + + def test_fetch_key_not_found + uid = 'cloudadmin@leap.se' + key_id = 'E818C478D3141282F7590D29D041EB11B1647490' + + stub_vindex_response(uid, :body => file_content(:leap_vindex_result)) + stub_get_response(key_id, :status => 404) + + test_em_errback "Nickserver::HKP::FetchKey.new.get '#{uid}'" do |error| + assert_equal 404, error + end + end + + protected + + # + # Takes a code snippet that returns a Deferrable, and yields the callback result. + # Assertion fails if errback is called instead of callback. + # + # This method takes care of the calls to EM.run and EM.stop. It works kind of like EM.run_block, + # except I couldn't get run_block to work with multiple nested HTTP requests. + # + def test_em_callback(code, &block) + EM.run do + deferrable = instance_eval(code) + deferrable.callback {|response| + EM.stop + yield response + return + } + deferrable.errback {|response| + EM.stop + flunk "Expecting callback, but errback invoked with response: #{response}" + } + end + assert false, 'should not get here' + end + + # + # like test_em_callback, except value yielded is the result of errback, and + # we raise an exception if errback was not called. + # + def test_em_errback(code, &block) + EM.run do + deferrable = instance_eval(code) + deferrable.callback {|response| + EM.stop + flunk "Expecting errback, but callback invoked with response: #{response}" + } + deferrable.errback {|response| + EM.stop + yield response + return + } + end + assert false, 'should not get here' + end + + def fetch_key_info(body_source, uid, &block) + stub_vindex_response(uid, :body => file_content(body_source)) + test_em_callback "Nickserver::HKP::FetchKeyInfo.new.search '#{uid}'", &block + end + +end diff --git a/test/unit/server_test.rb b/test/unit/server_test.rb new file mode 100644 index 0000000..ba462d0 --- /dev/null +++ b/test/unit/server_test.rb @@ -0,0 +1,34 @@ +require File.expand_path('test_helper', File.dirname(__FILE__)) + +class ServerTest < MiniTest::Unit::TestCase + + def test_server + uid = 'cloudadmin@leap.se' + key_id = 'E818C478D3141282F7590D29D041EB11B1647490' + stub_vindex_response(uid, :body => file_content(:leap_vindex_result)) + stub_get_response(key_id, :body => file_content(:leap_public_key)) + + EM.run do + EM.start_server '0.0.0.0', Nickserver::Config.port, Nickserver::Server + + params = {:query => {}, :path => "key/#{CGI.escape(uid)}"} + http = EventMachine::HttpRequest.new("http://localhost:#{Nickserver::Config.port}").get(params) + http.callback { + assert_equal file_content(:leap_public_key), http.response + EM.stop + }.errback { + puts http.error + EM.stop + } + + #socket = EM.connect('0.0.0.0', Nickserver::Config.port, TestSocketClient) + #socket.onopen = lambda { + # server.players.size.should == 1 + # socket.data.last.chomp.should == "READY" + # EM.stop + #} + end + end + +end + diff --git a/test/unit/test_helper.rb b/test/unit/test_helper.rb new file mode 100644 index 0000000..ade21a0 --- /dev/null +++ b/test/unit/test_helper.rb @@ -0,0 +1 @@ +require File.dirname(File.dirname(__FILE__)) + '/test_helper' \ No newline at end of file -- cgit v1.2.3