jackye1995 commented on a change in pull request #3470: URL: https://github.com/apache/iceberg/pull/3470#discussion_r743136477
########## File path: core/src/main/java/org/apache/iceberg/encryption/KmsClient.java ########## @@ -0,0 +1,115 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.Serializable; +import java.nio.ByteBuffer; +import java.util.Map; + +/** + * a minimum client interface to connect to a key management service (KMS). + */ +public interface KmsClient extends Serializable { + + /** + * Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * Wrapping means encryption of the secret key with the master key, and adding optional metadata + * that allows KMS to decrypt the secret key in an unwrap call. + * + * @param key a secret key being wrapped + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return wrapped key material + */ + String wrapKey(ByteBuffer key, String wrappingKeyId); + + /** + * Some KMS systems support generation of secret keys inside the KMS server. + * + * @return true if KMS server supports key generation and KmsClient implementation + * is interested to leverage this capability. Otherwise, return false - Iceberg will + * then generate secret keys locally (using the SecureRandom mechanism) and call + * wrapKey to wrap them in KMS. + */ + boolean supportsKeyGeneration(); + + /** + * Generate a new secret key in the KMS server, and wrap it using a wrapping/master key + * which is stored in KMS and referenced by an ID. This method will be called only if + * supportsKeyGeneration returns true. + * + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return a pair of plaintext and wrapped key encrypted with the given wrappingKeyId + */ + KeyGenerationResult generateKey(String wrappingKeyId); + + /** + * Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * + * @param wrappedKey wrapped key material (encrypted key and optional KMS metadata, returned by + * the wrapKey method) + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return plaintext key bytes + */ + ByteBuffer unwrapKey(String wrappedKey, String wrappingKeyId); + + /** + * Returns the algorithm used by the provider when generating keys, such as AES_256_GCM + */ + KeyGenerationAlgorithm keyGenerationAlgorithm(); + + /** + * Returns the spec of the key, such as AES_128 Review comment: nit: {@link KeySpec#AES_128} ########## File path: core/src/main/java/org/apache/iceberg/encryption/KmsClient.java ########## @@ -0,0 +1,115 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.Serializable; +import java.nio.ByteBuffer; +import java.util.Map; + +/** + * a minimum client interface to connect to a key management service (KMS). + */ +public interface KmsClient extends Serializable { + + /** + * Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * Wrapping means encryption of the secret key with the master key, and adding optional metadata + * that allows KMS to decrypt the secret key in an unwrap call. + * + * @param key a secret key being wrapped + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return wrapped key material + */ + String wrapKey(ByteBuffer key, String wrappingKeyId); + + /** + * Some KMS systems support generation of secret keys inside the KMS server. + * + * @return true if KMS server supports key generation and KmsClient implementation + * is interested to leverage this capability. Otherwise, return false - Iceberg will + * then generate secret keys locally (using the SecureRandom mechanism) and call + * wrapKey to wrap them in KMS. + */ + boolean supportsKeyGeneration(); + + /** + * Generate a new secret key in the KMS server, and wrap it using a wrapping/master key + * which is stored in KMS and referenced by an ID. This method will be called only if + * supportsKeyGeneration returns true. + * + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return a pair of plaintext and wrapped key encrypted with the given wrappingKeyId + */ + KeyGenerationResult generateKey(String wrappingKeyId); + + /** + * Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * + * @param wrappedKey wrapped key material (encrypted key and optional KMS metadata, returned by + * the wrapKey method) + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return plaintext key bytes + */ + ByteBuffer unwrapKey(String wrappedKey, String wrappingKeyId); + + /** + * Returns the algorithm used by the provider when generating keys, such as AES_256_GCM Review comment: nit: {@link KeyGenerationAlgorithm#AES_256_GCM} ########## File path: core/src/main/java/org/apache/iceberg/encryption/KmsClient.java ########## @@ -0,0 +1,115 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.Serializable; +import java.nio.ByteBuffer; +import java.util.Map; + +/** + * a minimum client interface to connect to a key management service (KMS). + */ +public interface KmsClient extends Serializable { + + /** + * Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * Wrapping means encryption of the secret key with the master key, and adding optional metadata + * that allows KMS to decrypt the secret key in an unwrap call. + * + * @param key a secret key being wrapped + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return wrapped key material + */ + String wrapKey(ByteBuffer key, String wrappingKeyId); + + /** + * Some KMS systems support generation of secret keys inside the KMS server. + * + * @return true if KMS server supports key generation and KmsClient implementation + * is interested to leverage this capability. Otherwise, return false - Iceberg will + * then generate secret keys locally (using the SecureRandom mechanism) and call Review comment: nit: {@link java.security.SecureRandom} ########## File path: core/src/test/java/org/apache/iceberg/encryption/DemoKmsClient.java ########## @@ -0,0 +1,146 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.security.KeyStore; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.UnrecoverableKeyException; +import java.security.cert.CertificateException; +import java.util.Base64; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import javax.crypto.SecretKey; + +public class DemoKmsClient implements KmsClient { Review comment: can we call it something more meaningful like `LocalKeyFileKmsClient`? ########## File path: core/src/main/java/org/apache/iceberg/encryption/KmsClient.java ########## @@ -0,0 +1,115 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.Serializable; +import java.nio.ByteBuffer; +import java.util.Map; + +/** + * a minimum client interface to connect to a key management service (KMS). + */ +public interface KmsClient extends Serializable { + + /** + * Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * Wrapping means encryption of the secret key with the master key, and adding optional metadata + * that allows KMS to decrypt the secret key in an unwrap call. + * + * @param key a secret key being wrapped + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return wrapped key material + */ + String wrapKey(ByteBuffer key, String wrappingKeyId); + + /** + * Some KMS systems support generation of secret keys inside the KMS server. + * + * @return true if KMS server supports key generation and KmsClient implementation + * is interested to leverage this capability. Otherwise, return false - Iceberg will + * then generate secret keys locally (using the SecureRandom mechanism) and call + * wrapKey to wrap them in KMS. + */ + boolean supportsKeyGeneration(); + + /** + * Generate a new secret key in the KMS server, and wrap it using a wrapping/master key + * which is stored in KMS and referenced by an ID. This method will be called only if + * supportsKeyGeneration returns true. + * + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return a pair of plaintext and wrapped key encrypted with the given wrappingKeyId + */ + KeyGenerationResult generateKey(String wrappingKeyId); + + /** + * Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID. + * + * @param wrappedKey wrapped key material (encrypted key and optional KMS metadata, returned by + * the wrapKey method) + * @param wrappingKeyId a key ID that represents a wrapping key stored in KMS + * @return plaintext key bytes + */ + ByteBuffer unwrapKey(String wrappedKey, String wrappingKeyId); + + /** + * Returns the algorithm used by the provider when generating keys, such as AES_256_GCM + */ + KeyGenerationAlgorithm keyGenerationAlgorithm(); + + /** + * Returns the spec of the key, such as AES_128 + */ + KeySpec keySpec(); + + /** + * Set kms client properties + * + * @param properties kms client properties + */ + void setProperties(Map<String, String> properties); Review comment: Is this the method that initializes the client? In that case we call it `initialize(Map<String, String> properties);` like https://github.com/apache/iceberg/blob/master/api/src/main/java/org/apache/iceberg/io/FileIO.java#L64-L69 ########## File path: core/src/test/java/org/apache/iceberg/encryption/DemoKmsClient.java ########## @@ -0,0 +1,146 @@ +/* + * 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. + */ + +package org.apache.iceberg.encryption; + +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.security.KeyStore; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.UnrecoverableKeyException; +import java.security.cert.CertificateException; +import java.util.Base64; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import javax.crypto.SecretKey; + +public class DemoKmsClient implements KmsClient { + + public static final String KEY_FILE_PATH_PROP = "demo.kms.client.keyfile.path"; Review comment: are these table properties / catalog properties? There are corresponding classes for them at `TableProperties` and `CatalogProperties`. -- 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]
