Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennethwussmann/cognito-cli
Small CLI tool to obtain a JWT from a Cognito userpool
https://github.com/kennethwussmann/cognito-cli
aws cli cognito cognito-cli jwt
Last synced: about 2 months ago
JSON representation
Small CLI tool to obtain a JWT from a Cognito userpool
- Host: GitHub
- URL: https://github.com/kennethwussmann/cognito-cli
- Owner: KennethWussmann
- License: mit
- Created: 2019-02-24T16:05:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-01T07:21:56.000Z (about 1 year ago)
- Last Synced: 2024-10-11T02:24:33.355Z (2 months ago)
- Topics: aws, cli, cognito, cognito-cli, jwt
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :guardsman: cognito-cli
Small CLI tool to obtain a JWT from a Cognito userpools. Supports multiple userpools ordered by stages and MFA.
## :rocket: Usage
- Install globally `npm install -g cogcli`
- Run the global command `cognito` or `cogcli`
- New config will be created at `~/.cognito-cli/config.json`
- Provide credentials in the config file
## :books: Configuration
This is the example `~/.cognito-cli/config.json`:
```JSON
{
"settings": {
"port": 8080
},
"pools": [
{
"name": "Example",
"dev": {
"poolId": "eu-west-1_1234567",
"clientId": "abc123456",
"username": "user",
"password": "OPTIONAL_PASSWORD",
"otpSecret": "OPTIONAL_OTPSECRET"
}
}
]
}
```
> The password and otpSecret are optional. You'll be prompted for them if not added to the config.
With `port` the default port for the local webserver can be globally adjusted.
You can add as many `pools` with `stages`. Example:
```JSON
{
"settings": {
"port": 8080
},
"pools": [
{
"name": "Application 1",
"test123": {
"poolId": "eu-west-1_1234567",
"clientId": "abc123456",
"username": "user",
"password": "OPTIONAL_PASSWORD",
"otpSecret": "OPTIONAL_OTPSECRET"
}
},
{
"name": "Something else",
"hello": {
"poolId": "eu-west-1_1234567",
"clientId": "abc123456",
"username": "user",
"password": "OPTIONAL_PASSWORD"
}
}
]
}
```
## :arrows_clockwise: MFA Support
When the Cognito user requires MFA login:
- You can supply the OTP secret which can be used to generate a token in the config via `otpSecret`
- If no `otpSecret` present you will be prompted to enter the token manually
- You can also use `--token 123456` to supply the token directly
- When using the local webserver you can use the `?token=123456` query parameter with your request
> :bangbang:️ Notice that this tool is for development purposes only.
> Never hold confidential credentials together with MFA secrets in a plain-text file.
## :man_technologist: CLI
You can run the global command `cognito`.
### Running without arguments
When you run just `cognito` without args you will be prompted with all possible pools & stages:
**Shows list of applications configured**
```
? What pool type would you like to use? (Use arrow keys)
❯ Application 1
Application 2
```
**Shows available stages for this application**
```
? What pool type would you like to use? Application 1
? And for what stage?
dev
❯ int
prd
```
**Copies the obtained JWT to your clipboard (macOS, Linux & Windows)**
```
Copied JWT for Application 1 INT to clipboard!
```
### Running with arguments
This CLI tool also allows the following arguments:
```
Usage: cognito [options]
Options:
-V, --version output the version number
-p, --pool [name] Use the pool by [name]
-s, --stage [stage] Use the [stage]
-c, --copy Copy the token directly to clipboard
-S, --server [port] Start a local webserver that can serve tokens
-t, --token [token] Token for MFA challenge
-h, --help display help for command
```
## :globe_with_meridians: Local webserver
Using `cognito -S` will start a local webserver (default on port 8080) that can be used to retrieve a JWT token for pool & stage.
The webserver has the following endpoint:
- `GET /{pool}/{stage}` - Get a fresh JWT token (no caching!)
- `GET /{pool}/{stage}?token=123456` - Get a fresh JWT token with MFA token if required
### Examples
```
$ curl -X GET http://localhost:8080/example/dev
{
"token": "eyJra..."
}
```
That's useful for example in REST clients like Insomnia or Postman to chain requests: Get Token -> Post something.