Hackage :: [Package]

otp-authenticator: OTP Authenticator (a la google) command line client

[ bsd3, cli, library, program, security ] [ Propose Tags ]

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.

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.1.0, 0.1.2.0, 0.1.2.1 (info)
Change log CHANGELOG.md
Dependencies aeson, base (>=4.9 && <5), bifunctors, binary, bytestring, containers, cryptonite, dependent-sum, filepath, h-gpgme, haskeline, microlens, one-time-password, optparse-applicative, otp-authenticator, sandi, singletons, text, time, transformers, trifecta, type-combinators, unix, uri-encode, witherable, yaml [details]
License BSD-3-Clause
Copyright (c) Justin Le 2017
Author Justin Le
Maintainer justin@jle.im
Category CLI, Security
Home page https://github.com/mstksg/otp-authenticator
Source repo head: git clone https://github.com/mstksg/otp-authenticator
Uploaded by jle at 2017-08-06T04:21:14Z
Distributions
Executables otp-auth
Downloads 1979 total (18 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-08-06 [all 1 reports]

Readme for otp-authenticator-0.1.0.0

[back to package description]

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.

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:

# 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:

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