Struct IdentityLockbox 

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

An encrypted IdentityKey.

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

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

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

Example

Using a StreamKey for decryption:

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

Methods from Deref<Target = IdentityLockboxRef>

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<IdentityLockboxRef> for IdentityLockbox

fn borrow(&self) -> &IdentityLockboxRef

Immutably borrows from an owned value.

impl Clone for IdentityLockbox

fn clone(&self) -> IdentityLockbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityLockbox

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

Formats the value using the given formatter.

impl Deref for IdentityLockbox

type Target = IdentityLockboxRef

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for IdentityLockbox

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<IdentityLockbox> for Value

fn from(v: IdentityLockbox) -> Self

Converts to this type from the input type.

impl Hash for IdentityLockbox

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 IdentityLockbox

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

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 IdentityLockbox

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 IdentityLockbox

impl StructuralPartialEq for IdentityLockbox