github-ldap 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github-ldap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Calavera
+
+MIT License
+
+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,88 @@
+# Github::Ldap
+
+GitHub-Ldap is a wrapper on top of Net::LDAP to make it human friendly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github-ldap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github-ldap
+
+## Usage
+
+GitHub-Ldap let you use an external ldap server to authenticate your users with.
+
+There are a few configuration options required to use this adapter:
+
+* host: is the host address where the ldap server lives.
+* port: is the port where the ldap server lives.
+* admin_user: is the the ldap administrator user. Required to perform search operation.
+* admin_password: is the password for the administrator user. Simple authentication is required on the server.
+* encryptation: is the encryptation protocol, disabled by default. The valid options are `ssl` and `tls`.
+* user_domain: is the default ldap domain base.
+* uid: is the field name in the ldap server used to authenticate your users, in ActiveDirectory this is `sAMAccountName`.
+
+Initialize a new adapter using those required options:
+
+```ruby
+  ldap = GitHub::Ldap.new options
+```
+
+There is also an optional configuration setting that you can add:
+
+* user_groups: is an array of groups used to restrict access to users only in those groups.
+
+## Testing
+
+GitHub-Ldap uses [ladle](https://github.com/NUBIC/ladle) for testing. Ladle is not required by default, so you'll need to add it to your gemfile separatedly and require it.
+
+Once you have it installed you can start the testing ldap server in the setup phase for your tests:
+
+```ruby
+require 'github/ldap/server'
+
+def setup
+  GitHub::Ldap.start_server
+end
+
+def teardown
+  GitHub::Ldap.stop_server
+end
+```
+
+GitHub-Ldap includes a set of configured users for testing, but you can provide your own users into a ldif file:
+
+```ruby
+def setup
+  GitHub::Ldap.start_server \
+    users_fixtures: ldif_path
+end
+```
+
+If you provide your own user fixtures, you'll probably need to change the default user domain, the administrator name and her password:
+
+```ruby
+def setup
+  GitHub::Ldap.start_server \
+    user_fixtures:  ldif_path,
+    user_domain:    'dc=evilcorp,dc=com'
+    admin_user:     'uid=eviladmin,dc=evilcorp,dc=com',
+    admin_password: 'correct horse battery staple'
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/github-ldap.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-ldap"
+  spec.version       = "1.0.0"
+  spec.authors       = ["David Calavera"]
+  spec.email         = ["david.calavera@gmail.com"]
+  spec.description   = %q{Ldap authentication for humans}
+  spec.summary       = %q{Ldap client authentication wrapper without all the boilerplate}
+  spec.homepage      = "https://github.com/github/github-ldap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'net-ldap', '>= 0.2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'ladle'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency "rake"
+end

data/lib/github/ldap.rb

@@ -0,0 +1,111 @@
+module GitHub
+  class Ldap
+    require 'net/ldap'
+
+    def initialize(options = {})
+      @user_domain = options[:user_domain]
+      @user_groups = Array(options[:user_groups])
+      @uid         = options[:uid] || "sAMAccountName"
+
+      @ldap = Net::LDAP.new({
+        host: options[:host],
+        port: options[:port]
+      })
+
+      @ldap.authenticate(options[:admin_user], options[:admin_password])
+
+      if encryptation = check_encryptation(options[:encryptation])
+        @ldap.encryptation(encryptation)
+      end
+    end
+
+    # Generate a filter to get the configured groups in the ldap server.
+    # Takes the list of the group names and generate a filter for the groups
+    # with cn that match and also include members:
+    #
+    # Returns the ldap filter.
+    def group_filter
+      or_filters = @user_groups.map {|g| Net::LDAP::Filter.eq("cn", g)}.reduce(:|)
+      Net::LDAP::Filter.pres("member") & or_filters
+    end
+
+    # List the groups in the ldap server that match the configured ones.
+    #
+    # Returns a list of ldap entries for the configured groups.
+    def groups
+      @ldap.search(base: @user_domain,
+                  attributes: %w{ou cn dn sAMAccountName member},
+                  filter: group_filter)
+    end
+
+    # Check if the user is include in any of the configured groups.
+    #
+    # user_dn: is the dn for the user ldap entry.
+    #
+    # Returns true if the user belongs to any of the groups.
+    # Returns false otherwise.
+    def groups_contain_user?(user_dn)
+      return true if @user_groups.empty?
+
+      members = groups.map(&:member).reduce(:+).uniq
+      members.include?(user_dn)
+    end
+
+    # Check if the user credentials are valid.
+    #
+    # login: is the user's login.
+    # password: is the user's password.
+    #
+    # Returns a Ldap::Entry if the credentials are valid.
+    # Returns nil if the credentials are invalid.
+    def valid_login?(login, password)
+      result = @ldap.bind_as(
+        base:     @user_domain,
+        limit:    1,
+        filter:   Net::LDAP::Filter.eq(@uid, login),
+        password: password)
+
+      return result.first if result.is_a?(Array)
+    end
+
+    # Authenticate a user with the ldap server.
+    #
+    # login: is the user's login. This method doesn't accept email identifications.
+    # password: is the user's password.
+    #
+    # Returns the user info if the credentials are valid and there are no groups configured.
+    # Returns the user info if the credentials are valid and the user belongs to a configured group.
+    # Returns nil if the credentials are invalid
+    def authenticate!(login, password)
+      user = valid_login?(login, password)
+      return user if user && groups_contain_user?(user.dn)
+    end
+
+    # Check the legacy auth configuration options (before David's war with omniauth)
+    # to determine whether to use encryptation or not.
+    #
+    # encryptation: is the encryptation method, either 'ssl', 'tls', 'simple_tls' or 'start_tls'.
+    #
+    # Returns the real encryptation type.
+    def check_encryptation(encryptation)
+      return unless encryptation
+
+      case auth_method.downcase.to_sym
+      when :ssl, :simple_tls
+        :simple_tls
+      when :tls, :start_tls
+        :start_tls
+      end
+    end
+
+    # Utility method to check if the connection with the server can be stablished.
+    # It tries to bind with the ldap auth default configuration.
+    #
+    # Return true if the connection is successful.
+    # Return false if the authentication settings are not valid.
+    # Raises an Net::LDAP::LdapError if the connection fails.
+    def test_connection
+      @ldap.bind
+    end
+  end
+end

data/lib/github/ldap/fixtures.ldif

@@ -0,0 +1,70 @@
+version: 1
+
+# Organizations
+dn: dc=github,dc=com
+objectClass: dcObject
+objectClass: organization
+dc: github
+o: GitHub Inc.
+
+dn: ou=Group,dc=github,dc=com
+objectclass: organizationalUnit
+ou: Group
+
+# Groups
+dn: cn=People,ou=Group,dc=github,dc=com
+cn: People
+objectClass: groupOfNames
+member: uid=sean,dc=github,dc=com
+
+dn: cn=Enterprise,ou=Group,dc=github,dc=com
+cn: Enterprise
+objectClass: groupOfNames
+member: uid=calavera,dc=github,dc=com
+
+# Users
+dn: uid=admin,dc=github,dc=com
+objectClass: top
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+cn: system administrator
+sn: administrator
+displayName: Directory Superuser
+uid: admin
+userPassword: secret
+
+dn: uid=sean,dc=github,dc=com
+cn: Sean Bryant
+cn: Sean
+sn: Bryant
+uid: sean
+userPassword: secret
+mail: sean@github.com
+mail: sbryant@github.com
+objectClass: inetOrgPerson
+
+dn: uid=calavera,dc=github,dc=com
+cn: David Calavera
+cn: David
+sn: Calavera
+uid: calavera
+userPassword: secret
+mail: calavera@github.com
+objectClass: inetOrgPerson
+
+dn: uid=ldaptest,dc=github,dc=com
+cn: LDAP
+sn: Test
+uid: ldaptest
+userPassword: secret
+mail: ldaptest@github.com
+objectClass: inetOrgPerson
+
+dn: uid=newuserindb,dc=github,dc=com
+cn: LDAP
+sn: Test
+uid: newuserindb
+userPassword: secret
+mail: newuserindb@github.com
+objectClass: inetOrgPerson

data/lib/github/ldap/server.rb

@@ -0,0 +1,52 @@
+module GitHub
+  class Ldap
+    require 'ladle'
+
+    # Preconfigured user fixtures. If you want to use them for your own tests.
+    DEFAULT_FIXTURES_PATH = File.expand_path('fixtures.ldif', File.dirname(__FILE__))
+
+    DEFAULT_SERVER_OPTIONS = {
+      user_fixtures:  DEFAULT_FIXTURES_PATH,
+      user_domain:     'dc=github,dc=com',
+      admin_user:      'uid=admin,dc=github,dc=com',
+      admin_password:  'secret',
+      quiet:           true,
+      port:            3897
+    }
+
+    class << self
+
+      # server_options: is the options used to start the server,
+      #                 useful to know in development.
+      attr_reader :server_options
+
+      # ldap_server: is the instance of the testing ldap server,
+      #              you should never interact with it,
+      #              but it's used to grecefully stop it after your tests finalize.
+      attr_reader :ldap_server
+    end
+
+    # Start a testing server.
+    # If there is already a server initialized it doesn't do anything.
+    #
+    # options: is a hash with the custom options for the server.
+    def self.start_server(options = {})
+      @server_options = DEFAULT_SERVER_OPTIONS.merge(options)
+
+      @ldap_server ||= Ladle::Server.new(
+        allow_anonymous: false,
+        ldif:            server_options[:user_fixtures],
+        domain:          server_options[:user_domain],
+        port:            server_options[:port],
+        quiet:           server_options[:quiet])
+
+      @ldap_server.start
+    end
+
+    # Stop the testing server.
+    # If there is no server started this method doesn't do anything.
+    def self.stop_server
+      ldap_server && ldap_server.stop
+    end
+  end
+end

data/test/ldap_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class GitHubLdapTest < Minitest::Test
+  def setup
+    GitHub::Ldap.start_server
+
+    @options = GitHub::Ldap.server_options.merge \
+      host: 'localhost',
+      uid:  'uid'
+
+    @ldap = GitHub::Ldap.new(@options)
+  end
+
+  def teardown
+    GitHub::Ldap.stop_server
+  end
+
+  def test_connection_with_default_options
+    assert @ldap.test_connection, "Ldap connection expected to succeed"
+  end
+
+  def test_user_valid_login
+    user = @ldap.valid_login?('calavera', 'secret')
+    assert_equal 'uid=calavera,dc=github,dc=com', user.dn
+  end
+
+  def test_user_with_invalid_password
+    assert !@ldap.valid_login?('calavera', 'foo'),
+      "Login `calavera` expected to be invalid with password `foo`"
+  end
+
+  def test_user_with_invalid_login
+    assert !@ldap.valid_login?('bar', 'foo'),
+      "Login `bar` expected to be invalid with password `foo`"
+  end
+
+  def test_groups_in_server
+    options = @options.merge(:user_groups => %w(Enterprise People))
+    assert_equal 2, GitHub::Ldap.new(options).groups.size
+  end
+
+  def test_user_in_group
+    options = @options.merge(:user_groups => %w(Enterprise People))
+    ldap = GitHub::Ldap.new(options)
+    user = ldap.valid_login?('calavera', 'secret')
+
+    assert ldap.groups_contain_user?(user.dn),
+      "Expected `Enterprise` or `Poeple` to include the member `#{user.dn}`"
+  end
+
+  def test_user_not_in_different_group
+    options = @options.merge(:user_groups => %w(People))
+    ldap = GitHub::Ldap.new(options)
+    user = ldap.valid_login?('calavera', 'secret')
+
+    assert !ldap.groups_contain_user?(user.dn),
+      "Expected `Poeple` not to include the member `#{user.dn}`"
+  end
+
+  def test_user_without_group
+    options = @options.merge(:user_groups => %w(People))
+    ldap = GitHub::Ldap.new(options)
+    user = ldap.valid_login?('ldaptest', 'secret')
+
+    assert !ldap.groups_contain_user?(user.dn),
+      "Expected `Poeple` not to include the member `#{user.dn}`"
+  end
+
+  def test_authenticate_doesnt_return_invalid_users
+    user = @ldap.authenticate!('calavera', 'secret')
+    assert_equal 'uid=calavera,dc=github,dc=com', user.dn
+  end
+
+  def test_authenticate_doesnt_return_invalid_users
+    assert !@ldap.authenticate!('calavera', 'foo'),
+      "Expected `authenticate!` to not return an invalid user"
+  end
+
+  def test_authenticate_check_valid_user_and_groups
+    options = @options.merge(:user_groups => %w(Enterprise People))
+    ldap = GitHub::Ldap.new(options)
+    user = ldap.authenticate!('calavera', 'secret')
+
+    assert_equal 'uid=calavera,dc=github,dc=com', user.dn
+  end
+
+  def test_authenticate_doesnt_return_valid_users_in_different_groups
+    options = @options.merge(:user_groups => %w(People))
+    ldap = GitHub::Ldap.new(options)
+
+    assert !ldap.authenticate!('calavera', 'secret'),
+      "Expected `authenticate!` to not return an user"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+__dir__ = File.expand_path(File.dirname(__FILE__))
+__lib__ = File.expand_path('lib', File.dirname(__FILE__))
+
+$LOAD_PATH << __dir__ unless $LOAD_PATH.include?(__dir__)
+$LOAD_PATH << __lib__ unless $LOAD_PATH.include?(__lib__)
+
+require 'github/ldap'
+require 'github/ldap/server'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: github-ldap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: ladle
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ldap authentication for humans
+email:
+- david.calavera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github-ldap.gemspec
+- lib/github/ldap.rb
+- lib/github/ldap/fixtures.ldif
+- lib/github/ldap/server.rb
+- test/ldap_test.rb
+- test/test_helper.rb
+homepage: https://github.com/github/github-ldap
+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: Ldap client authentication wrapper without all the boilerplate
+test_files:
+- test/ldap_test.rb
+- test/test_helper.rb
+has_rdoc: