https://github.com/codemowers/oidc-key-manager
https://github.com/codemowers/oidc-key-manager
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codemowers/oidc-key-manager
- Owner: codemowers
- License: mit
- Created: 2023-05-02T19:15:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-04T11:50:39.000Z (11 months ago)
- Last Synced: 2025-09-11T20:28:30.973Z (10 months ago)
- Language: TypeScript
- Size: 386 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
oidc-key-manager
=================
CLI to manage secret keys required by oidc-gateway
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @codemowers/oidc-key-manager
$ key-manager COMMAND
running command...
$ key-manager (--version)
@codemowers/oidc-key-manager/1.1.2 linux-x64 node-v22.20.0
$ key-manager --help [COMMAND]
USAGE
$ key-manager COMMAND
...
```
# Commands
* [`key-manager initialize`](#key-manager-initialize)
* [`key-manager rotate`](#key-manager-rotate)
## `key-manager initialize`
Initialize the secret with initial keys
```
USAGE
$ key-manager initialize -c local|cluster [--json] [-n ] [-s ] [-l ] [--recreate]
FLAGS
-c, --config= (required) use local or in-cluster Kubernetes config
-l, --additionalLabel=... Add custom Kubernetes label (may be repeated)
-n, --namespace= namespace, defaults to current namespace if service account is used
-s, --secret= [default: oidc-keys] secret name
--recreate recreate the secret if it exists
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Initialize the secret with initial keys
EXAMPLES
$ key-manager initialize
$ key-manager initialize
$ key-manager initialize -n -s
$ key-manager initialize --namespace --secret --recreate
$ key-manager initialize --additional-label "app.kubernetes.io/instance: passmower"
```
_See code: [src/commands/initialize.ts](https://github.com/codemowers/oidc-key-manager/blob/v1.1.2/src/commands/initialize.ts)_
## `key-manager rotate`
Append new JWK|cookie key|both and rotate the array, optionally restarting the deployment
```
USAGE
$ key-manager rotate -c local|cluster [-n ] [-s ] [-l ] [--both] [--jwks]
[--cookie-keys] [--max-number-of-jwks ] [--max-number-of-cookie-keys ] [--restart-deployment-backoff
--restart-deployment ]
FLAGS
-c, --config= (required) use local or in-cluster Kubernetes config
-l, --additionalLabel=... Add custom Kubernetes label (may be repeated)
-n, --namespace= namespace, defaults to current namespace if service account is used
-s, --secret= [default: oidc-keys] secret name
--both rotate both JWKs and cookie keys
--cookie-keys rotate cookie keys
--jwks rotate JWKs
--max-number-of-cookie-keys= [default: 3]
--max-number-of-jwks= [default: 3]
--restart-deployment= Kubernetes deployment name to restart while rotating
--restart-deployment-backoff= [default: 60] Seconds to wait for deployment to restart
DESCRIPTION
Append new JWK|cookie key|both and rotate the array, optionally restarting the deployment
EXAMPLES
$ key-manager rotate
```
_See code: [src/commands/rotate.ts](https://github.com/codemowers/oidc-key-manager/blob/v1.1.2/src/commands/rotate.ts)_