simple_ldap_authenticator 1.0.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 370835649201c04c545cb53d363385e36b1d34ae4f3a1f08dd91b7f889725866
+  data.tar.gz: 9d3118b82945916bd3043b22304777891943ad7ee450b4855b0bfe09e816af55
+SHA512:
+  metadata.gz: 0fce93068f8fb5d2e38f304860c6a4e7334a7bb408d0d3a75e41f5ff218c72107062dec33de8fd3455317296b98f6580bac7cb8a1c72c9ada4e0b5cec4d96715
+  data.tar.gz: c5b333d7c4b0359867a3176c0edb49fa1911cf329ebf41676049fa9999eb51bc57e931680a86c91e40cdee60112d3d57cbe9bdfe506e898b4f4ac32160429d98

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2004-2007 Jeremy Evans
+Copyright (c) 2006-2022 Jeremy Evans
+
+test/ldapserver.rb Copyright (c) 2006-2011 by Francis Cianfrocca and other contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy 
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -4,19 +4,17 @@ SimpleLdapAuthenticator
 Allows for simple authentication to an LDAP server with a minimum of
 configuration.  Requires either Ruby/LDAP or Net::LDAP.   
 
-Usage is fairly simple:
+Example Usage:
+
   require 'simple_ldap_authenticator'
+  require 'logger'
+
   SimpleLdapAuthenticator.servers = %w'dc1.domain.com dc2.domain.com'
   SimpleLdapAuthenticator.use_ssl = true
-  SimpleLdapAuthenticator.login_format = '%s @domain.com'
-  SimpleLdapAuthenticator.logger = RAILS_DEFAULT_LOGGER
-  class LoginController < ApplicationController
-    def login
-      return redirect_to(:action=>'try_again') unless \
-        SimpleLdapAuthenticator.valid?(params[:username], \
-        params[:password])  
-      session[:username] = params[:username]
-    end
-  end
+  SimpleLdapAuthenticator.login_format = '%s@domain.com'
+  SimpleLdapAuthenticator.logger = Logger.new($stdout)
+
+  SimpleLdapAuthenticator.valid?(username, password)
+  # => true or false (or raise if there is an issue connecting to the server)
 
-github: http://github.com/jeremyevans/simple_ldap_authenticator/tree/master
+github: http://github.com/jeremyevans/simple_ldap_authenticator

data/lib/simple_ldap_authenticator.rb

@@ -14,34 +14,33 @@
 # * servers = ['dc1.domain.com', 'dc2.domain.com'] # names/addresses of LDAP servers to use
 # * use_ssl = true # for logging in via LDAPS
 # * port = 3289 # instead of 389 for LDAP or 636 for LDAPS
-# * logger = RAILS_DEFAULT_LOGGER # for logging authentication successes/failures
+# * logger = Logger.new($stdout) # for logging authentication successes/failures
 #
-# The class is used as a global variable, you are not supposed to create an
+# The class is used as a singleton, you are not supposed to create an
 # instance of it. For example:
 #
-#    require 'simple_ldap_authenticator'
-#    SimpleLdapAuthenticator.servers = %w'dc1.domain.com dc2.domain.com'
-#    SimpleLdapAuthenticator.use_ssl = true
-#    SimpleLdapAuthenticator.login_format = '%s@domain.com'
-#    SimpleLdapAuthenticator.logger = RAILS_DEFAULT_LOGGER
-#    class LoginController < ApplicationController 
-#      def login
-#        return redirect_to(:action=>'try_again') unless SimpleLdapAuthenticator.valid?(params[:username], params[:password])
-#        session[:username] = params[:username]
-#      end
-#    end
+#  require 'simple_ldap_authenticator'
+#
+#  SimpleLdapAuthenticator.servers = %w'dc1.domain.com dc2.domain.com'
+#  SimpleLdapAuthenticator.use_ssl = true
+#  SimpleLdapAuthenticator.login_format = '%s@domain.com'
+#
+#  SimpleLdapAuthenticator.valid?(username, password)
+#  # => true or false (or raise if there is an issue connecting to the server)
 class SimpleLdapAuthenticator
+  @servers = ['127.0.0.1']
+  @use_ssl = false
+  @login_format = '%s'
+
   class << self
