ActiveDirectoryForRuby 0.1.8

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.8 2007-12-06
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,168 @@
+Copyright (c) 2007 Juan Gabriel Medina Marquez
+Released under LGPL
+
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/ActiveDirectoryForRuby.rb
+lib/ActiveDirectoryForRuby/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_ActiveDirectoryForRuby.rb
+test/test_helper.rb
+test/sample_config.yml
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,51 @@
+#=ActiveDirectoryForRuby
+#
+# Allows easy bare minimum access to MS Windows Server's
+# ActiveDirectory data and authentication
+#
+#=How To Use
+#
+# Just create an ActiveDirectoryForRuby object, and pass
+# your YAML configuration file as follows:
+#
+# myconn = ActiveDirectoryForRuby::ActiveDirectoryForRuby.new('myconfig.yml')
+#
+# Then, you can authenticate a user like this:
+# 
+# myconn.authenticate('user.name', 'somepass') # returns true/false
+#
+# And get a user's data with:
+#
+# myconn['user.name'].ldap_givenname # returns 'User'
+#
+#=Configuration File
+#
+# The format for the configuratio file is as follows:
+#---
+# # Server info, host ip or name, and port
+# # which usually will be 389 for a common
+# # MS Windows server
+# server:
+#   host : intranet.nuclearplant.com
+#   port : 389
+# 
+# # Administrator or authenticating login info
+# # distinguished_name
+# admin:
+#   distinguished_name : CN=Montgomery Burns,CN=Admins,DC=nuclearplant,DC=com
+#   user_name          : NUKEPLANT\montgomery.burns
+#   password           : burnsy
+# 
+# # The user data base structure and
+# # the field name containing user names
+# # which is usually sAMAccountName
+# search:
+#   base  : OU=USA,DC=nuclearplant,DC=com
+#   field : sAMAccountName
+#---
+#
+#=License
+#
+# Copyright (c) 2007 Juan Gabriel Medina Marquez
+# Released under the GNU Lesser General Public License
+#

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'ActiveDirectoryForRuby/version'
+
+AUTHOR = 'Juan Gabriel Medina Marquez'  # can also be an array of Authors
+EMAIL = "rha7.com@gmail.com"
+DESCRIPTION = "Active Directory For Ruby"
+GEM_NAME = 'ActiveDirectoryForRuby' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ad4ruby' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = ActiveDirectoryForRuby::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ActiveDirectoryForRuby documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ActiveDirectoryForRuby'

data/lib/ActiveDirectoryForRuby.rb

