dgen 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 703010a0616cbf836188f4b6c13561cafb8c825c
-  data.tar.gz: 21fb56a831f02280419cb6a1957d35310dfbf45f
+SHA256:
+  metadata.gz: cf8332f7c9acdb62aa98082b4e16cd43b695a8c74fba3352f1dda9b566d0eb31
+  data.tar.gz: ae25ff18757c3665f2315a7069e82070f035ce1c6e7f70659cd5b9664b776cf0
 SHA512:
-  metadata.gz: 8cc7055162419bc1a12676c6c591b509e7d25cc4412dd193cebe6ea211931b33e0b4d72151785570117ce18f6a3360d997e57a0d22f0f45eb2c949c954f8951f
-  data.tar.gz: 9fc9e38604af5795f64943c5500596f9ee82a5cb60492c165a36f4c8a4ba4a7844bb083fe203e98db5f9a2bc499af33d0f0a8293f8e8e0b8ff168f64b089dabd
+  metadata.gz: 7ae75c0ae186f711de9f41f65c78d5b69cf67115f45f18ae80e357540615f160c7dd99267d0b82818ab433e34249b95020112ce9b71f3ace1fa77df2b773f800
+  data.tar.gz: 881aa03f5e9c6a832fac4f7c84021d8bb25c480e54f6bcefd5d132364442bb6b8293ae3bd9f09a06cbbc1ebf1ac6370f0504b2ed0be5c226b4cf98a00af8a761

data/lib/dgen.rb

@@ -1 +1,28 @@
+# Copyright 2015-2018 Richard Davis
+#
+# This file is part of dgen.
+#
+# dgen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# dgen is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with dgen.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'dgen/base'
+
+##
+# = Dgen
+# Author::    Dick Davis
+# Copyright:: Copyright 2015-2018 Dick Davis
+# License::   GNU Public License 3
+#
+# The namespace for all Dgen components.
+module Dgen
+end

data/lib/dgen/base.rb

@@ -1,16 +1,40 @@
-##
-# dgen
+# Copyright 2015-2018 Richard Davis
+#
+# This file is part of dgen.
+#
+# dgen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# Copyright 2015 Richard Davis GPL v3
+# dgen is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with dgen.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'optparse'
 require 'dgen/passgen.rb'
+require 'dgen/diceware.rb'
 require 'dgen/outputfile.rb'
 
+##
+# = base.rb
+# Author::    Dick Davis
+# Copyright:: Copyright 2015-2018 Dick Davis
+# License::   GNU Public License 3
+#
+# The main script for program execution.
+
+# Catches interrupt signal to terminate program execution.
 trap('INT') do
   puts "\nTerminating..."
   exit
 end
 
+# Parses command-line options to determine program flow.
 options = {}
 
 optparse = OptionParser.new do |opts|
@@ -37,11 +61,14 @@ end
 
 optparse.parse!
 
+# Opens, decrypts, and displays previously saved passphrase file.
 if options[:open]
+  print 'Enter a key for decryption => '
+  key = gets.chomp
   begin
-    OutputFile.open_ofile(options[:file])
+    Dgen::OutputFile.open_ofile(options[:file], key)
     exit
-  rescue
+  rescue IOError
     puts 'An error occurred while trying to open the file.'
     exit
   end
@@ -50,30 +77,49 @@ elsif options.empty?
   exit
 end
 
+# Initializes generator with user-provided configuration options.
 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
+generator = Dgen::PassGen.new(n_words, p_length)
 
+# Generates a single passphrase and optionally saves to encrypted file.
 if options[:single]
-  single_pass = PassGen.single(n_words, p_length)
+  single_pass = generator.single
+  puts "Passphrase:        #{single_pass}"
   puts 'Save this passphrase in an encrypted file? (Y/N) => '
   save = gets.chomp
-  exit unless save.upcase == 'Y'
+  exit unless save.casecmp('Y').zero?
   begin
-    OutputFile.save_pass(single_pass)
-  rescue
+    print 'Enter name for output file => '
+    o_file = gets.chomp
+    print 'Enter a key for encryption => '
+    key = gets.chomp
+    Dgen::OutputFile.save_pass(o_file, key, single_pass)
+  rescue IOError
     puts 'Unable to save passphrase to output file.'
     exit
   end
+
+# Generates multiple passphrases and optionally saves to encrypted file.
 elsif options[:batch]
-  batch_pass = PassGen.batch(n_words, p_length)
+  print 'How many passphrases to generate? => '
+  n_pass = gets.chomp.to_i
+  batch_pass = generator.batch(n_pass)
+  batch_pass.each do |pass|
+    puts "Passphrase:        '#{pass}'"
+  end
   print 'Save the passphrases in an encrypted file? (Y/N) => '
   save = gets.chomp
-  exit unless save.upcase == 'Y'
+  exit unless save.casecmp('Y').zero?
   begin
-    OutputFile.save_batch(batch_pass)
-  rescue
+    print 'Enter name for output file => '
+    o_file = gets.chomp
+    print 'Enter a key for encryption => '
+    key = gets.chomp
+    Dgen::OutputFile.save_batch(o_file, key, batch_pass)
+  rescue IOError
     puts 'Unable to save passphrases to output file.'
     exit
   end

data/lib/dgen/diceware.rb

@@ -0,0 +1,71 @@
+# Copyright 2015-2018 Richard Davis
+#
+# This file is part of dgen.
+#
+# dgen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# dgen is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with dgen.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'securerandom'
+
+module Dgen
+  ##
+  # = Diceware
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2015-2018 Dick Davis
+  # License::   GNU Public License 3
+  #
+  # Methods to generate random numbers, select words from
+  # word list using those numbers, and combine words into
+  # a passphrase.
+  #
+  # The algorithm used to generate passwords is the Diceware method, developed
+  # by Arnold Reinhold.
+  module Diceware
+    ##
+    # Creates an array of random numbers generated securely.
+    def self.roll_nums
+      numbers = []
+      5.times do
+        numbers.push(SecureRandom.random_number(6) + 1)
+      end
+      num = numbers.join('')
+      num
+    end
+
+    ##
+    # Chooses words from the diceware word list for the passphrase.
+    def self.find_word(number, word_list)
+      File.foreach(word_list) do |line|
+        num = line.slice(0, 5)
+        @word = line.slice(6..-2)
+        break if num == number
+      end
+      @word
+    end
+
+    ##
+    # Generates and returns the passphrase.
+    def self.make_phrase(n_words, n_chars, word_list)
+      passphrase = ''
+      loop do
+        words = []
+        n_words.times do
+          words.push(find_word(roll_nums, word_list))
+        end
+        passphrase = words.join(' ')
+        break unless passphrase.length < n_chars
+      end
+      passphrase
+    end
+  end
+end

data/lib/dgen/outputfile.rb

@@ -1,73 +1,77 @@
-##
-# OutputFile Module
+# Copyright 2015-2018 Richard Davis
 #
-# Copyright 2015 Richard Davis GPL v3
-require 'crypt/blowfish'
-
-##
-# This module provides the methods that enable saving generated passwords
-# securely to a file.
+# This file is part of dgen.
 #
-# The encryption algorithm used is Blowfish, developed by Bruce Schneier.
+# dgen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-module OutputFile
-  ##
-  # Encrypts a plaintext file using blowfish encryption.
-  #
-  def self.encrypt(file, key)
-    bf = Crypt::Blowfish.new(key)
-    bf.encrypt_file("plain_#{file}", "#{file}")
-    File.delete("plain_#{file}")
-  end
+# dgen is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with dgen.  If not, see <http://www.gnu.org/licenses/>.
 
-  ##
-  # Decrypts a blowfish encrypted file.
-  #
-  def self.decrypt(file, key)
-    bf = Crypt::Blowfish.new(key)
-    bf.decrypt_file("#{file}", "decrypted_#{file}")
-  end
+require 'crypt/blowfish'
 
+module Dgen
   ##
-  # Saves passphrase to a file.
+  # = OutputFile
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2015-2018 Dick Davis
+  # License::   GNU Public License 3
   #
-  def self.save_pass(phrase)
-    print 'Enter name for output file => '
-    o_file = gets.chomp
-    print 'Enter a key for encryption => '
-    key = gets.chomp
-    f = File.open("plain_#{o_file}", 'w+')
-    f.puts phrase
-    f.close
-    encrypt(o_file, key)
-  end
-
-  ##
-  # Saves passphrases to a file.
+  # This module provides the methods that enable saving generated passwords
+  # securely to a file.
   #
