passphrase 0.0.1

data/lib/passphrase/generator.rb

@@ -0,0 +1,52 @@
+#! /usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), 'options')
+require File.join(File.dirname(__FILE__), 'wordlist')
+require File.join(File.dirname(__FILE__), 'random')
+
+module Passphrase
+  class Generator
+
+    attr_reader :num_words
+    attr_reader :odd_char
+    attr_reader :phrase
+    attr_reader :unmixed_phrase
+    attr_reader :words
+
+    def initialize(argv)
+      @options = Options.new(argv)
+      @num_words = @options.num_words
+      @words = []
+    end
+
+    def run
+      word_list = WordList.create
+      list_selector = Random.new(@num_words, 0, word_list.length - 1).rand_array
+      @num_words.times do |iword|
+        word_hash = Random.new(5, 1, 6).rand_array.join.to_sym
+        @words << word_list[list_selector[iword]][word_hash]
+      end
+      @phrase = @unmixed_phrase = @words.join(' ')
+      mix_odd_char if @options.mix
+    end
+
+    private
+
+    def mix_odd_char
+      odd = 
+        %w( ~  &  +  :  ?  4 ) +
+        %w( !  *  [  ;  /  5 ) +
+        %w( # \(  ]  "  0  6 ) +
+        %w( $ \) \\  '  1  7 ) +
+        %w( %  -  {  <  2  8 ) +
+        %w( ^  =  }  >  3  9 )
+      odd_char_index = Random.new(1, 0, odd.length - 1).rand_array.shift
+      word_index = Random.new(1, 0, @num_words - 1).rand_array.shift
+      word_length = @words[word_index].length
+      char_index = Random.new(1, 0, word_length - 1).rand_array.shift unless word_length.zero?
+      char_index ||= 0
+      @words[word_index][char_index] = @odd_char = odd[odd_char_index]
+      @phrase = @words.join(' ')
+    end
+  end
+end

data/lib/passphrase/options.rb

@@ -0,0 +1,60 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require File.join(File.dirname(__FILE__), 'version')
+
+module Passphrase
+  class Options
+
+    NUM_WORDS_RANGE = (3..10)
+    DEFAULT_NUM_WORDS = 5
+
+    attr_reader :num_words
+    attr_reader :mix
+
+    def initialize(argv)
+      @num_words = DEFAULT_NUM_WORDS
+      @mix = true
+      parse(argv)
+      validate
+    end
+
+    private
+
+    def parse(argv)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: passphrase [options]"
+        opts.separator "Options:"
+        opts.on("-n", "--num-words NUMBER", Integer,
+                "Desired number of words (#{NUM_WORDS_RANGE.to_s}), default #{DEFAULT_NUM_WORDS}") do |num|
+          @num_words = num
+        end
+        opts.on("-x", "--[no-]mix", "Mix in odd character, default mix") do |m|
+          @mix = m
+        end
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+        opts.on_tail("-v", "--version", "Show version") do
+          puts "#{$PROGRAM_NAME}, version #{Passphrase::Version::STRING}"
+          exit
+        end
+
+        begin
+          opts.parse!(argv)
+        rescue OptionParser::ParseError => e
+          STDERR.puts e.message, "\n", opts
+          exit(1)
+        end
+      end
+    end
+
+    def validate
+      unless NUM_WORDS_RANGE.include?(@num_words)
+        STDERR.puts "Number of words out of range: allowed #{NUM_WORD_RANGE.to_s}: specified #{@num_words}"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/passphrase/random.rb

@@ -0,0 +1,41 @@
+#! /usr/bin/env ruby
+
+require 'net/http'
+
+module Passphrase
+  class Random
+
+    RANDOM_ORG = "www.random.org"
+
+    attr_reader :num
+    attr_reader :min
+    attr_reader :max
+    attr_reader :via_random_org
+    attr_reader :rand_array
+
+    def initialize(num, min, max)
+      @num, @min, @max = num, min, max
+      @rand_array = []
+      generate_rand_array
+    end
+
+    private
+
+    def generate_rand_array
+      query = "/integers/?col=1&base=10&format=plain&rnd=new" + 
+        "&num=#{@num}&min=#{@min}&max=#{@max}"
+      site = Net::HTTP.new(RANDOM_ORG)
+      response, data = site.get(query)
+      raise unless response.code == "200"
+      @rand_array = data.split.collect {|num| num.to_i}
+      @via_random_org = true
+    rescue
+      max = @max - @min + 1
+      offset = @min
+      @num.times do
+        @rand_array << (rand(max) + offset)
+      end
+      @via_random_org = false
+    end
+  end
+end

data/lib/passphrase/version.rb

@@ -0,0 +1,14 @@
+#! /usr/bin/env ruby
+
+module Passphrase
+  module Version
+
+    # rubygems rational versioning policy
+    # http://docs.rubygems.org/read/chapter/7
+    MAJOR = 0
+    MINOR = 0
+    BUILD = 1
+
+    STRING = [MAJOR, MINOR, BUILD].compact.join('.')
+  end
+end

data/lib/passphrase/wordlist.rb

@@ -0,0 +1,30 @@
+#! /usr/bin/env ruby
+
+require 'zlib'
+require 'base64'
+require File.join(File.dirname(__FILE__), 'data')
+
+module Passphrase
+  module WordList
+
+    def self.create
+      decoded_wordlists
+    end
+
+    private
+
+    def self.decoded_wordlists
+      Data::ENCODED.collect {|encoded_list| self.decode(encoded_list) }
+    end
+
+    def self.decode(encoded_list)
+      decoded_list = {}
+      lines = Zlib::Inflate.inflate(Base64.decode64(encoded_list)).split(/\n/)
+      lines.grep(/^\d{5}/).each do |line|
+        key, value = line.chomp.split
+        decoded_list[key.to_sym] = value
+      end
+      decoded_list
+    end
+  end
+end

data/test/test_options.rb

@@ -0,0 +1,33 @@
+#! /usr/bin/env ruby
+
+require 'test/unit'
+require 'options'
+
+class TestOptions < Test::Unit::TestCase
+
+  def test_000_empty_args
+    opts = Passphrase::Options.new([])
+    assert_equal Passphrase::Options::DEFAULT_NUM_WORDS, opts.num_words
+    assert opts.mix
+  end
+
+  def test_001_specify_num_words
+    num = Passphrase::Options::DEFAULT_NUM_WORDS - 1
+    opts = Passphrase::Options.new(%W{--num-words #{num}})
+    assert_equal num, opts.num_words
+    assert opts.mix
+  end
+
+  def test_002_specify_mix
+    opts = Passphrase::Options.new(%W{--no-mix})
+    assert_equal Passphrase::Options::DEFAULT_NUM_WORDS, opts.num_words
+    assert !opts.mix
+  end
+
+  def test_003_specify_num_words_and_mix
+    num = Passphrase::Options::DEFAULT_NUM_WORDS - 1
+    opts = Passphrase::Options.new(%W{--num-words #{num} --no-mix})
+    assert_equal num, opts.num_words
+    assert !opts.mix
+  end
+end

data/test/test_wordlist.rb

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+
+require 'test/unit'
+require 'wordlist'
+
+class TestOptions < Test::Unit::TestCase
+
+  def setup
+    @wordlist = Passphrase::WordList.create
+  end
+
+  def test_000_sample_words
+    assert_equal 2, @wordlist.length
+    assert_equal "embalm", @wordlist[0][:'24356']
+    assert_equal "potato", @wordlist[1][:'46132']
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: passphrase
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Edmund Sumbar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-15 00:00:00 -07:00
+default_executable: passphrase
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+    requirement: *id001
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.2
+    requirement: *id002
+    prerelease: false
+    type: :development
+description: |+
+  = passphrase
+  
+  Passphrase is a command line tool written in Ruby for generating a passphrase
+  using the {Diceware(TM) method}[http://world.std.com/~reinhold/diceware.html].
+  
+  The act of rolling dice is simulated by requesting random numbers from
+  {www.random.org}[http://www.random.org]. If a network error occurs or a request
+  fails, the program gracefully degenerates to using Ruby's global +rand+ method,
+  which is based on the Mersenne Twister algorithm.
+  
+  Words in the generated passphrase are selected from either the Diceware list or
+  the alternate list edited by Alan Beale, referred to as the _Beale_ list.  The
+  choice of list for each word is made randomly. Both lists are embedded into the
+  code as compressed, base64 encoded strings. No external files are referenced.
+  
+  == Generating a passphrase
+  
+  The command line interface is simple. You have the option to specify the number
+  of words in the generated passphrase within the range of 3 to 10. The default
+  is 5. One _odd_ character is automatically mixed into one of the words
+  comprising the passphrase. You can forgo mixing if desired.
+  
+    Usage: passphrase [options]
+    Options:
+      -n, --num-words NUMBER           Desired number of words (3..10), default 5
+      -x, --[no-]mix                   Mix in odd character, default mix
+      -h, --help                       Show this message
+      -v, --version                    Show version
+  
+  == Examples
+  
+    $ passphrase --num-words 3
+    unmixed phrase => shot elm mild
+    odd character  => !
+    passphrase     => shot e!m mild
+  
+    $ passphrase --num-words 4 --no-mix
+    passphrase => humus smooth persia mz
+  
+  If you don't like a generated passphrase, repeat the command.
+  
+  == Contributing to passphrase
+   
+  * 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) 2011 Edmund Sumbar. See LICENSE.txt for
+  further details.
+  
+email: esumbar@gmail.com
+executables: 
+  - passphrase
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.rdoc
+files: 
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE.txt
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - bin/passphrase
+  - lib/passphrase/data.rb
+  - lib/passphrase/generator.rb
+  - lib/passphrase/options.rb
+  - lib/passphrase/random.rb
+  - lib/passphrase/version.rb
+  - lib/passphrase/wordlist.rb
+  - test/test_options.rb
+  - test/test_wordlist.rb
+has_rdoc: true
+homepage: http://github.com/esumbar/passphrase
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Generate a passphrase using the Diceware method.
+test_files: 
+  - test/test_options.rb
+  - test/test_wordlist.rb