Struct sodiumoxide::crypto::box_::curve25519xsalsa20poly1305::SecretKey

#[must_use]
pub struct SecretKey(pub [u8; 32]);

SecretKey for asymmetric authenticated encryption

When a SecretKey goes out of scope its contents will be zeroed out

Methods

impl SecretKey

fn from_slice(bs: &[u8]) -> Option<SecretKey>

from_slice() creates an object from a byte slice

This function will fail and return None if the length of the byte-s;ice isn't equal to the length of the object

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 PartialEq for SecretKey

fn eq(&self, SecretKey: &SecretKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for SecretKey

impl Serialize for SecretKey

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

Serializes this value into this serializer.

impl Deserialize for SecretKey

fn deserialize<D>(deserializer: &mut D) -> Result<SecretKey, D::Error> where D: Deserializer

Deserialize this value given this Deserializer.

impl Index<Range<usize>> for SecretKey

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[a..b] == y[a..b]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing

fn index(&self, _index: Range<usize>) -> &[u8]

The method for the indexing (container[index]) operation

impl Index<RangeTo<usize>> for SecretKey

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[..b] == y[..b]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing

fn index(&self, _index: RangeTo<usize>) -> &[u8]

The method for the indexing (container[index]) operation

impl Index<RangeFrom<usize>> for SecretKey

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[a..] == y[a..]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing

fn index(&self, _index: RangeFrom<usize>) -> &[u8]

The method for the indexing (container[index]) operation

impl Index<RangeFull> for SecretKey

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[] == y[]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing

fn index(&self, _index: RangeFull) -> &[u8]

The method for the indexing (container[index]) operation

impl Debug for SecretKey

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Drop for SecretKey

fn drop(&mut self)

A method called when the value goes out of scope.