gamgee: Tool for generating TOTP MFA tokens.
This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.
Tool for generating TOTP MFA tokens. Please see the README on GitHub at https://github.com/rkaippully/gamgee#readme
[Skip to Readme]
Properties
| Versions | 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.2.2, 1.2.2 |
|---|---|
| Change log | ChangeLog.md |
| Dependencies | aeson (==1.5.6.0), base (==4.14.1.0), base64-bytestring (==1.1.0.0), bytestring (==0.10.12.0), cryptonite (==0.27), directory (==1.3.6.0), filepath (==1.4.2.1), gamgee, Hclip (==3.0.0.4), memory (==0.15.0), optparse-applicative (==0.15.1.0), polysemy (==1.5.0.0), relude (==0.7.0.0), safe-exceptions (==0.1.7.1), text (==1.2.4.1), time (==1.9.3), unix (==2.7.2.2) [details] |
| License | MPL-2.0 |
| Copyright | 2018-2021 Raghu Kaippully, Alexander Shestakov |
| Author | Raghu Kaippully |
| Maintainer | rkaippully@gmail.com |
| Category | Authentication, Command Line |
| Home page | https://github.com/rkaippully/gamgee#readme |
| Bug tracker | https://github.com/rkaippully/gamgee/issues |
| Source repo | head: git clone https://github.com/rkaippully/gamgee |
| Uploaded | by rkaippully at 2021-04-14T10:15:18Z |
Modules
[Index] [Quick Jump]
Downloads
- gamgee-1.2.2.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
Package maintainers
For package maintainers and hackage trustees
Readme for gamgee-1.2.2
[back to package description]
About
Gamgee is your sidekick for managing multi-factor authentication tokens. It is a command-line tool that can be used as a drop-in replacement for Google Authenticator app or any other similar app providing multi-factor authentication using Time-based One-Time Password (TOTP) algorithm.
Gamgee implements the TOTP algorithm specified in RFC6238
Installation
On MacOS, install using homebrew:
brew install rkaippully/tools/gamgee
See other releases here: https://github.com/rkaippully/gamgee/releases/latest
Usage
Gamgee is a replacement for apps like Google Authenticator or Authy that are used to generate TOTP tokens. Typically, such tools scan a QR code to create an account. Gamgee cannot scan a QR code (yet), but you can instead get a secret token from your service and add that to Gamgee.
- Go to the multi-factor authentication setup page of your service (such as Github, Gmail, etc). You will see a QR code in that page and instructions to scan it with an app.
- Look for a link in the page that gives alternative installation instructions. For example, many services include a "Can't scan barcode?" or "Enter this text code" link next to the QR code. Follow that link.
- Note down the secret code mentioned in the page. Once you get the secret, create a token with this command:
gamgee add -l "<token-label>" -s "<secret-code>"
token-label is a convenient label that you choose for this token.
Now you are ready to generate an OTP with your token:
gamgee <token-label>
This will generate an OTP and copy it to your clipboard. You can paste it into your authentication service. Alternatively, you can write the OTP to standard output with:
gamgee <token-label> --stdout
You can find a list of all your tokens with:
gamgee list
You can also remove a token if it is no longer needed. Please remember that this cannot be undone:
gamgee delete -l "<token-label>"
Polysemy stores the tokens in a configuration file under your home directory. You can find the location of this file (along with some other details) by running:
gamgee info
License
Gamgee is distributed under Mozilla Public License 2.0. See the file LICENSE for details.
This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.