Struct private_box::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

pub fn public_key(&self) -> PublicKey

public_key() computes the corresponding public key for a given secret key

impl SecretKey

pub 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-slice isn't equal to the length of the object

Trait Implementations

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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Performs 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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Performs the indexing (container[index]) operation.

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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Performs 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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

Performs the indexing (container[index]) operation.

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

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SecretKey

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

Serialize this value into the given Serde serializer.

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, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SecretKey

impl PartialEq<SecretKey> for SecretKey

fn eq(&self, &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 !=.