diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbe355 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/Makefile b/Makefile index ca61c64..65cf983 100644 --- a/Makefile +++ b/Makefile @@ -57,7 +57,7 @@ OBJECTS_MIRACL=${MIRACL_LIB_DIR}/*.o MIRACL_LIB=${EXT}/miracl_lib/miracl.a -all: miracl core bench demo +all: miracl core bench demo cuckoo @echo "make all done." @@ -72,6 +72,9 @@ bench: demo: ${CC} -o demo.exe ${SRC}/mains/psi_demo.cpp ${OBJECTS_DHPSI} ${OBJECTS_OTPSI} ${OBJECTS_NAIVE} ${OBJECTS_SERVERAIDED} ${OBJECTS_UTIL} ${OBJECTS_HASHING} ${OBJECTS_CRYPTO} ${OBJECTS_OT} ${OBJECTS_MIRACL} ${CFLAGS} ${DEBUG_OPTIONS} ${LIBRARIES} ${MIRACL_LIB} ${INCLUDE} ${COMPILER_OPTIONS} +cuckoo: + ${CC} -o cuckoo.exe ${SRC}/mains/cuckoo_analysis.cpp ${OBJECTS_UTIL} ${OBJECTS_HASHING} ${OBJECTS_CRYPTO} ${OBJECTS_MIRACL} ${CFLAGS} ${DEBUG_OPTIONS} ${LIBRARIES} ${MIRACL_LIB} ${INCLUDE} ${COMPILER_OPTIONS} + # this will create a copy of the files in ${SOURCES_MIRACL} and its sub-directories and put them into ${MIRACL_LIB_DIR} without sub-directories, then compile it miracl: ${MIRACL_LIB_DIR}/miracl.a @@ -83,7 +86,7 @@ ${MIRACL_LIB_DIR}/miracl.a: ${SOURCES_MIRACL} # only clean example objects, test object and binaries clean: - rm -f ${OBJECTS_EXAMPLE} ${OBJECTS_TEST} *.exe ${OBJECTS_DHPSI} ${OBJECTS_OTPSI} ${OBJECTS_NAIVE} ${OBJECTS_SERVERAIDED} ${OBJECTS_UTIL} ${OBJECTS_CRYPTO} ${OBJECTS_OT} + rm -f ${OBJECTS_EXAMPLE} ${OBJECTS_TEST} *.exe ${OBJECTS_DHPSI} ${OBJECTS_OTPSI} ${OBJECTS_HASHING} ${OBJECTS_CRYPTO} ${OBJECTS_NAIVE} ${OBJECTS_SERVERAIDED} ${OBJECTS_UTIL} ${OBJECTS_CRYPTO} ${OBJECTS_OT} # this will clean everything: example objects, test object and binaries and the Miracl library cleanall: clean diff --git a/sample_sets/emails_bob.txt b/sample_sets/emails_bob.txt index 5cce43c..046801b 100644 --- a/sample_sets/emails_bob.txt +++ b/sample_sets/emails_bob.txt @@ -1,7 +1,7 @@ +Michael.Zohner@ec-spride.de Wolfram.Hipp@yahoo.co.jp Carl.Zitzmann@facebook.com Tilmann.Wittke@neuf.fr -Michael.Zohner@ec-spride.de Leila.Thiele@love.com Andres.Wölfle@o2.co.uk Semra.Kranz@live.com.ar diff --git a/src/hashing/cuckoo.cpp b/src/hashing/cuckoo.cpp index 377f37d..948297e 100644 --- a/src/hashing/cuckoo.cpp +++ b/src/hashing/cuckoo.cpp @@ -8,12 +8,21 @@ #include "cuckoo.h" //returns a cuckoo hash table with the first dimension being the bins and the second dimension being the pointer to the elements -uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_t bitlen, uint32_t *outbitlen, uint32_t* nelesinbin, +#ifndef TEST_UTILIZATION +uint8_t* +#else +uint32_t +#endif +cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_t bitlen, uint32_t *outbitlen, uint32_t* nelesinbin, uint32_t* perm, uint32_t ntasks, prf_state_ctx* prf_state) { //The resulting hash table uint8_t* hash_table; +#ifdef DOUBLE_TABLE + cuckoo_entry_ctx*** cuckoo_table; +#else cuckoo_entry_ctx** cuckoo_table; +#endif cuckoo_entry_ctx* cuckoo_entries; uint32_t i, j; uint32_t *perm_ptr; @@ -28,12 +37,18 @@ uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint3 init_hashing_state(&hs, neles, bitlen, nbins, prf_state); *outbitlen = hs.outbitlen; - +#ifdef DOUBLE_TABLE + cuckoo_table = (cuckoo_entry_ctx***) calloc(2, sizeof(cuckoo_entry_ctx**)); + cuckoo_table[0] = (cuckoo_entry_ctx**) calloc(nbins, sizeof(cuckoo_entry_ctx*)); + cuckoo_table[1] = (cuckoo_entry_ctx**) calloc(nbins, sizeof(cuckoo_entry_ctx*)); +#else cuckoo_table = (cuckoo_entry_ctx**) calloc(nbins, sizeof(cuckoo_entry_ctx*)); +#endif cuckoo_entries = (cuckoo_entry_ctx*) malloc(neles * sizeof(cuckoo_entry_ctx)); entry_gen_tasks = (pthread_t*) malloc(sizeof(pthread_t) * ntasks); ctx = (cuckoo_entry_gen_ctx*) malloc(sizeof(cuckoo_entry_gen_ctx) * ntasks); +#ifndef TEST_UTILIZATION for(i = 0; i < ntasks; i++) { ctx[i].elements = elements; ctx[i].cuckoo_entries = cuckoo_entries; @@ -53,13 +68,20 @@ uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint3 exit(0); } } - +#else + ctx[0].elements = elements; + ctx[0].cuckoo_entries = cuckoo_entries; + ctx[0].hs = &hs; + ctx[0].startpos = 0; + ctx[0].endpos = neles; + gen_cuckoo_entries(ctx); +#endif //for(i = 0; i < nbins; i++) { // cout << "Address " << i << " mapped to " << hs.address_used[i] << " times" << endl; //} //insert all elements into the cuckoo hash table for(i = 0; i < neles; i++) { - if(!(insert_element(cuckoo_table, cuckoo_entries + i))) { + if(!(insert_element(cuckoo_table, cuckoo_entries + i, neles))) { #ifdef COUNT_FAILS fails++; /*cout << "insertion failed for element " << (hex) << (*(((uint32_t*) elements)+i)) << ", inserting to address: "; @@ -68,19 +90,16 @@ uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint3 } cout << (dec) << endl;*/ #else - //cerr << "Insertion not successful for element " < 0) - cout << "insertion performed with " << fails << " fails" << endl; -#endif - //Copy the final state of the cuckoo table into the hash table perm_ptr = perm; + +#ifndef TEST_UTILIZATION hash_table = (uint8_t*) calloc(nbins, hs.outbytelen); for(i = 0; i < nbins; i++) { @@ -96,22 +115,32 @@ uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint3 } } - //Cleanup +#endif + #ifndef TEST_UTILIZATION + + //Cleanup for(i = 0; i < neles; i++) { - //for(j = 0; j < NUM_HASH_FUNCTIONS; j++) { - free(cuckoo_entries[i].val); - //} + free(cuckoo_entries[i].val); } #endif free(cuckoo_entries); +#ifdef DOUBLE_TABLE + free(cuckoo_table[0]); + free(cuckoo_table[1]); +#else free(cuckoo_table); +#endif free(entry_gen_tasks); free(ctx); free_hashing_state(&hs); +#ifdef TEST_UTILIZATION + return fails; +#else return hash_table; +#endif } @@ -135,15 +164,17 @@ inline void gen_cuckoo_entry(uint8_t* in, cuckoo_entry_ctx* out, hs_t* hs, uint3 out->pos = 0; out->eleid = ele_id; - //for(i = 0; i < NUM_HASH_FUNCTIONS; i++) { #ifndef TEST_UTILIZATION out->val = (uint8_t*) malloc(hs->outbytelen); #endif - hashElement(in, out->address, out->val, hs); - //} + hashElement(in, out->address, out->val, hs); } -inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element) { +#ifdef DOUBLE_TABLE +inline bool insert_element(cuckoo_entry_ctx*** ctable, cuckoo_entry_ctx* element, uint32_t max_iterations) { +#else +inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element, uint32_t max_iterations) { +#endif cuckoo_entry_ctx *evicted, *tmp_evicted; uint32_t i, ev_pos, iter_cnt; #ifdef DEBUG_CUCKOO @@ -151,21 +182,40 @@ inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element) << element->address[element->pos] << " or " << element->address[element->pos^1] << endl; #endif - for(iter_cnt = 0, evicted = element; iter_cnt < MAX_ITERATIONS; iter_cnt++) { + for(iter_cnt = 0, evicted = element; iter_cnt < max_iterations; iter_cnt++) { //TODO: assert(addr < MAX_TAB_ENTRIES) for(i = 0; i < NUM_HASH_FUNCTIONS; i++) {//, ele_pos=(ele_pos+1)%NUM_HASH_FUNCTIONS) { - if(ctable[evicted->address[i]] == NULL) { - ctable[evicted->address[i]] = evicted; +#ifdef DOUBLE_TABLE + if(ctable[i][evicted->address[i]] == NULL) { + ctable[i][evicted->address[i]] = evicted; evicted->pos = i; return true; } +#else + if(ctable[evicted->address[i]] == NULL) { + ctable[evicted->address[i]] = evicted; + evicted->pos = i; +#ifdef TEST_CHAINLEN + chain_cnt[iter_cnt]++; +#endif + return true; + } +#endif } //choose random bin to evict other element +#if NUM_HASH_FUNCTIONS == 2 + ev_pos = evicted->address[evicted->pos% NUM_HASH_FUNCTIONS]; +#else ev_pos = evicted->address[(evicted->pos^iter_cnt) % NUM_HASH_FUNCTIONS]; - +#endif +#ifdef DOUBLE_TABLE + tmp_evicted = ctable[evicted->pos][ev_pos]; + ctable[evicted->pos][ev_pos] = evicted; +#else tmp_evicted = ctable[ev_pos]; ctable[ev_pos] = evicted; +#endif evicted = tmp_evicted; //change position - if the number of HF's is increased beyond 2 this should be replaced by a different strategy @@ -175,3 +225,13 @@ inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element) //the highest number of iterations has been reached return false; } + +#ifdef TEST_CHAINLEN +void print_chain_cnt() { + //cout << "Chain Count: " << endl; + for(uint32_t i = 0; i < MAX_ITERATIONS; i++) { + //if(chain_cnt[i] > 0) + cout << i << "\t" << chain_cnt[i] << endl; + } +} +#endif diff --git a/src/hashing/cuckoo.h b/src/hashing/cuckoo.h index cc0ddc3..a689f3c 100644 --- a/src/hashing/cuckoo.h +++ b/src/hashing/cuckoo.h @@ -10,10 +10,18 @@ #include "hashing_util.h" -#define MAX_ITERATIONS 1000 +#define MAX_ITERATIONS 1024 //#define DEBUG_CUCKOO -//#define COUNT_FAILS +#ifdef TEST_UTILIZATION +#define COUNT_FAILS +#endif +//#define DOUBLE_TABLE +//#define TEST_CHAINLEN +#ifdef TEST_CHAINLEN +static uint64_t chain_cnt[MAX_ITERATIONS]; +void print_chain_cnt(); +#endif struct cuckoo_entry_ctx { //id of the element in the source set @@ -30,6 +38,7 @@ struct cuckoo_entry_ctx { }; + struct cuckoo_entry_gen_ctx { //starting position in the generation process uint32_t startpos; @@ -48,12 +57,21 @@ struct cuckoo_entry_gen_ctx { //returns a cuckoo hash table with the first dimension being the bins and the second dimension being the pointer to the elements -uint8_t* cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_t bitlen, uint32_t* outbitlen, uint32_t* nelesinbin, +#ifndef TEST_UTILIZATION +uint8_t* +#else +uint32_t +#endif +cuckoo_hashing(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_t bitlen, uint32_t* outbitlen, uint32_t* nelesinbin, uint32_t* perm, uint32_t ntasks, prf_state_ctx* prf_state); //routine for generating the entries, is invoked by the threads void *gen_cuckoo_entries(void *ctx); inline void gen_cuckoo_entry(uint8_t* in, cuckoo_entry_ctx* out, hs_t* hs, uint32_t ele_id); -inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element); +#ifdef DOUBLE_TABLE +inline bool insert_element(cuckoo_entry_ctx*** ctable, cuckoo_entry_ctx* element, uint32_t max_iterations); +#else +inline bool insert_element(cuckoo_entry_ctx** ctable, cuckoo_entry_ctx* element, uint32_t max_iterations); +#endif diff --git a/src/hashing/hashing_util.h b/src/hashing/hashing_util.h index 580ad9a..bdad1ac 100644 --- a/src/hashing/hashing_util.h +++ b/src/hashing/hashing_util.h @@ -13,13 +13,14 @@ typedef uint16_t TABLEID_T; -#define NUM_HASH_FUNCTIONS 2 +//#define TEST_UTILIZATION +//#define NUM_HASH_FUNCTIONS 2 +#define NUM_HASH_FUNCTIONS 3 #define MAX_TABLE_SIZE_BYTES sizeof(TABLEID_T) #define DUMMY_ENTRY_SERVER 0x00 #define DUMMY_ENTRY_CLIENT 0xFF #define USE_LUBY_RACKOFF -//#define TEST_UTILIZATION typedef struct hashing_state_ctx { uint32_t** hf_values[NUM_HASH_FUNCTIONS]; @@ -103,9 +104,15 @@ static void init_hashing_state(hs_t* hs, uint32_t nelements, uint32_t inbitlen, } static void free_hashing_state(hs_t* hs) { - uint32_t i; - for(i = 0; i < NUM_HASH_FUNCTIONS; i++) + uint32_t i, j; + for(i = 0; i < NUM_HASH_FUNCTIONS; i++) { + for(j = 0; j < hs->nhfvals; j++) { + free(hs->hf_values[i][j]); + } free(hs->hf_values[i]); + } + free(hs->address_used); + //free(hs->hf_values); } //reduce the bit-length of the elements if some bits are used to determine the bin and a permutation is used for hashing @@ -151,17 +158,19 @@ inline void hashElement(uint8_t* element, uint32_t* address, uint8_t* val, hs_t* //cout << "i = " << i << ", j = " << j << ", Hfmaskaddr = " << hfmaskaddr << endl; //cout << "Hfvalue: " << hs->hf_values[i][j][hfmaskaddr] << endl; address[i] = (L ^ *((hs->hf_values[i][j]+hfmaskaddr))) % hs->nbins; + //address[i] = (L ^ (i * R)) % hs->nbins; } //cout << address[i] << ", "; //hs->address_used[address[i]]++; } //cout << endl; +#ifndef TEST_UTILIZATION *((uint32_t*) val) = R; //TODO copy remaining bits if(hs->outbytelen >= sizeof(uint32_t)) memcpy(val + (sizeof(uint32_t) - hs->addrbytelen), element + sizeof(uint32_t), hs->outbytelen - sizeof(uint32_t)); - +#endif //cout << "Address for hfid = " << hfid << ": " << *address << ", L = " << L << ", R = " << R << endl; #else diff --git a/src/ot-based/ot-psi.cpp b/src/ot-based/ot-psi.cpp index 32fa3e4..b001348 100644 --- a/src/ot-based/ot-psi.cpp +++ b/src/ot-based/ot-psi.cpp @@ -7,80 +7,6 @@ #include "ot-psi.h" -/*int32_t main(int32_t argc, char** argv) { - uint32_t pid, nelements=10, elebytelen=4, symsecbits=80, - intersect_size, i, ntasks=1, runs=1, j; - int32_t nargs=8; - uint8_t *elements, *intersection; - const char* address; - uint16_t port; - timeval begin, end; - //CSocket* sockfd = (CSocket*) malloc(sizeof(CSocket) * ntasks); - vector sockfd(ntasks); - role_type role = (role_type) 0; - double epsilon=1.2; - - if(argc < nargs) { - print_ot_psi_usage(); - } - - pid = atoi(argv[1]); - nelements = atoi(argv[2]); - elebytelen = atoi(argv[3]); - symsecbits = atoi(argv[4]); - address = argv[5]; - port = (uint16_t) atoi(argv[6]); - epsilon = atof(argv[7]); - ntasks=atoi(argv[8]); - - if(pid == 0) { - role = SERVER; - listen(address, port, sockfd.data(), ntasks); - } else { - role = CLIENT; - for(i = 0; i < ntasks; i++) - connect(address, port, sockfd[i]); - } - - crypto crypto(symsecbits);//, const_ot_psi_seed); - elements = (uint8_t*) calloc(nelements * elebytelen, sizeof(uint8_t)); - -#ifdef SET_INPUT_ELEMENTS - for(i = 0; i < nelements; i++) { - //for(j = 0; j < elebytelen; j++) - elements[i*elebytelen] = i; - } -#endif -#ifdef PRINT_INPUT_ELEMENTS - for(i = 0; i < nelements; i++) { - cout << "Element " << i << ": " << (hex); - for(j = 0; j < elebytelen; j++) - cout << (unsigned int) elements[i*elebytelen + j]; - cout << (dec) << endl; - } -#endif - - - gettimeofday(&begin, NULL); - for(i = 0; i < runs; i++) { - crypto.gen_rnd(elements, elebytelen * nelements); - intersect_size = otpsi(nelements, elebytelen*8, elements, &intersection, &crypto, sockfd.data(), role, ntasks, epsilon); - } - gettimeofday(&end, NULL); - cout << "Computing the intersection took " << getMillies(begin, end) << " ms" << endl; - -#ifdef PRINT_INTERSECTION - cout << "Intersecting elements" << endl; - for(i = 0; i < intersect_size; i++) { - for(j = 0; j < elebytelen; j++) { - cout << (hex) << (uint32_t) intersection[i * elebytelen + j] << (dec); - } - cout << endl; - } -#endif - return 0; -}*/ - uint32_t otpsi(role_type role, uint32_t neles, uint32_t pneles, uint32_t* elebytelens, uint8_t** elements, uint8_t*** result, uint32_t** res_bytelen, crypto* crypt_env, CSocket* sock, uint32_t ntasks, double epsilon, @@ -126,15 +52,16 @@ uint32_t otpsi(role_type role, uint32_t neles, uint32_t pneles, uint32_t* elebyt intersect_size = otpsi_client(eleptr, neles, nbins, pneles, internal_bitlen, maskbitlen, crypt_env, sock, ntasks, &prf_state, &res_pos); - std::sort(res_pos, res_pos+intersect_size); + //std::sort(res_pos, res_pos+intersect_size); - *result = (uint8_t**) malloc(intersect_size * sizeof(uint8_t*)); - *res_bytelen = (uint32_t*) malloc(intersect_size * sizeof(uint32_t)); - for(i = 0; i < intersect_size; i++) { + //*result = (uint8_t**) malloc(intersect_size * sizeof(uint8_t*)); + //*res_bytelen = (uint32_t*) malloc(intersect_size * sizeof(uint32_t)); + /*for(i = 0; i < intersect_size; i++) { (*res_bytelen)[i] = elebytelens[res_pos[i]]; (*result)[i] = (uint8_t*) malloc((*res_bytelen)[i]); memcpy((*result)[i], elements[res_pos[i]], (*res_bytelen)[i]); - } + }*/ + create_result_from_matches_var_bitlen(result, res_bytelen, elebytelens, elements, res_pos, intersect_size); } free(eleptr); @@ -173,7 +100,6 @@ uint32_t otpsi(role_type role, uint32_t neles, uint32_t pneles, uint32_t elebitl internal_bitlen = elebitlen; } - crypt_env->gen_common_seed(&prf_state, sock[0]); if(role == SERVER) { @@ -223,8 +149,14 @@ uint32_t otpsi_client(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_ if(DETAILED_TIMINGS) { gettimeofday(&t_start, NULL); } +#ifndef TEST_UTILIZATION hash_table = cuckoo_hashing(elements, neles, nbins, elebitlen, &outbitlen, nelesinbin, perm, ntasks, prf_state); +#else + cerr << "Test utilization is active, PSI protocol will not be working correctly!" << endl; + cuckoo_hashing(elements, neles, nbins, elebitlen, &outbitlen, + nelesinbin, perm, ntasks, prf_state); +#endif if(DETAILED_TIMINGS) { gettimeofday(&t_end, NULL); cout << "Time for Cuckoo hashing:\t" << fixed << std::setprecision(2) << @@ -238,6 +170,7 @@ uint32_t otpsi_client(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_ gettimeofday(&t_start, NULL); #endif #ifdef PRINT_BIN_CONTENT + cout << "Client bin content: " << endl; print_bin_content(hash_table, nbins, ceil_divide(outbitlen, 8), NULL, false); #endif @@ -248,12 +181,22 @@ uint32_t otpsi_client(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_ if(DETAILED_TIMINGS) { gettimeofday(&t_start, NULL); } + + /*uint64_t tmpmask = 0; + for(uint32_t i = 0; i < neles-1; i++) { + memcpy((uint8_t*) &tmpmask, masks + i*maskbytelen, maskbytelen); + cout << "Mask " << i << " : " << (hex) << tmpmask << (dec) << endl; //"intersection found at position " << tmpval[0] << " for key " << tmpbuf[0] << endl; + }*/ #ifdef TIMING gettimeofday(&t_end, NULL); cout << "Client: time for OPRG evaluation: " << getMillies(t_start, t_end) << " ms" << endl; gettimeofday(&t_start, NULL); #endif +/*#ifdef PRINT_BIN_CONTENT + cout << "Client masks: " << endl; + print_bin_content(masks, neles, maskbytelen, NULL, false); +#endif*/ //receive server masks server_masks = (uint8_t*) malloc(NUM_HASH_FUNCTIONS * pneles * maskbytelen); @@ -289,7 +232,7 @@ uint32_t otpsi_client(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_ #endif #ifdef PRINT_RECEIVED_VALUES cout << "Received server masks: " << endl; - print_bin_content(server_masks, NUM_HASH_FUNCTIONS*neles, maskbytelen, NULL, false); + print_bin_content(server_masks, NUM_HASH_FUNCTIONS*pneles, maskbytelen, NULL, false); #endif //query hash table using multiple threads @@ -315,7 +258,7 @@ uint32_t otpsi_client(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_ //compute intersection intersect_size = otpsi_find_intersection(result, masks, neles, server_masks, - neles * NUM_HASH_FUNCTIONS, maskbytelen, perm); + pneles * NUM_HASH_FUNCTIONS, maskbytelen, perm); if(DETAILED_TIMINGS) { gettimeofday(&t_end, NULL); @@ -397,19 +340,6 @@ void otpsi_server(uint8_t* elements, uint32_t neles, uint32_t nbins, uint32_t pn free(nelesinbin); } - - - - -void print_ot_psi_usage() { - cout << "Usage: ./otpsi [0 (server)/1 (client)] [num_elements] [element_byte_length] " - << "[sym_security_bits] [server_ip] [server_port] [CH_epsilon] [nthreads]" << endl; - cout << "Program exiting" << endl; - exit(0); -} - - - void oprg_client(uint8_t* hash_table, uint32_t nbins, uint32_t neles, uint32_t* nelesinbin, uint32_t elebitlen, uint32_t maskbitlen, crypto* crypt, CSocket* sock, uint32_t nthreads, uint8_t* res_buf) { CBitVector choices; @@ -477,10 +407,16 @@ void oprg_client(uint8_t* hash_table, uint32_t nbins, uint32_t neles, uint32_t* #ifdef PRINT_OPRG_MASKS for(i = 0, ctr=0; i < nbins; i++) { if(nelesinbin[i] > 0) { - cout << "Result for element i = " << i << " and choice = " << (hex) << - choices.Get(i * OTsPerElement*8, OTsPerElement*8) << (dec) << ": "; + cout << "Result for element i = " << i << " and choice = ";// << (hex) << + for(uint32_t j = 0; j < OTsPerElement; j++) { + //cout << (hex) << (uint32_t) hash_table[j + i * OTsPerElement] << (dec); + cout << setw(2) << setfill('0') << (hex) << (uint32_t) choices.GetByte(j + i * OTsPerElement) << (dec); + } + cout << ": "; + + //choices.Get(i * OTsPerElement*8, OTsPerElement*8) << (dec) << ": "; for(uint32_t j = 0; j < maskbytelen; j++) { - cout << (hex) << (uint32_t) res_buf[ctr * maskbytelen + j] << (dec); + cout << setw(2) << setfill('0') << (hex) << (uint32_t) res_buf[ctr * maskbytelen + j] << (dec); } cout << endl; ctr++; @@ -493,6 +429,19 @@ void oprg_client(uint8_t* hash_table, uint32_t nbins, uint32_t neles, uint32_t* evaluate_crf(res_buf, res_buf, neles, maskbytelen, crypt); +#ifdef PRINT_CRF_EVAL + for(i = 0, ctr=0; i < nbins; i++) { + if(nelesinbin[i] > 0) { + cout << "CRF Result for element i = " << i << ": "; + for(uint32_t j = 0; j < maskbytelen; j++) { + cout << setw(2) << setfill('0') << (hex) << (uint32_t) res_buf[ctr * maskbytelen + j] << (dec); + } + cout << endl; + ctr++; + } + } +#endif + if(DETAILED_TIMINGS) { gettimeofday(&t_end, NULL); cout << "Time for CRF evaluation:\t" << fixed << std::setprecision(2) << @@ -510,14 +459,14 @@ void oprg_server(uint8_t* hash_table, uint32_t nbins, uint32_t totaleles, uint32 CBitVector input, results; CBitVector baseOTchoices; uint8_t* keySeeds; - uint32_t numOTs, OTsPerElement, i, maskbytelen; + uint32_t numOTs, OTsPerBin, i, maskbytelen; OTExtension1ooNECCSender* sender; timeval t_start, t_end; maskbytelen = maskbitlen / 8; - OTsPerElement = ceil_divide(elebitlen, 8); - numOTs = nbins * OTsPerElement; + OTsPerBin = ceil_divide(elebitlen, 8); + numOTs = nbins * OTsPerBin; #ifndef BATCH cout << "Server: bins = " << nbins << ", elebitlen = " << elebitlen << " and maskbitlen = " << @@ -570,9 +519,13 @@ void oprg_server(uint8_t* hash_table, uint32_t nbins, uint32_t totaleles, uint32 #ifdef PRINT_OPRG_MASKS for(i = 0; i < totaleles; i++) { - cout << "Result for element i = " << i << ": "; + cout << "Result for element i = " << i << " "; + for(uint32_t j = 0; j < OTsPerBin; j++) { + cout << setw(2) << setfill('0') << (hex) << (uint32_t) hash_table[i * OTsPerBin + j] << (dec); + } + cout << ": "; for(uint32_t j = 0; j < maskbytelen; j++) { - cout << (hex) << (uint32_t) res_buf[i * maskbytelen + j] << (dec); + cout << setw(2) << setfill('0') << (hex) << (uint32_t) res_buf[i * maskbytelen + j] << (dec); } cout << endl; } @@ -583,6 +536,16 @@ void oprg_server(uint8_t* hash_table, uint32_t nbins, uint32_t totaleles, uint32 //evaluate correlation robust function on the elements evaluate_crf(res_buf, res_buf, totaleles, maskbytelen, crypt); +#ifdef PRINT_CRF_EVAL + for(i = 0; i < totaleles; i++) { + cout << "Result for element i = " << i << ": "; + for(uint32_t j = 0; j < maskbytelen; j++) { + cout << setw(2) << setfill('0') << (hex) << (uint32_t) res_buf[i * maskbytelen + j] << (dec); + } + cout << endl; + } +#endif + if(DETAILED_TIMINGS) { gettimeofday(&t_end, NULL); cout << "Time for CRF evaluation:\t" << fixed << std::setprecision(2) << @@ -732,11 +695,16 @@ void *otpsi_query_hash_table(void* ctx_tmp) {//GHashTable *map, uint8_t* element //TODO if this works correctly, combine with other find intersection methods and outsource to hashing_util.h uint32_t otpsi_find_intersection(uint32_t** result, uint8_t* my_hashes, uint32_t my_neles, uint8_t* pa_hashes, uint32_t pa_neles, uint32_t hashbytelen, uint32_t* perm) { + uint32_t keys_stored; uint32_t* matches = (uint32_t*) malloc(sizeof(uint32_t) * my_neles); uint32_t* tmpval; uint64_t tmpbuf; uint32_t* tmpkeys; + uint32_t* invperm = (uint32_t*) malloc(sizeof(uint32_t) * my_neles); + + for(uint32_t i = 0; i < my_neles; i++) + invperm[perm[i]] = i; uint32_t size_intersect, i, intersect_ctr, tmp_hashbytelen; @@ -782,6 +750,7 @@ uint32_t otpsi_find_intersection(uint32_t** result, uint8_t* my_hashes, } } else { matches[intersect_ctr] = tmpval[0]; + //cout << "intersection found at position " << tmpval[0] << " for key " << (hex) << tmpbuf << (dec) << endl; if(intersect_ctrfixed_key_aes_hash(&aes_key, result+i*elebytelen, elebytelen, masks+i*elebytelen, elebytelen); - //cout << "Input: " << ((uint64_t*)masks)[0] << endl; } } @@ -830,7 +798,7 @@ void print_bin_content(uint8_t* hash_table, uint32_t nbins, uint32_t elebytelen, cout << "(" << nelesinbin[i] << ") Bin " << i << ": "; for(j = 0; j < nelesinbin[i]; j++) { for(k = 0; k < elebytelen; k++, ctr++) { - cout << (hex) << (unsigned int) hash_table[ctr] << (dec); + cout << setw(2) << setfill('0') << (hex) << (unsigned int) hash_table[ctr] << (dec); } cout << " "; } @@ -840,7 +808,7 @@ void print_bin_content(uint8_t* hash_table, uint32_t nbins, uint32_t elebytelen, for(i = 0, ctr = 0; i < nbins; i++) { cout << "Bin " << i << ": "; for(k = 0; k < elebytelen; k++, ctr++) { - cout << (hex) << (unsigned int) hash_table[ctr] << (dec); + cout << setw(2) << setfill('0') << (hex) << (unsigned int) hash_table[ctr] << (dec); } cout << endl; } diff --git a/src/ot-based/ot-psi.h b/src/ot-based/ot-psi.h index f6cc19c..4ef3a39 100644 --- a/src/ot-based/ot-psi.h +++ b/src/ot-based/ot-psi.h @@ -20,6 +20,7 @@ #include "../util/ot/opemasking.h" #include #include +#include "../util/helpers.h" static bool DETAILED_TIMINGS=0; @@ -27,6 +28,7 @@ static bool DETAILED_TIMINGS=0; //#define PRINT_BIN_CONTENT //#define PRINT_OPRG_MASKS //#define PRINT_RECEIVED_VALUES +//#define PRINT_CRF_EVAL struct mask_rcv_ctx { uint8_t* rcv_buf; @@ -76,8 +78,6 @@ void *receive_masks(void *ctx_tmp); void InitOTReceiver(uint8_t* keyMtx, CSocket sock, crypto* crypt); void InitOTSender(uint8_t* keySeeds, CBitVector& choices, CSocket sock, crypto* crypt); -void print_ot_psi_usage(); - GHashTable* otpsi_create_hash_table(uint32_t elebytelen, uint8_t* hashes, uint32_t neles, uint32_t hashbytelen, uint32_t* perm); void *otpsi_query_hash_table(void* ctx_tmp); diff --git a/src/util/crypto/crypto.cpp b/src/util/crypto/crypto.cpp index b465c0c..45adc3f 100644 --- a/src/util/crypto/crypto.cpp +++ b/src/util/crypto/crypto.cpp @@ -110,7 +110,7 @@ void crypto::gen_rnd(uint8_t* resbuf, uint32_t nbytes) { free(tmpbuf);*/ } -void crypto::gen_rnd_uniform(uint8_t* resbuf, uint64_t mod) { +void crypto::gen_rnd_uniform(uint8_t* res, uint64_t mod) { //pad to multiple of 4 bytes for uint32_t length uint32_t nrndbytes = pad_to_multiple(ceil_divide(secparam.symbits, 8) + ceil_log2(mod), sizeof(uint32_t)); uint64_t bitsint = (8*sizeof(uint32_t)); @@ -215,7 +215,7 @@ void crypto::hash_ctr(uint8_t* resbuf, uint32_t noutbytes, uint8_t* inbuf, uint3 uint8_t* tmpbuf = (uint8_t*) malloc(ninbytes + sizeof(uint32_t)); memcpy(tmpbuf, &ctr, sizeof(uint32_t)); memcpy(tmpbuf + sizeof(uint32_t), inbuf, ninbytes); - hash_routine(resbuf, noutbytes, inbuf, ninbytes, sha_hash_buf); + hash_routine(resbuf, noutbytes, tmpbuf, ninbytes+sizeof(uint32_t), sha_hash_buf); free(tmpbuf); } diff --git a/src/util/crypto/crypto.h b/src/util/crypto/crypto.h index d0c46df..c3d274e 100644 --- a/src/util/crypto/crypto.h +++ b/src/util/crypto/crypto.h @@ -88,11 +88,12 @@ public: uint32_t get_hash_bytes(); void gen_common_seed(prf_state_ctx* aes_key, CSocket& sock); + void init_prf_state(prf_state_ctx* prf_state, uint8_t* seed); + private: void seed_aes_key(AES_KEY_CTX* aeskey, uint8_t* seed, bc_mode mode=ECB, const uint8_t* iv=ZERO_IV, bool encrypt=true); void seed_aes_key(AES_KEY_CTX* aeskey, uint32_t symseclvl, uint8_t* seed, bc_mode mode=ECB, const uint8_t* iv=ZERO_IV, bool encrypt=true); void init(uint32_t symsecbits, uint8_t* seed); - void init_prf_state(prf_state_ctx* prf_state, uint8_t* seed); void free_prf_state(prf_state_ctx* prf_state); AES_KEY_CTX aes_hash_key; diff --git a/src/util/ot/opemasking.h b/src/util/ot/opemasking.h index 51d148f..317d170 100644 --- a/src/util/ot/opemasking.h +++ b/src/util/ot/opemasking.h @@ -31,15 +31,16 @@ public: assert(nbins > 0); m_vStartingPosForBin[0] = 0; m_nExpansionFactor = 1; + if(m_vNumEleInBin[0] > m_nCodeWordBits) { + m_nExpansionFactor = m_nCodeWordBits; + } for(uint32_t i = 1; i < nbins; i++) { m_vStartingPosForBin[i] = m_vStartingPosForBin[i-1] + m_vNumEleInBin[i-1]; if(m_vNumEleInBin[i] > m_nCodeWordBits) { m_nExpansionFactor = m_nCodeWordBits; } } - if(m_vNumEleInBin[0] > m_nCodeWordBits) { - m_nExpansionFactor = m_nCodeWordBits; - } + }; //Constructor that is called by the client @@ -78,11 +79,13 @@ public: //Expansion routine for the server void ServerExpand(CBitVector& matrix, uint8_t* uptr, uint32_t ot_begin_id, uint32_t processedOTs) { uint64_t ot_id, bin_id, bit_id, u, binoffset; + uint32_t hashinbytes = m_nCodeWordBytes + sizeof(uint64_t); uint8_t *Mptr = matrix.GetArr(); CBitVector mask(m_nCodeWordBits * m_nExpansionFactor); uint8_t* hash_buf = (uint8_t*) malloc(m_nCodeWordBytes * m_nExpansionFactor); - uint8_t* mask_ptr = mask.GetArr(); + uint8_t* mask_ptr; uint8_t* hash_ptr; + uint8_t* tmpbuf = (uint8_t*) malloc(hashinbytes); //m_vServerChoices.PrintHex(); for(ot_id = ot_begin_id; ot_id < ot_begin_id+processedOTs; ot_id++, Mptr+=m_nCodeWordBytes) @@ -92,6 +95,8 @@ public: binoffset = m_vStartingPosForBin[bin_id] * m_nOTsPerElement; + mask_ptr = mask.GetArr(); + if(m_vNumEleInBin[bin_id] < m_nCodeWordBits) { //cout << "Choice for ot_id = " << ot_id << ": "; for(u = 0; u < m_vNumEleInBin[bin_id]; u++) @@ -111,7 +116,10 @@ public: ((uint64_t*) mask_ptr)[0] ^= ot_id; m_cCrypto->aes_compression_hash(m_kCRFKey, hash_buf, mask_ptr, m_nCodeWordBytes); #else - m_cCrypto->hash_ctr(hash_buf, AES_BYTES, mask_ptr, m_nCodeWordBytes, ot_id); + memcpy(tmpbuf, (uint8_t*) &ot_id, sizeof(uint64_t)); + memcpy(tmpbuf+sizeof(uint64_t), mask_ptr, m_nCodeWordBytes); + m_cCrypto->hash(hash_buf, AES_BYTES, tmpbuf, hashinbytes); + //m_cCrypto->hash_ctr(hash_buf, AES_BYTES, mask_ptr, m_nCodeWordBytes, ot_id); #endif // cout << "MaskBitLen: " << m_nMaskBitLen << ", results size = " << m_vResults[bin_id].GetSize() << endl; //cout << "(" << (hex) << ((uint64_t*) hash_buf)[0] << ") " << (dec); @@ -137,7 +145,16 @@ public: ((uint32_t*) mask_ptr)[0] ^= ot_id; m_cCrypto->aes_compression_hash(m_kCRFKey, hash_ptr, mask_ptr, m_nCodeWordBytes); #else - m_cCrypto->hash_ctr(hash_buf, AES_BYTES, mask_ptr, m_nCodeWordBytes, ot_id); + memcpy(tmpbuf, (uint8_t*) &ot_id, sizeof(uint64_t)); + memcpy(tmpbuf+sizeof(uint64_t), mask_ptr, m_nCodeWordBytes); + m_cCrypto->hash(hash_ptr, AES_BYTES, tmpbuf, hashinbytes); + //m_cCrypto->hash_ctr(hash_ptr, AES_BYTES, mask_ptr, m_nCodeWordBytes, ot_id); +#endif +#ifdef DEBUG_HASH_OUTPUT + cout << "hash output for ot_id = " << ot_id << " and element_id = " << u << ": "; + for(uint32_t j = 0; j < AES_BYTES; j++) + cout << (hex) << (unsigned int) hash_buf[j]; + cout << (dec) << endl; #endif } uint64_t mask_id; @@ -151,14 +168,17 @@ public: } mask.delCBitVector(); free(hash_buf); + free(tmpbuf); } //Expansion routine for the client void ClientExpand(CBitVector& matrix, uint32_t ot_begin_id, uint32_t processedOTs) { //uint8_t hash_buf[m_cCrypto->get_hash_bytes()]; uint64_t ot_id, bin_id; + uint32_t hashinbytes = m_nCodeWordBytes + sizeof(uint64_t); uint8_t *Mptr = matrix.GetArr(); uint8_t* hash_buf = (uint8_t*) malloc(m_nCodeWordBytes); + uint8_t* tmpbuf = (uint8_t*) malloc(hashinbytes); for(ot_id = ot_begin_id; ot_id < ot_begin_id+processedOTs; ot_id++, Mptr+=m_nCodeWordBytes) { @@ -176,7 +196,10 @@ public: ((uint64_t*) Mptr)[0] ^= ot_id; m_cCrypto->aes_compression_hash(m_kCRFKey, hash_buf, Mptr, m_nCodeWordBytes); #else - m_cCrypto->hash_ctr(hash_buf, AES_BYTES, Mptr, m_nCodeWordBytes, ot_id); + memcpy(tmpbuf, (uint8_t*) &ot_id, sizeof(uint64_t)); + memcpy(tmpbuf+sizeof(uint64_t), Mptr, m_nCodeWordBytes); + m_cCrypto->hash(hash_buf, AES_BYTES, tmpbuf, hashinbytes); + //m_cCrypto->hash_ctr(hash_buf, AES_BYTES, Mptr, m_nCodeWordBytes, ot_id); #endif // cout << "Client expanding for bin_id : " << bin_id << endl; @@ -187,12 +210,13 @@ public: #ifdef DEBUG_HASH_OUTPUT cout << "hash output for ot_id = " << ot_id << ": "; for(uint32_t j = 0; j < AES_BYTES; j++) - cout << (hex) << (unsigned int) hash_buf[j]; - cout << (dec) << endl; + cout << (hex) << (uint32_t) hash_buf[j]; + cout << (dec) << ", " << (ot_begin_id) << ", " << processedOTs << ", " << m_nCodeWordBytes << ", " << (uint64_t) Mptr << endl; #endif } } free(hash_buf); + free(tmpbuf); } //the out vector contains the matrix with the data that needs to be hashed, uptr is a pointer to the choice-bits of the server in the base-OTs