Enum AuthSecretKey 

#[non_exhaustive]
#[repr(u8)]
pub enum AuthSecretKey {
    Falcon512Rpo(SecretKey),
    EcdsaK256Keccak(SecretKey),
}

Secret keys of the standard AuthSchemes available in the Miden protocol.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Falcon512Rpo(SecretKey)

EcdsaK256Keccak(SecretKey)

Implementations

impl AuthSecretKey

pub fn new_falcon512_rpo() -> AuthSecretKey

Generates an Falcon512Rpo secret key from the OS-provided randomness.

pub fn new_falcon512_rpo_with_rng<R>(rng: &mut R) -> AuthSecretKey

where R: Rng,

Generates an Falcon512Rpo secrete key using the provided random number generator.

pub fn new_ecdsa_k256_keccak() -> AuthSecretKey

Generates an EcdsaK256Keccak secret key from the OS-provided randomness.

pub fn new_ecdsa_k256_keccak_with_rng<R>(rng: &mut R) -> AuthSecretKey

where R: Rng + CryptoRng,

Generates an EcdsaK256Keccak secret key using the provided random number generator.

pub fn auth_scheme(&self) -> AuthScheme

Returns the authentication scheme of this secret key.

pub fn public_key(&self) -> PublicKey

Returns a public key associated with this secret key.

pub fn sign(&self, message: Word) -> Signature

Signs the provided message with this secret key.

Trait Implementations

impl Clone for AuthSecretKey

fn clone(&self) -> AuthSecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthSecretKey

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

Formats the value using the given formatter.

impl Deserializable for AuthSecretKey

fn read_from<R>(source: &mut R) -> Result<AuthSecretKey, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for AuthSecretKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serializable for AuthSecretKey

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for AuthSecretKey

impl StructuralPartialEq for AuthSecretKey