hone-lockdown 1.2.1

data/lib/lockdown/permission.rb

@@ -0,0 +1,240 @@
+module Lockdown
+  class InvalidRuleContext < StandardError; end
+  class PermissionScopeCollision < StandardError; end
+
+  class Controller
+    attr_accessor :name, :access_methods, :only_methods, :except_methods
+
+    def initialize(name)
+      @name = name
+      @except_methods = []
+    end
+
+    def set_access_methods
+      if @only_methods
+        @access_methods = paths_for(@name, *@only_methods)
+      else
+        @access_methods = paths_for(@name)
+      end
+
+      apply_exceptions if @except_methods.length > 0
+    end
+
+    private
+
+    def apply_exceptions
+      exceptions = paths_for(@name, *@except_methods)
+      @access_methods = @access_methods - exceptions
+    end
+
+    def paths_for(str_sym, *methods)
+      Lockdown::System.paths_for(str_sym, *methods)
+    end
+  end
+
+  class Model
+    attr_accessor :name, :controller_method, :model_method, :association, :param, :proc_object
+
+    def initialize(name, param = :id)
+      @name = name
+      @param = param
+    end
+
+    def class_name
+      self.name.to_s.camelize
+    end
+ 
+  end
+  
+  class Permission
+    attr_reader :name, :controllers, :models
+
+    # A Permission is a set of rules that are, through UserGroups, assigned
+    # to users to allow access to system resources.
+    #
+    # ==== Summary of controller oriented methods:
+    #
+    #   # defines which controller we're talking about
+    #   .with_controller(:controller_name)  #all_methods is the default
+    #
+    #   # only these methods on the controller
+    #   .only_methods(:meth1, :meth2)       
+    #
+    #   # all controller methods except these
+    #   .except_methods(:meth1, :meth2)
+    #
+    # ==== Summary of model oriented methods:
+    #
+    #   # defines which model we're talking about
+    #   .to_model(:model)         
+    #
+    #   # model_method is simply a public method on :model
+    #   .where(:model_method)           
+    #
+    #   # controller_method must equal model_method
+    #   .equals(:controller_method)         
+    #
+    #   # controller_method.include?(model_method)
+    #   .is_in(:controller_method)         
+    #   
+    #
+    # ==== Example:
+    #
+    #   # Define a permission called 'Manage Users' that allows users access
+    #   # all methods on the users_controller
+    #
+    #   set_permission(:manage_users).
+    #     with_controller(:users)
+    #
+    #   # Define a permission called "My Account" that only allows a user access
+    #   # to methods show and update and the current_user_id must match the id 
+    #   # of the user being modified
+    #
+    #   set_permission(:my_account).
+    #     with_controller(:users).
+    #     only_methods(:show, :update).
+    #     to_model(:user).
+    #       where(:current_user_id).
+    #       equals(:id)
+    #
+    def initialize(name_symbol)
+      @name         = name_symbol
+      @controllers  = {}
+      @models       = {}
+      @current_context = Lockdown::RootContext.new(name_symbol)
+    end
+
+    def with_controller(name_symbol)
+      validate_context
+
+      controller = Controller.new(name_symbol)
+      @controllers[name_symbol] = controller
+      @current_context = Lockdown::ControllerContext.new(name_symbol)
+      self
+    end
+
+    alias_method :and_controller, :with_controller
+
+    def only_methods(*methods)
+      validate_context
+
+      current_controller.only_methods = methods
+      @current_context = Lockdown::RootContext.new(@name)
+      self
+    end
+
+    def except_methods(*methods)
+      validate_context
+
+      current_controller.except_methods = methods
+
+      @current_context = Lockdown::RootContext.new(@name)
+      self
+    end
+
+    def to_model(name_symbol, param = :id)
+      validate_context
+
+      @models[name_symbol] = Model.new(name_symbol, param)
+      @current_context = Lockdown::ModelContext.new(name_symbol)
+      self
+    end
+
+    def where(model_method)
+      validate_context
+
+      current_model.model_method = model_method
+      @current_context = Lockdown::ModelWhereContext.new(current_context.name)
+      self
+    end
+
+    def equals(controller_method)
+      validate_context
+
+      associate_controller_method(controller_method, :==)
+      @current_context = Lockdown::RootContext.new(@name)
+      self
+    end
+
+    def is_in(controller_method)
+      validate_context
+
+      associate_controller_method(controller_method, :include?)
+      @current_context = Lockdown::RootContext.new(@name)
+      self
+    end
+
+    # allows you to pass in a proc object to do complex authorization control
+    # it is called from a +to_model+ method.  the +to_model+'s model 
+    # and the +with_controller+'s controller
+    # i.e. set_permission(:permission).
+    #        with_controller(:controller).
+    #        to_model(:model).
+    #          with_proc do |model, controller|
+    #            ...do stuff here
+    #          end
+    def with_proc(&block)
+      validate_context
+
+      current_model.proc_object = Proc.new(&block)
+      @current_context = Lockdown::ModelWithProcContext.new(current_context.name)
+      self
+    end
+
+    alias_method :includes, :is_in
+
+    def public_access?
+      @public_access
+    end
+
+    def protected_access?
+      @protected_access
+    end
+
+    def set_as_public_access
+      if protected_access?
+        raise PermissionScopeCollision, "Permission: #{name} already marked as protected and trying to set as public."
+      end
+      @public_access = true
+    end
+
+    def set_as_protected_access
+      if public_access?
+        raise PermissionScopeCollision, "Permission: #{name} already marked as public and trying to set as protected."
+      end
+      @protected_access = true
+    end
+
+    def current_context
+      @current_context
+    end
+
+    def current_controller
+      @controllers[current_context.name]
+    end
+
+    def current_model
+      @models[current_context.name]
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    private
+
+    def associate_controller_method(controller_method, association)
+      current_model.controller_method = controller_method
+      current_model.association = association
+      @current_context = Lockdown::RootContext.new(@name)
+    end
+
+    def validate_context
+      method_trace = caller.first;  
+      calling_method = caller.first[/#{__FILE__}:(\d+):in `(.*)'/,2]
+      unless current_context.allows?(calling_method)
+        raise InvalidRuleContext, "Method: #{calling_method} was called on wrong context #{current_context}. Allowed methods are: #{current_context.allowed_methods.join(',')}."
+      end
+    end
+  end
+end

data/lib/lockdown/rules.rb

@@ -0,0 +1,378 @@
+module Lockdown
+  class InvalidRuleAssignment < StandardError; end
+
+  module Rules
+    attr_accessor :options
+    attr_accessor :permissions
+    attr_accessor :user_groups
+
+    attr_reader :protected_access 
+    attr_reader :public_access
+
+    attr_reader :permission_objects
+ 
+    def set_defaults
+      @permissions  = {}
+      @user_groups  = {}
+      @options      = {}
+
+      @permission_objects = {}
+
+      @controller_classes = []
+      @public_access      = []
+      @protected_access   = []
+
+      @options = {
+        :session_timeout => (60 * 60),
+        :who_did_it => :current_user_id,
+        :default_who_did_it => 1,
+        :logout_on_access_violation => false,
+        :access_denied_path => "/",
+        :successful_login_path => "/",
+        :subdirectory => nil,
+        :skip_db_sync_in => ["test"],
+        :link_separator => ' | '
+      }
+
+      begin
+        @options[:user_group_model] = "UserGroup"
+      rescue NameError 
+      end
+
+      begin
+        @options[:user_model] = "User" 
+      rescue NameError 
+      end
+      
+    end
+
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    # =Rule defining methods.  e.g. Methods used in lib/lockdown/init.rb
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    # Creates new permission object 
+    #   Refer to the Permission object for the full functionality
+    def set_permission(name)
+      @permission_objects[name] = Lockdown::Permission.new(name)
+    end
+
+    # Defines public access by the permission symbols
+    #
+    # ==== Example
+    #   set_public_access(:permission_one, :permission_two)
+    #
+    def set_public_access(*perms)
+      perms.each do |perm_symbol|
+        perm = permission_objects.find{|name, pobj| pobj.name == perm_symbol}
+        if perm
+          perm[1].set_as_public_access 
+        else
+          msg = "Permission not found: #{perm_symbol}"
+          raise InvalidRuleAssigment, msg
+        end
+      end
+    end
+
+    # Defines protected access by the permission symbols
+    #
+    # ==== Example
+    #   set_public_access(:permission_one, :permission_two)
+    #
+    def set_protected_access(*perms)
+      perms.each do |perm_symbol|
+        perm = permission_objects.find{|name, pobj| pobj.name == perm_symbol}
+        if perm
+          perm[1].set_as_protected_access 
+        else
+          msg = "Permission not found: #{perm_symbol}"
+          raise InvalidRuleAssigment, msg
+        end
+      end
+    end
+
+    # Define a user groups by name and permission symbol(s)
+    #
+    # ==== Example
+    #   set_user_group(:managment_group, :permission_one, :permission_two)
+    #
+    def set_user_group(name, *perms)
+      user_groups[name] ||= []
+      perms.each do |perm|
+        user_groups[name].push(perm)
+      end
+    end
+ 
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    # =Convenience methods for permissions and user groups
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    
+    # Returns array of permission names as symbols
+    def get_permissions
+      permissions.keys
+    end
+
+    # Is the permission defined?
+    def permission_exists?(permission_symbol)
+      get_permissions.include?(permission_symbol)
+    end
+
+    alias_method :has_permission?, :permission_exists?
+    
+    # returns true if the permission is public
+    def public_access?(permmision_symbol)
+      public_access.include?(permmision_symbol)
+    end
+
+    # returns true if the permission is public
+    def protected_access?(permmision_symbol)
+      protected_access.include?(permmision_symbol)
+    end
+
+    # These permissions are assigned by the system 
+    def permission_assigned_automatically?(permmision_symbol)
+      public_access?(permmision_symbol) || protected_access?(permmision_symbol)
+    end
+
+    # Returns array of user group names as symbols
+    def get_user_groups
+      user_groups.keys
+    end
+
+    # Is the user group defined?
+    #   The :administrators user group always exists
+    def user_group_exists?(user_group_symbol)
+      return true if user_group_symbol == Lockdown.administrator_group_symbol
+      get_user_groups.include?(user_group_symbol)
+    end
+
+    alias_method :has_user_group?, :user_group_exists?
+
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    # =Convenience methods for permissions and user groups
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    # Pass in a user object to be associated to the administrator user group 
+    # The group will be created if it doesn't exist
+    def make_user_administrator(usr)
+      user_groups = usr.send(Lockdown.user_groups_hbtm_reference)
+      user_groups << Lockdown.user_group_class.
+        find_or_create_by_name(Lockdown.administrator_group_string)
+    end
+
+
+    # Returns array of controller/action values all logged in users can access.
+    def standard_authorized_user_rights
+      public_access + protected_access 
+    end
+
+    # Return array of controller/action values user can access.
+    def access_rights_for_user(usr)
+      return unless usr
+      return :all if administrator?(usr)
+
+      rights = standard_authorized_user_rights
+        
+      user_groups = usr.send(Lockdown.user_groups_hbtm_reference)
+      user_groups.each do |grp|
+        permissions_for_user_group(grp).each do |perm|
+          rights += access_rights_for_permission(perm) 
+        end
+      end
+      rights
+    end
+
+    # Return array of controller/action for a permission
+    def access_rights_for_permission(perm)
+      sym = Lockdown.get_symbol(perm)
+
+      permissions[sym]
+    rescue 
+      raise SecurityError, "Permission requested is not defined: #{sym}"
+    end
+
+
+    # Test user for administrator rights
+    def administrator?(usr)
+      user_has_user_group?(usr, Lockdown.administrator_group_symbol)
+    end
+
+    # Pass in user object and symbol for name of user group
+    def user_has_user_group?(usr, sym)
+      user_groups = usr.send(Lockdown.user_groups_hbtm_reference)
+      user_groups.any? do |ug|
+        Lockdown.convert_reference_name(ug.name) == sym
+      end
+    end
+
+    # Use this for the management screen to restrict user group list to the
+    # user.  This will prevent a user from creating a user with more power than
+    # him/her self.
+    def user_groups_assignable_for_user(usr)
+      return [] if usr.nil?
+      ug_table = Lockdown.user_groups_hbtm_reference.to_s
+      if administrator?(usr)
+        Lockdown.user_group_class.find_by_sql <<-SQL
+          select #{ug_table}.* from #{ug_table} order by #{ug_table}.name
+        SQL
+      else
+        usr_table = Lockdown.users_hbtm_reference.to_s
+        if usr_table < ug_table
+          join_table = "#{usr_table}_#{ug_table}"
+        else
+          join_table = "#{ug_table}_#{usr_table}"
+        end
+        Lockdown.user_group_class.find_by_sql <<-SQL
+            select #{ug_table}.* from #{ug_table}, #{join_table}
+             where #{ug_table}.id = #{join_table}.#{Lockdown.user_group_id_reference}
+             and #{join_table}.#{Lockdown.user_id_reference} = #{usr.id}	 
+             order by #{ug_table}.name
+        SQL
+      end
+    end
+
+    # Similar to user_groups_assignable_for_user, this method should be
+    # used to restrict users from creating a user group with more power than
+    # they have been allowed.
+    def permissions_assignable_for_user(usr)
+      return [] if usr.nil?
+      if administrator?(usr)
+        get_permissions.collect do |k| 
+          ::Permission.find_by_name(Lockdown.get_string(k))
+        end.compact
+      else
+        user_groups_assignable_for_user(usr).collect do |g| 
+          g.permissions
+        end.flatten.compact
+      end
+    end
+
+    # Returns and array of permission symbols for the user group
+    def permissions_for_user_group(ug)
+      sym = Lockdown.get_symbol(ug)
+      perm_array = []  
+
+      if has_user_group?(sym)
+        permissions = user_groups[sym] || []
+      else
+        permissions = ug.permissions
+      end
+
+
+      permissions.each do |perm|
+        perm_sym = Lockdown.get_symbol(perm)
+
+        unless permission_exists?(perm_sym)
+          msg = "Permission associated to User Group is invalid: #{perm}"
+          raise SecurityError, msg
+        end
+
+        perm_array << perm_sym
+      end
+
+      perm_array 
+    end
+
+    def process_rules
+      parse_permissions
+      validate_user_groups
+    end
+
+    private
+
+    def validate_user_groups
+      user_groups.each do |user_group, perms|
+        perms.each do |perm|
+          unless permission_exists?(perm)
+            msg ="User Group: #{user_group}, permission not found: #{perm}"
+            raise InvalidRuleAssignment, msg
+          end
+        end
+      end
+    end
+
+    def parse_permissions
+      permission_objects.each do |name, perm|
+        @permissions[perm.name] ||= []
+        set_controller_access(perm)
+      end
+
+      set_model_access
+    end
+
+    def set_controller_access(perm)
+      perm.controllers.each do |name, controller|
+        controller.set_access_methods
+
+        @permissions[perm.name] |= controller.access_methods
+
+        if perm.public_access?
+          @public_access |= controller.access_methods
+        elsif perm.protected_access?
+          @protected_access |= controller.access_methods
+        end
+      end
+    end
+
+    def set_model_access
+      method_definition =  "\tdef check_model_authorization\n\t#This method will check for access to model resources\n"
+
+      permission_objects.each do |name, perm|
+        next if perm.models.empty?
+
+        #Set filter for each controller
+        perm.controllers.each do |controller_name, controller|
+          #Set filter for each model on controller
+          perm.models.each do |model_name, model|
+            method_definition << define_restrict_model_access(controller, model)
+          end
+        end
+      end
+
+      method_definition << "\n\tend"
+
+      #puts "method_definition:\n #{method_definition}"
+
+      Lockdown.add_controller_method method_definition
+    end
+
+    def define_restrict_model_access(controller, model)
+      controller_class = Lockdown.fetch_controller_class(controller.name)
+
+      methods = controller.
+                  access_methods.
+                    collect do |am| 
+                      am[am.index('/') + 1..-1].to_sym if am.index('/')
+                    end.compact.inspect
+
+      return <<-RUBY
+        if controller_name == "#{controller.name}" 
+          if #{methods}.include?(action_name.to_sym)
+            unless instance_variable_defined?(:@#{model.name})
+              @#{model.name} = #{model.class_name}.find(params[#{model.param.inspect}])
+            end
+#{generate_proc_string(model)}
+            # Need to make sure we find the model first before checking admin status. 
+            return true if current_user_is_admin? 
+            unless @#{model.name}.#{model.model_method}.#{model.association}(#{model.controller_method})
+              raise SecurityError, "Access to #\{action_name\} denied to #{model.name}.id #\{@#{model.name}.id\}"
+            end
+          end
+        end
+      RUBY
+    end
+
+    # generates the metaprogram string for allowing +with_proc+ in the lib/lockdown/init.rb
+    def generate_proc_string(model)
+      # spaces need to properly format the code
+      spaces = (1..12).to_a.collect { " " }.join
+
+      if model.proc_object
+        <<PROC_STRING
+            unless #{model.proc_object.to_ruby.gsub("\n", "\n#{spaces}")}.call(@#{model.name}, self)
+              raise SecurityError, "Access to #\{action_name\} denied to #{model.name}.id #\{@#{model.name}.id\}"
+            end
+PROC_STRING
+      end
+    end
+  end
+end