Struct PrecalcSecretKey 

pub struct PrecalcSecretKey<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize>(/* private fields */);

Precalculated secret key for use with precalc_* functions in crate::dryocbox::DryocBox.

Use precalc_* functions to encrypt or decrypt multiple messages between the same sender and receiver. They reuse this shared secret instead of repeating the public-key operation for every message.

Using precalculated secret keys is compatible with libsodium’s crypto_box_beforenm.

Implementations

impl PrecalcSecretKey<Locked<HeapByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>>

pub fn precalculate_locked<ThirdPartyPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( third_party_public_key: &ThirdPartyPublicKey, secret_key: &SecretKey, ) -> Result<Self, Error>

Available on crate feature protected only.

Computes a heap-allocated, page-aligned, locked shared secret key for the given third_party_public_key and secret_key.

Compatible with libsodium’s crypto_box_beforenm.

Errors

Returns an error if third_party_public_key is an unacceptable low-order point or the protected allocation cannot be locked.

Panics

Panics if the page-aligned allocation cannot be created or its size cannot be represented with guard pages.

impl PrecalcSecretKey<LockedRO<HeapByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>>

pub fn precalculate_readonly_locked<ThirdPartyPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( third_party_public_key: &ThirdPartyPublicKey, secret_key: &SecretKey, ) -> Result<Self, Error>

Available on crate feature protected only.

Computes a heap-allocated, page-aligned, locked, read-only shared secret key for the given third_party_public_key and secret_key.

Compatible with libsodium’s crypto_box_beforenm.

Errors

Returns an error if third_party_public_key is an unacceptable low-order point, the protected allocation cannot be locked, or its page permissions cannot be changed to read-only.

Panics

Panics if the page-aligned allocation cannot be created or its size cannot be represented with guard pages.

impl PrecalcSecretKey<StackByteArray<CRYPTO_BOX_BEFORENMBYTES>>

pub fn precalculate<ThirdPartyPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( third_party_public_key: &ThirdPartyPublicKey, secret_key: &SecretKey, ) -> Result<Self, Error>

Computes a stack-allocated shared secret key for the given third_party_public_key and secret_key.

Compatible with libsodium’s crypto_box_beforenm.

Errors

Returns an error if third_party_public_key is an unacceptable low-order point.

Trait Implementations

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> ByteArray<CRYPTO_BOX_BEFORENMBYTES> for PrecalcSecretKey<InnerKey>

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

Returns a reference to the underlying fixed-length byte array.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Bytes + Zeroize> Bytes for PrecalcSecretKey<InnerKey>

fn as_slice(&self) -> &[u8]

Returns a slice of the underlying bytes.

fn is_empty(&self) -> bool

Returns true if the array is empty.

fn len(&self) -> usize

Shorthand to retrieve the underlying length of the byte array.

impl<InnerKey: Clone + ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> Clone for PrecalcSecretKey<InnerKey>

fn clone(&self) -> PrecalcSecretKey<InnerKey>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> Debug for PrecalcSecretKey<InnerKey>

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

Formats the value using the given formatter.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> Deref for PrecalcSecretKey<InnerKey>

type Target = InnerKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> DerefMut for PrecalcSecretKey<InnerKey>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> Drop for PrecalcSecretKey<InnerKey>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> Eq for PrecalcSecretKey<InnerKey>

impl<InnerKey: MutByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> MutByteArray<CRYPTO_BOX_BEFORENMBYTES> for PrecalcSecretKey<InnerKey>

fn as_mut_array(&mut self) -> &mut [u8; 32]

Returns a mutable reference to the underlying fixed-length byte array.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize + MutBytes> MutBytes for PrecalcSecretKey<InnerKey>

fn as_mut_slice(&mut self) -> &mut [u8]

Returns a mutable slice to the underlying bytes.

fn copy_from_slice(&mut self, other: &[u8])

Copies into the underlying slice from other. Panics if lengths do not match.

impl<InnerKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize> PartialEq for PrecalcSecretKey<InnerKey>

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

Equality operator ==.

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

Inequality operator !=.

impl<InnerKey> Zeroize for PrecalcSecretKey<InnerKey>

where InnerKey: Zeroize + ByteArray<CRYPTO_BOX_BEFORENMBYTES>,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.