attr_password 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12f7073d0568e2ee43eec82a4e70aaeca7b37178
+  data.tar.gz: b763a893e3545fa58010056bd821d3e4a1cc79a2
+SHA512:
+  metadata.gz: d56419de3d7969899236100484b99707fe97e032da24e252257923b1dd928407f0d845d1e4671c0537ea295d032c951458d1fd4cb30079a38ed30841959117aa
+  data.tar.gz: 08f5939ed8163a4ea99a021282d0d093a40895eba070c9a42c3ed8a5628dc4a86d57dcd21ab24cfd9cbf33437b10c9ad578ff0f044b0f3a75c9792376abb8cb2

data/.gitignore

@@ -0,0 +1,20 @@
+# OS Files #
+############
+.DS_Store
+.Trashes
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Ruby Files #
+##############
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+/spec/reports/
+/vendor/bundle/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/attr_password.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_password/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attr_password'
+  spec.version       = AttrPassword::VERSION
+  spec.authors       = ['Rediweb Hosting']
+  spec.email         = ['support@rediwebhosting.uk']
+
+  spec.summary       = %q{Password Attribute}
+  spec.description   = %q{Store passwords securely.}
+  spec.homepage      = 'https://rubygems.org/gems/attr_password'
+  spec.license       = 'GPL-3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/(?!((console|setup)$))}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.2'
+  spec.add_dependency 'bcrypt',       '~> 3.1'
+  spec.add_dependency 'unix-crypt',   '~> 1.3'
+
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'attr_password'
+
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/attr_password.rb

@@ -0,0 +1,81 @@
+# The password attribute module
+#
+module AttrPassword
+  class << self
+    # Require dependencies
+    #
+    # Example:
+    #   >> AttrPassword.require!
+    #   => nil
+    #
+    def require!
+      require 'bcrypt'
+      require 'unix_crypt'
+
+      require 'attr_password/constants'
+      require 'attr_password/adapters'
+
+      require 'attr_password/bcrypt'
+      require 'attr_password/sha512'
+      require 'attr_password/sha256'
+      require 'attr_password/md5'
+      require 'attr_password/des'
+    end
+  end
+
+  # Add the password functionality
+  #
+  # Arguments:
+  #   algorithm: (Symbol) (Default :bcrypt)
+  #
+  # Example:
+  #   >> class Test
+  #   >>   has_password :bcrypt
+  #   >> end
+  #
+  def has_password(algorithm = :bcrypt)
+    # Get the backend crypt class
+    backend = case algorithm
+    when :bcrypt
+      AttrPassword::BCrypt.new
+    when :sha512
+      AttrPassword::SHA512.new
+    when :sha256
+      AttrPassword::SHA256.new
+    when :md5
+      AttrPassword::MD5.new
+    when :des
+      AttrPassword::DES.new
+    else
+      return false
+    end
+
+    define_method("password=") do |password|
+      # Get the adapter
+      adapter = AttrPassword::Adapters.for(self)
+
+      # Get the crypted password
+      crypted_password = password ? backend.crypt_password(password) : nil
+
+      # Set the password hash
+      adapter.write_attribute(:crypted_password, crypted_password)
+    end
+
+    define_method("valid_password?") do |password|
+      # Ensure the password is not nil
+      return false if password.nil?
+
+      # Get the adapter
+      adapter = AttrPassword::Adapters.for(self)
+
+      # Check if the password is valid
+      backend.validate_password(password, crypted_password)
+    end
+
+    true
+  end
+end
+
+# Require dependencies
+#
+AttrPassword.require!

data/lib/attr_password/adapters.rb

