devise_pam_authenticatable2 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16387d390e7ee4a8e8c85d26e353126718a25e07
-  data.tar.gz: 0ed2cccb98705bdf0144e8b5a0c08df4d76e58d0
+  metadata.gz: 4f9628d3cf2664bae5f639899ba105b4c7bbcfb2
+  data.tar.gz: b7be5e5d0e46c978b11952d5b760a13779c53493
 SHA512:
-  metadata.gz: c8ed07a8892ddbb2ac01d182dfc439f0f062a0384098e88ac1002423f532bc8183a93fdfb60538ca98f6cfb67e88638ca3d1381de4f4da7c76d5bdaf35b70234
-  data.tar.gz: ba2e9ec56067359e235c1d729a8c18f0a5c1ed27d883a80fc0adc59d1f89fdcd0964643de2b38e7efa406ce04c148bd0e31cb0792256f62ab0ea68e0e3bf946e
+  metadata.gz: 2c3ba8094e16ece90da12a97d38ff4ea0b867fceb42a81293accdfe0c0fe20a1a1773ad4892e44ae75c445e068d5cdb9519f5b742a9ebe1536c4d0b784a91e36
+  data.tar.gz: 53bfd564175eb464ebadfc3e89baeabcf0e3a56eb4e38504df28faa73d82fbd2326f45c6ab7e149d742e4d600d0b13aee1a95cf5e196e6b20dcf45ed8bf628bc

data/README.md

@@ -51,6 +51,7 @@ Options:
 * config.pam_default_suffix = "pam" # username@pam = username
 * config.emailfield = "email" # set emailfield, set to nil if not available
 * config.usernamefield = "username" # set to nil to disable username (only email extraction)
+* config.check_at_sign = false # detect if email field contains username by @ sign (make sure names cannot contain @ signs)
 
 References
 ----------

data/VERSION

@@ -1 +1 @@
-3.0.0
+4.0.0

data/devise_pam_authenticatable2.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: devise_pam_authenticatable2 3.0.0 ruby lib
+# stub: devise_pam_authenticatable2 4.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "devise_pam_authenticatable2".freeze
-  s.version = "3.0.0"
+  s.version = "4.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["James Wilson".freeze, "Alexander Kaftan".freeze]
-  s.date = "2017-11-28"
+  s.date = "2018-01-16"
   s.description = "For authenticating against PAM (Pluggable Authentication Modules)".freeze
   s.email = "devkral@web.de".freeze
   s.extra_rdoc_files = [

data/lib/devise_pam_authenticatable.rb

@@ -5,16 +5,18 @@ require 'devise_pam_authenticatable/model'
 require 'devise_pam_authenticatable/strategy'
 module Devise
   mattr_accessor :pam_default_service
-  @@pam_default_service = "rpam"
+  @@pam_default_service = 'rpam'
   mattr_accessor :pam_default_suffix
   @@pam_default_suffix = nil
   mattr_accessor :emailfield
-  @@emailfield = "email"
+  @@emailfield = 'email'
   mattr_accessor :usernamefield
-  @@usernamefield = "username"
+  @@usernamefield = 'username'
+  mattr_accessor :check_at_sign
+  @@check_at_sign = false
 end
 Devise.add_module(:pam_authenticatable,
                   :route => :session,
                   :strategy   => true,
                   :controller => :sessions,
-                  :model => "devise_pam_authenticatable/model")
+                  :model => 'devise_pam_authenticatable/model')

data/lib/devise_pam_authenticatable/model.rb

@@ -3,33 +3,18 @@ require 'devise_pam_authenticatable/strategy'
 module Devise
   module Models
     module PamAuthenticatable
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-          attr_accessor :password
-        end
-      end
-
-      def self.required_fields(klass)
-        []
-      end
-
-      # Set password to nil
-      def clean_up_passwords
-        self.password = nil
-      end
 
       def get_service
-        return self.class.pam_service if self.class.instance_variable_defined?("@pam_service")
-        ::Devise::pam_default_service
+        return self.class.pam_service if self.class.instance_variable_defined?('@pam_service')
+        ::Devise.pam_default_service
       end
 
       def get_suffix
-        return self.class.pam_suffix if self.class.instance_variable_defined?("@pam_suffix")
-        ::Devise::pam_default_suffix
+        return self.class.pam_suffix if self.class.instance_variable_defined?('@pam_suffix')
+        ::Devise.pam_default_suffix
       end
 
-      def pam_on_filled_pw(attributes)
+      def pam_on_filled_pw(_attributes)
         # use blank password as discriminator between traditional login and pam login?
         # to disable login with pam return nil elsewise return a (different?) user object
         # as default assume there is no conflict and return user object
@@ -37,68 +22,70 @@ module Devise
       end
 
       def pam_setup(attributes)
