Struct SecretKey

pub struct SecretKey { /* private fields */ }

A crypto_box secret key.

Implementations

impl SecretKey

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

Initialize SecretKey from a byte array.

pub fn from_slice(slice: &[u8]) -> Result<Self, TryFromSliceError>

Initialize SecretKey from a byte slice.

Returns TryFromSliceError if the slice length is not exactly equal to KEY_SIZE.

pub fn generate(csprng: &mut impl CryptoRngCore) -> Self

Available on crate feature rand_core only.

Generate a random SecretKey.

pub fn public_key(&self) -> PublicKey

Get the PublicKey which corresponds to this SecretKey

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

Serialize SecretKey to bytes.

⚠️Warning

The serialized bytes are secret key material. Please treat them with the care they deserve!

Scalar conversion notes

If you are using the From<Scalar> impl on SecretKey (as opposed to using SecretKey::from_bytes or one of the other methods that decodes a secret key from bytes), this method will return the same value as Scalar::to_bytes, which may reflect “clamping” if it was applied to the original Scalar.

In such cases, it may be undesirable to call this method, since such a value may not reflect the original scalar prior to clamping. We suggest you don’t call this method when using From<Scalar> unless you know what you’re doing.

Calling SecretKey::to_scalar can be used to safely round-trip the scalar value in such cases.

pub fn to_scalar(&self) -> Scalar

Obtain the inner Scalar value of this SecretKey.

⚠️Warning

This value is key material. Please treat it with the care it deserves!

pub fn unseal(&self, ciphertext: &[u8]) -> Result<Vec<u8>, Error>

Available on crate feature seal only.

Implementation of crypto_box_seal_open function from libsodium “sealed boxes”.

Sealed boxes are designed to anonymously send messages to a recipient given their public key.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate 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

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<&SecretKey> for PublicKey

fn from(secret_key: &SecretKey) -> PublicKey

Converts to this type from the input type.

impl From<[u8; 32]> for SecretKey

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

Converts to this type from the input type.

impl From<Scalar> for SecretKey

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.

impl PartialEq for SecretKey

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 SecretKey

Available on crate feature serde only.

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 = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, TryFromSliceError>

Performs the conversion.

impl Eq for SecretKey