https://github.com/mstksg/otp-authenticator

OTP Authenticator (ala Google Authenticator) cli app
https://github.com/mstksg/otp-authenticator

Last synced: about 2 months ago
JSON representation

OTP Authenticator (ala Google Authenticator) cli app

• Host: GitHub
• URL: https://github.com/mstksg/otp-authenticator
• Owner: mstksg
• License: bsd-3-clause
• Created: 2017-08-02T08:09:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-15T09:20:42.000Z (11 months ago)
• Last Synced: 2024-05-02T00:12:54.402Z (8 months ago)
• Language: Haskell
• Size: 273 KB
• Stars: 4
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# otp-authenticator

Simple tool for keeping track of your one-time pad two-factor authentication

keys; basically a command-line version of the canonical [Google Authenticator

App][gauth].

[gauth]: https://github.com/google/google-authenticator

The library uses GnuPG (through *h-gpgme*) to safely encrypt your secret keys.

The first time you use it, it asks for a fingerprint to use for encryption.

Currently *GnuPG 1.x* has some issues with *h-gpgme* when asking for keys, so

*GPG 2.x* is recommended.  Keys are stored, encrypted, at `~/.otp-auth.vault`

by default.

Instructions are available through `--help`, but the basics are:

```bash

# interactively add a new key

otp-auth add

# interactively add a new key by entering the secret key uri

#   (following the otpauth protocol)

otp-auth add --uri

# view all time-based codes and cached counter-based codes

otp-auth view

# list accounts, do not display codes

otp-auth view --list

# generate a new counter-based code

otp-auth gen ID

# edit the metadata and delete codes

otp-auth edit ID

otp-auth delete ID

# dump all stored data as json (and as yaml)

otp-auth dump

otp-auth dump --yaml

```

You can edit configuration at `~/.otp-auth.yaml`, the basic schema is:

```yaml

fingerprint: ABCDEF12

vault: /home/robert/.otp-auth.vault

```