Key Management Service:Client JDBC pour les secrets

Le client JDBC pour les secrets offre les fonctionnalités suivantes :

• Prise en charge de Java Database Connectivity (JDBC), y compris les connexions utilisant des pools de connexions à la base de données (tels que c3p0 et DBCP) et des sources de données.

• Prise en charge de quatre types de bases de données : MySQL, SQL Server, PostgreSQL et MariaDB.

• Prise en charge d'intervalles d'actualisation personnalisés pour les secrets.

Remarques sur l'utilisation

• Types de secrets pris en charge : secrets génériques et secrets RDS.

  • Si vous utilisez un secret RDS, nous vous recommandons d'utiliser un secret RDS géré avec double compte.

  • Si vous utilisez un secret générique, la valeur du secret doit respecter le format JSON suivant.

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

• Langage de programmation pris en charge : Java 8 ou version ultérieure.

• Pools de connexions à la base de données pris en charge : c3p0, DBCP, HikariCP et Druid.

Scénario 1 : Récupérer des secrets via une passerelle partagée

Les types de réseau pris en charge sont le réseau public et le VPC. Cette méthode prend en charge les méthodes d'authentification basées sur RAM, telles que le rôle RAM d'instance ECS, RamRoleArn, un jeton STS et une AccessKey. Pour plus d'informations, consultez la section Gérer les identifiants d'accès.

Scénario 2 : Récupérer des secrets via une passerelle dédiée (non recommandé)

Le type de réseau est un réseau privé KMS et ClientKey est le seul identifiant d'accès pris en charge.

<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>

Se connecter à une base de données avec JDBC

• Base de données MySQL

  Remarque

  Remplacez #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données SQL Server

  Remarque

  Remplacez #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données PostgreSQL

  Remarque

  Remplacez #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données MariaDB

  Remarque

  Remplacez #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

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

Se connecter avec un pool de connexions à la base de données

Définissez les paramètres c3p0.user, c3p0.driverClass et c3p0.jdbcUrl dans le fichier de configuration c3p0.properties. Le paramètre c3p0.user correspond au nom du secret, c3p0.driverClass au nom de la classe du pilote JDBC Alibaba Cloud pour les secrets, et c3p0.jdbcUrl doit commencer par secrets-manager.

• Base de données MySQL

  Remarque

  Remplacez #your-mysql-secret-name#, <YOUR-MYSQL-IP>, <YOUR-MYSQL-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données SQL Server

  Remarque

  Remplacez #your-sqlserver-secret-name#, <YOUR-SQLSERVER-IP>, <YOUR-SQLSERVER-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données PostgreSQL

  Remarque

  Remplacez #your-postgresql-secret-name#, <YOUR-POSTGRESQL-IP>, <YOUR-POSTGRESQL-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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 données MariaDB

  Remarque

  Remplacez #your-mariadb-secret-name#, <YOUR-MARIADB-IP>, <YOUR-MARIADB-PORT> et <YOUR-DATABASE-NAME> par le nom réel du secret, l'adresse IP du serveur, le port et le nom de la base de données.

  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>

Se connecter avec une source de données

Cet exemple utilise une ComboPooledDataSource c3p0 et une base de données MySQL. Ajoutez la configuration suivante au fichier de configuration 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>

Se connecter avec un pool de connexions Druid

Cet exemple utilise une base de données MySQL. Vous devez modifier les propriétés suivantes dans le fichier de configuration.

• Utiliser un fichier de configuration 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>

• Utiliser la configuration bean

  • Méthode 1 : Fichier de configuration 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éthode 2 : Injection de propriété

    Créez une classe de configuration dans votre application pour charger les informations de connexion à la base de données.

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