Skip to content
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.

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

GH-41246: [Docs][C++][Python] Improve docs on column encryption for nested fields #45411

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
76 changes: 76 additions & 0 deletions docs/source/cpp/parquet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,82 @@ More specifically, Parquet C++ supports:
* EncryptionWithFooterKey and EncryptionWithColumnKey modes.
* Encrypted Footer and Plaintext Footer modes.

Configuration
~~~~~~~~~~~~~

An example for writing a dataset using encrypted Parquet file format:

.. code-block:: cpp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jorisvandenbossche @AlenkaF @raulcd What is our preferred policy for code examples? Do we put them inline in the docs? Do we use separate files?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update: it seems we use literalinclude directives from C++ example files that are compiled as part of CI runs. See for example https://github.com/apache/arrow/blob/main/docs/source/cpp/dataset.rst#reading-datasets


#include <arrow/util/logging.h>

#include "arrow/dataset/file_parquet.h"
#include "arrow/dataset/parquet_encryption_config.h"
#include "arrow/testing/gtest_util.h"
#include "parquet/encryption/crypto_factory.h"

using arrow::internal::checked_pointer_cast;

auto crypto_factory = std::make_shared<parquet::encryption::CryptoFactory>();
parquet::encryption::KmsClientFactory kms_client_factory = ...;
crypto_factory->RegisterKmsClientFactory(std::move(kms_client_factory));
auto kms_connection_config = std::make_shared<parquet::encryption::KmsConnectionConfig>();

// Set write options with encryption configuration.
auto encryption_config =
std::make_shared<parquet::encryption::EncryptionConfiguration>(
std::string("footer_key"));
encryption_config->column_keys = "col_key: a";
auto parquet_encryption_config = std::make_shared<ParquetEncryptionConfig>();
// Directly assign shared_ptr objects to ParquetEncryptionConfig members
parquet_encryption_config->crypto_factory = crypto_factory;
parquet_encryption_config->kms_connection_config = kms_connection_config;
parquet_encryption_config->encryption_config = std::move(encryption_config);

auto file_format = std::make_shared<ParquetFileFormat>();
auto parquet_file_write_options =
checked_pointer_cast<ParquetFileWriteOptions>(file_format->DefaultWriteOptions());
parquet_file_write_options->parquet_encryption_config =
std::move(parquet_encryption_config);

// Write dataset.
arrow::Table table = ...;
auto dataset = std::make_shared<InMemoryDataset>(table);
EXPECT_OK_AND_ASSIGN(auto scanner_builder, dataset->NewScan());
EXPECT_OK_AND_ASSIGN(auto scanner, scanner_builder->Finish());

FileSystemDatasetWriteOptions write_options;
write_options.file_write_options = parquet_file_write_options;
write_options.base_dir = "example.parquet";
ARROW_CHECK_OK(FileSystemDataset::Write(write_options, std::move(scanner)));

Column encryption is configured by setting ``encryption_config->column_keys`` to a string
of the format ``"masterKeyID:colName,colName;masterKeyID:colName..."``.
EnricoMi marked this conversation as resolved.
Show resolved Hide resolved

Encrypting columns that have nested fields (for instance struct, map, or even list data types)
require configuring column keys for the inner fields, not the column itself.
Configuring a column key for the column itself causes this error (here column name is ``col``):

.. code-block::

OSError: Encrypted column col not in file schema

An example encryption configuration for columns with nested fields:

.. code-block:: cpp

auto table_schema = schema({
field("ListColumn", list(int32())),
field("MapColumn", map(utf8(), int32())),
field("StructColumn", struct_({field("f1", int32()), field("f2", utf8())})),
});

