rack-auth-ldap 0.2 → 1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Nzk1NjVlMmE3MTg1NjE2NDllNTQyMmU4ZjM0ZTg1NzVlMWU0N2M1NA==
+  data.tar.gz: !binary |-
+    N2I2Y2YzY2JmOWMyNTBmMGUyOGQwMzFhZjJiN2E2NDI4MTcxNGQ2OA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTFjZmMwNGY3MjM3ZjdlN2NlZDIxNDJhZWU0MzAxNDEzY2FkZjQ2MTllYTVj
+    OTNkZDFiMDFhMzMzYjM3M2Q2YzZhYzA3ZTU2YTg4MjE3YTM3NWIxYzgzNGQ0
+    ZDgzOWVmMmQ5MzE5MTI4ZmNkNzMwZjEzODM1MDIzOTE2MTY3ZTA=
+  data.tar.gz: !binary |-
+    M2VlNDg2ZTk1NDE1MzI3Y2RiNmFkN2M2N2ZkNTgyZmJlNmNmMGUxYWJmZWM0
+    NDMzYTc4ZDQzZWI1Mjk4MjNjMzI3Y2EwY2M1NzFkOTNhN2E1NmQ5YzBlMTJl
+    YTYyMDA2MmQ2MmVhOGVkOTczZGI2ZDQ1ZGEwZDliZThiYWEyNTQ=

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    rack-auth-ldap (0.1)
+      rack
+      ruby-ldap
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    code_statistics (0.2.13)
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    rack (1.5.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    roodi (4.0.0)
+      ruby_parser (~> 3.2, >= 3.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    ruby-ldap (0.9.16)
+    ruby_parser (3.6.0)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.4.3)
+    yard (0.8.7.4)
+    yard-rspec (0.1)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  code_statistics
+  rack-auth-ldap!
+  rdoc
+  roodi
+  rspec
+  yard
+  yard-rspec

data/README.rdoc

@@ -5,3 +5,69 @@ Rack Middleware LDAP authentication
 == Copyright
 
 Copyright (c) 2014 Romain GEORGES. See COPYRIGHT for details.
+Copyright (C) 2007, 2008, 2009, 2010 Christian Neukirchen <purl.org/net/chneukirchen> for Rack Project
+
+== Presentation 
+
+Rack::Auth::Ldap is a basic authentication module with LDAP support 
+Rack::Auth::Ldap is heavily based on Rack:Auth::Basic from the Rack main Project by Christian Neukirchen 
+
+This is an additional module for Rack to authenticate users against an LDAP serveur 
+
+
+== Usage 
+
+=== Initialise
+
+In you config.ru, simply add :
+
+   require 'rubygems'
+   require 'rack'
+   gem 'rack-auth-ldap'
+   require 'rack/auth/ldap'
+
+
+   require File.dirname(__FILE__) + '/your_app'
+
+   use Rack::Auth::Ldap
+   run Sinatra::Application
+
+this configuration activate the Basic Authencation for the entire application 
+
+
+=== Configure
+
+Create an ldap.yml configuration file with :
+
+   production: &ldap_defaults
+     hostname: localhost
+     basedn: ou=groups,dc=domain,dc=tld
+     rootdn: cn=admin,dc=domain,dc=tld
+     passdn: secret
+     auth: true
+     port: 389
+     username_ldap_attribut: uid
+
+
+   test:
+     <<: *ldap_defaults
+
+   development:
+     <<: *ldap_defaults
+
+
+if you want to deactivate root authentication before user binding :
+
+   production: &ldap_defaults
+     hostname: localhost
+     basedn: ou=groups,dc=domain,dc=tld
+     auth: false
+     port: 389
+     username_ldap_attribut: uid
+
+
+   test:
+     <<: *ldap_defaults
+
+   development:
+     <<: *ldap_defaults

data/Rakefile

@@ -32,8 +32,8 @@ YARD::Rake::YardocTask.new do |t|
   t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']
   t.options += ['--title', "Gem Documentation"]
   t.options += ['-o', "yardoc"]
-  t.options += ['-r', "doc/manual.rdoc"]
 end
+
 YARD::Config.load_plugin('yard-rspec')
 
 namespace :yardoc do
@@ -52,7 +52,6 @@ end
 
 Rake::RDocTask.new('rdoc') do |d|
   d.rdoc_files.include('doc/**/*','bin/*')
-  d.main = 'doc/manual.rdoc'
   d.title = 'Dorsal : Yard'
   d.options << '--line-numbers' << '--diagram' << '-SHN'
 end

data/examples/config.ru

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rack'
 gem 'rack-auth-ldap'
 require 'rack/auth/ldap'
-require 'yaml'
+
 
 require File.dirname(__FILE__) + '/sinatra_example'
 

data/lib/rack/auth/ldap.rb

@@ -4,10 +4,22 @@ require 'rack/auth/abstract/handler'
 require 'rack/auth/abstract/request'
 require 'yaml'
 
+# the rack module from Rack Sources
 module Rack
+
+  # the auth module from Rack Sources
   module Auth
 
-    class Config
+  
+    # 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'})
         @values = defaults
         target  = (ENV['RACK_ENV'])? ENV['RACK_ENV'] : 'test'
@@ -26,6 +38,8 @@ module Rack
       end
       
       private 
+      # private method with default configuration values for LDAP
+      # @return [Hash<Symbol>] the default values of LDAP configuration
       def defaults
         return {
           :hostname => 'localhost',
@@ -42,17 +56,35 @@ module Rack
 
     end
 
-
+    # class Ldap, the main authentication component for Rack 
+    # inherited from the default Rack::Auth::AbstractHandler
+    # @note please do not instantiate, this classe is reserved to Rack 
+    # @example Usage 
+    #   # in a config.ru
+    #   gem 'rack-auth-ldap'
+    #   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
-
+      
+      # initializer for the Ldap Class
+      # @note please don not instantiate without rack config.ru 
+      # @see Rack::Auth::Ldap
+      # @return [Ldap] self object
+      # @param [Block,Proc,Lambda] app the rack application
+      # @param [hash<Symbol>] config_options the configurable options
+      # @option config_options [Symbol] :file the path to the YAML configuration file  
       def initialize(app, config_options = {})
         super(app)
         @config = Config.new(config_options)
       end
 
-
+      # call wrapper to provide authentication if not 
+      # @param [Hash] env the rack environnment variable
+      # @return [Array] the tri-dimensional Array [status,headers,[body]]
       def call(env)
         auth = Ldap::Request.new(env)
         return unauthorized unless auth.provided?
@@ -67,10 +99,15 @@ module Rack
 
       private
 
+      # forge a challange header for HTTP basic auth with the realm attribut
+      # @return [String] the header 
       def challenge
         'Basic realm="%s"' % realm
       end
-
+      
+      # do the LDAP connection => search => bind with the credentials get into request headers 
+      # @param [Rack::Auth::Ldap::Request] auth a LDAP authenticator object
+      # @return [TrueClass,FalseClass] Boolean true/false
       def valid?(auth)        
         dn = ''
         conn = LDAP::Conn.new(@config.hostname, @config.port)
@@ -92,6 +129,10 @@ module Rack
       end
 
       private
+
+      # helper to map ruby-ldap scope with internal scope symbols
+      # @param [Symbol] _scope a scope in [:subtree,:one]
+      # @return [Fixnum,Integer] the constant value form ruby-ldap 
       def ldap_scope(_scope)
         res = {
           :subtree => ::LDAP::LDAP_SCOPE_SUBTREE,
@@ -102,20 +143,30 @@ module Rack
 
 
 
-
+      # 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
         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)
         end
-
+        
+        # read accessor on the first credentials, username
+        # @return [String] the username
         def username
           credentials.first
         end
 
+        # read accessor on the last credentials, password
+        # @return [String] the password
         def password
           credentials.last
         end

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

@@ -2,10 +2,13 @@
 # -*- coding: utf-8 -*-                                                                                                                                                                            
 # Author : Romain GEORGES                                                                                                                                                                        
 
+# the Rack module from Rack Sources 
 module Rack
+
+# the Rack::Auth module from Rack Sources 
   module Auth
-    module Ldap
-      VERSION = "0.2"
-    end
+    # the current version for Rack::Auth::Ldap => gem rack-auth-ldap
+    # used by gemspec
+    LDAP_VERSION = "1.0"
   end
 end

data/rack-auth-ldap.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   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.version = Rack::Auth::LDAP_VERSION
   s.date = "2014-04-29"
   s.rubyforge_project = 'nowarning'
   s.description = %q{rack-auth-ldap : provide LDAP authentication for Rack middelware}

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-auth-ldap
 version: !ruby/object:Gem::Version
-  version: '0.2'
-  prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Romain GEORGES
@@ -14,7 +13,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: roodi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: code_statistics
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ldap
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -145,13 +128,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - COPYRIGHT
 - Gemfile
+- Gemfile.lock
 - README.rdoc
 - Rakefile
 - examples/config.ru
 - examples/ldap.yml
 - examples/sinatra_example.rb
+- ldap.rb
 - lib/rack/auth/ldap.rb
 - lib/rack/auth/ldap/version.rb
 - rack-auth-ldap.gemspec
@@ -161,27 +147,26 @@ files:
 homepage: http://www.github.com/lecid/rack-auth-ldap
 licenses:
 - BSD
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: nowarning
-rubygems_version: 1.8.29
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware providing LDAP authentication
 test_files: []
 has_rdoc: true