clandestine 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5349f88fdb91dc0ba318147f01dc441f43d27fa8
-  data.tar.gz: a10b5403a328c9d59f352d58a627fdd83a52249d
+  metadata.gz: 28199bdaabcdce860096d540533772d884633985
+  data.tar.gz: d50ae77ce56c28705d610713563a04a6a0a64418
 SHA512:
-  metadata.gz: 0b3b6a6ad52762bd9a245217290eb5be52ea2321504ba06dd4bd1129c677b18656755be0be8672471644dd8644a0ebd29a4354f85df70c77de466c6e64597a73
-  data.tar.gz: 33e414a62e14f96b4f0c7dfa799495b9eeef0aff8a70a6eee7d7a08b3f2028ba9f5d7212faf6aec32ffbb4d4baed44e700ab56c5f7f01b9a4bc539bb4824eba1
+  metadata.gz: e735a21d659094d197fc01ef14dab5be103bea886b9c6ee5cd94eb56514f75fe995c1c1f279aa1e986c43e98425ea92daea992beacc9dae54fa41668bc951672
+  data.tar.gz: 24d36dede0d1e12f9c872743f746ce95d1a4b0e29299fffae3e29297ade654c7fbc45cf97a10b1fa0c5bc6f4ea56b3f34e7a60862773fad6da1096cd657c8b81

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 .bundle
 .config
@@ -6,14 +5,8 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
-coverage*
-doc/
+coverage
+doc
 lib/bundler/man
-pkg
 rdoc
-spec/reports
-test/tmp
-test/version_tmp
 tmp
-.rspec
-#*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,32 +1,44 @@
-# Clandestine
+Clandestine
+-----------
 
 Clandestine allows you to store passwords in a local file using AES-CBC-256 encryption.
 
-## Requirements
+Requirements
+------------
 
-Ruby
+Ruby v2.0+
 
 Currently only supported on OSX
 
-## Installation
+Installation
+------------
 
 Clandestine can be installed using RubyGems:
 
     $ gem install clandestine
 
-## Usage
+Usage
+-----
 
     user$ clandestine
