passphrase_entropy 0.1.0

data/lib/passphrase_entropy/version.rb

@@ -0,0 +1,3 @@
+class PassphraseEntropy
+  VERSION = "0.1.0"
+end

data/lib/passphrase_entropy.rb

@@ -0,0 +1,38 @@
+require "zlib"
+
+# Estimate the entropy of a passphrase. This is calculated as the number of bytes
+# required to encode the passphrase on top of a Deflate stream of a preset
+# dictionary.
+#
+class PassphraseEntropy
+
+  # Instantiate a new PasswordEntropy calculator.
+  # dictionary should be a String containing a list of words; this is
+  # /usr/share/dict/words by default, which should be good for English systems.
+  #
+  def initialize(dictionary=default_dictionary)
+    @dictionary = dictionary
+  end
+
+  # Estimate the entropy of s (in bytes)
+  #
+  def entropy(s)
+    zlen(s) - baseline
+  end
+
+private
+  def default_dictionary
+    File.read("/usr/share/dict/words")
+  end
+
+  def zlen(s)
+    z = Zlib::Deflate.new
+    out = z.deflate(@dictionary + s, Zlib::FINISH)
+    z.close
+    out.bytesize
+  end
+
+  def baseline
+    @baseline ||= zlen("")
+  end
+end

data/test/passphrase_entropy_test.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+require "minitest/autorun"
+require "passphrase_entropy"
+
+class PassphraseEntropyTest < MiniTest::Unit::TestCase
+
+  def setup
+    @passphrase_entropy = PassphraseEntropy.new
+  end
+
+  def assert_better(better, worse)
+    eb = @passphrase_entropy.entropy(better)
+    ew = @passphrase_entropy.entropy(worse)
+    assert(eb > ew, "Expected #{better} (#{eb}) to be better than #{worse} (#{ew})")
+  end
+
+  def test_adding_punctuation_should_improve_entropy
+    assert_better "rubbish!", "rubbish"
+  end
+
+  def test_random_letters_should_be_better_than_words
+    assert_better "sdfjhweu", "password"
+  end
+
+  def test_capital_letters_and_numbers_should_improve_entropy
+    assert_better "Password1", "password"
+  end
+
+  def test_complex_passwords_should_be_better_than_simple_ones
+    assert_better "Slightly^better 1", "Password1"
+  end
+
+  def test_should_agree_with_xkcd_936
+    assert_better "correct horse battery staple", "Tr0ub4dor&3"
+  end
+
+  def test_mixed_symbols_should_be_better_than_words
+    assert_better "~T3n Char$", "antidisestablishmentarianism"
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: passphrase_entropy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Battley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: pbattley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/passphrase_entropy.rb
+- lib/passphrase_entropy/version.rb
+- test/passphrase_entropy_test.rb
+homepage: https://github.com/alphagov/passphrase_entropy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Estimate the entropy of a passphrase
+test_files:
+- test/passphrase_entropy_test.rb