Key Management Service:Cliente JDBC de segredos

O cliente JDBC de segredos oferece os seguintes recursos:

• Suporta o Java Database Connectivity (JDBC), incluindo conexões com pools de conexão de banco de dados (como c3p0 e DBCP) e source de dados.

• Suporta quatro tipos de banco de dados: MySQL, SQL Server, PostgreSQL e MariaDB.

• Suporta intervalos de atualização personalizados para segredos.

Notas de uso

• Tipos de segredo compatíveis: segredos genéricos e segredos do RDS.

  • Ao usar um segredo do RDS, recomendamos um segredo do RDS gerenciado com conta dupla.

  • Ao usar um segredo genérico, o valor do segredo deve estar no seguinte formato JSON:

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

• Linguagem de programação compatível: Java 8 ou superior.

• Pools de conexão de banco de dados compatíveis: c3p0, DBCP, HikariCP e Druid.

Cenário 1: Recuperar segredos por meio de um gateway compartilhado

As redes compatíveis são a rede pública e a VPC. Este método é compatível com autenticações baseadas no RAM, como função RAM de instância ECS, RamRoleArn, token STS e AccessKey. Para mais informações, consulte Manage access credentials.

Cenário 2: Recuperar segredos por meio de um gateway dedicado (não recomendado)

O tipo de rede é uma rede privada do KMS, e o ClientKey é a única credencial de acesso compatível.

Conectar-se a um banco de dados usando JDBC

• Banco de dados MySQL

  Nota

  Substitua #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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();
          }
      }
  }

• Banco de dados SQL Server

  Nota

  Substitua #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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();
          }
      }
  }

• Banco de dados PostgreSQL

  Nota

  Substitua #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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();
          }
      }
  }

• Banco de dados MariaDB

  Nota

  Substitua #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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();
  		}
  	}
  }

Conectar-se usando um pool de conexão de banco de dados

Defina c3p0.user, c3p0.driverClass e c3p0.jdbcUrl no arquivo de configuração c3p0.properties. c3p0.user é o nome do segredo, c3p0.driverClass é o nome da classe do driver JDBC de segredos do Alibaba Cloud, e c3p0.jdbcUrl deve começar com secrets-manager.

• Banco de dados MySQL

  Nota

  Substitua #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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>

• Banco de dados SQL Server

  Nota

  Substitua #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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>

• Banco de dados PostgreSQL

  Nota

  Substitua #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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>

• Banco de dados MariaDB

  Nota

  Substitua #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> e <YOUR-DATABASE-NAME> pelo nome real do segredo, endereço IP do servidor, porta e nome do banco de dados, respectivamente.

  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>

Conectar-se usando uma fonte de dados

Este exemplo usa um c3p0 ComboPooledDataSource e um banco de dados MySQL. Adicione a seguinte configuração ao arquivo de configuração do 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>

Conectar-se usando um pool de conexões Druid

Este exemplo usa um banco de dados MySQL. Modifique as seguintes propriedades no arquivo de configuração.

• Use um arquivo de configuração 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>

• Use a configuração bean

  • Método 1: Arquivo de configuração 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: Injeção de propriedade

    Crie uma classe de configuração na sua aplicação para carregar as informações de conexão do banco de dados.

    @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;
        }
    }