Struct Secret 

pub struct Secret(/* private fields */);

Owned secret bytes. Wiped on drop; Debug shows only the length.

Serializes as a byte string (serialize_bytes, CBOR major type 2), and deserializes one into a wiping buffer with a single copy. A human-readable format, such as JSON, has no byte strings: there it reads a sequence of u8 and nothing else, so a JSON string is an error, not its text’s bytes. A type whose serde shape stores its secret as a sequence of u8, as OpenMLS’s SignatureKeyPair does, reads it with deserialize_seq. Equality is constant time.

Implementations

impl Secret

pub fn new(bytes: Vec<u8>) -> Self

Take ownership of bytes. The buffer is wiped when the Secret drops.

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

Borrow the secret bytes.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Secret

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

Deserialize this value from the given Serde deserializer.

impl From<Secret> for Zeroizing<Vec<u8>>

fn from(secret: Secret) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Secret

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq for Secret

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 Secret

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

Serialize this value into the given Serde serializer.

impl Entity<{ openmls_traits::storage::CURRENT_VERSION }> for Secret

A secret is stored in the MLS key store as one CBOR byte string, and reading it through Secret copies the bytes once into a wiping buffer.

impl Eq for Secret

impl ZeroizeOnDrop for Secret