Go to file
Nick Krichevsky bc391fc4d7 Add config file location to README 2024-01-28 12:01:53 -05:00
lib Add small CLI wrapper around TOTP 2024-01-28 11:55:25 -05:00
test Add small CLI wrapper around TOTP 2024-01-28 11:55:25 -05:00
.formatter.exs initial commit of TOTP gen 2024-01-27 19:59:53 -05:00
.gitignore Add small CLI wrapper around TOTP 2024-01-28 11:55:25 -05:00
LICENSE Add LICENSE 2024-01-28 11:58:25 -05:00
README.md Add config file location to README 2024-01-28 12:01:53 -05:00
mix.exs Add small CLI wrapper around TOTP 2024-01-28 11:55:25 -05:00
mix.lock Add small CLI wrapper around TOTP 2024-01-28 11:55:25 -05:00

README.md

Topex

A small TOTP-generating application.

Why?

Mostly because I wanted to implement the TOTP algorithm for fun. I probably wouldn't use this in any security-sensitive contexts.

Building

The CLI application uses Burrito to package itself, so you should ensure its dependencies are installed (notably zig and xz). You can build the output binary with MIX_ENV=prod mix release.

Usage

Topex requires a configuration file (located at ./topex.conf) of the form

[[keys]]
name = "account1"
key = "JBSWY3DPEHPK3PXP"

[[keys]]
name = "account2"
key = "PXP3KPHEPD3YWSBJ"

You can then generate a code using ./topex [key_name]. Note that this argument is only optional if there is only one key present. If not, you must specify the TOTP key you want to use to generate the code.