adauth 1.0.1 → 1.1.0

data/.gitignore

@@ -5,3 +5,5 @@ tmp/*
 spec/test_data.yml
 doc/*
 .yardoc/*
+
+.rvmrc

data/Readme.rdoc

@@ -43,11 +43,17 @@ You need to create a yaml file that looks like this:
         - group
       fail_allowed_groups:
         - no_group
+      pass_allowed_ous:
+        - ou
+      fail_allowed_ous:
+        - no_ou
 
     user:
       login: username
       password: password
       group: group
+      ou: ou_user_is_in
+      email: email_of_user_in_ad
 
 The domain portion of this file is pretty self explanatory, they are the same as the code above for creating a domain connection. ALL options need to be set here.
 

data/lib/adauth.rb

@@ -23,6 +23,12 @@ module Adauth
         elsif @config.denied_groups != []
             user = Adauth::User.authenticate(login, pass)
             (user && @config.denied_groups == (@config.denied_groups - user.groups)) ? user : nil
+        elsif @config.allowed_ous != []
+            user = Adauth::User.authenticate(login, pass)
+            (user && @config.allowed_ous != (@config.allowed_ous - user.ous)) ? user : nil
+        elsif @config.denied_ous != []
+            user = Adauth::User.authenticate(login, pass)
+            (user && @config.denied_ous == (@config.denied_ous - user.ous)) ? user : nil
         else
             Adauth::User.authenticate(login, pass)
         end

data/lib/adauth/config.rb

@@ -2,15 +2,35 @@ module Adauth
     
     # Holds all of adauth config in attr_accessor values
     class Config
-        attr_accessor :domain, :port, :base, :server, :allowed_groups, :denied_groups
+        attr_accessor :domain, :port, :base, :server, :allowed_groups, :denied_groups, :ad_sv_attrs, :ad_mv_attrs, :allowed_ous, :denied_ous
         
         # Creates a new instance of Adauth::Config
         #
-        # Sets port, allowed_groups and denied_groups to default so they can be omitted from the 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
            @allowed_groups = []
            @denied_groups = []
+           @ad_sv_attrs = {}
+           @ad_mv_attrs = {}
+           @allowed_ous = []
+           @denied_ous = []
+        end
+        
+        def domain=(s)
+            @domain = s
+            work_out_base(s)
+            @server ||= s
+        end
+        
+        private
+        
+        def work_out_base(s)
+            dcs = []
+            s.split(/\./).each do |split|
+                dcs.push("dc=#{split}")
+            end
+            @base ||= dcs.join(', ')
         end
     end
 end

data/lib/adauth/user.rb

@@ -17,7 +17,9 @@ module Adauth
         # Multi values were the method needs to return an array for values.
         ATTR_MV = {
               :groups => [ :memberof,
-                           Proc.new {|g| g.sub(/.*?CN=(.*?),.*/, '\1')} ]
+                           Proc.new {|g| g.sub(/.*?CN=(.*?),.*/, '\1')} ],
+              :ous => [ :memberof,
+                           Proc.new {|g| g.sub(/.*?OU=(.*?),.*/, '\1')} ]
         }
 
         # Authenticates a user against Active Directory and returns an instance of self
@@ -34,7 +36,7 @@ module Adauth
                                     :auth => { :username => "#{login}@#{Adauth.config.domain}",
                                         :password => pass,
                                         :method => :simple }
-            if conn.bind and user = conn.search(:filter => "sAMAccountName=#{login}").first
+            if conn.bind and user = conn.search(:filter => Net::LDAP::Filter.eq('sAMAccountName', login)).first
                 return self.new(user)
             else
                 return nil
@@ -66,7 +68,7 @@ module Adauth
         end
 
         def self.generate_single_value_readers
-            ATTR_SV.each_pair do |k, v|
+            ATTR_SV.merge(Adauth.config.ad_sv_attrs).each_pair do |k, v|
                 val, block = Array(v)
                 define_method(k) do
                     if @entry.attribute_names.include?(val)
@@ -83,7 +85,7 @@ module Adauth
         end
 
         def self.generate_multi_value_readers
-            ATTR_MV.each_pair do |k, v|
+            ATTR_MV.merge(Adauth.config.ad_mv_attrs).each_pair do |k, v|
                 val, block = Array(v)
                 define_method(k) do
                     if @entry.attribute_names.include?(val)

data/lib/adauth/user_model.rb

@@ -18,6 +18,16 @@ module Adauth
     	   group_strings.split(", ") 
 	    end
 	    
+	    # Returns an array of groups for the user
+        #
+        # Called as:
+        #    UserInstance.ous
+        #
+        # The array is generated from the group_strings attribute which is set by the adauth update and create methods. This array will match the orginizational units the user is a member of.
+	    def ous
+	        ou_strings.split(", ")
+        end
+	    
 	    # Update the user record using an instance of Adauth::User
 	    #
 	    # Called as:
