casino-ldap_authenticator 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,8 @@
+# rcov generated
+coverage
+coverage.data
+
+# bundler
+.bundle
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+casino-ldap_authenticator

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Nils Caspar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# casino-ldap_authenticator [![Build Status](https://travis-ci.org/rbCAS/casino-ldap_authenticator.png?branch=master)](https://travis-ci.org/rbCAS/casino-ldap_authenticator)
+
+Provides mechanism to use LDAP as an authenticator for [CASino](https://github.com/rbCAS/CASino).
+
+To use the LDAP authenticator, configure it in your cas.yml:
+
+    authenticators:
+      my_company_ldap:
+        authenticator: "LDAP"
+        options:
+          host: "localhost"
+          port: 636
+          base: "ou=people,dc=example,dc=com"
+          username_attribute: "uid"
+          encryption: "simple_tls"
+          # optional, credentials to perform user lookup:
+          admin_user: "cn=admin,dc=example,dc=com"
+          admin_password: "password"
+          extra_attributes:
+            email: "mail"
+            fullname: "displayname"
+
+## Contributing to casino-ldap_authenticator
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Nils Caspar. See LICENSE.txt
+for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/casino-ldap_authenticator.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'casino/ldap_authenticator/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'casino-ldap_authenticator'
+  s.version     = CASino::LDAPAuthenticator::VERSION
+  s.authors     = ['Nils Caspar']
+  s.email       = ['ncaspar@me.com']
+  s.homepage    = 'http://rbcas.org/'
+  s.license     = 'MIT'
+  s.summary     = 'Provides mechanism to use LDAP as an authenticator for CASino.'
+  s.description = 'This gem can be used to allow the CASino backend to authenticate against an LDAP server.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 2.12'
+  s.add_development_dependency 'simplecov', '~> 0.7'
+
+  s.add_runtime_dependency 'net-ldap', '~> 0.3'
+  s.add_runtime_dependency 'casino', '~> 2.0'
+end

data/lib/casino/ldap_authenticator/version.rb

@@ -0,0 +1,5 @@
+module CASino
+  class LDAPAuthenticator
+    VERSION = '1.0.0'
+  end
+end

data/lib/casino/ldap_authenticator.rb

@@ -0,0 +1,83 @@
+require 'net/ldap'
+require 'casino/authenticator'
+
+class CASino::LDAPAuthenticator
+  DEFAULT_USERNAME_ATTRIBUTE = 'uid'
+
+  # @param [Hash] options
+  def initialize(options)
+    @options = options
+  end
+
+  def validate(username, password)
+    @username = username
+    @password = password
+    begin
+      connect
+      authenticate
+      if !@user_plain
+        false
+      else
+        generate_user
+        @user
+      end
+    rescue Net::LDAP::LdapError => e
+      raise CASino::Authenticator::AuthenticatorError,
+        "LDAP authentication failed with '#{e}'. Check your authenticator configuration."
+    end
+  end
+
+  private
+  def connect
+    @ldap = Net::LDAP.new
+    @ldap.host = @options[:host]
+    @ldap.port = @options[:port]
+    if @options[:encryption]
+      @ldap.encryption(@options[:encryption].to_sym)
+    end
+  end
+
+  def authenticate
+    unless @options[:admin_user].nil?
+      @ldap.auth(@options[:admin_user], @options[:admin_password])
+    end
+    @user_plain = @ldap.bind_as(:base => @options[:base], :size => 1, :password => @password, :filter => user_filter)
+    if @user_plain.is_a?(Array)
+      @user_plain = @user_plain.first
+    end
+  end
+
+  def username_attribute
+    @options[:username_attribute] || DEFAULT_USERNAME_ATTRIBUTE
+  end
+
+  def user_filter
+    filter = Net::LDAP::Filter.eq(username_attribute, @username)
+    unless @options[:filter].nil?
+      filter &= Net::LDAP::Filter.construct(@options[:filter])
+    end
+    filter
+  end
+
+  def generate_user
+    @user = {
+      username: @user_plain[username_attribute].first,
+      extra_attributes: extra_attributes
+    }
+  end
+
+  def extra_attributes
+    if @options[:extra_attributes]
+      result = {}
+      @options[:extra_attributes].each do |index_result, index_ldap|
+        value = @user_plain[index_ldap]
+        if value
+          result[index_result] = "#{value.first}"
+        end
+      end
+      result
+    else
+      nil
+    end
+  end
+end

data/lib/casino-ldap_authenticator.rb

@@ -0,0 +1,2 @@
+require 'casino/ldap_authenticator/version'
+require 'casino/ldap_authenticator'

data/spec/casino/ldap_authenticator_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'casino/ldap_authenticator'
+
+describe CASino::LDAPAuthenticator do
+  let(:options) { {
+    :host => 'localhost',
+    :port => 12445,
+    :base => 'dc=users,dc=example.com',
+    :encryption => 'simple_tls',
+    :username_attribute => 'uid',
+    :extra_attributes => { :email => 'mail', :fullname => :displayname }
+  } }
+  let(:subject) { described_class.new(options) }
+  let(:connection) { Object.new }
+
+  before(:each) do
+    Net::LDAP.stub(:new).and_return(connection)
+    [:host=, :port=, :encryption].each do |setting|
+      connection.stub(setting)
+    end
+  end
+
+  describe '#validate' do
+    let(:username) { 'test' }
+    let(:password) { 'foo' }
+    let(:user_filter) { Net::LDAP::Filter.eq(options[:username_attribute], username) }
+
+    before(:each) do
+      connection.stub(:bind_as)
+    end
+
+    it 'does the connection setup' do
+      connection.should_receive(:host=).with(options[:host])
+      connection.should_receive(:port=).with(options[:port])
+      connection.should_receive(:encryption).with(:"#{options[:encryption]}")
+      subject.validate(username, password)
+    end
+
+    it 'calls the #bind_as method on the LDAP connection' do
+      connection.should_receive(:bind_as).with(:base => options[:base], :size => 1, :password => password, :filter => user_filter)
+      subject.validate(username, password)
+    end
+
+    context 'when validation succeeds' do
+      let(:fullname) { 'Example User' }
+      let(:email) { "#{username}@example.org" }
+      let(:ldap_entry) {
+        entry = Net::LDAP::Entry.new
+        {:uid => username, :displayname => fullname, :mail => email}.each do |key, value|
+          entry[key] = [value]
+        end
+        entry
+      }
+      before(:each) do
+        connection.stub(:bind_as) do
+          ldap_entry
+        end
+      end
+
+      it 'returns the user data' do
+        subject.validate(username, password).should == {
+          username: username,
+          extra_attributes: {
+            :email => email,
+            :fullname => fullname
+          }
+        }
+      end
+    end
+
+    context 'when validation fails' do
+      before(:each) do
+        connection.stub(:bind_as) do
+          false
+        end
+      end
+
+      it 'returns false' do
+        subject.validate(username, password).should == false
+      end
+    end
+
+    context 'when communication error occurs' do
+      before(:each) do
+        connection.stub(:bind_as) do
+          raise Net::LDAP::LdapError, 'foo'
+        end
+      end
+
+      it 'raises an AuthenticatorError' do
+        lambda {
+          subject.validate(username, password)
+        }.should raise_error(CASino::Authenticator::AuthenticatorError)
+      end
+    end
+
+    context 'with an admin user' do
+      before(:each) do
+        options.merge! :admin_user => 'admin', :admin_password => 'password'
+      end
+
+      it 'authenticates the admin user' do
+        connection.should_receive(:auth).with(options[:admin_user], options[:admin_password])
+        subject.validate(username, password)
+      end
+    end
+
+    context 'with a filter' do
+      let(:filter_expression) { '(!(attribute=abc))' }
+      let(:filter) { user_filter & Net::LDAP::Filter.construct(filter_expression) }
+      before(:each) do
+        options.merge! :filter => filter_expression
+      end
+
+      it 'calls the #bind_as method on the LDAP connection' do
+        connection.should_receive(:bind_as).with(:base => options[:base], :size => 1, :password => password, :filter => filter)
+        subject.validate(username, password)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec'
+require 'casino-ldap_authenticator'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: casino-ldap_authenticator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nils Caspar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: casino
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem can be used to allow the CASino backend to authenticate against
+  an LDAP server.
+email:
+- ncaspar@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- casino-ldap_authenticator.gemspec
+- lib/casino-ldap_authenticator.rb
+- lib/casino/ldap_authenticator.rb
+- lib/casino/ldap_authenticator/version.rb
+- spec/casino/ldap_authenticator_spec.rb
+- spec/spec_helper.rb
+homepage: http://rbcas.org/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides mechanism to use LDAP as an authenticator for CASino.
+test_files:
+- spec/casino/ldap_authenticator_spec.rb
+- spec/spec_helper.rb