Skip to content

fix: check for key retriever in Parquet decryption properties conversion #24866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kosiew merged 3 commits into from
Sep 10, 2026
Merged

fix: check for key retriever in Parquet decryption properties conversion #24866

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71a2832
Check for key retriever in decryption properties conversion
adamreeve Sep 1, 2026
1665dd0
Ignore key_metadata in test KeyRetriever implementation
adamreeve Sep 8, 2026
8208093
Merge remote-tracking branch 'upstream/main' into key-retriever-check
adamreeve Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions datafusion/common/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3693,11 +3693,20 @@ impl TryFrom<&Arc<FileDecryptionProperties>> for ConfigFileDecryptionProperties
type Error = DataFusionError;

fn try_from(f: &Arc<FileDecryptionProperties>) -> Result<Self> {
if f.uses_key_retriever() {
// Getting the keys is not possible without the key metadata from
// a Parquet file if a key retriever is used.
return Err(
DataFusionError::Configuration(
"Cannot convert FileDecryptionProperties that use a key retriever to ConfigFileDecryptionProperties".into()
)
);
}

let footer_key = f.footer_key(None).map_err(|e| {
// This shouldn't happen for FileDecryptionProperties that don't use a key retriever.
DataFusionError::Configuration(format!(
"Could not retrieve footer key from FileDecryptionProperties. \
Note that conversion to ConfigFileDecryptionProperties is not supported \
when using a key retriever: {e}"
"Could not retrieve footer key from FileDecryptionProperties: {e}"
))
})?;

Expand Down Expand Up @@ -4468,14 +4477,10 @@ mod tests {

#[cfg(feature = "parquet_encryption")]
impl parquet::encryption::decrypt::KeyRetriever for ParquetEncryptionKeyRetriever {
fn retrieve_key(&self, key_metadata: &[u8]) -> parquet::errors::Result<Vec<u8>> {
if !key_metadata.is_empty() {
Ok(b"1234567890123450".to_vec())
} else {
Err(parquet::errors::ParquetError::General(
"Key metadata not provided".to_string(),
))
}
fn retrieve_key(&self, _key_metadata: &[u8]) -> parquet::errors::Result<Vec<u8>> {
// Ignore key metadata so we can verify that the key retriever isn't used
// even if it can provide a key without using metadata.
Ok(b"1234567890123450".to_vec())
}
}

Expand All @@ -4495,8 +4500,10 @@ mod tests {
(&decryption_properties).try_into();
assert!(config_file_decryption_properties.is_err());
let err = config_file_decryption_properties.unwrap_err().to_string();
assert!(err.contains("key retriever"));
assert!(err.contains("Key metadata not provided"));
assert_contains!(
err,
"Cannot convert FileDecryptionProperties that use a key retriever to ConfigFileDecryptionProperties"
);
}

#[cfg(feature = "parquet")]
Expand Down