README.md

Authum

Awesome authentication tool for connecting command line applications to SAML/OIDC identity and service providers. Authum is the successor to aws-jumpcloud.

Lens Kube Setup

Features

• Support for ANY SAML/OIDC identity and service provider via pluggy plugins. Built-in plugins include:
  • aws
  • jumpcloud
  • okta
• Support for Duo two-factor authentication
• Support for graphical prompts when no TTY is available (e.g. when using Authum with GUI apps)
• Securely stores all sensitive data in the native OS keyring

Installation

1. Install Poetry
   • brew install poetry
2. Clone this repository
3. cd /path/to/repository
4. poetry install
5. make pex
6. Copy dist/athm to a location in $PATH
   • Homebrewers cp dist/athm $(eval brew --prefix)/bin
7. rehash to update binaries in $PATH

Graphical Prompts

tkinter is required for graphical prompts.

Homebrew on macOS

brew install python-tk

Example Usage: Generate Temporary IAM Credentials via Identity Provider Credentials

See aws plugin documentation.

More Help

For help on available commands and options, see the --help output:

athm [command] --help

For debugging, use the --debug option:

athm --debug <command>

Development

1. Install Poetry
2. Clone this repository
3. cd /path/to/repository
4. poetry install
5. poetry shell

Running Tests

Run pytest

Developing Plugins

See Developing Authum Plugins

Releasing New Versions

1. Bump the version (e.g. run poetry version)
2. Update the CHANGELOG
3. Run make release