passman 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bda4662265b49027fdbcd554dec1e3d3647a2ace
-  data.tar.gz: 34836b929208a72a53171d148eb72ce1713793b2
+  metadata.gz: 3fd80581c44a6b45f671dee954c907546c1d0070
+  data.tar.gz: a6b7bb2c53cc7f49dbd46d780c2e8eeb98c1a569
 SHA512:
-  metadata.gz: 039799e9ba6eadd3039554d51796129b66240011b74c25ca9f59ce892e42c73d51140dad085070198615e66a556f8842d986b6c1cb9e594ab64e3ff470543506
-  data.tar.gz: 8dda4311d9e2afb3b405672caebc6332727963658c777883605739b3684e158790b4ff4e3fa6274e2ad8a91dbd7e1b79c81d04b261593e3973e1a57187687893
+  metadata.gz: f8843144a6727eb8d50eeddedcd98d5527da66f79ec892970acce16374b16036b655948d6a63f8ff60539c5b131b0194c72791d22b18c7f9993f65568c99b12c
+  data.tar.gz: ad5c45e1a5e9d802d73ee20a55689cb359bcadfec480b39c7624924ac792b2ab3aaa6daa48e51a1e64f83093bffe3d5cc5ffac54bd71bb0378e6a668b494d9a7

data/README.md

@@ -1,12 +1,12 @@
 # PassMan - Password Manager
