Add resource providers

Author: MouhsinElmajdouby

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/resource/AwsParameterStoreResourceParameterNames.java

@@ -1,41 +1,30 @@
-/*
- ** Copyright (c) 2023 Oracle and/or its affiliates.
- **
- ** The Universal Permissive License (UPL), Version 1.0
- **
- ** Subject to the condition set forth below, permission is hereby granted to any
- ** person obtaining a copy of this software, associated documentation and/or data
- ** (collectively the "Software"), free of charge and under any and all copyright
- ** rights in the Software, and any and all patent rights owned or freely
- ** licensable by each licensor hereunder covering either (i) the unmodified
- ** Software as contributed to or provided by such licensor, or (ii) the Larger
- ** Works (as defined below), to deal in both
- **
- ** (a) the Software, and
- ** (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
- ** one is included with the Software (each a "Larger Work" to which the Software
- ** is contributed by such licensors),
- **
- ** without restriction, including without limitation the rights to copy, create
- ** derivative works of, display, perform, and distribute the Software and make,
- ** use, sell, offer for sale, import, export, have made, and have sold the
- ** Software and the Larger Work(s), and to sublicense the foregoing rights on
- ** either these or other terms.
- **
- ** This license is subject to the following condition:
- ** The above copyright notice and either this complete permission notice or at
- ** a minimum a reference to the UPL must be included in all copies or
- ** substantial portions of the Software.
- **
- ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- ** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- ** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- ** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- ** SOFTWARE.
- */
 package oracle.jdbc.provider.aws.resource;
 
