dgen 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d401a5a3ae4f5f7e38d9374c5071a40b2cceecd5
-  data.tar.gz: 0713c03b735403a7ec8ab427f17060cd0a70878a
+  metadata.gz: 4cfb3588e2b4bcadcad552501b70b42ea1d31ec2
+  data.tar.gz: 016f9d876d44657a84c05e5c51a136cdd8eb9e3e
 SHA512:
-  metadata.gz: 82423d35a7d6d82d9c54cf172ed83e6bce7d18db74299213c3740264ab59cfa6d5e832548ee18b472b6b136e78a7fa2b43a65687cf0fc382977ae9f30dbe6645
-  data.tar.gz: 87263cb6ecf3b9b48a813e458d2426aad08908a818bac43906d63c8aa2d479fdbd19b85016b23e4b6281b42ea503690704b5f43c7ce982e7f2ebfcbc02f873aa
+  metadata.gz: e382e30496b8935d16c985fda4906a5191831d6d2c4add1227e162cc0efb4ca143f6aee849c6058ad5a37b86aee1109903658655aee7e0e5ce19501349db10bf
+  data.tar.gz: b0755d41f68d3a493dbacbfbd510979807b4677f4315a0d9a74f06b613ab56de66086b2b5125039f9a7f784817561b69d0284fec87947713370f2fe0651ba85d

data/lib/dgen/base.rb

@@ -1,36 +1,17 @@
-# == Synopsis
+##
+# Base Script
 #
-# dgen: generates diceware passphrases
-#
-#
-# == Usage
-#
-# dgen [OPTIONS]
-#
-# -h, --help:
-#   show help
-#
-# -i, --interactive:
-#   use the interactive menu to generate passphrases
+# This script handles the behavior of the program based on the options
+# provided by the user.
 #
 # Copyright 2015 Richard Davis GPL v3
 require 'optparse'
-require 'dgen/passgen'
-
-def interactive
-  print 'Number of words for phrase (recommended minimum is 6 words) => '
-  n_words = gets.chomp.to_i
-  print 'Length of passphrase (recommended minimum is 17 characters) => '
-  p_length = gets.chomp.to_i
-  path = File.expand_path(File.join(File.dirname(__FILE__),
-                                    '..',
-                                    'assets',
-                                    'word-list.txt'))
-  f = File.new(path, 'r')
-  phrase = PassGen.new.generate_phrase(n_words, p_length, f)
-  puts "Passphrase with spaces:    '#{phrase}'"
-  puts "Passphrase without spaces: '#{phrase.delete(' ')}'"
-  f.close
+require 'dgen/passgen.rb'
+require 'dgen/outputfile.rb'
+
+trap('INT') do
+  puts 'Terminating...'
+  exit
 end
 
 options = {}
@@ -38,8 +19,17 @@ options = {}
 optparse = OptionParser.new do |opts|
   opts.banner = 'Usage: dgen [options]'
 
-  opts.on('-i', '--interactive', 'Manually enter constraints') do
-    options[:interactive] = true
+  opts.on('-s', '--single', 'Generate a single passphrase') do
+    options[:single] = true
+  end
+
+  opts.on('-b', '--batch', 'Generate multiple passphrases') do
+    options[:batch] = true
+  end
+
+  opts.on('-o', '--open file', 'Opens encrypted output file') do |file|
+    options[:open] = true
+    options[:file] = file
   end
 
   opts.on('-h', '--help', 'Display this screen') do
@@ -50,8 +40,43 @@ end
 
 optparse.parse!
 
-if options[:interactive]
-  interactive
+if options[:open]
+  begin
+    OutputFile.open_ofile(options[:file])
+    exit
+  rescue
+    puts 'An error occurred while trying to open the file.'
+    exit
+  end
+end
+
+print 'Number of words for phrase (recommended minimum is 6 words) => '
+n_words = gets.chomp.to_i
+print 'Length of passphrase (recommended minimum is 17 characters) => '
+p_length = gets.chomp.to_i
+
+if options[:single]
+  single_pass = PassGen.single(n_words, p_length)
+  puts 'Save this passphrase in an encrypted file? (Y/N) => '
+  save = gets.chomp
+  exit unless save.upcase == 'Y'
+  begin
+    OutputFile.save_pass(single_pass)
+  rescue
+    puts 'Unable to save passphrase to output file.'
+    exit
+  end
+elsif options[:batch]
+  batch_pass = PassGen.batch(n_words, p_length)
+  puts 'Save the passphrases in an encrypted file? (Y/N) => '
+  save = gets.chomp
+  exit unless save.upcase == 'Y'
+  begin
+    OutputFile.save_batch(batch_pass)
+  rescue
+    puts 'Unable to save passphrases to output file.'
+    exit
+  end
 else
   puts 'You did not enter a valid option. Try --help.'
 end

data/lib/dgen/outputfile.rb

