Struct LockLockbox

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

An encrypted LockKey.

This must be decrypted by the matching recipient, which will return the LockKey on success. It can either be decrypted on its own, returning a temporary LockKey, or through a Vault, which will store the LockKey.

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

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

Example

Using a StreamKey for decryption:

// We have `enc`, a byte vector containing a lockbox
let dec_lockbox: LockLockbox = LockLockboxRef::from_bytes(&enc[..])?.to_owned();
let recipient: LockboxRecipient = dec_lockbox.recipient();
// ...
// Retrieve the key by looking up recipient
// ...
let dec_key: LockKey = key.decrypt_lock_key(&dec_lockbox)?;

Methods from Deref<Target = LockLockboxRef>

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<LockLockboxRef> for LockLockbox

fn borrow(&self) -> &LockLockboxRef

Immutably borrows from an owned value.

impl Clone for LockLockbox

fn clone(&self) -> LockLockbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockLockbox

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

Formats the value using the given formatter.

impl Deref for LockLockbox

type Target = LockLockboxRef

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for LockLockbox

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for LockLockbox

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

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 LockLockbox

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LockLockbox

impl StructuralPartialEq for LockLockbox