Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skarpdev/hapi-aws-secrets-manager-emulator
Minimal emulator for AWS Secrets Manager (for use locally and in CI)
https://github.com/skarpdev/hapi-aws-secrets-manager-emulator
Last synced: 11 days ago
JSON representation
Minimal emulator for AWS Secrets Manager (for use locally and in CI)
- Host: GitHub
- URL: https://github.com/skarpdev/hapi-aws-secrets-manager-emulator
- Owner: skarpdev
- Created: 2018-05-29T12:23:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T08:43:14.000Z (about 2 years ago)
- Last Synced: 2023-02-26T20:47:03.050Z (almost 2 years ago)
- Language: JavaScript
- Size: 685 KB
- Stars: 7
- Watchers: 3
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AWS Secrets Manager emulator
Note that since this project was made, [LocalStack](https://github.com/localstack/localstack) has added support for secrets manager. That project is likely to better maintained, than this one.
Available on Docker Hub as [skarpdev/aws-secrets-manager-emulator](https://hub.docker.com/r/skarpdev/aws-secrets-manager-emulator/).
At the moment, an extremely minimal emulator of [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
Supported AWS Secrets Manager features:
- [GetSecretValue](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html)
- [UpdatetSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UpdateSecret.html)
- [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html)
Limitations:
- it ignores secret versions
- it ignores authentication
- it provides an almost entirely hardcoded ARN
Other features:
- it has a UI for simple secret management
- it can preload secrets based on 1-file-1-secret in a given directory
## Configuration
Configuration is done through environment variables.
- `SECRETS_MANAGER_PORT` the port to run on - **default is 3000**
- `SECRETS_MANAGER_PRELOAD_DIRECTORY` absolute path of directory from which to read initial set of secrets (see below) - **default is empty**
- `SECRETS_MANAGER_SECRETS` secrets to preload if you are unable to use volume mounts - **default is empty**
## Preloading secrets
Preloading secrets can be done either via files or by passing a JSON string through an environment variable.
If you define the same SecretId as both a file and in environment - **the version from env will win**.
### Via files
As secrets are really just JSON blobs, we thought it would be easiest just to say that 1 file becomes 1 secret.
In [example-secrets](./example-secrets) you can see, well, an example of this.
`flat` becomes a secret with `SecretId = flat` and secret string is the content of the file.
`hierarchy.one` becomes a secret with `SecretId = hierarchy/one`.
`hierarchy.two` becomes a secret with `SecretId = hierarchy/two`.
You tell the emulator to preload secrets from a directory by assigning an **absolute path** to the environment variable `SECRETS_MANAGER_PRELOAD_DIRECTORY`.
### Via environment variable
You can provide a set of initial secrets by setting the environment variable `SECRETS_MANAGER_SECRETS` to a JSON string.
The pretty-printed object would look like this:
```json
{
"from/env": "{\"key\":\"value\"}",
"kewl": "{\"kinda\":\"ew\"}"
}
```
It is basically a dictionary with a **string key** and a **string value**. The key becomes the SecretId and the value becomes the content.
In Bash the above would look like this:
```bash
SET SECRETS_MANAGER_SECRETS='{"from/env":"{\"key\": \"value\"}","kewl":"{\"kinda\":\"ew\"}"}'
```
## Usage
### docker-compose.yml
```yaml
version: '3'
services:
secretsmanager:
image: skarpdev/aws-secrets-manager-emulator:0.1.0 ## remember to update the version
volumes:
- ./secrets-manager-secrets:/secrets ## preload secrets via files
ports:
- 3000:3000
```
### .gitlab-ci.yml
```yaml
stages:
- test
test-integration:
stage: test
image: $CONTAINER_TEST_IMAGE
variables:
SECRETS_MANAGER_SECRETS: '{"from/env":"{\"key\": \"value\"}","kewl":"{\"kinda\":\"ew\"}"}'
services:
- name: skarpdev/aws-secrets-manager-emulator:0.1.0
alias: secretsmanager
script:
- do your thing
```