cipher_bureau 0.2.1

data/lib/cipher_bureau/exceptions.rb

@@ -0,0 +1,25 @@
+# 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.
+
+module CipherBureau
+  class ArgumentError < StandardError; end
+end

data/lib/cipher_bureau/password.rb

@@ -0,0 +1,114 @@
+# 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.
+
+class CipherBureau::Password
+  attr_reader :length, :options
+  
+  class << self
+    def random(*args)
+      enum :random, *args
+    end
+    
+    def letters_and_numbers(*args)
+      enum :letters_and_numbers, *args
+    end
+
+    def numbers_only(*args)
+      enum :numbers_only, *args
+    end
+    
+    def symbols_and_numbers(*args)
+      enum :symbols_and_numbers, *args
+    end
+
+    def memorable(*args)
+      enum :memorable, *args
+    end
+    
+    def strength(password)
+      CipherBureau::PasswordMeter.strength(password)
+    end
+    
+    private
+      def enum(method, *args)
+        options = args.extract_options!
+        count = args.first || 1
+        as_hash = options.delete(:as) == :hash
+        if options.delete(:strength)
+          res = count.times.collect do
+            s = strength( p = self.new(options).send(method) )
+            as_hash ? {:password => p, :strength => s } : [p, s] 
+          end
+        else
+          res = count.times.collect { self.new(options).send(method) }
+        end
+        count == 1 ? res.first : res
+      end
+  end
+  
+  def initialize(options = {})
+    @options = options.reverse_merge(CipherBureau.default_memorable_options)
+    @options.assert_valid_keys(:length, :country_code, :ascii, :grammar, :name_type, :camelize, :middle_numbers)
+    @length = @options.delete(:length) || CipherBureau.password_length
+    raise ArgumentError, 'Password length is undefined.' unless @length
+    @options.delete(:name_type) unless @options[:grammar] == 'name'
+  end
+  
+  NUMBERS = ('0'..'9').to_a
+  RANDOM = ('!'..'~').to_a
+  LETTERS_AND_NUMBERS = ('a'..'z').to_a + ('A'..'Z').to_a + NUMBERS
+  SYMBOLS_AND_NUMBERS = RANDOM - ('a'..'z').to_a - ('A'..'Z').to_a
+  
+  def random(size = length)
+    (0...size).map{RANDOM.sample}.join
+  end
+
+
+  def letters_and_numbers(size = length)
+    (0...size).map{LETTERS_AND_NUMBERS.sample}.join
+  end
+
+  def numbers_only(size = length)
+    (0...size).map{NUMBERS.sample}.join
+  end
+
+  def memorable()
+    sym_size = length / 4   
+    end_size = (length - sym_size) / 2
+    beg_size = length - end_size - sym_size
+    # puts "beg_size: #{beg_size} sym_size: #{sym_size} end_size: #{end_size}"
+    beg_word = CipherBureau::Dictionary.random(beg_size, scope)
+    end_word = CipherBureau::Dictionary.random(end_size, scope)
+    sym_word = options[:middle_numbers] ? numbers_only(sym_size) : symbols_and_numbers(sym_size)
+    "#{beg_word}#{sym_word}#{end_word}"
+  end
+  
+  def symbols_and_numbers(size = length)
+    (0...size).map{SYMBOLS_AND_NUMBERS.sample}.join
+  end
+
+protected
+  def scope
+    options.slice(:length, :country_code, :ascii, :grammar, :name_type, :camelize)
+  end
+
+end

data/lib/cipher_bureau/password_meter.rb

@@ -0,0 +1,183 @@
+# 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.
+
+class CipherBureau::PasswordMeter
+  LETTERS = ('a'..'z').to_a.join
+  NUMBERS = (0..9).to_a.join
+  SYMBOLS = ')!@#$%^&*()'
+  
+  attr_reader :password, :length
+  def initialize(password)
+    self.password = password
+  end
+
+  def password=(password)
+    @absolute_score = nil
+    @length = password.length
+    @password = password
+  end
+
+  def self.strength(password)
+    new(password).strength
+  end
+  
+  def strength
+    n = absolute_score  
+    n > 100 ? 100 : (n < 0 ? 0 : n )
+  end
+
+  def verbose_strength
+    case strength
+    when 0...20   then "Very Weak"
+    when 20...40  then "Weak"
+    when 40...60  then "Good"
+    when 60...80  then "Strong"
+    else
+      "Very Strong"
+    end
+  end
+
+  def absolute_score
+    #@absolute_score ||= 
+    additions - deductions
+  end
+
+  def additions
+    number_of_characters + uppercase_letters + lowercase_letters + numbers + symbols + middle_numbers_or_symbols + requirements
+  end
+  
+  def deductions
+    letters_only + numbers_only + repeated_characters + 
+      sequential_letters + sequential_numbers + sequential_symbols +
+      consecutive_uppercase + consecutive_lowercase + consecutive_numbers
+  end
+  
+# Additions
+  def number_of_characters
+    password.length * 4
+  end
+  def uppercase_letters
+    n = password.gsub(/[^A-Z]/, '\1').length
+    n > 0 ? (length - n) * 2 : 0
+  end
+  def lowercase_letters
+    n = password.gsub(/[^a-z]/, '\1').length
+    n > 0 ? (length - n) * 2 : 0
+  end
+  def numbers
+    n = password.gsub(/[^0-9]/, '\1').length
+    n < length ? n * 4 : 0
+  end
+  def symbols
+    password.gsub(/[a-zA-Z0-9_]/, '\1').length * 6
+  end
+  def middle_numbers_or_symbols
+    length < 3 ? 0 : password[1...-1].gsub(/[a-zA-Z]/, '\1').length * 2
+  end
+  def requirements
+    if length >= 8
+      numbers = password.gsub(/[^0-9]/, '\1').length > 0 ? 1 : 0
+      lowercase = password.gsub(/[^a-z]/, '\1').length > 0 ? 1 : 0
+      uppercase = password.gsub(/[^A-Z]/, '\1').length > 0 ? 1 : 0
+      symbols = password.gsub(/[a-zA-Z0-9_]/, '\1').length > 0 ? 1 : 0
+      n = (numbers + lowercase + uppercase + symbols)
+      n > 2 ? (n + 1) * 2 : 0 # add 2 for satisfying length
+    else
+      0
+    end
+  end
+  
+# Deductions  
+  def letters_only
+    n = password.gsub(/[^a-zA-Z]/, '\1').length
+    n == length ? n : 0
+  end
+
+  def numbers_only
+    n = password.gsub(/[^0-9]/, '\1').length
+    n == length ? n : 0
+  end
+
+  def repeated_characters
+    nc = ni = 0
+    length.times do |a|
+      ch_exists = false
+      length.times do |b|
+        if a != b && password[a] == password[b]
+          ch_exists = true
+          ni += (length.to_f / (b - a)).abs
+        end
+      end
+      if ch_exists
+        nc += 1
+        unique = length - nc;
+        ni = unique != 0 ? (ni/unique).ceil : ni.ceil
+      end
+    end
+    ni
+  end
+  
+  def sequential_letters
+    sequential LETTERS, password.downcase
+  end
+  
+  def sequential_numbers
+    sequential NUMBERS
+  end
+
+  def sequential_symbols
+    sequential SYMBOLS
+  end
+  
+  def sequential(str, p = password)
+    n = 0
+    (str.size - 3).times do |i|
+      s = str[i..i + 2]
+      n += 1 if p.include?( s) || p.include?( s.reverse) 
+    end
+    n * 3
+  end
+  
+  def consecutive_uppercase
+    consecutive /[A-Z]/
+  end
+  
+  def consecutive_lowercase
+    consecutive /[a-z]/
+  end
+  
+  def consecutive_numbers
+    consecutive /[0-9]/
+  end
+  
+  def consecutive(pattern)
+    n = 0
+    prev = nil
+    password.chars do |c|
+      m = c.match(pattern)
+      n += 1 if m && prev
+      prev = m
+    end
+    n * 2
+  end
+    
+end

data/lib/cipher_bureau/statistic.rb

@@ -0,0 +1,48 @@
+# 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.
+
+class CipherBureau::Statistic < ActiveRecord::Base
+  validates_presence_of :country_code, :grammar, :length
+
+  class << self
+    # register updates word statistics
+    def register(word)
+      stat = where(:country_code => word.country_code, :grammar => word.grammar, :name_type => word.name_type, 
+        :ascii => word.ascii, :length => word.word.length).first_or_initialize
+      stat.word_count += 1
+      stat.save!
+      stat
+    end
+    
+    # returns number of words indatabase based on selection criteria
+    #
+    #  Examples:
+    #    word_count(5) => number of words with length 5
+    #    word_count(:ascii => true)  number of wordss with true ascii
+    #    word_count(5, :ascii => true)  number of wordsof length 5, with true ascii
+    def word_count(*args)
+      criteria = args.extract_options!
+      criteria.merge!(:length => args.first) if args.first
+      where(criteria).sum(:word_count)
+    end
+  end
+end

data/lib/cipher_bureau/version.rb

@@ -0,0 +1,3 @@
+module CipherBureau
+  VERSION = "0.2.1"
+end

data/lib/generators/cipher_bureau/create_migration_generator.rb

@@ -0,0 +1,40 @@
+# 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.
+
+module CipherBureau
+  class CreateMigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../../templates', __FILE__)
+  
+    def self.next_migration_number(path)
+      @v ||= 0
+      @v += 1
+      Time.now.utc.strftime("%Y%m%d%H%M%S") + "#{@v}"
+    end
+    
+    desc "Creates a migration file for the cipher_bureau_dictionaries tables"
+    def create_table_file
+      migration_template "create_cipher_bureau_dictionaries.rb", "db/migrate/create_cipher_bureau_dictionaries.rb"
+      migration_template "create_cipher_bureau_statistics.rb", "db/migrate/create_cipher_bureau_statistics.rb"
+    end  
+  end
+end

data/lib/generators/cipher_bureau/load_data_generator.rb

@@ -0,0 +1,36 @@
+# 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.
+
+module CipherBureau
+  class LoadDataGenerator < Rails::Generators::Base
+    desc "Loads data into the cipher_bureau_dictionaries table. Default language is 'norwegian'."
+    
+    argument :language, :default => 'norwegian'
+        
+    def load_data
+      puts "Loading #{language} data"
+      load File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'db', 'seeds', language, 'wordloader.rb'))
+      puts "Done."
+    end
+
+  end
+end