simple_ldap_authenticator 1.2.0 → 2.0.0

checksums.yaml

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2022 Jeremy Evans
+Copyright (c) 2006-2026 Jeremy Evans and contributors
 
 test/ldapserver.rb Copyright (c) 2006-2011 by Francis Cianfrocca and other contributors.
 

data/README

@@ -17,4 +17,40 @@ Example Usage:
   SimpleLdapAuthenticator.valid?(username, password)
   # => true or false (or raise if there is an issue connecting to the server)
 
+By default, a new connection object is created for each call to valid?,
+so valid? is safe to call concurrently from multiple threads.  If you only
+use SimpleLdapAuthenticator from a single thread, you can reuse a single
+connection object for all calls to valid?:
+
+  SimpleLdapAuthenticator.single_threaded = true
+
+Do not enable single threaded mode if valid? may be called concurrently,
+as that can result in invalid passwords being considered valid.
+
+When use_ssl is true, the server's certificate and hostname are verified
+using the default trusted certificates.  You can set use_ssl to a hash of
+TLS options to customize this, such as specifying the CA certificate(s) to
+trust (useful for internal CAs and self-signed certificates, such as those
+commonly used by Active Directory):
+
+  SimpleLdapAuthenticator.use_ssl = {ca_file: '/path/to/ca.pem'}
+
+The :ca_file, :ca_path, and :verify_mode options are supported for both
+ldap and net/ldap backends.  For net/ldap, any option supported by
+OpenSSL::SSL::SSLContext#set_params can be used.  For ldap, only
+those three options are supported. :verify_mode on ldap will default to
+the LDAP behavior (which verifies by default unless the TLS_REQCERT
+setting is set in the system's ldap.conf).
+
+Before version 2, use_ssl = true did not verify the server's
+certificate when using net/ldap.  To get the previous behavior of not
+verifying the server's certificate (not recommended, as it allows
+man-in-the-middle attacks to capture passwords):
+
+  SimpleLdapAuthenticator.use_ssl = {verify_mode: OpenSSL::SSL::VERIFY_NONE}
+
+Note that due to a bug in net/ldap, you should use domain names and
+not IP addresses in the servers array, at least if you are using
+LibreSSL (which follows the SSL spec more closely).
+
 github: http://github.com/jeremyevans/simple_ldap_authenticator

data/lib/simple_ldap_authenticator.rb

@@ -12,9 +12,43 @@
 # * login_format = '%s@domain.com' # Active Directory, OR
 # * login_format = 'cn=%s,cn=users,o=organization,c=us' # Other LDAP servers
 # * servers = ['dc1.domain.com', 'dc2.domain.com'] # names/addresses of LDAP servers to use
-# * use_ssl = true # for logging in via LDAPS
+# * use_ssl = true # for logging in via LDAPS, verifying the server certificate
+# * use_ssl = {ca_file: '/path/to/ca.pem'} # for logging in via LDAPS, with TLS options
 # * port = 3289 # instead of 389 for LDAP or 636 for LDAPS
 # * logger = Logger.new($stdout) # for logging authentication successes/failures
+# * single_threaded = true # reuse a single connection, only safe if not using threads
+#
+# By default, a new connection object is created for each call to valid?,
+# so that valid? is safe to call concurrently from multiple threads.  If
+# you are only using SimpleLdapAuthenticator in a single thread, you can set
+# single_threaded = true, which reuses a single connection object for all
+# calls to valid?.  Do not set single_threaded = true if valid? may be
+# called concurrently, as that can result in invalid passwords being
+# considered valid.
+#
+# When use_ssl is true, the server's certificate and hostname are verified
+# using the default trusted certificates.  use_ssl can also be set to a hash
+# of TLS options, which are merged into the default TLS options.  The
+# following TLS options are supported for both libraries:
+#
+# :ca_file :: File containing trusted CA certificates.
+# :ca_path :: Directory containing trusted CA certificates.
+# :verify_mode :: Whether to verify the server certificate, should be
+#                 OpenSSL::SSL::VERIFY_PEER or OpenSSL::SSL::VERIFY_NONE
+#                 if given.
+#
+# For net/ldap, any option supported by OpenSSL::SSL::SSLContext#set_params
+# can be used. For ldap, only the three keys given above work.
+#
+# Before version 2, use_ssl = true did not verify the server certificate
+# when using net/ldap.  To restore that behavior (not recommended, as it allows
+# man-in-the-middle attacks), you can disable verification:
+#
+#  SimpleLdapAuthenticator.use_ssl = {verify_mode: OpenSSL::SSL::VERIFY_NONE}
+#
+# With ldap, whether to verify the certificate by default depends on the
+# system's libldap configuration (TLS_REQCERT in ldap.conf). The above setting
+# also disables verification when using ldap.
 #
 # The class is used as a singleton, you are not supposed to create an
 # instance of it. For example:
@@ -31,9 +65,11 @@ class SimpleLdapAuthenticator
   @servers = ['127.0.0.1']
   @use_ssl = false
   @login_format = '%s'
+  @single_threaded = false
+  @switch_server_mutex = Mutex.new
 
   class << self
