rack-auth-ldap 1.2 → 1.2.2

data/lib/rack/auth/ldap/version.rb

@@ -1,13 +1,11 @@
-# coding: utf-8
 # Author : Romain GEORGES
-
+require 'version'
 # the Rack module from Rack Sources
 module Rack
-
-# the Rack::Auth module from Rack Sources
+  # the Rack::Auth module from Rack Sources
   module Auth
     # the current version for Rack::Auth::Ldap => gem rack-auth-ldap
     # used by gemspec
-    LDAP_VERSION = "1.2"
+    LDAP_VERSION = Version.current
   end
 end

data/lib/rack/auth/ldap.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-#inhibit warning : due to net-ldap warning on Socket.tcp
+# inhibit warning : due to net-ldap warning on Socket.tcp
 $-w = nil
 
 require 'rack'
@@ -11,66 +9,62 @@ require 'yaml'
 
 # the rack module from Rack Sources
 module Rack
-
   # the auth module from Rack Sources
   module Auth
-
     # class Config provide Yaml config mapping for Rack::Auth::Module
     # the class map ldap configurations values
     # @note this class is not provide to be used standalone
     class Config
-
       # initializer for Config class
       # @param [Hash<Symbol>] options initialisation options
       # @option options [Symbol] :file The YAML filename (default to ./ldap.yml, the config.ru path)
       # @return [Config] object himself
-      def initialize(options = { :file => './ldap.yml'})
+      def initialize(options = { file: './ldap.yml' })
         @values = defaults
-        target  = (ENV['RACK_ENV'])? ENV['RACK_ENV'] : 'test'
+        options.merge!(file: './ldap.yml') { |_key, oldval, _newval| oldval }
+        target = ENV['RACK_ENV'] || 'test'
         config_values = load_yaml(::File.expand_path(options[:file], Dir.pwd))[target]
-        debug = ::File.open("/tmp/test.txt",'a+')
-        debug.puts ENV['RACK_ENV']
+        debug = ::File.open('/tmp/test.txt', 'a+')
+        debug.puts ENV.fetch('RACK_ENV', nil)
         debug.close
         config_values.keys.each do |key|
           config_values[key.to_sym] = config_values.delete(key)
         end
         @values.merge! config_values
         @values.keys.each do |meth|
-          bloc = Proc.new  {@values[meth] }
-            self.class.send :define_method, meth, &bloc
+          bloc = proc { @values[meth] }
+          self.class.send :define_method, meth, &bloc
         end
       end
 
       private
 
       def load_yaml(file)
-        if ::File.exist?(file)
-          ::YAML.load ::ERB.new(IO.read(file)).result
-        else
-          raise "Could not load ldap configuration. No such file - #{file}"
-        end
+        raise "Could not load ldap configuration. No such file - #{file}" unless ::File.exist?(file)
+
+        ::YAML.load ::ERB.new(IO.read(file)).result
       rescue ::Psych::SyntaxError => e
         raise "YAML syntax error occurred while parsing #{file}. " \
-              "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+              'Please note that YAML must be consistently indented using spaces. Tabs are not allowed. ' \
               "Error: #{e.message}"
       end
 
       # private method with default configuration values for LDAP
       # @return [Hash<Symbol>] the default values of LDAP configuration
       def defaults
