From 0091ae1f8521337967a6dbb90157875a17fff7f9 Mon Sep 17 00:00:00 2001 From: Piotr Roslaniec Date: Fri, 18 Nov 2022 14:44:09 +0100 Subject: [PATCH] add python bindings and benchmark --- .gitignore | 1 + Cargo.lock | 96 +++ Cargo.toml | 1 + tpke-python/.gitignore | 7 + tpke-python/BENCHMARK.md | 52 ++ tpke-python/Cargo.toml | 15 + tpke-python/LICENSE | 675 ++++++++++++++++++ tpke-python/MANIFEST.in | 4 + tpke-python/README.md | 5 + tpke-python/build.rs | 3 + tpke-python/py-benches/benchmark.py | 39 + tpke-python/pyproject.toml | 2 + tpke-python/setup.py | 39 + tpke-python/src/lib.rs | 46 ++ tpke-python/tpke/__init__.py | 4 + tpke-python/tpke/__init__.pyi | 16 + tpke-python/tpke/py.typed | 0 tpke-wasm/BENCHMARK.md | 2 +- tpke-wasm/js-benches/index.js | 2 +- tpke-wasm/scripts/make-python-bench-inputs.js | 63 ++ tpke-wasm/src/lib.rs | 110 +-- tpke/BENCHMARK.md | 2 +- tpke/src/api.rs | 145 ++++ tpke/src/lib.rs | 4 +- 24 files changed, 1244 insertions(+), 89 deletions(-) create mode 100644 tpke-python/.gitignore create mode 100644 tpke-python/BENCHMARK.md create mode 100644 tpke-python/Cargo.toml create mode 100755 tpke-python/LICENSE create mode 100644 tpke-python/MANIFEST.in create mode 100644 tpke-python/README.md create mode 100644 tpke-python/build.rs create mode 100644 tpke-python/py-benches/benchmark.py create mode 100644 tpke-python/pyproject.toml create mode 100644 tpke-python/setup.py create mode 100644 tpke-python/src/lib.rs create mode 100644 tpke-python/tpke/__init__.py create mode 100644 tpke-python/tpke/__init__.pyi create mode 100644 tpke-python/tpke/py.typed create mode 100644 tpke-wasm/scripts/make-python-bench-inputs.js create mode 100644 tpke/src/api.rs diff --git a/.gitignore b/.gitignore index c5df1db2..9240575c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ target *.wasm +tpke-python/py-benches/inputs/ \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock index e3c7a41c..6d6161a3 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1084,6 +1084,12 @@ dependencies = [ "serde", ] +[[package]] +name = "indoc" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adab1eaa3408fb7f0c777a73e7465fd5656136fc93b670eb6df3c88c2c1344e3" + [[package]] name = "inferno" version = "0.10.12" @@ -1539,6 +1545,75 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "pyo3" +version = "0.16.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0220c44442c9b239dd4357aa856ac468a4f5e1f0df19ddb89b2522952eb4c6ca" +dependencies = [ + "cfg-if 1.0.0", + "indoc", + "libc", + "parking_lot", + "pyo3-build-config 0.16.6", + "pyo3-ffi", + "pyo3-macros", + "unindent", +] + +[[package]] +name = "pyo3-build-config" +version = "0.16.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c819d397859445928609d0ec5afc2da5204e0d0f73d6bf9e153b04e83c9cdc2" +dependencies = [ + "once_cell", + "target-lexicon", +] + +[[package]] +name = "pyo3-build-config" +version = "0.17.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "28fcd1e73f06ec85bf3280c48c67e731d8290ad3d730f8be9dc07946923005c8" +dependencies = [ + "once_cell", + "target-lexicon", +] + +[[package]] +name = "pyo3-ffi" +version = "0.16.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca882703ab55f54702d7bfe1189b41b0af10272389f04cae38fe4cd56c65f75f" +dependencies = [ + "libc", + "pyo3-build-config 0.16.6", +] + +[[package]] +name = "pyo3-macros" +version = "0.16.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "568749402955ad7be7bad9a09b8593851cd36e549ac90bfd44079cea500f3f21" +dependencies = [ + "proc-macro2", + "pyo3-macros-backend", + "quote", + "syn", +] + +[[package]] +name = "pyo3-macros-backend" +version = "0.16.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "611f64e82d98f447787e82b8e7b0ebc681e1eb78fc1252668b2c605ffb4e1eb8" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "quick-xml" version = "0.22.0" @@ -1952,6 +2027,12 @@ dependencies = [ "unicode-xid", ] +[[package]] +name = "target-lexicon" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9410d0f6853b1d94f0e519fb95df60f29d2c1eff2d921ffdf01a4c8a3b54f12d" + [[package]] name = "tempfile" version = "3.3.0" @@ -2056,6 +2137,15 @@ dependencies = [ "serde", ] +[[package]] +name = "tpke-python" +version = "0.1.0" +dependencies = [ + "group-threshold-cryptography", + "pyo3", + "pyo3-build-config 0.17.3", +] + [[package]] name = "tpke-wasm" version = "0.1.0" @@ -2110,6 +2200,12 @@ version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "957e51f3646910546462e67d5f7599b9e4fb8acdd304b087a6494730f9eebf04" +[[package]] +name = "unindent" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "58ee9362deb4a96cef4d437d1ad49cffc9b9e92d202b6995674e928ce684f112" + [[package]] name = "universal-hash" version = "0.5.0" diff --git a/Cargo.toml b/Cargo.toml index 8c6c402f..72edf305 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,7 @@ members = [ "subproductdomain", "tpke", "tpke-wasm", + "tpke-python", ] [profile.bench] diff --git a/tpke-python/.gitignore b/tpke-python/.gitignore new file mode 100644 index 00000000..b2417b63 --- /dev/null +++ b/tpke-python/.gitignore @@ -0,0 +1,7 @@ +__pycache__ +*.egg-info +*.so +build/ +dist/ +docs/_build + diff --git a/tpke-python/BENCHMARK.md b/tpke-python/BENCHMARK.md new file mode 100644 index 00000000..6115eaff --- /dev/null +++ b/tpke-python/BENCHMARK.md @@ -0,0 +1,52 @@ +# Benchmarks + +## Hardware + +Benchmarks produced on: + +- Intel® Core™ i7-10875H CPU @ 2.30GHz × 16 (single-threaded), +- Version 107.0.5304.110 (Official Build) (64-bit), +- Pop!\_OS 22.04 LTS (64-bit), + +### Setup + +First, build the WASM target and make inputs for Python benchmarks: + +```bash +cd tpke-wasm +wasm-pack build --release --target nodejs # Notice the target +node scripts/make-python-bench-inputs.js +``` + +Then, build and install the Python package: + +```bash +cd tpke-python +pip install -e . +``` + +### Running + +```bash +cd tpke-python +python py-benches/benchmark.py + +``` + +## Results + +Using fixed values, such that `shares=num_entities=threshold`. + +Rounding to nearest ms. + +### Python Results + +Filename refers to the number of shares. + +``` +participant-payloads-8.json: 2 ms +participant-payloads-16.json: 3 ms +participant-payloads-32.json: 6 ms +participant-payloads-64.json: 12 ms +participant-payloads-128.json: 25 ms +``` diff --git a/tpke-python/Cargo.toml b/tpke-python/Cargo.toml new file mode 100644 index 00000000..4387875e --- /dev/null +++ b/tpke-python/Cargo.toml @@ -0,0 +1,15 @@ +[package] +name = "tpke-python" +authors = ["Piotr Roslaniec "] +version = "0.1.0" +edition = "2018" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +pyo3 = "0.16" +group-threshold-cryptography = { path = "../tpke"} + +[build-dependencies] +pyo3-build-config = "*" diff --git a/tpke-python/LICENSE b/tpke-python/LICENSE new file mode 100755 index 00000000..2fb2e74d --- /dev/null +++ b/tpke-python/LICENSE @@ -0,0 +1,675 @@ +### 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/tpke-python/MANIFEST.in b/tpke-python/MANIFEST.in new file mode 100644 index 00000000..2dff285a --- /dev/null +++ b/tpke-python/MANIFEST.in @@ -0,0 +1,4 @@ +include Cargo.toml +include README.md +include LICENSE +recursive-include src * diff --git a/tpke-python/README.md b/tpke-python/README.md new file mode 100644 index 00000000..5bc58a51 --- /dev/null +++ b/tpke-python/README.md @@ -0,0 +1,5 @@ +# Python bindings for `tpke` + +## Build + +You will need to have `setuptools-rust` installed. Then, for development, you can just do `pip install -e .` as usual. diff --git a/tpke-python/build.rs b/tpke-python/build.rs new file mode 100644 index 00000000..dace4a9b --- /dev/null +++ b/tpke-python/build.rs @@ -0,0 +1,3 @@ +fn main() { + pyo3_build_config::add_extension_module_link_args(); +} diff --git a/tpke-python/py-benches/benchmark.py b/tpke-python/py-benches/benchmark.py new file mode 100644 index 00000000..b2aa3cba --- /dev/null +++ b/tpke-python/py-benches/benchmark.py @@ -0,0 +1,39 @@ +import os +import time +import json +import statistics +from tpke import ParticipantPayload + +# First, load pre-generated data + +inputs_path = 'py-benches/inputs' + +inputs = {} +for file_name in os.listdir(inputs_path): + with open(os.path.join(inputs_path, file_name)) as f: + payloads = [] + for payload_hex in json.load(f): + payload = ParticipantPayload.from_bytes(bytes.fromhex(payload_hex)) + payloads.append(payload) + inputs[file_name] = payloads + + +# Now, benchmark + +def bench_fn(fn, inputs): + BENCHMARK_TRIALS = 25 + + times = [] + for _ in range(BENCHMARK_TRIALS): + start_time = time.perf_counter() + fn(inputs) + end_time = time.perf_counter() + execution_time = (end_time - start_time) + times.append(execution_time) + return statistics.median(times) + + +for file_name, payloads in inputs.items(): + def fn(inputs): return [p.to_decryption_share() for p in inputs] + median_time = bench_fn(fn, payloads) + print(f"{file_name}: {int(median_time * 1000)} ms") # Rounding to ms diff --git a/tpke-python/pyproject.toml b/tpke-python/pyproject.toml new file mode 100644 index 00000000..31ffe048 --- /dev/null +++ b/tpke-python/pyproject.toml @@ -0,0 +1,2 @@ +[build-system] +requires = ["setuptools", "wheel", "setuptools-rust"] diff --git a/tpke-python/setup.py b/tpke-python/setup.py new file mode 100644 index 00000000..dee29136 --- /dev/null +++ b/tpke-python/setup.py @@ -0,0 +1,39 @@ +from setuptools import setup +from setuptools_rust import Binding, RustExtension + +from pathlib import Path +this_directory = Path(__file__).parent +long_description = (this_directory / "README.md").read_text() + +setup( + name="tpke", + description="Ferveo DKG scheme", + long_description=long_description, + long_description_content_type="text/markdown", + version="0.1.0", + author="Piotr Roslaniec", + author_email="p.roslaniec@gmail.com", + url="https://github.com/nucypher/ferveo/tree/master/tpke-python", + rust_extensions=[RustExtension( + "tpke._tpke", binding=Binding.PyO3, debug=False)], + packages=["tpke"], + package_data={ + 'tpke': ['py.typed', '__init__.pyi'], + }, + # rust extensions are not zip safe, just like C-extensions. + zip_safe=False, + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Natural Language :: English", + "Programming Language :: Rust", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Topic :: Security :: Cryptography", + ], +) diff --git a/tpke-python/src/lib.rs b/tpke-python/src/lib.rs new file mode 100644 index 00000000..0e616760 --- /dev/null +++ b/tpke-python/src/lib.rs @@ -0,0 +1,46 @@ +// Clippy shows false positives in PyO3 methods. +// See https://github.com/rust-lang/rust-clippy/issues/8971 +// Will probably be fixed by Rust 1.65 +#![allow(clippy::borrow_deref_ref)] + +extern crate alloc; + +extern crate group_threshold_cryptography as tpke; + +use pyo3::prelude::*; +use pyo3::types::PyBytes; + +#[pyclass(module = "tpke")] +pub struct DecryptionShare(tpke::api::DecryptionShare); + +impl DecryptionShare { + pub fn to_bytes(&self) -> PyResult { + Ok(Python::with_gil(|py| -> PyObject { + PyBytes::new(py, &self.0.to_bytes()).into() + })) + } +} + +#[pyclass(module = "tpke")] +pub struct ParticipantPayload(tpke::api::ParticipantPayload); + +#[pymethods] +impl ParticipantPayload { + #[staticmethod] + pub fn from_bytes(bytes: &[u8]) -> Self { + Self(tpke::api::ParticipantPayload::from_bytes(bytes)) + } + + pub fn to_decryption_share(&self) -> DecryptionShare { + DecryptionShare(self.0.to_decryption_share()) + } +} + +/// A Python module implemented in Rust. +#[pymodule] +fn _tpke(_py: Python, m: &PyModule) -> PyResult<()> { + m.add_class::()?; + m.add_class::()?; + + Ok(()) +} diff --git a/tpke-python/tpke/__init__.py b/tpke-python/tpke/__init__.py new file mode 100644 index 00000000..b85ea156 --- /dev/null +++ b/tpke-python/tpke/__init__.py @@ -0,0 +1,4 @@ +from ._tpke import ( + DecryptionShare, + ParticipantPayload +) diff --git a/tpke-python/tpke/__init__.pyi b/tpke-python/tpke/__init__.pyi new file mode 100644 index 00000000..413af70c --- /dev/null +++ b/tpke-python/tpke/__init__.pyi @@ -0,0 +1,16 @@ +class DecryptionShare: + + def __bytes__(self) -> bytes: + ... + + +class ParticipantPayload: + + @staticmethod + def from_bytes(data: bytes) -> ParticipantPayload: + ... + + def to_decryption_share(self) -> DecryptionShare: + ... + + diff --git a/tpke-python/tpke/py.typed b/tpke-python/tpke/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/tpke-wasm/BENCHMARK.md b/tpke-wasm/BENCHMARK.md index 15fc3d69..ce51030c 100644 --- a/tpke-wasm/BENCHMARK.md +++ b/tpke-wasm/BENCHMARK.md @@ -1,6 +1,6 @@ # Benchmarks -## Setup +## Hardware Benchmarks produced on: diff --git a/tpke-wasm/js-benches/index.js b/tpke-wasm/js-benches/index.js index 679dd844..0fbda838 100644 --- a/tpke-wasm/js-benches/index.js +++ b/tpke-wasm/js-benches/index.js @@ -35,7 +35,7 @@ function benchmark_combine(setup) { const decryptionShares = []; setup.decrypter_indexes().forEach((index) => { const decryptionContext = setup.private_context_at(index); - const share = new ParticipantPayload( + const share = new ParticipantPayload( decryptionContext, ciphertext ).to_decryption_share(); diff --git a/tpke-wasm/scripts/make-python-bench-inputs.js b/tpke-wasm/scripts/make-python-bench-inputs.js new file mode 100644 index 00000000..893eaa7e --- /dev/null +++ b/tpke-wasm/scripts/make-python-bench-inputs.js @@ -0,0 +1,63 @@ +const { + Setup, + encrypt, + ParticipantPayload, +} = require("../pkg/tpke_wasm.js"); +const fs = require("fs"); + +// Convert a byte array to a hex string +function bytesToHex(bytes) { + for (var hex = [], i = 0; i < bytes.length; i++) { + var current = bytes[i] < 0 ? bytes[i] + 256 : bytes[i]; + hex.push((current >>> 4).toString(16)); + hex.push((current & 0xF).toString(16)); + } + return hex.join(""); +} + +function persist(filePath, data) { + try { + fs.writeFileSync(filePath, data); + } catch (err) { + console.error(err); + } +} + +const makeParticipantPayloads = (setup) => { + const message = Uint8Array.from([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]); + const aad = Uint8Array.from([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]); + const ciphertext = encrypt(message, aad, setup.public_key); + + // Using a push to array here instead of map because somehow map breaks + // DecryptionShare into Uint8Array during iteration + const payloads = []; + setup.decrypter_indexes().forEach((index) => { + const decryptionContext = setup.private_context_at(index); + const payload = new ParticipantPayload( + decryptionContext, + ciphertext + ).to_bytes() + payloads.push(payload); + }); + return payloads; +} + +const makeInputs = async () => { + console.log("Running"); + + const numShares = [8, 16, 32, 64, 128]; + for (const shares of numShares) { + const setup = new Setup(shares, shares, shares); + + const payloads = makeParticipantPayloads(setup).map(bytesToHex); + const filePath = `../tpke-python/py-benches/inputs/participant-payloads-${shares}.json`; + + console.log(`Writing ${filePath}`); + persist(filePath, JSON.stringify(payloads)); + + } + console.log("Done!"); +}; + +makeInputs() + .catch((err) => console.error(err)); diff --git a/tpke-wasm/src/lib.rs b/tpke-wasm/src/lib.rs index a5b80eee..3b3705fb 100644 --- a/tpke-wasm/src/lib.rs +++ b/tpke-wasm/src/lib.rs @@ -2,9 +2,6 @@ mod utils; extern crate group_threshold_cryptography as tpke; -use ark_ec::{AffineCurve, ProjectiveCurve}; -use ark_ff::BigInteger256; -use ark_ff::ToBytes; use ark_serialize::{CanonicalDeserialize, CanonicalSerialize}; use serde::{Deserialize, Serialize}; use serde_with::serde_as; @@ -24,74 +21,27 @@ pub type TpkeSharedSecret = #[wasm_bindgen] #[derive(Clone, Debug)] -pub struct PrivateDecryptionContext { - b_inv: ark_bls12_381::Fr, - decrypter_index: usize, -} - -// Keeping this out of the `PrivateDecryptionContext`, since wasm_bindgen doesn't -// support constant field definitions. -const B_INV_LEN: usize = 32; -const DECRYPTER_INDEX_LEN: usize = 8; - +pub struct PrivateDecryptionContext(tpke::api::PrivateDecryptionContext); #[wasm_bindgen] impl PrivateDecryptionContext { - pub(crate) fn new( - b_inv: &ark_bls12_381::Fr, - decrypter_index: usize, - ) -> Self { - Self { - b_inv: *b_inv, - decrypter_index, - } - } - pub(crate) fn serialized_size() -> usize { - B_INV_LEN + DECRYPTER_INDEX_LEN + tpke::api::PrivateDecryptionContext::serialized_size() } #[wasm_bindgen] pub fn to_bytes(&self) -> Vec { - let mut bytes = Vec::new(); - self.b_inv.0.write(&mut bytes).unwrap(); - - let decrypter_index = - bincode::serialize(&self.decrypter_index).unwrap(); - bytes.extend(decrypter_index); - - bytes + self.0.to_bytes() } #[wasm_bindgen] pub fn from_bytes(bytes: &[u8]) -> Self { - let b_inv_bytes = &bytes[0..B_INV_LEN]; - // Chunking bytes to u64s to construct a BigInteger256. - let b_inv = b_inv_bytes - .chunks(8) - .map(|x| { - let mut bytes = [0u8; 8]; - bytes.copy_from_slice(x); - u64::from_le_bytes(bytes) - }) - .collect::>(); - let b_inv: [u64; 4] = b_inv.try_into().unwrap(); - let b_inv = ark_bls12_381::Fr::new(BigInteger256::new(b_inv)); - - let decrypter_index_bytes = - &bytes[B_INV_LEN..B_INV_LEN + DECRYPTER_INDEX_LEN]; - let decrypter_index = - bincode::deserialize(decrypter_index_bytes).unwrap(); - - Self { - b_inv, - decrypter_index, - } + Self(tpke::api::PrivateDecryptionContext::from_bytes(bytes)) } } #[wasm_bindgen] #[derive(Clone, Debug)] -pub struct DecryptionShare(TpkeDecryptionShare); +pub struct DecryptionShare(tpke::api::DecryptionShare); #[wasm_bindgen] impl DecryptionShare { @@ -102,18 +52,14 @@ impl DecryptionShare { #[wasm_bindgen] pub fn from_bytes(bytes: &[u8]) -> Self { - let share = TpkeDecryptionShare::from_bytes(bytes); + let share = tpke::api::DecryptionShare::from_bytes(bytes); Self(share) } } #[wasm_bindgen] #[derive(Clone, Debug)] -pub struct ParticipantPayload { - decryption_context: PrivateDecryptionContext, - // Using inner type here because `ciphertext` is never accessed from the outside. - ciphertext: TpkeCiphertext, -} +pub struct ParticipantPayload(tpke::api::ParticipantPayload); #[wasm_bindgen] impl ParticipantPayload { @@ -122,16 +68,16 @@ impl ParticipantPayload { decryption_context: &PrivateDecryptionContext, ciphertext: &Ciphertext, ) -> Self { - Self { - decryption_context: decryption_context.clone(), - ciphertext: ciphertext.ciphertext.clone(), - } + Self(tpke::api::ParticipantPayload::new( + &decryption_context.0, + &ciphertext.ciphertext, + )) } #[wasm_bindgen] pub fn to_bytes(&self) -> Vec { - let mut bytes = self.decryption_context.to_bytes(); - bytes.extend(&self.ciphertext.to_bytes()); + let mut bytes = self.0.decryption_context.to_bytes(); + bytes.extend(&self.0.ciphertext.to_bytes()); bytes } @@ -146,25 +92,15 @@ impl ParticipantPayload { bytes[PrivateDecryptionContext::serialized_size()..].to_vec(); let ciphertext = tpke::Ciphertext::from_bytes(&ciphertext_bytes); - Self { - decryption_context, + Self(tpke::api::ParticipantPayload { + decryption_context: decryption_context.0, ciphertext, - } + }) } #[wasm_bindgen] pub fn to_decryption_share(&self) -> DecryptionShare { - // TODO: Add verification steps - let decryption_share = self - .ciphertext - .commitment - .mul(self.decryption_context.b_inv) - .into_affine(); - - DecryptionShare(TpkeDecryptionShare { - decrypter_index: self.decryption_context.decrypter_index, - decryption_share, - }) + DecryptionShare(self.0.to_decryption_share()) } } @@ -240,7 +176,11 @@ impl Setup { let private_contexts = contexts .clone() .into_iter() - .map(|x| PrivateDecryptionContext::new(&x.b_inv, x.index)) + .map(|x| { + PrivateDecryptionContext( + tpke::api::PrivateDecryptionContext::new(&x.b_inv, x.index), + ) + }) .collect(); let public_contexts = contexts[0].public_decryption_contexts.to_vec(); @@ -260,7 +200,7 @@ impl Setup { pub fn private_context_at(&self, index: usize) -> PrivateDecryptionContext { set_panic_hook(); let context = self.private_contexts[index].clone(); - assert_eq!(context.decrypter_index, index); + assert_eq!(context.0.decrypter_index, index); context } @@ -269,7 +209,7 @@ impl Setup { set_panic_hook(); self.private_contexts .iter() - .map(|x| x.decrypter_index) + .map(|x| x.0.decrypter_index) .collect() } @@ -334,7 +274,7 @@ impl SharedSecretBuilder { #[wasm_bindgen] pub fn add_decryption_share(&mut self, share: &DecryptionShare) { - self.shares.push(share.0.clone()); + self.shares.push(share.0 .0.clone()); } #[wasm_bindgen] diff --git a/tpke/BENCHMARK.md b/tpke/BENCHMARK.md index 148d0ddc..1e3c61cc 100644 --- a/tpke/BENCHMARK.md +++ b/tpke/BENCHMARK.md @@ -1,6 +1,6 @@ # Benchmarks -## Setup +## Hardware Benchmarks produced on: diff --git a/tpke/src/api.rs b/tpke/src/api.rs new file mode 100644 index 00000000..6ac420f3 --- /dev/null +++ b/tpke/src/api.rs @@ -0,0 +1,145 @@ +//! Contains the public API of the library. + +// TODO: Refactor this module to deduplicate shared code from tpke-wasm and tpke-wasm. + +use std::convert::TryInto; + +use ark_ec::{AffineCurve, ProjectiveCurve}; +use ark_ff::{BigInteger256, ToBytes}; + +// Fixing some of the types here on our target engine +// TODO: Consider fixing on crate::api level instead of bindings level +type E = ark_bls12_381::Bls12_381; +type TpkePublicKey = ark_bls12_381::G1Affine; +type TpkePrivateKey = ark_bls12_381::G2Affine; +type TpkeCiphertext = crate::Ciphertext; +type TpkeDecryptionShare = crate::DecryptionShare; +type TpkePublicDecryptionContext = crate::PublicDecryptionContext; +type TpkeSharedSecret = + ::Fqk; + +#[derive(Clone, Debug)] +pub struct PrivateDecryptionContext { + pub b_inv: ark_bls12_381::Fr, + pub decrypter_index: usize, +} + +impl PrivateDecryptionContext { + const B_INV_LEN: usize = 32; + const DECRYPTER_INDEX_LEN: usize = 8; + + pub fn new(b_inv: &ark_bls12_381::Fr, decrypter_index: usize) -> Self { + Self { + b_inv: *b_inv, + decrypter_index, + } + } + + pub fn serialized_size() -> usize { + Self::B_INV_LEN + Self::DECRYPTER_INDEX_LEN + } + + pub fn to_bytes(&self) -> Vec { + let mut bytes = Vec::new(); + self.b_inv.0.write(&mut bytes).unwrap(); + + let decrypter_index = + bincode::serialize(&self.decrypter_index).unwrap(); + bytes.extend(decrypter_index); + + bytes + } + + pub fn from_bytes(bytes: &[u8]) -> Self { + let b_inv_bytes = &bytes[0..Self::B_INV_LEN]; + // Chunking bytes to u64s to construct a BigInteger256. + let b_inv = b_inv_bytes + .chunks(8) + .map(|x| { + let mut bytes = [0u8; 8]; + bytes.copy_from_slice(x); + u64::from_le_bytes(bytes) + }) + .collect::>(); + let b_inv: [u64; 4] = b_inv.try_into().unwrap(); + let b_inv = ark_bls12_381::Fr::new(BigInteger256::new(b_inv)); + + let decrypter_index_bytes = &bytes + [Self::B_INV_LEN..Self::B_INV_LEN + Self::DECRYPTER_INDEX_LEN]; + let decrypter_index = + bincode::deserialize(decrypter_index_bytes).unwrap(); + + Self { + b_inv, + decrypter_index, + } + } +} + +#[derive(Clone, Debug)] +pub struct DecryptionShare(pub TpkeDecryptionShare); + +impl DecryptionShare { + pub fn to_bytes(&self) -> Vec { + self.0.to_bytes() + } + + pub fn from_bytes(bytes: &[u8]) -> Self { + let share = TpkeDecryptionShare::from_bytes(bytes); + Self(share) + } +} + +#[derive(Clone, Debug)] +pub struct ParticipantPayload { + pub decryption_context: PrivateDecryptionContext, + pub ciphertext: TpkeCiphertext, +} +impl ParticipantPayload { + pub fn new( + decryption_context: &PrivateDecryptionContext, + ciphertext: &TpkeCiphertext, + ) -> Self { + Self { + decryption_context: decryption_context.clone(), + ciphertext: ciphertext.clone(), + } + } + + pub fn to_bytes(&self) -> Vec { + let mut bytes = self.decryption_context.to_bytes(); + bytes.extend(&self.ciphertext.to_bytes()); + bytes + } + + pub fn from_bytes(bytes: &[u8]) -> Self { + let decryption_context_bytes = + &bytes[0..PrivateDecryptionContext::serialized_size()]; + let decryption_context = + PrivateDecryptionContext::from_bytes(decryption_context_bytes); + + let ciphertext_bytes = + bytes[PrivateDecryptionContext::serialized_size()..].to_vec(); + let ciphertext: crate::Ciphertext = + crate::Ciphertext::from_bytes(&ciphertext_bytes); + + Self { + decryption_context, + ciphertext, + } + } + + pub fn to_decryption_share(&self) -> DecryptionShare { + // TODO: Add verification steps + let decryption_share = self + .ciphertext + .commitment + .mul(self.decryption_context.b_inv) + .into_affine(); + + DecryptionShare(TpkeDecryptionShare { + decrypter_index: self.decryption_context.decrypter_index, + decryption_share, + }) + } +} diff --git a/tpke/src/lib.rs b/tpke/src/lib.rs index d19c6236..d1a1277d 100644 --- a/tpke/src/lib.rs +++ b/tpke/src/lib.rs @@ -24,7 +24,9 @@ mod combine; pub use combine::*; mod context; pub use context::*; -// TODO: Turn into a crate feature + +// TODO: Turn into a crate features +pub mod api; pub mod serialization; pub trait ThresholdEncryptionParameters {