English | 简体中文
Alibaba Cloud Credentials for PHP is a tool that helps PHP developers manage their credentials.
Your system needs to meet Prerequisites, including PHP> = 5.6. We strongly recommend using the cURL extension and compiling cURL 7.16.2+ using the TLS backend.
If you have Globally Install Composer on your system, install Alibaba Cloud Credentials for PHP as a dependency by running the following directly in the project directory:
composer require alibabacloud/credentials
See Installation for details on installing through Composer and other means.
Before you begin, you need to sign up for an Alibaba Cloud account and retrieve your Credentials.
<?php
use AlibabaCloud\Credentials\Credential;
// Chain Provider if no Parameter
$credential = new Credential();
$credential->getAccessKeyId();
$credential->getAccessKeySecret();
// Access Key
$ak = new Credential([
'type' => 'access_key',
'access_key_id' => 'foo',
'access_key_secret' => 'bar',
]);
$ak->getAccessKeyId();
$ak->getAccessKeySecret();
// ECS RAM Role
$ecsRamRole = new Credential([
'type' => 'ecs_ram_role',
'role_name' => 'foo',
]);
$ecsRamRole->getAccessKeyId();
$ecsRamRole->getAccessKeySecret();
$ecsRamRole->getSecurityToken();
$ecsRamRole->getExpiration();
// RAM Role ARN
$ramRoleArn = new Credential([
'type' => 'ram_role_arn',
'access_key_id' => 'access_key_id',
'access_key_secret' => 'access_key_secret',
'role_arn' => 'role_arn',
'role_session_name' => 'role_session_name',
'policy' => '',
]);
$ramRoleArn->getAccessKeyId();
$ramRoleArn->getAccessKeySecret();
$ramRoleArn->getSecurityToken();
$ramRoleArn->getExpiration();
// RSA Key Pair
$rsaKeyPair = new Credential([
'type' => 'rsa_key_pair',
'public_key_id' => 'public_key_id',
'private_key_file' => 'private_key_file',
]);
$rsaKeyPair->getAccessKeyId();
$rsaKeyPair->getAccessKeySecret();
$rsaKeyPair->getSecurityToken();
$ramRoleArn->getExpiration();The default credential provider chain looks for available credentials, looking in the following order:
The program first looks for environment credentials in the environment variable. If the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are defined and not empty, the program will use them to create default credentials.
If the user's home directory has the default file
~/.alibabacloud/credentials(Windows isC:\Users\USER_NAME\.alibabacloud\credentials), the program will automatically create credentials with the specified type and name. The default file may not exist, but parsing errors will throw an exception. The voucher name is not case sensitive. If the voucher has the same name, the latter will overwrite the former. This configuration file can be shared between different projects and tools, and it will not be accidentally submitted to version control because it is outside the project. Environment variables can be referenced to the home directory %UserProfile% on Windows. Unix-like systems can use the environment variable $HOME or ~ (tilde). The path to the default file can be modified by defining theALIBABA_CLOUD_CREDENTIALS_FILEenvironment variable.
[default]
type = access_key # Authentication method is access_key
access_key_id = foo # Key
access_key_secret = bar # Secret
[project1]
type = ecs_ram_role # Authentication method is ecs_ram_role
role_name = EcsRamRoleTest # Role Name
[project2]
type = ram_role_arn # Authentication method is ram_role_arn
access_key_id = foo
access_key_secret = bar
role_arn = role_arn
role_session_name = session_name
[project3]
type = rsa_key_pair # Authentication method is rsa_key_pair
public_key_id = publicKeyId # Public Key ID
private_key_file = /your/pk.pem # Private Key 文件If the environment variable ALIBABA_CLOUD_ECS_METADATA is defined and not empty, the program will take the value of the environment variable as the role name and request http://100.100.100.200/latest/meta-data/ram/security-credentials/ to get the temporary Security credentials are used as default credentials.
You can replace the default order of the program chain by customizing the program chain, or you can write the closure to the provider.
<?php
use AlibabaCloud\Credentials\Providers\ChainProvider;
ChainProvider::set(
ChainProvider::ini(),
ChainProvider::env(),
ChainProvider::instance()
);Submit Issue, Problems that do not meet the guidelines may close immediately.
Detailed changes for each version are recorded in the Release Notes.
Please read the Contribution Guide before submitting a Pull Request.
Copyright 1999-2019 Alibaba Group