uhees-declarative_authorization 0.3.1

data/lib/declarative_authorization/development_support/development_support.rb

@@ -0,0 +1,243 @@
+
+module Authorization
+  module DevelopmentSupport
+    class AbstractAnalyzer
+      attr_reader :engine
+
+      def initialize (engine)
+        @engine = engine
+      end
+
+      def roles
+        AnalyzerEngine.roles(engine)
+      end
+
+      def rules
+        roles.collect {|role| role.rules }.flatten
+      end
+    end
+
+    # Groups utility methods and classes to better work with authorization object
+    # model.
+    module AnalyzerEngine
+
+      def self.roles (engine)
+        Role.all(engine)
+      end
+
+      def self.relevant_roles (engine, users)
+        users.collect {|user| user.role_symbols.map {|role_sym| Role.for_sym(role_sym, engine)}}.
+            flatten.uniq.collect {|role| [role] + role.ancestors}.flatten.uniq
+      end
+
+      def self.rule_for_permission (engine,  privilege, context, role)
+        AnalyzerEngine.roles(engine).
+              find {|cloned_role| cloned_role.to_sym == role.to_sym}.rules.find do |rule|
+            rule.contexts.include?(context) and rule.privileges.include?(privilege)
+          end
+      end
+
+      def self.apply_change (engine, change)
+        case change[0]
+        when :add_role
+          role_symbol = change[1]
+          if engine.roles.include?(role_symbol)
+            false
+          else
+            engine.roles << role_symbol
+            true
+          end
+        when :add_privilege
+          privilege, context, role = change[1,3]
+          role = Role.for_sym(role.to_sym, engine)
+          privilege = Privilege.for_sym(privilege.to_sym, engine)
+          if ([privilege] + privilege.ancestors).any? {|ancestor_privilege| ([role] + role.ancestors).any? {|ancestor_role| !ancestor_role.rules_for_permission(ancestor_privilege, context).empty?}}
+            false
+          else
+            engine.auth_rules << AuthorizationRule.new(role.to_sym,
+                [privilege.to_sym], [context])
+            true
+          end
+        when :remove_privilege
+          privilege, context, role = change[1,3]
+          role = Role.for_sym(role.to_sym, engine)
+          privilege = Privilege.for_sym(privilege.to_sym, engine)
+          rules_with_priv = role.rules_for_permission(privilege, context)
+          if rules_with_priv.empty?
+            false
+          else
+            rules_with_priv.each do |rule|
+              rule.rule.privileges.delete(privilege.to_sym)
+              engine.auth_rules.delete(rule.rule) if rule.rule.privileges.empty?
+            end
+            true
+          end
+        end
+      end
+
+      class Role
+        @@role_objects = {}
+        attr_reader :role
+        def initialize (role, rules, engine)
+          @role = role
+          @rules = rules
+          @engine = engine
+        end
+
+        def source_line
+          @rules.empty? ? nil : @rules.first.source_line
+        end
+        def source_file
+          @rules.empty? ? nil : @rules.first.source_file
+        end
+
+        # ancestors' privileges are included in in the current role
+        def ancestors (role_symbol = nil)
+          role_symbol ||= @role
+          (@engine.role_hierarchy[role_symbol] || []).
+              collect {|lower_role| ancestors(lower_role) }.flatten +
+            (role_symbol == @role ? [] : [Role.for_sym(role_symbol, @engine)])
+        end
+        def descendants (role_symbol = nil)
+          role_symbol ||= @role
+          (@engine.rev_role_hierarchy[role_symbol] || []).
+              collect {|higher_role| descendants(higher_role) }.flatten +
+            (role_symbol == @role ? [] : [Role.for_sym(role_symbol, @engine)])
+        end
+
+        def rules
+          @rules ||= @engine.auth_rules.select {|rule| rule.role == @role}.
+              collect {|rule| Rule.new(rule, @engine)}
+        end
+        def rules_for_permission (privilege, context)
+          rules.select do |rule|
+            rule.matches?([@role], [privilege.to_sym], context)
+          end
+        end
+
+        def to_sym
+          @role
+        end
+        def self.for_sym (role_sym, engine)
+          @@role_objects[[role_sym, engine]] ||= new(role_sym, nil, engine)
+        end
+
+        def self.all (engine)
+          rules_by_role = engine.auth_rules.inject({}) do |memo, rule|
+            memo[rule.role] ||= []
+            memo[rule.role] << rule
+            memo
+          end
+          engine.roles.collect do |role|
+            new(role, (rules_by_role[role] || []).
+                  collect {|rule| Rule.new(rule, engine)}, engine)
+          end
+        end
+        def self.all_for_privilege (privilege, context, engine)
+          privilege = privilege.is_a?(Symbol) ? Privilege.for_sym(privilege, engine) : privilege
+          privilege_symbols = ([privilege] + privilege.ancestors).map(&:to_sym)
+          all(engine).select {|role| role.rules.any? {|rule| rule.matches?([role.to_sym], privilege_symbols, context)}}.
+              collect {|role| [role] + role.descendants}.flatten.uniq
+        end
+      end
+
+      class Rule
+        @@rule_objects = {}
+        delegate :source_line, :source_file, :contexts, :matches?, :to => :@rule
+        attr_reader :rule
+        def initialize (rule, engine)
+          @rule = rule
+          @engine = engine
+        end
+        def privileges
+          PrivilegesSet.new(self, @engine, @rule.privileges.collect {|privilege| Privilege.for_sym(privilege, @engine) })
+        end
+        def self.for_rule (rule, engine)
+          @@rule_objects[[rule, engine]] ||= new(rule, engine)
+        end
+      end
+
+      class Privilege
+        @@privilege_objects = {}
+        def initialize (privilege, engine)
+          @privilege = privilege
+          @engine = engine
+        end
+
+        # Ancestor privileges are higher in the hierarchy.
+        # Doesn't take context into account.
+        def ancestors (priv_symbol = nil)
+          priv_symbol ||= @privilege
+          # context-specific?
+          (@engine.rev_priv_hierarchy[[priv_symbol, nil]] || []).
+              collect {|higher_priv| ancestors(higher_priv) }.flatten +
+            (priv_symbol == @privilege ? [] : [Privilege.for_sym(priv_symbol, @engine)])
+        end
+        def descendants (priv_symbol = nil)
+          priv_symbol ||= @privilege
+          # context-specific?
+          (@engine.privilege_hierarchy[priv_symbol] || []).
+              collect {|lower_priv, context| descendants(lower_priv) }.flatten +
+            (priv_symbol == @privilege ? [] : [Privilege.for_sym(priv_symbol, @engine)])
+        end
+
+        def rules
+          @rules ||= find_rules_for_privilege
+        end
+        def source_line
+          rules.empty? ? nil : rules.first.source_line
+        end
+        def source_file
+          rules.empty? ? nil : rules.first.source_file
+        end
+
+        def to_sym
+          @privilege
+        end
+        def self.for_sym (privilege_sym, engine)
+          @@privilege_objects[[privilege_sym, engine]] ||= new(privilege_sym, engine)
+        end
+
+        private
+        def find_rules_for_privilege
+          @engine.auth_rules.select {|rule| rule.privileges.include?(@privilege)}.
+              collect {|rule| Rule.for_rule(rule, @engine)}
+        end
+      end
+
+      class PrivilegesSet < Set
+        def initialize (*args)
+          if args.length > 2
+            @rule = args.shift
+            @engine = args.shift
+          end
+          super(*args)
+        end
+        def include? (privilege)
+          if privilege.is_a?(Symbol)
+            super(privilege_from_symbol(privilege))
+          else
+            super
+          end
+        end
+        def delete (privilege)
+          @rule.rule.privileges.delete(privilege.to_sym)
+          if privilege.is_a?(Symbol)
+            super(privilege_from_symbol(privilege))
+          else
+            super
+          end
+        end
+
+        def intersects? (privileges)
+          intersection(privileges).length > 0
+        end
+
+        private
+        def privilege_from_symbol (privilege_sym)
+          Privilege.for_sym(privilege_sym, @engine)
+        end
+      end
+    end
+  end
+end

