cipher_bureau 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/README.md

@@ -0,0 +1,160 @@
+# CipherBureau
+
+### CipherBureau is a simple gem for password generation
+
+Sometimes you need to generate passwords in your application.
+This gem does exactly that. It also has the ability to measure the strength of passwords.
+In addition it contains a dictionary for creating ```memorable``` passwords. Currently the dictionary is only in Norwegian, but you can easily load dictionaries yourself. See separate explanation on how to load dictionaries, setting up defaults etc.
+
+
+# Install and Setup
+
+Install the gem
+
+    gem install cipher_bureau
+    
+Or, in your Gemfile
+
+    gem 'cipher_bureau'
+
+
+## Generating migration and loading dictionary
+
+If you want to use the ```memorable method```, you will need to create a couple of tables for holding the dictionary.
+CipherBureau includes two generators, one for generating the migration, and one for loading the dictionary.
+
+Generate the migration:
+
+    rails generate cipher_bureau:create_migration
+    
+Load the data
+
+    rails generate cipher_bureau:load_data
+    
+Loading the data will take some time as there are more than 600,000 words, including grammar and names.
+
+# Using the password interface
+
+## Basic interface
+
+Generate a password, using random as an example
+
+```Ruby
+    # Generate a single random password with length 10 characters
+    CipherBureau::Password.random(:length => 10)
+     => "ZnipfcIByq" 
+    
+    # Generate two random passwords with length 10 characters
+    CipherBureau::Password.random(2, :length => 10)
+     => ["4X^gb1}oLP", "g%JJJ:Y`O."] 
+    
+    # Generate a random password and measure its strength
+    CipherBureau::Password.random(:length => 10, :strength => true)
+     => ["]KF|O4vANP", 90] 
+    
+    # Generate two random passwords and measure their strength
+    CipherBureau::Password.random(2, :length => 10, :strength => true)
+     => [[")1^flZvQ^4", 100], ["^DGAf83B`s", 98]]
+```
+
+## Configuring default password length
+
+If you want you can configure the default password length
+
+```Ruby
+  # Set deault length to 10 characters
+  CipherBureau.password_length = 10
+```
+
+## Basic methods
+
+### Password generation methods
+
+You can use the same parameters for all password functions, except memorable which takes more parameters
+
+```Ruby
+  CipherBureau::Password.random
+   => "dv$w1eD<5T" 
+   
+  CipherBureau::Password.letters_and_numbers
+   => "qoQIfSrElc" 
+   
+  CipherBureau::Password.numbers_only
+   => "6924908575" 
+   
+  CipherBureau::Password.symbols_and_numbers
+   => "<~%2`!-452" 
+   
+  CipherBureau::Password.memorable
+   => "acti)}flik"
+```
+
+The memorable password emphasize on generating passwords with symbols and numbers in the middle, as this ranks higher in security.
+
+The memorable method accepts more arguments:
+
+* ```:country_code``` - a numerical value of country_code, e.g. Norway 47
+* ```:ascii``` - true of false. Use false to get words outside 7-bits range, such as nordic characters
+* ```:camelize``` - true. Only names has first letter capitalized
+* ```:grammar``` - legal values are: 'adjective','adverb','conjunction','determiner','interjection','name','noun',
+           'musical','numeral','preposition','pronoun','subjunctive','verb','verbalsubst',
+* ```:name_tupe``` - if grammar is specified, you can optionally specify: 'boysname','girlsname', 'surname'
+
+
+Example:
+
+```Ruby
+  CipherBureau::Password.memorable(:length => 12, :grammar => 'name', :name_type => 'girlsname')
+   => "Hedda[)*Turi"
+
+  CipherBureau::Password.memorable(:length => 12, :grammar => 'noun', :camelize => true)
+    => "Aktor2]%Hott" 
+```
+
+### Measuring strength of passwords
+
+The PasswordMeter module is a ruby implementation of the javascript algorithm found at http://www.passwordmeter.com
+It will return a range from 0 to 100 depending on the complexity of the password.
+
+Examples:
+
+```Ruby
+  CipherBureau::PasswordMeter.strength('aaaaaaaa')
+   => 0 
+  CipherBureau::PasswordMeter.strength('abcdaaa1')
+   => 15
+  CipherBureau::PasswordMeter.strength('<~%2`!-452')
+   => 100 
+  CipherBureau::PasswordMeter.strength('Aktor2]%Hott')
+   => 97 
+  CipherBureau::PasswordMeter.strength('test123')
+   => 36 
+```
+
+
+# Configuring defaults
+
+You can configure defaults for passwrd_length and memorable passwords by placing a file in your initializers directory:
+
+```Ruby
+  # config/initializers/cipher_bureau.rb
+  CipherBureau.configure do |config|
+    config.password_length = 10
+    config.default_memorable_options = {
+      country_code: 47,
+      camelize:     true,
+      grammar:      'name'
+    }
+  end
+```
+
+# Loading your own dictionary
+
+See the file db/seeds/norwegian/wordloader.rb
+
+This file loads the Norwegian wordlist and Norwegian names into the database. It explains how to load grammars and names into the database.
+It is recommended to use the same facilities as that source is using.
+CipherBureau::DataLoader is loading data in chunked transactions.
+
+The default repository for dictionaries is located on http://dictionaries.cipher-bureau.net
+You can control the location of the dictionaries by setting the configuration ```language_repository```.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CipherBureau'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/db/seeds/norwegian/wordloader.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'unicode_utils'
+
+country_code = 47
+
+grammar_map = {
+  'prep' =>         'preposition',
+  'verb' =>         'verb',
+  'adj' =>          'adjective',
+  'adv' =>          'adverb',
+  'subst' =>        'noun',
+  'interj' =>       'interjection',
+  'det' =>          'determiner',
+  'pron' =>         'pronoun',
+  'verbalsubst' =>  'verbalsubst',
+  'musikkuttr' =>   'musical',
+  'konj' =>         'conjunction',
+  'numeral' =>      'numeral',
+  'sbu' =>          'subjunctive',
+  'adjektiv' =>     'adjective',
+  'CLB' =>          'conjunction', # or correlative conjunction
+  'nominal' =>      'determiner'
+}
+
+loader = CipherBureau::DataLoader.new(:norwegian, 1000)
+
+puts "Loading grammar"
+loader.process 'NSF-ordlisten', 'NSF-ordlisten.txt' do |str|
+  word, grammar = str.split(' ')
+  word = UnicodeUtils.downcase(word)
+  CipherBureau::Dictionary.create word: word.chomp, grammar: grammar_map[grammar], country_code: country_code  
+end
+
+names_map = {
+  'surname' => 'etternavn',
+  'boysname' => 'guttenavn',
+  'girlsname' => 'jentenavn'
+}
+loader.chunks = 100
+names_map.each do |name_type, file|
+  puts "Loading #{name_type}"
+  loader.process 'norske-navn', "#{file}.txt" do |name|
+    CipherBureau::Dictionary.create word: name, grammar: 'name', name_type: name_type, country_code: country_code
+  end
+end
+
+puts "Total words loaded: #{loader.words}"

data/lib/cipher_bureau.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2013 Dynamic Project Management AS
+# Copyright (c) 2013 Knut I. Stenmark
+#
+# 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.
+
+require 'cipher_bureau/exceptions'
+module CipherBureau
+  def self.table_name_prefix
+    'cipher_bureau_'
+  end
+  
+  autoload :Statistic,      'cipher_bureau/statistic'
+  autoload :Dictionary,     'cipher_bureau/dictionary'
+  autoload :Password,       'cipher_bureau/password'
+  autoload :PasswordMeter,  'cipher_bureau/password_meter'
+  autoload :DataLoader,     'cipher_bureau/data_loader'
+  
+  include ActiveSupport::Configurable
+  
+  # Default password length
+  config_accessor :password_length
+  
+  # Oprions to use for memorable passwords
+  # 
+  #   Valid options:
+  #
+  #     :country_code - a numerical value of country_code, e.g. Norway 47
+  #     :ascii - true of false. Use false to get words outside 7-bits range, such as nordic characters
+  #     :grammar - legal values are: 'adjective','adverb','conjunction','determiner','interjection','name','noun',
+  #               'musical','numeral','preposition','pronoun','subjunctive','verb','verbalsubst',
+  #     :name_tupe - if grammar is specified, you can optionally specify: 'boysname','girlsname', 'surname'
+  #
+  config_accessor :default_memorable_options
+
+  self.default_memorable_options ||= {}
+
+  # Sets repository location for langage files
+  config_accessor :language_repository
+  
+  self.language_repository ||= "http://dictionaries.cipher-bureau.net"
+  
+end

data/lib/cipher_bureau/data_loader.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2013 Dynamic Project Management AS
+# Copyright (c) 2013 Knut I. Stenmark
+#
+# 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.
+
+require 'open-uri'
+
+module CipherBureau
+  class DataLoader
+    attr_reader :words, :language
+    attr_accessor :chunks
+    
+    def initialize(language, chunks = 100, words = 0, verbose = true)
+      @language, @chunks, @words, @verbose = language, chunks, words, verbose
+    end
+
+    def reader(filename)
+      Fiber.new do
+        puts "Reading file #{filename}" if @verbose
+        open(filename).readlines.each do |str|
+          Fiber.yield str
+        end
+        puts "\r#{@words}" if @verbose
+        nil
+      end
+    end
+
+    def writer(fiber, &block)
+      str = nil
+      begin
+        chunks.times do
+          ActiveRecord::Base.transaction do
+            break unless str = fiber.resume
+            yield str.chomp
+            @words += 1
+          end
+          return unless str
+        end
+        print "\r#{@words}" if @verbose
+      end while str
+    end
+    
+    def process(*directories_and_filename, &block)
+      filename = ([CipherBureau.language_repository, language.to_s] + directories_and_filename).join('/')
+      writer(reader(filename), &block)
+    end
+  end
+end

data/lib/cipher_bureau/dictionary.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2013 Dynamic Project Management AS
+# Copyright (c) 2013 Knut I. Stenmark
+#
+# 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.
+
+require 'unicode_utils'
+class CipherBureau::Dictionary < ActiveRecord::Base
+  attr_accessible :word, :grammar, :country_code, :name_type
+  
+  validates_presence_of :word, :grammar, :country_code
+  
+  before_save do
+    self.length = word.length
+    self.ascii = !!(word =~ /^[a-z]+$/)
+    true
+  end
+  
+  after_create do
+    CipherBureau::Statistic.register(self)
+  end
+  
+  class << self
+    def random(*args)
+      criteria = args.extract_options!
+      camelize = criteria.delete(:camelize)
+      criteria.merge!(:length => args.first) if args.first
+      r = fetch_random_word(criteria)
+      r && (camelize ? capitalize(r.word) : r.word)
+    end
+    
+  private
+    def randomized_offset(offset)
+      rand(offset)
+    end
+    
+    def fetch_random_word(criteria)
+      n = CipherBureau::Statistic.word_count(criteria) # get number of elements satisfying criteria
+      where(criteria).offset(randomized_offset(n)).limit(1).first      
+    end
+    
+    def capitalize(word)
+      UnicodeUtils.upcase(word[0]) + word[1..-1]
+    end
+  end
+  
+end