X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/bc59a822ddb8e55739fdbdb04e6fbd78d5116450..fefce5e8e133a8fa064bbcdf31d85d41dc4a6729:/services/api/app/models/collection.rb diff --git a/services/api/app/models/collection.rb b/services/api/app/models/collection.rb index 84101ffdd4..334f3c699b 100644 --- a/services/api/app/models/collection.rb +++ b/services/api/app/models/collection.rb @@ -5,17 +5,38 @@ class Collection < ArvadosModel include KindAndEtag include CommonApiTemplate + before_validation :check_encoding before_validation :check_signatures before_validation :strip_manifest_text before_validation :set_portable_data_hash validate :ensure_hash_matches_manifest_text + before_save :set_file_names + + # Query only undeleted collections by default. + default_scope where("expires_at IS NULL or expires_at > CURRENT_TIMESTAMP") api_accessible :user, extend: :common do |t| t.add :name t.add :description t.add :properties t.add :portable_data_hash - t.add :manifest_text + t.add :signed_manifest_text, as: :manifest_text + t.add :replication_desired + end + + def self.attributes_required_columns + super.merge( + # If we don't list manifest_text explicitly, the + # params[:select] code gets confused by the way we + # expose signed_manifest_text as manifest_text in the + # API response, and never let clients select the + # manifest_text column. + 'manifest_text' => ['manifest_text'], + + # This is a shim until the database column gets + # renamed to replication_desired in #3410. + 'replication_desired' => ['redundancy'], + ) end def check_signatures @@ -23,6 +44,13 @@ class Collection < ArvadosModel return true if current_user.andand.is_admin + # Provided the manifest_text hasn't changed materially since an + # earlier validation, it's safe to pass this validation on + # subsequent passes without checking any signatures. This is + # important because the signatures have probably been stripped off + # by the time we get to a second validation pass! + return true if @signatures_checked and @signatures_checked == compute_pdh + if self.manifest_text_changed? # Check permissions on the collection manifest. # If any signature cannot be verified, raise PermissionDeniedError @@ -58,13 +86,13 @@ class Collection < ArvadosModel end end end - true + @signatures_checked = compute_pdh end def strip_manifest_text if self.manifest_text_changed? # Remove any permission signatures from the manifest. - Collection.munge_manifest_locators(self[:manifest_text]) do |loc| + self.class.munge_manifest_locators!(self[:manifest_text]) do |loc| loc.without_signature.to_s end end @@ -72,16 +100,20 @@ class Collection < ArvadosModel end def set_portable_data_hash - if (self.portable_data_hash.nil? or (self.portable_data_hash == "") or (manifest_text_changed? and !portable_data_hash_changed?)) - self.portable_data_hash = "#{Digest::MD5.hexdigest(manifest_text)}+#{manifest_text.length}" + if (portable_data_hash.nil? or + portable_data_hash == "" or + (manifest_text_changed? and !portable_data_hash_changed?)) + @need_pdh_validation = false + self.portable_data_hash = compute_pdh elsif portable_data_hash_changed? + @need_pdh_validation = true begin loc = Keep::Locator.parse!(self.portable_data_hash) loc.strip_hints! if loc.size self.portable_data_hash = loc.to_s else - self.portable_data_hash = "#{loc.hash}+#{self.manifest_text.length}" + self.portable_data_hash = "#{loc.hash}+#{portable_manifest_text.bytesize}" end rescue ArgumentError => e errors.add(:portable_data_hash, "#{e}") @@ -92,17 +124,70 @@ class Collection < ArvadosModel end def ensure_hash_matches_manifest_text - if manifest_text_changed? or portable_data_hash_changed? - computed_hash = "#{Digest::MD5.hexdigest(manifest_text)}+#{manifest_text.length}" - unless computed_hash == portable_data_hash - logger.debug "(computed) '#{computed_hash}' != '#{portable_data_hash}' (provided)" - errors.add(:portable_data_hash, "does not match hash of manifest_text") - return false - end + return true unless manifest_text_changed? or portable_data_hash_changed? + # No need verify it if :set_portable_data_hash just computed it! + return true if not @need_pdh_validation + expect_pdh = compute_pdh + if expect_pdh != portable_data_hash + errors.add(:portable_data_hash, + "does not match computed hash #{expect_pdh}") + return false + end + end + + def set_file_names + if self.manifest_text_changed? + self.file_names = manifest_files end true end + def manifest_files + names = '' + if self.manifest_text + self.manifest_text.scan(/ \d+:\d+:(\S+)/) do |name| + names << name.first.gsub('\040',' ') + "\n" + break if names.length > 2**12 + end + end + + if self.manifest_text and names.length < 2**12 + self.manifest_text.scan(/^\.\/(\S+)/m) do |stream_name| + names << stream_name.first.gsub('\040',' ') + "\n" + break if names.length > 2**12 + end + end + + names[0,2**12] + end + + def check_encoding + if manifest_text.encoding.name == 'UTF-8' and manifest_text.valid_encoding? + true + else + begin + # If Ruby thinks the encoding is something else, like 7-bit + # ASCII, but its stored bytes are equal to the (valid) UTF-8 + # encoding of the same string, we declare it to be a UTF-8 + # string. + utf8 = manifest_text + utf8.force_encoding Encoding::UTF_8 + if utf8.valid_encoding? and utf8 == manifest_text.encode(Encoding::UTF_8) + manifest_text = utf8 + return true + end + rescue + end + errors.add :manifest_text, "must use UTF-8 encoding" + false + end + end + + def replication_desired + # Shim until database columns get fixed up in #3410. + redundancy or 2 + end + def redundancy_status if redundancy_confirmed_as.nil? 'unconfirmed' @@ -119,7 +204,27 @@ class Collection < ArvadosModel end end - def self.munge_manifest_locators(manifest) + def signed_manifest_text + if has_attribute? :manifest_text + token = current_api_client_authorization.andand.api_token + @signed_manifest_text = self.class.sign_manifest manifest_text, token + end + end + + def self.sign_manifest manifest, token + signing_opts = { + key: Rails.configuration.blob_signing_key, + api_token: token, + ttl: Rails.configuration.blob_signing_ttl, + } + m = manifest.dup + munge_manifest_locators!(m) do |loc| + Blob.sign_locator(loc.to_s, signing_opts) + end + return m + end + + def self.munge_manifest_locators! manifest # Given a manifest text and a block, yield each locator, # and replace it with whatever the block returns. manifest.andand.gsub!(/ [[:xdigit:]]{32}(\+[[:digit:]]+)?(\+\S+)/) do |word| @@ -203,4 +308,28 @@ class Collection < ArvadosModel def self.for_latest_docker_image(search_term, search_tag=nil, readers=nil) find_all_for_docker_image(search_term, search_tag, readers).first end + + def self.searchable_columns operator + super - ["manifest_text"] + end + + def self.full_text_searchable_columns + super - ["manifest_text"] + end + + protected + def portable_manifest_text + portable_manifest = self[:manifest_text].dup + self.class.munge_manifest_locators!(portable_manifest) do |loc| + loc.hash + '+' + loc.size.to_s + end + portable_manifest + end + + def compute_pdh + portable_manifest = portable_manifest_text + (Digest::MD5.hexdigest(portable_manifest) + + '+' + + portable_manifest.bytesize.to_s) + end end