data/lib/declarative_authorization/helper.rb

@@ -0,0 +1,60 @@
+# Authorization::AuthorizationHelper
+require File.dirname(__FILE__) + '/authorization.rb'
+
+module Authorization
+  module AuthorizationHelper
+  
+    # If the current user meets the given privilege, permitted_to? returns true
+    # and yields to the optional block.  The attribute checks that are defined
+    # in the authorization rules are only evaluated if an object is given
+    # for context.
+    # 
+    # Examples:
+    #     <% permitted_to? :create, :users do %>
+    #     <%= link_to 'New', new_user_path %>
+    #     <% end %>
+    #     ...
+    #     <% if permitted_to? :create, :users %>
+    #     <%= link_to 'New', new_user_path %>
+    #     <% else %>
+    #     You are not allowed to create new users!
+    #     <% end %>
+    #     ...
+    #     <% for user in @users %>
+    #     <%= link_to 'Edit', edit_user_path(user) if permitted_to? :update, user %>
+    #     <% end %>
+    #
+    # To pass in an object and override the context, you can use the optional
+    # options:
+    #     permitted_to? :update, user, :context => :account
+    # 
+    def permitted_to? (privilege, object_or_sym = nil, options = {}, &block)
+      controller.permitted_to?(privilege, object_or_sym, options, &block)
+    end
+  
+    # While permitted_to? is used for authorization in views, in some cases
+    # content should only be shown to some users without being concerned
+    # with authorization.  E.g. to only show the most relevant menu options 
+    # to a certain group of users.  That is what has_role? should be used for.
+    # 
+    # Examples:
+    #     <% has_role?(:sales) do %>
+    #     <%= link_to 'All contacts', contacts_path %>
+    #     <% end %>
+    #     ...
+    #     <% if has_role?(:sales) %>
+    #     <%= link_to 'Customer contacts', contacts_path %>
+    #     <% else %>
+    #     ...
+    #     <% end %>
+    # 
+    def has_role? (*roles, &block)
+      controller.has_role?(*roles, &block)
+    end
+    
+    # As has_role? except checks all roles included in the role hierarchy
+    def has_role_with_hierarchy?(*roles, &block)
+      controller.has_role_with_hierarchy?(*roles, &block)
+    end
+  end
+end

