ggershinsky commented on code in PR #14621: URL: https://github.com/apache/iceberg/pull/14621#discussion_r2567598614
########## docs/docs/encryption.md: ########## @@ -0,0 +1,146 @@ +--- +title: "Encryption" +--- +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + --> + +# Encryption + +Iceberg table encryption protects confidentiality and integrity of table data in an untrusted storage. The `data`, `delete`, `manifest` and `manifest list` files are encrypted and tamper-proofed before being sent to the storage backend. + +The `metadata.json` file does not contain data or stats, and is therefore not encrypted. + +Currently, encryption is supported in the Hive and REST catalogs for tables with Parquet and Avro data formats. + +Two parameters are required to activate encryption of a table, +1. Catalog property `encryption.kms-impl`, that specifies the class path for a client of a KMS ("key management service"). +2. Table property `encryption.key-id`, that specifies the ID of a master key used to encrypt and decrypt the table. Master keys are stored and managed in the KMS. + +For more details, see the "Appendix: How It Works" [subsection](#appendix-how-it-works). + +## Example + +```sh +spark-sql --packages org.apache.iceberg:iceberg-spark-runtime-{{ sparkVersionMajor }}:{{ icebergVersion }}\ + --conf spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions \ + --conf spark.sql.catalog.spark_catalog=org.apache.iceberg.spark.SparkSessionCatalog \ + --conf spark.sql.catalog.spark_catalog.type=hive \ + --conf spark.sql.catalog.local=org.apache.iceberg.spark.SparkCatalog \ + --conf spark.sql.catalog.local.type=hive \ + --conf spark.sql.catalog.local.encryption.kms-impl=org.apache.iceberg.aws.AwsKeyManagementClient +``` + +```sql +CREATE TABLE local.db.table (id bigint, data string) USING iceberg +TBLPROPERTIES ('encryption.key-id'='{{ master key id }}'); +``` + +Inserted data will be automatically encrypted, + +```sql +INSERT INTO local.db.table VALUES (1, 'a'), (2, 'b'), (3, 'c'); +``` + +To verify encryption, the contents of data, manifest and manifest list files can be dumped in the command line with + +```sh +hexdump -C {{ /path/to/file }} | more +``` + +The Parquet files must start with the "PARE" magic string (PARquet Encrypted footer mode), and manifest/list files must start with "AGS1" magic string (Aes Gcm Stream version 1). + +Queried data will be automatically decrypted, + +```sql +SELECT * FROM local.db.table; +``` + +## Security requirements + +To function properly, Iceberg table encryption places the following requirements on the catalogs: + +1. For protection of table data confidentiality, the table encryption properties (`encryption.key-id` and an optional `encryption.data-key-length`) must be kept in a tamper-proof storage or in a trusted independent database. Catalogs must not retrieve these properties directly from the metadata.json, if this file is kept unprotected in a storage vulnerable to tampering. +2. For protection of table integrity, the metadata json must be kept in a tamper-proof storage or in a trusted independent object store. Catalogs must not retrieve the metadata.json file directly, if it is kept unprotected in a storage vulnerable to tampering. Review Comment: Yep, this can be simplified. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
