adtools 0.0.1pre

data/lib/adtools/computer.rb

@@ -0,0 +1,35 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	class Computer < Base
+		def self.filter # :nodoc:
+			Net::LDAP::Filter.eq(:objectClass,'computer')
+		end
+
+		def self.required_attributes # :nodoc:
+			{ :objectClass => [ 'top', 'person', 'organizationalPerson', 'user', 'computer' ] }
+		end
+
+		def hostname
+			dNSHostName || name
+		end
+	end
+end

data/lib/adtools/config.rb

@@ -0,0 +1,43 @@
+module Adtools
+    class Config
+        attr_accessor :domain, :port, :base, :server, :query_user, :query_password
+        
+        # Creates a new instance of ActiveDirectory::Config
+        #
+        # Sets port, allowed_groups, denied_groups, ad_sv_attrs and ad_mv_attrs to default so they can be omitted from the config
+        def initialize
+            @port = 389
+        end
+
+        # Sets domain valiable
+        #
+        # Called as:
+        #    ActiveDirectory::Config.domain=(s)
+        #
+        # Calculates both base string and server
+        def domain=(s)
+            @domain = s
+            work_out_base(s)
+            @server ||= s
+        end
+            
+        def settings_hash
+            {
+                :host => @server,
+                :base => @base,
+                :port => @port,
+                :auth => {
+                  :method => :simple,
+                  :username => "#{@query_user}@#{@domain}",
+                  :password => @query_password
+                }
+            }
+        end
+
+        private
+
+        def work_out_base(s)
+            @base ||= s.gsub(/\./,', dc=').gsub(/^/,"dc=")
+        end
+    end
+end

data/lib/adtools/container.rb

@@ -0,0 +1,114 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	#
+	# The ActiveDirectory::Container class represents a more malleable way
+	# of dealing with LDAP Distinguished Names (dn), like
+	# "cn=UserName,ou=Users,dc=example,dc=org".
+	#
+	# The following two representations of the above dn are identical:
+	#
+	#   dn = "cn=UserName,ou=Users,dc=example,dc=org"
+	#   dn = ActiveDirectory::Container.dc('org').dc('example').ou('Users').cn('UserName').to_s
+	#
+	class Container
+		attr_reader :type
+		attr_reader :name
+		attr_reader :parent
+
+		def initialize(type, name, node = nil) #:nodoc:
+			@type = type
+			@name = name
+			@node = node
+		end
+
+		#
+		# Creates a starting OU (Organizational Unit) dn part.
+		#
+		#   # ou_part = "ou=OrganizationalUnit"
+		#   ou_part = ActiveDirectory::Container.ou('OrganizationalUnit').to_s
+		#
+		def self.ou(name)
+			new(:ou, name, nil)
+		end
+
+		#
+		# Creates a starting DC (Domain Component) dn part.
+		#
+		#   # dc_part = "dc=net"
+		#   dc_part = ActiveDirectory::Container.dc('net').to_s
+		#
+		def self.dc(name)
+			new(:dc, name, nil)
+		end
+
+		#
+		# Creates a starting CN (Canonical Name) dn part.
+		#
+		#   # cn_part = "cn=CanonicalName"
+		#   cn_part = ActiveDirectory::Container.cn('CanonicalName').to_s
+		#
+		def self.cn(name)
+			new(:cn, name, nil)
+		end
+
+		#
+		# Appends an OU (Organizational Unit) dn part to another Container.
+		#
+		#   # ou = "ou=InfoTech,dc=net"
+		#   ou = ActiveDirectory::Container.dc("net").ou("InfoTech").to_s
+		#
+		def ou(name)
+			self.class.new(:ou, name, self)
+		end
+
+		#
+		# Appends a DC (Domain Component) dn part to another Container.
+		#
+		#   # base = "dc=example,dc=net"
+		#   base = ActiveDirectory::Container.dc("net").dc("example").to_s
+		#
+		def dc(name)
+			self.class.new(:dc, name, self)
+		end
+
+		#
+		# Appends a CN (Canonical Name) dn part to another Container.
+		#
+		#    # user = "cn=UID,ou=Users"
+		#    user = ActiveDirectory::Container.ou("Users").cn("UID")
+		#
+		def cn(name)
+			self.class.new(:cn, name, self)
+		end
+
+		#
+		# Converts the Container object to its String representation.
+		#
+		def to_s
+			@node ? "#{@type}=#{name},#{@node.to_s}" : "#{@type}=#{name}"
+		end
+
+		def ==(other) #:nodoc:
+			to_s.downcase == other.to_s.downcase
+		end
+	end
+end

data/lib/adtools/field_type/binary.rb

@@ -0,0 +1,39 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+  module FieldType
+    class Binary
+      #
+      # Encodes a hex string into a GUID
+      #
+      def self.encode(hex_string)
+        [hex_string].pack("H*")
+      end
+
+      #
+      # Decodes a binary GUID as a hex string
+      #
+      def self.decode(guid)
+        guid.unpack("H*").first.to_s
+      end
+    end
+  end
+end

data/lib/adtools/field_type/date.rb

@@ -0,0 +1,39 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+  module FieldType
+    class Date
+      #
+      # Converts a time object into an ISO8601 format compatable with Active Directory
+      # 
+      def self.encode(local_time)
+        local_time.strftime('%Y%m%d%H%M%S.0Z')
+      end
+
+      #
+      # Decodes an Active Directory date when stored as ISO8601
+      #
+      def self.decode(remote_time)
+        Time.parse(remote_time)
+      end
+    end
+  end
+end

data/lib/adtools/field_type/dn_array.rb

@@ -0,0 +1,40 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	module FieldType
+		class DnArray
+			#
+			# Encodes an array of objects into a list of dns
+			# 
+			def self.encode(obj_array)
+				obj_array.collect { |obj| obj.dn }
+			end
+
+			#
+			# Decodes a list of DNs into the objects that they are
+			#
+			def self.decode(dn_array)
+				# How to do user or group?
+				Base.find(:all, :distinguishedname => dn_array)
+			end
+		end
+	end
+end

data/lib/adtools/field_type/group_dn_array.rb

@@ -0,0 +1,40 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	module FieldType
+		class GroupDnArray
+			#
+			# Encodes an array of objects into a list of dns
+			# 
+			def self.encode(obj_array)
+				obj_array.collect { |obj| obj.dn }
+			end
+
+			#
+			# Decodes a list of DNs into the objects that they are
+			#
+			def self.decode(dn_array)
+				# How to do user or group?
+				Group.find(:all, :distinguishedname => dn_array)
+			end
+		end
+	end
+end

data/lib/adtools/field_type/member_dn_array.rb

@@ -0,0 +1,47 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	module FieldType
+		class MemberDnArray
+			#
+			# Encodes an array of objects into a list of dns
+			# 
+			def self.encode(obj_array)
+				obj_array.collect { |obj| obj.dn }
+			end
+
+			#
+			# Decodes a list of DNs into the objects that they are
+			#
+			def self.decode(dn_array)
+				# Ensures that the objects are cast correctly
+				users = User.find(:all, :distinguishedname => dn_array)
+				groups = Group.find(:all, :distinguishedname => dn_array)
+
+				arr = Array.new
+				arr << users unless users.nil?
+				arr << groups unless groups.nil?
+
+				return arr.flatten
+			end
+		end
+	end
+end

data/lib/adtools/field_type/password.rb

@@ -0,0 +1,41 @@
+#-- license
+#
+#  Based on original code by Justin Mecham and James Hunt
+#  at http://rubyforge.org/projects/activedirectory
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#++ license
+
+module Adtools
+	module FieldType
+		class Password
+			#
+			# Encodes an unencrypted password into an encrypted password
+			# that the Active Directory server will understand.
+			#
+			def self.encode(password)
+				("\"#{password}\"".split(//).collect { |c| "#{c}\000" }).join
+			end
+
+			#
+			# Always returns nil, since you can't decrypt the User's encrypted
+			# password.
+			#
+			def self.decode(hashed)
+				nil
+			end
+		end
+	end
+end