Struct SecretKey

Source
pub struct SecretKey { /* private fields */ }
Expand description

A crypto_box secret key.

Implementations§

Source§

impl SecretKey

Source

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

Initialize SecretKey from a byte array.

Source

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.

Source

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

Available on crate feature rand_core only.

Generate a random SecretKey.

Source

pub fn public_key(&self) -> PublicKey

Get the PublicKey which corresponds to this SecretKey

Source

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.

Source

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!

Source

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§

Source§

impl Clone for SecretKey

Source§

fn clone(&self) -> SecretKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecretKey

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Available on crate feature serde only.
Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Drop for SecretKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<&SecretKey> for PublicKey

Source§

fn from(secret_key: &SecretKey) -> PublicKey

Converts to this type from the input type.
Source§

impl From<[u8; 32]> for SecretKey

Source§

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

Converts to this type from the input type.
Source§

impl From<Scalar> for SecretKey

Source§

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SecretKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SecretKey

Available on crate feature serde only.
Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&[u8]> for SecretKey

Source§

type Error = TryFromSliceError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Eq for SecretKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,