@@ -0,0 +1,76 @@
+##
+# OutputFile Module
+#
+# This module provides the methods that enable saving generated passwords
+# securely to a file.
+#
+# The encryption algorithm used is Blowfish, developed by Bruce Schneier.
+#
+# Copyright 2015 Richard Davis GPL v3
+require 'crypt/blowfish'
+
+##
+# Provides the output file module for use as a mixin.
+#
+module OutputFile
+  ##
+  # Encrypts a given passphrase.
+  #
+  def self.encrypt(phrase, key)
+    blowfish = Crypt::Blowfish.new(key)
+    e_phrase = blowfish.encrypt_string(phrase)
+    e_phrase
+  end
+
+  ##
+  # Decrypts a given passphrase.
+  #
+  def self.decrypt(e_phrase, key)
+    blowfish = Crypt::Blowfish.new(key)
+    phrase = blowfish.decrypt_string(e_phrase)
+    phrase
+  end
+
+  ##
+  # Saves passphrase to a file.
+  #
+  def self.save_pass(phrase)
+    print 'Enter name for output file => '
+    o_file = gets.chomp
+    f = File.open("#{o_file}", 'w+')
+    print 'Enter a key for encryption => '
+    key = gets.chomp
+    e_phrase = encrypt(phrase, key)
+    f.puts e_phrase
+    f.close
+  end
+
+  ##
+  # Saves passphrases to a file.
+  #
+  def self.save_batch(phrase)
+    print 'Enter name for output file => '
+    o_file = gets.chomp
+    f = File.open("#{o_file}", 'w+')
+    print 'Enter a key for encryption => '
+    key = gets.chomp
+    phrase.each do |p|
+      e_phrase = encrypt(p, key)
+      f.puts e_phrase
+    end
+    f.close
+  end
+
+  ##
+  # Opens a previously saved output file for reading.
+  #
+  def self.open_ofile(file)
+    print 'Enter a key for decryption => '
+    key = gets.chomp
+    File.foreach(file) do |l|
+      e_phrase = l.chomp
+      phrase = decrypt(e_phrase, key)
+      puts "Decrypted passphrase: '#{phrase}'"
+    end
+  end
+end

data/lib/dgen/passgen.rb

@@ -1,11 +1,22 @@
-# PassGen Class
+##
+# PassGen Module
+#
+# This module provides the methods that compose the password generator.
+#
+# The algorithm used to generate passwords is the Diceware method, developed
+# by Arnold Reinhold.
+#
 # Copyright 2015 Richard Davis GPL v3
 require 'securerandom'
 
-# creates a generator object
-class PassGen
-  # creates array of random numbers
-  def roll_nums
+##
+# Provides the password generation module for use as a mixin.
+#
+module PassGen
+  ##
+  # Creates an array of random numbers generated securely.
+  #
+  def self.roll_nums
     numbers = []
     5.times do
       numbers.push(SecureRandom.random_number(6) + 1)
@@ -14,9 +25,22 @@ class PassGen
     num
   end
 
-  # chooses words from wordlist
-  def find_word(file, number)
-    # scan file for number
+  ##
+  # Opens and returns the file containing the diceware word list.
+  #
+  def self.open_wordlist
+    path = File.expand_path(File.join(File.dirname(__FILE__),
+                                      '..',
+                                      'assets',
+                                      'word-list.txt'))
+    wordlist = File.new(path, 'r')
+    wordlist
+  end
+
+  ##
+  # Chooses words from the diceware word list for the passphrase.
+  #
+  def self.find_word(file, number)
     File.foreach(file) do |line|
       num = line.slice(0, 5)
       @word = line.slice(6..-2)
@@ -25,22 +49,47 @@ class PassGen
     @word
   end
 
-  # makes the passphrase from the chosen words
-  def make_phrase(words)
-    phrase = words.join(' ')
-    phrase
-  end
-
-  # generates and returns the pass phrase
-  def generate_phrase(n_words, p_length, file)
+  ##
+  # Generates and returns the passphrase.
+  #
+  def self.make_phrase(n_words, p_length, file)
     loop do
       words = []
       n_words.times do
         words.push(find_word(file, roll_nums))
       end
-      @pass_phrase = make_phrase(words)
+      @pass_phrase = words.join(' ')
       break unless @pass_phrase.length < p_length
     end
     @pass_phrase
   end
+
+  ##
+  # Produces and displays a single passphrase.
+  #
+  def self.single(n_words, p_length)
+    f = open_wordlist
+    phrase = make_phrase(n_words, p_length, f)
+    puts "Passphrase with spaces:    '#{phrase}'"
+    puts "Passphrase without spaces: '#{phrase.delete(' ')}'"
+    f.close
+    phrase
+  end
+
+  ##
+  # Produces and displays multiple passphrases.
+  #
+  def self.batch(n_words, p_length)
+    f = open_wordlist
+    phrase = []
+    print 'How many passphrases to generate? => '
+    num_pass = gets.chomp.to_i
+    num_pass.times do |i|
+      phrase.push(make_phrase(n_words, p_length, f))
+      puts "Passphrase with spaces:    '#{phrase[i]}'"
+      puts "Passphrase without spaces: '#{phrase[i].delete(' ')}'"
+    end
+    f.close
+    phrase
+  end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: dgen
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Richard Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
-dependencies: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 description: |2
     Using the diceware method to generate passwords results in stronger passwords
     that are more resistant to cracking. This project implements the diceware
@@ -24,6 +44,7 @@ files:
 - lib/assets/word-list.txt
 - lib/dgen.rb
 - lib/dgen/base.rb
+- lib/dgen/outputfile.rb
 - lib/dgen/passgen.rb
 - test/test_dgen.rb
 homepage: https://github.com/d3d1rty/dgen