Enum SecretKey

#[non_exhaustive]
pub enum SecretKey {
    System,
    Ed25519(SigningKey),
    Secp256k1(SigningKey),
}

A secret or private asymmetric key.

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.

System

System secret key.

Ed25519(SigningKey)

Ed25519 secret key.

Secp256k1(SigningKey)

secp256k1 secret key.

Implementations

impl SecretKey

pub const SYSTEM_LENGTH: usize = 0usize

The length in bytes of a system secret key.

pub const ED25519_LENGTH: usize = 32usize

The length in bytes of an Ed25519 secret key.

pub const SECP256K1_LENGTH: usize = 32usize

The length in bytes of a secp256k1 secret key.

pub fn system() -> Self

Constructs a new system variant.

pub fn ed25519_from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, Error>

Constructs a new ed25519 variant from a byte slice.

pub fn secp256k1_from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, Error>

Constructs a new secp256k1 variant from a byte slice.

pub fn generate_ed25519() -> Result<Self, ErrorExt>

Available on crate features std or testing only.

Generates a new ed25519 variant using the system’s secure random number generator.

pub fn generate_secp256k1() -> Result<Self, ErrorExt>

Available on crate features std or testing only.

Generates a new secp256k1 variant using the system’s secure random number generator.

pub fn to_file<P: AsRef<Path>>(&self, file: P) -> Result<(), ErrorExt>

Available on crate feature std-fs-io only.

Attempts to write the key bytes to the configured file path.

pub fn from_file<P: AsRef<Path>>(file: P) -> Result<Self, ErrorExt>

Available on crate feature std-fs-io only.

Attempts to read the key bytes from configured file path.

pub fn to_der(&self) -> Result<Vec<u8>, ErrorExt>

Available on crate feature std only.

DER encodes a key.

pub fn from_der<T: AsRef<[u8]>>(input: T) -> Result<Self, ErrorExt>

Available on crate feature std only.

Decodes a key from a DER-encoded slice.

pub fn to_pem(&self) -> Result<String, ErrorExt>

Available on crate feature std only.

PEM encodes a key.

pub fn from_pem<T: AsRef<[u8]>>(input: T) -> Result<Self, ErrorExt>

Available on crate feature std only.

Decodes a key from a PEM-encoded slice.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random SecretKey.

pub fn random_ed25519(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random Ed25519 variant of SecretKey.

pub fn random_secp256k1(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random secp256k1 variant of SecretKey.

Trait Implementations

impl DataSize for SecretKey

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl From<&SecretKey> for PublicKey

fn from(secret_key: &SecretKey) -> PublicKey

Converts to this type from the input type.

impl Ord for SecretKey

Available on crate feature testing only.

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for SecretKey

Available on crate feature testing only.

fn eq(&self, other: &Self) -> 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 PartialOrd for SecretKey

Available on crate feature testing only.

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Tagged<u8> for SecretKey

fn tag(&self) -> u8

Returns the tag of a given object

impl Eq for SecretKey

Available on crate feature testing only.