* The example should eventually be expanded upon. * The language may need more refinement.master
c0gent
7 years ago
committed by
Nick Sanders
parent
3e6df11c4b
commit
ec037173b1
@ -0,0 +1,47 @@ |
|||||||
|
## Contributing |
||||||
|
|
||||||
|
Thank your for contributing to this project! We welcome collaborators and |
||||||
|
expect users to follow our [code of conduct](CODE_OF_CONDUCT.md) when |
||||||
|
submitting code or comments. |
||||||
|
|
||||||
|
1. [Fork the repo](https://github.com/poanetwork/threshold_crypto/fork). |
||||||
|
2. Create your feature branch (`git checkout -b my-new-feature`). |
||||||
|
3. Write tests that cover your work. |
||||||
|
4. Run Rustfmt, Clippy, and all tests to ensure CI rules are satisfied. |
||||||
|
Correct versions and feature flags can be found in the |
||||||
|
[`.travis.yml`](https://github.com/poanetwork/hbbft/blob/master/.travis.yml) |
||||||
|
file. |
||||||
|
5. Commit your changes (`git commit -am 'Add some feature'`). |
||||||
|
6. Push to your branch (`git push origin my-new-feature`). |
||||||
|
7. Create a new PR (Pull Request). |
||||||
|
|
||||||
|
### General |
||||||
|
|
||||||
|
* We strive to follow the [Rust API |
||||||
|
Guidelines](https://rust-lang-nursery.github.io/api-guidelines/about.html) |
||||||
|
to maintain consistency and compatibility in our code. |
||||||
|
* Commits should be one logical change that still allows all tests to pass. |
||||||
|
We prefer smaller commits if there could be two levels of logic grouping. |
||||||
|
The goal is to provide future contributors (including your future self) the |
||||||
|
reasoning behind your changes and allow them to cherry-pick, patch or port |
||||||
|
those changes in isolation to other branches or forks. |
||||||
|
* If during your PR you reveal a pre-existing bug and know how to fix it: 1. |
||||||
|
If you can isolate the bug, fix it in a separate PR. 2. If the fix depends |
||||||
|
on your other commits, add it in a separate commit to the same PR. |
||||||
|
|
||||||
|
In either case, try to write a regression test that fails because of the |
||||||
|
bug but passes with your fix. |
||||||
|
|
||||||
|
### Issues |
||||||
|
|
||||||
|
Creating and discussing [Issues](https://github.com/poanetwork/hbbft/issues) |
||||||
|
provides significant value to the project. If you find a bug you can report it |
||||||
|
in an Issue. |
||||||
|
|
||||||
|
### Pull Requests |
||||||
|
|
||||||
|
All pull requests should include: |
||||||
|
|
||||||
|
* A clear, readable description of the purpose of the PR |
||||||
|
* A clear, readable description of changes |
||||||
|
* Any additional concerns or comments (optional) |
||||||
@ -0,0 +1,7 @@ |
|||||||
|
threshold_crypto is copyright 2018, POA Networks, Ltd. |
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
||||||
|
http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or |
||||||
|
http://opensource.org/licenses/MIT>, at your option. All files in the project |
||||||
|
carrying such notice may not be copied, modified, or distributed except |
||||||
|
according to those terms. |
||||||
@ -0,0 +1,201 @@ |
|||||||
|
Apache License |
||||||
|
Version 2.0, January 2004 |
||||||
|
http://www.apache.org/licenses/ |
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||||
|
|
||||||
|
1. Definitions. |
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction, |
||||||
|
and distribution as defined by Sections 1 through 9 of this document. |
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by |
||||||
|
the copyright owner that is granting the License. |
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all |
||||||
|
other entities that control, are controlled by, or are under common |
||||||
|
control with that entity. For the purposes of this definition, |
||||||
|
"control" means (i) the power, direct or indirect, to cause the |
||||||
|
direction or management of such entity, whether by contract or |
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity. |
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity |
||||||
|
exercising permissions granted by this License. |
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications, |
||||||
|
including but not limited to software source code, documentation |
||||||
|
source, and configuration files. |
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical |
||||||
|
transformation or translation of a Source form, including but |
||||||
|
not limited to compiled object code, generated documentation, |
||||||
|
and conversions to other media types. |
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or |
||||||
|
Object form, made available under the License, as indicated by a |
||||||
|
copyright notice that is included in or attached to the work |
||||||
|
(an example is provided in the Appendix below). |
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object |
||||||
|
form, that is based on (or derived from) the Work and for which the |
||||||
|
editorial revisions, annotations, elaborations, or other modifications |
||||||
|
represent, as a whole, an original work of authorship. For the purposes |
||||||
|
of this License, Derivative Works shall not include works that remain |
||||||
|
separable from, or merely link (or bind by name) to the interfaces of, |
||||||
|
the Work and Derivative Works thereof. |
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including |
||||||
|
the original version of the Work and any modifications or additions |
||||||
|
to that Work or Derivative Works thereof, that is intentionally |
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner |
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of |
||||||
|
the copyright owner. For the purposes of this definition, "submitted" |
||||||
|
means any form of electronic, verbal, or written communication sent |
||||||
|
to the Licensor or its representatives, including but not limited to |
||||||
|
communication on electronic mailing lists, source code control systems, |
||||||
|
and issue tracking systems that are managed by, or on behalf of, the |
||||||
|
Licensor for the purpose of discussing and improving the Work, but |
||||||
|
excluding communication that is conspicuously marked or otherwise |
||||||
|
designated in writing by the copyright owner as "Not a Contribution." |
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||||
|
on behalf of whom a Contribution has been received by Licensor and |
||||||
|
subsequently incorporated within the Work. |
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of |
||||||
|
this License, each Contributor hereby grants to You a perpetual, |
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||||
|
copyright license to reproduce, prepare Derivative Works of, |
||||||
|
publicly display, publicly perform, sublicense, and distribute the |
||||||
|
Work and such Derivative Works in Source or Object form. |
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of |
||||||
|
this License, each Contributor hereby grants to You a perpetual, |
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||||
|
(except as stated in this section) patent license to make, have made, |
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||||
|
where such license applies only to those patent claims licensable |
||||||
|
by such Contributor that are necessarily infringed by their |
||||||
|
Contribution(s) alone or by combination of their Contribution(s) |
||||||
|
with the Work to which such Contribution(s) was submitted. If You |
||||||
|
institute patent litigation against any entity (including a |
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||||
|
or a Contribution incorporated within the Work constitutes direct |
||||||
|
or contributory patent infringement, then any patent licenses |
||||||
|
granted to You under this License for that Work shall terminate |
||||||
|
as of the date such litigation is filed. |
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the |
||||||
|
Work or Derivative Works thereof in any medium, with or without |
||||||
|
modifications, and in Source or Object form, provided that You |
||||||
|
meet the following conditions: |
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or |
||||||
|
Derivative Works a copy of this License; and |
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices |
||||||
|
stating that You changed the files; and |
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works |
||||||
|
that You distribute, all copyright, patent, trademark, and |
||||||
|
attribution notices from the Source form of the Work, |
||||||
|
excluding those notices that do not pertain to any part of |
||||||
|
the Derivative Works; and |
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its |
||||||
|
distribution, then any Derivative Works that You distribute must |
||||||
|
include a readable copy of the attribution notices contained |
||||||
|
within such NOTICE file, excluding those notices that do not |
||||||
|
pertain to any part of the Derivative Works, in at least one |
||||||
|
of the following places: within a NOTICE text file distributed |
||||||
|
as part of the Derivative Works; within the Source form or |
||||||
|
documentation, if provided along with the Derivative Works; or, |
||||||
|
within a display generated by the Derivative Works, if and |
||||||
|
wherever such third-party notices normally appear. The contents |
||||||
|
of the NOTICE file are for informational purposes only and |
||||||
|
do not modify the License. You may add Your own attribution |
||||||
|
notices within Derivative Works that You distribute, alongside |
||||||
|
or as an addendum to the NOTICE text from the Work, provided |
||||||
|
that such additional attribution notices cannot be construed |
||||||
|
as modifying the License. |
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and |
||||||
|
may provide additional or different license terms and conditions |
||||||
|
for use, reproduction, or distribution of Your modifications, or |
||||||
|
for any such Derivative Works as a whole, provided Your use, |
||||||
|
reproduction, and distribution of the Work otherwise complies with |
||||||
|
the conditions stated in this License. |
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||||
|
any Contribution intentionally submitted for inclusion in the Work |
||||||
|
by You to the Licensor shall be under the terms and conditions of |
||||||
|
this License, without any additional terms or conditions. |
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify |
||||||
|
the terms of any separate license agreement you may have executed |
||||||
|
with Licensor regarding such Contributions. |
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade |
||||||
|
names, trademarks, service marks, or product names of the Licensor, |
||||||
|
except as required for reasonable and customary use in describing the |
||||||
|
origin of the Work and reproducing the content of the NOTICE file. |
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or |
||||||
|
agreed to in writing, Licensor provides the Work (and each |
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||||
|
implied, including, without limitation, any warranties or conditions |
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||||
|
appropriateness of using or redistributing the Work and assume any |
||||||
|
risks associated with Your exercise of permissions under this License. |
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory, |
||||||
|
whether in tort (including negligence), contract, or otherwise, |
||||||
|
unless required by applicable law (such as deliberate and grossly |
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be |
||||||
|
liable to You for damages, including any direct, indirect, special, |
||||||
|
incidental, or consequential damages of any character arising as a |
||||||
|
result of this License or out of the use or inability to use the |
||||||
|
Work (including but not limited to damages for loss of goodwill, |
||||||
|
work stoppage, computer failure or malfunction, or any and all |
||||||
|
other commercial damages or losses), even if such Contributor |
||||||
|
has been advised of the possibility of such damages. |
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing |
||||||
|
the Work or Derivative Works thereof, You may choose to offer, |
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity, |
||||||
|
or other liability obligations and/or rights consistent with this |
||||||
|
License. However, in accepting such obligations, You may act only |
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf |
||||||
|
of any other Contributor, and only if You agree to indemnify, |
||||||
|
defend, and hold each Contributor harmless for any liability |
||||||
|
incurred by, or claims asserted against, such Contributor by reason |
||||||
|
of your accepting any such warranty or additional liability. |
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS |
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work. |
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following |
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]" |
||||||
|
replaced with your own identifying information. (Don't include |
||||||
|
the brackets!) The text should be enclosed in the appropriate |
||||||
|
comment syntax for the file format. We also recommend that a |
||||||
|
file or class name and description of purpose be included on the |
||||||
|
same "printed page" as the copyright notice for easier |
||||||
|
identification within third-party archives. |
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner] |
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); |
||||||
|
you may not use this file except in compliance with the License. |
||||||
|
You may obtain a copy of the License at |
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0 |
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software |
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
See the License for the specific language governing permissions and |
||||||
|
limitations under the License. |
||||||
@ -1,15 +1,110 @@ |
|||||||
# Pairing cryptography and threshold signatures |
# threshold_crypto |
||||||
|
|
||||||
[](https://travis-ci.org/poanetwork/threshold_crypto) |
[](https://travis-ci.org/poanetwork/threshold_crypto) |
||||||
|
|
||||||
This crate contains constructions of asymmetric key cryptography and threshold |
A pairing-based threshold cryptosystem for collaborative decryption and |
||||||
signatures on top of `pairing` crate. |
signatures. |
||||||
|
|
||||||
### Examples |
Provides constructors for encrypted message handling within a public key |
||||||
|
encryption system. It utilizes the pairing elliptic curve library to create |
||||||
|
and enable reconstruction of public and private key shares. |
||||||
|
|
||||||
You can run a file from the [`examples`](examples) directory using: |
In a network environment, messages are signed and encrypted, and key and |
||||||
|
signature shares are distributed to network participants. A message can be |
||||||
|
decrypted and authenticated only with cooperation from at least `threshold + |
||||||
|
1` nodes. |
||||||
|
|
||||||
|
## Usage |
||||||
|
|
||||||
|
`Cargo.toml`: |
||||||
|
|
||||||
|
```toml |
||||||
|
[dependencies] |
||||||
|
rand = "0.4" |
||||||
|
threshold_crypto = { version = "0.1", git = "https://github.com/poanetwork/threshold_crypto" } |
||||||
|
``` |
||||||
|
|
||||||
|
`main.rs`: |
||||||
|
|
||||||
|
```rust |
||||||
|
extern crate rand; |
||||||
|
extern crate threshold_crypto; |
||||||
|
|
||||||
|
use threshold_crypto::SecretKey; |
||||||
|
|
||||||
|
/// Very basic secret key usage. |
||||||
|
fn main() { |
||||||
|
let sk0: SecretKey = rand::random(); |
||||||
|
let sk1: SecretKey = rand::random(); |
||||||
|
|
||||||
|
let pk0 = sk0.public_key(); |
||||||
|
|
||||||
|
let msg0 = b"Real news"; |
||||||
|
let msg1 = b"Fake news"; |
||||||
|
|
||||||
|
assert!(pk0.verify(&sk0.sign(msg0), msg0)); |
||||||
|
assert!(!pk0.verify(&sk1.sign(msg0), msg0)); // Wrong key. |
||||||
|
assert!(!pk0.verify(&sk0.sign(msg1), msg0)); // Wrong message. |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
### More Examples |
||||||
|
|
||||||
|
Run examples from the [`examples`](examples) directory using: |
||||||
|
|
||||||
``` |
``` |
||||||
$ MLOCK_SECRETS=false cargo run --example <example name> |
$ MLOCK_SECRETS=false cargo run --example <example name> |
||||||
``` |
``` |
||||||
|
|
||||||
|
Also see the |
||||||
|
[distributed_key_generation](https://github.com/poanetwork/threshold_crypto/blob/d81953b55d181311c2a4eed2b6c34059fcf3fdae/src/poly.rs#L967) |
||||||
|
test. |
||||||
|
|
||||||
|
## More Details |
||||||
|
|
||||||
|
The basic usage outline is: choose a threshold value t, create a key set, then |
||||||
|
distribute N secret key shares among the participants and publish the public |
||||||
|
master key. A third party can now encrypt a message to the public master key |
||||||
|
and any set of `t + 1` participants *(but no fewer!)* can collaborate to |
||||||
|
decrypt it. Also, any `t + 1` participants can collaborate to sign a message, |
||||||
|
producing a signature that can be verified against the public master key. |
||||||
|
|
||||||
|
This cryptosystem has the property that signatures are unique, i.e. |
||||||
|
independent of which particular participants produced it. If `S1` and `S2` are |
||||||
|
signatures for the same message, produced by two different sets of `t + 1` |
||||||
|
secret key share holders each, then they won't just both be valid, but in fact |
||||||
|
equal. This is useful in some applications, for example it allows using the |
||||||
|
signature of a message as a pseudorandom number that is unknown to anyone |
||||||
|
until `t + 1` participants agree to reveal it. |
||||||
|
|
||||||
|
In its simplest form, threshold cryptography requires a trusted dealer who |
||||||
|
produces the secret key shares and distributes them. However, there are ways |
||||||
|
to produce the keys themselves in a way that guarantees that nobody except the |
||||||
|
corresponding participant knows their secret in the end, and this crate |
||||||
|
includes the basic tools to implement such a *Distributed Key Generation* |
||||||
|
scheme. |
||||||
|
|
||||||
|
One major application for this library is within distributed networks that |
||||||
|
must tolerate up to `t` adversarial (malicious or faulty) nodes. Because `t + |
||||||
|
1` nodes are required to sign or reveal information, messages can be trusted |
||||||
|
by third-parties as representing the consensus of the network. |
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
Licensed under either of: |
||||||
|
|
||||||
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
||||||
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
||||||
|
|
||||||
|
at your option. |
||||||
|
|
||||||
|
## Contributing |
||||||
|
|
||||||
|
See the [CONTRIBUTING](CONTRIBUTING.md) document for contribution, testing and |
||||||
|
pull request protocol. |
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally |
||||||
|
submitted for inclusion in the work by you, as defined in the Apache-2.0 |
||||||
|
license, shall be dual licensed as above, without any additional terms or |
||||||
|
conditions. |
||||||
|
>>>>>>> Change license, flesh out README a bit. |
||||||
|
|||||||
Loading…
Reference in new issue