Struct SecretKey

pub struct SecretKey { /* private fields */ }

Available on crate feature key only.

A secret key.

Implementations

impl SecretKey

pub fn shared(&self, other: &PublicKey) -> SharedSecret

Returns the shared key for communication between this key and other.

impl SecretKey

pub fn public(&self) -> PublicKey

The public key of this SecretKey.

pub fn generate() -> Self

Generate a new SecretKey with the default randomness generator.

pub fn generate_with_rng<R: CryptoRngCore + ?Sized>(csprng: &mut R) -> Self

Generate a new SecretKey with a randomness generator.

pub fn to_openssh(&self) -> Result<Zeroizing<String>>

Serialise this key to OpenSSH format.

pub fn try_from_openssh<T: AsRef<[u8]>>(data: T) -> Result<Self>

Deserialise this key from OpenSSH format.

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]) -> Self

Create a secret key from its byte representation.

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl From<[u8; 32]> for SecretKey

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

Converts to this type from the input type.

impl From<SigningKey> for SecretKey

fn from(secret: SigningKey) -> Self

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<Self, Self::Err>

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

impl Serialize for SecretKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::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<Self, Self::Error>

Performs the conversion.