Key Management Service:Cliente JDBC de secretos

El cliente JDBC de secretos ofrece las siguientes características:

• Admite Java Database Connectivity (JDBC), incluidas las conexiones que usan grupos de conexiones a bases de datos (como c3p0 y DBCP) y orígenes de datos.

• Es compatible con cuatro tipos de bases de datos: MySQL, SQL Server, PostgreSQL y MariaDB.

• Permite definir intervalos de actualización personalizados para los secretos.

Notas de uso

• Tipos de secretos compatibles: secretos genéricos y secretos de RDS.

  • Si usa un secreto de RDS, se recomienda emplear un secreto de RDS gestionado con cuenta dual.

  • Si usa un secreto genérico, el valor del secreto debe tener el siguiente formato JSON.

    {
        "AccountName":"<YOUR-DATABASE-USERNAME>",
        "AccountPassword":"<YOUR-DATABASE-PASSWORD>"
    }

• Lenguaje de programación compatible: Java 8 o posterior.

• Grupos de conexiones a bases de datos compatibles: c3p0, DBCP, HikariCP y Druid.

Escenario 1: Recuperación de secretos mediante una puerta de enlace compartida

Los tipos de red compatibles son la red pública y VPC. Este método admite mecanismos de autenticación basados en RAM, como un rol de RAM de instancia de ECS, RamRoleArn, un token de STS y un AccessKey. Para obtener más información, consulte Manage access credentials.

Escenario 2: Recuperación de secretos mediante una puerta de enlace dedicada (no recomendado)

El tipo de red es una red privada de KMS, y ClientKey es la única credencial de acceso compatible.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-secretsmanager-jdbc</artifactId>
    <version>x.x.x</version>
</dependency>
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.x.x</version>
</dependency>

Conexión a una base de datos mediante JDBC

• Base de datos MySQL

  Nota

  Reemplace #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCSample {
      public static void main(String[] args) throws Exception {
          // Load the Alibaba Cloud secrets JDBC driver: com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>", "#your-mysql-secret-name#","");
          } catch(SQLException e) {
              e.printStackTrace();
          }
      }
  }

• Base de datos SQL Server

  Nota

  Reemplace #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCSqlServerSample {
  
      public static void main(String[] args) throws Exception{
          // Load the Alibaba Cloud secrets JDBC driver: com.aliyun.kms.secretsmanager.MssqlSecretsManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.MssqlSecretsManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:sqlserver://<YOUR-SQLSERVER-IP>:<YOUR-SQLSERVER-PORT>;databaseName=<YOUR-DATABASE-NAME>", "#your-sqlserver-secret-name#", "");
          }  catch (SQLException e) {
              e.printStackTrace();
          }
      }
  }

• Base de datos PostgreSQL

  Nota

  Reemplace #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCPostgreSQLSample {
      public static void main(String[] args) throws Exception {
          // Load the Alibaba Cloud secrets JDBC driver: com.aliyun.kms.secretsmanager.PostgreSQLSecretManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.PostgreSQLSecretManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:postgresql://<YOUR-POSTGRESQL-IP>:<YOUR-POSTGRESQL-PORT>/<YOUR-DATABASE-NAME>", "#your-postgresql-secret-name#", "");
          } catch (SQLException e) {
              e.printStackTrace();
          }
      }
  }

• Base de datos MariaDB

  Nota

  Reemplace #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCMarialDBSample {
  
  	public static void main(String[] args) throws Exception{
  		// Load the Alibaba Cloud secrets JDBC driver: com.aliyun.kms.secretsmanager.MariaDBSecretManagerSimpleDriver
  		Class.forName("com.aliyun.kms.secretsmanager.MariaDBSecretManagerSimpleDriver");
  		Connection connect = null;
  		try {
  			connect = DriverManager.getConnection("secrets-manager:mariadb://<YOUR-MARIADB-IP>:<YOUR-MARIADB-PORT>/<YOUR-DATABASE-NAME>", "#your-mariadb-secret-name#", "");
  		}  catch (SQLException e) {
  			e.printStackTrace();
  		}
  	}
  }

Conexión mediante un pool de conexiones de base de datos

Establezca c3p0.user, c3p0.driverClass y c3p0.jdbcUrl en el archivo de configuración c3p0.properties. El parámetro c3p0.user corresponde al nombre del secreto, c3p0.driverClass es el nombre de la clase del controlador JDBC de secretos de Alibaba Cloud y c3p0.jdbcUrl debe comenzar con secrets-manager.

• Base de datos MySQL

  Nota

  Reemplace #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  c3p0.user=#your-mysql-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>

• Base de datos SQL Server

  Nota

  Reemplace #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  c3p0.user=#your-sqlserver-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MssqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:sqlserver://<YOUR-SQLSERVER-IP>:<YOUR-SQLSERVER-PORT>/<YOUR-DATABASE-NAME>

• Base de datos PostgreSQL

  Nota

  Reemplace #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  c3p0.user=#your-postgresql-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.PostgreSQLSecretManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:postgresql://<YOUR-POSTGRESQL-IP>:<YOUR-POSTGRESQL-PORT>/<YOUR-DATABASE-NAME>

• Base de datos MariaDB

  Nota

  Reemplace #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> y <YOUR-DATABASE-NAME> por el nombre real del secreto, la dirección IP del servidor, el puerto y el nombre de la base de datos.

  c3p0.user=#your-mariadb-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MariaDBSecretManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:mariadb://<YOUR-MARIADB-IP>:<YOUR-MARIADB-PORT>/<YOUR-DATABASE-NAME>

Conexión mediante un origen de datos

Este ejemplo utiliza un objeto c3p0 ComboPooledDataSource y una base de datos MySQL. Agregue a continuación la configuración en el archivo de configuración de Spring.

<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
      <property name="driverClass" value="com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver" />
      <property name="user" value="#your-mysql-secret-name#" />
      <property name="jdbcUrl" value="secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>" />
      <property name="maxPoolSize" value="***" />
      <property name="minPoolSize" value="***" />
      <property name="initialPoolSize" value="***" />
  </bean>
  <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate" >
      <property name="dataSource" ref="dataSource" />
  </bean>

Conexión mediante un pool de conexiones Druid

Este ejemplo utiliza una base de datos MySQL. Modifique las siguientes propiedades en el archivo de configuración.

• Uso de un archivo de configuración properties

  username=#your-mysql-secret-name#
  driverClassName=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  url=secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>

• Uso de la configuración de beans

  • Método 1: archivo de configuración XML

    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> 
         <property name="username" value="${your-mysql-secret-name}" />
         <property name="driverClassName" value="com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver" />
         <property name="url" value="secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>" />
    </bean>
    

  • Método 2: inyección de propiedades

    Cree una clase de configuración en su aplicación para cargar la información de conexión a la base de datos.

    @Configuration
    public class DataConfig {
    
        @Value("${your-mysql-secret-name}")
        private String username;
    
        @Value("com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver")
        private String driverClassName;
    
        @Value("secrets-manager:mysql://<YOUR-MYSQL-IP>:<YOUR-MYSQL-PORT>/<YOUR-DATABASE-NAME>")
        private String url;
    
        @Bean(name = "dataSource",initMethod = "init",destroyMethod = "close")
        public DruidDataSource dataSource(){
            DruidDataSource druidDataSource = new DruidDataSource();
            druidDataSource.setUsername(username);
            druidDataSource.setDriverClassName(driverClassName);
            druidDataSource.setUrl(url);
            return druidDataSource;
        }
    }