GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-48337: [C++][Parquet] Improve column encryption API#48338

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
pitrou merged 1 commit into from
Dec 8, 2025
Merged

GH-48337: [C++][Parquet] Improve column encryption API #48338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,13 +68,10 @@ int main(int argc, char** argv) {
auto column_path1 = schema_desc.Column(5)->path()->ToDotString();
auto column_path2 = schema_desc.Column(4)->path()->ToDotString();

parquet::ColumnEncryptionProperties::Builder encryption_col_builder0(column_path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder1(column_path2);
encryption_col_builder0.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder1.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols[column_path1] = encryption_col_builder0.build();
encryption_cols[column_path2] = encryption_col_builder1.build();
encryption_cols[column_path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols[column_path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder(
kFooterEncryptionKey);
Expand Down
51 changes: 20 additions & 31 deletions cpp/examples/parquet/low_level_api/encryption_reader_writer_all_crypto_options.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,10 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
encryption_cols2;
std::string path1 = "double_field";
std::string path2 = "float_field";
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_20(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_21(path2);
encryption_col_builder_20.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_21.key(kColumnEncryptionKey2)->key_id("kc2");

encryption_cols2[path1] = encryption_col_builder_20.build();
encryption_cols2[path2] = encryption_col_builder_21.build();
encryption_cols2[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols2[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

parquet::FileEncryptionProperties::Builder file_encryption_builder_2(
kFooterEncryptionKey);
Expand All@@ -194,13 +191,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// (plaintext footer mode, readable by legacy readers)
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols3;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_30(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_31(path2);
encryption_col_builder_30.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_31.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols3[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols3[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols3[path1] = encryption_col_builder_30.build();
encryption_cols3[path2] = encryption_col_builder_31.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_3(
kFooterEncryptionKey);

Expand All@@ -214,13 +209,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols4;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_40(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_41(path2);
encryption_col_builder_40.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_41.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols4[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols4[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols4[path1] = encryption_col_builder_40.build();
encryption_cols4[path2] = encryption_col_builder_41.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_4(
kFooterEncryptionKey);

Expand All@@ -234,13 +227,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use aad_prefix and disable_aad_prefix_storage.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols5;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_50(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_51(path2);
encryption_col_builder_50.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_51.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols5[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols5[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols5[path1] = encryption_col_builder_50.build();
encryption_cols5[path2] = encryption_col_builder_51.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_5(
kFooterEncryptionKey);

Expand All@@ -255,13 +246,11 @@ void InteropTestWriteEncryptedParquetFiles(std::string root_path) {
// Use AES_GCM_CTR_V1 algorithm.
std::map<std::string, std::shared_ptr<parquet::ColumnEncryptionProperties>>
encryption_cols6;
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_60(path1);
parquet::ColumnEncryptionProperties::Builder encryption_col_builder_61(path2);
encryption_col_builder_60.key(kColumnEncryptionKey1)->key_id("kc1");
encryption_col_builder_61.key(kColumnEncryptionKey2)->key_id("kc2");
encryption_cols6[path1] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encryption_cols6[path2] =
parquet::ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc2");

encryption_cols6[path1] = encryption_col_builder_60.build();
encryption_cols6[path2] = encryption_col_builder_61.build();
parquet::FileEncryptionProperties::Builder file_encryption_builder_6(
kFooterEncryptionKey);

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/parquet/encryption/crypto_factory.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,7 @@ ColumnPathToEncryptionPropertiesMap CryptoFactory::GetColumnEncryptionProperties
key_wrapper->GetEncryptionKeyMetadata(column_key, column_key_id, false);

std::shared_ptr<ColumnEncryptionProperties> cmd =
ColumnEncryptionProperties::Builder(column_name)
ColumnEncryptionProperties::Builder()
.key(column_key)
->key_metadata(column_key_key_metadata)
->build();
Expand Down
24 changes: 18 additions & 6 deletions cpp/src/parquet/encryption/encryption.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,16 +179,12 @@ FileEncryptionProperties::Builder::disable_aad_prefix_storage() {
return this;
}

ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
std::string column_path,
SecureString key,
ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted, SecureString key,
std::string key_metadata)
: column_path_(std::move(column_path)),
encrypted_(encrypted),
: encrypted_(encrypted),
encrypted_with_footer_key_(encrypted && key.empty()),
key_(std::move(key)),
key_metadata_(std::move(key_metadata)) {
DCHECK(!column_path_.empty());
if (!encrypted) {
DCHECK(key_.empty() && key_metadata_.empty());
}
Expand All@@ -200,6 +196,22 @@ ColumnEncryptionProperties::ColumnEncryptionProperties(bool encrypted,
}
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::Unencrypted() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/false, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithFooterKey() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(/*encrypted=*/true, {}, {}));
}

std::shared_ptr<ColumnEncryptionProperties> ColumnEncryptionProperties::WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata) {
return std::shared_ptr<ColumnEncryptionProperties>(new ColumnEncryptionProperties(
/*encrypted=*/true, std::move(key), std::move(key_metadata)));
}

ColumnDecryptionProperties::ColumnDecryptionProperties(std::string column_path,
SecureString key)
: column_path_(std::move(column_path)), key_(std::move(key)) {
Expand Down
29 changes: 14 additions & 15 deletions cpp/src/parquet/encryption/encryption.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,12 +114,13 @@ class PARQUET_EXPORT ColumnEncryptionProperties {
public:
class PARQUET_EXPORT Builder {
public:
/// Convenience builder for encrypted columns.
explicit Builder(std::string name) : Builder(std::move(name), true) {}
PARQUET_DEPRECATED("name argument is ignored, use default constructor instead")
explicit Builder(const std::string& name) : encrypted_(true) {}

/// Convenience builder for encrypted columns.
explicit Builder(const schema::ColumnPath& path)
: Builder(path.ToDotString(), true) {}
PARQUET_DEPRECATED("path argument is ignored, use default constructor instead")
explicit Builder(const schema::ColumnPath& path) : encrypted_(true) {}

Builder() = default;

/// Set a column-specific key.
/// If key is not set on an encrypted column, the column will
Expand All@@ -140,33 +141,31 @@ class PARQUET_EXPORT ColumnEncryptionProperties {

std::shared_ptr<ColumnEncryptionProperties> build() {
return std::shared_ptr<ColumnEncryptionProperties>(
new ColumnEncryptionProperties(encrypted_, column_path_, key_, key_metadata_));
new ColumnEncryptionProperties(encrypted_, key_, key_metadata_));
}

private:
std::string column_path_;
bool encrypted_;
bool encrypted_ = true;
::arrow::util::SecureString key_;
std::string key_metadata_;

Builder(std::string path, bool encrypted)
: column_path_(std::move(path)), encrypted_(encrypted) {}
};

const std::string& column_path() const { return column_path_; }
bool is_encrypted() const { return encrypted_; }
bool is_encrypted_with_footer_key() const { return encrypted_with_footer_key_; }
const ::arrow::util::SecureString& key() const { return key_; }
const std::string& key_metadata() const { return key_metadata_; }

static std::shared_ptr<ColumnEncryptionProperties> Unencrypted();
static std::shared_ptr<ColumnEncryptionProperties> WithFooterKey();
static std::shared_ptr<ColumnEncryptionProperties> WithColumnKey(
::arrow::util::SecureString key, std::string key_metadata = "");

private:
std::string column_path_;
bool encrypted_;
bool encrypted_with_footer_key_;
::arrow::util::SecureString key_;
std::string key_metadata_;
explicit ColumnEncryptionProperties(bool encrypted, std::string column_path,
::arrow::util::SecureString key,
explicit ColumnEncryptionProperties(bool encrypted, ::arrow::util::SecureString key,
std::string key_metadata);
};

Expand Down
59 changes: 31 additions & 28 deletions cpp/src/parquet/encryption/properties_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,29 +25,46 @@
namespace parquet::encryption::test {

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithOwnKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());

// Same with shorthand API
column_props_1 =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, column_props_1->key());
ASSERT_EQ("kc1", column_props_1->key_metadata());
}

TEST(TestColumnEncryptionProperties, ColumnEncryptedWithFooterKey) {
std::string column_path_1 = "column_1";
ColumnEncryptionProperties::Builder column_builder_1(column_path_1);
ColumnEncryptionProperties::Builder column_builder_1;
std::shared_ptr<ColumnEncryptionProperties> column_props_1 = column_builder_1.build();

ASSERT_EQ(column_path_1, column_props_1->column_path());
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());

// Same with shorthand API
column_props_1 = ColumnEncryptionProperties::WithFooterKey();
ASSERT_EQ(true, column_props_1->is_encrypted());
ASSERT_EQ(true, column_props_1->is_encrypted_with_footer_key());
}

TEST(TestColumnEncryptionProperties, UnencryptedColumn) {
ColumnEncryptionProperties::Builder column_builder_1;

auto column_props_1 = ColumnEncryptionProperties::Unencrypted();
ASSERT_EQ(false, column_props_1->is_encrypted());
ASSERT_EQ(false, column_props_1->is_encrypted_with_footer_key());
}

// Encrypt all columns and the footer with the same key.
// (uniform encryption)
TEST(TestEncryptionProperties, UniformEncryption) {
Expand All@@ -74,19 +91,14 @@ TEST(TestEncryptionProperties, UniformEncryption) {
TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(column_path_1->ToDotString());
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(column_path_2->ToDotString());
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -100,7 +112,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -109,7 +120,6 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand All@@ -128,19 +138,14 @@ TEST(TestEncryptionProperties, EncryptFooterAndTwoColumns) {
TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<parquet::schema::ColumnPath> column_path_1 =
parquet::schema::ColumnPath::FromDotString("column_1");
ColumnEncryptionProperties::Builder column_builder_1(*column_path_1);
column_builder_1.key(kColumnEncryptionKey1);
column_builder_1.key_id("kc1");

std::shared_ptr<parquet::schema::ColumnPath> column_path_2 =
parquet::schema::ColumnPath::FromDotString("column_2");
ColumnEncryptionProperties::Builder column_builder_2(*column_path_2);
column_builder_2.key(kColumnEncryptionKey2);
column_builder_2.key_id("kc2");

std::map<std::string, std::shared_ptr<ColumnEncryptionProperties>> encrypted_columns;
encrypted_columns[column_path_1->ToDotString()] = column_builder_1.build();
encrypted_columns[column_path_2->ToDotString()] = column_builder_2.build();
encrypted_columns[column_path_1->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey1, "kc1");
encrypted_columns[column_path_2->ToDotString()] =
ColumnEncryptionProperties::WithColumnKey(kColumnEncryptionKey2, "kc2");

FileEncryptionProperties::Builder builder(kFooterEncryptionKey);
builder.footer_key_metadata("kf");
Expand All@@ -155,7 +160,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_1 =
props->column_encryption_properties(column_path_1->ToDotString());

ASSERT_EQ(column_path_1->ToDotString(), out_col_props_1->column_path());
ASSERT_EQ(true, out_col_props_1->is_encrypted());
ASSERT_EQ(false, out_col_props_1->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey1, out_col_props_1->key());
Expand All@@ -164,7 +168,6 @@ TEST(TestEncryptionProperties, EncryptTwoColumnsNotFooter) {
std::shared_ptr<ColumnEncryptionProperties> out_col_props_2 =
props->column_encryption_properties(column_path_2->ToDotString());

ASSERT_EQ(column_path_2->ToDotString(), out_col_props_2->column_path());
ASSERT_EQ(true, out_col_props_2->is_encrypted());
ASSERT_EQ(false, out_col_props_2->is_encrypted_with_footer_key());
ASSERT_EQ(kColumnEncryptionKey2, out_col_props_2->key());
Expand Down
Loading
Loading