cloudflare

README

Vault Secrets Plugin - Cloudflare

Vault secrets plugins to simplify creation, management, and revocation of Cloudflare API tokens.

This is a fork of https://github.com/bloominlabs/vault-plugin-secrets-cloudflare, created because I wanted to see a version with the following changes:

1. Built with updated Go
2. Built with updated cloudflare-go
3. Built with updated vault/api
4. Built with updated vault/sdk
5. Improved the README to support usability.
6. Various other code improvements.

Usage

Configure Endpoint

1. Download and enable plugin locally

2. Configure the plugin with a Cloudflare token capable of generating other tokens:

vault write /cloudflare/config/token token=<token>

Configure Policies

Note when creating policies the Cloudflare API docs are of help:

• Token Creation information: https://developers.cloudflare.com/api/operations/user-api-tokens-create-token
  • Note that only the contents of the policies block is required, not the name or condition block etc.
• The id values in the permission_groups correspond to the relevant permission groups on Cloudflare. The doc at https://developers.cloudflare.com/api/operations/permission-groups-list-permission-groups can be used as a reference to retrieve a list of values to use.
• The resources block references the domains on which the permissions are applied.
• A list of zones and their details can be retrieved via the Cloudflare API, see https://developers.cloudflare.com/api/operations/zones-get for an example.

An example policy which allows for reading and editing of DNS records on a zone with the id 069d3066870c958bad1cd2a767b78g86 is included below.

1. Create a role and supply an appropriate policy:

$ vault write /cloudflare/roles/test-role policy_document=-<<EOF
[
  {
        "effect": "allow",
        "permission_groups": [
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "name": "DNS Read"
          },
          {
            "id": "4755a26eedb94da69e1066d98aa820be",
            "name": "DNS Write"
          }
        ],
        "resources": {
          "com.cloudflare.api.account.zone.069d3066870c958bad1cd2a767b78g86": "*"
        }
  }
]
EOF

Read the configuration of a role:

$ vault read cloudflare/roles/test-role
Key                Value
---                -----
policy_document    [{"effect":"allow","permission_groups":[{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"},{"id":"4755a26eedb94da69e1066d98aa820be","name":"DNS Write"}],"resources":{"com.cloudflare.api.account.zone.069d3066870c958bad1cd2a767b78g86":"*"}}]

Generate a new Token

Perform a 'read' operation on the creds/<role-name> endpoint.

$ vault read cloudflare/creds/test-role
Key                Value
---                -----
lease_id           cloudflare/creds/test-role/956Fo9MQgleoqosK5wuMVwPC
lease_duration     768h
lease_renewable    true
id                 9c40db059267e91c7f3f22220c1536ed
token              <token>

Rotating the Root Token

The plugin supports rotating the configured admin token to seamlessly improve security.

To rotate the token, perform a forced write operation on the config/rotate-root endpoint:

> vault write -f cloudflare/config/rotate-root
Key      Value
---      -----
name     vault-admin-{timestamp in nano seconds}

Documentation

Index

• Constants
• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Constants

const (
	SecretTokenType = "token"
)

Functions

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Factory configures and returns Cloudflare backends