Struct keynesis::key::ed25519::SecretKey

pub struct SecretKey(_);

Ed25519 Secret Key

Mind it though, losing this key means losing control over your identity

Implementations

impl SecretKey

pub const SIZE: usize

the size of the Secret key in bytes

pub fn new<Rng>(rng: Rng) -> SecretKey where
    Rng: RngCore + CryptoRng, 

generate a new SecretKey with the given random number generator

pub fn exchange(&self, public_key: &PublicKey) -> SharedSecret

generate a shared secret between the owner of the given public key and ourselves.

pub fn public_key(&self) -> PublicKey

get the PublicKey associated to this key

Unlike the SecretKey, the PublicKey can be safely publicly shared. The key can then be used to verify any Signature generated with this SecretKey and the original message.

pub fn sign<T>(&self, msg: T) -> Signature where
    T: AsRef<[u8]>, 

create a Signature for the given message with this SecretKey.

The Signature can then be verified against the associated PublicKey and the original message.

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

get a reference to the inner Seed bytes

Security Consideration

be mindful that leaking the content of the internal signing key may result in losing the ultimate control of the signing key

Trait Implementations

impl Clone for SecretKey

pub 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

conveniently provide an incomplete implementation of Debug for the SecretKey.

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

Formats the value using the given formatter.

impl Dh for SecretKey

pub fn name() -> &'static str

pub fn generate<RNG>(rng: &mut RNG) -> SecretKey where
    RNG: RngCore + CryptoRng, 

pub fn public(&self) -> PublicKey

pub fn dh(&self, public: &PublicKey) -> SharedSecret

impl Drop for SecretKey

custom implementation of Drop so we can have more certainty that the secret key raw data will be scrubbed (zeroed) before releasing the memory

pub fn drop(&mut self)

Executes the destructor for this type.

impl From<[u8; 32]> for SecretKey

pub fn from(bytes: [u8; 32]) -> SecretKey

Performs the conversion.

impl FromStr for SecretKey

type Err = FromHexError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<SecretKey, <SecretKey as FromStr>::Err>

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

impl Hash for SecretKey

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<SecretKey> for SecretKey

pub 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 !=.

impl<'a> TryFrom<&'a [u8]> for SecretKey

type Error = SecretKeyError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &'a [u8]
) -> Result<SecretKey, <SecretKey as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl Eq for SecretKey