sesame-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8946385f1c8994446d910c37ecab7b3fe5497d7753f156c47ba9f3d70d655631
+  data.tar.gz: 515d7680020974e60217383d1245e829ff8b0486e915b072a0950c2acf41ad1c
+SHA512:
+  metadata.gz: 1796899e14a5bbc257b7ad781be05a64ede3e2b3c673bf44fd49ff67b7dc5fa40d5b45e40fe7f82140a3553f61628e761a49e790ebb072e3dc8d4d51f1882b58
+  data.tar.gz: bcbefe388969f696f1dfc778837991543b0fdc1f6811ae7e968529ac353a514ec2ce74c267c09204f93d4239f93e32182555dfb2c1beebc2456331adf0b9e5d8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+UNLICENSE

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+
+gem 'bases', '~> 1.0'
+gem 'clipboard', '~> 1.1'
+gem 'digest-crc', '~> 0.4'
+gem 'highline', '~> 1.7'
+gem 'i18n', '~> 1.0'
+gem 'rbnacl', '~> 5.0'
+gem 'rbnacl-libsodium', '~> 1.0'
+gem 'slop', '~> 4.6'
+
+group :development do
+  gem 'awesome_print', '~> 1.8.0'
+  gem 'byebug', '~> 10.0.1'
+  gem 'jeweler', '~> 2.3.9'
+  gem 'rdoc', '~> 6.0'
+  gem 'rspec', '~> 3.7'
+  gem 'simplecov', '~> 0.15'
+  gem 'yard', '~> 0.9'
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    awesome_print (1.8.0)
+    bases (1.0.2)
+    builder (3.2.3)
+    byebug (10.0.2)
+    clipboard (1.1.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    digest-crc (0.4.1)
+    docile (1.3.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.23)
+    git (1.3.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.5.7)
+    highline (1.7.10)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    jeweler (2.3.9)
+      builder
+      bundler
+      git (>= 1.2.5)
+      github_api (~> 0.16.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych
+      rake
+      rdoc
+      semver2
+    json (2.1.0)
+    jwt (1.5.6)
+    mime-types (2.99.3)
+    mini_portile2 (2.3.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (3.0.2)
+    rack (2.0.4)
+    rake (12.3.1)
+    rbnacl (5.0.0)
+      ffi
+    rbnacl-libsodium (1.0.16)
+      rbnacl (>= 3.0.1)
+    rdoc (6.0.3)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    semver2 (3.4.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (4.6.2)
+    thread_safe (0.3.6)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8.0)
+  bases (~> 1.0)
+  byebug (~> 10.0.1)
+  clipboard (~> 1.1)
+  digest-crc (~> 0.4)
+  highline (~> 1.7)
+  i18n (~> 1.0)
+  jeweler (~> 2.3.9)
+  rbnacl (~> 5.0)
+  rbnacl-libsodium (~> 1.0)
+  rdoc (~> 6.0)
+  rspec (~> 3.7)
+  simplecov (~> 0.15)
+  slop (~> 4.6)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,234 @@
+[![Gem Version](https://badge.fury.io/rb/sesame-cli.svg)](http://badge.fury.io/rb/sesame-cli)
+[![Dependency Status](https://gemnasium.com/badges/github.com/kranzky/sesame-cli.svg)](https://gemnasium.com/github.com/kranzky/sesame-cli)
+[![Codeship Status for kranzky/sesame-cli](https://app.codeship.com/projects/01008000-26b3-0136-297f-36c36926d30f/status?branch=master)](https://app.codeship.com/projects/286882)
+
+Sesame
+======
+
+Sesame is a simple password manager for the command-line.
+
+Creating a Cave
+---------------
+
+Your passwords are stored in a secure cave, guarded by a Jinn that will only
+grant access if the correct magic words are uttered. These words also known as a
+passphrase, or a sesame seed 😩
+
+To get started, install Sesame and create a new cave. Note that the `--echo`
+argument is used to display sensitive information such as the generated
+passphrase; omit `--echo` to have this copied to the clipboard instead.
+
+```
+$ gem install sesame
+$ sesame --echo
+╔═════════════════════════════════════╗
+║ ┏━━━┓ ┏━━━┓ ┏━━━┓  ┏━┓  ┏┓ ┏┓ ┏━━━┓ ║
+║ ┗━╋━┓ ┣━━┫  ┗━╋━┓ ┏┻━┻┓ ┃┗┳┛┃ ┣━━┫  ║
+║ ┗━━━┛ ┗━━━┛ ┗━━━┛ ┗   ┛ ┗   ┛ ┗━━━┛ ║
+╚═════════════════════════════════════╝
+
+🧞 - "Your new cave is ready, master. Please commit these magic words to memory..."
+mammal glue wage paper store detail weave date
+
+🧞 - "What is your command?"
+1. list
+2. add
+3. get
+4. next
+5. delete
+6. exit
+7. help
+
+> exit
+🧞 - "I have secured your treasure with this key..."
+sky tea ant ice
+```
+
+You will notice that Sesame enters interactive mode, allowing you to issue
+multiple commands in a single session. When you exit from interactive mode, the
+cave will be locked with a short code.
+
+Remembering the Passphrase
+--------------------------
+
+By default, Sesame generates an eight-word passphrase that is used to secure
+your cave. Try to remember it in groups of two or three consecutive words, and
+associate those words with something you know well (such as walking through your
+home, from the front door to the bathroom).
+
+* I enter the front door. On the side table a mammal is glueing their wages together.
+* Turning left into the kitchen, I see the drawer where I store my paper.
+* Looking down the corridor, I notice a detailed weave of a date on the bathroom door.
+
+Lame perhaps, but easier to remember than `58qWT6jHpA566MX` (and just as
+secure).
+
+If you must write the passphrase down, please make sure to store the paper that
+you write it on securely (ideally in a safe).
+
+Unlocking the Cave
+------------------
+
+Upon exiting interactive mode for the first time, Sesame will lock your cave
+with a short code. In the example above, that code is `sky tea ant ice`. The
+next time you run Sesame, you will be prompted to enter the short code instead
+of your eight-word passphrase.
+
+Instead of entering the full code, you may also enter just the first letter of
+each word. For the example above, entering `stai` as the unlock code will also
+work.
+
+Keeping your cave locked this way is convenient, but anyone with access to your
+computer would be able to crack the lock with a small amount of effort. It is
+therefore recommended to expunge the lock when you don't need it. You can do
+this with the `--expunge` argument.
+
+Adding a Service
+----------------
+
+You can add, list, retrieve and delete passwords for different services. 
+
+```
+> add twitter kranzky
+🧞 - "Your new magic words are..."
+nylon sand slice party
+```
+
+Listing Services
+----------------
+
+```
+> list
+🧞 - "Behold! Tremble in awe at the greatness of these heroes!"
+twitter
+facebook
+google (2)
+```
+
+If several user accounts exist for the same service, a number will be displayed
+in brackets. View all accounts by listing the service.
+
+```
+> list google
+🧞 - "Behold! Tremble in awe at the greatness of these heroes!"
+lloyd@kranzky.com
+pazu@kranzky.com
+```
+
+Retrieving a Password
+---------------------
+
+You can retrieve a password for an existing service. You only need to specify
+the name of the user account if more than one exists for the service.
+
+```
+> get google lloyd@kranzky.com
+🧞 - "Master, the magic words for lloyd@kranzky.com of google are..."
+rainy area rough feather
+```
+
+Updating a Password
+-------------------
+
+From time-to-time you may wish to update the password that you use for a
+particular service. The `next` command allows you to do that.
+
+```
+> next google lloyd@kranzky.com
+```
+
+Removing a Service
+------------------
+
+You can delete services from your cave.
+
+```
+> delete google pazu@kranzky.com
+```
+
+Recovering a Lost Cave
+----------------------
+
+Sesame stores your cave in an encrypted file named `sesame.cave`. You should
+keep this file in Dropbox or iCloud or a similar service to ensure that you
+don't lose it. However, if the worst happens and you do lose that file, you may
+recover it by specifying the `--reconstruct` argument when creating a new cave.
+
+You will be prompted to enter the passphrase that you wish to use. As long as
+you use the same passphrase as the one you used for your lost cave, the
+passwords generated for the services you add to the cave will be the same.
+
+Command-line Options
+--------------------
+
+Run with the `--help` argument to view all options.
+
+```
+$ sesame --help
+usage: ./bin/sesame [options]
+    -p, --path         the path to the sesame cave; overrides $SESAME_PATH and .sesamerc
+    -s, --service      the name of the service (e.g. Twitter)
+    -u, --user         the username for the given service (e.g. user@test.com)
+    -o, --offset       the password index for the service and username (defaults to 0)
+    -e, --echo         display passwords in plain text instead of adding to the clipboard
+    -i, --interactive  launch an interactive cli, allowing commands to be issued
+    -r, --reconstruct  reconstruct a sesame cave from an existing passphrase
+    -x, --expunge      remove the temporary lock; the full passphrase will be required
+    -c, --command      the command to execute; one of: list, get, add, next, delete
+    -l, --list         show all services and usernames
+    -a, --add          add a new service and username
+    -g, --get          get the current password for an existing service and username
+    -n, --next         generate a new password for an existing service and username
+    -d, --delete       remove an existing service and username
+    -q, --quiet        silence the jinn
+    -v, --version      print the version and exit
+    -h, --help         all of that up there ^
+```
+
+You can issue commands directly, which will suppress interactive mode.
+
+```
+$ sesame -qegs twitter
+Enter unlock code.
+🔑  ****
+Opened ./sesame.cave
+Password for twitter / kranzky:
+nylon sand slice party
+```
+
+Configuration
+-------------
+
+Rather than specifying the `--path` argument, you may set the `$SESAME_PATH`
+environment variable to the location where the `sesame.cave` file should be
+stored.
+
+Sesame will also look for a file named `.sesamerc` or `sesame.cfg` in the
+current directory and in your home directory. This file should be in the JSON
+format, and can specify the `path`, `user`, `echo` and `quiet` options. For
+example, here is the configuration file used by Lloyd Kranzky:
+
+```
+  {
+    "path": "~/Dropbox",
+    "user": "lloyd@kranzky.com",
+    "echo": "false",
+    "quiet": "true"
+  }
+```
+
+Contributing
+------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2018 Jason Hutchens and Jack Casey. See UNLICENSE for further details.

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "sesame-cli"
+  gem.homepage = "http://github.com/kranzky/sesame-cli"
+  gem.license = "UNLICENSE"
+  gem.summary = %Q{Sesame is a simple password manager for the command-line.}
+  gem.description = %Q{Sesame is a simple password manager for the command-line.}
+  gem.email = "jasonhutchens@gmail.com"
+  gem.authors = ["Jason Hutchens", "Jack Casey"]
+  gem.required_ruby_version = "~> 2.1"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/sesame

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'sesame'
+require 'slop'
+
+opts =
+  begin
+    Slop.parse do |o|
+      o.string '-p', '--path', 'the path to the sesame cave; overrides $SESAME_PATH and .sesamerc'
+      o.string '-s', '--service', 'the name of the service (e.g. Twitter)'
+      o.string '-u', '--user', 'the username for the given service (e.g. user@test.com)'
+      o.integer '-o', '--offset', 'the password index for the service and username (defaults to 0)'
+      o.bool '-e', '--echo', 'display passwords in plain text instead of adding to the clipboard'
+      o.bool '-i', '--interactive', 'launch an interactive cli, allowing commands to be issued'
+      o.bool '-r', '--reconstruct', 'reconstruct a sesame cave from an existing passphrase'
+      o.bool '-x', '--expunge', 'remove the temporary lock; the full passphrase will be required'
+      o.string '-c', '--command', 'the command to execute; one of: list, get, add, next, delete'
+      o.bool '-l', '--list', 'show all services and usernames'
+      o.bool '-a', '--add', 'add a new service and username'
+      o.bool '-g', '--get', 'get the current password for an existing service and username'
+      o.bool '-n', '--next', 'generate a new password for an existing service and username'
+      o.bool '-d', '--delete', 'remove an existing service and username'
+      o.bool '-q', '--quiet', 'silence the jinn'
+      o.on '-v', '--version', 'print the version and exit' do
+        say(File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')))
+        exit
+      end
+      o.on '-h', '--help', 'all of that up there ^' do
+        say(o)
+        exit
+      end
+    end
+  rescue Slop::Error => e
+    say(e.message + " (try --help)")
+    exit 1
+  end
+if opts.arguments.count > 0
+  say("extraneous arguments: #{opts.arguments.join(' ')} (try --help)")
+  exit 1
+end
+
+Sesame::Jinn.new(opts).process!