Simple tool to help rotate keys in a suite of cooperating Heroku apps.
Give the auth server in a particualar environment a new key.
$ keyset rekey test
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myweb-test │ 2577d6a9ee4058597188c90f7a9f445b0e6b945cfff1a99e7b768768a19c54a5 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myauth-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myapi-test │ 2577d6a9ee4058597188c90f7a9f445b0e6b945cfff1a99e7b768768a19c54a5 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myapi-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myweb-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myauth-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
Make sure the other API servers have that key. This step uses all the apps configured in the oc-api-<env>
to decide which other apps need to be in sync with the auth server for that environment.
$ keyset sync
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myweb-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myauth-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myapi-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myapi-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myweb-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myauth-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
Look to see if all the keys match.
$ keyset check
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myweb-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myauth-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ test │ myapi-test │ b945cfff1a99e7b768768a19c54a52577d6a9ee4058597188c90f7a9f445b0e6 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
┌──────────┬─────────────────────────┬──────────────────────────────────────────────────────────────────┐
│ Env │ App │ Key │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myapi-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myweb-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
├──────────┼─────────────────────────┼──────────────────────────────────────────────────────────────────┤
│ prod │ myauth-prod │ 808c81be713d7a7b65e8fc89e06c614a46d3476566bb59113622915137fa5bc9 │
└──────────┴─────────────────────────┴──────────────────────────────────────────────────────────────────┘
$ npm install -g keyset
Put a file like this at ~/.keyset.json, or it won't work.
{
"secretKeyName": "HEROKU_CONFIG_NAME_FOR_SECRET_KEY",
"envs": {
"test": {
"auth": "myauth-test",
"apps": [
"myauth-test",
"myweb-test",
"myapi-test"
]
},
"prod": {
"auth": "myauth-prod",
"apps": [
"myauth-prod",
"myweb-prod",
"myapi-prod"
]
}
}
}
MIT.
FAQs
Simple tool to help rotate keys in a suite of cooperating Heroku apps.
The npm package keyset receives a total of 1 weekly downloads. As such, keyset popularity was classified as not popular.
We found that keyset demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.