serai/crypto/frost/README.md

# Modular FROST

A modular implementation of FROST for any curve with a ff/group API.
Additionally, custom algorithms may be specified so any signature reducible to
Schnorr-like may be used with FROST.

A Schnorr algorithm is provided, of the form (R, s) where `s = r + cx`, which
allows specifying the challenge format. This is intended to easily allow
integrating with existing systems.

This library offers ciphersuites compatible with the
[IETF draft](https://github.com/cfrg/draft-irtf-cfrg-frost). Currently, version
11 is supported.

This library was
[audited by Cypher Stack in March 2023](https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf),
culminating in commit
[669d2dbffc1dafb82a09d9419ea182667115df06](https://github.com/serai-dex/serai/tree/669d2dbffc1dafb82a09d9419ea182667115df06).
Any subsequent changes have not undergone auditing. While this audit included
FROST's definition of Ed448, the underlying Ed448 ciphersuite (offered by the
ciphersuite crate) was not audited, nor was the minimal-ed448 crate implementing
the curve itself.
Rename FROST's official package name and update documentation 2022-06-19 09:21:22 +00:00			`# Modular FROST`
Initial commit Combines the existing frost-rs, dalek-ff-group, and monero-rs repos into a monorepo. Makes tweaks necessary as needed. Replaces RedDSA (which was going to be stubbed out into a new folder for now) with an offset system that voids its need and allows stealth addresses with CLSAG. 2022-04-22 01:36:18 +00:00
Add further FROST documentation 2022-09-29 10:02:43 +00:00			`A modular implementation of FROST for any curve with a ff/group API.`
			`Additionally, custom algorithms may be specified so any signature reducible to`
			`Schnorr-like may be used with FROST.`

			A Schnorr algorithm is provided, of the form (R, s) where `s = r + cx`, which
			`allows specifying the challenge format. This is intended to easily allow`
			`integrating with existing systems.`

			`This library offers ciphersuites compatible with the`
			`[IETF draft](https://github.com/cfrg/draft-irtf-cfrg-frost). Currently, version`
Create a dedicated crate for the DKG (#141) * Add dkg crate * Remove F_len and G_len They're generally no longer used. * Replace hash_to_vec with a provided method around associated type H: Digest Part of trying to minimize this trait so it can be moved elsewhere. Vec, which isn't std, may have been a blocker. * Encrypt secret shares within the FROST library Reduces requirements on callers in order to be correct. * Update usage of Zeroize within FROST * Inline functions in key_gen There was no reason to have them separated as they were. sign probably has the same statement available, yet that isn't the focus right now. * Add a ciphersuite package which provides hash_to_F * Set the Ciphersuite version to something valid * Have ed448 export Scalar/FieldElement/Point at the top level * Move FROST over to Ciphersuite * Correct usage of ff in ciphersuite * Correct documentation handling * Move Schnorr signatures to their own crate * Remove unused feature from schnorr * Fix Schnorr tests * Split DKG into a separate crate * Add serialize to Commitments and SecretShare Helper for buf = vec![]; .write(buf).unwrap(); buf * Move FROST over to the new dkg crate * Update Monero lib to latest FROST * Correct ethereum's usage of features * Add serialize to GeneratorProof * Add serialize helper function to FROST * Rename AddendumSerialize to WriteAddendum * Update processor * Slight fix to processor 2022-10-29 08:54:42 +00:00			`11 is supported.`
Document crypto crates with audit notices 2023-03-16 22:46:48 +00:00
			`This library was`
Fully document crypto/ 2023-03-21 00:10:00 +00:00			`[audited by Cypher Stack in March 2023](https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf),`
			`culminating in commit`
			`[669d2dbffc1dafb82a09d9419ea182667115df06](https://github.com/serai-dex/serai/tree/669d2dbffc1dafb82a09d9419ea182667115df06).`
			`Any subsequent changes have not undergone auditing. While this audit included`
			`FROST's definition of Ed448, the underlying Ed448 ciphersuite (offered by the`
Clarify further changes have not been audited 2023-03-20 20:23:43 +00:00			`ciphersuite crate) was not audited, nor was the minimal-ed448 crate implementing`
			`the curve itself.`