Alibaba Cloud Credentials for PHP
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
Some users may not be able to install due to network problems, you can switch to the Alibaba Cloud Composer Mirror.
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.
Setup access_key credential through [User Information Management][ak], it have full authority over the account, please keep it safe. Sometimes for security reasons, you cannot hand over a primary account AccessKey with full access to the developer of a project. You may create a sub-account [RAM Sub-account][ram] , grant its [authorization][permissions]，and use the AccessKey of RAM Sub-account.
<?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' => '<access_key_id>', 'access_key_secret' => '<access_key_secret>', ]); $ak->getAccessKeyId(); $ak->getAccessKeySecret();
Create a temporary security credential by applying Temporary Security Credentials (TSC) through the Security Token Service (STS).
<?php use AlibabaCloud\Credentials\Credential; $sts = new Credential([ 'type' => 'sts', 'access_key_id' => '<access_key_id>', 'accessKey_secret' => '<accessKey_secret>', 'security_token' => '<security_token>', ]); $sts->getAccessKeyId(); $sts->getAccessKeySecret(); $sts->getSecurityToken();
By specifying [RAM Role][RAM Role], the credential will be able to automatically request maintenance of STS Token. If you want to limit the permissions([How to make a policy][policy]) of STS Token, you can assign value for
<?php use AlibabaCloud\Credentials\Credential; $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->getRoleArn(); $ramRoleArn->getRoleSessionName(); $ramRoleArn->getPolicy();
By specifying the role name, the credential will be able to automatically request maintenance of STS Token.
<?php use AlibabaCloud\Credentials\Credential; $ecsRamRole = new Credential([ 'type' => 'ecs_ram_role', 'role_name' => '<role_name>', ]); $ecsRamRole->getRoleName(); // Note: `role_name` is optional. It will be retrieved automatically if not set. It is highly recommended to set it up to reduce requests.
By specifying the public key Id and the private key file, the credential will be able to automatically request maintenance of the AccessKey before sending the request. Only Japan station is supported.
<?php use AlibabaCloud\Credentials\Credential; $rsaKeyPair = new Credential([ 'type' => 'rsa_key_pair', 'public_key_id' => '<public_key_id>', 'private_key_file' => '<private_key_file>', ]); $rsaKeyPair->getPublicKeyId(); $rsaKeyPair->getPrivateKey();
If credential is required by the Cloud Call Centre (CCC), please apply for Bearer Token maintenance by yourself.
<?php use AlibabaCloud\Credentials\Credential; $bearerToken = new Credential([ 'type' => 'bearer_token', 'bearer_token' => '<bearer_token>', ]); $bearerToken->getBearerToken(); $bearerToken->getSignature();
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_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
C:\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 the
[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, optional. It will be retrieved automatically if not set. It is highly recommended to set it up to reduce requests. [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 File
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 (c) 2009-present, Alibaba Cloud All rights reserved.