Struct FileDecryptionProperties

pub struct FileDecryptionProperties { /* private fields */ }

FileDecryptionProperties hold keys and AAD data required to decrypt a Parquet file.

When reading Arrow data, the FileDecryptionProperties should be included in the ArrowReaderOptions using with_file_decryption_properties.

Examples

Create FileDecryptionProperties for a file encrypted with uniform encryption, where all metadata and data are encrypted with the footer key:

let file_encryption_properties = FileDecryptionProperties::builder(b"0123456789012345".into())
    .build()?;

Create properties for a file where columns are encrypted with different keys:

let file_encryption_properties = FileDecryptionProperties::builder(b"0123456789012345".into())
    .with_column_key("x", b"1234567890123450".into())
    .with_column_key("y", b"1234567890123451".into())
    .build()?;

Specify additional authenticated data, used to protect against data replacement. This must match the AAD prefix provided when the file was written, otherwise data decryption will fail.

let file_encryption_properties = FileDecryptionProperties::builder(b"0123456789012345".into())
    .with_aad_prefix("example_file".into())
    .build()?;

Implementations

impl FileDecryptionProperties

pub fn builder(footer_key: Vec<u8>) -> DecryptionPropertiesBuilder

Returns a new FileDecryptionProperties builder that will use the provided key to decrypt footer metadata.

pub fn with_key_retriever( key_retriever: Arc<dyn KeyRetriever>, ) -> DecryptionPropertiesBuilderWithRetriever

Returns a new FileDecryptionProperties builder that uses a KeyRetriever to get decryption keys based on key metadata.

pub fn aad_prefix(&self) -> Option<&Vec<u8>>

AAD prefix string uniquely identifies the file and prevents file swapping

pub fn check_plaintext_footer_integrity(&self) -> bool

Returns true if footer signature verification is enabled for files with plaintext footers.

pub fn footer_key( &self, key_metadata: Option<&[u8]>, ) -> Result<Cow<'_, Vec<u8>>, ParquetError>

Get the encryption key for decrypting a file’s footer, and also column data if uniform encryption is used.

pub fn column_key( &self, column_name: &str, key_metadata: Option<&[u8]>, ) -> Result<Cow<'_, Vec<u8>>, ParquetError>

Get the column-specific encryption key for decrypting column data and metadata within a file

pub fn column_keys(&self) -> (Vec<String>, Vec<Vec<u8>>)

Get the column names and associated decryption keys that have been configured. If a key retriever is used rather than explicit decryption keys, the result will be empty. Provided for testing consumer code.

Trait Implementations

impl Clone for FileDecryptionProperties

fn clone(&self) -> FileDecryptionProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileDecryptionProperties

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

Formats the value using the given formatter.

impl From<&FileDecryptionProperties> for ConfigFileDecryptionProperties

fn from(f: &FileDecryptionProperties) -> ConfigFileDecryptionProperties

Converts to this type from the input type.

impl From<ConfigFileDecryptionProperties> for FileDecryptionProperties

fn from(val: ConfigFileDecryptionProperties) -> FileDecryptionProperties

Converts to this type from the input type.

impl PartialEq for FileDecryptionProperties

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