Release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 M. Moldabekov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+## gauth is a two-factor authentication agent.
+
+### Usage:
+
+	gauth -add [-hotp] name
+	gauth -list
+	gauth name
+
+To add a new key to keychain use "gauth -add name", where name is a given name.
+It'll prompt a 2fa key from stdin
+2fa keys are case-insensitive strings [A-Za-z2-7].
+
+Default generation algorithm is time based auth codes
+(TOTP - the same as Google Authenticator)
+
+There is also *EXPERIMENTAL* support of counter based auth codes (HOTP).
+
+To list all names in the keychain use `gauth -list`
+
+To print certain 2fa auth code use `gauth name`
+
+If no arguments are provided, gauth prints all 2fa TOTP auth codes.
+
+**IMPORTANT NOTE:**
+
+TOTP auth codes are derived from key hash and current time.
+Please ensure that system clock are adjusted via NTP.
+Acceptable fault threshold is about ~1 min.
+
+The keychain itself is stored UNENCRYPTED in `$HOME/.gauth`.
+Take measures to encrypt your partitions (haven't you done this yet?)
+
+### Example
+
+While Google 2fa setup select "enter this text code instead" bypassing QR code scanning. You will get your 2fa secret - short string.
+
+Add it to 2fa under the name google, typing the secret at the prompt:
+
+	$ gauth -add google
+	gauth key for google: <secret>
+	$
+
+Whenever Google prompts for a 2fa code, run gauth to obtain one:
+
+	$ gauth google
+	438163
+
+### Greetings
+ - Golang team
+ - Russ C.
+
+### Contributing
+All PR and Issues are welcome
+
+### License
+(C) MIT License