-  def self.save_batch(phrase)
-    print 'Enter name for output file => '
-    o_file = gets.chomp
-    print 'Enter a key for encryption => '
-    key = gets.chomp
-    f = File.open("plain_#{o_file}", 'w+')
-    phrase.each do |p|
-      f.write p + "\n"
+  # The encryption algorithm used is Blowfish, developed by Bruce Schneier.
+  module OutputFile
+    ##
+    # Encrypts a plaintext file using blowfish encryption.
+    def self.encrypt(file, key)
+      bf = Crypt::Blowfish.new(key)
+      bf.encrypt_file("plain_#{file}", file.to_s)
+      File.delete("plain_#{file}")
     end
-    f.close
-    encrypt(o_file, key)
-  end
 
-  ##
-  # Opens a previously saved output file for reading.
-  #
-  def self.open_ofile(file)
-    print 'Enter a key for decryption => '
-    key = gets.chomp
-    decrypt(file, key)
-    File.foreach("decrypted_#{file}") do |l|
-      puts "Decrypted passphrase: '#{l.chomp}'"
+    ##
+    # Decrypts a blowfish encrypted file.
+    def self.decrypt(file, key)
+      bf = Crypt::Blowfish.new(key)
+      bf.decrypt_file(file.to_s, "decrypted_#{file}")
+    end
+
+    ##
+    # Saves passphrase to a file.
+    def self.save_pass(o_file, key, phrase)
+      f = File.open("plain_#{o_file}", 'w+')
+      f.puts phrase
+      f.close
+      encrypt(o_file, key)
+    end
+
+    ##
+    # Saves passphrases to a file.
+    def self.save_batch(o_file, key, phrases)
+      f = File.open("plain_#{o_file}", 'w+')
+      phrases.each do |phrase|
+        f.write phrase + "\n"
+      end
+      f.close
+      encrypt(o_file, key)
+    end
+
+    ##
+    # Opens a previously saved output file for reading.
+    def self.open_ofile(file, key)
+      decrypt(file, key)
+      File.foreach("decrypted_#{file}") do |l|
+        puts "Decrypted passphrase: '#{l.chomp}'"
+      end
+      File.delete("decrypted_#{file}")
     end
-    File.delete("decrypted_#{file}")
   end
 end

data/lib/dgen/passgen.rb

@@ -1,91 +1,67 @@
-##
-# PassGen Module
+# Copyright 2015-2018 Richard Davis
 #
-# Copyright 2015 Richard Davis GPL v3
-require 'securerandom'
-
-##
-# This module provides the methods that compose the password generator.
+# This file is part of dgen.
 #
-# The algorithm used to generate passwords is the Diceware method, developed
-# by Arnold Reinhold.
+# dgen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-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)
-    end
-    num = numbers.join('')
-    num
-  end
+# dgen is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with dgen.  If not, see <http://www.gnu.org/licenses/>.
 
-  ##
-  # 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
+require 'dgen/diceware'
 
+module Dgen
   ##
-  # Chooses words from the diceware word list for the passphrase.
+  # = PassGen
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2015-2018 Dick Davis
+  # License::   GNU Public License 3
   #
-  def self.find_word(file, number)
-    File.foreach(file) do |line|
-      num = line.slice(0, 5)
-      @word = line.slice(6..-2)
-      break if num == number
-    end
-    @word
-  end
-
-  ##
-  # Generates and returns the passphrase.
+  # Generates secure diceware passphrases.
   #
-  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 = words.join(' ')
-      break unless @pass_phrase.length < p_length
+  # The algorithm used to generate passwords is the Diceware method, developed
+  # by Arnold Reinhold.
+  class PassGen
+    # Number of words to use in passphrase.
+    attr_reader :n_words
+    # Minimum character length of passphrase.
+    attr_reader :n_chars
+    # File containing the list of words to select words from.
+    attr_reader :word_list
+
+    ##
+    # Initializes a PassGen instance
+    def initialize(n_words, n_chars)
+      @n_words = n_words
+      @n_chars = n_chars
+      path = File.expand_path(File.join(File.dirname(__FILE__),
+                                        '..',
+                                        'assets',
+                                        'word-list.txt'))
+      @word_list = File.new(path, 'r')
     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:        '#{phrase}'"
-    f.close
-    phrase
-  end
+    ##
+    # Produces and displays a single passphrase.
+    def single
+      Dgen::Diceware.make_phrase(@n_words, @n_chars, @word_list)
+    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:        '#{phrase[i]}'"
+    ##
+    # Produces and displays multiple passphrases.
+    def batch(n_pass)
+      phrases = []
+      n_pass.times do
+        phrases.push(Dgen::Diceware.make_phrase(@n_words, @n_chars, @word_list))
+      end
+      phrases
     end
-    f.close
-    phrase
   end
 end