-        return unless ::Devise::emailfield && ::Devise::usernamefield
-        self[::Devise::emailfield] = Rpam2.getenv(get_service, get_pam_name, attributes[:password], "email", false)
-        self[::Devise::emailfield] = attributes[::Devise::emailfield] if self[::Devise::emailfield].nil?
-        self[::Devise::emailfield] = "#{self[::Devise::usernamefield]}@#{get_suffix}" if self[::Devise::emailfield].nil? && get_suffix
+        return unless ::Devise.emailfield && ::Devise.usernamefield
+        self[::Devise.emailfield] = Rpam2.getenv(get_service, get_pam_name, attributes[:password], 'email', false)
+        self[::Devise.emailfield] = attributes[::Devise.emailfield] if self[::Devise.emailfield].nil?
+        self[::Devise.emailfield] = "#{self[::Devise.usernamefield]}@#{get_suffix}" if self[::Devise.emailfield].nil? && get_suffix
       end
 
       def password_required?
-        return false
+        false
       end
 
       def get_pam_name
-        return self[::Devise::usernamefield] if ::Devise::usernamefield
-        suffix = get_suffix()
-        return nil unless suffix && ::Devise::emailfield
-        email = "#{self[::Devise::emailfield]}\n"
+        return self[::Devise.usernamefield] if ::Devise.usernamefield && self[::Devise.usernamefield]
+        suffix = get_suffix
+        return nil unless suffix && ::Devise.emailfield
+        email = "#{self[::Devise.emailfield]}\n"
         pos = email.index("@#{suffix}\n")
         return nil unless pos
         email.slice(0, pos)
       end
 
       # Checks if a resource is valid upon authentication.
-      def valid_pam_authentication?(password)
-        Rpam2.auth(get_service, get_pam_name, password)
+      def valid_pam_authentication?(pw)
+        return nil unless get_pam_name
+        Rpam2.auth(get_service, get_pam_name, pw)
       end
 
       module ClassMethods
         Devise::Models.config(self, :pam_service, :pam_suffix)
 
-        def authenticate_with_pam(attributes={})
-          if ::Devise::usernamefield && attributes[::Devise::usernamefield]
-            resource = where(::Devise::usernamefield => attributes[::Devise::usernamefield]).first
+        def authenticate_with_pam(attributes = {})
+          return nil unless attributes[:password]
+          if ::Devise.usernamefield && attributes[:username]
+            resource = find_by(::Devise.usernamefield => attributes[:username])
 
             if resource.blank?
               resource = new
-              resource[::Devise::usernamefield] = attributes[::Devise::usernamefield]
+              resource[::Devise.usernamefield] = attributes[:username]
             end
-          elsif ::Devise::emailfield
-            return nil unless attributes[::Devise::emailfield]
-            resource = where(::Devise::emailfield => attributes[::Devise::emailfield]).first
+          elsif ::Devise.emailfield
+            return nil unless attributes[:email]
+            resource = find_by(::Devise.emailfield => attributes[:email])
 
-            if resource.blank? && ::Devise::usernamefield.nil?
+            if resource.blank?
               resource = new
-              resource[::Devise::emailfield] = attributes[::Devise::emailfield]
-            elsif resource.blank?
-              return nil
+              if ::Devise.check_at_sign && ::Devise.usernamefield && attributes[:email].index('@').nil?
+                # use email as username
+                resource[::Devise.usernamefield] = attributes[:email]
+              else
+                resource[::Devise.emailfield] = attributes[:email]
+              end
             end
           else
             return nil
           end
 
           # potential conflict detected
-          resource = resource.pam_on_filled_pw(attributes) unless resource.password.blank?
+          resource = resource.pam_on_filled_pw(attributes) if resource.respond_to?('password') && resource.password.present?
 
-          if resource && resource.try(:valid_pam_authentication?, attributes[:password])
-            if resource.new_record?
-              resource.pam_setup(attributes)
-              resource.save!
-            end
-            return resource
-          else
-            return nil
+          return nil unless resource && resource.try(:valid_pam_authentication?, attributes[:password])
+          if resource.new_record?
+            resource.pam_setup(attributes)
+            resource.save!
           end
+          resource
         end
       end
     end

data/lib/devise_pam_authenticatable/strategy.rb

@@ -1,15 +1,18 @@
 require 'devise/strategies/base'
 
+
 class Devise::Strategies::PamAuthenticatable < Devise::Strategies::Authenticatable
+  def valid?
+    super && (::Devise.emailfield || ::Devise.usernamefield)
+  end
 
   def authenticate!
-    if resource = mapping.to.authenticate_with_pam(params[scope])
+    if (resource = mapping.to.authenticate_with_pam(params[scope].clone))
       success!(resource)
     else
       fail(:invalid)
     end
   end
-
 end
 
 Warden::Strategies.add(:pam_authenticatable, Devise::Strategies::PamAuthenticatable)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_pam_authenticatable2
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - James Wilson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise