Struct EncryptedRecord 

pub struct EncryptedRecord {
    pub iv: Iv,
    pub ciphertext: Vec<u8>,
    pub tag: Vec<u8>,
    pub descriptor: String,
    pub keyset_id: Option<Uuid>,
    pub decryption_policy: Option<DecryptionPolicy>,
}

Represents an encrypted record for storage in the database. Implements serialization and deserialization so you can use it with any serde-compatible format however convenience methods are provided for CBOR, MessagePack, Hex, and Base85 encoding.

Fields

iv: Iv

ciphertext: Vec<u8>

tag: Vec<u8>

descriptor: String

keyset_id: Option<Uuid>

decryption_policy: Option<DecryptionPolicy>

Decryption policy with server-generated MAC (tag_version=1 only).

Implementations

impl EncryptedRecord

pub fn to_vec(&self) -> Result<Vec<u8>, DecryptError>

👎Deprecated since 0.12.4:

Use to_cbor_bytes or to_mp_bytes instead

Serialize the record to a Vec<u8> using CBOR encoding

pub fn to_cbor_bytes(&self) -> Result<Vec<u8>, DecryptError>

Serialize the record to a Vec<u8> using CBOR encoding

pub fn to_mp_bytes(&self) -> Result<Vec<u8>, DecryptError>

Serialize the record to a Vec<u8> using MessagePack encoding

pub fn to_hex(&self) -> Result<String, DecryptError>

👎Deprecated since 0.12.4:

Use to_cbor_hex or to_mp_base85 instead

Serialize the record using CBOR and convert to a hex-encoded string

pub fn to_cbor_hex(&self) -> Result<String, DecryptError>

Serialize the record using CBOR and convert to a hex-encoded string

pub fn to_mp_base85(&self) -> Result<String, DecryptError>

Serialize the record using MessagePack and convert to a base85-encoded string

pub fn from_slice(bytes: &[u8]) -> Result<Self, DecryptError>

👎Deprecated since 0.12.4:

Use from_cbor_bytes or from_mp_bytes instead

Deserialize a record from a slice of bytes encoded using CBOR

pub fn from_cbor_bytes(bytes: &[u8]) -> Result<Self, DecryptError>

Deserialize a record from a slice of bytes encoded using CBOR

pub fn from_mp_bytes(bytes: &[u8]) -> Result<Self, DecryptError>

Deserialize a record from a slice of bytes encoded using MessagePack

pub fn from_hex(hexstr: impl AsRef<[u8]>) -> Result<Self, DecryptError>

👎Deprecated since 0.12.4:

Use from_cbor_hex or from_mp_base85 instead

Deserialize a record from a hex-encoded string of bytes encoded using CBOR

pub fn from_cbor_hex(hexstr: &str) -> Result<Self, DecryptError>

Deserialize a record from a hex-encoded string of bytes encoded using CBOR

pub fn from_mp_base85(base85str: &str) -> Result<Self, DecryptError>

Deserialize a record from a base85-encoded string of bytes encoded using MessagePack

pub fn with_context<'a>(self, context: Context) -> WithContext<'a>

Add a context to the record to prepare it for decryption.

Trait Implementations

impl Clone for EncryptedRecord

fn clone(&self) -> EncryptedRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedRecord

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

Formats the value using the given formatter.

impl Decryptable for EncryptedRecord

type Error = Infallible

fn keyset_id(&self) -> Option<Uuid>

The keyset ID associated with the record, if any.

fn retrieve_key_payload(&self) -> Result<RetrieveKeyPayload<'_>, Self::Error>

The payload used to retrieve the key for decryption.

fn into_encrypted_record(self) -> Result<EncryptedRecord, Self::Error>

Convert the record into an EncryptedRecord.

fn nonce_override(&self) -> Option<[u8; 12]>

The explicit AEAD nonce for this record, when the wire format derives it from something other than the data key’s IV. SteVec entries under the envelope wire format derive it from the entry’s stored selector (nonce = selector_bytes[..12]); classic records return None and decrypt with the IV-derived nonce.

fn aad_selector(&self) -> Option<[u8; 16]>

The full 16-byte tokenized selector to bind into the AEAD AAD, when the wire format ties the ciphertext to a selector. The nonce only covers the first 12 selector bytes, so binding all 16 here authenticates the whole selector — a stored selector cannot be mutated (even in its last 4 bytes) without the entry failing to decrypt. SteVec entries return their selector; classic records return None and add nothing to the AAD.

impl<'de> Deserialize<'de> for EncryptedRecord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EncryptedRecord

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

Formats the value using the given formatter.

impl<'a> From<&'a EncryptedRecord> for RetrieveKeyPayload<'a>

fn from(record: &'a EncryptedRecord) -> Self

Converts to this type from the input type.

impl Serialize for EncryptedRecord

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.