soar_ldap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: def8660c3a9aab179dcb6135d71ef1bc7b44d498
+  data.tar.gz: 203eae89e13f58d405fc0d99fb60ba15a84f9ae7
+SHA512:
+  metadata.gz: dddbeba8a02711054d8a89324db8109dc9aa4c8be371969a00317a036c1ee6c7bf3ed0d0bad1bd18ff69d02bbed209192b36aed9afdee0310744bbe12d943a5b
+  data.tar.gz: c329706fef6bd445f5f42fa45210bb3e5a10245f336a1baf05a59eb416d70bd68ec76b0894e54d5375bca658d2a76917bed70769ffcb9776b59d149d7d0b8c47

data/.gitignore

@@ -0,0 +1,11 @@
+.byebug_history
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_ldap

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p643

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ernst van Graan
+
+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,49 @@
+# SoarLdap
+
+SoarLdap is a simplified LDAP client library allowing easy access to entries on LDAP servers, using LDAP protocol version 3, for use in the SOAR architecture. SoarLdap has an optional built-in cache, which reduces the requirement for connections to the LDAP server. Freshness of 0 disables the cache. Freshness is in seconds.
+
+SoarLdap adheres to the SoarIdm::DirectoryProvider specification for diretory providers.
+
+The finder find_entity can be over-ridden to model specific search behaviour. By default, get_entity establishes a connection and calls find_entity, which searches the subtree for UUIDs matching the identifier specified, or for dn entries which include the identifier specifier. By default the finder includes the following fields: 'objectClass', 'cn', 'dn', 'entryuuid', 'description' and returns only the first entry found. You might want to override find_entity to return an array if you expect multiple results.
+
+SoarLdap will raise a SoarLdapError if it encounters unexpected or invalid configuration or state. get_entity returns an LDAP::Entry. connect returns LDAP::Conn.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'soar_ldap'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install soar_ldap
+
+## Usage
+    spec.add_development_dependency 'soar_ldap'
+    bundle exec irb
+
+    require 'soar_ldap'
+    configuration = { 'server' => 'my.server.com', 'port' => 389, 'node' => 'dc=directory,dc=my,dc=server,dc=com', freshness => 0 }
+    credentials = { 'username' => 'ldap-user', 'password' => 'ldap-password' }
+    @soar_ldap = SoarLdap::LdapProvider.new(configuration)
+    @soar_ldap.authenticate(credentials)
+    puts "This LDAP Provider operated on #{@soar_ldap.uri}"
+    @soar_ldap.connect if @soar_ldap.bootstrapped?
+    # returns LDAP::Conn
+    puts "Connected? #{@soar_ldap.connected?}"
+    ldap_entry = @soar_ldap.get_entity('findme') if @soar_ldap.ready?
+    # LDAP::Entry
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to ernst dot van dot graan at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/soar_ldap/version.rb

@@ -0,0 +1,3 @@
+module SoarLdap
+  VERSION = "0.0.1"
+end

data/lib/soar_ldap.rb

@@ -0,0 +1,116 @@
+require "soar_ldap/version"
+require 'ldap'
+require 'ldap/control'
+require 'soar_idm/directory_provider'
+#require 'byebug'
+
+module SoarLdap
+  class SoarLdapError < StandardError
+  end
+
+  class LdapProvider < SoarIdm::DirectoryProvider
+    attr_reader :configuration
+    attr_reader :path
+    attr_reader :server
+    attr_reader :port
+    attr_reader :credentials
+    attr_reader :username
+    attr_reader :password    
+    attr_reader :connection
+
+    def initialize(configuration)
+      bootstrap(configuration)
+    end
+
+    def bootstrap(configuration)
+      @configuration = nil
+      validate_configuration(configuration)
+      remember_configuration(configuration)
+    end
+
+    def bootstrapped?
+      not @configuration.nil?
+    end
+
+    def authenticate(credentials)
+      @credentials = nil
+      validate_credentials(credentials)
+      remember_credentials(credentials)
+    end
+
+    def connect
+      @connection = ::LDAP::Conn.new(@server, @port)
+      @connection.set_option(::LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+      @connection.bind(@username, @password)
+      @connection
+
+    rescue => ex
+      raise SoarLdapError.new("Connection error + #{ex}")
+    end
+
+    def connected?
+      not @connection.nil?
+    end
+
+    def ready?
+      bootstrapped? and connected?
+    end
+
+    def uri
+      raise SoarLdapError.new('Not bootstrapped') if not bootstrapped?
+      "ldap://#{server}:#{port}/#{@path}"
+    end
+
+    def get_entity(identifier)
+      connect if not connected?
+      find_entity(@connection, identifier)
+
+    rescue => ex
+      raise SoarLdapError.new("Lookup error, #{ex}")
+    end
+
+    protected
+
+    def find_entity(connection, identifier)
+      connection.search(@path, ::LDAP::LDAP_SCOPE_SUBTREE, 'objectClass=*', ['objectClass', 'cn', 'dn', 'entryuuid', 'description']) do |entry|
+        uuid = entry['entryUUID'].first
+        dn = entry.dn
+        return entry if uuid == identifier
+        return entry if dn and dn.include?(identifier)
+      end
+      nil
+    end
+
+    private
+
+    def validate_configuration(configuration)
+      raise SoarLdapError.new('No configuration') if configuration.nil?
+      raise SoarLdapError.new('Empty configuration') if configuration == {}
+      raise SoarLdapError.new('Invalid configuration') if not configuration.is_a?(Hash)
+      raise SoarLdapError.new('Missing server') if configuration['server'].nil?
+      raise SoarLdapError.new('Missing port') if configuration['port'].nil?
+      raise SoarLdapError.new('Missing path') if configuration['path'].nil?
+    end
+
+    def validate_credentials(credentials)
+      raise SoarLdapError.new('Missing credentials') if credentials.nil?
+      raise SoarLdapError.new('Empty credentials') if credentials == {}
+      raise SoarLdapError.new('Invalid credentials') if not credentials.is_a?(Hash)
+      raise SoarLdapError.new('Missing username') if credentials['username'].nil?
+      raise SoarLdapError.new('Missing password') if credentials['password'].nil?
+    end
+
+    def remember_configuration(configuration)
+      @configuration = configuration
+      @server = @configuration['server']
+      @port = @configuration['port'].to_i
+      @path = @configuration['path']
+    end
+
+    def remember_credentials(credentials)
+      @credentials = credentials
+      @username = @credentials['username']
+      @password = @credentials['password']
+    end
+  end
+end

data/soar_ldap.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_ldap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_ldap"
+  spec.version       = SoarLdap::VERSION
+  spec.authors       = ["Ernst van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{LDAP client library allowing easy acces to entries on LDAP servers}
+  spec.description   = %q{LDAP client library allowing easy acces to entries on LDAP servers}
+#  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+#  spec.required_ruby_version = ['>=2.0.0']
+
+  spec.add_development_dependency "persistent-cache-ram"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "soar_idm"
+  if RUBY_PLATFORM =~ /java/
+    spec.add_development_dependency "jruby-ldap"
+  else
+    spec.add_development_dependency "ruby-ldap"
+    #spec.add_development_dependency "byebug"
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: soar_ldap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ernst van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: persistent-cache-ram
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: soar_idm
+  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: ruby-ldap
+  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'
+description: LDAP client library allowing easy acces to entries on LDAP servers
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/soar_ldap.rb
+- lib/soar_ldap/version.rb
+- soar_ldap.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: LDAP client library allowing easy acces to entries on LDAP servers
+test_files: []