sequel_auth 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7520438387075590996072d0bf3f39a4590313d5cd4ac9ebbd7bfe75b7a4c1c6
+  data.tar.gz: 9e9619c3be523a75011aa8469b4704f9572df4d6d566f8d7fb2463243e20cdd1
+SHA512:
+  metadata.gz: de9544a0e81aee9437200aa43f7a1dae108394a12e6a21a123fd4b95d450cbc8b878395318e96e608e53786cef005252547283ac386094d282219ec76b0ef781
+  data.tar.gz: 27b30df7effd4556194675dcd6d5e847a1dab66a7eb1565f37b5ae052dae47076ffd3eab6b2356cb294c58b41e9de63a1a9e59965b0c5f006a57e653aaa24f08

data/lib/providers/bcrypt.rb

@@ -0,0 +1,35 @@
+require "bcrypt"
+
+module SequelAuth
+  module Providers
+    class Bcrypt
+      class << self
+        
+        def cost
+          @cost ||= ::BCrypt::Engine.cost
+        end
+        
+        def cost=(val)
+          raise ArgumentError,"cost < #{min_cost} not allowed!" if val < min_cost
+          @cost = val
+        end
+        
+        def encrypt(password)
+          raise ArgumentError, "password not a valid string" if !password.is_a?(String) || password.strip.empty?
+          ::BCrypt::Password.create(password, cost: cost)
+        end
+        
+        def matches?(hash,password)
+          ::BCrypt::Password.new(hash)==password
+        rescue ::BCrypt::Errors::InvalidHash
+          false
+        end
+        
+        private
+        def min_cost
+          ::BCrypt::Engine::MIN_COST
+        end
+      end
+    end
+  end
+end

data/lib/providers/crypt.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SequelAuth
+  module Providers
+    class Crypt
+      class << self
+        
+        attr_writer :salt_prefix,:salt_size
+        # Salt prefix - prefix for random salt
+        def salt_prefix
+          @salt_prefix ||= defaults[:salt_prefix]
+        end
+        
+        # Salt size - size as number
+        def salt_size
+          @salt_size ||= defaults[:salt_size]
+        end
+        
+        def salt
+          salt_prefix + (salt_size-salt_prefix.length).times.map { 
+            (('a'..'z').to_a + (1..9).to_a + ('A'..'Z').to_a).sample 
+          }.join
+        end
+        
+        def encrypt(password)
+          password.crypt(salt)
+        end
+        
+        def matches?(hash, password)
+          password.crypt(hash) == hash
+        end   
+        
+        def defaults
+          {
+            salt_prefix: "$6$",
+            salt_size: 16,
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/providers/scrypt.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "scrypt"
+
+module SequelAuth
+  module Providers
+    class Scrypt
+      class << self
+        
+        attr_writer :key_len, :salt_size, :max_time, :max_mem, :max_memfrac
+        # Key length - length in bytes of generated key, from 16 to 512.
+        def key_len
+          @key_len ||= defaults[:key_len]
+        end
+        
+        # Salt size - size in bytes of random salt, from 8 to 32
+        def salt_size
+          @salt_size ||= defaults[:salt_size]
+        end
+        
+        # Max time - maximum time spent in computation
+        def max_time
+          @max_time ||= defaults[:max_time]
+        end
+        
+        # Max memory - maximum memory usage. The minimum is always 1MB
+        def max_mem
+          @max_mem ||= defaults[:max_mem]
+        end
+        
+        # Max memory fraction - maximum memory out of all available. Always
+        # greater than zero and <= 0.5.
+        def max_memfrac
+          @max_memfrac ||= defaults[:max_memfrac]
+        end
+        
+        def encrypt(password)
+          ::SCrypt::Password.create(
+            password,
+            key_len: key_len,
+            salt_size: salt_size,
+            max_mem: max_mem,
+            max_memfrac: max_memfrac,
+            max_time: max_time
+          )
+        end
+
+        def matches?(hash, password)
+          ::SCrypt::Password.new(hash)==password
+        rescue ::SCrypt::Errors::InvalidHash
+          false
+        end   
+        
+        def defaults
+          {
+            key_len: 32,
+            salt_size: 8,
+            max_time: 0.2,
+            max_mem: 1024 * 1024,
+            max_memfrac: 0.5
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/sequel_auth.rb

@@ -0,0 +1,92 @@
+require "sequel"
+require "securerandom"
+require_relative "providers/bcrypt"
+require_relative "providers/scrypt"
+require_relative "providers/crypt"
+
+module Sequel
+  module Plugins
+    module SequelAuth
+      def self.provider(provider,opts={})
+        provider = Kernel.const_get("SequelAuth::Providers::#{provider.to_s.capitalize}")
+        opts.each { |k,v| provider.public_send("#{k}=", v) }
+        provider
+      end
+      
+      def self.configure(model, opts = {})
+        model.instance_eval do
+          @digest_column       = opts.fetch(:digest_column, :password_digest)
+          @include_validations = opts.fetch(:include_validations, true)
+          @provider  = SequelAuth.provider opts.fetch(:provider, :bcrypt),
+              opts.fetch(:provider_opts, {})
+          #Optional columns
+          @access_token_column        = opts.fetch(:access_token_column, nil)
+          @login_count_column         = opts.fetch(:login_count_column, nil)
+          @failed_login_count_column  = opts.fetch(:failed_login_count_column, nil)
+          @last_login_at_column       = opts.fetch(:last_login_at_column,nil)
+        end
+      end
+      
+      module ClassMethods
+        attr_reader :provider, 
+            :digest_column, 
+            :access_token_column, 
+            :login_count_column,
+            :failed_login_count_column,
+            :last_login_at_column,
+            :include_validations
+        
+        # NOTE: nil as a value means that the value of the instance variable
+        # will be assigned as is in the subclass.
+        Plugins.inherited_instance_variables(self, :@provider => nil,
+                                             :@include_validations => nil,
+                                             :@digest_column  => nil)
+        
+      end
+      
+      module InstanceMethods
+        attr_accessor :password_confirmation
+        attr_reader   :password
+        def password=(unencrypted)
+          @password = unencrypted
+          self.send "#{model.digest_column}=",model.provider.encrypt(unencrypted)
+        end
+        
+        def authenticate(unencrypted)
+          if model.provider.matches?(self.send(model.digest_column),unencrypted)
+            if model.login_count_column || model.last_login_at_column
+              #Update login count
+              self.send("#{model.login_count_column}=",self.send(model.login_count_column)+1 ) if model.login_count_column
+              self.send("#{model.last_login_at_column}=",Time.now ) if model.last_login_at_column
+              self.save
+            end
+            self
+          else
+            if model.failed_login_count_column
+              #Update failed login count
+              self.send("#{model.failed_login_count_column}=",self.send(model.failed_login_count_column)+1 )
+              self.save            
+            end
+          end
+        end
+        
+        def reset_access_token
+          if model.access_token_column
+            self.update(model.access_token_column=>SecureRandom.urlsafe_base64(16))
+          end
+        end
+        
+        def validate
+          super
+          
+          if model.include_validations
+            errors.add :password, 'is not present'              if password.nil? && new?
+            errors.add :password, 'doesn\'t match confirmation' if password != password_confirmation
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/sequel_auth/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sequel
+  module Plugins
+    module SequelAuth
+      VERSION = '0.0.6'
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: sequel_auth
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Fatih GENÇ
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !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: scrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Plugin to add authentication methods to Sequel Model
+email: fatihgnc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/providers/bcrypt.rb
+- lib/providers/crypt.rb
+- lib/providers/scrypt.rb
+- lib/sequel_auth.rb
+- lib/sequel_auth/version.rb
+homepage: https://gitlab.com/ikilifikir/sequel_auth
+licenses:
+- MIT
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Plugin to add authentication methods to Sequel Model Select one of crypt,
+  bcrypt, scrypt
+test_files: []