Struct SecretKey

pub struct SecretKey { /* private fields */ }

A secret key.

Implementations

impl SecretKey

pub fn public(&self) -> PublicKey

The public key of this SecretKey.

pub fn generate<R>(csprng: R) -> SecretKey

where R: CryptoRngCore,

Generate a new SecretKey with a randomness generator.

// use the OsRng option for OS depedndent most secure RNG.
let mut rng = rand::rngs::OsRng;
let _key = iroh_base::SecretKey::generate(&mut rng);

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

Sign the given message and return a digital signature

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

Convert this to the bytes representing the secret part. The public part can always be recovered.

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

Create a secret key from its byte representation.

pub fn secret(&self) -> &SigningKey

Returns the [SigningKey] for this SecretKey.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl From<[u8; 32]> for SecretKey

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

Converts to this type from the input type.

impl From<SigningKey> for SecretKey

fn from(secret: SigningKey) -> SecretKey

Converts to this type from the input type.

impl FromStr for SecretKey

type Err = KeyParsingError

The associated error which can be returned from parsing.

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

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

impl Serialize for SecretKey

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from( bytes: &[u8], ) -> Result<SecretKey, <SecretKey as TryFrom<&[u8]>>::Error>

Performs the conversion.