Struct dusk_schnorr::SecretKey

pub struct SecretKey(/* private fields */);

Structure representing a SecretKey, represented as a private scalar in the JubJub scalar field.

Examples

Generate a random SecretKey:

use dusk_schnorr::SecretKey;
use rand::rngs::StdRng;
use rand::SeedableRng;

let mut rng = StdRng::seed_from_u64(12345);
let sk = SecretKey::random(&mut rng);

Implementations

impl SecretKey

pub fn random<T>(rand: &mut T) -> SecretKey

where T: RngCore + CryptoRng,

This will create a random SecretKey from a scalar of the Field JubJubScalar.

impl SecretKey

pub fn sign<R>(&self, rng: &mut R, msg: BlsScalar) -> Signature

where R: RngCore + CryptoRng,

Signs a chosen message with a given secret key using the dusk variant of the Schnorr signature scheme.

This function performs the following cryptographic operations:

• Generates a random nonce r.
• Computes R = r * G.
• Computes the challenge c = H(R || m).
• Computes the signature u = r - c * sk.

Parameters

• rng: Reference to the random number generator.
• message: The message in BlsScalar to be signed.

Returns

Returns a new Signature containing the u scalar and R point.

Example

Sign a message with a SecretKey and verify with the respective PublicKey:

use dusk_schnorr::{SecretKey, PublicKey};
use dusk_jubjub::JubJubScalar;
use dusk_bls12_381::BlsScalar;
use rand::rngs::StdRng;
use rand::SeedableRng;
use ff::Field;

let mut rng = StdRng::seed_from_u64(12345);

let message = BlsScalar::random(&mut rng);

let sk = SecretKey::random(&mut rng);
let pk = PublicKey::from(&sk);

let signature = sk.sign(&mut rng, message);

assert!(pk.verify(&signature, message));

Trait Implementations

impl AsRef<Fr> for SecretKey

fn as_ref(&self) -> &JubJubScalar

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&Fr> for SecretKey

fn from(s: &JubJubScalar) -> SecretKey

Converts to this type from the input type.

impl From<&SecretKey> for PublicKey

fn from(sk: &SecretKey) -> Self

Converts to this type from the input type.

impl From<Fr> for SecretKey

fn from(s: JubJubScalar) -> SecretKey

Converts to this type from the input type.

impl Ord for SecretKey

fn cmp(&self, other: &SecretKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SecretKey

fn eq(&self, other: &SecretKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SecretKey

fn partial_cmp(&self, other: &SecretKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable<32> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

fn to_bytes(&self) -> [u8; 32]

Serialize Self into a [[u8; N]].

fn from_bytes(bytes: &[u8; 32]) -> Result<Self, Error>

Deserialize a [&[u8; N]] into Self, it might be fail.

const SIZE: usize = N

The size of

impl Copy for SecretKey

impl Eq for SecretKey

impl StructuralEq for SecretKey

impl StructuralPartialEq for SecretKey