Struct DataEnvelope

pub struct DataEnvelope {
    envelope_data: CoseEncrypt0Bytes,
}

DataEnvelope allows sealing structs entire structs to encrypted blobs.

Sealing a struct results in an encrypted blob, and a content-encryption-key. The content-encryption-key must be provided again when unsealing the data. A content encryption key allows easy key-rotation of the encrypting-key, as now just the content-encryption-keys need to be re-uploaded, instead of all data.

The content-encryption-key cannot be re-used for encrypting other data.

Note: This is explicitly meant for structured data, not large binary blobs (files).

Fields

envelope_data: CoseEncrypt0Bytes

Implementations

impl DataEnvelope

pub fn seal<Ids: KeyIds, T>( data: T, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<(Self, Ids::Symmetric), DataEnvelopeError>

where T: Serialize + SealableVersionedData,

Seals a struct into an encrypted blob, and stores the content-encryption-key in the provided context.

pub fn seal_with_wrapping_key<Ids: KeyIds, T>( data: T, wrapping_key: &Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<(Self, EncString), DataEnvelopeError>

where T: Serialize + SealableVersionedData,

Seals a struct into an encrypted blob. The content encryption key is wrapped with the provided wrapping key

fn seal_ref<T>( data: &T, namespace: &DataEnvelopeNamespace, ) -> Result<(DataEnvelope, XChaCha20Poly1305Key), DataEnvelopeError>

where T: Serialize + SealableVersionedData,

Seals a struct into an encrypted blob, and returns the encrypted blob and the content-encryption-key.

pub fn unseal<Ids: KeyIds, T>( &self, cek_keyslot: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<T, DataEnvelopeError>

where T: DeserializeOwned + SealableVersionedData,

Unseals the data from the encrypted blob using a content-encryption-key stored in the context.

pub fn unseal_with_wrapping_key<Ids: KeyIds, T>( &self, wrapping_key: &Ids::Symmetric, wrapped_cek: &EncString, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<T, DataEnvelopeError>

where T: DeserializeOwned + SealableVersionedData,

Unseals the data from the encrypted blob and wrapped content-encryption-key.

fn unseal_ref<T>( &self, namespace: &DataEnvelopeNamespace, cek: &XChaCha20Poly1305Key, ) -> Result<T, DataEnvelopeError>

where T: DeserializeOwned + SealableVersionedData,

Unseals the data from the encrypted blob using the provided content-encryption-key.

Trait Implementations

impl Clone for DataEnvelope

fn clone(&self) -> DataEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for DataEnvelope

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for DataEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataEnvelope

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DataEnvelope

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for DataEnvelope

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = <String as Lower<UniFfiTag>>::FfiType

The low-level type used for passing values of this type over the FFI.

fn lower(obj: DataEnvelope) -> Self::FfiType

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(v: Self::FfiType) -> Result<DataEnvelope>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: DataEnvelope, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<DataEnvelope>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<&DataEnvelope> for Vec<u8>

fn from(val: &DataEnvelope) -> Self

Converts to this type from the input type.

impl From<DataEnvelope> for String

fn from(val: DataEnvelope) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for DataEnvelope

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl FromStr for DataEnvelope

type Err = NotB64EncodedError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromWasmAbi for DataEnvelope

type Abi = <String as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(abi: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<UT> Lift<UT> for DataEnvelope

type FfiType = <DataEnvelope as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for DataEnvelope

type LiftType = DataEnvelope

impl<UT> LiftReturn<UT> for DataEnvelope

type ReturnType = <DataEnvelope as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for DataEnvelope

type FfiType = <DataEnvelope as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for DataEnvelope

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for DataEnvelope

type ReturnType = <DataEnvelope as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Serialize for DataEnvelope

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for DataEnvelope

const TYPE_ID_META: MetadataBuffer

impl WasmDescribe for DataEnvelope

fn describe()