通過配置Credentials實現OpenAPI安全調用（PHP SDK） - Alibaba Cloud SDK

在使用阿里雲SDK時，憑據資訊（例如AccessKey、STS Token等）由Credentials工具統一管理。本文將為您介紹Credentials工具支援的憑據類型及其配置方法，協助您快速掌握Credentials工具的使用。

背景資訊

憑據是指使用者證明其身份的一組資訊。使用者在系統中進行登入時，需要提供正確的憑據才能驗證身份。常見的憑據類型有：

阿里雲主帳號和RAM使用者的永久憑據 AccessKey（簡稱AK）是由AccessKey ID和AccessKey Secret組成的金鑰組。
阿里雲RAM角色的STS臨時訪問Token，簡稱STS Token。它是可以自訂時效和存取權限的臨時身份憑據，詳情請參見什麼是STS。
Bearer Token。它是一種身分識別驗證和授權的令牌類型。

前提條件

使用Credentials工具要求PHP版本 >= 5.6。強烈建議您使用cURL擴充，並使用TLS後端編譯cURL 7.16.2+。
使用V2.0代系的阿里雲SDK。

安裝Credentials工具

如果已在系統上全域安裝 Composer，請直接在專案目錄中運行以下內容來安裝 Alibaba Cloud Credentials for PHP 作為依賴項：

composer require alibabacloud/credentials

使用最新發行Credentials依賴包，確保所有憑證支援。
請查看CHANGELOG.md擷取所有發行的版本列表。

Credentials工具配置參數介紹

Credentials工具的配置參數定義在AlibabaCloud\Credentials\Credential\Config中，憑據類型由必填參數type指定。確定憑據類型後，需根據該憑據類型選擇相應的參數。下表將詳細介紹type的取值範圍及各類憑據類型所支援的參數。其中，√表示必填參數，-表示選擇性參數，×表示不支援參數。

說明

未在下表中列出的憑據類型及參數表示不建議繼續使用。

type	access_key	sts	ram_role_arn	ecs_ram_role	oidc_role_arn	credentials_uri	bearer
accessKeyId：訪問憑據ID。	√	√	√	×	×	×	×
accessKeySecret：訪問憑據密鑰。	√	√	√	×	×	×	×
securityToken：STS Token。	×	√	-	×	×	×	×
roleArn：RAM角色的ARN。	×	×	√	×	√	×	×
roleSessionName：自訂會話名稱，預設格式為`phpSdkRoleSessionName`。	×	×	-	×	-	×	×
roleName：RAM角色名稱。	×	×	×	-	×	×	×
disableIMDSv1：是否強制使用加固模式，預設值為`false`。	×	×	×	-	×	×	×
bearerToken：bearer token。	×	×	×	×	×	×	√
policy：自訂權限原則。	×	×	-	×	-	×	×
roleSessionExpiration：會話到期時間，預設3600秒。	×	×	-	×	-	×	×
oidcProviderArn：OIDC供應商ARN。	×	×	×	×	√	×	×
oidcTokenFilePath：OIDC Token檔案路徑。	×	×	×	×	√	×	×
externalId：角色外部 ID，主要功能是防止混淆代理人問題。更多資訊，請參見使用ExternalId防止混淆代理人問題。	×	×	-	×	×	×	×
credentialsURI：憑證的URI。	×	×	×	×	×	√	×
STSEndpoint：STS的服務存取點，支援VPC服務存取點和公網服務存取點，可選的值請參見服務存取點，預設值為`sts.aliyuncs.com`。	×	×	-	×	-	×	×
timeout：HTTP請求的讀逾時時間，預設值為5000毫秒。	×	×	-	-	-	-	×
connectTimeout：HTTP請求的連線逾時時間，預設值為10000毫秒。	×	×	-	-	-	-	×

初始化憑據用戶端

前文已介紹Credentials工具所支援的憑據類型及其配置參數，接下來將通過詳細的程式碼範例進一步說明，您可以根據具體情況選擇適合的使用方式。

重要

在專案中使用明文AccessKey，容易因代碼倉庫許可權管理不當造成AccessKey泄露，會威脅該帳號下所有資源的安全。建議通過環境變數、設定檔等方式儲存AccessKey。
在使用Credentials工具時，建議採用單例模式。這一做法能夠啟用Credentials工具內建的憑據緩衝功能，有效防止因多次調用介面而導致的限流問題，以及因建立多個執行個體而引起的資源浪費問題。詳細資料請參見Session類型憑據自動重新整理機制。