encryption_config->column_keys = "column_key_name: "
EnricoMi marked this conversation as resolved.
Show resolved Hide resolved
"ListColumn.list.element, "
"MapColumn.key_value.key, MapColumn.key_value.value, "
"StructColumn.f1, StructColumn.f2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the spaces embedded in the string actually supported? Also, it seems to lack a semicolon at the end of the line.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it supports extra whitespaces, it trims the strings. The final semicolon is not needed, it would introduce a next empty section:

ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties(
int dek_length, const std::string& column_keys, FileKeyWrapper* key_wrapper) {
ColumnPathToEncryptionPropertiesMap encrypted_columns;
std::vector<::std::string_view> key_to_columns =
::arrow::internal::SplitString(column_keys, ';');
for (size_t i = 0; i < key_to_columns.size(); ++i) {
std::string cur_key_to_columns =
::arrow::internal::TrimString(std::string(key_to_columns[i]));
if (cur_key_to_columns.empty()) {
continue;
}
std::vector<::std::string_view> parts =
::arrow::internal::SplitString(cur_key_to_columns, ':');
if (parts.size() != 2) {
std::ostringstream message;
message << "Incorrect key to columns mapping in column keys property"
<< ": [" << cur_key_to_columns << "]";
throw ParquetException(message.str());
}
std::string column_key_id = ::arrow::internal::TrimString(std::string(parts[0]));
if (column_key_id.empty()) {
throw ParquetException("Empty key name in column keys property.");
}
std::string column_names_str = ::arrow::internal::TrimString(std::string(parts[1]));
std::vector<::std::string_view> column_names =
::arrow::internal::SplitString(column_names_str, ',');
if (0 == column_names.size()) {
throw ParquetException("No columns to encrypt defined for key: " + column_key_id);
}
for (size_t j = 0; j < column_names.size(); ++j) {
std::string column_name =
::arrow::internal::TrimString(std::string(column_names[j]));
if (column_name.empty()) {
std::ostringstream message;
message << "Empty column name in column keys property for key: " << column_key_id;
throw ParquetException(message.str());
}
if (encrypted_columns.find(column_name) != encrypted_columns.end()) {
throw ParquetException("Multiple keys defined for the same column: " +
column_name);
}
std::string column_key(dek_length, '\0');
RandBytes(reinterpret_cast<uint8_t*>(column_key.data()), column_key.size());
std::string column_key_key_metadata =
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);
std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
encrypted_columns.insert({column_name, cmd});
}
}
if (encrypted_columns.empty()) {
throw ParquetException("No column keys configured in column keys property.");
}
return encrypted_columns;
}



Miscellaneous
-------------

Expand Down
32 changes: 31 additions & 1 deletion docs/source/python/parquet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -703,7 +703,7 @@ creating file encryption properties) includes the following options:
* ``footer_key``, the ID of the master key for footer encryption/signing.
* ``column_keys``, which columns to encrypt with which key. Dictionary with
master key IDs as the keys, and column name lists as the values,
e.g. ``{key1: [col1, col2], key2: [col3]}`` .
e.g. ``{key1: [col1, col2], key2: [col3]}``. See notes on nested fields below.
* ``encryption_algorithm``, the Parquet encryption algorithm.
Can be ``AES_GCM_V1`` (default) or ``AES_GCM_CTR_V1``.
* ``plaintext_footer``, whether to write the file footer in plain text (otherwise it is encrypted).
Expand Down Expand Up @@ -739,6 +739,36 @@ An example encryption configuration:
},
)

.. note::
Encrypting columns that have nested fields (for instance struct, map, or even list data types)
require configuring column keys for the inner fields, not the column itself.
Configuring a column key for the column itself causes this error (here column name is ``col``):

.. code-block::

OSError: Encrypted column col not in file schema

An example encryption configuration for columns with nested fields:
EnricoMi marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: python

schema = pa.schema([
("ListColumn", pa.list_(pa.int32())),
("MapColumn", pa.map_(pa.string(), pa.int32())),
("StructColumn", pa.struct([("f1", pa.int32()), ("f2", pa.string())])),
])

encryption_config = pq.EncryptionConfiguration(
footer_key="footer_key_name",
column_keys={
"column_key_name": [
EnricoMi marked this conversation as resolved.
Show resolved Hide resolved
"ListColumn.list.element",
"MapColumn.key_value.key", "MapColumn.key_value.value",
"StructColumn.f1", "StructColumn.f2"
],
},
)

Decryption configuration
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading