Struct fog_pack::types::StreamLockbox

pub struct StreamLockbox(_);

An encrypted StreamKey.

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

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

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

Example

Using a StreamKey for decryption (different from the one contained in the lockbox!):

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

Methods from Deref<Target = StreamLockboxRef>

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<StreamLockboxRef> for StreamLockbox

pub fn borrow(&self) -> &StreamLockboxRef

Immutably borrows from an owned value.

impl Clone for StreamLockbox

pub fn clone(&self) -> StreamLockbox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamLockbox

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

Formats the value using the given formatter.

impl Deref for StreamLockbox

type Target = StreamLockboxRef

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for StreamLockbox

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

Deserialize this value from the given Serde deserializer.

impl From<StreamLockbox> for Value

fn from(v: StreamLockbox) -> Self

Performs the conversion.

impl Hash for StreamLockbox

pub 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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<StreamLockbox> for StreamLockbox

pub fn eq(&self, other: &StreamLockbox) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &StreamLockbox) -> bool

This method tests for !=.

impl Serialize for StreamLockbox

pub 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 StreamLockbox

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 StreamLockbox

impl StructuralEq for StreamLockbox

impl StructuralPartialEq for StreamLockbox