@@ -0,0 +1,145 @@
+$:.unshift File.dirname(__FILE__)
+require 'rubygems'
+require 'yaml'
+require 'erb'
+require 'net/ldap'
+
+module ActiveDirectoryForRuby
+	class ActiveDirectoryForRubyFields #:nodoc:
+		def initialize(data) #:nodoc:
+			@data = data
+		end
+		
+		def method_missing(methodname) #:nodoc:
+			strMethodName = methodname.id2name
+			if strMethodName[0..4] != 'ldap_'
+				raise "Method missing [#{strMethodName}]"
+				return nil
+			end
+			symFieldName = strMethodName[5..99999].to_sym
+			data = @data[symFieldName]
+			data = data[0] if data.length == 1 if data.class == Array unless data.nil?
+			data = nil if data.length == 0 if data.class == Array unless data.nil?
+			return data
+		end
+	end
+	
+	#=ActiveDirectoryForRuby
+	#
+	# Allows for easy access to MS Windows Server's ActiveDirectory
+	# Authentication and data.
+	#
+	# Overrides [] operator, maps LDAP fields to Method names, and provides
+	# a simple authenticate() method for easy authentication.
+	#
+	class ActiveDirectoryForRuby
+		
+		#= Constructor
+		#
+		# Receives a single parameter which is the path to the
+		# ActiveDirectory data YAML config file.
+		#
+		# Config file's structure is describe in README.txt
+		#
+		def initialize(strConfigFile)
+			lconfig = YAML::load(ERB.new(IO.read(strConfigFile)).result).freeze
+			@config = {}
+			lconfig.each do |key, value|
+				temp = {}
+				value.each do |key2, value2|
+					temp[key2.to_sym] = value2
+				end
+				@config[key.to_sym] = temp
+			end
+		end
+
+		# Returns true or false depending on wether
+		# user and password were or not succesfully authenticated.
+		# example:
+		#
+		# adconn.authenticate('myuser', 'secretpass')
+		# => true
+		#
+		def authenticate(user, pass)
+			ldap_con = createconnection(@config[:admin][:distinguished_name], @config[:admin][:password])
+			user_filter = Net::LDAP::Filter.eq( @config[:search][:field], user )
+			op_filter = Net::LDAP::Filter.eq( "objectClass", "organizationalPerson" )
+			dn = String.new
+			ldap_con.search( :base => @config[:search][:base], :filter => op_filter & user_filter, :attributes=> 'dn') do |entry|
+				dn = entry.dn
+			end
+			login_succeeded = false
+			unless dn.empty?
+				ldap_con = createconnection(dn, pass)
+				login_succeeded = true if ldap_con.bind
+			end
+			return login_succeeded
+		end
+		
+		# Receives a user's login and optionally a second parameter
+		# as an array containing symbols representing fields in LDAP
+		# examples:
+		#
+		# adconn.get('myuser') # Would return all fields
+		# win.get('myuser', [ :cn, :sn ]) # Would return :dn, :cn and :sn
+		#
+		# Additionally get() creates an additional field :organizational_unit
+		# based on :dn with a humanized version of any Organizational Unit (OU)
+		# fields available in :dn and reversed, for example if we had a :dn like
+		#
+		# 'CN=Homer Simpson,OU=Springfield,OU=USA,DC=nuclearplant,DC=com'
+		#
+		# win.get('myuser')[:organizational_unit]
+		#
+		# would yield: 'USA, Springfield'
+		#
+		def get(user, what = nil)
+			@data ||= {}
+			if @data[user].nil?
+				ldap_con = createconnection(@config[:admin][:distinguished_name], @config[:admin][:password])
+				user_filter = Net::LDAP::Filter.eq( @config[:search][:field], user )
+				op_filter = Net::LDAP::Filter.eq( "objectClass", "organizationalPerson" )
+				data = nil
+				ldap_con.search( :base => @config[:search][:base], :filter => op_filter & user_filter, :attributes=> what) do |entry|
+					data = entry
+					data[:organizational_unit] = ''
+					data[:organizational_unit] = entry[:dn][0].split(',').collect{|c| case c[0..1] when 'OU' then c else nil end}.compact.collect{|c| c.split('=')[1] }.reverse.join(', ') unless entry[:dn][0].nil? unless entry[:dn].nil? unless entry.nil?
+				end
+				@data[user] = data
+			end
+			return @data[user]
+		end
+		
+		# Defines the [] operator, which allows easy access to fields for a user,
+		# for example:
+    #
+		# pp adconn['user.name']
+		#
+		# Would return an object whose methods correspond to LDAP fields, with a *ldap_* prefix
+		# for example:
+		#
+		# pp adconn['user.name'].ldap_givenname
+		#
+		# Would return the user's givenname, which usually is in AD, the user's first name.
+		#
+		def[](username)
+			return ActiveDirectoryForRubyFields.new(get(username))
+		end
+		
+	private
+	
+		def createconnection(dn, pass)
+			return Net::LDAP.new(
+				{
+					:host => @config[:server][:host], 
+					:port => @config[:server][:port], 
+					:auth => { 
+						:method => :simple,
+						:username => dn,
+						:password => pass
+					}
+				}
+			)
+		end
+	end
+end