Merge branch 'main' into aws-parameter-store-centralized-config-provider

Author: MouhsinElmajdouby

.github/workflows/run-tests.yaml

@@ -33,11 +33,16 @@ jobs:
 
       - name: Install dependencies
         run: mvn install -DskipTests
+      
+      - name: Set GCP environment variables
+        run : |
+          echo "GOOGLE_APPLICATION_CREDENTIALS=$HOME/.gcp/config.json" >> $GITHUB_ENV
 
       - name: Prepare certificate and properties files
         run: |
           mkdir -p $HOME/.azure
           mkdir -p $HOME/.oci
+          mkdir -p $HOME/.gcp
           
           # Prepare certificate
           echo "${{ secrets.TEST_AZURE_CERTIFICATE }}" > $HOME/.azure/ojdbc-plugin-test-app.pem
@@ -62,6 +67,8 @@ jobs:
           AZURE_TOKEN_SCOPE=${{ secrets.TEST_AZURE_TOKEN_SCOPE }}\n
           AZURE_APP_CONFIG_NAME=${{ secrets.TEST_AZURE_APP_CONFIG_NAME }}\n
           AZURE_APP_CONFIG_KEY=${{ secrets.TEST_AZURE_APP_CONFIG_KEY }}\n
+          AZURE_APP_CONFIG_KEY_INVALID_PROPERTIES=${{ vars.TEST_AZURE_APP_CONFIG_KEY_INVALID_PROPERTIES }}\n
+          AZURE_APP_CONFIG_KEY_NON_WHITELISTED_PROPERTIES=${{ vars.TEST_AZURE_APP_CONFIG_KEY_NON_WHITELISTED_PROPERTIES }}\n
           AZURE_APP_CONFIG_LABEL=${{ secrets.TEST_AZURE_APP_CONFIG_LABEL }}\n
           AZURE_KEY_VAULT_URL=${{ secrets.TEST_AZURE_KEY_VAULT_URL }}\n
           AZURE_KEY_VAULT_SECRET_NAME=${{ secrets.TEST_AZURE_KEY_VAULT_SECRET_NAME }}\n
@@ -131,6 +138,9 @@ jobs:
           AWS_SECRETS_MANAGER_URL=${{ secrets.TEST_AWS_SECRETS_MANAGER_URL }}\n
           " >> ojdbc-provider-aws/test.properties
           
+          # Generate GCP config
+          echo "${{ secrets.TEST_GCP_CONFIG }}" > $HOME/.gcp/config.json
+          echo "${{ secrets.GCP_TEST_PROPERTIES }}" > ojdbc-provider-gcp/test.properties
           
           # Generate ojdbc-provider-hashicorp/test.properties
           echo -e "VAULT_ADDR=${{ secrets.TEST_VAULT_ADDR }}\n
@@ -165,6 +175,9 @@ jobs:
           rm ojdbc-provider-azure/ojdbc-provider-test-app.pfx
           rm ojdbc-provider-azure/test.properties
           
+          rm $HOME/.gcp/config.json
+          rm ojdbc-provider-gcp/test.properties
+          
           rm ojdbc-provider-jackson-oson/test.properties
           
           rm ojdbc-provider-aws/test.properties

README.md

@@ -13,6 +13,8 @@ Each module of this project contains a set of providers.
 <dd>Providers for integration with Oracle Cloud Infrastructure (OCI).</dd>
 <dt><a href="ojdbc-provider-azure/README.md">Oracle JDBC Azure Providers</a></dt>
 <dd>Providers for integration with Microsoft Azure</dd>
+<dt><a href="ojdbc-provider-gcp/README.md">Oracle JDBC GCP Providers</a></dt>
+<dd>Providers for integration with Google Cloud Platform</dd>
 <dt><a href="ojdbc-provider-hashicorp/README.md">Oracle JDBC HashiCorp Providers</a></dt>
 <dd>Providers for integration with Hashicorp</dd>
 </dl>
