balenakeys

README

vault-plugin-secrets-balena

This is a Vault plugin to manage API Keys for the IoT Platform Balena

Try it out!

You can run a set of commands to enable the secrets engine at /balena in Vault.

Then, you can write a configuration and a role based on a Balena account.

NOTE: Each role requires a different Balena account and balenaApiKey (Session Token) associated with that account

Finally, you can read the credentials for the role.

$ CGO_ENABLED=0 go build -ldflags="-extldflags=-static" -o vault/plugins/vault-plugin-secrets-balena cmd/vault-plugin-secrets-balena/main.go

Once built, copy the binary to your vault plugins folder. Then run the following to active the engine:

$ SHA256=$(sha256sum vault/plugins/vault-plugin-secrets-balena | cut -d ' ' -f1)

vault plugin register -sha256=$SHA256 secret vault-plugin-secrets-hashicups
Success! Registered plugin: vault-plugin-secrets-balena

vault secrets enable -path=balena vault-plugin-secrets-balena
Success! Enabled the vault-plugin-secrets-balena secrets engine at: balena/

vault write balena/config url="https://api.balena-cloud.com"
Success! Data written to: balena/config

vault write balen/role/developer balenaApiKey="${BALENA_SESSION_TOKEN}" ttl="5m" max_ttl="1h"
Success! Data written to: balena/role/developer

vault read balena/creds/developer
Key                Value
---                -----
lease_id           balena/creds/default/tVsj1JusAp8mW2vgD3FqAnxf
lease_duration     5m
lease_renewable    true
key_desc           this is a test token managed by Vault
key_name           test-balena-apikey
token              Aej6vxnlTA4ifgH8Ak16Jtj8oGjjlALQ
token_id           5f83a6ee-3b51-44e4-9744-76e467762fde

Copy the token and set it to the TOKEN environment variable.

export TOKEN="Bearer Aej6vxnlTA4ifgH8Ak16Jtj8oGjjlALQ"

Call the Balena API to test the token.

$ curl -i -X GET -H "Authorization: ${TOKEN}" -H  "Content-Type: application/json" https://api.balena-cloud.com/user/v1/whoami

TTP/2 200 
date: Mon, 25 Sep 2023 15:01:50 GMT
content-type: application/json; charset=utf-8
content-length: 70
etag: W/"46-n2a7afpiWLDYhYthxsDKLupNKGg"
vary: Accept-Encoding
cf-cache-status: DYNAMIC
strict-transport-security: max-age=15552000
server: cloudflare
cf-ray: 80c4250e0fa6ec80-SEA
alt-svc: h3=":443"; ma=86400

{"id":54623,"username":"developer_87","email":"developer@mydomain.com"}

Revoke the lease for the Balena token in Vault.

$ vault lease revoke balena/creds/developer/tVsj1JusAp8mW2vgD3FqAnxf

All revocation operations queued successfully!

If you try to call the Balena API again, you'll find that the token is no longer valid.

$ curl -i -X GET -H "Authorization: ${TOKEN}" -H  "Content-Type: application/json" https://api.balena-cloud.com/user/v1/whoami

HTTP/2 401 
date: Mon, 25 Sep 2023 15:03:01 GMT
cf-cache-status: DYNAMIC
strict-transport-security: max-age=15552000
server: cloudflare
cf-ray: 80c426cbac1f2841-SEA
alt-svc: h3=":443"; ma=86400

Additional references:

• Upgrading Plugins
• List of Vault Plugins

FAQ

Session Tokens

Currently API keys generated for an account cannot generate new API Keys, so you have to use the Session Token when configuring the role. It expires every 7 days so must be rotated. You can automate this with scripting.

Documentation

Index

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

Functions

func Factory

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

Factory returns a new backend as logical.Backend