Go to file
natalie c6f2d6b5fb
Update keygen_with_dealer to return a hashmap (#288)
* Change keygen_with_dealer to return a HashMap (#282)

Update docs

* Add vscode folder to gitignore
2023-03-23 22:24:33 +00:00
.github Bump actions/checkout from 3.3.0 to 3.4.0 (#285) 2023-03-17 14:13:44 +00:00
book Update frost-dependencies-for-audit.md (#289) 2023-03-22 11:26:01 +01:00
frost-core Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-ed448 Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-ed25519 Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-p256 Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-rerandomized Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-ristretto255 Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
frost-secp256k1 Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
gencode renamed gendoc to gencode; make it unpublishable (#260) 2023-03-02 21:19:53 +00:00
rfcs add missing checks 2021-06-15 17:10:38 -04:00
.gitignore Update keygen_with_dealer to return a hashmap (#288) 2023-03-23 22:24:33 +00:00
.mergify.yml ci(Mergify): configuration update 2022-06-15 20:13:45 -04:00
CHANGELOG.md Don't reject small-order verification keys (#137) 2021-11-18 15:53:35 -03:00
Cargo.toml renamed gendoc to gencode; make it unpublishable (#260) 2023-03-02 21:19:53 +00:00
LICENCE Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07:00
LICENCE.MIT Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07:00
LICENSE.Apache-2.0 Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07:00
README.md renamed gendoc to gencode; make it unpublishable (#260) 2023-03-02 21:19:53 +00:00
codecov.yml Port frost-ristretto255 to frost-core (#57) 2022-06-17 14:54:54 -04:00
zcash-frost-audit-report-20210323.pdf Remove `frost-redjubjub` (#246) 2023-02-16 22:44:12 +00:00

README.md

FROST (Flexible Round-Optimised Schnorr Threshold signatures)

Rust implementations of 'Two-Round Threshold Schnorr Signatures with FROST'.

Unlike signatures in a single-party setting, threshold signatures require cooperation among a threshold number of signers, each holding a share of a common private key. The security of threshold schemes in general assume that an adversary can corrupt strictly fewer than a threshold number of participants.

'Two-Round Threshold Schnorr Signatures with FROST' presents a variant of a Flexible Round-Optimized Schnorr Threshold (FROST) signature scheme originally defined in FROST20. FROST reduces network overhead during threshold signing operations while employing a novel technique to protect against forgery attacks applicable to prior Schnorr-based threshold signature constructions. This variant of FROST requires two rounds to compute a signature, and implements signing efficiency improvements described by Schnorr21. Single-round signing with FROST is not implemented here.

Status ⚠

The FROST specification is not yet finalized, and this codebase has not yet been audited or released. The APIs and types in frost-core are subject to change.

Usage

frost-core implements the base traits and types in a generic manner, to enable top-level implementations for different ciphersuites / curves without having to implement all of FROST from scratch. End-users should not use frost-core if they want to sign and verify signatures, they should use the crate specific to their ciphersuite/curve parameters that uses frost-core as a dependency.

Pre-commit checks

  1. Run tests cargo test
  2. Run formatter cargo fmt
  3. Check linter cargo clippy and if you want to automatically fix then run cargo clippy --fix

Coverage

Test coverage checks are performed in the pipeline. This is cofigured here: .github/workflows/coverage.yaml To run these locally:

  1. Install coverage tool by running cargo install cargo-llvm-cov
  2. Run cargo llvm-cov --ignore-filename-regex 'tests.rs|benches.rs|gencode' (you may be asked if you want to install llvm-tools-preview, if so type Y)