全部產品
Search

搜尋本產品

    Alibaba Cloud SDK：管理訪問憑據

    文件中心

    Alibaba Cloud SDK：管理訪問憑據

    更新時間：Oct 18, 2024

    當您通過阿里雲SDK調用OpenAPI進行資源操作時，必須正確配置憑證資訊。阿里雲的Credentials工具提供了一套強大的功能，使您能夠輕鬆地擷取和管理這些訪問憑證。無論是利用預設憑證，AccessKey（AK），還是Security Token Service（STS）令牌等，Credentials工具都能為您提供相應支援。此外，本文檔將詳細闡述如何根據優先順序使用預設憑證。您將深入理解如何在阿里雲SDK中配置和維護憑證，從而確保您對雲資源的操作既有效率又具有高度安全性。

    背景資訊

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

    1. 阿里雲主帳號和RAM使用者的永久憑據 AccessKey（簡稱AK）是由AccessKey ID和AccessKey Secret組成的金鑰組。

    2. 阿里雲RAM角色的STS臨時訪問Token，簡稱STS Token。它是可以自訂時效和存取權限的臨時身份憑據，詳情請參見什麼是STS。

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

    1. 使用最新發行Credentials依賴包，確保所有憑證支援。

    2. 請查看CHANGELOG.md擷取所有發行的版本列表。

    初始化憑據用戶端

    Credentials工具支援多種方式初始化憑據用戶端，您可根據實際情況選擇合適的方式進行憑據用戶端初始化。

    重要

    在專案中使用明文AccessKey，容易因代碼倉庫許可權管理不當造成AccessKey泄露，會威脅該帳號下所有資源的安全。建議通過環境變數、設定檔等方式擷取AccessKey。

    方式一：使用預設憑據鏈

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

    <?php

use AlibabaCloud\Credentials\Credential;

// 不指定參數
$credential = new Credential();
$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

    阿里雲帳號、RAM使用者可產生調用OpenAPI的金鑰組AK。如何擷取AK請參見文檔建立AccessKey。您可使用AK初始化憑據用戶端。

    警告

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

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

    <?php

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

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

    介面調用方法

    通過Credentials工具讀取AK，完成雲產品OpenAPI介面的調用。

    本樣本以調用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

    以一個RAM使用者的身份調用STS服務的AssumeRole介面，設定Token的最大到期時間，即可換取到臨時憑據STS Token。以下樣本示範如何使用STS Token初始化憑據用戶端（不包含如何擷取到STS Token的過程）。

    <?php

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

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

    介面調用方法

    通過Credentials工具讀取臨時安全性權杖（STS Token），完成雲產品OpenAPI介面的調用。

    本樣本以調用Elastic Compute Service的DescribeRegions介面為例，因此需先安裝Elastic Compute Service SDK和Security Token Service 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\SDK\Sts\V20150401\Models\AssumeRoleRequest;
use AlibabaCloud\SDK\Sts\V20150401\Sts;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;

// 建立STS Client，並調用assumeRole方法擷取臨時憑證。
$config = new Config([
    // 從環境變數擷取AccessKeyId、AccessKeySecret，如果未設定，請設定後運行。
    'accessKeyId' => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    'accessKeySecret' => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    'regionId' => 'cn-hangzhou',
]);
$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;

$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工具時，將自動擷取執行個體綁定的RAM角色，並通過訪問中繼資料服務擷取RAM角色的STS Token，以完成憑據用戶端的初始化。

    執行個體中繼資料服務器支援加固模式和普通模式兩種訪問方式，Credentials工具預設使用加固模式（IMDSv2）擷取訪問憑據。若使用加固模式時發生異常，您可以通過設定disableIMDSv1來執行不同的異常處理邏輯：

    1. 當值為false（預設值）時，會使用普通模式繼續擷取訪問憑據。

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

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

    說明 
    <?php

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

$credConfig = new Config([
    'type' => 'ecs_ram_role',
    // 選填，該ECS角色的角色名稱，不填會自動擷取，但是建議加上以減少請求次數，可以通過環境變數ALIBABA_CLOUD_ECS_METADATA設定role_name
    'roleName' => '<RoleName>',
    // 'disableIMDSv1' => false,
]);
$credClient = new Credential($credConfig);
$credential = $credClient->getCredential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
$credential->getSecurityToken();

    介面調用方法

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

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

    注入的環境變數如下：

    ALIBABA_CLOUD_ROLE_ARN：RAM角色名稱ARN；

    ALIBABA_CLOUD_OIDC_PROVIDER_ARN：OIDC供應商ARN；

    ALIBABA_CLOUD_OIDC_TOKEN_FILE：OIDC Token檔案路徑；

    <?php

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

// 使用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 Token。Credentials工具通過您提供的URI擷取STS Token，完成憑據用戶端初始化。

    <?php

namespace AlibabaCloud\SDK\Sample;

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

// 使用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();

    介面調用方法

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

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

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

    介面調用方法

    本樣本以調用話務中心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（密鑰Key） 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET（密鑰Value） 不為空白，Credentials工具會優先使用它們作為預設憑據。

    • 如果系統內容變數ALIBABA_CLOUD_ACCESS_KEY_ID（密鑰Key）、ALIBABA_CLOUD_ACCESS_KEY_SECRET（密鑰Value）、ALIBABA_CLOUD_SECURITY_TOKEN（Token）均不為空白，Credentials工具會優先使用STS Token作為預設憑據。

    2. 使用OIDC RAM角色

    若不存在優先順序更高的憑據資訊，Credentials工具會在環境變數中擷取如下內容：

    ALIBABA_CLOUD_ROLE_ARN：RAM角色名稱ARN；

    ALIBABA_CLOUD_OIDC_PROVIDER_ARN：OIDC供應商ARN；

    ALIBABA_CLOUD_OIDC_TOKEN_FILE：OIDC Token檔案路徑；

    若以上三個環境變數都已設定內容，Credentials將會使用變數內容調用STS服務的AssumeRoleWithOIDC - OIDC角色SSO時擷取扮演角色的臨時身份憑證介面換取STS Token作為預設憑據。

    3. 使用config.json設定檔

    若不存在優先順序更高的憑據資訊，Credentials工具會優先在如下位置尋找config.json檔案是否存在：

    Linux系統：~/.aliyun/config.json

    Windows系統： C:\Users\USER_NAME\.aliyun\config.json

    如果檔案存在，程式將會使用設定檔中current 指定的憑據資訊初始化憑據用戶端。當然，您也可以通過環境變數 ALIBABA_CLOUD_PROFILE 來指定憑據資訊，例如設定 ALIBABA_CLOUD_PROFILE 的值為client1。

    在config.json設定檔中每個mode的值代表了不同的憑據資訊擷取方式：

    • AK：使用使用者的Access Key作為憑據資訊；

    • RamRoleArn：使用RAM角色的ARN來擷取憑據資訊；

    • EcsRamRole：利用ECS綁定的RAM角色來擷取憑據資訊；

    • OIDC：通過OIDC ARN和OIDC Token來擷取憑據資訊；

    • ChainableRamRoleArn：採用角色鏈的方式，通過指定JSON檔案中的其他憑據，以重新擷取新的憑據資訊。

    配置樣本資訊如下：

    {
	"current": "default",
	"profiles": [
		{
			"name": "default",
			"mode": "AK",
			"access_key_id": "<ALIBABA_CLOUD_ACCESS_KEY_ID>",
			"access_key_secret": "<ALIBABA_CLOUD_ACCESS_KEY_SECRET>"
		},
		{
			"name":"client1",
			"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":"client2",
			"mode":"EcsRamRole",
			"ram_role_name":"<RAM_ROLE_ARN>"
		},
		{
			"name":"client3",
			"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":"client4",
			"mode":"ChainableRamRoleArn",
			"source_profile":"<PROFILE_NAME>",
			"ram_role_arn":"<ROLE_ARN>",
			"ram_session_name":"<ROLE_SESSION_NAME>",
			"expired_seconds":3600
		}
	]
}

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

    若不存在優先順序更高的憑據資訊，Credentials工具將通過環境變數擷取ALIBABA_CLOUD_ECS_METADATA（ECS執行個體RAM角色名稱）的值。若該變數的值存在，程式將採用加固模式（IMDSv2）訪問ECS的中繼資料服務（Meta Data Server），以擷取ECS執行個體RAM角色的STS Token作為預設憑據資訊。在使用加固模式時若發生異常，將使用普通模式兜底來擷取訪問憑據。您也可以通過設定環境變數ALIBABA_CLOUD_IMDSV1_DISABLED，執行不同的異常處理邏輯：

    1. 當值為false時，會使用普通模式繼續擷取訪問憑據。

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

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

    5. 使用Credentials工具URI

    若不存在優先順序更高的憑據資訊，Credentials工具會在環境變數中擷取ALIBABA_CLOUD_CREDENTIALS_URI，若存在，程式將請求該URI地址，擷取臨時安全憑證作為預設憑據資訊。

    自訂憑證提供者鏈

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

    <?php

use AlibabaCloud\Credentials\Providers\ChainProvider;

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

    如何切換憑據

    當您想要在程式中使用不同的訪問憑據調用不同OpenAPI時，可以通過如下方式。

    使用多個憑據用戶端

    通過初始化多個憑據用戶端，傳入到不同的介面請求用戶端。

    <?php

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

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

$credClient1 = new Credential($credConfig);


$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'),
]);
$credClient2 = new Credential($credConfig);

    相關文檔