parquet/file/metadata/
writer.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
18use crate::file::metadata::thrift::FileMeta;
19use crate::file::metadata::{
20    ColumnChunkMetaData, ParquetColumnIndex, ParquetOffsetIndex, RowGroupMetaData,
21};
22use crate::schema::types::{SchemaDescPtr, SchemaDescriptor};
23use crate::{
24    basic::ColumnOrder,
25    file::metadata::{FileMetaData, ParquetMetaDataBuilder},
26};
27#[cfg(feature = "encryption")]
28use crate::{
29    encryption::{
30        encrypt::{FileEncryptor, encrypt_thrift_object, write_signed_plaintext_thrift_object},
31        modules::{ModuleType, create_footer_aad, create_module_aad},
32    },
33    file::column_crypto_metadata::ColumnCryptoMetaData,
34    file::metadata::thrift::encryption::{AesGcmV1, EncryptionAlgorithm, FileCryptoMetaData},
35};
36use crate::{errors::Result, file::page_index::column_index::ColumnIndexMetaData};
37
38use crate::{
39    file::writer::{TrackedWrite, get_file_magic},
40    parquet_thrift::WriteThrift,
41};
42use crate::{
43    file::{
44        metadata::{KeyValue, ParquetMetaData},
45        page_index::offset_index::OffsetIndexMetaData,
46    },
47    parquet_thrift::ThriftCompactOutputProtocol,
48};
49use std::io::Write;
50use std::sync::Arc;
51
52/// Writes `crate::file::metadata` structures to a thrift encoded byte stream
53///
54/// See [`ParquetMetaDataWriter`] for background and example.
55pub(crate) struct ThriftMetadataWriter<'a, W: Write> {
56    buf: &'a mut TrackedWrite<W>,
57    schema_descr: &'a SchemaDescPtr,
58    row_groups: Vec<RowGroupMetaData>,
59    column_indexes: Option<Vec<Vec<Option<ColumnIndexMetaData>>>>,
60    offset_indexes: Option<Vec<Vec<Option<OffsetIndexMetaData>>>>,
61    key_value_metadata: Option<Vec<KeyValue>>,
62    created_by: Option<String>,
63    object_writer: MetadataObjectWriter,
64    writer_version: i32,
65    write_path_in_schema: bool,
66}
67
68impl<'a, W: Write> ThriftMetadataWriter<'a, W> {
69    /// Serialize all the offset indexes to `self.buf`,
70    ///
71    /// Note: also updates the `ColumnChunk::offset_index_offset` and
72    /// `ColumnChunk::offset_index_length` to reflect the position and length
73    /// of the serialized offset indexes.
74    fn write_offset_indexes(
75        &mut self,
76        offset_indexes: &[Vec<Option<OffsetIndexMetaData>>],
77    ) -> Result<()> {
78        // iter row group
79        // iter each column
80        // write offset index to the file
81        for (row_group_idx, row_group) in self.row_groups.iter_mut().enumerate() {
82            for (column_idx, column_metadata) in row_group.columns.iter_mut().enumerate() {
83                if let Some(offset_index) = &offset_indexes[row_group_idx][column_idx] {
84                    let start_offset = self.buf.bytes_written();
85                    self.object_writer.write_offset_index(
86                        offset_index,
87                        column_metadata,
88                        row_group_idx,
89                        column_idx,
90                        &mut self.buf,
91                    )?;
92                    let end_offset = self.buf.bytes_written();
93                    // set offset and index for offset index
94                    column_metadata.offset_index_offset = Some(start_offset as i64);
95                    column_metadata.offset_index_length = Some((end_offset - start_offset) as i32);
96                }
97            }
98        }
99        Ok(())
100    }
101
102    /// Serialize all the column indexes to the `self.buf`
103    ///
104    /// Note: also updates the `ColumnChunk::column_index_offset` and
105    /// `ColumnChunk::column_index_length` to reflect the position and length
106    /// of the serialized column indexes.
107    fn write_column_indexes(
108        &mut self,
109        column_indexes: &[Vec<Option<ColumnIndexMetaData>>],
110    ) -> Result<()> {
111        // iter row group
112        // iter each column
113        // write column index to the file
114        for (row_group_idx, row_group) in self.row_groups.iter_mut().enumerate() {
115            for (column_idx, column_metadata) in row_group.columns.iter_mut().enumerate() {
116                if let Some(column_index) = &column_indexes[row_group_idx][column_idx] {
117                    let start_offset = self.buf.bytes_written();
118                    // only update column_metadata if the write succeeds
119                    if self.object_writer.write_column_index(
120                        column_index,
121                        column_metadata,
122                        row_group_idx,
123                        column_idx,
124                        &mut self.buf,
125                    )? {
126                        let end_offset = self.buf.bytes_written();
127                        // set offset and index for offset index
128                        column_metadata.column_index_offset = Some(start_offset as i64);
129                        column_metadata.column_index_length =
130                            Some((end_offset - start_offset) as i32);
131                    }
132                }
133            }
134        }
135        Ok(())
136    }
137
138    /// Serialize the column indexes and transform to `Option<ParquetColumnIndex>`
139    fn finalize_column_indexes(&mut self) -> Result<Option<ParquetColumnIndex>> {
140        let column_indexes = std::mem::take(&mut self.column_indexes);
141
142        // Write column indexes to file
143        if let Some(column_indexes) = column_indexes.as_ref() {
144            self.write_column_indexes(column_indexes)?;
145        }
146
147        // check to see if the index is `None` for every row group and column chunk
148        let all_none = column_indexes
149            .as_ref()
150            .is_some_and(|ci| ci.iter().all(|cii| cii.iter().all(|idx| idx.is_none())));
151
152        // transform from Option<Vec<Vec<Option<ColumnIndexMetaData>>>> to
153        // Option<Vec<Vec<ColumnIndexMetaData>>>
154        let column_indexes: Option<ParquetColumnIndex> = if all_none {
155            None
156        } else {
157            column_indexes.map(|ovvi| {
158                ovvi.into_iter()
159                    .map(|vi| {
160                        vi.into_iter()
161                            .map(|ci| ci.unwrap_or(ColumnIndexMetaData::NONE))
162                            .collect()
163                    })
164                    .collect()
165            })
166        };
167
168        Ok(column_indexes)
169    }
170
171    /// Serialize the offset indexes and transform to `Option<ParquetOffsetIndex>`
172    fn finalize_offset_indexes(&mut self) -> Result<Option<ParquetOffsetIndex>> {
173        let offset_indexes = std::mem::take(&mut self.offset_indexes);
174
175        // Write offset indexes to file
176        if let Some(offset_indexes) = offset_indexes.as_ref() {
177            self.write_offset_indexes(offset_indexes)?;
178        }
179
180        // check to see if the index is `None` for every row group and column chunk
181        let all_none = offset_indexes
182            .as_ref()
183            .is_some_and(|oi| oi.iter().all(|oii| oii.iter().all(|idx| idx.is_none())));
184
185        let offset_indexes: Option<ParquetOffsetIndex> = if all_none {
186            None
187        } else {
188            // FIXME(ets): this will panic if there's a missing index.
189            offset_indexes.map(|ovvi| {
190                ovvi.into_iter()
191                    .map(|vi| vi.into_iter().map(|oi| oi.unwrap()).collect())
192                    .collect()
193            })
194        };
195
196        Ok(offset_indexes)
197    }
198
199    /// Assembles and writes the final metadata to self.buf
200    pub fn finish(mut self) -> Result<ParquetMetaData> {
201        let num_rows = self.row_groups.iter().map(|x| x.num_rows).sum();
202
203        // serialize page indexes and transform to the proper form for use in ParquetMetaData
204        let column_indexes = self.finalize_column_indexes()?;
205        let offset_indexes = self.finalize_offset_indexes()?;
206
207        // We only include ColumnOrder for leaf nodes.
208        let column_orders = self
209            .schema_descr
210            .columns()
211            .iter()
212            .map(|col| {
213                ColumnOrder::column_order_for_type(
214                    col.logical_type_ref(),
215                    col.converted_type(),
216                    col.physical_type(),
217                )
218            })
219            .collect();
220
221        // This field is optional, perhaps in cases where no min/max fields are set
222        // in any Statistics or ColumnIndex object in the whole file.
223        // But for simplicity we always set this field.
224        let column_orders = Some(column_orders);
225
226        let (row_groups, unencrypted_row_groups) = self
227            .object_writer
228            .apply_row_group_encryption(self.row_groups)?;
229
230        #[cfg(feature = "encryption")]
231        let (encryption_algorithm, footer_signing_key_metadata) =
232            self.object_writer.get_plaintext_footer_crypto_metadata();
233        #[cfg(feature = "encryption")]
234        let file_metadata = FileMetaData::new(
235            self.writer_version,
236            num_rows,
237            self.created_by,
238            self.key_value_metadata,
239            self.schema_descr.clone(),
240            column_orders,
241        )
242        .with_encryption_algorithm(encryption_algorithm)
243        .with_footer_signing_key_metadata(footer_signing_key_metadata);
244
245        #[cfg(not(feature = "encryption"))]
246        let file_metadata = FileMetaData::new(
247            self.writer_version,
248            num_rows,
249            self.created_by,
250            self.key_value_metadata,
251            self.schema_descr.clone(),
252            column_orders,
253        );
254
255        let file_meta = FileMeta {
256            file_metadata: &file_metadata,
257            row_groups: &row_groups,
258            write_path_in_schema: self.write_path_in_schema,
259        };
260
261        // Write file metadata
262        let start_pos = self.buf.bytes_written();
263        self.object_writer
264            .write_file_metadata(&file_meta, &mut self.buf)?;
265        let end_pos = self.buf.bytes_written();
266
267        // Write footer
268        let metadata_len = (end_pos - start_pos) as u32;
269
270        self.buf.write_all(&metadata_len.to_le_bytes())?;
271        self.buf.write_all(self.object_writer.get_file_magic())?;
272
273        // If row group metadata was encrypted, we replace the encrypted row groups with
274        // unencrypted metadata before it is returned to users. This allows the metadata
275        // to be usable for retrieving the row group statistics for example, without users
276        // needing to decrypt the metadata.
277        let builder = ParquetMetaDataBuilder::new(file_metadata)
278            .set_column_index(column_indexes)
279            .set_offset_index(offset_indexes);
280
281        Ok(match unencrypted_row_groups {
282            Some(rg) => builder.set_row_groups(rg).build(),
283            None => builder.set_row_groups(row_groups).build(),
284        })
285    }
286
287    pub fn new(
288        buf: &'a mut TrackedWrite<W>,
289        schema_descr: &'a SchemaDescPtr,
290        row_groups: Vec<RowGroupMetaData>,
291        created_by: Option<String>,
292        writer_version: i32,
293        write_path_in_schema: bool,
294    ) -> Self {
295        Self {
296            buf,
297            schema_descr,
298            row_groups,
299            column_indexes: None,
300            offset_indexes: None,
301            key_value_metadata: None,
302            created_by,
303            object_writer: Default::default(),
304            writer_version,
305            write_path_in_schema,
306        }
307    }
308
309    pub fn with_column_indexes(
310        mut self,
311        column_indexes: Vec<Vec<Option<ColumnIndexMetaData>>>,
312    ) -> Self {
313        self.column_indexes = Some(column_indexes);
314        self
315    }
316
317    pub fn with_offset_indexes(
318        mut self,
319        offset_indexes: Vec<Vec<Option<OffsetIndexMetaData>>>,
320    ) -> Self {
321        self.offset_indexes = Some(offset_indexes);
322        self
323    }
324
325    pub fn with_key_value_metadata(mut self, key_value_metadata: Vec<KeyValue>) -> Self {
326        self.key_value_metadata = Some(key_value_metadata);
327        self
328    }
329
330    #[cfg(feature = "encryption")]
331    pub fn with_file_encryptor(mut self, file_encryptor: Option<Arc<FileEncryptor>>) -> Self {
332        self.object_writer = self.object_writer.with_file_encryptor(file_encryptor);
333        self
334    }
335}
336
337/// Writes [`ParquetMetaData`] to a byte stream
338///
339/// This structure handles the details of writing the various parts of Parquet
340/// metadata into a byte stream. It is used to write the metadata into a parquet
341/// file and can also write metadata into other locations (such as a store of
342/// bytes).
343///
344/// # Discussion
345///
346/// The process of writing Parquet metadata is tricky because the
347/// metadata is not stored as a single inline thrift structure. It can have
348/// several "out of band" structures such as the [`OffsetIndex`] and
349/// BloomFilters stored in separate structures whose locations are stored as
350/// offsets from the beginning of the file.
351///
352/// Note: this writer does not directly write BloomFilters. In order to write
353/// BloomFilters, write the bloom filters into the buffer before creating the
354/// metadata writer. Then set the corresponding `bloom_filter_offset` and
355/// `bloom_filter_length` on [`ColumnChunkMetaData`] passed to this writer.
356///
357/// # Output Format
358///
359/// The format of the metadata is as follows:
360///
361/// 1. Optional [`ColumnIndex`] (thrift encoded)
362/// 2. Optional [`OffsetIndex`] (thrift encoded)
363/// 3. [`FileMetaData`] (thrift encoded)
364/// 4. Length of encoded `FileMetaData` (4 bytes, little endian)
365/// 5. Parquet Magic Bytes (4 bytes)
366///
367/// [`FileMetaData`]: https://github.com/apache/parquet-format/tree/master?tab=readme-ov-file#metadata
368/// [`ColumnChunkMetaData`]: crate::file::metadata::ColumnChunkMetaData
369/// [`ColumnIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
370/// [`OffsetIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
371///
372/// ```text
373/// ┌──────────────────────┐
374/// │                      │
375/// │         ...          │
376/// │                      │
377/// │┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │
378/// │     ColumnIndex     ◀│─ ─ ─
379/// ││    (Optional)     │ │     │
380/// │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─  │
381/// │┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │     │ FileMetadata
382/// │     OffsetIndex      │       contains embedded
383/// ││    (Optional)     │◀┼ ─   │ offsets to
384/// │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─  │  │    ColumnIndex and
385/// │╔═══════════════════╗ │     │ OffsetIndex
386/// │║                   ║ │  │
387/// │║                   ║ ┼ ─   │
388/// │║   FileMetadata    ║ │
389/// │║                   ║ ┼ ─ ─ ┘
390/// │║                   ║ │
391/// │╚═══════════════════╝ │
392/// │┌───────────────────┐ │
393/// ││  metadata length  │ │ length of FileMetadata  (only)
394/// │└───────────────────┘ │
395/// │┌───────────────────┐ │
396/// ││      'PAR1'       │ │ Parquet Magic Bytes
397/// │└───────────────────┘ │
398/// └──────────────────────┘
399///      Output Buffer
400/// ```
401///
402/// # Example
403/// ```no_run
404/// # use parquet::file::metadata::{ParquetMetaData, ParquetMetaDataWriter};
405/// # fn get_metadata() -> ParquetMetaData { unimplemented!(); }
406/// // write parquet metadata to an in-memory buffer
407/// let mut buffer = vec![];
408/// let metadata: ParquetMetaData = get_metadata();
409/// let writer = ParquetMetaDataWriter::new(&mut buffer, &metadata);
410/// // write the metadata to the buffer
411/// writer.finish().unwrap();
412/// assert!(!buffer.is_empty());
413/// ```
414pub struct ParquetMetaDataWriter<'a, W: Write> {
415    buf: TrackedWrite<W>,
416    metadata: &'a ParquetMetaData,
417    write_path_in_schema: bool,
418}
419
420impl<'a, W: Write> ParquetMetaDataWriter<'a, W> {
421    /// Create a new `ParquetMetaDataWriter` to write to `buf`
422    ///
423    /// Note any embedded offsets in the metadata will be written assuming the
424    /// metadata is at the start of the buffer. If the metadata is being written
425    /// to a location other than the start of the buffer, see [`Self::new_with_tracked`]
426    ///
427    /// See example on the struct level documentation
428    pub fn new(buf: W, metadata: &'a ParquetMetaData) -> Self {
429        Self::new_with_tracked(TrackedWrite::new(buf), metadata)
430    }
431
432    /// Create a new ParquetMetaDataWriter to write to `buf`
433    ///
434    /// This method is used when the metadata is being written to a location other
435    /// than the start of the buffer.
436    ///
437    /// See example on the struct level documentation
438    pub fn new_with_tracked(buf: TrackedWrite<W>, metadata: &'a ParquetMetaData) -> Self {
439        Self {
440            buf,
441            metadata,
442            write_path_in_schema: true,
443        }
444    }
445
446    /// Set whether or not to write the `path_in_schema` field in the Thrift `ColumnMetaData`
447    /// struct.
448    pub fn with_write_path_in_schema(self, val: bool) -> Self {
449        Self {
450            write_path_in_schema: val,
451            ..self
452        }
453    }
454
455    /// Write the metadata to the buffer
456    pub fn finish(mut self) -> Result<()> {
457        let file_metadata = self.metadata.file_metadata();
458
459        let schema = Arc::new(file_metadata.schema().clone());
460        let schema_descr = Arc::new(SchemaDescriptor::new(schema.clone()));
461        let created_by = file_metadata.created_by().map(str::to_string);
462
463        let row_groups = self.metadata.row_groups.clone();
464
465        let key_value_metadata = file_metadata.key_value_metadata().cloned();
466
467        let column_indexes = self.convert_column_indexes();
468        let offset_indexes = self.convert_offset_index();
469
470        let mut encoder = ThriftMetadataWriter::new(
471            &mut self.buf,
472            &schema_descr,
473            row_groups,
474            created_by,
475            file_metadata.version(),
476            self.write_path_in_schema,
477        );
478
479        if let Some(column_indexes) = column_indexes {
480            encoder = encoder.with_column_indexes(column_indexes);
481        }
482
483        if let Some(offset_indexes) = offset_indexes {
484            encoder = encoder.with_offset_indexes(offset_indexes);
485        }
486
487        if let Some(key_value_metadata) = key_value_metadata {
488            encoder = encoder.with_key_value_metadata(key_value_metadata);
489        }
490        encoder.finish()?;
491
492        Ok(())
493    }
494
495    fn convert_column_indexes(&self) -> Option<Vec<Vec<Option<ColumnIndexMetaData>>>> {
496        // TODO(ets): we're converting from ParquetColumnIndex to vec<vec<option>>,
497        // but then converting back to ParquetColumnIndex in the end. need to unify this.
498        self.metadata
499            .column_index()
500            .map(|row_group_column_indexes| {
501                (0..self.metadata.row_groups().len())
502                    .map(|rg_idx| {
503                        let column_indexes = &row_group_column_indexes[rg_idx];
504                        column_indexes
505                            .iter()
506                            .map(|column_index| Some(column_index.clone()))
507                            .collect()
508                    })
509                    .collect()
510            })
511    }
512
513    fn convert_offset_index(&self) -> Option<Vec<Vec<Option<OffsetIndexMetaData>>>> {
514        self.metadata
515            .offset_index()
516            .map(|row_group_offset_indexes| {
517                (0..self.metadata.row_groups().len())
518                    .map(|rg_idx| {
519                        let offset_indexes = &row_group_offset_indexes[rg_idx];
520                        offset_indexes
521                            .iter()
522                            .map(|offset_index| Some(offset_index.clone()))
523                            .collect()
524                    })
525                    .collect()
526            })
527    }
528}
529
530#[derive(Debug, Default)]
531struct MetadataObjectWriter {
532    #[cfg(feature = "encryption")]
533    file_encryptor: Option<Arc<FileEncryptor>>,
534}
535
536impl MetadataObjectWriter {
537    #[inline]
538    fn write_thrift_object(object: &impl WriteThrift, sink: impl Write) -> Result<()> {
539        let mut protocol = ThriftCompactOutputProtocol::new(sink);
540        object.write_thrift(&mut protocol)?;
541        Ok(())
542    }
543}
544
545/// Implementations of [`MetadataObjectWriter`] methods for when encryption is disabled
546#[cfg(not(feature = "encryption"))]
547impl MetadataObjectWriter {
548    /// Write [`FileMetaData`] in Thrift format
549    ///
550    /// [`FileMetaData`]: https://github.com/apache/parquet-format/tree/master?tab=readme-ov-file#metadata
551    fn write_file_metadata(&self, file_metadata: &FileMeta, sink: impl Write) -> Result<()> {
552        Self::write_thrift_object(file_metadata, sink)
553    }
554
555    /// Write a column [`OffsetIndex`] in Thrift format
556    ///
557    /// [`OffsetIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
558    fn write_offset_index(
559        &self,
560        offset_index: &OffsetIndexMetaData,
561        _column_chunk: &ColumnChunkMetaData,
562        _row_group_idx: usize,
563        _column_idx: usize,
564        sink: impl Write,
565    ) -> Result<()> {
566        Self::write_thrift_object(offset_index, sink)
567    }
568
569    /// Write a column [`ColumnIndex`] in Thrift format
570    ///
571    /// If `column_index` is [`ColumnIndexMetaData::NONE`] the index will not be written and
572    /// this will return `false`. Returns `true` otherwise.
573    ///
574    /// [`ColumnIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
575    fn write_column_index(
576        &self,
577        column_index: &ColumnIndexMetaData,
578        _column_chunk: &ColumnChunkMetaData,
579        _row_group_idx: usize,
580        _column_idx: usize,
581        sink: impl Write,
582    ) -> Result<bool> {
583        match column_index {
584            // Missing indexes may also have the placeholder ColumnIndexMetaData::NONE
585            ColumnIndexMetaData::NONE => Ok(false),
586            _ => {
587                Self::write_thrift_object(column_index, sink)?;
588                Ok(true)
589            }
590        }
591    }
592
593    /// No-op implementation of row-group metadata encryption
594    fn apply_row_group_encryption(
595        &self,
596        row_groups: Vec<RowGroupMetaData>,
597    ) -> Result<(Vec<RowGroupMetaData>, Option<Vec<RowGroupMetaData>>)> {
598        Ok((row_groups, None))
599    }
600
601    /// Get the "magic" bytes identifying the file type
602    pub fn get_file_magic(&self) -> &[u8; 4] {
603        get_file_magic()
604    }
605}
606
607/// Implementations of [`MetadataObjectWriter`] methods that rely on encryption being enabled
608#[cfg(feature = "encryption")]
609impl MetadataObjectWriter {
610    /// Set the file encryptor to use
611    fn with_file_encryptor(mut self, encryptor: Option<Arc<FileEncryptor>>) -> Self {
612        self.file_encryptor = encryptor;
613        self
614    }
615
616    /// Write [`FileMetaData`] in Thrift format, possibly encrypting it if required
617    ///
618    /// [`FileMetaData`]: https://github.com/apache/parquet-format/tree/master?tab=readme-ov-file#metadata
619    fn write_file_metadata(&self, file_metadata: &FileMeta, mut sink: impl Write) -> Result<()> {
620        match self.file_encryptor.as_ref() {
621            Some(file_encryptor) if file_encryptor.properties().encrypt_footer() => {
622                // First write FileCryptoMetadata
623                let crypto_metadata = Self::file_crypto_metadata(file_encryptor)?;
624                let mut protocol = ThriftCompactOutputProtocol::new(&mut sink);
625                crypto_metadata.write_thrift(&mut protocol)?;
626
627                // Then write encrypted footer
628                let aad = create_footer_aad(file_encryptor.file_aad())?;
629                let mut encryptor = file_encryptor.get_footer_encryptor()?;
630                encrypt_thrift_object(file_metadata, &mut encryptor, &mut sink, &aad)
631            }
632            Some(file_encryptor) if file_metadata.file_metadata.encryption_algorithm.is_some() => {
633                let aad = create_footer_aad(file_encryptor.file_aad())?;
634                let mut encryptor = file_encryptor.get_footer_encryptor()?;
635                write_signed_plaintext_thrift_object(file_metadata, &mut encryptor, &mut sink, &aad)
636            }
637            _ => Self::write_thrift_object(file_metadata, &mut sink),
638        }
639    }
640
641    /// Write a column [`OffsetIndex`] in Thrift format, possibly encrypting it if required
642    ///
643    /// [`OffsetIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
644    fn write_offset_index(
645        &self,
646        offset_index: &OffsetIndexMetaData,
647        column_chunk: &ColumnChunkMetaData,
648        row_group_idx: usize,
649        column_idx: usize,
650        sink: impl Write,
651    ) -> Result<()> {
652        match &self.file_encryptor {
653            Some(file_encryptor) => Self::write_thrift_object_with_encryption(
654                offset_index,
655                sink,
656                file_encryptor,
657                column_chunk,
658                ModuleType::OffsetIndex,
659                row_group_idx,
660                column_idx,
661            ),
662            None => Self::write_thrift_object(offset_index, sink),
663        }
664    }
665
666    /// Write a column [`ColumnIndex`] in Thrift format, possibly encrypting it if required
667    ///
668    /// If `column_index` is [`ColumnIndexMetaData::NONE`] the index will not be written and
669    /// this will return `false`. Returns `true` otherwise.
670    ///
671    /// [`ColumnIndex`]: https://github.com/apache/parquet-format/blob/master/PageIndex.md
672    fn write_column_index(
673        &self,
674        column_index: &ColumnIndexMetaData,
675        column_chunk: &ColumnChunkMetaData,
676        row_group_idx: usize,
677        column_idx: usize,
678        sink: impl Write,
679    ) -> Result<bool> {
680        match column_index {
681            // Missing indexes may also have the placeholder ColumnIndexMetaData::NONE
682            ColumnIndexMetaData::NONE => Ok(false),
683            _ => {
684                match &self.file_encryptor {
685                    Some(file_encryptor) => Self::write_thrift_object_with_encryption(
686                        column_index,
687                        sink,
688                        file_encryptor,
689                        column_chunk,
690                        ModuleType::ColumnIndex,
691                        row_group_idx,
692                        column_idx,
693                    )?,
694                    None => Self::write_thrift_object(column_index, sink)?,
695                }
696                Ok(true)
697            }
698        }
699    }
700
701    /// If encryption is enabled and configured, encrypt row group metadata.
702    /// Returns a tuple of the row group metadata to write,
703    /// and possibly unencrypted metadata to be returned to clients if data was encrypted.
704    fn apply_row_group_encryption(
705        &self,
706        row_groups: Vec<RowGroupMetaData>,
707    ) -> Result<(Vec<RowGroupMetaData>, Option<Vec<RowGroupMetaData>>)> {
708        match &self.file_encryptor {
709            Some(file_encryptor) => {
710                let unencrypted_row_groups = row_groups.clone();
711                let encrypted_row_groups = Self::encrypt_row_groups(row_groups, file_encryptor)?;
712                Ok((encrypted_row_groups, Some(unencrypted_row_groups)))
713            }
714            None => Ok((row_groups, None)),
715        }
716    }
717
718    /// Get the "magic" bytes identifying the file type
719    fn get_file_magic(&self) -> &[u8; 4] {
720        get_file_magic(
721            self.file_encryptor
722                .as_ref()
723                .map(|encryptor| encryptor.properties()),
724        )
725    }
726
727    fn write_thrift_object_with_encryption(
728        object: &impl WriteThrift,
729        mut sink: impl Write,
730        file_encryptor: &FileEncryptor,
731        column_metadata: &ColumnChunkMetaData,
732        module_type: ModuleType,
733        row_group_index: usize,
734        column_index: usize,
735    ) -> Result<()> {
736        let column_path_vec = column_metadata.column_path().as_ref();
737
738        let joined_column_path;
739        let column_path = if column_path_vec.len() == 1 {
740            &column_path_vec[0]
741        } else {
742            joined_column_path = column_path_vec.join(".");
743            &joined_column_path
744        };
745
746        if file_encryptor.is_column_encrypted(column_path) {
747            use crate::encryption::encrypt::encrypt_thrift_object;
748
749            let aad = create_module_aad(
750                file_encryptor.file_aad(),
751                module_type,
752                row_group_index,
753                column_index,
754                None,
755            )?;
756            let mut encryptor = file_encryptor.get_column_encryptor(column_path)?;
757            encrypt_thrift_object(object, &mut encryptor, &mut sink, &aad)
758        } else {
759            Self::write_thrift_object(object, sink)
760        }
761    }
762
763    fn get_plaintext_footer_crypto_metadata(
764        &self,
765    ) -> (Option<EncryptionAlgorithm>, Option<Vec<u8>>) {
766        // Only plaintext footers may contain encryption algorithm and footer key metadata.
767        if let Some(file_encryptor) = self.file_encryptor.as_ref() {
768            let encryption_properties = file_encryptor.properties();
769            if !encryption_properties.encrypt_footer() {
770                return (
771                    Some(Self::encryption_algorithm_from_encryptor(file_encryptor)),
772                    encryption_properties.footer_key_metadata().cloned(),
773                );
774            }
775        }
776        (None, None)
777    }
778
779    fn encryption_algorithm_from_encryptor(file_encryptor: &FileEncryptor) -> EncryptionAlgorithm {
780        let supply_aad_prefix = file_encryptor
781            .properties()
782            .aad_prefix()
783            .map(|_| !file_encryptor.properties().store_aad_prefix());
784        let aad_prefix = if file_encryptor.properties().store_aad_prefix() {
785            file_encryptor.properties().aad_prefix()
786        } else {
787            None
788        };
789        EncryptionAlgorithm::AES_GCM_V1(AesGcmV1 {
790            aad_prefix: aad_prefix.cloned(),
791            aad_file_unique: Some(file_encryptor.aad_file_unique().clone()),
792            supply_aad_prefix,
793        })
794    }
795
796    fn file_crypto_metadata(file_encryptor: &'_ FileEncryptor) -> Result<FileCryptoMetaData<'_>> {
797        let properties = file_encryptor.properties();
798        Ok(FileCryptoMetaData {
799            encryption_algorithm: Self::encryption_algorithm_from_encryptor(file_encryptor),
800            key_metadata: properties.footer_key_metadata().map(|v| v.as_slice()),
801        })
802    }
803
804    fn encrypt_row_groups(
805        row_groups: Vec<RowGroupMetaData>,
806        file_encryptor: &Arc<FileEncryptor>,
807    ) -> Result<Vec<RowGroupMetaData>> {
808        row_groups
809            .into_iter()
810            .enumerate()
811            .map(|(rg_idx, mut rg)| {
812                let cols: Result<Vec<ColumnChunkMetaData>> = rg
813                    .columns
814                    .into_iter()
815                    .enumerate()
816                    .map(|(col_idx, c)| {
817                        Self::encrypt_column_chunk(c, file_encryptor, rg_idx, col_idx)
818                    })
819                    .collect();
820                rg.columns = cols?;
821                Ok(rg)
822            })
823            .collect()
824    }
825
826    /// Apply column encryption to column chunk metadata
827    fn encrypt_column_chunk(
828        mut column_chunk: ColumnChunkMetaData,
829        file_encryptor: &Arc<FileEncryptor>,
830        row_group_index: usize,
831        column_index: usize,
832    ) -> Result<ColumnChunkMetaData> {
833        // Column crypto metadata should have already been set when the column was created.
834        // Here we apply the encryption by encrypting the column metadata if required.
835        let encryptor = match column_chunk.column_crypto_metadata.as_deref() {
836            None => None,
837            Some(ColumnCryptoMetaData::ENCRYPTION_WITH_FOOTER_KEY) => {
838                let is_footer_encrypted = file_encryptor.properties().encrypt_footer();
839
840                // When uniform encryption is used the footer is already encrypted,
841                // so the column chunk does not need additional encryption.
842                // Except if we're in plaintext footer mode, then we need to encrypt
843                // the column metadata here.
844                if !is_footer_encrypted {
845                    Some(file_encryptor.get_footer_encryptor()?)
846                } else {
847                    None
848                }
849            }
850            Some(ColumnCryptoMetaData::ENCRYPTION_WITH_COLUMN_KEY(col_key)) => {
851                let column_path = col_key.path_in_schema.join(".");
852                Some(file_encryptor.get_column_encryptor(&column_path)?)
853            }
854        };
855
856        if let Some(mut encryptor) = encryptor {
857            use crate::file::metadata::thrift::serialize_column_meta_data;
858
859            let aad = create_module_aad(
860                file_encryptor.file_aad(),
861                ModuleType::ColumnMetaData,
862                row_group_index,
863                column_index,
864                None,
865            )?;
866            // create temp ColumnMetaData that we can encrypt
867            let mut buffer: Vec<u8> = vec![];
868            {
869                let mut prot = ThriftCompactOutputProtocol::new(&mut buffer);
870                serialize_column_meta_data(&column_chunk, &mut prot)?;
871            }
872            let ciphertext = encryptor.encrypt(&buffer, &aad)?;
873            column_chunk.encrypted_column_metadata = Some(ciphertext);
874            // Track whether the footer is plaintext, which affects how we serialize
875            // the column metadata (we need to write stripped metadata for backward compatibility)
876            column_chunk.plaintext_footer_mode = !file_encryptor.properties().encrypt_footer();
877        }
878
879        Ok(column_chunk)
880    }
881}
parquet/file/metadata/writer.rs

parquet/file/metadata/
writer.rs
