hashicorp / vault-plugin-auth-alicloud

Alibaba Auth Plugin for Vault

Vault Plugin: AliCloud Auth Backend

This is a standalone backend plugin for use with Hashicorp Vault. This plugin allows authentication to Vault using Resource Access Management (RAM).

Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault, please responsibly disclose by contacting us at [email protected].

Quick Links

- Vault Website: https://www.vaultproject.io
- AliCloud Auth Docs: https://www.vaultproject.io/docs/auth/alicloud.html
- Main Project Github: https://www.github.com/hashicorp/vault

Getting Started

This is a Vault plugin and is meant to work with Vault. This guide assumes you have already installed Vault and have a basic understanding of how Vault works.

Otherwise, first read this guide on how to get started with Vault.

To learn specifically about how plugins work, see documentation on Vault plugins.

Security Model

This authentication model places Vault in the middle of a call between a client and AliCloud's "GetCallerIdentity" method. Based on AliCloud's response, it grants an access token based on pre-configured roles.

Usage

Please see documentation for the plugin on the Vault website.

This plugin is currently built into Vault and by default is accessed at auth/alicloud. To enable this in a running Vault server:

$ vault auth enable alicloud
Successfully enabled 'alicloud' at 'alicloud'!

To see all the supported paths, see the AliCloud auth backend docs.

Developing

If you wish to work on this plugin, you'll first need Go installed on your machine.

For local dev first make sure Go is properly installed, including setting up a GOPATH. Next, clone this repository into $GOPATH/src/github.com/hashicorp/vault-plugin-auth-alicloud.

To compile a development version of this plugin, run make or make dev. This will put the plugin binary in the bin and $GOPATH/bin folders. dev mode will only generate the binary for your platform and is faster:

$ make
$ make dev

Put the plugin binary into a location of your choice. This directory will be specified as the plugin_directory in the Vault config used to start the server.

plugin_directory = "path/to/plugin/directory"

Start a Vault server with this config file:

$ vault server -config=path/to/config.hcl ...
...

Once the server is started, register the plugin in the Vault server's plugin catalog:

$ vault plugin register \
        -sha256=<SHA256 Hex value of the plugin binary> \
        -command="vault-plugin-auth-alicloud" \
        auth \
        alicloud

Note you should generate a new sha256 checksum if you have made changes to the plugin. Example using openssl:

openssl dgst -sha256 $GOPATH/vault-plugin-auth-alicloud
...
SHA256(.../go/bin/vault-plugin-auth-alicloud)= 896c13c0f5305daed381952a128322e02bc28a57d0c862a78cbc2ea66e8c6fa1

Enable the auth plugin backend using the AliCloud auth plugin:

$ vault auth enable -plugin-name='alicloud' plugin
...

Successfully enabled 'plugin' at 'alicloud'!

Tests

If you are developing this plugin and want to verify it is still functioning (and you haven't broken anything else), we recommend running the tests.

To run the tests, invoke make test:

$ make test

You can also specify a TESTARGS variable to filter tests like so:

$ make test TESTARGS='--run=TestConfig'

Acceptance Tests

Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs in some cases. In the presence of a bug, it is technically possible that broken backends could leave dangling data behind. Therefore, please run the acceptance tests at your own risk. At the very least, we recommend running them in their own private account for whatever backend you're testing.

Acceptance tests require the following environment variables.

export VAULT_AUTH_ACC_TEST_ROLE_ARN=<myrolearn>
export VAULT_AUTH_ACC_TEST_ACCESS_KEY_ID=<myaccesskeyid>
export VAULT_AUTH_ACC_TEST_SECRET_KEY=<mysecretkey>
export VAULT_ACC=1

To run the acceptance tests, invoke make testacc:

$ make testacc

vault-plugin-auth-alicloud's Issues

No support for sts client networks in auth backend

Due to the way that the sts endpoint validation works, if a client is using the vpc endpoints for sts because there is no internet access (intentional), the alicloud auth backend will reject the sts endpoint with the error:

* error making upstream request: expected host of "sts.cn-hangzhou.aliyuncs.com" but received "sts-vpc.cn-hangzhou.aliyuncs.com"

This forces internet access on the Vault server.

The issue lies in this codeset, where the client.Network is not configurable in any way.

https://github.com/hashicorp/vault-plugin-auth-alicloud/blob/main/path_login.go#L258-L284

provide support for the vault identity service

It should be possible to specify what type of value this mount passes to the identity service so that entity aliases can be configured for entities authenticating using this mount.

net/http: TLS handshake timeout

Our project set AliCloud as vault auth method, and config as document described.
vault version: Vault v1.1.3 ('9bc820f700f83a7c4bcab54c5323735a581b34eb')
but still faced following error with small chance.

vault login -method=alicloud
Error authenticating: Error making API request.

URL: PUT https://ip:8200/v1/auth/alicloud/login
Code: 500. Errors:

• error making upstream request: error making request: Post https://sts.aliyuncs.com/?AccessKeyId=&Action=GetCallerIdentity&Format=JSON&RegionId=&SecurityToken=&Signature=&SignatureMethod=HMAC-SHA1&SignatureNonce=&SignatureType=&SignatureVersion=1.0&Timestamp=2019-10-09T09%!A(MISSING)55%!A(MISSING)11Z&Version=2015-04-01: net/http: TLS handshake timeout

When using the latest version of Alibaba Cloud sdk in client, an error occurs

When using the latest version of Alibaba Cloud sdk in client, the following error occurs：

expected host of "sts.aliyuncs.com" but received "sts.us-west-1.aliyuncs.com"

Because latest verstion of Alibaba Cloud sdk of sts service add regionId

is it able to use auth plugin to create a role and grant the policy to get an arn before writing "vault write alibaba/role/role-based role_arn=xxx " without using terraform api

Test Jira sync

Creating a new issue to test Jira sync

alicloud support ttl setting for sts while yr embedded plugin do not support ttl and use default DurationSeconds(3600s)

please add ttl feature seeting support for alicloud sts

btw: suggest using alibaba v2 go sdk.

test jira sync

cross-account validating support

Hi,

Does this plugin support cross-account validating ram roles?
like this:
https://www.vaultproject.io/api-docs/auth/aws/

Authentication failure

Return error when using Aliyun authentication method.

{
  "errors":[
    "error making upstream request: received 400 checking caller identity: {\"RequestId\":\"44854463-55E4-534F-B65B-B54BB34246FF\",\"Message\":\"Specified signature nonce was used already.\",\"Recommend\":\"https://next.api.aliyun.com/troubleshoot?q=SignatureNonceUsed\u0026product=Sts\",\"HostId\":\"sts.cn-zhangjiakou.aliyuncs.com\",\"Code\":\"SignatureNonceUsed\"}"
  ]
}

How to reproduce

1. start vault service in terminal

vault server -dev -log-level=debug

2. Open another terminal and execute the following command

export VAULT_TOKEN=xxx
vault auth enable -path alicloud
vault write auth/alicloud/role/{ram_role_name} arn={your ram_role_name}

4. Execute the login in the terminal

curl -X POST -d @data.json "http://localhost:8200/v1/auth/alicloud/login"

data.json data format

data.json {
  "role":"{ram_role_name}",
  "identity_request_url":"{base_64_url}",
  "identity_request_headers":{
    "Content-Type":[
      "application/json;charset=utf-8"
    ]
  }
}

@jefferai @calvn