Skip to content
This repository
tag: v3.0.7
Fetching contributors…

Cannot retrieve contributors at this time

file 160 lines (149 sloc) 5.458 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
require 'active_support/core_ext/class/attribute.rb'
require 'active_model/mass_assignment_security/permission_set'

module ActiveModel
  # = Active Model Mass-Assignment Security
  module MassAssignmentSecurity
    extend ActiveSupport::Concern

    included do
      class_attribute :_accessible_attributes
      class_attribute :_protected_attributes
      class_attribute :_active_authorizer
    end

    # Mass assignment security provides an interface for protecting attributes
    # from end-user assignment. For more complex permissions, mass assignment security
    # may be handled outside the model by extending a non-ActiveRecord class,
    # such as a controller, with this behavior.
    #
    # For example, a logged in user may need to assign additional attributes depending
    # on their role:
    #
    # class AccountsController < ApplicationController
    # include ActiveModel::MassAssignmentSecurity
    #
    # attr_accessible :first_name, :last_name
    #
    # def self.admin_accessible_attributes
    # accessible_attributes + [ :plan_id ]
    # end
    #
    # def update
    # ...
    # @account.update_attributes(account_params)
    # ...
    # end
    #
    # protected
    #
    # def account_params
    # sanitize_for_mass_assignment(params[:account])
    # end
    #
    # def mass_assignment_authorizer
    # admin ? admin_accessible_attributes : super
    # end
    #
    # end
    #
    module ClassMethods
      # Attributes named in this macro are protected from mass-assignment
      # whenever attributes are sanitized before assignment.
      #
      # Mass-assignment to these attributes will simply be ignored, to assign
      # to them you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms.
      #
      # == Example
      #
      # class Customer
      # include ActiveModel::MassAssignmentSecurity
      #
      # attr_accessor :name, :credit_rating
      # attr_protected :credit_rating
      #
      # def attributes=(values)
      # sanitize_for_mass_assignment(values).each do |k, v|
      # send("#{k}=", v)
      # end
      # end
      # end
      #
      # customer = Customer.new
      # customer.attributes = { "name" => "David", "credit_rating" => "Excellent" }
      # customer.name # => "David"
      # customer.credit_rating # => nil
      #
      # customer.credit_rating = "Average"
      # customer.credit_rating # => "Average"
      #
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
      #
      # Note that using <tt>Hash#except</tt> or <tt>Hash#slice</tt> in place of +attr_protected+
      # to sanitize attributes won't provide sufficient protection.
      def attr_protected(*names)
        self._protected_attributes = self.protected_attributes + names
        self._active_authorizer = self._protected_attributes
      end

      # Specifies a white list of model attributes that can be set via
      # mass-assignment.
      #
      # This is the opposite of the +attr_protected+ macro: Mass-assignment
      # will only set attributes in this list, to assign to the rest of
      # attributes you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms. If you'd rather start from an all-open
      # default and restrict attributes as needed, have a look at
      # +attr_protected+.
      #
      # class Customer
      # include ActiveModel::MassAssignmentSecurity
      #
      # attr_accessor :name, :credit_rating
      # attr_accessible :name
      #
      # def attributes=(values)
      # sanitize_for_mass_assignment(values).each do |k, v|
      # send("#{k}=", v)
      # end
      # end
      # end
      #
      # customer = Customer.new
      # customer.attributes = { :name => "David", :credit_rating => "Excellent" }
      # customer.name # => "David"
      # customer.credit_rating # => nil
      #
      # customer.credit_rating = "Average"
      # customer.credit_rating # => "Average"
      #
      # Note that using <tt>Hash#except</tt> or <tt>Hash#slice</tt> in place of +attr_accessible+
      # to sanitize attributes won't provide sufficient protection.
      def attr_accessible(*names)
        self._accessible_attributes = self.accessible_attributes + names
        self._active_authorizer = self._accessible_attributes
      end

      def protected_attributes
        self._protected_attributes ||= BlackList.new(attributes_protected_by_default).tap do |w|
          w.logger = self.logger if self.respond_to?(:logger)
        end
      end

      def accessible_attributes
        self._accessible_attributes ||= WhiteList.new.tap { |w| w.logger = self.logger if self.respond_to?(:logger) }
      end

      def active_authorizer
        self._active_authorizer ||= protected_attributes
      end

      def attributes_protected_by_default
        []
      end
    end

  protected

    def sanitize_for_mass_assignment(attributes)
      mass_assignment_authorizer.sanitize(attributes)
    end

    def mass_assignment_authorizer
      self.class.active_authorizer
    end
  end
end
Something went wrong with that request. Please try again.