Struct Ed25519SecretKey 

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

Available on (crate features hmac or hkdf or kmac or ed25519 or x25519 or phc-strings or argon2 or scrypt) and crate feature ed25519 only.

Ed25519 secret key bytes.

Provides typed signing and public-key derivation instead of vague &[u8] parameters at the call site.

Implementations

impl Ed25519SecretKey

pub const LENGTH: usize = SECRET_KEY_LENGTH

Secret key length in bytes.

pub const fn from_bytes(bytes: [u8; 32]) -> Self

Construct a secret key from its byte representation.

pub fn expose_secret(&self) -> SecretBytes<{ Self::LENGTH }>

Explicitly extract the secret key bytes into a zeroizing wrapper.

pub const fn as_bytes(&self) -> &[u8; 32]

Borrow the secret key bytes.

pub fn public_key(&self) -> Ed25519PublicKey

Derive the matching Ed25519 public key.

pub fn sign(&self, message: &[u8]) -> Ed25519Signature

Sign a message with this secret key.

impl Ed25519SecretKey

pub fn generate(fill: impl FnOnce(&mut [u8; 32])) -> Self

Construct a secret key by filling bytes from the provided closure.

let sk = Ed25519SecretKey::generate(|buf| buf.fill(0xA5));
assert_eq!(sk.as_bytes(), &[0xA5; Ed25519SecretKey::LENGTH]);

pub fn random() -> Self

Available on crate feature getrandom only.

Generate a random instance using the operating system’s CSPRNG.

Panics

Panics if the platform entropy source is unavailable.

pub fn try_random() -> Result<Self, Error>

Available on crate feature getrandom only.

Try to generate a random instance from the platform entropy source.

Errors

Returns a getrandom error if the platform entropy source is unavailable.

impl Ed25519SecretKey

pub fn display_secret(&self) -> DisplaySecret<'_>

Returns a wrapper that displays the key bytes as lowercase hex.

This is an explicit opt-in for showing secret key material. The wrapper implements Display.

Trait Implementations

impl Clone for Ed25519SecretKey

fn clone(&self) -> Ed25519SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for Ed25519SecretKey

fn ct_eq(&self, other: &Self) -> bool

Returns true if self and other are equal.

impl Debug for Ed25519SecretKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ed25519SecretKey

Available on crate feature serde-secrets only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Drop for Ed25519SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl FromStr for Ed25519SecretKey

type Err = InvalidHexError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Ed25519SecretKey

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 Serialize for Ed25519SecretKey

Available on crate feature serde-secrets only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Ed25519SecretKey