Abacn commented on code in PR #36891:
URL: https://github.com/apache/beam/pull/36891#discussion_r2578954386
##########
sdks/java/core/src/test/java/org/apache/beam/sdk/transforms/GroupByKeyIT.java:
##########
@@ -88,6 +96,35 @@ public static void setup() throws IOException {
.build());
}
gcpSecretVersionName = secretName.toString() + "/versions/latest";
+
+ try {
+ KeyManagementServiceClient kmsClient =
KeyManagementServiceClient.create();
+ String locationId = "global";
Review Comment:
should locationId also be a constant like PROJECT_ID and KEY_RING_ID?
##########
sdks/python/apache_beam/transforms/core_it_test.py:
##########
@@ -38,6 +38,11 @@
except ImportError:
secretmanager = None # type: ignore[assignment]
+try:
+ from google.cloud import kms
+except ImportError:
+ kms = None # type: ignore[assignment]
Review Comment:
For Python SDK we have this mechanism to handle optional dependency. Just
wondering if it is possible to make gcp secret dependencies optional for Java
core as well. Just a side note, not needed for this PR.
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcpHsmGeneratedSecret.java:
##########
@@ -0,0 +1,192 @@
+/*
+ * 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.beam.sdk.util;
+
+import com.google.api.gax.rpc.AlreadyExistsException;
+import com.google.api.gax.rpc.NotFoundException;
+import com.google.cloud.kms.v1.CryptoKeyName;
+import com.google.cloud.kms.v1.EncryptResponse;
+import com.google.cloud.kms.v1.KeyManagementServiceClient;
+import com.google.cloud.secretmanager.v1.AccessSecretVersionResponse;
+import com.google.cloud.secretmanager.v1.ProjectName;
+import com.google.cloud.secretmanager.v1.Replication;
+import com.google.cloud.secretmanager.v1.SecretManagerServiceClient;
+import com.google.cloud.secretmanager.v1.SecretName;
+import com.google.cloud.secretmanager.v1.SecretPayload;
+import com.google.cloud.secretmanager.v1.SecretVersionName;
+import com.google.crypto.tink.subtle.Hkdf;
+import com.google.protobuf.ByteString;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.IOException;
+import java.security.GeneralSecurityException;
+import java.security.SecureRandom;
+import java.util.Base64;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A {@link org.apache.beam.sdk.util.Secret} manager implementation that
generates a secret using
+ * entropy from a GCP HSM key and stores it in Google Cloud Secret Manager. If
the secret already
+ * exists, it will be retrieved.
+ */
+public class GcpHsmGeneratedSecret implements Secret {
+ private static final Logger LOG =
LoggerFactory.getLogger(GcpHsmGeneratedSecret.class);
+ private final String projectId;
+ private final String locationId;
+ private final String keyRingId;
+ private final String keyId;
+ private final String secretId;
+
+ public GcpHsmGeneratedSecret(
+ String projectId, String locationId, String keyRingId, String keyId,
String jobName) {
+ this.projectId = projectId;
+ this.locationId = locationId;
+ this.keyRingId = keyRingId;
+ this.keyId = keyId;
+ this.secretId = "HsmGeneratedSecret_" + jobName;
+ }
+
+ /**
+ * Returns the secret as a byte array. Assumes that the current active
service account has
+ * permissions to read the secret.
+ *
+ * @return The secret as a byte array.
+ */
+ @Override
+ public byte[] getSecretBytes() {
+ try (SecretManagerServiceClient client =
SecretManagerServiceClient.create()) {
+ SecretVersionName secretVersionName = SecretVersionName.of(projectId,
secretId, "1");
+
+ try {
+ AccessSecretVersionResponse response =
client.accessSecretVersion(secretVersionName);
+ return response.getPayload().getData().toByteArray();
+ } catch (NotFoundException e) {
+ LOG.info(
+ "Secret version {} not found. Creating new secret and version.",
+ secretVersionName.toString());
+ }
+
+ ProjectName projectName = ProjectName.of(projectId);
+ SecretName secretName = SecretName.of(projectId, secretId);
+ try {
+ com.google.cloud.secretmanager.v1.Secret secret =
+ com.google.cloud.secretmanager.v1.Secret.newBuilder()
+ .setReplication(
+ Replication.newBuilder()
+
.setAutomatic(Replication.Automatic.newBuilder().build()))
+ .build();
+ client.createSecret(projectName, secretId, secret);
+ } catch (AlreadyExistsException e) {
+ LOG.info("Secret {} already exists. Adding new version.",
secretName.toString());
+ }
+
+ byte[] newKey = generateDek();
+
+ try {
+ // Try to access again in case another thread created it.
Review Comment:
This comment puzzled me at first glance. I understand it means "always
retrieve remote secret as source-of-truth in case another thread created it"
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/util/Secret.java:
##########
@@ -76,10 +76,47 @@ static Secret parseSecretOption(String secretOption) {
"version_name must contain a valid value for versionName
parameter");
}
return new GcpSecret(versionName);
+ case "gcphsmgeneratedsecret":
+ Set<String> gcpHsmGeneratedSecretParams =
+ new HashSet<>(
+ Arrays.asList("project_id", "location_id", "key_ring_id",
"key_id", "job_name"));
+ for (String paramName : paramMap.keySet()) {
+ if (!gcpHsmGeneratedSecretParams.contains(paramName)) {
+ throw new RuntimeException(
+ String.format(
+ "Invalid secret parameter %s, GcpHsmGeneratedSecret only
supports the following parameters: %s",
+ paramName, gcpHsmGeneratedSecretParams));
+ }
+ }
+ String projectId = paramMap.get("project_id");
+ if (projectId == null) {
Review Comment:
can be simplified with `String projectId = Preconditions.checkNotNull(...,
message)`. Same below
##########
sdks/python/apache_beam/transforms/core_it_test.py:
##########
@@ -94,6 +135,22 @@ def test_gbk_with_gbek_it(self):
pipeline.run().wait_until_finish()
+ @pytest.mark.it_postcommit
+ @unittest.skipIf(secretmanager is None, 'GCP dependencies are not installed')
+ @unittest.skipIf(kms is None, 'GCP dependencies are not installed')
Review Comment:
Could you please triggering Python PostCommit via trigger file (if this is
the test suite that suppose to exercise it)?
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcpHsmGeneratedSecret.java:
##########
@@ -0,0 +1,192 @@
+/*
+ * 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.beam.sdk.util;
+
+import com.google.api.gax.rpc.AlreadyExistsException;
+import com.google.api.gax.rpc.NotFoundException;
+import com.google.cloud.kms.v1.CryptoKeyName;
+import com.google.cloud.kms.v1.EncryptResponse;
+import com.google.cloud.kms.v1.KeyManagementServiceClient;
+import com.google.cloud.secretmanager.v1.AccessSecretVersionResponse;
+import com.google.cloud.secretmanager.v1.ProjectName;
+import com.google.cloud.secretmanager.v1.Replication;
+import com.google.cloud.secretmanager.v1.SecretManagerServiceClient;
+import com.google.cloud.secretmanager.v1.SecretName;
+import com.google.cloud.secretmanager.v1.SecretPayload;
+import com.google.cloud.secretmanager.v1.SecretVersionName;
+import com.google.crypto.tink.subtle.Hkdf;
+import com.google.protobuf.ByteString;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.IOException;
+import java.security.GeneralSecurityException;
+import java.security.SecureRandom;
+import java.util.Base64;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A {@link org.apache.beam.sdk.util.Secret} manager implementation that
generates a secret using
+ * entropy from a GCP HSM key and stores it in Google Cloud Secret Manager. If
the secret already
+ * exists, it will be retrieved.
+ */
+public class GcpHsmGeneratedSecret implements Secret {
+ private static final Logger LOG =
LoggerFactory.getLogger(GcpHsmGeneratedSecret.class);
+ private final String projectId;
+ private final String locationId;
+ private final String keyRingId;
+ private final String keyId;
+ private final String secretId;
+
+ public GcpHsmGeneratedSecret(
+ String projectId, String locationId, String keyRingId, String keyId,
String jobName) {
+ this.projectId = projectId;
+ this.locationId = locationId;
+ this.keyRingId = keyRingId;
+ this.keyId = keyId;
+ this.secretId = "HsmGeneratedSecret_" + jobName;
+ }
+
+ /**
+ * Returns the secret as a byte array. Assumes that the current active
service account has
+ * permissions to read the secret.
+ *
+ * @return The secret as a byte array.
+ */
+ @Override
+ public byte[] getSecretBytes() {
+ try (SecretManagerServiceClient client =
SecretManagerServiceClient.create()) {
+ SecretVersionName secretVersionName = SecretVersionName.of(projectId,
secretId, "1");
+
+ try {
+ AccessSecretVersionResponse response =
client.accessSecretVersion(secretVersionName);
+ return response.getPayload().getData().toByteArray();
+ } catch (NotFoundException e) {
+ LOG.info(
+ "Secret version {} not found. Creating new secret and version.",
+ secretVersionName.toString());
+ }
+
+ ProjectName projectName = ProjectName.of(projectId);
+ SecretName secretName = SecretName.of(projectId, secretId);
+ try {
+ com.google.cloud.secretmanager.v1.Secret secret =
+ com.google.cloud.secretmanager.v1.Secret.newBuilder()
+ .setReplication(
+ Replication.newBuilder()
+
.setAutomatic(Replication.Automatic.newBuilder().build()))
+ .build();
+ client.createSecret(projectName, secretId, secret);
+ } catch (AlreadyExistsException e) {
+ LOG.info("Secret {} already exists. Adding new version.",
secretName.toString());
+ }
+
+ byte[] newKey = generateDek();
+
+ try {
+ // Try to access again in case another thread created it.
+ AccessSecretVersionResponse response =
client.accessSecretVersion(secretVersionName);
+ return response.getPayload().getData().toByteArray();
+ } catch (NotFoundException e) {
+ LOG.info(
+ "Secret version {} not found after re-check. Creating new secret
and version.",
+ secretVersionName.toString());
+ }
+
+ SecretPayload payload =
+
SecretPayload.newBuilder().setData(ByteString.copyFrom(newKey)).build();
+ client.addSecretVersion(secretName, payload);
+ AccessSecretVersionResponse response =
client.accessSecretVersion(secretVersionName);
+ return response.getPayload().getData().toByteArray();
+
+ } catch (IOException | GeneralSecurityException e) {
+ throw new RuntimeException("Failed to retrieve or create secret bytes",
e);
+ }
+ }
+
+ @SuppressFBWarnings("DMI_RANDOM_USED_ONLY_ONCE") // intended, used for
non-random nonceOne
Review Comment:
I think this is a valid finding. What the tool want to say is to move
SecureRandom random = new SecureRandom();
to a private static final member of this class.
--
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]
