X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c9a361f7fd3b1cf7f4959e9b0292d0f495d82771..267c1a22e4b9e04ed29d1360f4e7ea6519845d12:/services/api/app/models/arvados_model.rb diff --git a/services/api/app/models/arvados_model.rb b/services/api/app/models/arvados_model.rb index b77ba1cdf8..08d7e9345d 100644 --- a/services/api/app/models/arvados_model.rb +++ b/services/api/app/models/arvados_model.rb @@ -1,3 +1,7 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + require 'has_uuid' require 'record_filters' require 'serializers' @@ -9,10 +13,6 @@ class ArvadosModel < ActiveRecord::Base include DbCurrentTime extend RecordFilters - attr_protected :created_at - attr_protected :modified_by_user_uuid - attr_protected :modified_by_client_uuid - attr_protected :modified_at after_initialize :log_start_state before_save :ensure_permission_to_save before_save :ensure_owner_uuid_is_permitted @@ -27,17 +27,16 @@ class ArvadosModel < ActiveRecord::Base after_find :convert_serialized_symbols_to_strings before_validation :normalize_collection_uuids before_validation :set_default_owner - validate :ensure_serialized_attribute_type validate :ensure_valid_uuids # Note: This only returns permission links. It does not account for # permissions obtained via user.is_admin or # user.uuid==object.owner_uuid. has_many(:permissions, + ->{where(link_class: 'permission')}, foreign_key: :head_uuid, class_name: 'Link', - primary_key: :uuid, - conditions: "link_class = 'permission'") + primary_key: :uuid) class PermissionDeniedError < StandardError def http_status @@ -51,6 +50,12 @@ class ArvadosModel < ActiveRecord::Base end end + class LockFailedError < StandardError + def http_status + 422 + end + end + class InvalidStateTransitionError < StandardError def http_status 422 @@ -77,6 +82,46 @@ class ArvadosModel < ActiveRecord::Base "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}" end + def self.permit_attribute_params raw_params + # strong_parameters does not provide security: permissions are + # implemented with before_save hooks. + # + # The following permit! is necessary even with + # "ActionController::Parameters.permit_all_parameters = true", + # because permit_all does not permit nested attributes. + if raw_params + serialized_attributes.each do |colname, coder| + param = raw_params[colname.to_sym] + if param.nil? + # ok + elsif !param.is_a?(coder.object_class) + raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}") + elsif has_nonstring_keys?(param) + raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys") + end + end + end + ActionController::Parameters.new(raw_params).permit! + end + + def initialize raw_params={}, *args + super(self.class.permit_attribute_params(raw_params), *args) + end + + # Reload "old attributes" for logging, too. + def reload(*args) + super + log_start_state + end + + def self.create raw_params={}, *args + super(permit_attribute_params(raw_params), *args) + end + + def update_attributes raw_params={}, *args + super(self.class.permit_attribute_params(raw_params), *args) + end + def self.selectable_attributes(template=:user) # Return an array of attribute name strings that can be selected # in the given template. @@ -155,6 +200,14 @@ class ArvadosModel < ActiveRecord::Base ["id", "uuid"] end + def self.limit_index_columns_read + # This method returns a list of column names. + # If an index request reads that column from the database, + # APIs that return lists will only fetch objects until reaching + # max_index_database_read bytes of data from those columns. + [] + end + # If current user can manage the object, return an array of uuids of # users and groups that have permission to write the object. The # first two elements are always [self.owner_uuid, current user's @@ -199,48 +252,52 @@ class ArvadosModel < ActiveRecord::Base kwargs = {} end - # Check if any of the users are admin. If so, we're done. - if users_list.select { |u| u.is_admin }.any? - return self - end - # Collect the UUIDs of the authorized users. - user_uuids = users_list.map { |u| u.uuid } - - # Collect the UUIDs of all groups readable by any of the - # authorized users. If one of these (or the UUID of one of the - # authorized users themselves) is an object's owner_uuid, that - # object is readable. - owner_uuids = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) } - owner_uuids.uniq! + sql_table = kwargs.fetch(:table_name, table_name) + include_trash = kwargs.fetch(:include_trash, false) + query_on = kwargs.fetch(:query_on, self) sql_conds = [] - sql_table = kwargs.fetch(:table_name, table_name) + user_uuids = users_list.map { |u| u.uuid } - # Match any object (evidently a group or user) whose UUID is - # listed explicitly in owner_uuids. - sql_conds += ["#{sql_table}.uuid in (:owner_uuids)"] + if users_list.select { |u| u.is_admin }.any? + if !include_trash + # exclude rows that are explicitly trashed. + if sql_table != "api_client_authorizations" + sql_conds.push "NOT EXISTS(SELECT 1 + FROM #{PERMISSION_VIEW} + WHERE trashed = 1 AND + (#{sql_table}.uuid = target_uuid OR #{sql_table}.owner_uuid = target_uuid))" + end + end + else + if include_trash + trashed_check = "" + else + trashed_check = "AND trashed = 0" + end - # Match any object whose owner is listed explicitly in - # owner_uuids. - sql_conds += ["#{sql_table}.owner_uuid IN (:owner_uuids)"] + if sql_table != "api_client_authorizations" and sql_table != "groups" + owner_check = "OR (target_uuid = #{sql_table}.owner_uuid AND target_owner_uuid IS NOT NULL)" + else + owner_check = "" + end - # Match the head of any permission link whose tail is listed - # explicitly in owner_uuids. - sql_conds += ["#{sql_table}.uuid IN (SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (:owner_uuids))"] + sql_conds.push "EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} "+ + "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check} AND (target_uuid = #{sql_table}.uuid #{owner_check}))" - if sql_table == "links" - # Match any permission link that gives one of the authorized - # users some permission _or_ gives anyone else permission to - # view one of the authorized users. - sql_conds += ["(#{sql_table}.link_class in (:permission_link_classes) AND "+ - "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))"] + if sql_table == "links" + # Match any permission link that gives one of the authorized + # users some permission _or_ gives anyone else permission to + # view one of the authorized users. + sql_conds.push "(#{sql_table}.link_class IN (:permission_link_classes) AND "+ + "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))" + end end - where(sql_conds.join(' OR '), - owner_uuids: owner_uuids, - user_uuids: user_uuids, - permission_link_classes: ['permission', 'resources']) + query_on.where(sql_conds.join(' OR '), + user_uuids: user_uuids, + permission_link_classes: ['permission', 'resources']) end def save_with_unique_name! @@ -300,13 +357,14 @@ class ArvadosModel < ActiveRecord::Base def self.full_text_searchable_columns self.columns.select do |col| - col.type == :string or col.type == :text + [:string, :text, :jsonb].include?(col.type) end.map(&:name) end def self.full_text_tsvector parts = full_text_searchable_columns.collect do |column| - "coalesce(#{column},'')" + cast = serialized_attributes[column] ? '::text' : '' + "coalesce(#{column}#{cast},'')" end "to_tsvector('english', #{parts.join(" || ' ' || ")})" end @@ -386,36 +444,31 @@ class ArvadosModel < ActiveRecord::Base raise PermissionDeniedError end - # Verify "write" permission on old owner - # default fail unless one of: - # owner_uuid did not change - # previous owner_uuid is nil - # current user is the old owner - # current user is this object - # current user can_write old owner - unless !owner_uuid_changed? or - owner_uuid_was.nil? or - current_user.uuid == self.owner_uuid_was or - current_user.uuid == self.uuid or - current_user.can? write: self.owner_uuid_was - logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write old owner_uuid #{owner_uuid_was}" - errors.add :owner_uuid, "cannot be changed without write permission on old owner" - raise PermissionDeniedError - end - - # Verify "write" permission on new owner - # default fail unless one of: - # current_user is this object - # current user can_write new owner, or this object if owner unchanged - if new_record? or owner_uuid_changed? or is_a?(ApiClientAuthorization) - write_target = owner_uuid + if new_record? || owner_uuid_changed? + # Permission on owner_uuid_was is needed to move an existing + # object away from its previous owner (which implies permission + # to modify this object itself, so we don't need to check that + # separately). Permission on the new owner_uuid is also needed. + [['old', owner_uuid_was], + ['new', owner_uuid] + ].each do |which, check_uuid| + if check_uuid.nil? + # old_owner_uuid is nil? New record, no need to check. + elsif !current_user.can?(write: check_uuid) + logger.warn "User #{current_user.uuid} tried to set ownership of #{self.class.to_s} #{self.uuid} but does not have permission to write #{which} owner_uuid #{check_uuid}" + errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner" + raise PermissionDeniedError + end + end else - write_target = uuid - end - unless current_user == self or current_user.can? write: write_target - logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write new owner_uuid #{owner_uuid}" - errors.add :owner_uuid, "cannot be changed without write permission on new owner" - raise PermissionDeniedError + # If the object already existed and we're not changing + # owner_uuid, we only need write permission on the object + # itself. + if !current_user.can?(write: self.uuid) + logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission" + errors.add :uuid, "is not writable" + raise PermissionDeniedError + end end true @@ -463,6 +516,7 @@ class ArvadosModel < ActiveRecord::Base def update_modified_by_fields current_time = db_current_time + self.created_at = created_at_was || current_time self.updated_at = current_time self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid= self.modified_at = current_time @@ -471,6 +525,19 @@ class ArvadosModel < ActiveRecord::Base true end + def self.has_nonstring_keys? x + if x.is_a? Hash + x.each do |k,v| + return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v) + end + elsif x.is_a? Array + x.each do |v| + return true if has_nonstring_keys?(v) + end + end + false + end + def self.has_symbols? x if x.is_a? Hash x.each do |k,v| @@ -507,8 +574,15 @@ class ArvadosModel < ActiveRecord::Base end def self.where_serialized(colname, value) - sorted = deep_sort_hash(value) - where("#{colname.to_s} IN (?)", [sorted.to_yaml, SafeJSON.dump(sorted)]) + if value.empty? + # rails4 stores as null, rails3 stored as serialized [] or {} + sql = "#{colname.to_s} is null or #{colname.to_s} IN (?)" + sorted = value + else + sql = "#{colname.to_s} IN (?)" + sorted = deep_sort_hash(value) + end + where(sql, [sorted.to_yaml, SafeJSON.dump(sorted)]) end Serializer = { @@ -517,25 +591,18 @@ class ArvadosModel < ActiveRecord::Base } def self.serialize(colname, type) - super(colname, Serializer[type]) + coder = Serializer[type] + @serialized_attributes ||= {} + @serialized_attributes[colname.to_s] = coder + super(colname, coder) end - def ensure_serialized_attribute_type - # Specifying a type in the "serialize" declaration causes rails to - # raise an exception if a different data type is retrieved from - # the database during load(). The validation preventing such - # crash-inducing records from being inserted in the database in - # the first place seems to have been left as an exercise to the - # developer. - self.class.serialized_attributes.each do |colname, attr| - if attr.object_class - if self.attributes[colname].class != attr.object_class - self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}" - elsif self.class.has_symbols? attributes[colname] - self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}" - end - end - end + def self.serialized_attributes + @serialized_attributes ||= {} + end + + def serialized_attributes + self.class.serialized_attributes end def convert_serialized_symbols_to_strings @@ -548,8 +615,8 @@ class ArvadosModel < ActiveRecord::Base self.class.serialized_attributes.each do |colname, attr| if self.class.has_symbols? attributes[colname] attributes[colname] = self.class.recursive_stringify attributes[colname] - self.send(colname + '=', - self.class.recursive_stringify(attributes[colname])) + send(colname + '=', + self.class.recursive_stringify(attributes[colname])) end end end