方式一：使用預設憑據鏈

當您在初始化憑據用戶端不傳入任何參數時，Credentials工具會使用預設憑據鏈方式初始化用戶端。預設憑據的讀取邏輯請參見預設憑據鏈。

<?php

use AlibabaCloud\Credentials\Credential;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 不指定參數
$credClient = new Credential();

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 使用預設憑證初始化Credentials Client。
$credentialClient = new Credential();
$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credentialClient,
    // 雲產品服務存取點
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式二：使用AK

Credentials工具將使用您提供的AccessKey作為訪問憑據。

警告

阿里雲帳號（主帳號）擁有資源的全部許可權，AK一旦泄露，會給系統帶來巨大風險，不建議使用。

推薦使用最小化授權的RAM使用者的AK。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

$credConfig = new Config([
    'type' => 'access_key',
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
]);

$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 使用AK 初始化Credentials Client。
$credConfig = new CredentialConfig([
    'type' => 'access_key',
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
]);
$credClient = new Credential($credConfig);

$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式三：使用STS Token

Credentials工具將使用您提供的靜態STS Token作為訪問憑據。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

$credConfig = new Config([
    'type' => 'sts',
    // 從環境變數中擷取AccessKey ID的值
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    // 從環境變數中擷取AccessKey Secret的值
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    // 從環境變數中擷取STS Token的值
    'securityToken' => getenv('ALIBABA_CLOUD_SECURITY_TOKEN'),
]);
$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝Elastic Compute Service SDK和Security Token Service SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\SDK\Sts\V20150401\Models\AssumeRoleRequest;
use AlibabaCloud\SDK\Sts\V20150401\Sts;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 建立STS Client，並調用assumeRole方法擷取臨時憑證。
$config = new Config([
    // 從環境變數擷取AccessKeyId、AccessKeySecret，如果未設定，請設定後運行。
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    'endpoint' => 'sts.aliyuncs.com',
]);
$stsClient = new Sts($config);
$request = new AssumeRoleRequest([
    // 要扮演的RAM角色ARN，樣本值：acs:ram::123456789012****:role/adminrole，可以通過環境變數ALIBABA_CLOUD_ROLE_ARN設定roleArn  
    'roleArn' => '<RoleArn>',
    // 角色會話名稱，可以通過環境變數ALIBABA_CLOUD_ROLE_SESSION_NAME設定roleSessionName  
    'roleSessionName' => '<RoleSessionName>',
]);
$assumeRoleResp = $stsClient->assumeRole($request);
$assumeRoleCredentials = $assumeRoleResp->body->credentials;

// 使用STS Token初始化Credentials Client。
$credentialConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'sts',
    'accessKeyId' => $assumeRoleCredentials->accessKeyId,
    'accessKeySecret' => $assumeRoleCredentials->accessKeySecret,
    'securityToken' => $assumeRoleCredentials->securityToken,
]);
$credentialClient = new Credential($credentialConfig);
$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credentialClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);// 輸出狀態代碼
echo $resp->statusCode;// 輸出響應
var_dump($resp);

方式四：使用AK及RamRoleArn

該方式底層實現是STS Token。通過指定RAM角色的ARN（Alibabacloud Resource Name），Credentials工具可以協助開發人員前往STS換取STS Token。您也可以通過為policy賦值來限制RAM角色到一個更小的許可權集合。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

$credConfig = new Config([
    'type' => 'ram_role_arn',
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    // 要扮演的RAM角色ARN，樣本值：acs:ram::123456789012****:role/adminrole，可以通過環境變數ALIBABA_CLOUD_ROLE_ARN設定role_arn
    'roleArn' => '<RoleArn>',
    // 角色會話名稱，可以通過環境變數ALIBABA_CLOUD_ROLE_SESSION_NAME設定role_session_name
    'roleSessionName' => '<RoleSessionName>',
    // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
    'policy' => '<Policy>',
    // 會話到期時間，非必填，預設值3600
    'roleSessionExpiration' => 3600,
]);
$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// 使用AK和RamRoleArn初始化Credentials Client。
$credentialConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'ram_role_arn',
    // 從環境變數中擷取AccessKey ID值。
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    // 從環境變數中擷取AccessKey Secret值。
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    // 要扮演的RAM角色ARN，樣本值：acs:ram::123456789012****:role/adminrole，可以通過環境變數ALIBABA_CLOUD_ROLE_ARN設定role_arn
    'roleArn' => '<RoleArn>',
    // 角色會話名稱，可以通過環境變數ALIBABA_CLOUD_ROLE_SESSION_NAME設定role_session_name
    'roleSessionName' => '<RoleSessionName>',
    // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
    'policy' => '<Policy>',
    // 會話到期時間，非必填，預設值3600
    'roleSessionExpiration' => 3600,
]);
$credentialClient = new Credential($credentialConfig);

