spass 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+pkg

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'bundler', '~> 1.0'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    spass (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rcov (0.9.11)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  rcov
+  rspec (>= 2.2.0)
+  spass!

data/README.md

@@ -0,0 +1,80 @@
+spass
+=====
+
+spass is a simple passphrase generator that chooses random words from a
+dictionary. It was inspired by [an XKCD strip](http://xkcd.com/936/)
+which reminds us that hard-to-remember passwords are not necessarily hard for a
+computer to guess.
+
+
+Prerequisites
+-------------
+
+Currently, spass only words on Unix-like systems, which are expected to have a
+`/usr/share/dict/words` file. Future versions may support other platforms.
+
+
+Installation
+------------
+
+spass is distributed as a gem, so just do:
+
+    $ gem install spass
+
+
+Usage
+-----
+
+Run `spass` from the command-line to see usage notes. The first argument is the
+minimum passphrase length (in characters). Examples:
+
+    $ spass 12
+    hive frighten
+
+    $ spass 24
+    moppet castigator harvesters
+
+    $ spass 32
+    munificent icebound raymond clorets
+
+Passphrases are guaranteed to be at least as long as the given number, but
+may be longer. By default, the words are taken from `/usr/share/dict/words`;
+if you want to use words from a different dictionary, pass a second argument:
+
+    $ spass 12 my_words.txt
+
+
+Future plans
+------------
+
+- Optional inclusion of uppercase, numbers, symbols
+- Avoid word repetition
+
+
+
+MIT License
+-----------
+
+spass is licensed under the MIT License.
+
+Copyright (c) 2011 Eric Pierce
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/bin/spass

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'spass' # Is this needed?
+
+USAGE = <<EOF
+spass: Generate a passphrase with lowercase words
+
+Usage:
+
+  $ spass <length> [path_to_dict]
+
+This script generates a plain-English passphrase of at least the given length
+(in characters), using random words from the given dictionary file
+(/usr/share/dict/words by default). Only lowercase letters a-z will be included
+in the output, making passphrases relatively easy to type (though usually
+nonsensical).
+
+Examples:
+
+  $ spass 12
+  hive frighten
+
+  $ spass 24
+  moppet castigator harvesters
+
+  $ spass 32
+  munificent icebound raymond clorets
+
+A 32-character passphrase has about 120 bits of entropy, which is overkill for
+most purposes. A 24-character passphrase clocks in at about 90 bits of entropy,
+suitable for most high-security applications like root passwords or financial
+records. You might want to use a password checker to verify the strength of
+your passphrase after generating one that you like:
+
+  http://rumkin.com/tools/password/passchk.php
+
+Inspired by http://xkcd.com/936/
+EOF
+
+if ARGV.count == 0
+  puts USAGE
+else
+  length = ARGV[0].to_i
+  if ARGV[1]
+    sp = SPass.new(ARGV[1])
+  else
+    sp = SPass.new
+  end
+  puts sp.generate(length)
+end
+
+

data/lib/spass.rb

@@ -0,0 +1,43 @@
+
+class SPass
+  attr_reader :dict_path, :dict_lines
+
+  def initialize(dict_path='/usr/share/dict/words')
+    @dict_path = File.expand_path(dict_path)
+    if !File.file?(@dict_path)
+      raise RuntimeError, "Cannot find dict file: #{@dict_path}"
+    end
+    @dict_lines = `wc -l #{@dict_path}`.split.first.to_i
+  end
+
+  # Return a random line number from 1..N where N is the last line
+  # in the dict file
+  def random_line
+    rand(@dict_lines) + 1
+  end
+
+  # Return a random word from the dictionary, lowercased
+  def random_word
+    cmd = "sed -n '#{random_line} {p;q;}' '#{@dict_path}'"
+    `#{cmd}`.chomp.downcase
+  end
+
+  # Return a random word that consists of only lowercase letters
+  def random_ascii_word
+    word = random_word
+    while word =~ /[^a-z]/
+      word = random_word
+    end
+    return word
+  end
+
+  # Generate a passphrase of at least the given length in characters
+  def generate(length)
+    phrase = ''
+    while phrase.length < length + 1 # to account for trailing space
+      phrase += random_ascii_word + ' '
+    end
+    return phrase.chomp
+  end
+end
+

data/spass.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = "spass"
+  s.version = "0.0.1"
+  s.summary = "Generate passphrases"
+  s.description = <<-EOS
+    spass generates passphrases using random words
+  EOS
+  s.authors = ["Eric Pierce"]
+  s.email = "wapcaplet88@gmail.com"
+  s.homepage = "http://github.com/wapcaplet/spass"
+  s.platform = Gem::Platform::RUBY
+
+  s.add_development_dependency 'rspec', '>= 2.2.0'
+  s.add_development_dependency 'rcov'
+  #s.add_development_dependency 'yard'
+  #s.add_development_dependency 'bluecloth'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.executables = ['spass']
+end
+

data/spec/data/ten_words

@@ -0,0 +1,10 @@
+one
+two
+three
+four
+five
+six
+seven
+eight
+nine
+ten

data/spec/spass_spec.rb

@@ -0,0 +1,69 @@
+require 'spass'
+
+TEST_DICT = File.expand_path('../data/ten_words', __FILE__)
+
+describe SPass do
+  before(:each) do
+    @sp = SPass.new(TEST_DICT)
+  end
+
+
+  describe "#initialize" do
+    it "correctly sets dict_path" do
+      path = TEST_DICT
+      @sp = SPass.new(path)
+      @sp.dict_path.should == path
+    end
+
+    it "raises an exception for invalid path" do
+      path = File.expand_path('non/existent/path')
+      lambda do
+        @sp = SPass.new(path)
+      end.should raise_error(RuntimeError, /Cannot find dict file/)
+    end
+  end
+
+
+  describe "#random_line" do
+    it "is >= 1" do
+      100.times do
+        @sp.random_line.should be >= 1
+      end
+    end
+
+    it "is <= number of lines" do
+      100.times do
+        @sp.random_line.should be <= @sp.dict_lines
+      end
+    end
+  end
+
+
+  describe "#random_word" do
+    it "only returns words from the dict" do
+      100.times do
+        @sp.random_word.should =~ /one|two|three|four|five|six|seven|eight|nine|ten/
+      end
+    end
+  end
+
+
+  describe "#random_ascii_word" do
+    it "only includes lowercase letters" do
+      10.times do
+        @sp.random_ascii_word.should =~ /^[a-z]+$/
+      end
+    end
+  end
+
+  describe "#generate" do
+    it "is at least the given length" do
+      [10, 15, 20, 25, 30, 35, 40].each do |len|
+        10.times do
+          @sp.generate(len).length.should be >= len
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: spass
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eric Pierce
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-30 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "    spass generates passphrases using random words\n"
+email: wapcaplet88@gmail.com
+executables: 
+- spass
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/spass
+- lib/spass.rb
+- spass.gemspec
+- spec/data/ten_words
+- spec/spass_spec.rb
+has_rdoc: true
+homepage: http://github.com/wapcaplet/spass
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generate passphrases
+test_files: []
+