-
-    Options:           
-        -a <key>      ::   add password related to <key>
-        -g <key>      ::   get password related to <key>
-        -g            ::   get all keys
-        -d <key>      ::   delete password related to <key>
-        -d            ::   delete all passwords
-        -l            ::   print current location of safe
-        -l <path>     ::   move safe location to <path>
-        -c            ::   change password to safe
-        -r            ::   remove safe completely
-        
-        Passwords will be copied to the clipboard for 10 seconds
+    Clandestine v0.1.0
+    Usage: clandestine [option] [key]
+
+        -a, --add <key>                  Add password for <key> (Passwords are randomly generated)
+        -g, --get [key]                  Get password for [key] (Returns all keys if key isn't given)
+        -d, --delete <key>               Delete <key> and related password
+        -u, --update [key]               Update password for [key] (Updates password for safe if key isn't given)
+        -l, --location                   Print location of safe (Default is ~/.cls if env variable CLANDESTINE_SAFE isn't set)
+        -r, --remove                     Remove safe completely
+        -v, --version                    Print version number
+        -h, --help                       Print these options
+
+
+Contributing
+------------
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Write specs (bundle exec rspec spec)
+4. Commit your changes (git commit -am 'Add some feature')
+5. Push to the branch (git push origin my-new-feature)
+6. Create new Pull Request

data/Rakefile

@@ -1,25 +1 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-namespace :spec do 
-  desc 'Run specs for Crypt'
-  RSpec::Core::RakeTask.new :crypt do |t|
-    t.pattern = 'spec/crypt_spec.rb'
-  end
-  desc 'Run specs for Safe'
-  RSpec::Core::RakeTask.new :safe do |t|
-    t.pattern = 'spec/safe_spec.rb'
-  end
-  desc 'Run specs for Guard'
-  RSpec::Core::RakeTask.new :guard do |t|
-    t.pattern = 'spec/guard_spec.rb'
-  end
-  desc 'Rub specs for Config'
-  RSpec::Core::RakeTask.new :config do |t|
-    t.pattern = 'spec/config_spec.rb'
-  end
-  task :all => [:safe, :guard, :crypt, :config]
-end
-
-task :default => 'spec:all'

data/bin/clandestine

@@ -4,4 +4,4 @@ $: << File.expand_path(File.dirname(__FILE__) + "/../lib") unless $:.include? Fi
 
 require 'clandestine'
 
-Clandestine::Guard.new.on_the_job
+Clandestine::CommandLineRunner.run

data/clandestine.gemspec

@@ -15,5 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency 'highline'
-  gem.add_development_dependency 'rspec', '~>2.8'
+  gem.add_dependency 'json'
+  gem.add_dependency 'bcrypt-ruby'
+  gem.add_development_dependency 'rspec', '~> 2'
 end

data/lib/clandestine.rb

@@ -1,9 +1 @@
-require 'openssl'
-require 'base64'
-require 'digest/sha2'
-require 'fileutils'
-require 'clandestine/version'
-require 'clandestine/crypt'
-require 'clandestine/config'
-require 'clandestine/safe'
-require 'clandestine/guard'
+require_relative 'clandestine/command_line_runner'

data/lib/clandestine/clandestine_error.rb

@@ -0,0 +1,4 @@
+module Clandestine
+  class ClandestineError < StandardError; end
+end
+

data/lib/clandestine/command_line_options.rb

@@ -0,0 +1,52 @@
+module Clandestine
+  class CommandLineOptions
+
+    attr_reader :parser
+    attr_accessor :options
+    private :options
+
+    def initialize
+      @options = {}
+      @parser = OptionParser.new
+    end
+
+    def parse
+      parser.banner = "Clandestine v#{Clandestine::VERSION}\nUsage: clandestine [option] [key]\n\n"
+
+      parser.on('-a', '--add <key>', 'Add password for <key>') do |key|
+        options[:add] = key
+      end
+
+      parser.on('-g', '--get [key]', 'Get password for [key] (Returns all keys if key isn\'t given)') do |key|
+        options[:get] = key
+      end
+
+      parser.on('-d', '--delete <key>', 'Delete <key> and related password') do |key|
+        options[:delete] = key
+      end
+
+      parser.on('-u', '--update [key]', 'Update password for [key] (Updates password for safe if key isn\'t given)') do |key|
+        options[:update] = key
+      end
+
+      parser.on '-l', '--location', 'Print location of safe (Default is ~/.cls if env variable CLANDESTINE_SAFE isn\'t set)' do
+        options[:location] = nil
+      end
+
+      parser.on '-r', '--remove', 'Remove safe completely' do
+        options[:remove] = nil
+      end
+
+      parser.on '-v', '--version', 'Print version number' do |h|
+        options[:version] = nil
+      end
+
+      parser.on_tail '-h', '--help', 'Print these options' do |h|
+        options[:help] = parser
+      end
+
+      parser.parse!
+      options
+    end
+  end
+end

data/lib/clandestine/command_line_runner.rb

@@ -0,0 +1,86 @@
+require 'optparse'
+require_relative 'command_line_options'
+require_relative 'commands'
+require_relative 'version'
+require_relative 'clandestine_error'
+require_relative 'io'
+
+module Clandestine
+
+  class CommandLineRunner
+
+    def self.run
+      clo = CommandLineOptions.new
+      options = clo.parse
+
+      command = options.keys.first
+      value = options[command]
+
+      case command
+      when :add
+        output = run_command(command, value)
+        if output
+          puts "Successfully added password for #{value}"
+        else
+          puts "Password already exists for #{value}"
+        end
+      when :get
+        output = run_command(command, value)
+        if value && !output.is_a?(Array)
+          IO.copy_to_clipboard(output)
+        else
+          IO.print_keys(output)
+        end
+      when :update
+        output = run_command(command, value)
+        if output
+          if value
+            puts "Password for #{value} has been updated"
+          else
+            puts "Password for safe has been updated"
+          end
+        else
+          if value
+            puts "#{value} does not exist"
+          else
+            puts "Failed to update safe password"
+          end
+        end
+      when :delete
+        if run_command(command, value)
+          puts "#{value} has been deleted"
+        else
+          puts "#{value} does not exist"
+        end
+      when :remove
+        if run_command(command, value)
+          puts "Safe has been successfully removed"
+        else
+          puts "Failed to remve safe"
+        end
+      when :version
+        puts Commands.version
+      when :location
+        puts Commands.location
+      when :help
+        puts clo.parser.on_tail
+      else
+        puts clo.parser.on_tail
+      end
+      puts
+    rescue OptionParser::MissingArgument, OptionParser::InvalidOption
+      puts clo.parser.on_tail
+    end
+
+    def self.run_command(command, value)
+      if command
+        if value
+          Commands.send(command, value)
+        else
+          Commands.send(command, nil)
+        end
+      end
+    end
+
+  end
+end

data/lib/clandestine/commands.rb

@@ -0,0 +1,52 @@
+require_relative 'version'
+require_relative 'clandestine_error'
+require_relative 'io'
+require_relative 'safe_location'
+require_relative 'commands/add'
+require_relative 'commands/update'
+require_relative 'commands/get'
+require_relative 'commands/delete'
+require_relative 'commands/remove_safe'
+
+module Clandestine
+  module Commands
+      def self.add(key, password = nil)
+        password = IO.get_password unless password
+        Add.new(password, key).add
+      end
+
+      def self.get(key = nil, password = nil)
+        if key && password.nil?
+          password = IO.get_password
+        end
+        Get.new(password, key).get
+      end
+
+      def self.delete(key, password = nil)
+        password = IO.get_password unless password
+        Delete.new(password, key).delete
+      end
+
+      def self.update(key = nil, password = nil)
+        password = IO.get_password unless password
+        Update.new(password, key).update
+      end
+
+      def self.location
+        ENV['CLANDESTINE_SAFE'] || SAFE_LOCATION
+      end
+
+      def self.remove(password = nil)
+        password = IO.get_password unless password
+        RemoveSafe.new(password).remove
+      end
+
+      def self.version
+        Clandestine::VERSION
+      end
+
+      def self.help(options)
+        options
+      end
+  end
+end

data/lib/clandestine/commands/add.rb

@@ -0,0 +1,29 @@
+require_relative '../safe'
+require_relative '../io'
+require_relative '../password_generator'
+require_relative '../clandestine_error'
+
+module Clandestine
+  module Commands
+    class Add
+      attr_reader :safe_password, :key
+      private :safe_password, :key
+
+      def initialize(safe_password, key)
+        raise ClandestineError.new 'Missing required key argument' unless key
+        @safe_password = safe_password
+        @key = key.to_sym
+      end
+
+      def add
+        Safe.new(safe_password).open do |safe|
+          if !safe.exists?(key)
+            safe.add(key, PasswordGenerator.random_password)
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clandestine/commands/delete.rb

@@ -0,0 +1,25 @@
+require_relative '../safe'
+
+module Clandestine
+  module Commands
+    class Delete
+      attr_reader :safe_password, :key
+      private :safe_password, :key
+
+      def initialize(safe_password, key)
+        @safe_password = safe_password
+        @key = key.to_sym
+      end
+
+      def delete
+        Safe.new(safe_password).open do |safe|
+          if safe.exists?(key)
+            safe.delete(key)
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clandestine/commands/get.rb

@@ -0,0 +1,37 @@
+require_relative '../safe'
+require_relative '../io'
+
+module Clandestine
+  module Commands
+    class Get
+
+      attr_reader :safe_password, :key
+      private :safe_password, :key
+
+      def initialize(safe_password, key)
+        @safe_password = safe_password
+        @key = key.to_sym if key
+      end
+
+      def get
+        Safe.new(safe_password).open do |safe|
+          if no_key_or_value?(safe)
+            safe.contents
+          else
+            safe[key]
+          end
+        end
+      end
+
+      private
+
+      def no_key_or_value?(safe)
+        !key || key_missing?(safe)
+      end
+
+      def key_missing?(safe)
+        !safe[key]
+      end
+    end
+  end
+end