-[![Gem Version](https://badge.fury.io/rb/passman.svg)]()
+[![Gem Version](https://badge.fury.io/rb/passman.svg)](https://badge.fury.io/rb/passman)
 [![Dependency Status](https://gemnasium.com/badges/github.com/alebian/passman.svg)](https://gemnasium.com/github.com/alebian/passman)
 [![Build Status](https://travis-ci.org/alebian/passman.svg)](https://travis-ci.org/alebian/passman)
 [![Code Climate](https://codeclimate.com/github/alebian/passman/badges/gpa.svg)](https://codeclimate.com/github/alebian/passman)
 [![Test Coverage](https://codeclimate.com/github/alebian/passman/badges/coverage.svg)](https://codeclimate.com/github/alebian/passman/coverage)
 [![Inline docs](http://inch-ci.org/github/alebian/passman.svg)](http://inch-ci.org/github/alebian/passman)
 
-PassMan is a command line application that stores your passwords encripted with a symmetric-key algorithm. It also let's you save more information about your accounts such as recovery information and more.
+PassMan is a command line application that stores your passwords encrypted with AES 256 symmetric-key algorithm. It also let's you save more information about your accounts such as recovery information and more.
 
 ## Installation
 
@@ -16,16 +16,46 @@ Run this in your terminal:
 
 ## Usage
 
-After installing the gem, you can use it in your command line:
+PassMan will save your passwords in a file called 'passman.json' by default, you can tell PassMan to store  the passwords in different files.
+
+First of all you will need a 32 bit (or more) symmetric key. This will be used in the future to encrypt and decrypt your passwords but PassMan will not store that value. Everytime PassMan needs to encrypt or decrypt your passwords it will ask you for one key. You can tell PassMan to create a new secure random key if you want to:
+
+```
+passman -g 32
+# => c50647a4dde91848fb5edda217149258
+```
+
+Once you have your key, write it down on paper or try to remember it. Now you can start saving your passwords.
+
+```
+passman -a Twitter -u alebian -p MySuperPassword
+```
+
+You will be prompted to insert you key and then PassMan will store your password.
+
+Now you can retreive your passwords:
 
 ```
-passman
+passman -r Twitter
 ```
 
-```ruby
+You can tell Passman to store your password in a different file:
 
 ```
+passman -a Twitter -u alebian -p MySuperPassword -f ~/my_database
+```
+
+You can list the stored accounts:
 
+```
+passman -l
+```
+
+You can delete your accounts:
+
+```
+passman -d Twitter
+```
 
 ## Contributing
 

data/bin/passman

@@ -5,7 +5,7 @@ require 'optparse'
 require 'colorize'
 require 'io/console'
 
-options = {}
+options = { length: 32 }
 
 begin
 
@@ -39,7 +39,7 @@ begin
     end
 
     opts.on('-g', '--generate [N]', Integer, 'Generates a new random password of N characters, or default if N is not provided') do |length|
-      options[:length] = length
+      options[:length] = length unless length.nil? || length.empty?
       options[:generate] = true
     end
 
@@ -48,7 +48,7 @@ begin
     end
 
     opts.on('-v', '--version', 'Displays version') do
-      puts "PassMan Version: #{Passman::VERSION}"
+      puts "PassMan Version: #{Passman::VERSION}".colorize(:yellow)
       exit
     end
 
@@ -60,52 +60,73 @@ begin
 
   parser.parse!
 
+  manager = Passman::Manager.new(options[:file])
+  key = ''
+  password = ''
+
   if options[:account]
 
-    raise ArgumentError, 'No username provided.' unless options[:username]
-    password = ''
     if options[:password]
       password = options[:password]
     else
-      password = Passman.generate_password(options[:length])
+      password = manager.generate_password(options[:length])
+      puts "Password generated: #{password}".colorize(:yellow)
     end
 
-    if Passman.get(options[:account], options[:file])
+    if manager.exist?(options[:account])
       print 'There is a username already stored. Do you want to overwrite it? [Y/n] '
       overwrite = gets
       exit unless overwrite == 'Y'
       puts ''
     end
 
-    print 'Insert your symmetric-key: '
+    print 'Insert your symmetric-key:'
     key = STDIN.noecho(&:gets)
+    raise ArgumentError, 'Key cannot be empty' if key.empty?
     puts ''
-    Passman.add(options[:account], options[:username], Passman::Crypto.encrypt(password, key.chomp), options[:file])
 
+    manager.add(options[:account], options[:username], password, key)
     puts 'Password successfully added'.colorize(:green)
 
   elsif options[:delete]
 
-    Passman.delete(options[:delete], options[:file])
+    manager.delete(options[:delete])
     puts 'Password deleted'.colorize(:green)
 
   elsif options[:list]
 
-    Passman.database(options[:file]).each do |account, data|
+    list = manager.list
+    puts 'No accounts stored' if list.empty?
+    list.each do |account, data|
       puts account.colorize(:yellow) + ' -> ' + data['username']
     end
 
   elsif options[:generate]
 
-    puts Passman.generate_password(options[:length])
+    puts manager.generate_password(options[:length])
 
   elsif options[:retreive]
 
-    account = Passman.get(options[:retreive], options[:file])
-    print 'Insert your symmetric-key: '
+    unless manager.exist?(options[:retreive])
+      puts "The account doesn't exist"
+      exit
+    end
+
+    print 'Insert your symmetric-key:'
     key = STDIN.noecho(&:gets)
+    raise ArgumentError, 'Key cannot be empty' if key.empty?
     puts ''
-    puts "Account: #{options[:retreive]}, Username: #{account['username']}, Password: #{Passman::Crypto.decrypt(account['password'], key)}"
+    account = manager.get(options[:retreive], key)
+    puts(
+      'Account: ' + "#{account[0]}".colorize(:yellow) +
+      ', Username: ' + "#{account[1]['username']}".colorize(:yellow) +
+      ', Password: ' + "#{account[1]['password']}".colorize(:yellow)
+    )
+
+  elsif options[:remove]
+
+    manager.delete(options[:remove])
+    puts 'Deleted account'.colorize(:red)
 
   else
 

data/lib/passman.rb

@@ -1,44 +1,7 @@
-require_relative 'passman/crypto'
+require 'passman/crypto'
+require 'passman/manager'
 require 'passman/password_generator'
 require 'passman/version'
-require 'json'
 
 module Passman
-  DEFAULT_FILE = 'passman.json'.freeze
-
-  def self.generate_password(length)
-    Passman::PasswordGenerator.generate(length / 2)
-  end
-
-  def self.add(account, username, encrypted_password, file = nil)
-    path = DEFAULT_FILE if file.nil?
-    db = database(path)
-    db[account.to_s] = { username: username, password: encrypted_password }
-    write_database(db, path)
-  end
-
-  def self.delete(account, file = nil)
-    path = DEFAULT_FILE if file.nil?
-    db = database(path)
-    db.delete(account.to_s)
-    write_database(db, path)
-  end
-
-  def self.get(account, key, file = nil)
-    path = DEFAULT_FILE if file.nil?
-    db = database(path)
-    db[account.to_s]
-  end
-
-  def self.database(file)
-    return JSON.parse(File.read(file)) if File.exist?(file)
-    {}
-  end
-
-  def self.write_database(data, path)
-    File.delete(path) if File.exist?(path)
-    file = File.open(path, 'w+')
-    file.write(JSON.generate(data))
-    file.close
-  end
 end

data/lib/passman/crypto.rb

@@ -3,11 +3,13 @@ require 'base64'
 
 module Passman
   class Crypto
+    MINIMUM_SIZE_KEY = 32
+
     class << self
       def encrypt(password, key)
         cipher = new_cipher
         cipher.encrypt
-        cipher.key = key
+        cipher.key = sanitize_key(key)
         encrypted_password = cipher.update(password) + cipher.final
         Base64.encode64(encrypted_password)
       end
@@ -15,7 +17,7 @@ module Passman
       def decrypt(encrypted_password, key)
         cipher = new_cipher
         cipher.decrypt
-        cipher.key = key
+        cipher.key = sanitize_key(key)
         decrypted_password = cipher.update(Base64.decode64(encrypted_password))
         decrypted_password << cipher.final
       end
@@ -25,6 +27,13 @@ module Passman
       def new_cipher
         OpenSSL::Cipher::AES.new(256, 'CBC')
       end
+
+      def sanitize_key(key)
+        raise ArgumentError, 'No key provided.' if key.nil? || key.empty?
+        sanitized = key
+        sanitized += key while sanitized.length < MINIMUM_SIZE_KEY
+        sanitized
+      end
     end
   end
 end

data/lib/passman/manager.rb

@@ -0,0 +1,78 @@
+require 'passman/crypto'
+require 'passman/password_generator'
+require 'json'
+
+module Passman
+  class Manager
+    DEFAULT_PATH = 'passman.json'.freeze
+
+    def initialize(file = nil)
+      @file_path = DEFAULT_PATH
+      @file_path = file unless file.nil?
+    end
+
+    def generate_password(length = 32)
+      Passman::PasswordGenerator.generate(length)
+    end
+
+    def add(account, username, password, key)
+      validate_add_arguments(account, username, password, key)
+      db = database
+      db[account.to_s] = { username: username, password: Passman::Crypto.encrypt(password, key) }
+      store_data(db)
+    end
+
+    def delete(account)
+      raise ArgumentError, 'No account provided.' unless valid?(account)
+      db = database
+      db.delete(account.to_s)
+      store_data(db)
+    end
+
+    def get(account, key)
+      validate_get_arguments(account, key)
+      data = database[account.to_s]
+      [account.to_s, { 'username' => data['username'],
+                       'password' => Passman::Crypto.decrypt(data['password'], key) }]
+    end
+
+    def exist?(account)
+      raise ArgumentError, 'No account provided.' unless valid?(account)
+      !(!database[account.to_s])
+    end
+
+    def list
+      database
+    end
+
+    private
+
+    def validate_add_arguments(account, username, password, key)
+      raise ArgumentError, 'No account provided.' unless valid?(account)
+      raise ArgumentError, 'No username provided.' unless valid?(username)
+      raise ArgumentError, 'No password provided.' unless valid?(password)
+      raise ArgumentError, 'No key provided.' unless valid?(key)
+    end
+
+    def validate_get_arguments(account, key)
+      raise ArgumentError, 'No account provided.' unless valid?(account)
+      raise ArgumentError, 'No key provided.' unless valid?(key)
+    end
+
+    def valid?(argument)
+      !(argument.nil? || argument.empty?)
+    end
+
+    def database
+      return JSON.parse(File.read(@file_path)) if File.exist?(@file_path)
+      {}
+    end
+
+    def store_data(data)
+      File.delete(@file_path) if File.exist?(@file_path)
+      file = File.open(@file_path, 'w+')
+      file.write(JSON.generate(data))
+      file.close
+    end
+  end
+end

data/lib/passman/password_generator.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 module Passman
   class PasswordGenerator
     def self.generate(length)
-      SecureRandom.hex(length)
+      SecureRandom.hex(length.to_i / 2)
     end
   end
 end

data/lib/passman/version.rb

@@ -1,3 +1,3 @@
 module Passman
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alejandro Bezdjian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -103,6 +103,7 @@ files:
 - bin/passman
 - lib/passman.rb
 - lib/passman/crypto.rb
+- lib/passman/manager.rb
 - lib/passman/password_generator.rb
 - lib/passman/version.rb
 - passman.gemspec