-public class AwsParameterStoreResourceParameterNames {
+/**
+ * Centralized parameter name constants used by AWS Parameter Store resource providers.
+ */
+public final class AwsParameterStoreResourceParameterNames {
+
+  private AwsParameterStoreResourceParameterNames() {}
+
+  /** The AWS region where the parameter is stored (e.g., eu-north-1). */
+  public static final String AWS_REGION = "awsRegion";
+
+  /** The name of the parameter stored in AWS Parameter Store. */
+  public static final String PARAMETER_NAME = "parameterName";
+
+  /** Optional field name to extract from a JSON parameter value. */
+  public static final String FIELD_NAME = "fieldName";
+
+  /** The alias used to retrieve a connection string from tnsnames.ora. */
+  public static final String TNS_ALIAS = "tnsAlias";
+
+  /** Optional password used to decrypt the wallet (for PKCS12 or encrypted PEM). */
+  public static final String WALLET_PASSWORD = "walletPassword";
+
+  /** The wallet format: SSO, PKCS12, or PEM. */
+  public static final String TYPE = "type";
+
+  /** Index of the credential set in the wallet */
+  public static final String CONNECTION_STRING_INDEX = "connectionStringIndex";
 }

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/resource/AwsResourceProvider.java

@@ -1,41 +1,58 @@
-/*
- ** Copyright (c) 2023 Oracle and/or its affiliates.
- **
- ** The Universal Permissive License (UPL), Version 1.0
- **
- ** Subject to the condition set forth below, permission is hereby granted to any
- ** person obtaining a copy of this software, associated documentation and/or data
- ** (collectively the "Software"), free of charge and under any and all copyright
- ** rights in the Software, and any and all patent rights owned or freely
- ** licensable by each licensor hereunder covering either (i) the unmodified
- ** Software as contributed to or provided by such licensor, or (ii) the Larger
- ** Works (as defined below), to deal in both
- **
- ** (a) the Software, and
- ** (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
- ** one is included with the Software (each a "Larger Work" to which the Software
- ** is contributed by such licensors),
- **
- ** without restriction, including without limitation the rights to copy, create
- ** derivative works of, display, perform, and distribute the Software and make,
- ** use, sell, offer for sale, import, export, have made, and have sold the
- ** Software and the Larger Work(s), and to sublicense the foregoing rights on
- ** either these or other terms.
- **
- ** This license is subject to the following condition:
- ** The above copyright notice and either this complete permission notice or at
- ** a minimum a reference to the UPL must be included in all copies or
- ** substantial portions of the Software.
- **
- ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- ** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- ** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- ** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- ** SOFTWARE.
- */
 package oracle.jdbc.provider.aws.resource;
 
-public class AwsResourceProvider {
-}
+import oracle.jdbc.provider.aws.authentication.AwsAuthenticationMethod;
+import oracle.jdbc.provider.aws.authentication.AwsCredentialsFactory;
+import oracle.jdbc.provider.resource.AbstractResourceProvider;
+import oracle.jdbc.provider.resource.ResourceParameter;
+
+import java.util.stream.Stream;
+
+import static oracle.jdbc.provider.aws.authentication.AwsAuthenticationMethod.DEFAULT;
+import static oracle.jdbc.provider.aws.authentication.AwsCredentialsFactory.AUTHENTICATION_METHOD;
+import static oracle.jdbc.provider.aws.configuration.AwsConfigurationParameters.REGION;
+import static oracle.jdbc.provider.aws.resource.AwsParameterStoreResourceParameterNames.AWS_REGION;
+
+/**
+ * Super class of all {@code OracleResourceProvider} implementations
+ * that request a resource from AWS. This super class defines parameters for
+ * authentication with AWS.
+ */
+public abstract class AwsResourceProvider extends AbstractResourceProvider {
+
+  private static final ResourceParameter[] PARAMETERS = {
+          new ResourceParameter("authenticationMethod", AUTHENTICATION_METHOD,
+                  "aws-default",
+                  AwsResourceProvider::parseAuthenticationMethod),
+          new ResourceParameter(AWS_REGION, REGION)
+  };
+
+  /**
+   * Constructs a provider identified by the name:
+   * <pre>{@code
+   *   ojdbc-provider-aws-{resourceType}
+   * }</pre>
+   * @param resourceType The resource type identifier used in the provider name.
+   * @param parameters Additional parameters specific to the subclass provider.
+   */
+  protected AwsResourceProvider(String resourceType, ResourceParameter... parameters) {
+    super("aws", resourceType,
+            Stream.concat(Stream.of(PARAMETERS), Stream.of(parameters))
+                    .toArray(ResourceParameter[]::new));
+  }
+
+  /**
+   * Parses the "authenticationMethod" parameter as an
+   * {@link AwsAuthenticationMethod} recognized by {@link AwsCredentialsFactory}.
+   *
+   * @param authenticationMethod The value to parse.
+   * @return An {@link AwsAuthenticationMethod} enum.
+   * @throws IllegalArgumentException if the value is unrecognized.
+   */
+  private static AwsAuthenticationMethod parseAuthenticationMethod(String authenticationMethod) {
+    switch (authenticationMethod) {
+      case "aws-default": return DEFAULT;
+      default:
+        throw new IllegalArgumentException("Unrecognized authentication method: " + authenticationMethod);
+    }
+  }
+}

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/resource/ParameterStoreConnectionStringProvider.java

@@ -1,41 +1,46 @@
-/*
- ** Copyright (c) 2023 Oracle and/or its affiliates.
- **
- ** The Universal Permissive License (UPL), Version 1.0
- **
- ** Subject to the condition set forth below, permission is hereby granted to any
- ** person obtaining a copy of this software, associated documentation and/or data
- ** (collectively the "Software"), free of charge and under any and all copyright
- ** rights in the Software, and any and all patent rights owned or freely
- ** licensable by each licensor hereunder covering either (i) the unmodified
- ** Software as contributed to or provided by such licensor, or (ii) the Larger
- ** Works (as defined below), to deal in both
- **
- ** (a) the Software, and
- ** (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
- ** one is included with the Software (each a "Larger Work" to which the Software
- ** is contributed by such licensors),
- **
- ** without restriction, including without limitation the rights to copy, create
- ** derivative works of, display, perform, and distribute the Software and make,
- ** use, sell, offer for sale, import, export, have made, and have sold the
- ** Software and the Larger Work(s), and to sublicense the foregoing rights on
- ** either these or other terms.
- **
- ** This license is subject to the following condition:
- ** The above copyright notice and either this complete permission notice or at
- ** a minimum a reference to the UPL must be included in all copies or
- ** substantial portions of the Software.
- **
- ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- ** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- ** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- ** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- ** SOFTWARE.
- */
 package oracle.jdbc.provider.aws.resource;
 
-public class ParameterStoreConnectionStringProvider {
+import oracle.jdbc.spi.ConnectionStringProvider;
+import oracle.jdbc.provider.resource.ResourceParameter;
+import oracle.jdbc.provider.util.TNSNames;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Map;
+
+import static oracle.jdbc.provider.util.CommonParameters.TNS_ALIAS;
+import static oracle.jdbc.provider.util.FileUtils.decodeIfBase64;
+
+/**
+ * Provider that retrieves tnsnames.ora from AWS Parameter Store and extracts a connection string.
+ */
+public class ParameterStoreConnectionStringProvider
+        extends ParameterStoreSecretProvider
+        implements ConnectionStringProvider {
+
+  private static final ResourceParameter[] PARAMETERS = {
+          new ResourceParameter(AwsParameterStoreResourceParameterNames.TNS_ALIAS, TNS_ALIAS)
+  };
+
+  public ParameterStoreConnectionStringProvider() {
+    super("parameterstore-tnsnames", PARAMETERS);
+  }
+
+  @Override
+  public String getConnectionString(Map<Parameter, CharSequence> parameterValues) {
+    String alias = parseParameterValues(parameterValues).getRequired(TNS_ALIAS);
+    byte[] fileBytes = decodeIfBase64(getSecret(parameterValues).getBytes());
+
+    try (InputStream inputStream = new ByteArrayInputStream(fileBytes)) {
+      TNSNames tnsNames = TNSNames.read(inputStream);
+      String connectionString = tnsNames.getConnectionStringByAlias(alias);
+      if (connectionString == null) {
+        throw new IllegalArgumentException("Alias specified does not exist in tnsnames.ora: " + alias);
+      }
+      return connectionString;
+    } catch (IOException e) {
+      throw new IllegalStateException("Failed to read tnsnames.ora content", e);
+    }
+  }
 }

ojdbc-provider-aws/src/main/java/oracle/jdbc/provider/aws/resource/ParameterStorePasswordProvider.java

@@ -1,41 +1,40 @@
-/*
- ** Copyright (c) 2023 Oracle and/or its affiliates.
- **
- ** The Universal Permissive License (UPL), Version 1.0
- **
- ** Subject to the condition set forth below, permission is hereby granted to any
- ** person obtaining a copy of this software, associated documentation and/or data
- ** (collectively the "Software"), free of charge and under any and all copyright
- ** rights in the Software, and any and all patent rights owned or freely
- ** licensable by each licensor hereunder covering either (i) the unmodified
- ** Software as contributed to or provided by such licensor, or (ii) the Larger
- ** Works (as defined below), to deal in both
- **
- ** (a) the Software, and
- ** (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
- ** one is included with the Software (each a "Larger Work" to which the Software
- ** is contributed by such licensors),
- **
- ** without restriction, including without limitation the rights to copy, create
- ** derivative works of, display, perform, and distribute the Software and make,
- ** use, sell, offer for sale, import, export, have made, and have sold the
- ** Software and the Larger Work(s), and to sublicense the foregoing rights on
- ** either these or other terms.
- **
- ** This license is subject to the following condition:
- ** The above copyright notice and either this complete permission notice or at
- ** a minimum a reference to the UPL must be included in all copies or
- ** substantial portions of the Software.
- **
- ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- ** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- ** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- ** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- ** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- ** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- ** SOFTWARE.
- */
 package oracle.jdbc.provider.aws.resource;
 
-public class ParameterStorePasswordProvider {
+import oracle.jdbc.spi.PasswordProvider;
+
+import java.util.Map;
+
+/**
+ * <p>
+ * A provider of password managed as parameters in AWS Systems Manager Parameter Store.
+ * This class inherits parameters and behavior from {@link ParameterStoreSecretProvider}
+ * and {@link AwsResourceProvider}.
+ * </p><p>
+ * This class implements the {@link PasswordProvider} SPI defined by Oracle JDBC.
+ * It is designed to be located and instantiated by {@link java.util.ServiceLoader}.
+ * </p>
+ */
+public class ParameterStorePasswordProvider
+        extends ParameterStoreSecretProvider
+        implements PasswordProvider {
+
+  /**
+   * A public no-arg constructor used by {@link java.util.ServiceLoader}
+   * to construct an instance of this provider.
+   */
+  public ParameterStorePasswordProvider() {
+    super("parameterstore-password");
+  }
+
+  /**
+   * Retrieves a password stored in AWS Parameter Store.
+   *
+   * @param parameterValues A map of parameter names and values required for
+   * retrieving the parameter. Must not be null.
+   * @return The secret value as a char array. Not null.
+   */
+  @Override
+  public char[] getPassword(Map<Parameter, CharSequence> parameterValues) {
+    return getSecret(parameterValues).toCharArray();
+  }
 }