-    attr_accessor :servers, :use_ssl, :login_format, :logger, :ldap_library
+    attr_accessor :servers, :use_ssl, :login_format, :logger, :ldap_library, :single_threaded
     attr_writer :port, :connection
     
     # Load the required LDAP library, either 'ldap' or 'net/ldap'
@@ -64,16 +100,46 @@ class SimpleLdapAuthenticator
       servers[0]
     end
     
-    # The connection to the LDAP server.  A single connection is made and the
-    # connection is only changed if a server returns an error other than 
-    # invalid password.
+    # The shared connection to the LDAP server, only used in single threaded
+    # mode.  A single connection is made and the connection is only changed if
+    # a server returns an error other than invalid password.
     def connection
-      return @connection if @connection
+      @connection ||= new_connection(server)
+    end
+
+    # Create a new connection object for the given LDAP server.
+    def new_connection(server)
       load_ldap_library
-      @connection = if ldap_library == 'net/ldap'
-        Net::LDAP.new(:host=>server, :port=>(port), :encryption=>(:simple_tls if use_ssl))
+      if ldap_library == 'net/ldap'
+        if use_ssl
+          tls_opts = use_ssl.is_a?(Hash) ? use_ssl.dup : {}
+          unless tls_opts[:verify_mode]
+            require "openssl"
+            tls_opts[:verify_mode] = OpenSSL::SSL::VERIFY_PEER
+          end
+          encryption_opts = {:method=>:simple_tls, :tls_options=>tls_opts}
+        end
+        Net::LDAP.new(:host=>server, :port=>port, :encryption=>encryption_opts)
+      elsif use_ssl
+        conn = LDAP::SSLConn.new(server, port)
+        if use_ssl.is_a?(Hash) && !use_ssl.empty?
+          use_ssl.each do |k, v|
+            case k
+            when :verify_mode
+              conn.set_option(LDAP::LDAP_OPT_X_TLS_REQUIRE_CERT, v)
+            when :ca_file
+              conn.set_option(LDAP::LDAP_OPT_X_TLS_CACERTFILE, v)
+            when :ca_path
+              conn.set_option(LDAP::LDAP_OPT_X_TLS_CACERTDIR, v)
+            else
+              raise ArgumentError, "unsupported TLS option for ldap library: #{k.inspect}"
+            end
+          end
+          conn.set_option(LDAP::LDAP_OPT_X_TLS_NEWCTX, 0)
+        end
+        conn
       else
-        (use_ssl ? LDAP::SSLConn : LDAP::Conn).new(server, port)
+        LDAP::Conn.new(server, port)
       end
     end
     
@@ -83,36 +149,47 @@ class SimpleLdapAuthenticator
     end
     
     # Disconnect from current LDAP server and use a different LDAP server on the
-    # next authentication attempt
-    def switch_server
-      self.connection = nil
-      servers << servers.shift
+    # next authentication attempt.  If failed_server is given, only switch
+    # servers if failed_server is still the current server, so that multiple
+    # threads failing on the same server only switch servers once.
+    def switch_server(failed_server = nil)
+      @switch_server_mutex.synchronize do
+        if failed_server.nil? || server.equal?(failed_server)
+          self.connection = nil
+          servers.rotate!
+        end
+      end
     end
     
     # Check the validity of a login/password combination
     def valid?(login, password)
       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, password)
+      return false if password == '' || password.include?("\0") || login.include?("\0")
+
+      server = self.server
+      if ldap_library == 'net/ldap'
+        connection = single_threaded ? self.connection : new_connection(server)
+        auth = {:method=>:simple, :username=>login_format % login, :password=>password}
         begin
-          if connection.bind
+          if connection.bind(auth)
             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
+            result = connection.get_operation_result
+            if logger
+              logger.info("Error attempting to authenticate #{login} by #{server}: #{result.code} #{result.message} #{result.error_message.to_s.strip}")
+            end
+            switch_server(server) unless 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
+          switch_server(server)
           false
         end
       else
+        connection = (single_threaded && !(use_ssl.is_a?(Hash) && !use_ssl.empty?)) ? self.connection : new_connection(server)
         connection.unbind if connection.bound?
         begin
           connection.bind(login_format % login, password)
@@ -120,9 +197,8 @@ class SimpleLdapAuthenticator
           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} by #{server}: #{error.message}") if logger
-          switch_server unless error.message == 'Invalid credentials'
+          switch_server(server) unless error.message == 'Invalid credentials'
           false
         end
       end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simple_ldap_authenticator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-global_expectations
@@ -24,20 +23,6 @@ dependencies:
     - - ">="
       - !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
@@ -66,7 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: code@jeremyevans.net
 executables: []
 extensions: []
@@ -76,14 +60,14 @@ files:
 - LICENSE
 - README
 - lib/simple_ldap_authenticator.rb
-homepage:
-licenses: []
+homepage: http://github.com/jeremyevans/simple_ldap_authenticator
+licenses:
+- MIT
 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"
@@ -95,15 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Easy authentication to an LDAP server(s)
 test_files: []