adamreeve commented on code in PR #6637: URL: https://github.com/apache/arrow-rs/pull/6637#discussion_r1986427446
########## parquet/src/encryption/decryption.rs: ########## @@ -0,0 +1,264 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use crate::encryption::ciphers::{BlockDecryptor, RingGcmBlockDecryptor}; +use crate::encryption::modules::{create_module_aad, ModuleType}; +use crate::errors::{ParquetError, Result}; +use std::collections::HashMap; +use std::io::Read; +use std::sync::Arc; + +pub fn read_and_decrypt<T: Read>( + decryptor: &Arc<dyn BlockDecryptor>, + input: &mut T, + aad: &[u8], +) -> Result<Vec<u8>> { + let mut len_bytes = [0; 4]; + input.read_exact(&mut len_bytes)?; + let ciphertext_len = u32::from_le_bytes(len_bytes) as usize; + let mut ciphertext = vec![0; 4 + ciphertext_len]; + input.read_exact(&mut ciphertext[4..])?; + + decryptor.decrypt(&ciphertext, aad.as_ref()) +} + +// CryptoContext is a data structure that holds the context required to +// decrypt parquet modules (data pages, dictionary pages, etc.). +#[derive(Debug, Clone)] +pub struct CryptoContext { + pub(crate) row_group_ordinal: usize, + pub(crate) column_ordinal: usize, + pub(crate) page_ordinal: Option<usize>, + pub(crate) dictionary_page: bool, + // We have separate data and metadata decryptors because + // in GCM CTR mode, the metadata and data pages use + // different algorithms. + data_decryptor: Arc<dyn BlockDecryptor>, + metadata_decryptor: Arc<dyn BlockDecryptor>, + file_aad: Vec<u8>, +} + +impl CryptoContext { + pub fn new( + row_group_ordinal: usize, + column_ordinal: usize, + data_decryptor: Arc<dyn BlockDecryptor>, + metadata_decryptor: Arc<dyn BlockDecryptor>, + file_aad: Vec<u8>, + ) -> Self { + Self { + row_group_ordinal, + column_ordinal, + page_ordinal: None, + dictionary_page: false, + data_decryptor, + metadata_decryptor, + file_aad, + } + } + + pub fn with_page_ordinal(&self, page_ordinal: usize) -> Self { + Self { + row_group_ordinal: self.row_group_ordinal, + column_ordinal: self.column_ordinal, + page_ordinal: Some(page_ordinal), + dictionary_page: false, + data_decryptor: self.data_decryptor.clone(), + metadata_decryptor: self.metadata_decryptor.clone(), + file_aad: self.file_aad.clone(), + } + } + + pub(crate) fn create_page_header_aad(&self) -> Result<Vec<u8>> { + let module_type = if self.dictionary_page { + ModuleType::DictionaryPageHeader + } else { + ModuleType::DataPageHeader + }; + + create_module_aad( + self.file_aad(), + module_type, + self.row_group_ordinal, + self.column_ordinal, + self.page_ordinal, + ) + } + + pub(crate) fn create_page_aad(&self) -> Result<Vec<u8>> { + let module_type = if self.dictionary_page { + ModuleType::DictionaryPage + } else { + ModuleType::DataPage + }; + + create_module_aad( + self.file_aad(), + module_type, + self.row_group_ordinal, + self.column_ordinal, + self.page_ordinal, + ) + } + + pub fn for_dictionary_page(&self) -> Self { + Self { + row_group_ordinal: self.row_group_ordinal, + column_ordinal: self.column_ordinal, + page_ordinal: self.page_ordinal, + dictionary_page: true, + data_decryptor: self.data_decryptor.clone(), + metadata_decryptor: self.metadata_decryptor.clone(), + file_aad: self.file_aad.clone(), + } + } + + pub fn data_decryptor(&self) -> &Arc<dyn BlockDecryptor> { + &self.data_decryptor + } + + pub fn metadata_decryptor(&self) -> &Arc<dyn BlockDecryptor> { + &self.metadata_decryptor + } + + pub fn file_aad(&self) -> &Vec<u8> { + &self.file_aad + } +} + +/// FileDecryptionProperties hold keys and AAD data required to decrypt a Parquet file. +#[derive(Debug, Clone, PartialEq)] +pub struct FileDecryptionProperties { + footer_key: Vec<u8>, + column_keys: HashMap<String, Vec<u8>>, + aad_prefix: Option<Vec<u8>>, +} + +impl FileDecryptionProperties { + /// Returns a new FileDecryptionProperties builder + pub fn builder(footer_key: Vec<u8>) -> DecryptionPropertiesBuilder { + DecryptionPropertiesBuilder::new(footer_key) + } +} + +pub struct DecryptionPropertiesBuilder { + footer_key: Vec<u8>, + column_keys: HashMap<String, Vec<u8>>, + aad_prefix: Option<Vec<u8>>, +} + +impl DecryptionPropertiesBuilder { + pub fn new(footer_key: Vec<u8>) -> DecryptionPropertiesBuilder { + Self { + footer_key, + column_keys: HashMap::default(), + aad_prefix: None, + } + } + + pub fn build(self) -> Result<FileDecryptionProperties> { + Ok(FileDecryptionProperties { + footer_key: self.footer_key, + column_keys: self.column_keys, + aad_prefix: self.aad_prefix, + }) + } + + pub fn with_aad_prefix(mut self, value: Vec<u8>) -> Self { + self.aad_prefix = Some(value); + self + } + + pub fn with_column_key(mut self, column_name: &str, decryption_key: Vec<u8>) -> Self { + self.column_keys + .insert(column_name.to_string(), decryption_key); + self + } +} + +#[derive(Clone, Debug)] +pub struct FileDecryptor { + decryption_properties: FileDecryptionProperties, + footer_decryptor: Option<Arc<dyn BlockDecryptor>>, + file_aad: Vec<u8>, +} + +impl PartialEq for FileDecryptor { + fn eq(&self, other: &Self) -> bool { + self.decryption_properties == other.decryption_properties + } +} + +impl FileDecryptor { + pub(crate) fn new( + decryption_properties: &FileDecryptionProperties, + aad_file_unique: Vec<u8>, + aad_prefix: Vec<u8>, + ) -> Result<Self, ParquetError> { + let file_aad = [aad_prefix.as_slice(), aad_file_unique.as_slice()].concat(); + // todo decr: if no key available yet (not set in properties, should be retrieved from metadata) + let footer_decryptor = RingGcmBlockDecryptor::new(&decryption_properties.footer_key) + .map_err(|e| { + let msg = String::from("Invalid footer key. ") + + e.to_string().replace("Parquet error: ", "").as_str(); + ParquetError::General(msg) Review Comment: ```suggestion .map_err(|e| general_err!("Invalid footer key. {}", e.to_string().replace("Parquet error: ", "")))?; ``` Edit: Just noticed this diff should apply to lines 215 to 219 so won't be valid if you apply it as-is, you'll probably want to manually apply this. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
