Key Management Service:インスタンス RAM ロールを使用した KMS へのアクセス

Alibaba Cloud SDK V2.0

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    public static com.aliyun.kms20160120.Client createClient() throws Exception {
        com.aliyun.credentials.models.Config credentialConfig = new com.aliyun.credentials.models.Config();
        // 認証情報タイプを設定します。
        credentialConfig.type = "ecs_ram_role";
        // オプション。API呼び出しを削減するために、インスタンス RAM ロール名を指定します。このパラメーターを省略すると、ロール名は自動的に取得されます。
        credentialConfig.roleName = "<your-ecsRamRoleName>";
        com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client(credentialConfig);

        com.aliyun.teaopenapi.models.Config kmsClientConfig = new com.aliyun.teaopenapi.models.Config()
        // KMSエンドポイントを設定します。例：kms.cn-hangzhou.aliyuncs.com
        .setEndpoint( "kms.cn-hangzhou.aliyuncs.com").
                setCredential(credentialClient);
        return new com.aliyun.kms20160120.Client(kmsClientConfig);

    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.kms20160120.Client client = Sample.createClient();
        com.aliyun.kms20160120.models.ListKeysRequest listKeysRequest = new com.aliyun.kms20160120.models.ListKeysRequest();
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            client.listKeysWithOptions(listKeysRequest, runtime);
        } catch (TeaException error) {
            System.out.println(error.getMessage());
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            _error.printStackTrace();
        }        
    }
}

タブボディ

Secrets Manager クライアント

詳細については、「Secrets Manager クライアント」をご参照ください。

1. secretsmanager.properties ファイル、またはシステム環境変数に、次のパラメーターを設定します。

   パラメーター	値
   credentials_type	ecs_ram_role に設定します。
   credentials_role_session_name	ロールセッションのカスタム名。監査に使用されます。
   cache_client_region_id	[{"regionId":"<your region id>"}] の形式で指定します。<your region id> は実際のリージョン ID に置き換えてください。

2. クライアントをビルドしてシークレット値を取得します。

   import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClient;
   import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClientBuilder;
   import com.aliyuncs.kms.secretsmanager.client.v2.exception.CacheSecretException;
   import com.aliyuncs.kms.secretsmanager.client.v2.model.SecretInfo;
   
   public class CacheClientEnvironmentSample {
   
       public static void main(String[] args) {
           try {
               SecretCacheClient client = SecretCacheClientBuilder.newClient();
               SecretInfo secretInfo = client.getSecretInfo("#secretName#");
               System.out.println(secretInfo);
           } catch (CacheSecretException e) {
               e.printStackTrace();
           }
       }
   }

Secrets Manager JDBC クライアント

このセクションでは、JDBC を介した MySQL データベース接続を例として使用します。詳細については、「Secrets Manager JDBC クライアント」をご参照ください。

1. プロジェクトのアプリケーションコードに、「secretsmanager.properties」という名前の設定ファイルを追加します。

   ## アクセス認証情報のタイプ
   credentials_type=ecs_ram_role
   ## ECS RAM ロールの名前
   credentials_role_name=#credentials_role_name#
   ## 関連するKMSインスタンスのリージョン
   cache_client_region_id=[{"regionId":"#regionId#"}]
   ## カスタム更新間隔。単位：ミリ秒。デフォルト：6時間。最小：5分。
   refresh_secret_ttl=21600000

2. JDBC を介して MySQL データベースに接続します。

   import java.sql.Connection;
   import java.sql.DriverManager;
   import java.sql.SQLException;
   
   public class SecretManagerJDBCSample {
       public static void main(String[] args) throws Exception {
           // Alibaba Cloud Secrets Manager JDBCドライバー 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();
           }
       }
   }

RAM シークレットプラグイン

詳細については、「RAM シークレットプラグイン」をご参照ください。

