Tablestore：配置訪問憑證

憑證提供者選型

Tablestore支援多種方式初始化憑證提供者，您可以根據使用情境對認證和授權的要求，選擇對應的方式初始化憑證提供者。

方式一：使用AK

如果您的應用程式部署運行在安全、穩定且不易受外部攻擊的環境中，需要長期訪問您的Tablestore，且不能頻繁輪轉憑證時，您可以使用阿里雲主帳號或RAM使用者的AK（Access Key ID、Access Key Secret）初始化憑證提供者。需要注意的是，該方式需要您手動維護一個AK，存在安全性風險和維護複雜度增加的風險。如何擷取AK，請參見使用RAM使用者密鑰發起請求。

方式二：使用自動輪轉的AK

如果您的應用程式需要長期訪問Tablestore，但部署啟動並執行環境面臨AK泄露的風險，需要頻繁手動輪轉（輪換）AK，您可以使用ClientKey初始化憑證提供者。該方式底層實現是AK。使用ClientKey後，Key Management Service（KMS）可以對託管的RAM使用者AK進行全自動的定期輪轉，將靜態RAM使用者AK動態化，從而降低AK泄漏的風險。除定期輪轉外，KMS還支援立即輪轉，在AK泄漏情況下快速更換AK。該方式無需您手動維護一個AK，從而降低安全性風險和維護複雜度增加的風險。如何擷取ClientKey，請參見建立應用存取點。

1. 添加憑據用戶端依賴。

   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>alibabacloud-secretsmanager-client</artifactId>
       <version>1.3.7</version>
   </dependency>
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>aliyun-java-sdk-core</artifactId>
     <version>4.7.0</version>
   </dependency>

2. 建立設定檔secretsmanager.properties。

   # 訪問憑據類型，固定為client_key
   credentials_type=client_key
   
   # 讀取Client Key的解密密碼：支援從環境變數或者檔案讀取，只需設定一種
   client_key_password_from_env_variable=<your client key private key password environment variable name>
   client_key_password_from_file_path=<your client key private key password file path>
   
   # Client Key的私密金鑰檔案路徑
   client_key_private_key_path=<your client key private key file path>
   
   # 關聯的KMS服務地區
   cache_client_region_id=[{"regionId":"<regionId>"}]

3. 使用設定檔來傳遞憑證資訊。

   import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
   import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
   import com.alicloud.openservices.tablestore.core.auth.ServiceCredentials;
   import com.aliyuncs.kms.secretsmanager.client.SecretCacheClient;
   import com.aliyuncs.kms.secretsmanager.client.SecretCacheClientBuilder;
   import com.aliyuncs.kms.secretsmanager.client.exception.CacheSecretException;
   import com.aliyuncs.kms.secretsmanager.client.model.SecretInfo;
   import org.codehaus.jettison.json.JSONException;
   import org.codehaus.jettison.json.JSONObject;
   
   public class ClientKeyDemoTest {
   
       public static void main(String[] args) throws CacheSecretException {
           final SecretCacheClient client = SecretCacheClientBuilder.newClient();
           CredentialsProvider credentialsProvider = new CredentialsProvider() {
               @Override
               public void setCredentials(ServiceCredentials credentials) {
               }
   
               @Override
               public ServiceCredentials getCredentials() {
                   try {
                       SecretInfo secretInfo = client.getSecretInfo("<secretName>");
                       JSONObject jsonObject = new JSONObject(secretInfo.getSecretValue());
   
                       String accessKeyId = jsonObject.getString("AccessKeyId");
                       String accessKeySecret = jsonObject.getString("AccessKeySecret");
   
                       return new DefaultCredentials(accessKeyId, accessKeySecret);
                   } catch (CacheSecretException | JSONException e) {
                       return null;
                   }
               }
           };
           // 使用credentialsProvider進行後續操作...
       }
   }

方式三：使用STS Token

如果您的應用程式需要臨時訪問Tablestore，您可以使用通過STS服務擷取的臨時身份憑證（Access Key ID、Access Key Secret和Security Token）初始化憑證提供者。需要注意的是，該方式需要您手動維護一個STS Token，存在安全性風險和維護複雜度增加的風險。此外，如果您需要多次臨時訪問Tablestore，您需要手動重新整理STS Token。如何擷取STS Token，請參見使用STS臨時訪問憑證發起請求。

方式四：使用AK及RAMRoleARN

如果您的應用程式需要授權訪問Tablestore，例如跨阿里雲帳號訪問Tablestore，您可以使用RAMRoleARN初始化憑證提供者。該方式底層實現是STS Token。通過指定RAM角色的ARN（Alibabacloud Resource Name），Credentials工具會前往STS服務擷取STS Token，並在會話到期前自動重新整理STS Token。此外，您還可以通過為policy賦值來限制RAM角色到一個更小的許可權集合。需要注意的是，該方式需要您提供一個AK，存在安全性風險和維護複雜度增加的風險。如何擷取AK，請參見CreateAccessKey - 為RAM使用者建立存取金鑰。如何擷取RAMRoleARN，請參見CreateRole - 建立角色。

1. 添加credentials依賴。

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>0.3.4</version>
   </dependency>

2. 配置AK和RAMRoleARN作為訪問憑證。

   import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
   import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
   import com.alicloud.openservices.tablestore.core.auth.ServiceCredentials;
   import com.aliyun.credentials.models.CredentialModel;
   
   public class RamRoleArnAkDemoTest {
   
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // 訪問憑證類型。固定為ram_role_arn
           config.setType("ram_role_arn");
           // 從環境變數中擷取RAM角色的RamRoleArn
           config.setRoleArn(System.getenv().get("ALIBABACLOUD_STS_ROLE_ARN"));
           // 從環境變數中擷取AccessKeyId
           config.setAccessKeyId(System.getenv().get("OTS_AK_ENV"));
           // 從環境變數中擷取AccessKeySecret
           config.setAccessKeySecret(System.getenv().get("OTS_SK_ENV"));
           // 填寫RAM角色的會話名稱
           config.setRoleName("roleSessionName");
           // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
           config.setPolicy("<Policy>");
           // 設定角色會話有效期間，非必填
           config.setRoleSessionExpiration(3600);
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(ServiceCredentials credentials) {
               }
   
               @Override
               public ServiceCredentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // 使用credentialsProvider進行後續操作...
       }
   }

方式五：使用ECSRAMRole

如果您的應用程式運行在ECS執行個體、ECI執行個體、Container ServiceKubernetes版的Worker節點中，建議您使用ECSRAMRole初始化憑證提供者。該方式底層實現是STS Token。ECSRAMRole允許您將一個角色關聯到ECS執行個體、ECI執行個體或Container Service Kubernetes 版的Worker節點，實現在執行個體內部自動重新整理STS Token。該方式無需您提供一個AK或STS Token，消除了手動維護AK或STS Token的風險。如何擷取ECSRAMRole，請參見CreateRole - 建立角色。

1. 添加credentials依賴。

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>0.3.4</version>
   </dependency>

2. 配置ECSRAMRole作為訪問憑證。

   import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
   import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
   import com.alicloud.openservices.tablestore.core.auth.ServiceCredentials;
   import com.aliyun.credentials.models.CredentialModel;
   
   public class EcsRamRoleDemoTest {
   
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // 訪問憑證類型。固定為ecs_ram_role。
           config.setType("ecs_ram_role");
           // 為ECS授予的RAM角色的名稱。選擇性參數。如果不設定，將自動檢索。強烈建議設定，以減少請求。
           config.setRoleName("ECSRAMRole");
           // 開啟ECS執行個體中繼資料加固模式。選擇性參數。強烈建議設定，以提高整體系統的安全性。
           config.setEnableIMDSv2(true);
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(ServiceCredentials credentials) {
               }
   
               @Override
               public ServiceCredentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // 使用credentialsProvider進行後續操作...
       }
   }

方式六：使用OIDCRoleARN

在Container ServiceKubernetes版中設定了Worker節點RAM角色後，對應節點內的Pod中的應用也就可以像ECS上部署的應用一樣，通過中繼資料服務（Meta Data Server）擷取關聯角色的STS Token。但如果容器叢集上部署的是不可信的應用（比如部署您的客戶提交的應用，代碼也沒有對您開放），您可能並不希望它們能通過中繼資料服務擷取Worker節點關聯執行個體RAM角色的STS Token。為了避免影響雲上資源的安全，同時又能讓這些不可信的應用安全地擷取所需的STS Token，實現應用層級的許可權最小化，您可以使用RRSA（RAM Roles for Service Account）功能。該方式底層實現是STS Token。阿里雲容器叢集會為不同的應用Pod建立和掛載相應的服務賬戶OIDC Token檔案，並將相關配置資訊注入到環境變數中，Credentials工具通過擷取環境變數的配置資訊，調用STS服務的AssumeRoleWithOIDC介面換取綁定角色的STS Token。該方式無需您提供一個AK或STS Token，消除了手動維護AK或STS Token的風險。詳情請參見通過RRSA配置ServiceAccount的RAM許可權實現Pod許可權隔離。

1. 添加credentials依賴。

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>0.3.4</version>
   </dependency>>

2. 配置OIDC的RAM角色作為訪問憑證。

   public class OidcRoleArnDemoTest {
   
       public static void main(String[] args) {
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // 指定Credential類型，固定值為oidc_role_arn
           config.setType("oidc_role_arn");
           // 從環境變數中擷取臨時AccessKeyId
           config.setAccessKeyId(System.getenv().get("OTS_AK_ENV"));
           // 從環境變數中擷取臨時AccessKeySecret
           config.setAccessKeySecret(System.getenv().get("OTS_SK_ENV"));
           // 從環境變數中擷取臨時SecurityToken
           config.setSecurityToken(System.getenv().get("OTS_SESSION_TOKEN"));
           // 角色的ARN資訊，即需要扮演的角色ID
           config.setRoleArn(System.getenv("ALIBABA_CLOUD_ROLE_ARN"));
           // 指定OIDC提供者的ARN
           config.setOidcProviderArn(System.getenv("ALIBABA_CLOUD_OIDC_PROVIDER_ARN"));
           // 指定OIDC令牌的檔案路徑，用於儲存OIDC令牌
           config.setOidcTokenFilePath(System.getenv("ALIBABA_CLOUD_OIDC_TOKEN_FILE"));
           // 角色會話名稱
           config.setRoleSessionName("<RoleSessionName>");
           // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
           config.setPolicy("<Policy>");
           // RAM角色的外部ID，非必填。
           // 此參數由外部方提供，用於防止混淆的代理問題。
           config.setExternalId("<ExternalId>");
           // 設定session到期時間
           config.setRoleSessionExpiration(3600);
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider() {
               @Override
               public void setCredentials(ServiceCredentials credentials) {
               }
   
               @Override
               public ServiceCredentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // 使用credentialsProvider進行後續操作...
       }
   }

方式七：使用Function Compute上下文中的Credentials

如果您的應用程式的函數部署運行在Function Compute中，您可以使用Function Compute上下文中的Credentials初始化憑證提供者。該方式底層實現是STS Token。Function Compute根據函數配置的角色，通過扮演服務角色，而擷取一個STS Token，然後通過上下文中的參數Credentials將STS Token傳遞給您的應用程式。該STS Token的有效期間為36小時，且不支援修改。函數的最大執行時間為24小時，因此，執行函數過程中，STS Token不會到期，您無需考慮重新整理問題。該方式無需您提供一個AK或STS Token，消除了手動維護AK或STS Token的風險。如何授予Function Compute訪問Tablestore的許可權，請參見授予Function Compute訪問其他雲端服務的許可權。

1. 添加Function Compute上下文依賴。

   <!-- https://mvnrepository.com/artifact/com.aliyun.fc.runtime/fc-java-core -->
   <dependency>
       <groupId>com.aliyun.fc.runtime</groupId>
       <artifactId>fc-java-core</artifactId>
       <version>1.4.1</version>
   </dependency>

2. 使用Function Compute上下文中的Credentials初始化憑證提供者。

   package example;
   
   import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
   import com.alicloud.openservices.tablestore.core.auth.DefaultCredentialProvider;
   import com.aliyun.fc.runtime.Context;
   import com.aliyun.fc.runtime.Credentials;
   import com.aliyun.fc.runtime.StreamRequestHandler;
   
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.OutputStream;
   
   public class App implements StreamRequestHandler {
   
       @Override
       public void handleRequest(
               InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
   
           // 擷取密鑰資訊，執行前，確保函數所在的服務配置了角色資訊，並且角色需要擁有Tablestore的許可權，建議直接使用AliyunFCDefaultRole角色
           Credentials creds = context.getExecutionCredentials();
   
           // 使用擷取到的憑證建立憑證提供者執行個體
           CredentialsProvider credentialsProvider = new DefaultCredentialProvider(creds.getAccessKeyId(), creds.getAccessKeySecret(), creds.getSecurityToken());
   
           // 使用credentialsProvider進行後續操作...
   
           outputStream.write(new String("done").getBytes());
       }
   }

方式八：使用CredentialsURI

如果您的應用程式需要通過外部系統擷取阿里雲憑證，從而實現靈活的憑證管理和無密鑰訪問，您可以使用CredentialsURI初始化憑證提供者。該方式底層實現是STS Token。Credentials工具通過您提供的URI擷取STS Token，完成憑證用戶端初始化。該方式無需您提供一個AK或STS Token，消除了手動維護AK或STS Token的風險。需要注意的是，提供CredentialsURI響應的後端服務需要實現STS Token的自動重新整理邏輯，確保您的應用程式始終能擷取到有效憑證。

1. 為了使Credentials工具正確解析和使用STS Token，URI必須遵循以下響應協議：

   • 響應狀態代碼：200

   • 響應體結構：

     {
         "Code": "Success",
         "AccessKeySecret": "AccessKeySecret",
         "AccessKeyId": "AccessKeyId",
         "Expiration": "2021-09-26T03:46:38Z",
         "SecurityToken": "SecurityToken"
     }

2. 添加credentials依賴。

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>0.3.4</version>
   </dependency>

3. 配置CredentialsURI作為訪問憑證。

   import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
   import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
   import com.alicloud.openservices.tablestore.core.auth.ServiceCredentials;
   import com.aliyun.credentials.models.CredentialModel;
   
   public class CredentialsUriDemoTest {
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // 訪問憑證類型。固定為credentials_uri
           config.setType("credentials_uri");
           // 換取憑證的URI，格式為http://local_or_remote_uri/
           config.setCredentialsUri("<local_or_remote_uri>");
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider() {
               @Override
               public void setCredentials(ServiceCredentials credentials) {
               }
   
               @Override
               public ServiceCredentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // 使用credentialsProvider進行後續操作...
       }
   }

方式九：自訂訪問憑證

如果以上憑證配置方式都不滿足要求時，您還可以通過實現Credential Providers介面的方式，來自訂憑證提供方式。需要注意，如果底層實現是STS Token，需要提供憑證的更新支援。

import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
import com.alicloud.openservices.tablestore.core.auth.ServiceCredentials;

public class CustomCredentialProviderDemoTest {

    public static void main(String[] args) {

        CredentialsProvider credentialsProvider = new CredentialsProvider(){

            // 初始設定變數
            String accessKeyId = null;
            // 初始設定變數
            String accessKeySecrect = null;
            // 初始設定變數
            // String token = null;

            @Override
            public void setCredentials(ServiceCredentials credentials) {
            }

            @Override
            public ServiceCredentials getCredentials() {
                //TODO
                //自訂訪問憑證的擷取方法

                // 返回長期憑證 access_key_id, access_key_secrect
                return new DefaultCredentials(accessKeyId, accessKeySecrect);

                // 返回 臨時憑證 access_key_id, access_key_secrect, token
                // 對於臨時憑證，需要根據到期時間，重新整理憑證。
                // return new DefaultCredentials(accessKeyId, accessKeySecrect, token);
            }
        };
        // 使用credentialsProvider進行後續操作...
    }
}