stffn-declarative_authorization 0.2.1 → 0.2.3

data/lib/helper.rb

@@ -0,0 +1,51 @@
+# 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 %>
+    # 
+    def permitted_to? (privilege, object_or_sym = nil, &block)
+      controller.permitted_to?(privilege, object_or_sym, &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
+  end
+end

data/lib/in_controller.rb

@@ -0,0 +1,311 @@
+# 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?
+    #
+    def permitted_to? (privilege, object_or_sym = nil, &block)
+      context = object = nil
+      if object_or_sym.is_a?(Symbol)
+        context = object_or_sym
+      else
+        object = object_or_sym
+      end
+      # TODO infer context also from self.class.name
+      authorization_engine.permit?(privilege, 
+          {:user => current_user, 
+           :object => object,
+           :context => context,
+           :skip_attribute_test => object.nil?}, 
+          &block)
+    end
+    
+    # Works similar to the permitted_to? method, but doesn't accept a block
+    # and throws the authorization exceptions, just like Engine#permit!
+    def permitted_to! (privilege, object_or_sym = nil)
+      context = object = nil
+      if object_or_sym.is_a?(Symbol)
+        context = object_or_sym
+      else
+        object = object_or_sym
+      end
+      authorization_engine.permit!(privilege, 
+          {:user => current_user, 
+           :object => object,
+           :context => context,
+           :skip_attribute_test => object.nil?})
+    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
+    
+    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 < ActionController
+      #     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
+      #   
+      # 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.
+      # [:+attribute_check+]
+      #   Enables the check of attributes defined in the authorization rules.
+      #   Defaults to false.  If enabled, filter_access_to will try to load
+      #   a context object employing either 
+      #   * the method from the :+load_method+ option or 
+      #   * a find on the context model, using +params+[:id] as id value.
+      #   Any of these loading 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,
+          :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[: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, :attribute_check
+    def initialize (actions, privilege, context, attribute_check = false, 
+                    load_object_model = nil, load_object_method = nil,
+                    filter_block = nil)
+      @actions = actions.to_set
+      @privilege = privilege
+      @context = context
+      @load_object_model = load_object_model
+      @load_object_method = load_object_method
+      @filter_block = filter_block
+      @attribute_check = attribute_check
+    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 || contr.class.controller_name.to_sym
+      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

data/lib/in_model.rb

@@ -0,0 +1,130 @@
+# Authorization::AuthorizationInModel
+require File.dirname(__FILE__) + '/authorization.rb'
+require File.dirname(__FILE__) + '/obligation_scope.rb'
+
+module Authorization
+  
+  module AuthorizationInModel
+    
+    def self.included(base) # :nodoc:
+      #base.extend(ClassMethods)
+      base.module_eval do
+        scopes[:with_permissions_to] = lambda do |parent_scope, *args|
+          options = args.last.is_a?(Hash) ? args.pop : {}
+          privilege = (args[0] || :read).to_sym
+          privileges = [privilege]
+          context = options[:context] || :"#{parent_scope.table_name}"
+          
+          user = options[:user] || Authorization.current_user
+
+          engine = Authorization::Engine.instance
+          engine.permit!(privileges, :user => user, :skip_attribute_test => true,
+                         :context => context)
+
+          obligation_scope_for( privileges, :user => user,
+              :context => context, :engine => engine, :model => parent_scope)
+        end
+        
+        # Builds and returns a scope with joins and conditions satisfying all obligations.
+        def self.obligation_scope_for( privileges, options = {} )
+          options = {
+            :user => Authorization.current_user,
+            :context => nil,
+            :model => self,
+            :engine => nil,
+          }.merge(options)
+          engine ||= Authorization::Engine.instance
+
+          scope = ObligationScope.new( options[:model], {} )
+          engine.obligations( privileges, :user => options[:user], :context => options[:context] ).each do |obligation|
+            scope.parse!( obligation )
+          end
+          scope
+        end
+
+        # Named scope for limiting query results according to the authorization
+        # of the current user.  If no privilege is given, :+read+ is assumed.
+        # 
+        #   User.with_permissions_to
+        #   User.with_permissions_to(:update)
+        #   User.with_permissions_to(:update, :context => :users)
+        #   
+        # As in the case of other named scopes, this one may be chained:
+        #   User.with_permission_to.find(:all, :conditions...)
+        # 
+        # Options
+        # [:+context+]
+        #   Context for the privilege to be evaluated in; defaults to the
+        #   model's table name.
+        # [:+user+]
+        #   User to be used for gathering obligations; defaults to the
+        #   current user.
+        #
+        def self.with_permissions_to (*args)
+          scopes[:with_permissions_to].call(self, *args)
+        end
+        
+        # Activates model security for the current model.  Then, CRUD operations
+        # are checked against the authorization of the current user.  The
+        # privileges are :+create+, :+read+, :+update+ and :+delete+ in the
+        # context of the model.  By default, :+read+ is not checked because of
+        # performance impacts, especially with large result sets.
+        # 
+        #   class User < ActiveRecord::Base
+        #     using_access_control
+        #   end
+        #   
+        # If an operation is not permitted, a Authorization::AuthorizationError
+        # is raised.
+        # 
+        # Available options
+        # [:+context+] Specify context different from the models table name.
+        # [:+include_read+] Also check for :+read+ privilege after find.
+        #
+        def self.using_access_control (options = {})
+          options = {
+            :context => nil,
+            :include_read => false
+          }.merge(options)
+          context = (options[:context] || self.table_name).to_sym
+
+          class_eval do
+            before_create do |object|
+              Authorization::Engine.instance.permit!(:create, :object => object,
+                :context => context)
+            end
+            
+            before_update do |object|
+              Authorization::Engine.instance.permit!(:update, :object => object,
+                :context => context)
+            end
+            
+            before_destroy do |object|
+              Authorization::Engine.instance.permit!(:delete, :object => object,
+                :context => context)
+            end
+            
+            # only called if after_find is implemented
+            after_find do |object|
+              Authorization::Engine.instance.permit!(:read, :object => object,
+                :context => context)
+            end
+            
+            if options[:include_read]
+              def after_find; end
+            end
+
+            def self.using_access_control?
+              true
+            end
+          end
+        end
+
+        # Returns true if the model is using model security.
+        def self.using_access_control?
+          false
+        end
+      end
+    end
+  end
+end