Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/telia-oss/aws-env
Securely populate environment variables using KMS/SSM/Secrets manager on AWS.
https://github.com/telia-oss/aws-env
aws aws-kms aws-secrets-manager aws-ssm
Last synced: 7 days ago
JSON representation
Securely populate environment variables using KMS/SSM/Secrets manager on AWS.
- Host: GitHub
- URL: https://github.com/telia-oss/aws-env
- Owner: telia-oss
- License: mit
- Created: 2018-07-17T08:17:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-07T20:00:23.000Z (over 2 years ago)
- Last Synced: 2024-06-18T18:45:04.567Z (5 months ago)
- Topics: aws, aws-kms, aws-secrets-manager, aws-ssm
- Language: Go
- Homepage:
- Size: 738 KB
- Stars: 79
- Watchers: 7
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## aws-env
[](https://github.com/telia-oss/aws-env/actions?query=workflow%3Atest)
A small library and binary for securely handling secrets in environment variables on AWS. Supports KMS, SSM Parameter store and secrets manager. Inspired by [ssm-env](https://github.com/remind101/ssm-env).
## Usage
Both the library and binary versions of `aws-env` will loop through the environment and exchange any variables prefixed with
`sm://`, `ssm://` and `kms://` with their secret value from Secrets manager, SSM Parameter store or KMS respectively. In order
for this to work, the instance profile (EC2), task role (ECS), or execution role (Lambda) must have the correct privileges in order
to retrive the secret values and/or decrypt the secret using KMS.
For instance:
- `export SECRETSMANAGER=sm://`
- `export PARAMETERSTORE=ssm://`
- `export KMSENCRYPTED=kms://`
- `export MULTIVALUE=sm://#` (if the secret itself contains JSON).
Where `` is the name of the secret in secrets manager or parameter store. `aws-env` will look up secrets in the region specified
in the `AWS_REGION` or `AWS_DEFAULT_REGION` environment variables, and if they are both unset/empty it will contact the EC2 Metadata endpoint
(if possible) and use the region where it is deployed.
Required IAM privileges:
- Secrets manager: `secretsmanager:GetSecretValue` on the resource. And `kms:Decrypt` if not using the `aws/secretsmanager` key alias.
- SSM Parameter store: `ssm:GetParameter` on the resource. `kms:Decrypt` on the KMS key used to encrypt the secret.
- KMS: `kms:Decrypt` on the key used to encrypt the secret.
#### Binary
Install using [homebrew](https://brew.sh/):
```bash
brew install telia-oss/tap/aws-env
```
Or grab binary from the [releases](https://github.com/telia-oss/aws-env/releases), and start your process with:
```bash
aws-env exec --
```
This will populate all the secrets in the environment, and hand over the process to your `` with the same PID. The
populated secrets are only made available to the `` and 'disappear' when the process exits.
#### Library
Import the library and invoke it prior to parsing flags or reading environment variables:
```go
package main
import (
"fmt"
"github.com/aws/aws-sdk-go/aws/session"
environment "github.com/telia-oss/aws-env"
)
func main() {
// New AWS Session
sess, err := session.NewSession()
if err != nil {
panic(fmt.Errorf("failed to create new aws session: %s", err))
}
// Populate secrets using aws-env
env, err := environment.New(sess)
if err != nil {
panic(fmt.Errorf("failed to initialize aws-env: %s", err))
}
if err := env.Populate(); err != nil {
panic(fmt.Errorf("failed to populate environment: %s", err))
}
}
```
## Security
There are a couple of things to keep in mind when using `aws-env`:
- Spawned processes will inherit their parents environment by default. If your `` spawns new processes they will inherit the environment _with the secrets already populated_, unless you hand-roll the environment for the new process.
- The environment for a running process can be read by the root user (and yourself) _after secrets have been populated_ by running `cat /proc//environ` on Linux, and `ps eww ` on OSX. However, if root or the spawning user is compromised a malicious user can just as easily fetch the secrets directly from the AWS API ¯\\_(ツ)_/¯