flyrain commented on a change in pull request #3471: URL: https://github.com/apache/iceberg/pull/3471#discussion_r806205807
########## File path: core/src/main/java/org/apache/iceberg/encryption/EnvelopeEncryptionManager.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.nio.ByteBuffer; +import java.security.SecureRandom; +import java.util.Map; +import org.apache.iceberg.common.DynConstructors; +import org.apache.iceberg.io.InputFile; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; + +/** + * Encryption manager that performs envelope encryption. + * <p> + */ +public class EnvelopeEncryptionManager implements EncryptionManager { + private final EnvelopeConfig dataEncryptionConfig; + private final boolean pushdown; + private final KmsClient kmsClient; + private final int dataKeyLength; + + private transient volatile SecureRandom workerRNG = null; + + public EnvelopeEncryptionManager( + boolean pushdown, EnvelopeConfig dataEncryptionConfig, + KmsClient kmsClient, int dataKeyLength) { + if (!pushdown) { + throw new UnsupportedOperationException("EnvelopeEncryptionManager currently supports only pushdown " + + "data encryption / decryption"); + } + this.dataEncryptionConfig = Preconditions.checkNotNull(dataEncryptionConfig, + "Cannot create EnvelopeEncryptionManager because data encryption config is not passed"); + Preconditions.checkNotNull(dataEncryptionConfig.kekId(), + "Cannot create EnvelopeEncryptionManager because table key encryption key ID is not specified"); + this.kmsClient = Preconditions.checkNotNull(kmsClient, + "Cannot create EnvelopeEncryptionManager because KmsClient is null"); + this.pushdown = pushdown; + this.dataKeyLength = dataKeyLength; + } + + @Override + public EncryptedOutputFile encrypt(OutputFile rawOutput) { + EnvelopeMetadata metadata = generateEnvelopeMetadata(dataEncryptionConfig); + + // Pushdown to data formats with native encryption support (such as Parquet) + NativeFileCryptoParameters nativeEncryptParams = NativeFileCryptoParameters.create(metadata.dek()) + .encryptionAlgorithm(metadata.algorithm().toString()) + .build(); + + try { + ((NativelyEncryptedFile) rawOutput).setNativeCryptoParameters(nativeEncryptParams); + } catch (ClassCastException e) { + throw new RuntimeException("Can't natively encrypt " + rawOutput.location() + " because the class " + + rawOutput.getClass() + " doesn't implement NativelyEncryptedFile interface", e); + } + + return new BaseEncryptedOutputFile(rawOutput, metadata); + } + + @Override + public InputFile decrypt(EncryptedInputFile encrypted) { + EnvelopeMetadata metadata = EnvelopeMetadataParser.fromJson(encrypted.keyMetadata().buffer()); + ByteBuffer fileDek = kmsClient.unwrapKey(metadata.wrappedDek(), metadata.kekId()); + + // Pushdown to data formats with native decryption support (such as Parquet) + NativeFileCryptoParameters nativeDecryptParams = NativeFileCryptoParameters.create(fileDek).build(); + InputFile rawInput = encrypted.encryptedInputFile(); + + try { + ((NativelyEncryptedFile) rawInput).setNativeCryptoParameters(nativeDecryptParams); + } catch (ClassCastException e) { + throw new RuntimeException("Can't natively decrypt " + rawInput.location() + " because the class " + + rawInput.getClass() + " doesn't implement NativelyEncryptedFile interface", e); + } + + return rawInput; + } + + private EnvelopeMetadata generateEnvelopeMetadata(EnvelopeConfig config) { + if (null == workerRNG) { + workerRNG = new SecureRandom(); + } + + String tableKekID = config.kekId(); + byte[] fileDek; + String wrappedFileDEK; + + if (kmsClient.supportsKeyGeneration()) { + KmsClient.KeyGenerationResult generatedDek = kmsClient.generateKey(tableKekID); + fileDek = generatedDek.key().array(); + wrappedFileDEK = generatedDek.wrappedKey(); + } else { + fileDek = new byte[dataKeyLength]; + workerRNG.nextBytes(fileDek); + wrappedFileDEK = kmsClient.wrapKey(ByteBuffer.wrap(fileDek), tableKekID); + } + + EnvelopeMetadata fileEnvelopeMetadata = new EnvelopeMetadata(tableKekID, wrappedFileDEK, null, + config.algorithm()); + fileEnvelopeMetadata.setDek(ByteBuffer.wrap(fileDek)); + + return fileEnvelopeMetadata; + } + + public static KmsClient loadKmsClient(String classPath, Map<String, String> properties) { Review comment: Are we going to have a dedicated Kms utility class in the future? This method should fit better there. I'm OK with the current solution though, if EnvelopeEncryptionManager is the only place to use KMS client. -- 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]
