Struct DataLockboxRef

pub struct DataLockboxRef(/* 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.

This is only a reference to an encrypted payload. The owned version is DataLockbox.

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: &DataLockboxRef = DataLockboxRef::from_bytes(&enc[..])?;
let recipient: LockboxRecipient = dec_lockbox.recipient();
// ...
// Retrieve the key by looking up recipient
// ...
let plaintext: Vec<u8> = key.decrypt_data(&dec_lockbox)?;

Implementations

impl 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.

pub fn from_bytes(buf: &[u8]) -> Result<&Self, CryptoError>

Trait Implementations

impl Borrow<DataLockboxRef> for DataLockbox

fn borrow(&self) -> &DataLockboxRef

Immutably borrows from an owned value.

impl Debug for DataLockboxRef

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a DataLockboxRef

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DataLockboxRef

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

Feeds this value into the given Hasher.

impl PartialEq for DataLockboxRef

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToOwned for DataLockboxRef

type Owned = DataLockbox

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for DataLockboxRef

impl StructuralPartialEq for DataLockboxRef