-        return {
-          :hostname => 'localhost',
-          :basedn => 'dc=domain,dc=tld',
-          :rootdn => '',
-          :passdn => '',
-          :auth => false,
-          :port => 389,
-          :scope => :subtree,
-          :username_ldap_attribute => 'uid',
-          :ldaps => false,
-          :starttls => false,
-          :tls_options => nil,
-          :debug => false
+        {
+          hostname: 'localhost',
+          basedn: 'dc=domain,dc=tld',
+          rootdn: '',
+          passdn: '',
+          auth: false,
+          port: 389,
+          scope: :subtree,
+          username_ldap_attribute: 'uid',
+          ldaps: false,
+          starttls: false,
+          tls_options: nil,
+          debug: false
         }
       end
     end
@@ -84,7 +78,6 @@ module Rack
     #   require 'rack/auth/ldap'
     #   use Rack::Auth::Ldap
     class Ldap < AbstractHandler
-
       # the config read accessor
       # @attr [Rack::Auth::Config] the read accessor to the LDAP Config object
       attr_reader :config
@@ -108,6 +101,7 @@ module Rack
         auth = Ldap::Request.new(env)
         return unauthorized unless auth.provided?
         return bad_request unless auth.basic?
+
         if valid?(auth)
           env['REMOTE_USER'] = auth.username
           return @app.call(env)
@@ -115,7 +109,6 @@ module Rack
         unauthorized
       end
 
-
       private
 
       # forge a challange header for HTTP basic auth with the realm attribut
@@ -130,16 +123,16 @@ module Rack
       def valid?(auth)
         # how to connect to the ldap server: ldap, ldaps, ldap + starttls
         if @config.ldaps
-          enc = { :method => :simple_tls }
+          enc = { method: :simple_tls }
         elsif @config.starttls
-          enc =  { :method => :start_tls }
+          enc = { method: :start_tls }
           enc[:tls_options] = @config.tls_options if @config.tls_options
         else
-          enc = nil             # just straight ldap
+          enc = nil # just straight ldap
         end
-        conn = Net::LDAP.new( :host => @config.hostname, :port => @config.port,
-                              :base => @config.basedn,
-                              :encryption => enc )
+        conn = Net::LDAP.new(host: @config.hostname, port: @config.port,
+                             base: @config.basedn,
+                             encryption: enc)
 
         $stdout.puts "Net::LDAP.new => #{conn.inspect}" if @config.debug
 
@@ -156,30 +149,26 @@ module Rack
         $stdout.puts "Net::LDAP::Filter.eq => #{filter.inspect}" if @config.debug
 
         # find the user and rebind as them to test the password
-        #return conn.bind_as(:filter => filter, :password => auth.password)
+        # return conn.bind_as(:filter => filter, :password => auth.password)
         $stdout.puts "doing bind_as password.size: #{auth.password.size}..." if @config.debug
-        ret = conn.bind_as(:filter => filter, :password => auth.password)
+        ret = conn.bind_as(filter: filter, password: auth.password)
         $stdout.puts "bind_as => #{ret.inspect}" if @config.debug
         ret
       end
 
-      private
-
-
       # Request class the LDAP credentials authenticator
       # @note please do not instantiate manually, used by Rack::Auth:Ldap
       class Request < Auth::AbstractRequest
-
         # return true if the auth scheme provide is really a basic scheme
         # @return [FalseClass,TrueClass] the result
         def basic?
-          !parts.first.nil? && "basic" == scheme
+          !parts.first.nil? && 'basic' == scheme
         end
 
         # return an array of the two credentials [username,password]
         # @return [Array] the couple [username,password]
         def credentials
-          @credentials ||= params.unpack("m*").first.split(/:/, 2)
+          @credentials ||= params.unpack1('m*').split(':', 2)
         end
 
         # read accessor on the first credentials, username
@@ -193,9 +182,7 @@ module Rack
         def password
           credentials.last
         end
-
       end
-
     end
   end
 end

data/rack-auth-ldap.gemspec

@@ -1,32 +1,32 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rack/auth/ldap/version'
 
-
 Gem::Specification.new do |s|
-  s.name = "rack-auth-ldap"
-  s.summary = %Q{Rack middleware providing LDAP authentication}
-  s.email = "romain@ultragreen.net"
-  s.homepage = "http://www.github.com/lecid/rack-auth-ldap"
-  s.authors = ["Romain GEORGES"]
+  s.name = 'rack-auth-ldap'
+  s.summary = %(Rack middleware providing LDAP authentication)
+  s.email = 'romain@ultragreen.net'
+  s.homepage = 'http://www.github.com/lecid/rack-auth-ldap'
+  s.authors = ['Romain GEORGES']
   s.version = Rack::Auth::LDAP_VERSION
 
-
-  s.description = %q{rack-auth-ldap : provide LDAP authentication for Rack middelware}
-  s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'yard', '~> 0.9.24'
-  s.add_development_dependency 'rdoc', '~> 6.2.1'
-  s.add_development_dependency 'roodi', '~> 5.0.0'
+  s.description = 'rack-auth-ldap : provide LDAP authentication for Rack middelware'
+  s.add_development_dependency 'bundle-audit', '~> 0.1.0'
   s.add_development_dependency 'code_statistics', '~> 0.2.13'
-  s.add_development_dependency 'yard-rspec', '~> 0.1'
   s.add_development_dependency 'ladle', '~> 1.0.1'
   s.add_development_dependency 'rake', '~> 13.0.1'
+  s.add_development_dependency 'rspec', '~> 3.12.0'
+  s.add_development_dependency 'rubocop', '~> 1.54'
+  s.add_development_dependency 'version', '~> 1.1'
+  s.add_development_dependency 'yard', '~> 0.9.24'
+  s.add_development_dependency 'yard-rspec', '~> 0.1'
 
+  s.add_development_dependency 'cyclonedx-ruby', '~> 1.1'
+  s.add_development_dependency 'debride', '~> 1.12'
 
-
-
-  s.add_dependency 'net-ldap', '~> 0.16.2'
-  s.add_dependency 'rack', '~> 2.2.2'
-  s.license       = "BSD-2-Clause"
+  s.add_dependency 'net-ldap', '~> 0.18'
+  s.add_dependency 'rack', '~> 3.0'
+  s.license       = 'BSD-2-Clause'
   s.files         = `git ls-files`.split($/)
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/rack-auth-ldap_spec.rb

@@ -1,24 +1,21 @@
-# coding: utf-8
 require 'ladle'
 require 'rack/auth/ldap'
 require 'rack/lint'
 require 'rack/mock'
 
 describe Rack::Auth::Ldap do
+  before :all do
+    @ldap_server = Ladle::Server.new({
+                                       quiet: true, port: 3897,
+                                       ldif: './spec/config/users.ldif',
+                                       domain: 'dc=test',
+                                       tmpdir: '/tmp'
+                                     }).start
+  end
 
-   before :all do
-     @ldap_server = Ladle::Server.new({
-     :quiet => true, :port   => 3897,
-     :ldif   => "./spec/config/users.ldif",
-     :domain => "dc=test",
-     :tmpdir => '/tmp'
-     }).start
-   end
-
-   after :all do
-     @ldap_server.stop if @ldap_server
-   end
-
+  after :all do
+    @ldap_server.stop if @ldap_server
+  end
 
   def realm
     'test'
@@ -26,12 +23,12 @@ describe Rack::Auth::Ldap do
 
   def unprotected_app
     Rack::Lint.new lambda { |env|
-      [ 200, {'Content-Type' => 'text/plain'}, ["Hi #{env['REMOTE_USER']}"] ]
+      [200, { 'content-type' => 'text/plain' }, ["Hi #{env['REMOTE_USER']}"]]
     }
   end
 
   def protected_app
-    app = Rack::Auth::Ldap.new(unprotected_app,{:file => "./spec/config/ldap.yml"})
+    app = Rack::Auth::Ldap.new(unprotected_app, { file: './spec/config/ldap.yml' })
     app.realm = realm
     app
   end
@@ -41,7 +38,7 @@ describe Rack::Auth::Ldap do
   end
 
   def request_with_basic_auth(username, password, &block)
-    request 'HTTP_AUTHORIZATION' => 'Basic ' + ["#{username}:#{password}"].pack("m*"), &block
+    request 'HTTP_AUTHORIZATION' => 'Basic ' + ["#{username}:#{password}"].pack('m*'), &block
   end
 
   def request(headers = {})
@@ -52,18 +49,18 @@ describe Rack::Auth::Ldap do
     expect(response.client_error?).to be true
     expect(response.status).to eq 401
     expect(response).to include 'WWW-Authenticate'
-    expect(response.headers['WWW-Authenticate']).to match /Basic realm="#{Regexp.escape(realm)}"/
+    expect(response.headers['WWW-Authenticate']).to match(/Basic realm="#{Regexp.escape(realm)}"/)
     expect(response.body).to be_empty
   end
 
   it 'should render ldap.yaml with erb and use env vars' do
-     allow(ENV).to receive(:[]).with('RACK_ENV')
-     allow(ENV).to receive(:[]).with('HOSTNAME').and_return('localhost.local')
-     allow(ENV).to receive(:[]).with('PORT').and_return('9090')
+    allow(ENV).to receive(:[]).with('RACK_ENV')
+    allow(ENV).to receive(:[]).with('HOSTNAME').and_return('localhost.local')
+    allow(ENV).to receive(:[]).with('PORT').and_return('9090')
 
-     app = Rack::Auth::Ldap.new(unprotected_app,{:file => './spec/config/ldap.yml'})
-     expect(app.config.hostname).to eq('localhost.local')
-     expect(app.config.port).to eq(9090)
+    app = Rack::Auth::Ldap.new(unprotected_app, { file: './spec/config/ldap.yml' })
+    expect(app.config.hostname).to eq('localhost.local')
+    expect(app.config.port).to eq(9090)
   end
 
   it 'should challenge correctly when no credentials are specified' do

metadata

@@ -1,85 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: rack-auth-ldap
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.2
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundle-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: code_statistics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: ladle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: roodi
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: code_statistics
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
 - !ruby/object:Gem::Dependency
   name: yard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,72 +137,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: ladle
+  name: cyclonedx-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: debride
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '3.0'
 description: 'rack-auth-ldap : provide LDAP authentication for Rack middelware'
 email: romain@ultragreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".debride-whitelist"
 - ".gitignore"
-- COPYRIGHT
+- ".rubocop.yml"
 - Gemfile
+- LICENSE.txt
 - README.rdoc
 - Rakefile
+- VERSION
+- bom.xml
 - examples/Gemfile
 - examples/config.ru
 - examples/ldap.yml
@@ -174,7 +220,8 @@ files:
 homepage: http://www.github.com/lecid/rack-auth-ldap
 licenses:
 - BSD-2-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -190,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Rack middleware providing LDAP authentication