Skip to content

Latest commit

 

History

History
211 lines (180 loc) · 8.5 KB

README-CN.md

File metadata and controls

211 lines (180 loc) · 8.5 KB

English | 简体中文

Alibaba Cloud Credentials for Go

Latest Stable Version Go Report Card codecov License Travis Build Status Appveyor Build Status Scrutinizer Code Quality

Alibaba Cloud Credentials for Go 是帮助 GO 开发者管理凭据的工具。

本文将介绍如何获取和使用 Alibaba Cloud Credentials for Go。

要求

  • 请确保你的系统安装了不低于 1.10.x 版本的 Go 环境。

安装

使用 go get 下载安装

$ go get -u github.com/aliyun/credentials-go

如果你使用 dep 来管理你的依赖包，你可以使用以下命令:

$ dep ensure -add  github.com/aliyun/credentials-go

##快速使用 在您开始之前，您需要注册阿里云帐户并获取您的凭证。

凭证类型

AccessKey

通过用户信息管理设置 access_key，它们具有该账户完全的权限，请妥善保管。有时出于安全考虑，您不能把具有完全访问权限的主账户 AccessKey 交于一个项目的开发者使用，您可以创建RAM子账户并为子账户授权，使用RAM子用户的 AccessKey 来进行API调用。

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                  "access_key",       // 凭证类型
		AccessKeyId:           "AccessKeyId",      // AccessKeyId
		AccessKeySecret:       "AccessKeySecret",  // AccessKeySecret
    }
	akCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	accessKeyId, err := akCredential.GetAccessKeyId()
	accessSecret, err := akCredential.GetAccessSecret()
	credentialType := akCredential.GetType()
}

STS

通过安全令牌服务（Security Token Service，简称 STS），申请临时安全凭证（Temporary Security Credentials，简称 TSC），创建临时安全凭证。

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                  "sts",              // 凭证类型
		AccessKeyId:           "AccessKeyId",      // AccessKeyId
		AccessKeySecret:       "AccessKeySecret",  // AccessKeySecret
		SecurityToken:         "SecurityToken",    // STS Token
    }
	stsCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	accessKeyId, err := stsCredential.GetAccessKeyId()
	accessSecret, err := stsCredential.GetAccessSecret()
	securityToken, err := stsCredential.GetSecurityToken()
	credentialType := stsCredential.GetType()
}

RamRoleArn

通过指定RAM角色，让凭证自动申请维护 STS Token。你可以通过为 Policy 赋值来限制获取到的 STS Token 的权限。

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                   "ram_role_arn",     // 凭证类型
		AccessKeyId:            "AccessKeyId",      // AccessKeyId
		AccessKeySecret:        "AccessKeySecret",  // AccessKeySecret
		RoleArn:                "RoleArn",          // 格式: acs:ram::用户Id:role/角色名
		RoleSessionName:        "RoleSessionName",  // 角色会话名称
		Policy:                 "Policy",           // 可选, 限制 STS Token 的权限
		RoleSessionExpiration:  3600,               // 可选, 限制 STS Token 的有效时间
    }
	arnCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	accessKeyId, err := arnCredential.GetAccessKeyId()
	accessSecret, err := arnCredential.GetAccessSecret()
	securityToken, err := arnCredential.GetSecurityToken()
	credentialType := arnCredential.GetType()
}

EcsRamRole

通过指定角色名称，让凭证自动申请维护 STS Token

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                   "ecs_ram_role",     // 凭证类型
		RoleName:               "RoleName",         // 账户RoleName，非必填，不填则自动获取，建议设置，可以减少请求
    }
	ecsCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	accessKeyId, err := ecsCredential.GetAccessKeyId()
	accessSecret, err := ecsCredential.GetAccessSecret()
	securityToken, err := ecsCredential.GetSecurityToken()
	credentialType := ecsCredential.GetType()
}

RsaKeyPair

通过指定公钥Id和私钥文件，让凭证自动申请维护 AccessKey。仅支持日本站。

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                   "rsa_key_pair",       // 凭证类型
		PrivateKeyFile:         "PrivateKeyFile",     // PrivateKey文件路径
		PublicKeyId:            "PublicKeyId",        // 账户PublicKeyId
    }
	rsaCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	accessKeyId, err := rsaCredential.GetAccessKeyId()
	accessSecret, err := rsaCredential.GetAccessSecret()
	securityToken, err := rsaCredential.GetSecurityToken()
	credentialType := rsaCredential.GetType()
}

Bearer Token

如呼叫中心(CCC)需用此凭证，请自行申请维护 Bearer Token。

import (
	"github.com/aliyun/credentials-go/credentials"
)

func main(){
	config := &credentials.Config{
		Type:                 "bearer",       // 凭证类型
		BearerToken:          "BearerToken",  // BearerToken
    }
	bearerCredential, err := credentials.NewCredential(config)
	if err != nil {
		return err
	}
	bearerToken := bearerCredential.GetBearerToken()
	credentialType := bearerCredential.GetType()
}

凭证提供程序链

如果你调用 NewCredential() 时传入空， 将通过凭证提供链来为你获取凭证。

1. 环境凭证

程序首先会在环境变量里寻找环境凭证，如果定义了 ALICLOUD_ACCESS_KEY 和 ALICLOUD_SECRET_KEY 环境变量且不为空，程序将使用他们创建凭证。如否则，程序会在配置文件中加载和寻找凭证。

2. 配置文件

如果用户主目录存在默认文件 ~/.alibabacloud/credentials （Windows 为 C:\Users\USER_NAME\.alibabacloud\credentials），程序会自动创建指定类型和名称的凭证。默认文件可以不存在，但解析错误会抛出异常。也可以手动加载指定文件： AlibabaCloud::load('/data/credentials', 'vfs://AlibabaCloud/credentials', ...); 不同的项目、工具之间可以共用这个配置文件，因为超出项目之外，也不会被意外提交到版本控制。Windows 上可以使用环境变量引用到主目录 %UserProfile%。类 Unix 的系统可以使用环境变量 $HOME 或 ~ (tilde)。 可以通过定义 ALIBABA_CLOUD_CREDENTIALS_FILE 环境变量修改默认文件的路径。

[default]                          # 默认凭证
type = access_key                  # 认证方式为 access_key
access_key_id = foo                # access key id
access_key_secret = bar            # access key secret

3. 实例 RAM 角色

如果定义了环境变量 ALIBABA_CLOUD_ECS_METADATA 且不为空，程序会将该环境变量的值作为角色名称，请求 http://100.100.100.200/latest/meta-data/ram/security-credentials/ 获取临时安全凭证。

许可证

Apache-2.0

Copyright (c) 2009-present, Alibaba Cloud All rights reserved.