Struct DataLockbox

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

General encrypted data.

This must be decrypted by the matching recipient, which will return a Vec<u8> on success. It can either be decrypted on its own or through a Vault. In both cases, the data is returned without being stored anywhere.

When decoding, a reference to the data is first created: DataLockboxRef, which can then be converted with to_owned to create this struct.

See: StreamKey::decrypt_data, LockKey::decrypt_data, and Vault::decrypt_data.

Example

Using a StreamKey for decryption:

// We have `enc`, a byte vector containing a lockbox
let dec_lockbox: DataLockbox = DataLockboxRef::from_bytes(&enc[..])?.to_owned();
let recipient: LockboxRecipient = dec_lockbox.recipient();
// ...
// Retrieve the key by looking up recipient
// ...
let plaintext: Vec<u8> = key.decrypt_data(&dec_lockbox)?;

Methods from Deref<Target = DataLockboxRef>

pub fn as_parts(&self) -> LockboxParts<'_>

Decompose the lockbox into its component parts.

pub fn version(&self) -> u8

Get the stream encryption version.

pub fn recipient(&self) -> LockboxRecipient

Get the target recipient who can decrypt this.

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

The raw bytestream, suitable for serialization.

Trait Implementations

impl Borrow<DataLockboxRef> for DataLockbox

fn borrow(&self) -> &DataLockboxRef

Immutably borrows from an owned value.

impl Clone for DataLockbox

fn clone(&self) -> DataLockbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataLockbox

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

Formats the value using the given formatter.

impl Deref for DataLockbox

type Target = DataLockboxRef

The resulting type after dereferencing.

fn deref(&self) -> &<DataLockbox as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for DataLockbox

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DataLockbox> for Value

fn from(v: DataLockbox) -> Self

Converts to this type from the input type.

impl Hash for DataLockbox

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DataLockbox

fn eq(&self, other: &DataLockbox) -> 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 DataLockbox

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 TryFrom<Value> for DataLockbox

type Error = Value

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DataLockbox

impl StructuralPartialEq for DataLockbox