datafusion_common/
encryption.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18// Support optional features for encryption in Parquet files.
19//! This module provides types and functions related to encryption in Parquet files.
20
21#[cfg(feature = "parquet_encryption")]
22pub use parquet::encryption::decrypt::FileDecryptionProperties;
23#[cfg(feature = "parquet_encryption")]
24pub use parquet::encryption::encrypt::FileEncryptionProperties;
25
26#[cfg(not(feature = "parquet_encryption"))]
27pub struct FileDecryptionProperties;
28#[cfg(not(feature = "parquet_encryption"))]
29pub struct FileEncryptionProperties;
30
31#[cfg(feature = "parquet")]
32use crate::config::ParquetEncryptionOptions;
33pub use crate::config::{ConfigFileDecryptionProperties, ConfigFileEncryptionProperties};
34#[cfg(feature = "parquet")]
35use parquet::file::properties::WriterPropertiesBuilder;
36
37#[cfg(feature = "parquet")]
38pub fn add_crypto_to_writer_properties(
39    #[allow(unused)] crypto: &ParquetEncryptionOptions,
40    #[allow(unused_mut)] mut builder: WriterPropertiesBuilder,
41) -> WriterPropertiesBuilder {
42    #[cfg(feature = "parquet_encryption")]
43    if let Some(file_encryption_properties) = &crypto.file_encryption {
44        builder = builder
45            .with_file_encryption_properties(file_encryption_properties.clone().into());
46    }
47    builder
48}
49
50#[cfg(feature = "parquet_encryption")]
51pub fn map_encryption_to_config_encryption(
52    encryption: Option<&FileEncryptionProperties>,
53) -> Option<ConfigFileEncryptionProperties> {
54    encryption.map(|fe| fe.into())
55}
56
57#[cfg(not(feature = "parquet_encryption"))]
58pub fn map_encryption_to_config_encryption(
59    _encryption: Option<&FileEncryptionProperties>,
60) -> Option<ConfigFileEncryptionProperties> {
61    None
62}
63
64#[cfg(feature = "parquet_encryption")]
65pub fn map_config_decryption_to_decryption(
66    decryption: Option<&ConfigFileDecryptionProperties>,
67) -> Option<FileDecryptionProperties> {
68    decryption.map(|fd| fd.clone().into())
69}
70
71#[cfg(not(feature = "parquet_encryption"))]
72pub fn map_config_decryption_to_decryption(
73    _decryption: Option<&ConfigFileDecryptionProperties>,
74) -> Option<FileDecryptionProperties> {
75    None
76}