|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, software |
| 13 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | + * See the License for the specific language governing permissions and |
| 16 | + * limitations under the License. |
| 17 | + */ |
| 18 | +package org.apache.beam.sdk.util; |
| 19 | + |
| 20 | +import com.google.api.gax.rpc.AlreadyExistsException; |
| 21 | +import com.google.api.gax.rpc.NotFoundException; |
| 22 | +import com.google.cloud.kms.v1.CryptoKeyName; |
| 23 | +import com.google.cloud.kms.v1.EncryptResponse; |
| 24 | +import com.google.cloud.kms.v1.KeyManagementServiceClient; |
| 25 | +import com.google.cloud.secretmanager.v1.AccessSecretVersionResponse; |
| 26 | +import com.google.cloud.secretmanager.v1.ProjectName; |
| 27 | +import com.google.cloud.secretmanager.v1.Replication; |
| 28 | +import com.google.cloud.secretmanager.v1.SecretManagerServiceClient; |
| 29 | +import com.google.cloud.secretmanager.v1.SecretName; |
| 30 | +import com.google.cloud.secretmanager.v1.SecretPayload; |
| 31 | +import com.google.cloud.secretmanager.v1.SecretVersionName; |
| 32 | +import com.google.crypto.tink.subtle.Hkdf; |
| 33 | +import com.google.protobuf.ByteString; |
| 34 | +import java.io.IOException; |
| 35 | +import java.security.GeneralSecurityException; |
| 36 | +import java.security.SecureRandom; |
| 37 | +import java.util.Base64; |
| 38 | +import org.slf4j.Logger; |
| 39 | +import org.slf4j.LoggerFactory; |
| 40 | + |
| 41 | +/** |
| 42 | + * A {@link org.apache.beam.sdk.util.Secret} manager implementation that generates a secret using |
| 43 | + * entropy from a GCP HSM key and stores it in Google Cloud Secret Manager. If the secret already |
| 44 | + * exists, it will be retrieved. |
| 45 | + */ |
| 46 | +public class GcpHsmGeneratedSecret implements Secret { |
| 47 | + private static final Logger LOG = LoggerFactory.getLogger(GcpHsmGeneratedSecret.class); |
| 48 | + private final String projectId; |
| 49 | + private final String locationId; |
| 50 | + private final String keyRingId; |
| 51 | + private final String keyId; |
| 52 | + private final String secretId; |
| 53 | + |
| 54 | + private final SecureRandom random = new SecureRandom(); |
| 55 | + |
| 56 | + public GcpHsmGeneratedSecret( |
| 57 | + String projectId, String locationId, String keyRingId, String keyId, String jobName) { |
| 58 | + this.projectId = projectId; |
| 59 | + this.locationId = locationId; |
| 60 | + this.keyRingId = keyRingId; |
| 61 | + this.keyId = keyId; |
| 62 | + this.secretId = "HsmGeneratedSecret_" + jobName; |
| 63 | + } |
| 64 | + |
| 65 | + /** |
| 66 | + * Returns the secret as a byte array. Assumes that the current active service account has |
| 67 | + * permissions to read the secret. |
| 68 | + * |
| 69 | + * @return The secret as a byte array. |
| 70 | + */ |
| 71 | + @Override |
| 72 | + public byte[] getSecretBytes() { |
| 73 | + try (SecretManagerServiceClient client = SecretManagerServiceClient.create()) { |
| 74 | + SecretVersionName secretVersionName = SecretVersionName.of(projectId, secretId, "1"); |
| 75 | + |
| 76 | + try { |
| 77 | + AccessSecretVersionResponse response = client.accessSecretVersion(secretVersionName); |
| 78 | + return response.getPayload().getData().toByteArray(); |
| 79 | + } catch (NotFoundException e) { |
| 80 | + LOG.info( |
| 81 | + "Secret version {} not found. Creating new secret and version.", |
| 82 | + secretVersionName.toString()); |
| 83 | + } |
| 84 | + |
| 85 | + ProjectName projectName = ProjectName.of(projectId); |
| 86 | + SecretName secretName = SecretName.of(projectId, secretId); |
| 87 | + try { |
| 88 | + com.google.cloud.secretmanager.v1.Secret secret = |
| 89 | + com.google.cloud.secretmanager.v1.Secret.newBuilder() |
| 90 | + .setReplication( |
| 91 | + Replication.newBuilder() |
| 92 | + .setAutomatic(Replication.Automatic.newBuilder().build())) |
| 93 | + .build(); |
| 94 | + client.createSecret(projectName, secretId, secret); |
| 95 | + } catch (AlreadyExistsException e) { |
| 96 | + LOG.info("Secret {} already exists. Adding new version.", secretName.toString()); |
| 97 | + } |
| 98 | + |
| 99 | + byte[] newKey = generateDek(); |
| 100 | + |
| 101 | + try { |
| 102 | + // Always retrieve remote secret as source-of-truth in case another thread created it |
| 103 | + AccessSecretVersionResponse response = client.accessSecretVersion(secretVersionName); |
| 104 | + return response.getPayload().getData().toByteArray(); |
| 105 | + } catch (NotFoundException e) { |
| 106 | + LOG.info( |
| 107 | + "Secret version {} not found after re-check. Creating new secret and version.", |
| 108 | + secretVersionName.toString()); |
| 109 | + } |
| 110 | + |
| 111 | + SecretPayload payload = |
| 112 | + SecretPayload.newBuilder().setData(ByteString.copyFrom(newKey)).build(); |
| 113 | + client.addSecretVersion(secretName, payload); |
| 114 | + AccessSecretVersionResponse response = client.accessSecretVersion(secretVersionName); |
| 115 | + return response.getPayload().getData().toByteArray(); |
| 116 | + |
| 117 | + } catch (IOException | GeneralSecurityException e) { |
| 118 | + throw new RuntimeException("Failed to retrieve or create secret bytes", e); |
| 119 | + } |
| 120 | + } |
| 121 | + |
| 122 | + private byte[] generateDek() throws IOException, GeneralSecurityException { |
| 123 | + int dekSize = 32; |
| 124 | + try (KeyManagementServiceClient client = KeyManagementServiceClient.create()) { |
| 125 | + // 1. Generate nonce_one. This doesn't need to have baked in randomness since the |
| 126 | + // actual randomness comes from KMS. |
| 127 | + byte[] nonceOne = new byte[dekSize]; |
| 128 | + random.nextBytes(nonceOne); |
| 129 | + |
| 130 | + // 2. Encrypt to get nonce_two |
| 131 | + CryptoKeyName keyName = CryptoKeyName.of(projectId, locationId, keyRingId, keyId); |
| 132 | + EncryptResponse response = client.encrypt(keyName, ByteString.copyFrom(nonceOne)); |
| 133 | + byte[] nonceTwo = response.getCiphertext().toByteArray(); |
| 134 | + |
| 135 | + // 3. Generate DK |
| 136 | + byte[] dk = new byte[dekSize]; |
| 137 | + random.nextBytes(dk); |
| 138 | + |
| 139 | + // 4. Derive DEK using HKDF |
| 140 | + byte[] dek = Hkdf.computeHkdf("HmacSha256", dk, nonceTwo, new byte[0], dekSize); |
| 141 | + |
| 142 | + // 5. Base64 encode |
| 143 | + return Base64.getUrlEncoder().encode(dek); |
| 144 | + } |
| 145 | + } |
| 146 | + |
| 147 | + /** |
| 148 | + * Returns the project ID of the secret. |
| 149 | + * |
| 150 | + * @return The project ID as a String. |
| 151 | + */ |
| 152 | + public String getProjectId() { |
| 153 | + return projectId; |
| 154 | + } |
| 155 | + |
| 156 | + /** |
| 157 | + * Returns the location ID of the secret. |
| 158 | + * |
| 159 | + * @return The location ID as a String. |
| 160 | + */ |
| 161 | + public String getLocationId() { |
| 162 | + return locationId; |
| 163 | + } |
| 164 | + |
| 165 | + /** |
| 166 | + * Returns the key ring ID of the secret. |
| 167 | + * |
| 168 | + * @return The key ring ID as a String. |
| 169 | + */ |
| 170 | + public String getKeyRingId() { |
| 171 | + return keyRingId; |
| 172 | + } |
| 173 | + |
| 174 | + /** |
| 175 | + * Returns the key ID of the secret. |
| 176 | + * |
| 177 | + * @return The key ID as a String. |
| 178 | + */ |
| 179 | + public String getKeyId() { |
| 180 | + return keyId; |
| 181 | + } |
| 182 | + |
| 183 | + /** |
| 184 | + * Returns the secret ID of the secret. |
| 185 | + * |
| 186 | + * @return The secret ID as a String. |
| 187 | + */ |
| 188 | + public String getSecretId() { |
| 189 | + return secretId; |
| 190 | + } |
| 191 | +} |
0 commit comments