Merge branch '3410-replication-attrs' closes #3410 refs #5011
[arvados.git] / services / api / app / models / collection.rb
1 require 'arvados/keep'
2
3 class Collection < ArvadosModel
4   include HasUuid
5   include KindAndEtag
6   include CommonApiTemplate
7
8   serialize :properties, Hash
9
10   before_validation :check_encoding
11   before_validation :check_signatures
12   before_validation :strip_manifest_text
13   before_validation :set_portable_data_hash
14   before_validation :maybe_clear_replication_confirmed
15   validate :ensure_hash_matches_manifest_text
16   before_save :set_file_names
17
18   # Query only undeleted collections by default.
19   default_scope where("expires_at IS NULL or expires_at > CURRENT_TIMESTAMP")
20
21   api_accessible :user, extend: :common do |t|
22     t.add :name
23     t.add :description
24     t.add :properties
25     t.add :portable_data_hash
26     t.add :signed_manifest_text, as: :manifest_text
27     t.add :replication_desired
28     t.add :replication_confirmed
29     t.add :replication_confirmed_at
30   end
31
32   def self.attributes_required_columns
33     super.merge(
34                 # If we don't list manifest_text explicitly, the
35                 # params[:select] code gets confused by the way we
36                 # expose signed_manifest_text as manifest_text in the
37                 # API response, and never let clients select the
38                 # manifest_text column.
39                 'manifest_text' => ['manifest_text'],
40                 )
41   end
42
43   def check_signatures
44     return false if self.manifest_text.nil?
45
46     return true if current_user.andand.is_admin
47
48     # Provided the manifest_text hasn't changed materially since an
49     # earlier validation, it's safe to pass this validation on
50     # subsequent passes without checking any signatures. This is
51     # important because the signatures have probably been stripped off
52     # by the time we get to a second validation pass!
53     return true if @signatures_checked and @signatures_checked == compute_pdh
54
55     if self.manifest_text_changed?
56       # Check permissions on the collection manifest.
57       # If any signature cannot be verified, raise PermissionDeniedError
58       # which will return 403 Permission denied to the client.
59       api_token = current_api_client_authorization.andand.api_token
60       signing_opts = {
61         key: Rails.configuration.blob_signing_key,
62         api_token: api_token,
63         ttl: Rails.configuration.blob_signing_ttl,
64       }
65       self.manifest_text.lines.each do |entry|
66         entry.split[1..-1].each do |tok|
67           if /^[[:digit:]]+:[[:digit:]]+:/.match tok
68             # This is a filename token, not a blob locator. Note that we
69             # keep checking tokens after this, even though manifest
70             # format dictates that all subsequent tokens will also be
71             # filenames. Safety first!
72           elsif Blob.verify_signature tok, signing_opts
73             # OK.
74           elsif Keep::Locator.parse(tok).andand.signature
75             # Signature provided, but verify_signature did not like it.
76             logger.warn "Invalid signature on locator #{tok}"
77             raise ArvadosModel::PermissionDeniedError
78           elsif Rails.configuration.permit_create_collection_with_unsigned_manifest
79             # No signature provided, but we are running in insecure mode.
80             logger.debug "Missing signature on locator #{tok} ignored"
81           elsif Blob.new(tok).empty?
82             # No signature provided -- but no data to protect, either.
83           else
84             logger.warn "Missing signature on locator #{tok}"
85             raise ArvadosModel::PermissionDeniedError
86           end
87         end
88       end
89     end
90     @signatures_checked = compute_pdh
91   end
92
93   def strip_manifest_text
94     if self.manifest_text_changed?
95       # Remove any permission signatures from the manifest.
96       self.class.munge_manifest_locators!(self[:manifest_text]) do |loc|
97         loc.without_signature.to_s
98       end
99     end
100     true
101   end
102
103   def set_portable_data_hash
104     if (portable_data_hash.nil? or
105         portable_data_hash == "" or
106         (manifest_text_changed? and !portable_data_hash_changed?))
107       @need_pdh_validation = false
108       self.portable_data_hash = compute_pdh
109     elsif portable_data_hash_changed?
110       @need_pdh_validation = true
111       begin
112         loc = Keep::Locator.parse!(self.portable_data_hash)
113         loc.strip_hints!
114         if loc.size
115           self.portable_data_hash = loc.to_s
116         else
117           self.portable_data_hash = "#{loc.hash}+#{portable_manifest_text.bytesize}"
118         end
119       rescue ArgumentError => e
120         errors.add(:portable_data_hash, "#{e}")
121         return false
122       end
123     end
124     true
125   end
126
127   def ensure_hash_matches_manifest_text
128     return true unless manifest_text_changed? or portable_data_hash_changed?
129     # No need verify it if :set_portable_data_hash just computed it!
130     return true if not @need_pdh_validation
131     expect_pdh = compute_pdh
132     if expect_pdh != portable_data_hash
133       errors.add(:portable_data_hash,
134                  "does not match computed hash #{expect_pdh}")
135       return false
136     end
137   end
138
139   def set_file_names
140     if self.manifest_text_changed?
141       self.file_names = manifest_files
142     end
143     true
144   end
145
146   def manifest_files
147     names = ''
148     if self.manifest_text
149       self.manifest_text.scan(/ \d+:\d+:(\S+)/) do |name|
150         names << name.first.gsub('\040',' ') + "\n"
151         break if names.length > 2**12
152       end
153     end
154
155     if self.manifest_text and names.length < 2**12
156       self.manifest_text.scan(/^\.\/(\S+)/m) do |stream_name|
157         names << stream_name.first.gsub('\040',' ') + "\n"
158         break if names.length > 2**12
159       end
160     end
161
162     names[0,2**12]
163   end
164
165   def check_encoding
166     if manifest_text.encoding.name == 'UTF-8' and manifest_text.valid_encoding?
167       true
168     else
169       begin
170         # If Ruby thinks the encoding is something else, like 7-bit
171         # ASCII, but its stored bytes are equal to the (valid) UTF-8
172         # encoding of the same string, we declare it to be a UTF-8
173         # string.
174         utf8 = manifest_text
175         utf8.force_encoding Encoding::UTF_8
176         if utf8.valid_encoding? and utf8 == manifest_text.encode(Encoding::UTF_8)
177           manifest_text = utf8
178           return true
179         end
180       rescue
181       end
182       errors.add :manifest_text, "must use UTF-8 encoding"
183       false
184     end
185   end
186
187   def signed_manifest_text
188     if has_attribute? :manifest_text
189       token = current_api_client_authorization.andand.api_token
190       @signed_manifest_text = self.class.sign_manifest manifest_text, token
191     end
192   end
193
194   def self.sign_manifest manifest, token
195     signing_opts = {
196       key: Rails.configuration.blob_signing_key,
197       api_token: token,
198       ttl: Rails.configuration.blob_signing_ttl,
199     }
200     m = manifest.dup
201     munge_manifest_locators!(m) do |loc|
202       Blob.sign_locator(loc.to_s, signing_opts)
203     end
204     return m
205   end
206
207   def self.munge_manifest_locators! manifest
208     # Given a manifest text and a block, yield each locator,
209     # and replace it with whatever the block returns.
210     manifest.andand.gsub!(/ [[:xdigit:]]{32}(\+\S+)?/) do |word|
211       if loc = Keep::Locator.parse(word.strip)
212         " " + yield(loc)
213       else
214         " " + word
215       end
216     end
217   end
218
219   def self.each_manifest_locator manifest
220     # Given a manifest text and a block, yield each locator.
221     manifest.andand.scan(/ ([[:xdigit:]]{32}(\+\S+)?)/) do |word, _|
222       if loc = Keep::Locator.parse(word)
223         yield loc
224       end
225     end
226   end
227
228   def self.normalize_uuid uuid
229     hash_part = nil
230     size_part = nil
231     uuid.split('+').each do |token|
232       if token.match /^[0-9a-f]{32,}$/
233         raise "uuid #{uuid} has multiple hash parts" if hash_part
234         hash_part = token
235       elsif token.match /^\d+$/
236         raise "uuid #{uuid} has multiple size parts" if size_part
237         size_part = token
238       end
239     end
240     raise "uuid #{uuid} has no hash part" if !hash_part
241     [hash_part, size_part].compact.join '+'
242   end
243
244   # Return array of Collection objects
245   def self.find_all_for_docker_image(search_term, search_tag=nil, readers=nil)
246     readers ||= [Thread.current[:user]]
247     base_search = Link.
248       readable_by(*readers).
249       readable_by(*readers, table_name: "collections").
250       joins("JOIN collections ON links.head_uuid = collections.uuid").
251       order("links.created_at DESC")
252
253     # If the search term is a Collection locator that contains one file
254     # that looks like a Docker image, return it.
255     if loc = Keep::Locator.parse(search_term)
256       loc.strip_hints!
257       coll_match = readable_by(*readers).where(portable_data_hash: loc.to_s).limit(1).first
258       if coll_match
259         # Check if the Collection contains exactly one file whose name
260         # looks like a saved Docker image.
261         manifest = Keep::Manifest.new(coll_match.manifest_text)
262         if manifest.exact_file_count?(1) and
263             (manifest.files[0][1] =~ /^[0-9A-Fa-f]{64}\.tar$/)
264           return [coll_match]
265         end
266       end
267     end
268
269     if search_tag.nil? and (n = search_term.index(":"))
270       search_tag = search_term[n+1..-1]
271       search_term = search_term[0..n-1]
272     end
273
274     # Find Collections with matching Docker image repository+tag pairs.
275     matches = base_search.
276       where(link_class: "docker_image_repo+tag",
277             name: "#{search_term}:#{search_tag || 'latest'}")
278
279     # If that didn't work, find Collections with matching Docker image hashes.
280     if matches.empty?
281       matches = base_search.
282         where("link_class = ? and links.name LIKE ?",
283               "docker_image_hash", "#{search_term}%")
284     end
285
286     # Generate an order key for each result.  We want to order the results
287     # so that anything with an image timestamp is considered more recent than
288     # anything without; then we use the link's created_at as a tiebreaker.
289     uuid_timestamps = {}
290     matches.all.map do |link|
291       uuid_timestamps[link.head_uuid] = [(-link.properties["image_timestamp"].to_datetime.to_i rescue 0),
292        -link.created_at.to_i]
293     end
294     Collection.where('uuid in (?)', uuid_timestamps.keys).sort_by { |c| uuid_timestamps[c.uuid] }
295   end
296
297   def self.for_latest_docker_image(search_term, search_tag=nil, readers=nil)
298     find_all_for_docker_image(search_term, search_tag, readers).first
299   end
300
301   def self.searchable_columns operator
302     super - ["manifest_text"]
303   end
304
305   def self.full_text_searchable_columns
306     super - ["manifest_text"]
307   end
308
309   protected
310   def portable_manifest_text
311     portable_manifest = self[:manifest_text].dup
312     self.class.munge_manifest_locators!(portable_manifest) do |loc|
313       if loc.size
314         loc.hash + '+' + loc.size.to_s
315       else
316         loc.hash
317       end
318     end
319     portable_manifest
320   end
321
322   def compute_pdh
323     portable_manifest = portable_manifest_text
324     (Digest::MD5.hexdigest(portable_manifest) +
325      '+' +
326      portable_manifest.bytesize.to_s)
327   end
328
329   def maybe_clear_replication_confirmed
330     if manifest_text_changed?
331       # If the new manifest_text contains locators whose hashes
332       # weren't in the old manifest_text, storage replication is no
333       # longer confirmed.
334       in_old_manifest = {}
335       self.class.each_manifest_locator(manifest_text_was) do |loc|
336         in_old_manifest[loc.hash] = true
337       end
338       self.class.each_manifest_locator(manifest_text) do |loc|
339         if not in_old_manifest[loc.hash]
340           self.replication_confirmed_at = nil
341           self.replication_confirmed = nil
342           break
343         end
344       end
345     end
346   end
347
348   def ensure_permission_to_save
349     if (not current_user.andand.is_admin and
350         (replication_confirmed_at_changed? or replication_confirmed_changed?) and
351         not (replication_confirmed_at.nil? and replication_confirmed.nil?))
352       raise ArvadosModel::PermissionDeniedError.new("replication_confirmed and replication_confirmed_at attributes cannot be changed, except by setting both to nil")
353     end
354     super
355   end
356 end