@@ -130,6 +132,8 @@ this project:
 
 [ojdbc-provider-azure](ojdbc-provider-azure/README.md#installation)
 
+[ojdbc-provider-gcp](ojdbc-provider-gcp/README.md#installation)
+
 [ojdbc-provider-opentelemetry](ojdbc-provider-opentelemetry/README.md#installation)
 
 [ojdbc-provider-jackson-oson](ojdbc-provider-jackson-oson/README.md#installation)

ojdbc-provider-aws/README.md

@@ -33,7 +33,7 @@ JDK versions. The coordinates for the latest release are:
 <dependency>
   <groupId>com.oracle.database.jdbc</groupId>
   <artifactId>ojdbc-provider-aws</artifactId>
-  <version>1.0.4</version>
+  <version>1.0.5</version>
 </dependency>
 ```
 
@@ -76,7 +76,8 @@ And the JSON Payload for the file **payload_ojdbc_objectstorage.json** in **mybu
   "user": "scott",
   "password": { 
     "type": "awssecretsmanager",
-    "value": "test-secret"
+    "value": "test-secret",
+    "field_name": "<field-name>"  // Optional: Only needed when the secret is structured and contains multiple key-value pairs.
   },
   "jdbc": {
     "oracle.jdbc.ReadTimeout": 1000,
@@ -118,6 +119,12 @@ For the JSON type of provider (AWS S3, AWS Secrets Manager, AWS Parameter Store,
         - Base64 Encoded password (if base64)
         - AWS Secret name (if awssecretsmanager)
         - AWS Parameter name (if awsparameterstore)
+- field_name
+  - Optional
+  - Description: Specifies the key within the secret JSON object from which to extract the password value.
+    If the secret JSON contains multiple key-value pairs, field_name must be provided to unambiguously select the desired secret value.
+    If the secret contains only a single key-value pair and field_name is not provided, that sole value will be used.
+    If the secret is provided as plain text (i.e., not structured as a JSON object), no field_name is required.
 - authentication
     - Optional
     - Possible Values

ojdbc-provider-aws/pom.xml

@@ -10,7 +10,7 @@
   <parent>
     <groupId>com.oracle.database.jdbc</groupId>
     <artifactId>ojdbc-extensions</artifactId>
-    <version>1.0.4</version>
+    <version>1.0.5</version>
   </parent>
 
   <dependencyManagement>

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/configuration/AwsConfigurationParameters.java

@@ -59,6 +59,11 @@ private AwsConfigurationParameters() {}
    */
   public static final Parameter<String> KEY = Parameter.create();
 
+  /**
+   *  The field name for extracting a specific value from the JSON.
+   */
+  public static final Parameter<String> FIELD_NAME = Parameter.create();
+
   /**
    * Configures a {@code builder} to build a parser that recognizes the common
    * set of parameters accepted by {@link AwsS3ConfigurationProvider} and

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/configuration/AwsJsonSecretsManagerProvider.java

@@ -40,15 +40,23 @@
 import oracle.jdbc.provider.aws.secrets.SecretsManagerFactory;
 import oracle.jdbc.provider.parameter.ParameterSet;
 import oracle.jdbc.spi.OracleConfigurationSecretProvider;
+import oracle.sql.json.OracleJsonException;
+import oracle.sql.json.OracleJsonFactory;
 import oracle.sql.json.OracleJsonObject;
 
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 import java.util.Map;
 
+import static oracle.jdbc.provider.aws.configuration.AwsConfigurationParameters.FIELD_NAME;
 import static oracle.jdbc.provider.aws.configuration.AwsSecretsManagerConfigurationProvider.PARAMETER_SET_PARSER;
 
 public class AwsJsonSecretsManagerProvider
     implements OracleConfigurationSecretProvider {
+
+  private static final OracleJsonFactory JSON_FACTORY = new OracleJsonFactory();
+
   /**
    * {@inheritDoc}
    * <p>
@@ -62,24 +70,59 @@ public class AwsJsonSecretsManagerProvider
    * <pre>{@code
    *   "password": {
    *       "type": "awssecretsmanager",
-   *       "value": "<secret-name>"
+   *       "value": "<secret-name>",
+   *       "field_name": "<field-name>"
    *   }
    * }</pre>
    *
+   * <p>
+   * The {@code field_name} parameter indicates the key whose value should
+   * be extracted as the secret. When there are multiple key-value pairs
+   * present, specifying this parameter is mandatory in order to
+   * unambiguously select the desired secret value. If the secret contains
+   * only a single entry and no {@code field_name} is provided, that sole
+   * value will be used. In cases where the secret is plain text,
+   * the {@code field_name} parameter is not required.
+   * </p>
+   *
    * @param map Map object to be parsed
    * @return encoded char array in base64 format that represents the retrieved
    *         Secret.
    */
   @Override
   public char[] getSecret(Map<String, String> map) {
     ParameterSet parameterSet = PARAMETER_SET_PARSER.parseNamedValues(map);
+    String fieldName = parameterSet.getOptional(FIELD_NAME);
 
     String secretString = SecretsManagerFactory.getInstance()
         .request(parameterSet)
         .getContent();
 
+    String extractedSecret;
+
+    try {
+      OracleJsonObject jsonObject = JSON_FACTORY.createJsonTextValue(
+           new ByteArrayInputStream(secretString.getBytes(StandardCharsets.UTF_8)))
+        .asJsonObject();
+
+      if (fieldName != null) {
+        if (!jsonObject.containsKey(fieldName)) {
+          throw new IllegalStateException("Field '" + fieldName + "' not found in secret JSON.");
+        }
+        extractedSecret = jsonObject.get(fieldName).asJsonString().getString();
+      } else if (jsonObject.size() == 1) {
+        extractedSecret = jsonObject.values().iterator().next().asJsonString().getString();
+      } else {
+        throw new IllegalStateException(
+          "FIELD_NAME is required when multiple keys exist in the secret JSON");
+      }
+
+    } catch (OracleJsonException e) {
+      extractedSecret = secretString;
+    }
+
     return Base64.getEncoder()
-        .encodeToString(secretString.getBytes())
+        .encodeToString(extractedSecret.getBytes(StandardCharsets.UTF_8))
         .toCharArray();
   }
 

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/configuration/AwsSecretsManagerConfigurationProvider.java

@@ -39,6 +39,7 @@
 
 import oracle.jdbc.driver.configuration.OracleConfigurationParsableProvider;
 import oracle.jdbc.provider.aws.secrets.SecretsManagerFactory;
+import oracle.jdbc.provider.parameter.Parameter;
 import oracle.jdbc.provider.parameter.ParameterSet;
 import oracle.jdbc.provider.parameter.ParameterSetParser;
 import oracle.jdbc.util.OracleConfigurationCache;
@@ -64,6 +65,8 @@ public class AwsSecretsManagerConfigurationProvider extends OracleConfigurationP
               ParameterSetParser.builder()
                   .addParameter("value", SecretsManagerFactory.SECRET_NAME)
                   .addParameter("key", AwsConfigurationParameters.KEY)
+                  .addParameter("type", Parameter.create())
+                  .addParameter("field_name", AwsConfigurationParameters.FIELD_NAME)
                   .addParameter("AWS_REGION", AwsConfigurationParameters.REGION))
           .build();
 

ojdbc-provider-azure/README.md

@@ -44,7 +44,7 @@ JDK versions. The coordinates for the latest release are:
 <dependency>
   <groupId>com.oracle.database.jdbc</groupId>
   <artifactId>ojdbc-provider-azure</artifactId>
-  <version>1.0.4</version>
+  <version>1.0.5</version>
 </dependency>
 ```
 

ojdbc-provider-azure/example-test.properties

@@ -117,6 +117,12 @@ AZURE_APP_CONFIG_NAME=app-config-name
 # The prefix of the Azure App Configuration key-names
 AZURE_APP_CONFIG_KEY=your-app-config-key/
 
+# The prefix of the Azure App Configuration key-names which contains invalid properties
+AZURE_APP_CONFIG_KEY_INVALID_PROPERTIES=your-app-config-key-with-invalid-properties/
+
+# The prefix of the Azure App Configuration key-names which contains non-whitelisted properties
+AZURE_APP_CONFIG_KEY_NON_WHITELISTED_PROPERTIES=your-app-config-key-with-non-whitelisted-properties/
+
 # The label of the Azure App Configuration
 AZURE_APP_CONFIG_LABEL=your-label
 

ojdbc-provider-azure/pom.xml

@@ -10,7 +10,7 @@
   <parent>
     <groupId>com.oracle.database.jdbc</groupId>
     <artifactId>ojdbc-extensions</artifactId>
-    <version>1.0.4</version>
+    <version>1.0.5</version>
   </parent>
 
   <dependencyManagement>