@@ -0,0 +1,60 @@
+module AttrPassword
+  # This module contains the adapters
+  #
+  module Adapters
+    class << self
+      # Require the adapters
+      #
+      # Example:
+      #   >> AttrPassword::Adapters.require!
+      #   => true
+      #
+      def require!
+        require 'attr_password/adapters/base'
+
+        # Get the glob for the adapters directory
+        adapters_glob = File.expand_path('../adapters/**/*.rb', __FILE__)
+
+        # Loop over each adapter file
+        Dir.glob(adapters_glob).each do |adapter|
+          # Require the adapter file
+          require(adapter)
+        end
+      end
+
+      # Find the best adapter for an object
+      #
+      # Arguments:
+      #   object: (Object)
+      #
+      # Example:
+      #   >> AttrPassword::Adapters.for(object)
+      #   => #<AttrPassword::Adapters::Ruby:0x00000000000000>
+      #
+      def for(object)
+        # The list of all adapters
+        adapters = [
+          AttrPassword::Adapters::ActiveRecord,
+          AttrPassword::Adapters::Ruby
+        ]
+
+        # Loop over each adapter
+        adapters.each do |klass|
+          # Create a new instance of the adapter
+          adapter = klass.new(object)
+
+          # Ensure the adapter is available
+          next unless adapter.available?
+
+          return adapter
+        end
+
+        nil
+      end
+    end
+  end
+end
+
+# Require the adapters
+#
+AttrPassword::Adapters.require!

data/lib/attr_password/adapters/active_record.rb

@@ -0,0 +1,63 @@
+module AttrPassword
+  module Adapters
+    # The ActiveRecord adapter
+    #
+    class ActiveRecord < Base
+      class << self
+        # Attempt to inject the AttrPassword class into ActiveRecord::Base
+        #
+        # Example:
+        #   >> AttrPassword::Adapters::ActiveRecord.inject!
+        #   => nil
+        #
+        def inject!
+          # Ensure the ActiveRecord::Base class is defined
+          return false unless defined?(::ActiveRecord::Base)
+
+          # Make the ActiveRecord::Base class extend the AttrPassword class
+          ::ActiveRecord::Base.send(:extend, AttrPassword)
+
+          true
+        end
+      end
+
+      # Check if this adapter can be used for the object
+      #
+      # Example:
+      #   >> adapter.available?
+      #   => true
+      #
+      def available?
+        # Ensure the ActiveRecord::Base class is defined
+        return false unless defined?(::ActiveRecord::Base)
+
+        # Check if the object inherits from ActiveRecord::Base
+        @object.class.ancestors.include?(::ActiveRecord::Base)
+      end
+
+      # Read an attribute
+      #
+      # Example:
+      #   >> adapter.read_attribute(:hello_world)
+      #   => "Hello, World!"
+      #
+      def read_attribute(attribute)
+        @object.send(:read_attribute, attribute.to_sym)
+      end
+
+      # Write an attribute
+      #
+      # Example:
+      #   >> adapter.write_attribute(:hello_world, "Hello, World!")
+      #   => true
+      #
+      def write_attribute(attribute, value)
+        @object.send(:write_attribute, attribute, value)
+      end
+    end
+  end
+end
+
+# Attempt to inject the AttrPassword class into ActiveRecord::Base
+#
+AttrPassword::Adapters::ActiveRecord.inject!

data/lib/attr_password/adapters/base.rb

@@ -0,0 +1,57 @@
+module AttrPassword
+  module Adapters
+    # The base adapter
+    #
+    class Base
+      # The object the adapter relates to
+      #
+      attr_reader :object
+
+      # Create a new instance of this adapter
+      #
+      # Example:
+      #   >> AttrPassword::Adapters::Base.new(object)
+      #   => #<AttrPassword::Adapters::Base:0x00000000000000>
+      #
+      def initialize(object)
+        # Ensure the object exists
+        unless object
+          raise 'The object property cannot be nil.'
+        end
+
+        # Store the object
+        @object = object
+      end
+
+      # Check if this adapter can be used for the object
+      #
+      # Example:
+      #   >> adapter.available?
+      #   => true
+      #
+      def available?
+        true
+      end
+
+      # Read an attribute
+      #
+      # Example:
+      #   >> adapter.read_attribute(:hello_world)
+      #   => "Hello, World!"
+      #
+      def read_attribute(attribute, value)
+        nil
+      end
+
+      # Write an attribute
+      #
+      # Example:
+      #   >> adapter.write_attribute(:hello_world, "Hello, World!")
+      #   => true
+      #
+      def write_attribute(attribute, value)
+        false
+      end
+    end
+  end
+end

data/lib/attr_password/adapters/ruby.rb

@@ -0,0 +1,27 @@
+module AttrPassword
+  module Adapters
+    # The ActiveRecord adapter
+    #
+    class Ruby < Base
+      # Read an attribute
+      #
+      # Example:
+      #   >> adapter.read_attribute(:hello_world)
+      #   => "Hello, World!"
+      #
+      def read_attribute(attribute)
+        @object.instance_variable_get("@#{attribute}")
+      end
+
+      # Write an attribute
+      #
+      # Example:
+      #   >> adapter.write_attribute(:hello_world, "Hello, World!")
+      #   => true
+      #
+      def write_attribute(attribute, value)
+        @object.instance_variable_set("@#{attribute}", value)
+      end
+    end
+  end
+end

data/lib/attr_password/bcrypt.rb

@@ -0,0 +1,44 @@
+module AttrPassword
+  # The BCrypt class
+  #
+  class BCrypt
+    # Crypt the password
+    #
+    # Arguments:
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd")
+    #   => "$2a$10$Ou0no1.WrBtZm2rF4Te7getynnENc2wESKZDLyJTmqnSPV1TEXZ8y"
+    #
+    def crypt_password(password)
+      # Get the BCrypt password
+      bcrypt = ::BCrypt::Password.create(password)
+
+      # Get the BCrypt string
+      bcrypt.to_s
+    end
+
+    # Check if a password is valid
+    #
+    # Arguments:
+    #   password_hash: (String)
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd", "$2a$10$Ou0no1.WrBtZm2rF4Te7getynnENc2wESKZDLyJTmqnSPV1TEXZ8y")
+    #   => true
+    #
+    def validate_password(password, password_hash)
+      begin
+        # Load the BCrypt password hash
+        bcrypt = ::BCrypt::Password.new(password_hash)
+
+        # Check if the password is valid
+        bcrypt == password
+      rescue => e
+        return false
+      end
+    end
+  end
+end

data/lib/attr_password/constants.rb

@@ -0,0 +1,3 @@
+module AttrPassword
+  VERSION = '0.1.0'
+end

data/lib/attr_password/des.rb

@@ -0,0 +1,40 @@
+module AttrPassword
+  # The DES class
+  #
+  class DES
+    # Crypt the password
+    #
+    # Arguments:
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd")
+    #   => "5F9dBJsU0KiKQ"
+    #
+    def crypt_password(password)
+      # Get the DES crypt password
+      UnixCrypt::DES.build(password)
+    end
+
+    # Check if a password is valid
+    #
+    # Arguments:
+    #   password_hash: (String)
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd", "5F9dBJsU0KiKQ")
+    #   => true
+    #
+    def validate_password(password, password_hash)
+      # Ensure the password is set
+      return false unless password
+
+      # Ensure the password hash is set
+      return false unless password_hash
+
+      # Check if the password is valid
+      UnixCrypt.valid?(password, password_hash)
+    end
+  end
+end

data/lib/attr_password/md5.rb

@@ -0,0 +1,40 @@
+module AttrPassword
+  # The MD5 class
+  #
+  class MD5
+    # Crypt the password
+    #
+    # Arguments:
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd")
+    #   => "$1$zKiCUMIJ$9w79XD.6T1tQZ3xF2ztcK."
+    #
+    def crypt_password(password)
+      # Get the MD5 crypt password
+      UnixCrypt::MD5.build(password)
+    end
+
+    # Check if a password is valid
+    #
+    # Arguments:
+    #   password_hash: (String)
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd", "$1$zKiCUMIJ$9w79XD.6T1tQZ3xF2ztcK.")
+    #   => true
+    #
+    def validate_password(password, password_hash)
+      # Ensure the password is set
+      return false unless password
+
+      # Ensure the password hash is set
+      return false unless password_hash
+
+      # Check if the password is valid
+      UnixCrypt.valid?(password, password_hash)
+    end
+  end
+end

data/lib/attr_password/sha256.rb