@@ -57,6 +67,7 @@ module Adauth
         		create! do |user|
         			user.login = adauth_user.login
         			user.group_strings = adauth_user.groups.join(", ")
+        			user.ou_strings = adauth_user.ous.join(", ")
         			user.name = adauth_user.name
         		end
         	end 

data/lib/adauth/version.rb

@@ -1,5 +1,5 @@
 module Adauth
     
     # The version of the gem
-    Version = "1.0.1"
+    Version = "1.1.0"
 end

data/lib/generators/adauth/config/templates/config.rb.erb

@@ -39,4 +39,19 @@ Adauth.configure do |c|
 	#
 	# Takes an array for group names
 	#c.denied_groups = ["Group1", "Group2"]
+	
+	# Additional single attributes to fetch
+	#
+	# Single Values to fetch from Active Directory for example phone number
+	#
+	# Takes a hash in the form { :method_on_Adauth::User => :field_in_ad }
+	#c.ad_sv_attrs = { :phone => :telephonenumber }
+	
+	# Additional multi attributes to fetch
+	#
+	# Multiple Values to fetch from Active Directory
+	#
+	# Takes a hash in the form { :method_on_Adauth::User => [ :field_in_ad, Proc.new { |g| operations_to_turn_field_into_array } ] }
+	# Example os for groups (already provided)
+	#c.ad_mv_attrs(:groups => [ :memberof, Proc.new {|g| g.sub(/.*?CN=(.*?),.*/, '\1')} ])
 end

data/lib/generators/adauth/user_model/user_model_generator.rb

@@ -15,7 +15,7 @@ module Adauth
             # Has 2 optional parameters, model_name which defaults to "user" and migration_name which defaults to "create_users"
             def generate_user_model
                 template "model.rb.erb", "app/models/#{file_name}.rb"
-                generate "migration", "#{migration_name_for_array}", "login:string", "group_strings:string", "name:string"
+                generate "migration", "#{migration_name_for_array}", "login:string", "group_strings:string", "name:string", "ou_strings:string"
             end
             
             private

data/spec/adauth_spec.rb

@@ -4,9 +4,17 @@ require 'yaml'
 describe Adauth, "#configure" do
     it "should accept a block" do
         Adauth.configure do |c|
-            c.domain = "example.com"
+            c.domain = "test.example.com"
         end
     end
+    
+    it "should correctly calculate the base" do
+        Adauth.config.base.should eq("dc=test, dc=example, dc=com")
+    end
+    
+    it "should set the server to the domain if not specified" do
+        Adauth.config.server.should eq("test.example.com")
+    end
 end
 
 describe Adauth, "#config" do
@@ -66,10 +74,30 @@ describe Adauth, "#authenticate" do
         Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_nil
     end
     
-    it "should dis-allow users who are in a denied group" do
+    it "should allow users who are in a denied group" do
         Adauth.config.denied_groups = @yaml["domain"]["fail_allowed_groups"]
         Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_a Adauth::User
     end
+    
+    it "should allow users who are in an allowed ou" do
+        Adauth.config.allowed_ous = @yaml["domain"]["pass_allowed_ous"]
+        Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_a Adauth::User
+    end
+    
+    it "should dis-allow users who are not in an allowed ou" do
+        Adauth.config.allowed_ous = @yaml["domain"]["fail_allowed_ous"]
+        Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_nil
+    end
+    
+    it "should dis-allow users who are in a denied ou" do
+        Adauth.config.denied_ous = @yaml["domain"]["pass_allowed_ous"]
+        Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_nil
+    end
+    
+    it "should allow users who are not in a denied ou" do
+        Adauth.config.denied_ous = @yaml["domain"]["fail_allowed_ous"]
+        Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"]).should be_a Adauth::User
+    end
 end
 
 describe Adauth::User do
@@ -99,4 +127,28 @@ describe Adauth::User do
     it "should have the correct user" do
         @user.login.should == @yaml["user"]["login"]
     end
+end
+
+describe "Adauth::User custom returns" do
+    before :each do
+        @yaml = YAML::load(File.open('spec/test_data.yml'))
+        Adauth.configure do |c|
+            c.domain = @yaml["domain"]["domain"]
+            c.server = @yaml["domain"]["server"]
+            c.port = @yaml["domain"]["port"]
+            c.base = @yaml["domain"]["base"]
+            c.ad_sv_attrs = { :phone => :telephonenumber }
+            c.ad_mv_attrs = { :ous => [ :memberof,
+                                            Proc.new {|g| g.sub(/.*?OU=(.*?),.*/, '\1')} ] }
+        end    
+        @user = Adauth.authenticate(@yaml["user"]["login"], @yaml["user"]["password"])
+    end
+    
+    it "should pickup the custom single value from AD" do
+        @user.phone.should be_a String
+    end
+    
+    it "should pickup the custom multi value from AD" do
+        @user.ous.should be_a Array
+    end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: adauth
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Adam "Arcath" Laycock
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-01 00:00:00 +01:00
+date: 2011-08-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency