jackad 0.2.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 — 2013 Nick Kugaevsky
+
+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,47 @@
+# Jackad
+
+Active Directory connector gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jackad'
+
+And then execute:
+
+    $ bundle install
+
+Or install it alone with:
+
+    $ gem install jackad
+
+Configure your AD connection with YAML file `/usr/local/jackad/ldap.yml`
+
+    :host: 'example.com'
+    :port: 389
+    :base: 'dc=example,dc=com'
+    :attribute: 'sAMAccountName'
+    :method: 'simple'
+    :ssl: false
+    :admin: false
+    :admin_user: 'admin_username'           # Only if admin:true needed
+    :admin_password: 'admin_password'       # Only if admin:true needed
+
+## Usage
+
+Jackad gives you simple API to access your LDAP directory. All self methods return true or false
+
+    Jackad.credentials_valid?('username@example.com', 'user_ldap_password')     # Check validity of username and password
+
+    Jackad.entry_exists?('username')                                            # Check user existance by configured attribute
+
+    Jackad.entry_valid?(username)                                               # Check user validity by configured attribute, useraccountcontrol flags and pwdlastset attribute
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/jackad.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jackad/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Kugaevsky"]
+  gem.email         = ["nick@kugaevsky.ru"]
+  gem.description   = %q{ Simple LDAP (Active Directory) connector }
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/pantsu/jackad"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "jackad"
+  gem.require_paths = ["lib"]
+  gem.version       = Jackad::VERSION
+
+  gem.add_dependency 'net-ldap', '~>0.2.0'
+  # gem.add_dependency 'yaml'
+
+  #gem.add_development_dependency('rspec')
+
+end

data/lib/jackad.rb

@@ -0,0 +1,7 @@
+# -*- ruby encoding: utf-8 -*-
+
+require "jackad/net/ldap"
+require "jackad/version"
+require "jackad/config"
+require "jackad/ad_connect"
+require "jackad/jackad"

data/lib/jackad/ad_connect.rb

@@ -0,0 +1,46 @@
+module Jackad
+  class AdConnect
+
+    attr_reader :ldap, :attribute
+
+    def initialize(params = {})
+      options = Jackad::Config.setup
+
+      @ldap = Net::LDAP.new(params)
+      @ldap.host = options[:host]
+      @ldap.port = options[:port]
+      @ldap.base = options[:base]
+      @attribute = params[:attribute] || options[:attribute]
+      @login = params[:login] || options[:admin_user]
+      @password = params[:password] || options[:admin_password]
+
+      @ldap.auth @login, @password
+
+      @new_password = params[:new_password]
+    end
+
+    # Gets entry attributes from LDAP
+    def get_entry_data(username, attrs = [] )
+      filter = Net::LDAP::Filter.eq(@attribute.to_s, username)
+      search_params = { filter: filter, size: 1 }
+      search_params[:attributes] = attrs unless attrs.empty?
+      @ldap.search(search_params)[0]
+    end
+
+    # Gets user guid from LDAP.
+    # Returns binary Net::BER::BerIdentifiedString
+    def get_entry_guid(username)
+      filter = Net::LDAP::Filter.eq(@attribute.to_s, username)
+      result = @ldap.search(filter: filter, attributes: ['objectguid'], size: 1)
+      result.size > 0 ? result[0]['objectguid'][0] : nil
+    end
+
+    # Gets user guid from LDAP.
+    # Returns string.
+    def get_entry_guid_as_string(username)
+      username = get_entry_guid(username)
+      username.unpack('H*')[0].upcase unless username.nil?
+    end
+
+  end
+end

data/lib/jackad/config.rb

@@ -0,0 +1,7 @@
+module Jackad
+  class Config
+    def self.setup
+      YAML.load_file('/usr/local/jackad/ldap.yml')
+    end
+  end
+end

data/lib/jackad/jackad.rb

@@ -0,0 +1,32 @@
+module Jackad
+  class ConnectionRefused < StandardError; end
+  class RecordNotFound < StandardError; end
+
+  # Check validity of username and password
+  # Returns true or false
+  def self.credentials_valid?(username, password)
+    ad = AdConnect.new
+    ad.ldap.auth(username, password)
+    ad.ldap.bind
+  end
+
+  # Check user existance by configured attribute
+  # Returns true or false
+  def self.entry_exists?(username)
+    ad = AdConnect.new
+    filter = Net::LDAP::Filter.eq(ad.attribute.to_s, username)
+    ad.ldap.search(filter: filter, size: 1).size > 0 ? true : false
+  end
+
+  # Check user validity by configured attribute, useraccountcontrol flags and pwdlastset attribute
+  # Returns true or false
+  def self.entry_valid?(username)
+    ad = AdConnect.new
+    filter_by_attr = Net::LDAP::Filter.eq(ad.attribute.to_s, username)
+    filter_by_uac = ~Net::LDAP::Filter.construct('useraccountcontrol:1.2.840.113556.1.4.803:=2')
+    filter_by_pass = ~Net::LDAP::Filter.eq('pwdlastset', '0')
+    filter = filter_by_attr & filter_by_uac & filter_by_pass
+    ad.ldap.search(filter: filter, size: 1).size > 0 ? true : false
+  end
+
+end

data/lib/jackad/net/ldap.rb

@@ -0,0 +1,20 @@
+require "net/ldap"
+
+module Jackad
+  module Net
+    class LDAP < ::Net::LDAP
+
+      def search(args = {})
+        super(args) || []
+      rescue => e
+        case e.message
+        when /refused connection/
+          raise Jackad::ConnectionRefused, e.message
+        else
+          raise
+        end
+      end
+
+    end
+  end
+end

data/lib/jackad/version.rb

@@ -0,0 +1,3 @@
+module Jackad
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jackad
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors:
+- Nick Kugaevsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: ! ' Simple LDAP (Active Directory) connector '
+email:
+- nick@kugaevsky.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jackad.gemspec
+- lib/jackad.rb
+- lib/jackad/ad_connect.rb
+- lib/jackad/config.rb
+- lib/jackad/jackad.rb
+- lib/jackad/net/ldap.rb
+- lib/jackad/version.rb
+homepage: https://github.com/pantsu/jackad
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Simple LDAP (Active Directory) connector
+test_files: []