@@ -0,0 +1,40 @@
+module AttrPassword
+  # The SHA256 class
+  #
+  class SHA256
+    # Crypt the password
+    #
+    # Arguments:
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd")
+    #   => "$5$1zQaVXCHYfnNQALN$BKZbxVPaCnhgigMSLDMlmxSLPZHY1HBOEypeL3ZHfbD"
+    #
+    def crypt_password(password)
+      # Get the SHA256 crypt password
+      UnixCrypt::SHA256.build(password)
+    end
+
+    # Check if a password is valid
+    #
+    # Arguments:
+    #   password_hash: (String)
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd", "$5$1zQaVXCHYfnNQALN$BKZbxVPaCnhgigMSLDMlmxSLPZHY1HBOEypeL3ZHfbD")
+    #   => true
+    #
+    def validate_password(password, password_hash)
+      # Ensure the password is set
+      return false unless password
+
+      # Ensure the password hash is set
+      return false unless password_hash
+
+      # Check if the password is valid
+      UnixCrypt.valid?(password, password_hash)
+    end
+  end
+end

data/lib/attr_password/sha512.rb

@@ -0,0 +1,40 @@
+module AttrPassword
+  # The SHA512 class
+  #
+  class SHA512
+    # Crypt the password
+    #
+    # Arguments:
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd")
+    #   => "$6$x7NCbuLU4Bdr2SrU$qb.a9XG7AFszgj0qDO66Xce5pFI5eRcGhAyIrmylEuhYHIsyoCk6DKBOKW/eleMSjBuY10kgtS2zvicwLxZj91"
+    #
+    def crypt_password(password)
+      # Get the SHA512 crypt password
+      UnixCrypt::SHA512.build(password)
+    end
+
+    # Check if a password is valid
+    #
+    # Arguments:
+    #   password_hash: (String)
+    #   password: (String)
+    #
+    # Example:
+    #   >> backend.crypt_password("P@ssw0rd", "$6$x7NCbuLU4Bdr2SrU$qb.a9XG7AFszgj0qDO66Xce5pFI5eRcGhAyIrmylEuhYHIsyoCk6DKBOKW/eleMSjBuY10kgtS2zvicwLxZj91")
+    #   => true
+    #
+    def validate_password(password, password_hash)
+      # Ensure the password is set
+      return false unless password
+
+      # Ensure the password hash is set
+      return false unless password_hash
+
+      # Check if the password is valid
+      UnixCrypt.valid?(password, password_hash)
+    end
+  end
+end

data/spec/matchers/version.rb

@@ -0,0 +1,21 @@
+module AttrPassword
+  module RSpec
+    module Matchers
+      module Version
+        extend ::RSpec::Matchers::DSL
+
+        matcher :be_semantic_version do
+          match do |string|
+            next false if "0.0.0" == string
+
+            string =~ /^[0-9]+\.[0-9]+\.[0-9]+$/
+          end
+
+          failure_message do |string|
+            "%s is not a semantic version" % string
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'attr_password'
+
+Dir.glob(File.expand_path('../matchers/**/*.rb', __FILE__)).each do |matcher|
+  require(matcher)
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/unit/attr_password_spec.rb

@@ -0,0 +1,11 @@
+describe AttrPassword do
+  describe '::VERSION' do
+    include AttrPassword::RSpec::Matchers::Version
+
+    subject { AttrPassword::VERSION }
+
+    it 'should be semantic' do
+      expect(subject).to be_semantic_version
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: attr_password
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rediweb Hosting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: unix-crypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: Store passwords securely.
+email:
+- support@rediwebhosting.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- attr_password.gemspec
+- bin/console
+- bin/setup
+- lib/attr_password.rb
+- lib/attr_password/adapters.rb
+- lib/attr_password/adapters/active_record.rb
+- lib/attr_password/adapters/base.rb
+- lib/attr_password/adapters/ruby.rb
+- lib/attr_password/bcrypt.rb
+- lib/attr_password/constants.rb
+- lib/attr_password/des.rb
+- lib/attr_password/md5.rb
+- lib/attr_password/sha256.rb
+- lib/attr_password/sha512.rb
+- spec/matchers/version.rb
+- spec/spec_helper.rb
+- spec/unit/attr_password_spec.rb
+homepage: https://rubygems.org/gems/attr_password
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Password Attribute
+test_files:
+- spec/matchers/version.rb
+- spec/spec_helper.rb
+- spec/unit/attr_password_spec.rb
+has_rdoc: