Compare commits
5 Commits
e7e23ba899
...
fc517a8047
Author | SHA1 | Date |
---|---|---|
Ryan Heywood | fc517a8047 | |
Ryan Heywood | 64315676f8 | |
Ryan Heywood | 4faab1cd33 | |
Ryan Heywood | f10fef2c88 | |
Ryan Heywood | de314fed2c |
|
@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.6.0] - 2024-11-16
|
||||
### Changed
|
||||
- Rename project to `blahaj` following soft-fork
|
||||
- Use `u8::MAX` instead of deprecated `u8::max_value()`
|
||||
- Upgraded project dependencies
|
||||
|
||||
### Fixed
|
||||
- Lower bound of polynomial coefficients changed from 1 to 0
|
||||
|
||||
## [0.5.0] - 2021-03-14
|
||||
### Added
|
||||
- Zeroize memory on drop for generated secret shares
|
||||
|
|
13
COPYRIGHT
13
COPYRIGHT
|
@ -1,12 +1,11 @@
|
|||
Copyrights in the Sharks project are retained by their contributors. No
|
||||
copyright assignment is required to contribute to the Sharks project.
|
||||
Copyrights in the Blahaj project are retained by their contributors. No
|
||||
copyright assignment is required to contribute to the Blahaj project.
|
||||
|
||||
For full authorship information, see the version control history.
|
||||
|
||||
Except as otherwise noted (below and/or in individual files), Sharks is
|
||||
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.
|
||||
licensed under the MIT license <LICENSE-MIT> or
|
||||
<http://opensource.org/licenses/MIT>.
|
||||
|
||||
The Sharks project includes code from the Rust project
|
||||
published under these same licenses.
|
||||
The Blahaj project includes code from the Rust project published under these
|
||||
same licenses.
|
||||
|
|
25
Cargo.toml
25
Cargo.toml
|
@ -1,21 +1,16 @@
|
|||
[package]
|
||||
name = "sharks"
|
||||
version = "0.5.0"
|
||||
authors = ["Aitor Ruano <codearm@pm.me>"]
|
||||
description = "Fast, small and secure Shamir's Secret Sharing library crate"
|
||||
homepage = "https://github.com/c0dearm/sharks"
|
||||
repository = "https://github.com/c0dearm/sharks"
|
||||
name = "blahaj"
|
||||
version = "0.6.0"
|
||||
authors = ["Ryan Heywood <ryan@distrust.co>"]
|
||||
description = "Fast, small, and secure Shamir's Secret Sharing"
|
||||
homepage = "https://git.distrust.co/public/blahaj"
|
||||
repository = "https://git.distrust.co/public/blahaj"
|
||||
readme = "README.md"
|
||||
keywords = ["shamir", "secret", "sharing", "share", "crypto"]
|
||||
keywords = ["shamir", "secret", "sharing", "share", "cryptography"]
|
||||
categories = ["algorithms", "cryptography", "mathematics"]
|
||||
license = "MIT/Apache-2.0"
|
||||
edition = "2018"
|
||||
license = "MIT"
|
||||
edition = "2021"
|
||||
|
||||
[badges]
|
||||
maintenance = { status = "actively-developed" }
|
||||
codecov = { repository = "c0dearm/sharks" }
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
[features]
|
||||
default = ["std", "zeroize_memory"]
|
||||
std = ["rand/std", "rand/std_rng"]
|
||||
|
@ -24,7 +19,7 @@ zeroize_memory = ["zeroize"]
|
|||
|
||||
[dependencies]
|
||||
rand = { version = "0.8", default-features = false }
|
||||
hashbrown = "0.9"
|
||||
hashbrown = "0.15"
|
||||
arbitrary = { version = "0.4.7", features = ["derive"], optional = true }
|
||||
zeroize = { version = "1.2.0", features = ["zeroize_derive"], optional = true }
|
||||
|
||||
|
|
201
LICENSE-APACHE
201
LICENSE-APACHE
|
@ -1,201 +0,0 @@
|
|||
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 2020 Aitor Ruano Miralles
|
||||
|
||||
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.
|
30
README.md
30
README.md
|
@ -1,15 +1,12 @@
|
|||
# Sharks
|
||||
# Blahaj
|
||||
|
||||
[![Rust](https://github.com/c0dearm/sharks/workflows/Rust/badge.svg?branch=master)](https://github.com/c0dearm/sharks/actions)
|
||||
[![Crates](https://img.shields.io/crates/v/sharks.svg)](https://crates.io/crates/sharks)
|
||||
[![Docs](https://docs.rs/sharks/badge.svg)](https://docs.rs/sharks)
|
||||
[![Codecov](https://codecov.io/gh/c0dearm/sharks/branch/master/graph/badge.svg)](https://codecov.io/gh/c0dearm/sharks)
|
||||
[![License](https://camo.githubusercontent.com/47069b7e06b64b608c692a8a7f40bc6915cf629c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865322e302532464d49542d626c75652e737667)](https://github.com/c0dearm/sharks/blob/master/COPYRIGHT)
|
||||
[![Crates](https://img.shields.io/crates/v/blahaj.svg)](https://crates.io/crates/blahaj)
|
||||
[![Docs](https://docs.rs/blahaj/badge.svg)](https://docs.rs/blahaj)
|
||||
|
||||
Fast, small and secure [Shamir's Secret Sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing) library crate
|
||||
|
||||
Documentation:
|
||||
- [API reference (docs.rs)](https://docs.rs/sharks)
|
||||
- [API reference (docs.rs)](https://docs.rs/blahaj)
|
||||
|
||||
## Usage
|
||||
|
||||
|
@ -17,17 +14,17 @@ Add this to your `Cargo.toml`:
|
|||
|
||||
```toml
|
||||
[dependencies]
|
||||
sharks = "0.4"
|
||||
blahaj = "0.6"
|
||||
```
|
||||
|
||||
If your environment doesn't support `std`:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
sharks = { version = "0.4", default-features = false }
|
||||
blahaj = { version = "0.6", default-features = false }
|
||||
```
|
||||
|
||||
To get started using Sharks, see the [Rust docs](https://docs.rs/sharks)
|
||||
To get started using Blahaj, see the [Rust docs](https://docs.rs/blahaj)
|
||||
|
||||
## Features
|
||||
|
||||
|
@ -62,16 +59,11 @@ You can run them with `cargo test` and `cargo bench`.
|
|||
|
||||
# Contributing
|
||||
|
||||
If you find a vulnerability, bug or would like a new feature, [open a new issue](https://github.com/c0dearm/sharks/issues/new).
|
||||
|
||||
To introduce your changes into the codebase, submit a Pull Request.
|
||||
|
||||
Many thanks!
|
||||
If you find a vulnerability, bug or would like a new feature, reach out to
|
||||
<mailto:team@distrust.co>.
|
||||
|
||||
# License
|
||||
|
||||
Sharks is distributed under the terms of both the MIT license and the
|
||||
Apache License (Version 2.0).
|
||||
Blahaj is distributed under the terms of the MIT license.
|
||||
|
||||
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
|
||||
[COPYRIGHT](COPYRIGHT) for details.
|
||||
See [LICENSE-MIT](LICENSE-MIT) and [COPYRIGHT](COPYRIGHT) for details.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
use criterion::{black_box, criterion_group, criterion_main, Criterion};
|
||||
use std::convert::TryFrom;
|
||||
|
||||
use sharks::{Share, Sharks};
|
||||
use blahaj::{Share, Sharks};
|
||||
|
||||
fn dealer(c: &mut Criterion) {
|
||||
let sharks = Sharks(255);
|
||||
|
|
20
codecov.yml
20
codecov.yml
|
@ -1,20 +0,0 @@
|
|||
codecov:
|
||||
require_ci_to_pass: yes
|
||||
|
||||
coverage:
|
||||
precision: 2
|
||||
round: down
|
||||
range: "90...100"
|
||||
|
||||
parsers:
|
||||
gcov:
|
||||
branch_detection:
|
||||
conditional: yes
|
||||
loop: yes
|
||||
method: no
|
||||
macro: no
|
||||
|
||||
comment:
|
||||
layout: "reach,diff,flags,tree"
|
||||
behavior: default
|
||||
require_changes: no
|
12
src/lib.rs
12
src/lib.rs
|
@ -2,7 +2,7 @@
|
|||
//!
|
||||
//! Usage example (std):
|
||||
//! ```
|
||||
//! use sharks::{ Sharks, Share };
|
||||
//! use blahaj::{ Sharks, Share };
|
||||
//!
|
||||
//! // Set a minimum threshold of 10 shares
|
||||
//! let sharks = Sharks(10);
|
||||
|
@ -20,7 +20,7 @@
|
|||
//!
|
||||
//! Usage example (no std):
|
||||
//! ```
|
||||
//! use sharks::{ Sharks, Share };
|
||||
//! use blahaj::{ Sharks, Share };
|
||||
//! use rand_chacha::rand_core::SeedableRng;
|
||||
//!
|
||||
//! // Set a minimum threshold of 10 shares
|
||||
|
@ -53,7 +53,7 @@ pub use share::Share;
|
|||
///
|
||||
/// Usage example:
|
||||
/// ```
|
||||
/// # use sharks::{ Sharks, Share };
|
||||
/// # use blahaj::{ Sharks, Share };
|
||||
/// // Set a minimum threshold of 10 shares
|
||||
/// let sharks = Sharks(10);
|
||||
/// // Obtain an iterator over the shares for secret [1, 2, 3, 4]
|
||||
|
@ -79,7 +79,7 @@ impl Sharks {
|
|||
///
|
||||
/// Example:
|
||||
/// ```
|
||||
/// # use sharks::{ Sharks, Share };
|
||||
/// # use blahaj::{ Sharks, Share };
|
||||
/// # use rand_chacha::rand_core::SeedableRng;
|
||||
/// # let sharks = Sharks(3);
|
||||
/// // Obtain an iterator over the shares for secret [1, 2]
|
||||
|
@ -106,7 +106,7 @@ impl Sharks {
|
|||
///
|
||||
/// Example:
|
||||
/// ```
|
||||
/// # use sharks::{ Sharks, Share };
|
||||
/// # use blahaj::{ Sharks, Share };
|
||||
/// # let sharks = Sharks(3);
|
||||
/// // Obtain an iterator over the shares for secret [1, 2]
|
||||
/// let dealer = sharks.dealer(&[1, 2]);
|
||||
|
@ -124,7 +124,7 @@ impl Sharks {
|
|||
///
|
||||
/// Example:
|
||||
/// ```
|
||||
/// # use sharks::{ Sharks, Share };
|
||||
/// # use blahaj::{ Sharks, Share };
|
||||
/// # use rand_chacha::rand_core::SeedableRng;
|
||||
/// # let sharks = Sharks(3);
|
||||
/// # let mut rng = rand_chacha::ChaCha8Rng::from_seed([0x90; 32]);
|
||||
|
|
|
@ -30,12 +30,12 @@ pub fn interpolate(shares: &[Share]) -> Vec<u8> {
|
|||
.collect()
|
||||
}
|
||||
|
||||
// Generates `k` polynomial coefficients, being the last one `s` and the others randomly generated between `[1, 255]`.
|
||||
// Generates `k` polynomial coefficients, being the last one `s` and the others randomly generated between `[0, 255]`.
|
||||
// Coefficient degrees go from higher to lower in the returned vector order.
|
||||
pub fn random_polynomial<R: rand::Rng>(s: GF256, k: u8, rng: &mut R) -> Vec<GF256> {
|
||||
let k = k as usize;
|
||||
let mut poly = Vec::with_capacity(k);
|
||||
let between = Uniform::new_inclusive(1, 255);
|
||||
let between = Uniform::new_inclusive(0, 255);
|
||||
|
||||
for _ in 1..k {
|
||||
poly.push(GF256(between.sample(rng)));
|
||||
|
@ -50,7 +50,7 @@ pub fn random_polynomial<R: rand::Rng>(s: GF256, k: u8, rng: &mut R) -> Vec<GF25
|
|||
// Each polynomial corresponds to one byte chunk of the original secret.
|
||||
// The iterator will start at `x = 1` and end at `x = 255`.
|
||||
pub fn get_evaluator(polys: Vec<Vec<GF256>>) -> impl Iterator<Item = Share> {
|
||||
(1..=u8::max_value()).map(GF256).map(move |x| Share {
|
||||
(1..=u8::MAX).map(GF256).map(move |x| Share {
|
||||
x: x.clone(),
|
||||
y: polys
|
||||
.iter()
|
||||
|
|
|
@ -12,7 +12,7 @@ use zeroize::Zeroize;
|
|||
///
|
||||
/// Usage example:
|
||||
/// ```
|
||||
/// use sharks::{Sharks, Share};
|
||||
/// use blahaj::{Sharks, Share};
|
||||
/// use core::convert::TryFrom;
|
||||
/// # use rand_chacha::rand_core::SeedableRng;
|
||||
/// # fn send_to_printer(_: Vec<u8>) {}
|
||||
|
|
Loading…
Reference in New Issue