1. プロジェクトのランタイムコードに設定ファイル「managed_credentials_providers.properties」を追加します。

   credentials_type=ecs_ram_role
   ## ECS RAM ロールの名前
   credentials_role_name=#credentials_role_name#
   ## 関連するKMSインスタンスのリージョン
   cache_client_region_id=[{"regionId":"#regionId#"}]

2. Alibaba Cloud SDK for Java クライアントを取得し、クラウドサービスを呼び出します。

   次の例は、ECS の DescribeInstanceStatus API を呼び出す方法を示しています。

   説明

   サンプルコードを実行する前に、pom.xml ファイルに aliyun-java-sdk-ecs 依存関係を追加してください。

   import com.aliyuncs.IAcsClient;
   import com.aliyuncs.ecs.model.v20140526.DescribeInstanceStatusRequest;
   import com.aliyuncs.ecs.model.v20140526.DescribeInstanceStatusResponse;
   import com.aliyun.kms.secretsmanager.plugin.sdkcore.ProxyAcsClient;
   import com.aliyuncs.exceptions.ClientException;
   import com.aliyuncs.exceptions.ServerException;
   
   public class AliyunSdkProviderSample {
       public static void main(String[]args) {
           String secretName="******";
           /*
             アプリケーションがクラスパスまたは実行可能JARファイルからデフォルトの設定ファイル (managed_credentials_providers.properties) を読み取れない場合、またはカスタム設定ファイル名を使用する必要がある場合は、次のコードを呼び出してカスタム設定ファイルを指定できます。ファイルは次の順序で読み取られます。
             1. "your-config-name" が絶対パスの場合、そのパスからファイルが読み取られます。
             2. "your-config-name" がファイル名のみの場合、クラスパスから最初に読み取られ、次に実行可能JARファイルから読み取られます。
           */
           //ConfigLoader.setConfigName("your-config-name");
           
           // 1. aliyun-java-sdk-managed-credentials-providerを使用してIAcsClientを取得します。
           IAcsClient client = null;
           try {
               client = new ProxyAcsClient("<the regionId of ECS>", secretName);
           } catch (ClientException e) {
                e.printStackTrace();
            }
           // 2. ECS API を呼び出してビジネスロジックを実装します。
           DescribeInstanceStatusRequest request = new DescribeInstanceStatusRequest();
           DescribeInstanceStatusResponse response;
           try {
                response = client.getAcsResponse(request);
           } catch (ServerException e) {
                e.printStackTrace();
            } catch (ClientException e) {
                e.printStackTrace();
            }
           // 3. クライアントをシャットダウンして、プラグインが使用するリソースを解放します。
           client.shutdown();
       }
   }

Alibaba Cloud SDK V1.0 (非推奨)

package com.aliyuncs.kms.examples;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.auth.AlibabaCloudCredentialsProvider;
import com.aliyuncs.auth.InstanceProfileCredentialsProvider;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.kms.model.v20160120.*;
import com.aliyuncs.profile.DefaultProfile;

public class RamRoleTest {
    public static void main(final String[] args) throws Exception {
        String regionId = "<region-id>";
        DefaultProfile profile = DefaultProfile.getProfile(regionId);

        // RAM ロールを設定します。このトピックではEcsRamRoleTestを例として使用します。
        String roleName = "EcsRamRoleTest"; 

        // インスタンス RAM ロールの認証情報プロバイダーを作成します。
        AlibabaCloudCredentialsProvider provider = new InstanceProfileCredentialsProvider(roleName);

        IAcsClient client = new DefaultAcsClient(profile, provider);

        ListKeysRequest request = new ListKeysRequest();
      
        try {
            ListKeysResponse response = client.getAcsResponse(request);
            System.out.println(new Gson().toJson(response));
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            System.out.println("ErrCode:" + e.getErrCode());
            System.out.println("ErrMsg:" + e.getErrMsg());
            System.out.println("RequestId:" + e.getRequestId());
        }

    }
}