憑據管家代碼開發樣本 - Key Management Service

建立憑據後，您可以使用KMS簡單易用的SDK代碼使用憑據。本文以Java SDK為例為您介紹如何使用憑據。

準備工作

擷取Java SDK的依賴聲明，需要擷取的版本請參見SDK概覽。樣本如下：

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.5.2</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-kms</artifactId>
    <version>2.12.0</version>
</dependency>

根據您使用的KMS地區，確認正確的KMS服務接入地址。詳情請參見調用方式。
說明
本文樣本通過指定地區標識符，快速存取KMS的公網接入地址。訪問KMS的VPC地址操作方法，請參見Java SDK樣本。

使用憑據

您可以建立憑據，將受保護資料存入憑據。憑據管家詳情，請參見憑據管家概述。

說明

阿里雲帳號AccessKey擁有所有OpenAPI的存取權限，建議您使用RAM使用者進行API訪問或日常營運。強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。

本樣本以將AccessKey配置在環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式來實現身分識別驗證為例。

更多認證資訊配置方式，請參見管理訪問憑據。
不同作業系統的環境變數配置方法不同，具體操作，請參見在Linux、macOS和Windows系統配置環境變數。

package com.aliyun.kms.secretmanager.samples;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.kms.model.v20160120.*;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import com.aliyuncs.http.HttpClientConfig;

public class FastUsage {
         /*
          *  訪問憑據管家前，請在RAM控制台為訪問帳號添加存取原則（例如：設定Key Management Service的系統管理權限AliyunKMSFullAccess）。您也可以添加包含所需的API許可權的系統策略或自訂策略。
          * */
    public static DefaultAcsClient getkmsClient() {
        /*
         *  1. 指定憑據管家所在地區。
         *  2. 指定訪問KMS所需要的憑證AccessKey ID和AccessKey Secret。
         * */
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou",System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        HttpClientConfig clientConfig = HttpClientConfig.getDefault();
        profile.setHttpClientConfig(clientConfig);
        return new DefaultAcsClient(profile);
    }


    public static void CreateSecretSample(String secret_name,String secret_data,String version_id) throws ClientException {
        DefaultAcsClient acsClient = getkmsClient();

        CreateSecretRequest req = new CreateSecretRequest();
        req.setSecretName(secret_name);
        req.setSecretData(secret_data);
        req.setVersionId(version_id);
        req.setSecretDataType("text");
        req.setDescription("my app passwd");
        req.setEncryptionKeyId("");           //您可以使用對稱金鑰類型的使用者主要金鑰，或設定為空白。設定為空白時將使用憑據管家為使用者建立的託管密鑰。
        req.setTags("");

        CreateSecretResponse rsp = acsClient.getAcsResponse(req);
        System.out.printf("CreateSecret arn: %s; secret_name: %s; versionid: %s; requestid: %s \n",rsp.getArn(),rsp.getSecretName(),rsp.getVersionId(),rsp.getRequestId());
    }


    public static void GetSecretValueSample(String secret_name,String version_stage) throws ClientException {
        DefaultAcsClient acsClient = getkmsClient();

        GetSecretValueRequest req = new GetSecretValueRequest();
        req.setSecretName(secret_name);
        req.setVersionStage(version_stage);

        GetSecretValueResponse  rsp = acsClient.getAcsResponse(req);
        System.out.printf("GetSecretValue  data: %s \n",rsp.getSecretData());
    }



    public static void PutSecretValueSample(String secret_name,String secret_data,String version_id,String version_stages) throws ClientException {
        DefaultAcsClient acsClient = getkmsClient();

        PutSecretValueRequest req = new PutSecretValueRequest();
        req.setSecretName(secret_name);
        req.setSecretData(secret_data);
        req.setSecretDataType("text");
        req.setVersionId(version_id);
        req.setVersionStages(version_stages);  //憑據指定狀態的參數取值為JSON格式。


        PutSecretValueResponse rsp = acsClient.getAcsResponse(req);
        System.out.printf("PutSecretValue versionid: %s; now stages: %s \n",rsp.getVersionId(),rsp.getVersionStages());
    }


    public static void DeleteScretSample() throws ClientException {
        DefaultAcsClient acsClient = getkmsClient();

        DeleteSecretRequest req = new DeleteSecretRequest();
        req.setSecretName("myapp_secret");
        req.setForceDeleteWithoutRecovery("true");


        DeleteSecretResponse rsp = acsClient.getAcsResponse(req);
        System.out.printf("DeleteSecret force delete secret:%s \n",rsp.getSecretName());
    }


    public static void main(String[] args ){
        try {
           /*
            *  建立憑據，並指定初始版本VersionId和需被加密的憑據值SecretData。初始版本的狀態被系統標記為ACSCurrent。
            * */
            FastUsage.CreateSecretSample("myapp_secret","mysqpasswdv1","v1");
            /*
             *  擷取憑據。如果不指定版本號碼或版本狀態，則憑據管家預設返回被標記為ACSCurrent版本的憑據值。
             * */
            FastUsage.GetSecretValueSample("myapp_secret","");


            /*
             *  為憑據存入一個新版本的憑據值，並指定此版本所處狀態VersionStages。若不指定，系統預設將ACSCurrent移動至新版本。
             * */
            FastUsage.PutSecretValueSample("myapp_secret","mysqpasswdv2","v2","[\"ACSCurrent\", \"MyUserstage\"]");
            /*
             *  再次擷取憑據。預設擷取最新版本的憑據值。
             * */
            FastUsage.GetSecretValueSample("myapp_secret","");



            FastUsage.PutSecretValueSample("myapp_secret","mysqpasswdv3","v3","");
            /*
             *  擷取憑據。預設擷取最新版本的憑據值。
             * */
            FastUsage.GetSecretValueSample("myapp_secret","");
            /*
             *  擷取憑據。指定參數VersionId或VersionStage後，您可以擷取之前建立版本的憑據值。
             * */
            FastUsage.GetSecretValueSample("myapp_secret","MyUserstage");


            FastUsage.DeleteScretSample();

        } catch (ClientException e) {
            e.printStackTrace();
        }

    }
}

更多程式碼範例，請參見KMS代碼開發範例庫。