-    @servers = ['127.0.0.1']
-    @use_ssl = false
-    @login_format = '%s'
-    attr_accessor :servers, :use_ssl, :port, :login_format, :logger, :connection, :ldap_library
+    attr_accessor :servers, :use_ssl, :login_format, :logger, :ldap_library
+    attr_writer :port, :connection
     
     # Load the required LDAP library, either 'ldap' or 'net/ldap'
     def load_ldap_library
       return if @ldap_library_loaded
-      if ldap_library
-        if ldap_library == 'net/ldap'
+      if @ldap_library
+        if @ldap_library == 'net/ldap'
           require 'net/ldap'
         else
           require 'ldap'
@@ -51,10 +50,10 @@ class SimpleLdapAuthenticator
         begin
           require 'ldap'
           require 'ldap/control'
-          ldap_library = 'ldap'
+          @ldap_library = 'ldap'
         rescue LoadError
           require 'net/ldap'
-          ldap_library = 'net/ldap'
+          @ldap_library = 'net/ldap'
         end
       end
       @ldap_library_loaded = true
@@ -92,34 +91,37 @@ class SimpleLdapAuthenticator
     
     # Check the validity of a login/password combination
     def valid?(login, password)
-      if password.to_s == ''
+      login = login.to_s
+      password = password.to_s
+      connection = self.connection
+      if password == '' || password.include?("\0") || login.include?("\0")
         false
       elsif ldap_library == 'net/ldap'
-        connection.authenticate(login_format % login.to_s, password.to_s)
+        connection.authenticate(login_format % login, password)
         begin
           if connection.bind
-              logger.info("Authenticated #{login.to_s} by #{server}") if logger
-              true
-            else
-              logger.info("Error attempting to authenticate #{login.to_s} by #{server}: #{connection.get_operation_result.code} #{connection.get_operation_result.message}") if logger
-              switch_server unless connection.get_operation_result.code == 49
-              false
-            end
-        rescue Net::LDAP::LdapError => error
-          logger.info("Error attempting to authenticate #{login.to_s} by #{server}: #{error.message}") if logger
+            logger.info("Authenticated #{login} by #{server}") if logger
+            true
+          else
+            logger.info("Error attempting to authenticate #{login} by #{server}: #{connection.get_operation_result.code} #{connection.get_operation_result.message}") if logger
+            switch_server unless connection.get_operation_result.code == 49
+            false
+          end
+        rescue Net::LDAP::Error, SocketError, SystemCallError => error
+          logger.info("Error attempting to authenticate #{login} by #{server}: #{error.message}") if logger
           switch_server
           false
         end
       else
         connection.unbind if connection.bound?
         begin
-          connection.bind(login_format % login.to_s, password.to_s)
+          connection.bind(login_format % login, password)
           connection.unbind
-          logger.info("Authenticated #{login.to_s} by #{server}") if logger
+          logger.info("Authenticated #{login} by #{server}") if logger
           true
         rescue LDAP::ResultError => error
           connection.unbind if connection.bound?
-          logger.info("Error attempting to authenticate #{login.to_s} by #{server}: #{error.message}") if logger
+          logger.info("Error attempting to authenticate #{login} by #{server}: #{error.message}") if logger
           switch_server unless error.message == 'Invalid credentials'
           false
         end

metadata

@@ -1,72 +1,109 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple_ldap_authenticator
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Jeremy Evans
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-08-03 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: 
+date: 2024-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email: code@jeremyevans.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
-files: 
-- README
+files:
 - LICENSE
+- README
 - lib/simple_ldap_authenticator.rb
-has_rdoc: true
-homepage: 
+homepage:
 licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --inline-source
-- --line-numbers
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/simple_ldap_authenticator/issues
+  changelog_uri: https://github.com/jeremyevans/simple_ldap_authenticator/blob/master/CHANGELOG
+  mailing_list_uri: https://github.com/jeremyevans/simple_ldap_authenticator/discussions
+  source_code_uri: https://github.com/jeremyevans/simple_ldap_authenticator
+post_install_message:
+rdoc_options:
+- "--inline-source"
+- "--line-numbers"
 - README
 - lib
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
 summary: Easy authentication to an LDAP server(s)
 test_files: []
-