$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credentialClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式五：使用ECS執行個體RAM角色

ECS和ECI執行個體均支援綁定執行個體RAM角色，運行於執行個體中的程式可通過Credentials工具自動擷取該角色的STS Token，從而完成憑據用戶端的初始化。

Credentials工具將預設採用加固模式（IMDSv2）訪問ECS的中繼資料服務（Meta Data Server），在使用加固模式時若發生異常，將使用普通模式兜底來擷取訪問憑據。您也可以通過設定參數disableIMDSv1或環境變數ALIBABA_CLOUD_IMDSV1_DISABLE，執行不同的異常處理邏輯：

當值為false（預設）時，會使用普通模式繼續擷取訪問憑據。
當值為true時，表示只能使用加固模式擷取訪問憑據，會拋出異常。

服務端是否支援IMDSv2，取決於您在伺服器的配置。

另外，您可以通過配置環境變數ALIBABA_CLOUD_ECS_METADATA_DISABLED=true來關閉ECS中繼資料的憑證訪問。

說明

使用加固模式擷取臨時身份憑證時，credentials的版本不低於1.2.0。
關於ECS執行個體中繼資料的介紹，請參見執行個體中繼資料。
如何為ECS和ECI執行個體授予RAM角色，具體操作請參見步驟一：建立RAM角色和為ECI執行個體授予執行個體RAM角色。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

$credConfig = new Config([
    'type' => 'ecs_ram_role',
    // 選填，該ECS角色的角色名稱，不填會自動擷取，但是建議加上以減少請求次數，可以通過環境變數ALIBABA_CLOUD_ECS_METADATA設定role_name
    'roleName' => '<RoleName>',
    // 選填，預設值：false。true：表示強制使用加固模式。false：系統將首先嘗試在加固模式下擷取憑據。如果失敗，則會切換到普通模式（IMDSv1）進行嘗試
    // 'disableIMDSv1' => true,
]);
$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// 使用ECS執行個體RAM角色初始化Credentials Client。
$credConfig = new CredentialConfig([
    'type' => 'ecs_ram_role',
    // 選填，該ECS角色的角色名稱，不填會自動擷取，但是建議加上以減少請求次數，可以通過環境變數ALIBABA_CLOUD_ECS_METADATA設定role_name
    'roleName' => '<RoleName>',
]);
$credClient = new Credential($credConfig);

$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式六：使用OIDCRoleArn

若您使用OIDC認證協議，並已建立OIDC身份供應商的RAM角色，您可以通過Credentials工具傳入OIDC身份供應商ARN、OIDC Token及RAM角色ARN，系統將自動調用AssumeRoleWithOIDC介面擷取RAM角色的STS Token，並將該STS Token作為訪問憑據。通過此方式擷取的憑據支援自動重新整理，詳情請參見Session類型憑據自動重新整理機制。例如當您的應用程式運行於已啟用RRSA功能的ACK叢集中時，Credentials工具支援通過讀取Pod環境變數中的OIDC配置資訊，調用AssumeRoleWithOIDC介面擷取服務角色的STS Token，從而利用該STS Token訪問阿里雲相關服務。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 使用OIDCRoleArn初始化Credentials Client。
$credConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'oidc_role_arn',
    // OIDC供應商ARN，可以通過環境變數ALIBABA_CLOUD_OIDC_PROVIDER_ARN設定oidc_provider_arn
    'oidcProviderArn' => '<OidcProviderArn>',
    // OIDC Token檔案路徑，可以通過環境變數ALIBABA_CLOUD_OIDC_TOKEN_FILE設定oidc_token_file_path
    'oidcTokenFilePath' => '<OidcTokenFilePath>',
    // RAM角色名稱ARN，樣本值：acs:ram::123456789012****:role/adminrole，可以通過環境變數ALIBABA_CLOUD_ROLE_ARN設定role_arn
    'roleArn' => '<RoleArn>',
    // 角色會話名稱，可以通過環境變數ALIBABA_CLOUD_ROLE_SESSION_NAME設定role_session_name
    'roleSessionName' => '<RoleSessionName>',
    // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
    'policy' => '<Policy>',
    // 設定session到期時間，非必填。
    'roleSessionExpiration' => 3600,
]);

$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// 使用OIDCRoleArn初始化Credentials Client。
$credConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'oidc_role_arn',
    // OIDC供應商ARN，可以通過環境變數ALIBABA_CLOUD_OIDC_PROVIDER_ARN設定oidc_provider_arn
    'oidcProviderArn' => '<OidcProviderArn>',
    // OIDC Token檔案路徑，可以通過環境變數ALIBABA_CLOUD_OIDC_TOKEN_FILE設定oidc_token_file_path
    'oidcTokenFilePath' => '<OidcTokenFilePath>',
    // RAM角色名稱ARN，樣本值：acs:ram::123456789012****:role/adminrole，可以通過環境變數ALIBABA_CLOUD_ROLE_ARN設定role_arn
    'roleArn' => '<RoleArn>',
    // 角色會話名稱，可以通過環境變數ALIBABA_CLOUD_ROLE_SESSION_NAME設定role_session_name
    'roleSessionName' => '<RoleSessionName>',
    // 設定更小的權限原則，非必填。樣本值：{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
    'policy' => '<Policy>',
    // 設定session到期時間，非必填。
    'roleSessionExpiration' => 3600,
]);

$credClient = new Credential($credConfig);

$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式七：使用URI憑據

通過封裝STS服務並對外暴露服務的URI，外部服務能夠通過該URI擷取STS Token，從而有效降低AK等敏感資訊的暴露風險。Credentials工具支援通過訪問您所提供的URI來擷取STS Token，並將該STS Token作為訪問憑據。通過此方式擷取的憑據支援自動重新整理，詳情請參見Session類型憑據自動重新整理機制。

<?php

namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

// 使用URI憑據初始化Credentials Client。
$credConfig = new Config([
    // 憑證類型。
    'type' => 'credentials_uri',
    // 憑證的 URI，格式為http://local_or_remote_uri/，可以通過環境變數ALIBABA_CLOUD_CREDENTIALS_URI設定credentials_uri
    'credentialsURI' => '<CredentialsUri>',
]);
$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

該地址必須滿足如下條件：

支援GET請求。
響應 200 狀態代碼。

響應體為如下的結構：

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

介面調用樣本

本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝ECS SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig; 
use AlibabaCloud\SDK\Ecs\V20140526\Ecs as Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// 使用URI憑據初始化Credentials Client。
$credConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'credentials_uri',
    // 憑證的 URI，格式為http://local_or_remote_uri/，可以通過環境變數ALIBABA_CLOUD_CREDENTIALS_URI設定credentials_uri
    'credentialsURI' => '<CredentialsUri>',
]);
$credClient = new Credential($credConfig);

$ecsConfig = new Config([
    // 使用 credential 配置憑證
    'credential' => $credClient,
    // 產品服務網域名稱
    'endpoint' => 'ecs.aliyuncs.com'
]);
// 初始化ECS client
$ecsClient = new Ecs($ecsConfig);
// 初始化 request
$describeRegionsRequest = new DescribeRegionsRequest([]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $ecsClient->describeRegionsWithOptions($describeRegionsRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

方式八：使用Bearer Token

目前只有Cloud Call CenterCCC這款產品支援Bearer Token。

<?php

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

$credConfig = new Config([
    'type' => 'bearer',
    // 填入您的Bearer Token
    'bearerToken' => '<BearerToken>',
]);
$credClient = new Credential($credConfig);

$credential = $credClient->getCredential();
$credential->getBearerToken();

介面調用樣本

本樣本以調用話務中心CCC的GetInstance介面為例，因此需先安裝CCC SDK。

<?php

namespace AlibabaCloud\SDK\Sample;

// composer 自動載入機制，require_once(vendor目錄下autoload.php檔案)
require_once 'vendor/autoload.php';

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig; 
use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\SDK\CCC\V20200701\CCC;
use AlibabaCloud\SDK\CCC\V20200701\Models\GetInstanceRequest;

// 使用Bearer Token初始化Credentials Client。
$credConfig = new CredentialConfig([
    // 憑證類型。
    'type' => 'bearer',
    // 填入您的Bearer Token
    'bearerToken' => '<BearerToken>',
]);
$credClient = new Credential($credConfig);

$config = new Config([
    // 使用 credential 配置憑證
    'credential' => $credClient,
    // 產品服務網域名稱
    'endpoint' => 'ccc.cn-shanghai.aliyuncs.com'
]);
$cccClient = new CCC($config);
// 初始化 request
$getInstanceRequest = new GetInstanceRequest([
    "instanceId" => "ccc-test"
]);
// 初始化運行時配置
$runtime = new RuntimeOptions([]);
$resp = $cccClient->getInstanceWithOptions($getInstanceRequest, $runtime);
// 輸出狀態代碼
echo $resp->statusCode;
// 輸出響應
var_dump($resp);

預設憑據鏈

當您的程式開發環境和生產環境採用不同的憑據類型，常見做法是在代碼中擷取當前環境資訊，編寫擷取不同憑據的分支代碼。藉助Credentials工具的預設憑據鏈，您可以用同一套代碼，通過程式之外的配置來控制不同環境下的憑據擷取方式。當您在不傳入參數的情況下，直接使用$credential = new Credential();初始化憑據用戶端時，阿里雲SDK將會嘗試按照如下順序尋找相關憑據資訊。

1. 使用環境變數

如果未找到系統屬性中的憑據資訊，Credentials工具會繼續檢查環境變數。

如果 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 均存在且非空，則使用它們作為預設憑據。
如果同時設定了 ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET 和 ALIBABA_CLOUD_SECURITY_TOKEN，則使用STS Token作為預設憑據。

2. 使用OIDC RAM角色

如果仍未擷取到憑據資訊，Credentials工具會檢查以下與OIDC RAM角色相關的環境變數：

ALIBABA_CLOUD_ROLE_ARN：RAM角色名稱ARN。
ALIBABA_CLOUD_OIDC_PROVIDER_ARN：OIDC供應商ARN。
ALIBABA_CLOUD_OIDC_TOKEN_FILE：OIDC Token檔案路徑。

如果以上三個環境變數均存在且非空，Credentials將會使用變數內容調用STS服務的AssumeRoleWithOIDC介面換取STS Token作為預設憑據。

3. 使用config.json設定檔

如果仍未擷取到憑據資訊，Credentials工具會嘗試從預設路徑載入config.json設定檔，並擷取指定的憑據作為預設憑據。該檔案的預設完整路徑如下：

Linux/Mac：~/.aliyun/config.json
Windows： C:\Users\USER_NAME\.aliyun\config.json

如果您需要通過此方式配置憑據，您可以使用阿里雲CLI工具配置憑據，或手動在相應路徑下建立config.json設定檔。內容格式樣本如下：

{
  "current": "<PROFILE_NAME>",
  "profiles": [
    {
      "name": "<PROFILE_NAME>",
      "mode": "AK",
      "access_key_id": "<ALIBABA_CLOUD_ACCESS_KEY_ID>",
      "access_key_secret": "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>"
    },
    {
      "name": "<PROFILE_NAME1>",
      "mode": "StsToken",
      "access_key_id": "<ALIBABA_CLOUD_ACCESS_KEY_ID>",
      "access_key_secret": "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>",
      "sts_token": "<SECURITY_TOKEN>"
    },
    {
      "name":"<PROFILE_NAME2>",
      "mode":"RamRoleArn",
      "access_key_id":"<ALIBABA_CLOUD_ACCESS_KEY_ID>",
      "access_key_secret":"<ALIBABA_CLOUD_ACCESS_KEY_SECRET>",
      "ram_role_arn":"<ROLE_ARN>",
      "ram_session_name":"<ROLE_SESSION_NAME>",
      "expired_seconds":3600
    },
    {
      "name":"<PROFILE_NAME3>",
      "mode":"EcsRamRole",
      "ram_role_name":"<RAM_ROLE_ARN>"
    },
    {
      "name":"<PROFILE_NAME4>",
      "mode":"OIDC",
      "oidc_provider_arn":"<OIDC_PROVIDER_ARN>",
      "oidc_token_file":"<OIDC_TOKEN_FILE>",
      "ram_role_arn":"<ROLE_ARN>",
      "ram_session_name":"<ROLE_SESSION_NAME>",
      "expired_seconds":3600
    },
    {
      "name":"<PROFILE_NAME5>",
      "mode":"ChainableRamRoleArn",
      "source_profile":"<PROFILE_NAME>",
      "ram_role_arn":"<ROLE_ARN>",
      "ram_session_name":"<ROLE_SESSION_NAME>",
      "expired_seconds":3600
    }
  ]
}

參數名稱

參數介紹

current

指定憑據名稱以擷取相應的憑據配置資訊，其值為profiles中參數name的值。預設情況下，系統優先使用環境變數 ALIBABA_CLOUD_PROFILE 指定的憑據名稱；若該環境變數未配置，則將使用current指定的憑據名稱。

profiles

憑據資訊集合。通過參數mode指定憑據的類型：

AK：使用使用者的AccessKey作為憑據資訊；
StsToken：使用STS Token作為憑據資訊；
RamRoleArn：通過RAM使用者扮演RAM角色擷取憑證資訊。
EcsRamRole：通過執行個體中繼資料擷取憑據資訊；
OIDC：通過OIDC身份供應商ARN、OIDC Token和RAM角色ARN擷取憑據資訊；
ChainableRamRoleArn：採用角色鏈的方式，通過source_profile指定profiles中其他憑據的名稱，以重新擷取新的憑據資訊。

4. 使用ECS執行個體RAM角色

如果未找到更高優先順序的憑據資訊，Credentials會嘗試通過ECS執行個體綁定的RAM角色擷取憑據。預設情況下，Credentials會使用加固模式（IMDSv2）訪問ECS的中繼資料服務（Meta Data Server），以擷取ECS執行個體RAM角色的STS Token作為預設憑據資訊。程式會自動訪問ECS的中繼資料服務拿到RoleName資訊，再去擷取憑證，也就是兩次請求。若想減少一次請求，可以直接在環境變數中配置 ALIBABA_CLOUD_ECS_METADATA 來指定執行個體RAM角色名稱。在使用加固模式時若發生異常，將使用普通模式兜底來擷取訪問憑據。您也可以通過設定環境變數 ALIBABA_CLOUD_IMDSV1_DISABLE，執行不同的異常處理邏輯：

當值為false時，會使用普通模式繼續擷取訪問憑據。
當值為true時，表示只能使用加固模式擷取訪問憑據，會拋出異常。

服務端是否支援IMDSv2，取決於您在伺服器的配置。

另外，您可以通過配置環境變數ALIBABA_CLOUD_ECS_METADATA_DISABLED=true來關閉ECS中繼資料的憑證訪問。

說明

關於ECS執行個體中繼資料的介紹，請參見執行個體中繼資料。
如何為ECS和ECI執行個體授予RAM角色，具體操作請參見建立RAM角色和為ECI執行個體授予執行個體RAM角色。

5. 使用Credentials工具URI

如果仍未擷取到憑據資訊，Credentials工具會檢查環境變數 ALIBABA_CLOUD_CREDENTIALS_URI，如果該變數存在且指向一個有效URI地址，Credentials通過訪問該URI來擷取STS Token作為預設憑據。

自訂憑證提供者鏈

可通過自訂程式鏈代替預設程式鏈的尋找順序，也可以自行編寫閉包傳入提供者。

<?php

use AlibabaCloud\Credentials\Providers\ChainProvider;

ChainProvider::set(
        ChainProvider::ini(),
        ChainProvider::env(),
        ChainProvider::instance()
);

Session類型憑據自動重新整理機制

Session類型憑據包含ram_role_arn、ecs_ram_role、oidc_role_arn以及credentials_uri，該類型憑據在Credentials工具中內建了憑據自動重新整理機制。當憑據用戶端首次擷取憑據後，Credentials工具會將擷取的憑據資訊儲存至緩衝中。在後續使用過程中，同一憑據用戶端執行個體將自動從緩衝中提取憑據；若緩衝中的憑據資訊已到期，則憑據用戶端執行個體將重新擷取憑據，並更新緩衝中的值。

說明

對於ecs_ram_role類型憑據，Credentials工具將會在緩衝中的值到期前15分鐘進行提前重新整理。

下面將採用單例模式建立憑據用戶端，通過多個時間段擷取憑據來驗證憑據重新整理機制，並通過調用OpenAPI確保所擷取的憑據處於可用狀態。

<?php

namespace Sample;

require_once 'vendor/autoload.php';

use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\Credentials\Credential\Config as CredentialConfig;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use Darabonba\OpenApi\Models\Config as OpenApiConfig;
use RuntimeException;

class Sample
{
    /**
     * @var Credential|null
     */
    private static $credentialInstance = null;

    /**
     * @return Credential
     * @throws RuntimeException
     */
    private static function getCredentialClient(): Credential
    {
        if (self::$credentialInstance === null) {
            try {
                $config = new CredentialConfig([
                    'type' => 'ram_role_arn',
                    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
                    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
                    'roleArn' => getenv('ALIBABA_CLOUD_ROLE_ARN'),
                    'roleSessionName' => 'RamRoleArnTest',
                    'roleSessionExpiration' => 3600,
                ]);

                self::$credentialInstance = new Credential($config);
            } catch (\Exception $e) {
                throw new RuntimeException("Credential initialization failed: " . $e->getMessage(), 0, $e);
            }
        }

        return self::$credentialInstance;
    }

    /**
     * @var Ecs|null
     */
    private static $ecsClientInstance = null;

    /**
     * @return Ecs
     * @throws RuntimeException
     */
    private static function getEcsClient(): Ecs
    {
        if (self::$ecsClientInstance === null) {
            try {
                $config = new OpenApiConfig([
                    'credential' => self::getCredentialClient(),
                    'endpoint' => 'ecs.cn-hangzhou.aliyuncs.com'
                ]);

                self::$ecsClientInstance = new Ecs($config);
            } catch (\Exception $e) {
                throw new RuntimeException("ECS client initialization failed: " . $e->getMessage(), 0, $e);
            }
        }

        return self::$ecsClientInstance;
    }

    public static function main(): void
    {
        $task = function () {
            // 擷取憑證並列印
            $credentialClient = self::getCredentialClient();
            $credential = $credentialClient->getCredential();

            echo date('c') . PHP_EOL;
            echo "AK ID: {$credential->accessKeyId}" . PHP_EOL;
            echo "AK Secret: {$credential->accessKeySecret}" . PHP_EOL;
            echo "STS Token: {$credential->securityToken}" . PHP_EOL;

            // 調用 ECS 介面驗證憑據是否可用
            $ecsClient = self::getEcsClient();
            $request = new DescribeRegionsRequest();

            try {
                $response = $ecsClient->describeRegions($request);
                echo sprintf("Invoke result: %d" . PHP_EOL, $response->statusCode);
            } catch (\Exception $e) {
                throw new RuntimeException("ECS client execution failed: " . $e->getMessage(), 0, $e);
            }
        };

        call_user_func($task); // 0秒調用

        sleep(600); // 等待600秒
        call_user_func($task);

        sleep(3600); // 等待3600秒
        call_user_func($task);

        sleep(100); // 等待100秒
        call_user_func($task);
    }
}

// 執行主函數
Sample::main();

根據日誌顯示結果進行分析：

在第一次調用時，由於未緩衝憑據資訊，系統根據配置擷取憑據資訊。擷取到憑據後，憑據資訊被儲存在緩衝中。
第二次調用所使用的憑據資訊與第一次相同，表明第二次調用是從緩衝中提取的憑據資訊。
第三次調用時，由於憑據的到期時間（RoleSessionExpiration）被設定為3600秒，而第三次調用發生在第一次調用之後的4200秒，此時緩衝中的憑據已到期。因此，SDK依據自動重新整理機制重新擷取了新的憑據資訊，並將新擷取的憑據資訊再次儲存於緩衝中。
第四次調用所使用的憑據資訊與第三次重新擷取的憑據資訊一致，這表明緩衝中的憑據在到期後已被更新為新的憑據。

Alibaba Cloud SDK：管理訪問憑據

背景資訊

前提條件

安裝Credentials工具

Credentials工具配置參數介紹

初始化憑據用戶端

方式一：使用預設憑據鏈

介面調用樣本

方式二：使用AK

介面調用樣本

方式三：使用STS Token

介面調用樣本

方式四：使用AK及RamRoleArn

介面調用樣本

方式五：使用ECS執行個體RAM角色

介面調用樣本

方式六：使用OIDCRoleArn

介面調用樣本

方式七：使用URI憑據

介面調用樣本

方式八：使用Bearer Token

介面調用樣本

預設憑據鏈

1. 使用環境變數

2. 使用OIDC RAM角色

3. 使用config.json設定檔

4. 使用ECS執行個體RAM角色

5. 使用Credentials工具URI

自訂憑證提供者鏈

Session類型憑據自動重新整理機制

相關文檔