The otp-authenticator package

[ Tags: 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.

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]

Properties

Versions 0.1.0.0, 0.1.0.1
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 BSD3
Copyright (c) Justin Le 2017
Author Justin Le
Maintainer justin@jle.im
Category CLI, Security
Home page https://github.com/mstksg/otp-authenticator
Source repository head: git clone https://github.com/mstksg/otp-authenticator
Uploaded Mon Aug 7 00:24:00 UTC 2017 by jle
Distributions NixOS:0.1.0.1
Executables otp-auth
Downloads 134 total (49 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-08-07 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for otp-authenticator-0.1.0.1

[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