schnorr-rs 0.3.0

Schnorr Protocols
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

#![doc = include_str!("../README.md")]

use digest::Digest;

pub mod group;
pub use group::{Group, SchnorrGroup, SchnorrP256Group};

pub mod public_key;
pub use public_key::PublicKey;

pub mod signature;
pub use signature::Signature;

pub mod signature_scheme;
pub use signature_scheme::SignatureScheme;

pub mod signing_key;
pub use signing_key::SigningKey;

pub mod signer;
pub use signer::Signer;

pub mod verifier;
pub use verifier::Verifier;

pub mod identification;
pub use identification::Identification;

/// Instantiate a Schnorr Signature Protocol from string representation of p, q, and a:
/// - p is a large prime
/// - q is a large prime divisor of p-1
/// - a is a generator of the group of order q, i.e., a^q mod p = 1 by Fermat's Little Theorem.
///
/// Return None if a is not a valid generator (i.e. a^q mod p != 1)
pub fn signature_scheme<H: Digest>(
    p: &str,
    q: &str,
    a: &str,
) -> Option<SignatureScheme<SchnorrGroup, H>> {
    let group = SchnorrGroup::from_str(p, q, a)?;
    Some(SignatureScheme {
        group,
        _phantom: std::marker::PhantomData,
    })
}

/// Instantiate a Schnorr Identification Protocol from string representation of p, q, and a:
/// - p is a large prime
/// - q is a large prime divisor of p-1
/// - a is a generator of the group of order q, i.e., a^q mod p = 1 by Fermat's Little Theorem.
///
/// Return None if a is not a valid generator (i.e. a^q mod p != 1)
pub fn identification_protocol(p: &str, q: &str, a: &str) -> Option<Identification<SchnorrGroup>> {
    SchnorrGroup::from_str(p, q, a).map(|group| Identification { group })
}

/// Instantiate a Schnorr Signature Protocol based on elliptic curve p256. The generator point is provided by crate [p256].
pub fn signature_scheme_p256<H: Digest>() -> SignatureScheme<SchnorrP256Group, H> {
    let group = SchnorrP256Group;
    SignatureScheme {
        group,
        _phantom: std::marker::PhantomData,
    }
}

/// Instantiate a Schnorr Identification Protocol based on elliptic curve p256. The generator point is provided by crate [p256].
pub fn identification_protocol_p256() -> Identification<SchnorrP256Group> {
    Identification {
        group: SchnorrP256Group,
    }
}