data/lib/declarative_authorization/in_controller.rb

@@ -0,0 +1,367 @@
+# Authorization::AuthorizationInController
+require File.dirname(__FILE__) + '/authorization.rb'
+
+module Authorization
+  module AuthorizationInController
+  
+    def self.included(base) # :nodoc:
+      base.extend(ClassMethods)
+      base.hide_action :authorization_engine, :permitted_to?,
+        :permitted_to!
+    end
+    
+    DEFAULT_DENY = false
+    
+    # Returns the Authorization::Engine for the current controller.
+    def authorization_engine
+      @authorization_engine ||= Authorization::Engine.instance
+    end
+    
+    # If the current user meets the given privilege, permitted_to? returns true
+    # and yields to the optional block.  The attribute checks that are defined
+    # in the authorization rules are only evaluated if an object is given
+    # for context.
+    # 
+    # See examples for Authorization::AuthorizationHelper #permitted_to?
+    #
+    # If no object or context is specified, the controller_name is used as
+    # context.
+    #
+    def permitted_to? (privilege, object_or_sym = nil, options = {}, &block)
+      permitted_to!(privilege, object_or_sym, options.merge(:non_bang => true), &block)
+    end
+    
+    # Works similar to the permitted_to? method, but
+    # throws the authorization exceptions, just like Engine#permit!
+    def permitted_to! (privilege, object_or_sym = nil, options = {}, &block)
+      context = object = nil
+      if object_or_sym.nil?
+        context = self.class.controller_name.to_sym
+      elsif object_or_sym.is_a?(Symbol)
+        context = object_or_sym
+      else
+        object = object_or_sym
+      end
+
+      non_bang = options.delete(:non_bang)
+      args = [
+        privilege,
+        {:user => current_user,
+         :object => object,
+         :context => context,
+         :skip_attribute_test => object.nil?}.merge(options)
+      ]
+      if non_bang
+        authorization_engine.permit?(*args, &block)
+      else
+        authorization_engine.permit!(*args, &block)
+      end
+    end
+
+    # While permitted_to? is used for authorization, in some cases
+    # content should only be shown to some users without being concerned
+    # with authorization.  E.g. to only show the most relevant menu options 
+    # to a certain group of users.  That is what has_role? should be used for.
+    def has_role? (*roles, &block)
+      user_roles = authorization_engine.roles_for(current_user)
+      result = roles.all? do |role|
+        user_roles.include?(role)
+      end
+      yield if result and block_given?
+      result
+    end
+    
+    # As has_role? except checks all roles included in the role hierarchy
+    def has_role_with_hierarchy?(*roles, &block)
+      user_roles = authorization_engine.roles_with_hierarchy_for(current_user)
+      result = roles.all? do |role|
+        user_roles.include?(role)
+      end
+      yield if result and block_given?
+      result
+    end
+    
+    
+    protected
+    def filter_access_filter # :nodoc:
+      permissions = self.class.all_filter_access_permissions
+      all_permissions = permissions.select {|p| p.actions.include?(:all)}
+      matching_permissions = permissions.select {|p| p.matches?(action_name)}
+      allowed = false
+      auth_exception = nil
+      begin
+        allowed = if !matching_permissions.empty?
+                    matching_permissions.all? {|perm| perm.permit!(self)}
+                  elsif !all_permissions.empty?
+                    all_permissions.all? {|perm| perm.permit!(self)}
+                  else
+                    !DEFAULT_DENY
+                  end
+      rescue AuthorizationError => e
+        auth_exception = e
+      end
+
+      unless allowed
+        if all_permissions.empty? and matching_permissions.empty?
+          logger.warn "Permission denied: No matching filter access " +
+            "rule found for #{self.class.controller_name}.#{action_name}"
+        elsif auth_exception
+          logger.info "Permission denied: #{auth_exception}"
+        end
+        if respond_to?(:permission_denied)
+          # permission_denied needs to render or redirect
+          send(:permission_denied)
+        else
+          send(:render, :text => "You are not allowed to access this action.",
+            :status => :forbidden)
+        end
+      end
+    end
+    
+    module ClassMethods
+      #
+      # Defines a filter to be applied according to the authorization of the
+      # current user.  Requires at least one symbol corresponding to an
+      # action as parameter.  The special symbol :+all+ refers to all action.
+      # The all :+all+ statement is only employed if no specific statement is
+      # present.
+      #   class UserController < ApplicationController
+      #     filter_access_to :index
+      #     filter_access_to :new, :edit
+      #     filter_access_to :all
+      #     ...
+      #   end
+      # 
+      # The default is to allow access unconditionally if no rule matches.
+      # Thus, including the +filter_access_to+ :+all+ statement is a good
+      # idea, implementing a default-deny policy.
+      #   
+      # When the access is denied, the method +permission_denied+ is called
+      # on the current controller, if defined.  Else, a simple "you are not
+      # allowed" string is output.  Log.info is given more information on the
+      # reasons of denial.
+      # 
+      #   def permission_denied
+      #     flash[:error] = 'Sorry, you are not allowed to the requested page.'
+      #     respond_to do |format|
+      #       format.html { redirect_to(:back) rescue redirect_to('/') }
+      #       format.xml  { head :unauthorized }
+      #       format.js   { head :unauthorized }
+      #     end
+      #   end
+      # 
+      # By default, required privileges are infered from the action name and
+      # the controller name.  Thus, in UserController :+edit+ requires
+      # :+edit+ +users+.  To specify required privilege, use the option :+require+
+      #   filter_access_to :new, :create, :require => :create, :context => :users
+      #
+      # Without the :+attribute_check+ option, no constraints from the
+      # authorization rules are enforced because for some actions (collections,
+      # +new+, +create+), there is no object to evaluate conditions against.  To
+      # allow attribute checks on all actions, it is a common pattern to provide
+      # custom objects through +before_filters+:
+      #   class BranchesController < ApplicationController
+      #     before_filter :load_company
+      #     before_filter :new_branch_from_company_and_params,
+      #       :only => [:index, :new, :create]
+      #     filter_access_to :all, :attribute_check => true
+      #
+      #     protected
+      #     def new_branch_from_company_and_params
+      #       @branch = @company.branches.new(params[:branch])
+      #     end
+      #   end
+      # NOTE: +before_filters+ need to be defined before the first
+      # +filter_access_to+ call.
+      #   
+      # For further customization, a custom filter expression may be formulated
+      # in a block, which is then evaluated in the context of the controller
+      # on a matching request.  That is, for checking two objects, use the 
+      # following:
+      #   filter_access_to :merge do
+      #     permitted_to!(:update, User.find(params[:original_id])) and
+      #       permitted_to!(:delete, User.find(params[:id]))
+      #   end
+      # The block should raise a Authorization::AuthorizationError or return
+      # false if the access is to be denied.
+      # 
+      # Later calls to filter_access_to with overlapping actions overwrite
+      # previous ones for that action.
+      # 
+      # All options:
+      # [:+require+] 
+      #   Privilege required; defaults to action_name
+      # [:+context+] 
+      #   The privilege's context, defaults to controller_name, pluralized.
+      # [:+namespace+] 
+      #   Prefix the default controller context with.
+      #   * +true+: the model namespace(s) separated with underscores,
+      #   * +Symbol+ or +String+: the given symbol or string
+      #   * else: no prefix
+      #   Example:
+      #     filter_access_to :show, :namespace => true
+      #     filter_access_to :delete, :namespace => :foo
+      # [:+attribute_check+]
+      #   Enables the check of attributes defined in the authorization rules.
+      #   Defaults to false.  If enabled, filter_access_to will use a context
+      #   object from one of the following sources (in that order):
+      #   * the method from the :+load_method+ option,
+      #   * an instance variable named after the singular of the context
+      #     (by default from the controller name, e.g. @post for PostsController),
+      #   * a find on the context model, using +params+[:id] as id value.
+      #   Any of these methods will only be employed if :+attribute_check+
+      #   is enabled.
+      # [:+model+] 
+      #   The data model to load a context object from.  Defaults to the
+      #   context, singularized.
+      # [:+load_method+]
+      #   Specify a method by symbol or a Proc object which should be used 
+      #   to load the object.  Both should return the loaded object.
+      #   If a Proc object is given, e.g. by way of
+      #   +lambda+, it is called in the instance of the controller.  
+      #   Example demonstrating the default behaviour:
+      #     filter_access_to :show, :attribute_check => true,
+      #                      :load_method => lambda { User.find(params[:id]) }
+      # 
+      
+      def filter_access_to (*args, &filter_block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options = {
+          :require => nil,
+          :context => nil,
+          :namespace => nil,
+          :attribute_check => false,
+          :model => nil,
+          :load_method => nil
+        }.merge!(options)
+        privilege = options[:require]
+        context = options[:context]
+        actions = args.flatten
+
+        # collect permits in controller array for use in one before_filter
+        unless filter_chain.any? {|filter| filter.method == :filter_access_filter}
+          before_filter :filter_access_filter
+        end
+        
+        filter_access_permissions.each do |perm|
+          perm.remove_actions(actions)
+        end
+        filter_access_permissions << 
+          ControllerPermission.new(actions, privilege, context,
+                                   options[:namespace],
+                                   options[:attribute_check],
+                                   options[:model],
+                                   options[:load_method],
+                                   filter_block)
+      end
+      
+      # Collecting all the ControllerPermission objects from the controller
+      # hierarchy.  Permissions for actions are overwritten by calls to 
+      # filter_access_to in child controllers with the same action.
+      def all_filter_access_permissions # :nodoc:
+        ancestors.inject([]) do |perms, mod|
+          if mod.respond_to?(:filter_access_permissions)
+            perms + 
+              mod.filter_access_permissions.collect do |p1| 
+                p1.clone.remove_actions(perms.inject(Set.new) {|actions, p2| actions + p2.actions})
+              end
+          else
+            perms
+          end
+        end
+      end
+      
+      protected
+      def filter_access_permissions # :nodoc:
+        unless filter_access_permissions?
+          ancestors[1..-1].reverse.each do |mod|
+            mod.filter_access_permissions if mod.respond_to?(:filter_access_permissions)
+          end
+        end
+        class_variable_set(:@@declarative_authorization_permissions, {}) unless filter_access_permissions?
+        class_variable_get(:@@declarative_authorization_permissions)[self.name] ||= []
+      end
+      
+      def filter_access_permissions? # :nodoc:
+        class_variable_defined?(:@@declarative_authorization_permissions)
+      end
+    end
+  end
+  
+  class ControllerPermission # :nodoc:
+    attr_reader :actions, :privilege, :context, :namespace, :attribute_check
+    def initialize (actions, privilege, context, namespace, attribute_check = false, 
+                    load_object_model = nil, load_object_method = nil,
+                    filter_block = nil)
+      @actions = actions.to_set
+      @privilege = privilege
+      @context = context
+      @namespace = namespace
+      @load_object_model = load_object_model
+      @load_object_method = load_object_method
+      @filter_block = filter_block
+      @attribute_check = attribute_check
+    end
+    
+    def controller_context(contr)
+      case @namespace
+        when true
+          "#{contr.class.name.gsub(/::/, "_").gsub(/Controller$/, "").underscore}".to_sym
+        when String, Symbol
+          "#{@namespace.to_s}_#{contr.class.controller_name}".to_sym
+        else
+          contr.class.controller_name.to_sym
+      end
+    end
+    
+    def matches? (action_name)
+      @actions.include?(action_name.to_sym)
+    end
+    
+    def permit! (contr)
+      if @filter_block
+        return contr.instance_eval(&@filter_block)
+      end
+      context = @context || controller_context(contr)
+      object = @attribute_check ? load_object(contr, context) : nil
+      privilege = @privilege || :"#{contr.action_name}"
+      
+      #puts "Trying permit?(#{privilege.inspect}, "
+      #puts "               :user => #{contr.send(:current_user).inspect}, "
+      #puts "               :object => #{object.inspect}," 
+      #puts "               :skip_attribute_test => #{!@attribute_check}," 
+      #puts "               :context => #{contr.class.controller_name.pluralize.to_sym})"
+      res = contr.authorization_engine.permit!(privilege, 
+                                         :user => contr.send(:current_user),
+                                         :object => object,
+                                         :skip_attribute_test => !@attribute_check,
+                                         :context => context)
+      #puts "permit? result: #{res.inspect}"
+      res
+    end
+    
+    def remove_actions (actions)
+      @actions -= actions
+      self
+    end
+    
+    private
+    def load_object(contr, context)
+      if @load_object_method and @load_object_method.is_a?(Symbol)
+        contr.send(@load_object_method)
+      elsif @load_object_method and @load_object_method.is_a?(Proc)
+        contr.instance_eval(&@load_object_method)
+      else
+        load_object_model = @load_object_model || context.to_s.classify.constantize
+        instance_var = :"@#{load_object_model.name.underscore}"
+        object = contr.instance_variable_get(instance_var)
+        unless object
+          # catch ActiveRecord::RecordNotFound?
+          object = load_object_model.find(contr.params[:id])
+          contr.instance_variable_set(instance_var, object)
+        end
+        object
+      end
+    end
+  end
+end