authentic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a466cc3f5d39c27b78beccb0ae2445838d770a58
-  data.tar.gz: 34363dd67e5a8d9139b6836a3cd2883cf49905f5
+  metadata.gz: 3a0405bf6ab9d3d2032221c0bd437cc0613e2887
+  data.tar.gz: 10fb91b9d22b3ed865dc78cf873c8ca17f30828f
 SHA512:
-  metadata.gz: e25fd334769ab583a9bf4357f149861eddfdac4f3447c6189b6b77c75d3c4915277801d9f653d78411c01995aaa10dc3064de70b50861547f04f19361dfb09da
-  data.tar.gz: e9f1b08e6fe772f0cdac82ac16bb5065e405a417f1f8586d10de12af8487de14ca74e86ad64bf785ead2b5caed9274105ebff2a19e916752f0e53823484cd399
+  metadata.gz: d1f2c01f5e7445e1463e422bbea71f10d53ea7b8e5093b68c554609732462fec027baa0310ed07343edab89fe413ac4e7c02004fef16af5bcec68542a252f47c
+  data.tar.gz: 1ddb1a3ebc93f0f8093c64a6c7cd17754fa68b1b9fb5c1a5a71654e43094f6f01f94cf91f3c42ae941b36192de6f6e9dc38a3c8679f17729e032312749210238

data/README.md

@@ -1,30 +1,78 @@
 # Authentic
 
-TODO: Write a gem description
+I was increasingly annoyed with having to unlock my phone, launch Google Authenticator and type
+in the code to the web page every time I was prompted with a Two Factor Authentication screen.
+I wanted a CLI tool to do the same thing on my Mac. For a long time, I've used
+[oathtool](http://www.nongnu.org/oath-toolkit/) combined with a shell script that I'd keep adding
+my TFA keys to. That obviously was very insecure and I was wondering if I could use Keychain
+since it can be used to store various secure credentials.
+
+So long story short, one evening in Nov 2014, I sat down to code a Ruby based tool to offload key storage
+to Keychain and `authentic` was born.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the tool by running:
 
-```ruby
-gem 'authentic'
+```shell
+$ gem install authentic
 ```
 
-And then execute:
+(you might need to put a `sudo` in front of that command if your Ruby installation requires it)
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Once installed, the command should be available on the `PATH` so you can type:
 
-    $ gem install authentic
+```shell
+$ authentic help
+```
 
-## Usage
+which should print out something like this:
+
+```shell
+$ authentic help
+Authentic commands:
+  authentic add NAME SECRET_KEY [LABEL]  # Add a new TOTP key
+  authentic delete NAME                  # Delete a TOTP key
+  authentic generate                     # Generate TOTP codes
+  authentic help [COMMAND]               # Describe available commands or one specific command
+```
+
+In order to start using the tool, you first need to find your TFA key for the service that you are trying
+to add. This could be tricky for some services, but this code is actually what is encoded by the QR code
+displayed in most services. So click around (or view source) to try to find your TFA key, remember it will
+only be displayed the first time you setup TFA for the service.
+
+Once you have your TFA key in hand, adding it to `authentic` is as simple as:
+
+```shell
+$ authentic add MyService hedere
+✓ Service MyService added to keychain
+```
+
+Now you can simply type:
+
+```shell
+$ authentic
+```
+
+to generate your codes. If you have a single service registered, the generated code will be automatically
+copied to the clipboard (if you don't want that run the command with the `-s` flag, as in `authentic -s`).
+If you have more than one service registered, the tool will prompt you to select a key number to copy. At
+this point you can enter the key number you want to copy or just press `Enter` to exit the tool without copying
+anything.
+
+## Disclaimer
+
+I am not a security expert and haven't had any security experts vet this tool. Use it at your own risk, I won't
+take any responsibility for anything that happens to you as a result of using this tool.
 
-TODO: Write usage instructions here
+If you feel (or even better *know*) that I am doing something wrong, please create an Issue or submit a Pull Request.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/authentic/fork )
+1. Fork it ( https://github.com/paracycle/authentic/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/authentic/version.rb

@@ -1,3 +1,3 @@
 module Authentic
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/authentic.rb

@@ -27,7 +27,7 @@ module Authentic
       end
 
       unless item.nil?
-        say "\u2713".colorize(:green) + " Service #{name.colorize(:green)} add to keychain"
+        say "\u2713".colorize(:green) + " Service #{name.colorize(:green)} added to keychain"
       else
         say "\u2717".colorize(:red) + " Couldn't add service #{name.colorize(:red)}..."
         say "Error: #{message}" unless message.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authentic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -152,3 +152,4 @@ signing_key:
 specification_version: 4
 summary: A desktop Google Authenticator replacement.
 test_files: []
+has_rdoc: