Struct ScopedCipher

pub struct ScopedCipher<C> { /* private fields */ }

A Scoped Cipher is one which has been initialized for a specific dataset. It can be used only to encrypt and decrypt data for that dataset.

Implementations

impl<C> ScopedCipher<C>

pub async fn init_default( client: Arc<ZeroKMSWithClientKey<C>>, ) -> Result<Self, Error>

where C: Credentials<Token = ServiceToken>,

Initialize a new ScopedCipher for the default dataset_id.

pub async fn init( client: Arc<ZeroKMSWithClientKey<C>>, dataset_id: Option<Uuid>, ) -> Result<Self, Error>

where C: Credentials<Token = ServiceToken>,

Initialize a new ScopedCipher for the given dataset_id. If the dataset_id is None, the ScopedCipher will be initialized with the default dataset_id for the client.

pub fn mac<const N: usize>(&self, value: &str, prefix: Option<&str>) -> [u8; N]

This value is used for term index keys and “encrypted” partition / sort keys

pub fn compound_index<I>( &self, index: I, plaintext: ComposablePlaintext, info: String, ) -> Result<IndexTerm, EncryptionError>

where I: ComposableIndex + Send,

pub fn compound_query<I>( &self, index: I, input: ComposablePlaintext, info: String, ) -> Result<IndexTerm, EncryptionError>

where I: ComposableIndex + Send,

pub async fn encrypt( &self, payloads: impl IntoIterator<Item = EncryptPayload<'_>>, ) -> Result<Vec<EncryptedRecord>, Error>

where C: Credentials<Token = ServiceToken>,

Encrypt a stream of EncryptPayload and return them as an EncryptedRecord. This function wraps the ZeroKMSWithClientKey::encrypt function but with the dataset_id set.

pub async fn decrypt( &self, payloads: impl IntoIterator<Item = EncryptedRecord>, ) -> Result<Vec<Vec<u8>>, Error>

where C: Credentials<Token = ServiceToken>,

Decrypt a stream of EncryptedRecord and return the raw decrypted binary blob.

pub fn index_key(&self) -> &IndexKey

Trait Implementations

impl<C> Debug for ScopedCipher<C>

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

Formats the value using the given formatter.

impl<C> Drop for ScopedCipher<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C> Zeroize for ScopedCipher<C>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.