blob: a2a293fa73688ea1b23ce3863cef807089be8b46 [file] [log] [blame]
Darin Petkovc3fd90c2011-05-11 14:23:00 -07001# Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
rtc@google.comded22402009-10-26 22:36:21 +00002# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
Gilad Arnoldd8d595c2014-03-21 13:00:41 -07005"""Devserver module for handling update client requests."""
6
David Zeuthen52ccd012013-10-31 12:58:26 -07007import base64
Gilad Arnolde7819e72014-03-21 12:50:48 -07008import collections
Dale Curtisc9aaf3a2011-08-09 15:47:40 -07009import json
rtc@google.comded22402009-10-26 22:36:21 +000010import os
David Zeuthen52ccd012013-10-31 12:58:26 -070011import struct
Chris Sosa05491b12010-11-08 17:14:16 -080012import subprocess
Gilad Arnolde74b3812013-04-22 11:27:38 -070013import sys
Gilad Arnoldd0c71752013-12-06 11:48:45 -080014import threading
Darin Petkov2b2ff4b2010-07-27 15:02:09 -070015import time
Gilad Arnold0c9c8602012-10-02 23:58:58 -070016import urllib2
Don Garrett0ad09372010-12-06 16:20:30 -080017import urlparse
Chris Sosa7c931362010-10-11 19:49:01 -070018
Gilad Arnoldabb352e2012-09-23 01:24:27 -070019import cherrypy
20
Gilad Arnolde74b3812013-04-22 11:27:38 -070021# Allow importing from dev/host/lib when running from source tree.
22lib_dir = os.path.join(os.path.dirname(__file__), 'host', 'lib')
23if os.path.exists(lib_dir) and os.path.isdir(lib_dir):
24 sys.path.insert(1, lib_dir)
25
joychen921e1fb2013-06-28 11:12:20 -070026import build_util
Chris Sosa52148582012-11-15 15:35:58 -080027import autoupdate_lib
Gilad Arnold55a2a372012-10-02 09:46:32 -070028import common_util
joychen7c2054a2013-07-25 11:14:07 -070029import devserver_constants as constants
Gilad Arnoldc65330c2012-09-20 15:17:48 -070030import log_util
Gilad Arnolde74b3812013-04-22 11:27:38 -070031# pylint: disable=F0401
32import update_payload
Chris Sosa05491b12010-11-08 17:14:16 -080033
Gilad Arnoldc65330c2012-09-20 15:17:48 -070034
joychen121fc9b2013-08-02 14:30:30 -070035# If used by client in place of an pre-update version string, forces an update
36# to the client regardless of the relative versions of the payload and client.
37FORCED_UPDATE = 'ForcedUpdate'
38
39# Files needed to serve an update.
40UPDATE_FILES = (
41 constants.UPDATE_FILE,
42 constants.STATEFUL_FILE,
43 constants.METADATA_FILE
44)
45
Gilad Arnoldc65330c2012-09-20 15:17:48 -070046# Module-local log function.
Chris Sosa6a3697f2013-01-29 16:44:43 -080047def _Log(message, *args):
48 return log_util.LogWithTag('UPDATE', message, *args)
Gilad Arnoldc65330c2012-09-20 15:17:48 -070049
rtc@google.comded22402009-10-26 22:36:21 +000050
Gilad Arnold0c9c8602012-10-02 23:58:58 -070051class AutoupdateError(Exception):
52 """Exception classes used by this module."""
53 pass
54
55
Don Garrett0ad09372010-12-06 16:20:30 -080056def _ChangeUrlPort(url, new_port):
57 """Return the URL passed in with a different port"""
58 scheme, netloc, path, query, fragment = urlparse.urlsplit(url)
59 host_port = netloc.split(':')
60
61 if len(host_port) == 1:
62 host_port.append(new_port)
63 else:
64 host_port[1] = new_port
65
66 print host_port
joychen121fc9b2013-08-02 14:30:30 -070067 netloc = '%s:%s' % tuple(host_port)
Don Garrett0ad09372010-12-06 16:20:30 -080068
69 return urlparse.urlunsplit((scheme, netloc, path, query, fragment))
70
Chris Sosa6a3697f2013-01-29 16:44:43 -080071def _NonePathJoin(*args):
72 """os.path.join that filters None's from the argument list."""
73 return os.path.join(*filter(None, args))
Don Garrett0ad09372010-12-06 16:20:30 -080074
Chris Sosa6a3697f2013-01-29 16:44:43 -080075
76class HostInfo(object):
Gilad Arnold286a0062012-01-12 13:47:02 -080077 """Records information about an individual host.
78
79 Members:
80 attrs: Static attributes (legacy)
81 log: Complete log of recorded client entries
82 """
83
84 def __init__(self):
85 # A dictionary of current attributes pertaining to the host.
86 self.attrs = {}
87
88 # A list of pairs consisting of a timestamp and a dictionary of recorded
89 # attributes.
90 self.log = []
91
92 def __repr__(self):
93 return 'attrs=%s, log=%s' % (self.attrs, self.log)
94
95 def AddLogEntry(self, entry):
96 """Append a new log entry."""
97 # Append a timestamp.
98 assert not 'timestamp' in entry, 'Oops, timestamp field already in use'
99 entry['timestamp'] = time.strftime('%Y-%m-%d %H:%M:%S')
100 # Add entry to hosts' message log.
101 self.log.append(entry)
102
Gilad Arnold286a0062012-01-12 13:47:02 -0800103
Chris Sosa6a3697f2013-01-29 16:44:43 -0800104class HostInfoTable(object):
Gilad Arnold286a0062012-01-12 13:47:02 -0800105 """Records information about a set of hosts who engage in update activity.
106
107 Members:
108 table: Table of information on hosts.
109 """
110
111 def __init__(self):
112 # A dictionary of host information. Keys are normally IP addresses.
113 self.table = {}
114
115 def __repr__(self):
116 return '%s' % self.table
117
118 def GetInitHostInfo(self, host_id):
119 """Return a host's info object, or create a new one if none exists."""
120 return self.table.setdefault(host_id, HostInfo())
121
122 def GetHostInfo(self, host_id):
123 """Return an info object for given host, if such exists."""
Chris Sosa1885d032012-11-29 17:07:27 -0800124 return self.table.get(host_id)
Gilad Arnold286a0062012-01-12 13:47:02 -0800125
126
Chris Sosa6a3697f2013-01-29 16:44:43 -0800127class UpdateMetadata(object):
128 """Object containing metadata about an update payload."""
129
David Zeuthen52ccd012013-10-31 12:58:26 -0700130 def __init__(self, sha1, sha256, size, is_delta_format, metadata_size,
131 metadata_hash):
Chris Sosa6a3697f2013-01-29 16:44:43 -0800132 self.sha1 = sha1
133 self.sha256 = sha256
134 self.size = size
135 self.is_delta_format = is_delta_format
David Zeuthen52ccd012013-10-31 12:58:26 -0700136 self.metadata_size = metadata_size
137 self.metadata_hash = metadata_hash
Chris Sosa6a3697f2013-01-29 16:44:43 -0800138
139
joychen921e1fb2013-06-28 11:12:20 -0700140class Autoupdate(build_util.BuildObject):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700141 """Class that contains functionality that handles Chrome OS update pings.
142
143 Members:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700144 urlbase: base URL, other than devserver, for update images.
145 forced_image: path to an image to use for all updates.
146 payload_path: path to pre-generated payload to serve.
147 src_image: if specified, creates a delta payload from this image.
148 proxy_port: port of local proxy to tell client to connect to you
149 through.
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700150 board: board for the image. Needed for pre-generating of updates.
151 copy_to_static_root: copies images generated from the cache to ~/static.
152 private_key: path to private key in PEM format.
David Zeuthen52ccd012013-10-31 12:58:26 -0700153 private_key_for_metadata_hash_signature: path to private key in PEM format.
154 public_key: path to public key in PEM format.
Gilad Arnold8318eac2012-10-04 12:52:23 -0700155 critical_update: whether provisioned payload is critical.
156 remote_payload: whether provisioned payload is remotely staged.
157 max_updates: maximum number of updates we'll try to provision.
158 host_log: record full history of host update events.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700159 """
rtc@google.comded22402009-10-26 22:36:21 +0000160
joychened64b222013-06-21 16:39:34 -0700161 _OLD_PAYLOAD_URL_PREFIX = '/static/archive'
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700162 _PAYLOAD_URL_PREFIX = '/static/'
163 _FILEINFO_URL_PREFIX = '/api/fileinfo/'
164
Chris Sosa6a3697f2013-01-29 16:44:43 -0800165 SHA1_ATTR = 'sha1'
166 SHA256_ATTR = 'sha256'
167 SIZE_ATTR = 'size'
168 ISDELTA_ATTR = 'is_delta'
David Zeuthen52ccd012013-10-31 12:58:26 -0700169 METADATA_SIZE_ATTR = 'metadata_size'
170 METADATA_HASH_ATTR = 'metadata_hash'
Chris Sosa6a3697f2013-01-29 16:44:43 -0800171
joychen121fc9b2013-08-02 14:30:30 -0700172 def __init__(self, xbuddy, urlbase=None, forced_image=None, payload_path=None,
Gabe Black70994862014-09-05 00:50:58 -0700173 proxy_port=None, src_image='', board=None,
Chris Sosa0f1ec842011-02-14 16:33:22 -0800174 copy_to_static_root=True, private_key=None,
David Zeuthen52ccd012013-10-31 12:58:26 -0700175 private_key_for_metadata_hash_signature=None, public_key=None,
Chris Sosa52148582012-11-15 15:35:58 -0800176 critical_update=False, remote_payload=False, max_updates= -1,
Chris Sosa6a3697f2013-01-29 16:44:43 -0800177 host_log=False, *args, **kwargs):
Sean O'Connor14b6a0a2010-03-20 23:23:48 -0700178 super(Autoupdate, self).__init__(*args, **kwargs)
joychen121fc9b2013-08-02 14:30:30 -0700179 self.xbuddy = xbuddy
180 self.urlbase = urlbase or None
Chris Sosa0356d3b2010-09-16 15:46:22 -0700181 self.forced_image = forced_image
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700182 self.payload_path = payload_path
Chris Sosa62f720b2010-10-26 21:39:48 -0700183 self.src_image = src_image
Don Garrett0ad09372010-12-06 16:20:30 -0800184 self.proxy_port = proxy_port
joychen562699a2013-08-13 15:22:14 -0700185 self.board = board or self.GetDefaultBoardID()
Chris Sosa08d55a22011-01-19 16:08:02 -0800186 self.copy_to_static_root = copy_to_static_root
Chris Sosa0f1ec842011-02-14 16:33:22 -0800187 self.private_key = private_key
David Zeuthen52ccd012013-10-31 12:58:26 -0700188 self.private_key_for_metadata_hash_signature = \
189 private_key_for_metadata_hash_signature
190 self.public_key = public_key
Satoru Takabayashid733cbe2011-11-15 09:36:32 -0800191 self.critical_update = critical_update
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700192 self.remote_payload = remote_payload
Jay Srinivasanac69d262012-10-30 19:05:53 -0700193 self.max_updates = max_updates
Gilad Arnold8318eac2012-10-04 12:52:23 -0700194 self.host_log = host_log
Don Garrettfff4c322010-11-19 13:37:12 -0800195
Chris Sosa417e55d2011-01-25 16:40:48 -0800196 self.pregenerated_path = None
Sean O'Connor14b6a0a2010-03-20 23:23:48 -0700197
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700198 # Initialize empty host info cache. Used to keep track of various bits of
Gilad Arnold286a0062012-01-12 13:47:02 -0800199 # information about a given host. A host is identified by its IP address.
200 # The info stored for each host includes a complete log of events for this
201 # host, as well as a dictionary of current attributes derived from events.
202 self.host_infos = HostInfoTable()
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700203
Gilad Arnolde7819e72014-03-21 12:50:48 -0700204 self._update_count_lock = threading.Lock()
Gilad Arnoldd0c71752013-12-06 11:48:45 -0800205
Chris Sosa6a3697f2013-01-29 16:44:43 -0800206 @classmethod
207 def _ReadMetadataFromStream(cls, stream):
208 """Returns metadata obj from input json stream that implements .read()."""
209 file_attr_dict = {}
210 try:
211 file_attr_dict = json.loads(stream.read())
212 except IOError:
213 return None
214
215 sha1 = file_attr_dict.get(cls.SHA1_ATTR)
216 sha256 = file_attr_dict.get(cls.SHA256_ATTR)
217 size = file_attr_dict.get(cls.SIZE_ATTR)
218 is_delta = file_attr_dict.get(cls.ISDELTA_ATTR)
David Zeuthen52ccd012013-10-31 12:58:26 -0700219 metadata_size = file_attr_dict.get(cls.METADATA_SIZE_ATTR)
220 metadata_hash = file_attr_dict.get(cls.METADATA_HASH_ATTR)
221 return UpdateMetadata(sha1, sha256, size, is_delta, metadata_size,
222 metadata_hash)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800223
224 @staticmethod
225 def _ReadMetadataFromFile(payload_dir):
226 """Returns metadata object from the metadata_file in the payload_dir"""
joychen25d25972013-07-30 14:54:16 -0700227 metadata_file = os.path.join(payload_dir, constants.METADATA_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800228 if os.path.exists(metadata_file):
229 with open(metadata_file, 'r') as metadata_stream:
230 return Autoupdate._ReadMetadataFromStream(metadata_stream)
231
232 @classmethod
233 def _StoreMetadataToFile(cls, payload_dir, metadata_obj):
234 """Stores metadata object into the metadata_file of the payload_dir"""
235 file_dict = {cls.SHA1_ATTR: metadata_obj.sha1,
236 cls.SHA256_ATTR: metadata_obj.sha256,
237 cls.SIZE_ATTR: metadata_obj.size,
David Zeuthen52ccd012013-10-31 12:58:26 -0700238 cls.ISDELTA_ATTR: metadata_obj.is_delta_format,
239 cls.METADATA_SIZE_ATTR: metadata_obj.metadata_size,
240 cls.METADATA_HASH_ATTR: metadata_obj.metadata_hash}
joychen25d25972013-07-30 14:54:16 -0700241 metadata_file = os.path.join(payload_dir, constants.METADATA_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800242 with open(metadata_file, 'w') as file_handle:
243 json.dump(file_dict, file_handle)
244
Chris Sosa52148582012-11-15 15:35:58 -0800245 @staticmethod
246 def _GetVersionFromDir(image_dir):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700247 """Returns the version of the image based on the name of the directory."""
248 latest_version = os.path.basename(image_dir)
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700249 parts = latest_version.split('-')
joychen121fc9b2013-08-02 14:30:30 -0700250 # If we can't get a version number from the directory, default to a high
251 # number to allow the update to happen
252 return parts[1] if len(parts) == 3 else "9999.0.0"
Chris Sosa0356d3b2010-09-16 15:46:22 -0700253
Chris Sosa52148582012-11-15 15:35:58 -0800254 @staticmethod
255 def _CanUpdate(client_version, latest_version):
Don Garrettf90edf02010-11-16 17:36:14 -0800256 """Returns true if the latest_version is greater than the client_version.
257 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800258 _Log('client version %s latest version %s', client_version, latest_version)
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700259
260 client_tokens = client_version.replace('_', '').split('.')
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700261 latest_tokens = latest_version.replace('_', '').split('.')
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700262
joychen121fc9b2013-08-02 14:30:30 -0700263 if len(latest_tokens) == len(client_tokens) == 3:
264 return latest_tokens > client_tokens
Chris Sosa0356d3b2010-09-16 15:46:22 -0700265 else:
joychen121fc9b2013-08-02 14:30:30 -0700266 # If the directory name isn't a version number, let it pass.
267 return True
Chris Sosa0356d3b2010-09-16 15:46:22 -0700268
Chris Sosa52148582012-11-15 15:35:58 -0800269 @staticmethod
Gilad Arnolde74b3812013-04-22 11:27:38 -0700270 def IsDeltaFormatFile(filename):
Andrew de los Reyes5679b972010-10-25 17:34:49 -0700271 try:
Gilad Arnolde74b3812013-04-22 11:27:38 -0700272 with open(filename) as payload_file:
273 payload = update_payload.Payload(payload_file)
274 payload.Init()
275 return payload.IsDelta()
276 except (IOError, update_payload.PayloadError):
277 # For unit tests we may not have real files, so it's ok to ignore these
278 # errors.
Andrew de los Reyes5679b972010-10-25 17:34:49 -0700279 return False
280
Don Garrettf90edf02010-11-16 17:36:14 -0800281 def GenerateUpdateFile(self, src_image, image_path, output_dir):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700282 """Generates an update gz given a full path to an image.
283
284 Args:
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700285 src_image: Path to a source image.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700286 image_path: Full path to image.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700287 output_dir: Path to the generated update file.
288
Chris Sosa6a3697f2013-01-29 16:44:43 -0800289 Raises:
290 subprocess.CalledProcessError if the update generator fails to generate a
291 stateful payload.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700292 """
joychen7c2054a2013-07-25 11:14:07 -0700293 update_path = os.path.join(output_dir, constants.UPDATE_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800294 _Log('Generating update image %s', update_path)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700295
Chris Sosa0f1ec842011-02-14 16:33:22 -0800296 update_command = [
Chris Sosa5b8b5eb2012-03-27 11:15:27 -0700297 'cros_generate_update_payload',
Chris Sosa6a3697f2013-01-29 16:44:43 -0800298 '--image', image_path,
David Zeuthen52ccd012013-10-31 12:58:26 -0700299 '--out_metadata_hash_file', os.path.join(output_dir,
300 constants.METADATA_HASH_FILE),
Chris Sosa6a3697f2013-01-29 16:44:43 -0800301 '--output', update_path,
Chris Sosa0f1ec842011-02-14 16:33:22 -0800302 ]
Chris Sosa4136e692010-10-28 23:42:37 -0700303
Chris Sosa52148582012-11-15 15:35:58 -0800304 if src_image:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800305 update_command.extend(['--src_image', src_image])
Chris Sosa52148582012-11-15 15:35:58 -0800306
Chris Sosa52148582012-11-15 15:35:58 -0800307 if self.private_key:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800308 update_command.extend(['--private_key', self.private_key])
Chris Sosa0f1ec842011-02-14 16:33:22 -0800309
Chris Sosa6a3697f2013-01-29 16:44:43 -0800310 _Log('Running %s', ' '.join(update_command))
311 subprocess.check_call(update_command)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700312
Chris Sosa52148582012-11-15 15:35:58 -0800313 @staticmethod
314 def GenerateStatefulFile(image_path, output_dir):
Don Garrettf90edf02010-11-16 17:36:14 -0800315 """Generates a stateful update payload given a full path to an image.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700316
317 Args:
318 image_path: Full path to image.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700319 output_dir: Directory for emitting the stateful update payload.
320
Chris Sosa908fd6f2010-11-10 17:31:18 -0800321 Raises:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800322 subprocess.CalledProcessError if the update generator fails to generate a
Chris Sosa908fd6f2010-11-10 17:31:18 -0800323 stateful payload.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700324 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800325 update_command = [
326 'cros_generate_stateful_update_payload',
327 '--image', image_path,
328 '--output_dir', output_dir,
329 ]
330 _Log('Running %s', ' '.join(update_command))
331 subprocess.check_call(update_command)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700332
Don Garrettf90edf02010-11-16 17:36:14 -0800333 def FindCachedUpdateImageSubDir(self, src_image, dest_image):
334 """Find directory to store a cached update.
335
Gilad Arnold55a2a372012-10-02 09:46:32 -0700336 Given one, or two images for an update, this finds which cache directory
337 should hold the update files, even if they don't exist yet.
Don Garrettf90edf02010-11-16 17:36:14 -0800338
Gilad Arnold55a2a372012-10-02 09:46:32 -0700339 Returns:
340 A directory path for storing a cached update, of the following form:
341 Non-delta updates:
342 CACHE_DIR/<dest_hash>
343 Delta updates:
344 CACHE_DIR/<src_hash>_<dest_hash>
345 Signed updates (self.private_key):
346 CACHE_DIR/<src_hash>_<dest_hash>+<private_key_hash>
Chris Sosa744e1472011-09-07 19:32:50 -0700347 """
Gilad Arnold55a2a372012-10-02 09:46:32 -0700348 update_dir = ''
Chris Sosa744e1472011-09-07 19:32:50 -0700349 if src_image:
Gilad Arnold55a2a372012-10-02 09:46:32 -0700350 update_dir += common_util.GetFileMd5(src_image) + '_'
Don Garrettf90edf02010-11-16 17:36:14 -0800351
Gilad Arnold55a2a372012-10-02 09:46:32 -0700352 update_dir += common_util.GetFileMd5(dest_image)
Chris Sosa744e1472011-09-07 19:32:50 -0700353 if self.private_key:
Gilad Arnold55a2a372012-10-02 09:46:32 -0700354 update_dir += '+' + common_util.GetFileMd5(self.private_key)
Chris Sosa744e1472011-09-07 19:32:50 -0700355
joychen25d25972013-07-30 14:54:16 -0700356 return os.path.join(constants.CACHE_DIR, update_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800357
Don Garrettfff4c322010-11-19 13:37:12 -0800358 def GenerateUpdateImage(self, image_path, output_dir):
Don Garrettf90edf02010-11-16 17:36:14 -0800359 """Force generates an update payload based on the given image_path.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700360
Chris Sosade91f672010-11-16 10:05:44 -0800361 Args:
Don Garrettf90edf02010-11-16 17:36:14 -0800362 image_path: full path to the image.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800363 output_dir: the directory to write the update payloads to
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700364
Chris Sosa6a3697f2013-01-29 16:44:43 -0800365 Raises:
366 AutoupdateError if it failed to generate either update or stateful
367 payload.
Chris Sosade91f672010-11-16 10:05:44 -0800368 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800369 _Log('Generating update for image %s', image_path)
Andrew de los Reyes9a528712010-06-30 10:29:43 -0700370
Chris Sosa6a3697f2013-01-29 16:44:43 -0800371 # Delete any previous state in this directory.
372 os.system('rm -rf "%s"' % output_dir)
373 os.makedirs(output_dir)
rtc@google.comded22402009-10-26 22:36:21 +0000374
Chris Sosa6a3697f2013-01-29 16:44:43 -0800375 try:
376 self.GenerateUpdateFile(self.src_image, image_path, output_dir)
377 self.GenerateStatefulFile(image_path, output_dir)
378 except subprocess.CalledProcessError:
379 os.system('rm -rf "%s"' % output_dir)
380 raise AutoupdateError('Failed to generate update in %s' % output_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800381
Chris Sosa75490802013-09-30 17:21:45 -0700382 def GenerateUpdateImageWithCache(self, image_path):
Don Garrettf90edf02010-11-16 17:36:14 -0800383 """Force generates an update payload based on the given image_path.
rtc@google.comded22402009-10-26 22:36:21 +0000384
Chris Sosa0356d3b2010-09-16 15:46:22 -0700385 Args:
386 image_path: full path to the image.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700387
Chris Sosa0356d3b2010-09-16 15:46:22 -0700388 Returns:
joychen121fc9b2013-08-02 14:30:30 -0700389 update directory relative to static_image_dir.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700390
Chris Sosa6a3697f2013-01-29 16:44:43 -0800391 Raises:
392 AutoupdateError if it we need to generate a payload and fail to do so.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700393 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800394 _Log('Generating update for src %s image %s', self.src_image, image_path)
Chris Sosae67b78f2010-11-04 17:33:16 -0700395
joychen121fc9b2013-08-02 14:30:30 -0700396 # If it was pregenerated, don't regenerate.
Chris Sosa417e55d2011-01-25 16:40:48 -0800397 if self.pregenerated_path:
398 return self.pregenerated_path
Don Garrettfff4c322010-11-19 13:37:12 -0800399
Chris Sosa75490802013-09-30 17:21:45 -0700400 # Which sub_dir should hold our cached update image.
401 cache_sub_dir = self.FindCachedUpdateImageSubDir(self.src_image, image_path)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800402 _Log('Caching in sub_dir "%s"', cache_sub_dir)
Chris Sosa417e55d2011-01-25 16:40:48 -0800403
joychen121fc9b2013-08-02 14:30:30 -0700404 # The cached payloads exist in a cache dir.
Chris Sosa75490802013-09-30 17:21:45 -0700405 cache_dir = os.path.join(self.static_dir, cache_sub_dir)
joychen121fc9b2013-08-02 14:30:30 -0700406
407 cache_update_payload = os.path.join(cache_dir,
joychen7c2054a2013-07-25 11:14:07 -0700408 constants.UPDATE_FILE)
joychen121fc9b2013-08-02 14:30:30 -0700409 cache_stateful_payload = os.path.join(cache_dir,
joychen25d25972013-07-30 14:54:16 -0700410 constants.STATEFUL_FILE)
Chris Sosa417e55d2011-01-25 16:40:48 -0800411 # Check to see if this cache directory is valid.
joychen121fc9b2013-08-02 14:30:30 -0700412 if not (os.path.exists(cache_update_payload) and
413 os.path.exists(cache_stateful_payload)):
414 self.GenerateUpdateImage(image_path, cache_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800415
joychen121fc9b2013-08-02 14:30:30 -0700416 # Don't regenerate the image for this devserver instance.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800417 self.pregenerated_path = cache_sub_dir
Chris Sosa65d339b2013-01-21 18:59:21 -0800418
Chris Sosa6a3697f2013-01-29 16:44:43 -0800419 # Generate the cache file.
joychen121fc9b2013-08-02 14:30:30 -0700420 self.GetLocalPayloadAttrs(cache_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800421
joychen121fc9b2013-08-02 14:30:30 -0700422 return cache_sub_dir
Chris Sosa0356d3b2010-09-16 15:46:22 -0700423
Chris Sosa75490802013-09-30 17:21:45 -0700424 def _SymlinkUpdateFiles(self, target_dir, link_dir):
425 """Symlinks the update-related files from target_dir to link_dir.
joychen121fc9b2013-08-02 14:30:30 -0700426
427 Every time an update is called, clear existing files/symlinks in the
Chris Sosa75490802013-09-30 17:21:45 -0700428 link_dir, and replace them with symlinks to the target_dir.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700429
430 Args:
Chris Sosa75490802013-09-30 17:21:45 -0700431 target_dir: Location of the target files.
432 link_dir: Directory where the links should exist after.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700433 """
Chris Sosa75490802013-09-30 17:21:45 -0700434 _Log('Linking %s to %s', target_dir, link_dir)
435 if link_dir == target_dir:
436 _Log('Cannot symlink into the same directory.')
joychen121fc9b2013-08-02 14:30:30 -0700437 return
438 for f in UPDATE_FILES:
Chris Sosa75490802013-09-30 17:21:45 -0700439 link = os.path.join(link_dir, f)
440 target = os.path.join(target_dir, f)
Alex Deymo3e2d4952013-09-03 21:49:41 -0700441 common_util.SymlinkFile(target, link)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700442
joychen121fc9b2013-08-02 14:30:30 -0700443 def GetUpdateForLabel(self, client_version, label,
444 image_name=constants.TEST_IMAGE_FILE):
445 """Given a label, get an update from the directory.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700446
joychen121fc9b2013-08-02 14:30:30 -0700447 Args:
448 client_version: Current version of the client or FORCED_UPDATE
449 label: the relative directory inside the static dir
450 image_name: If the image type was specified by the update rpc, we try to
451 find an image with this file name first. This is by default
452 "chromiumos_test_image.bin" but can also take any of the values in
453 devserver_constants.ALL_IMAGES
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700454
Chris Sosa6a3697f2013-01-29 16:44:43 -0800455 Returns:
joychen121fc9b2013-08-02 14:30:30 -0700456 A relative path to the directory with the update payload.
457 This is the label if an update did not need to be generated, but can
458 be label/cache/hashed_dir_for_update.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700459
Chris Sosa6a3697f2013-01-29 16:44:43 -0800460 Raises:
joychen121fc9b2013-08-02 14:30:30 -0700461 AutoupdateError: If client version is higher than available update found
462 at the directory given by the label.
Don Garrettf90edf02010-11-16 17:36:14 -0800463 """
joychen121fc9b2013-08-02 14:30:30 -0700464 _Log('Update label/file: %s/%s', label, image_name)
465 static_image_dir = _NonePathJoin(self.static_dir, label)
466 static_update_path = _NonePathJoin(static_image_dir, constants.UPDATE_FILE)
467 static_image_path = _NonePathJoin(static_image_dir, image_name)
joychen7c2054a2013-07-25 11:14:07 -0700468
joychen121fc9b2013-08-02 14:30:30 -0700469 # Update the client only if client version is older than available update.
470 latest_version = self._GetVersionFromDir(static_image_dir)
471 if not (client_version == FORCED_UPDATE or
472 self._CanUpdate(client_version, latest_version)):
473 raise AutoupdateError(
474 'Update check received but no update available for client')
Don Garrettee25e552010-11-23 12:09:35 -0800475
joychen121fc9b2013-08-02 14:30:30 -0700476 if label and os.path.exists(static_update_path):
477 # An update payload was found for the given label, return it.
478 return label
479 elif os.path.exists(static_image_path) and common_util.IsInsideChroot():
480 # Image was found for the given label. Generate update if we can.
Chris Sosa75490802013-09-30 17:21:45 -0700481 rel_path = self.GenerateUpdateImageWithCache(static_image_path)
482 # Add links from the static directory to the update.
483 cache_path = _NonePathJoin(self.static_dir, rel_path)
484 self._SymlinkUpdateFiles(cache_path, static_image_dir)
485 return label
Don Garrett0c880e22010-11-17 18:13:37 -0800486
joychen121fc9b2013-08-02 14:30:30 -0700487 # The label didn't resolve.
488 return None
Chris Sosa2c048f12010-10-27 16:05:27 -0700489
490 def PreGenerateUpdate(self):
Chris Sosa417e55d2011-01-25 16:40:48 -0800491 """Pre-generates an update and prints out the relative path it.
492
Chris Sosa6a3697f2013-01-29 16:44:43 -0800493 Returns relative path of the update.
Chris Sosa65d339b2013-01-21 18:59:21 -0800494
Chris Sosa6a3697f2013-01-29 16:44:43 -0800495 Raises:
496 AutoupdateError if it failed to generate the payload.
497 """
498 _Log('Pre-generating the update payload')
joychen121fc9b2013-08-02 14:30:30 -0700499 # Does not work with labels so just use static dir. (empty label)
500 pregenerated_update = self.GetPathToPayload('', FORCED_UPDATE, self.board)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800501 print 'PREGENERATED_UPDATE=%s' % _NonePathJoin(pregenerated_update,
joychen7c2054a2013-07-25 11:14:07 -0700502 constants.UPDATE_FILE)
Chris Sosa417e55d2011-01-25 16:40:48 -0800503 return pregenerated_update
Chris Sosa2c048f12010-10-27 16:05:27 -0700504
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700505 def _GetRemotePayloadAttrs(self, url):
506 """Returns hashes, size and delta flag of a remote update payload.
507
508 Obtain attributes of a payload file available on a remote devserver. This
509 is based on the assumption that the payload URL uses the /static prefix. We
510 need to make sure that both clients (requests) and remote devserver
511 (provisioning) preserve this invariant.
512
513 Args:
514 url: URL of statically staged remote file (http://host:port/static/...)
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700515
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700516 Returns:
David Zeuthen52ccd012013-10-31 12:58:26 -0700517 A UpdateMetadata object.
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700518 """
519 if self._PAYLOAD_URL_PREFIX not in url:
520 raise AutoupdateError(
521 'Payload URL does not have the expected prefix (%s)' %
522 self._PAYLOAD_URL_PREFIX)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800523
joychened64b222013-06-21 16:39:34 -0700524 if self._OLD_PAYLOAD_URL_PREFIX in url:
525 fileinfo_url = url.replace(self._OLD_PAYLOAD_URL_PREFIX,
526 self._FILEINFO_URL_PREFIX)
527 else:
528 fileinfo_url = url.replace(self._PAYLOAD_URL_PREFIX,
529 self._FILEINFO_URL_PREFIX)
530
Chris Sosa6a3697f2013-01-29 16:44:43 -0800531 _Log('Retrieving file info for remote payload via %s', fileinfo_url)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700532 try:
533 conn = urllib2.urlopen(fileinfo_url)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800534 metadata_obj = Autoupdate._ReadMetadataFromStream(conn)
535 # These fields are required for remote calls.
536 if not metadata_obj:
537 raise AutoupdateError('Failed to obtain remote payload info')
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700538
Chris Sosa6a3697f2013-01-29 16:44:43 -0800539 return metadata_obj
540 except IOError as e:
541 raise AutoupdateError('Failed to obtain remote payload info: %s', e)
542
David Zeuthen52ccd012013-10-31 12:58:26 -0700543 @staticmethod
544 def _GetMetadataHash(payload_dir):
David Zeuthenf27f1502013-11-13 10:38:16 -0800545 """Gets the metadata hash, if it exists.
David Zeuthen52ccd012013-10-31 12:58:26 -0700546
547 Args:
548 payload_dir: The payload directory.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700549
David Zeuthen52ccd012013-10-31 12:58:26 -0700550 Returns:
David Zeuthenf27f1502013-11-13 10:38:16 -0800551 The metadata hash, base-64 encoded or None if there is no metadata hash.
David Zeuthen52ccd012013-10-31 12:58:26 -0700552 """
553 path = os.path.join(payload_dir, constants.METADATA_HASH_FILE)
David Zeuthenf27f1502013-11-13 10:38:16 -0800554 if os.path.exists(path):
555 return base64.b64encode(open(path, 'rb').read())
556 else:
557 return None
David Zeuthen52ccd012013-10-31 12:58:26 -0700558
559 @staticmethod
560 def _GetMetadataSize(payload_filename):
561 """Gets the size of the metadata in a payload file.
562
563 Args:
564 payload_filename: Path to the payload file.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700565
David Zeuthen52ccd012013-10-31 12:58:26 -0700566 Returns:
567 The size of the payload metadata, as reported in the payload header.
568 """
Alex Deymoa6ac00d2015-10-15 09:14:58 -0700569 try:
570 with open(payload_filename) as payload_file:
571 payload = update_payload.Payload(payload_file)
572 payload.Init()
573 return payload.metadata_size
574 except (IOError, update_payload.PayloadError):
575 # For unit tests we may not have real files, so it's ok to ignore these
576 # errors.
David Zeuthen52ccd012013-10-31 12:58:26 -0700577 return 0
David Zeuthen52ccd012013-10-31 12:58:26 -0700578
Chris Sosa6a3697f2013-01-29 16:44:43 -0800579 def GetLocalPayloadAttrs(self, payload_dir):
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700580 """Returns hashes, size and delta flag of a local update payload.
581
582 Args:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800583 payload_dir: Path to the directory the payload is in.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700584
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700585 Returns:
David Zeuthen52ccd012013-10-31 12:58:26 -0700586 A UpdateMetadata object.
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700587 """
joychen7c2054a2013-07-25 11:14:07 -0700588 filename = os.path.join(payload_dir, constants.UPDATE_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800589 if not os.path.exists(filename):
590 raise AutoupdateError('update.gz not present in payload dir %s' %
591 payload_dir)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700592
Chris Sosa6a3697f2013-01-29 16:44:43 -0800593 metadata_obj = Autoupdate._ReadMetadataFromFile(payload_dir)
594 if not metadata_obj or not (metadata_obj.sha1 and
595 metadata_obj.sha256 and
596 metadata_obj.size):
597 sha1 = common_util.GetFileSha1(filename)
598 sha256 = common_util.GetFileSha256(filename)
599 size = common_util.GetFileSize(filename)
Gilad Arnolde74b3812013-04-22 11:27:38 -0700600 is_delta_format = self.IsDeltaFormatFile(filename)
David Zeuthen52ccd012013-10-31 12:58:26 -0700601 metadata_size = self._GetMetadataSize(filename)
602 metadata_hash = self._GetMetadataHash(payload_dir)
603 metadata_obj = UpdateMetadata(sha1, sha256, size, is_delta_format,
604 metadata_size, metadata_hash)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800605 Autoupdate._StoreMetadataToFile(payload_dir, metadata_obj)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700606
Chris Sosa6a3697f2013-01-29 16:44:43 -0800607 return metadata_obj
608
609 def _ProcessUpdateComponents(self, app, event):
Gilad Arnolde7819e72014-03-21 12:50:48 -0700610 """Processes the components of an update request.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800611
Gilad Arnolde7819e72014-03-21 12:50:48 -0700612 Args:
613 app: An app component of an update request.
614 event: An event component of an update request.
615
616 Returns:
617 A named tuple containing attributes of the update requests as the
618 following fields: 'forced_update_label', 'client_version', 'board',
619 'event_result' and 'event_type'.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700620 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800621 # Initialize an empty dictionary for event attributes to log.
622 log_message = {}
Jay Srinivasanac69d262012-10-30 19:05:53 -0700623
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700624 # Determine request IP, strip any IPv6 data for simplicity.
625 client_ip = cherrypy.request.remote.ip.split(':')[-1]
Gilad Arnold286a0062012-01-12 13:47:02 -0800626 # Obtain (or init) info object for this client.
627 curr_host_info = self.host_infos.GetInitHostInfo(client_ip)
628
joychen121fc9b2013-08-02 14:30:30 -0700629 client_version = FORCED_UPDATE
Chris Sosa6a3697f2013-01-29 16:44:43 -0800630 board = None
631 if app:
632 client_version = app.getAttribute('version')
633 channel = app.getAttribute('track')
634 board = (app.hasAttribute('board') and app.getAttribute('board')
joychenb0dfe552013-07-30 10:02:06 -0700635 or self.GetDefaultBoardID())
Chris Sosa6a3697f2013-01-29 16:44:43 -0800636 # Add attributes to log message
637 log_message['version'] = client_version
638 log_message['track'] = channel
639 log_message['board'] = board
640 curr_host_info.attrs['last_known_version'] = client_version
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700641
Gilad Arnolde7819e72014-03-21 12:50:48 -0700642 event_result = None
643 event_type = None
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700644 if event:
Gilad Arnold286a0062012-01-12 13:47:02 -0800645 event_result = int(event[0].getAttribute('eventresult'))
646 event_type = int(event[0].getAttribute('eventtype'))
Gilad Arnoldb11a8942012-03-13 15:33:21 -0700647 client_previous_version = (event[0].getAttribute('previousversion')
648 if event[0].hasAttribute('previousversion')
649 else None)
Gilad Arnold286a0062012-01-12 13:47:02 -0800650 # Store attributes to legacy host info structure
651 curr_host_info.attrs['last_event_status'] = event_result
652 curr_host_info.attrs['last_event_type'] = event_type
653 # Add attributes to log message
654 log_message['event_result'] = event_result
655 log_message['event_type'] = event_type
Gilad Arnoldb11a8942012-03-13 15:33:21 -0700656 if client_previous_version is not None:
657 log_message['previous_version'] = client_previous_version
Gilad Arnold286a0062012-01-12 13:47:02 -0800658
Gilad Arnold8318eac2012-10-04 12:52:23 -0700659 # Log host event, if so instructed.
660 if self.host_log:
661 curr_host_info.AddLogEntry(log_message)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700662
Gilad Arnolde7819e72014-03-21 12:50:48 -0700663 UpdateRequestAttrs = collections.namedtuple(
664 'UpdateRequestAttrs',
665 ('forced_update_label', 'client_version', 'board', 'event_result',
666 'event_type'))
667
668 return UpdateRequestAttrs(
669 curr_host_info.attrs.pop('forced_update_label', None),
670 client_version, board, event_result, event_type)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800671
Chris Sosa4b951602014-04-09 20:26:07 -0700672 @classmethod
673 def _CheckOmahaRequest(cls, app):
674 """Checks |app| component of Omaha Request for correctly formed data.
675
676 Raises:
677 common_util.DevServerHTTPError: if any check fails. All 400 error codes to
678 indicate a bad HTTP request.
679 """
680 if not app:
681 raise common_util.DevServerHTTPError(
682 400, 'Missing app component in Omaha Request')
683
684 hardware_class = app.getAttribute('hardware_class')
685 if not hardware_class:
686 raise common_util.DevServerHTTPError(
687 400, 'hardware_class is required in Omaha Request')
688
689 track = app.getAttribute('track')
Chris Sosafc715442014-04-09 20:45:23 -0700690 if not (track and track.endswith('-channel')):
Chris Sosa4b951602014-04-09 20:26:07 -0700691 raise common_util.DevServerHTTPError(
Chris Sosafc715442014-04-09 20:45:23 -0700692 400, 'Omaha requests need a valid update channel')
Chris Sosa4b951602014-04-09 20:26:07 -0700693
Chris Sosa6a3697f2013-01-29 16:44:43 -0800694 def _GetStaticUrl(self):
695 """Returns the static url base that should prefix all payload responses."""
696 x_forwarded_host = cherrypy.request.headers.get('X-Forwarded-Host')
697 if x_forwarded_host:
698 hostname = 'http://' + x_forwarded_host
699 else:
700 hostname = cherrypy.request.base
701
702 if self.urlbase:
703 static_urlbase = self.urlbase
Chris Sosa6a3697f2013-01-29 16:44:43 -0800704 else:
705 static_urlbase = '%s/static' % hostname
706
707 # If we have a proxy port, adjust the URL we instruct the client to
708 # use to go through the proxy.
709 if self.proxy_port:
710 static_urlbase = _ChangeUrlPort(static_urlbase, self.proxy_port)
711
712 _Log('Using static url base %s', static_urlbase)
713 _Log('Handling update ping as %s', hostname)
714 return static_urlbase
715
joychen121fc9b2013-08-02 14:30:30 -0700716 def GetPathToPayload(self, label, client_version, board):
717 """Find a payload locally.
718
719 See devserver's update rpc for documentation.
720
721 Args:
722 label: from update request
723 client_version: from update request
724 board: from update request
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700725
726 Returns:
joychen121fc9b2013-08-02 14:30:30 -0700727 The relative path to an update from the static_dir
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700728
joychen121fc9b2013-08-02 14:30:30 -0700729 Raises:
730 AutoupdateError: If the update could not be found.
731 """
732 path_to_payload = None
733 #TODO(joychen): deprecate --payload flag
734 if self.payload_path:
735 # Copy the image from the path to '/forced_payload'
736 label = 'forced_payload'
737 dest_path = os.path.join(self.static_dir, label, constants.UPDATE_FILE)
738 dest_stateful = os.path.join(self.static_dir, label,
739 constants.STATEFUL_FILE)
Alex Deymo48e970d2015-09-23 14:34:41 -0700740 dest_meta = os.path.join(self.static_dir, label, constants.METADATA_FILE)
joychen121fc9b2013-08-02 14:30:30 -0700741
742 src_path = os.path.abspath(self.payload_path)
743 src_stateful = os.path.join(os.path.dirname(src_path),
744 constants.STATEFUL_FILE)
745 common_util.MkDirP(os.path.join(self.static_dir, label))
Alex Deymo3e2d4952013-09-03 21:49:41 -0700746 common_util.SymlinkFile(src_path, dest_path)
Alex Deymo48e970d2015-09-23 14:34:41 -0700747 # The old metadata file should be regenerated whenever a new payload is
748 # used.
749 try:
750 os.unlink(dest_meta)
751 except OSError:
752 pass
joychen121fc9b2013-08-02 14:30:30 -0700753 if os.path.exists(src_stateful):
754 # The stateful payload is optional.
Alex Deymo3e2d4952013-09-03 21:49:41 -0700755 common_util.SymlinkFile(src_stateful, dest_stateful)
joychen121fc9b2013-08-02 14:30:30 -0700756 else:
757 _Log('WARN: %s not found. Expected for dev and test builds',
758 constants.STATEFUL_FILE)
759 if os.path.exists(dest_stateful):
760 os.remove(dest_stateful)
761 path_to_payload = self.GetUpdateForLabel(client_version, label)
762 #TODO(joychen): deprecate --image flag
763 elif self.forced_image:
joychendbfe6c92013-08-16 20:03:49 -0700764 if self.forced_image.startswith('xbuddy:'):
765 # This is trying to use an xbuddy path in place of a path to an image.
joychendbfe6c92013-08-16 20:03:49 -0700766 xbuddy_label = self.forced_image.split(':')[1]
767 self.forced_image = None
joychen365a5742013-08-21 10:41:18 -0700768 # Make sure the xbuddy path target is in the directory.
769 path_to_payload, _image_name = self.xbuddy.Get(xbuddy_label.split('/'))
770 # Pretend to have called update with this update path to payload.
Chris Sosa54ef81e2013-08-27 16:45:12 -0700771 self.GetPathToPayload(xbuddy_label, client_version, board)
772 else:
773 src_path = os.path.abspath(self.forced_image)
774 if os.path.exists(src_path) and common_util.IsInsideChroot():
775 # Image was found for the given label. Generate update if we can.
Chris Sosa75490802013-09-30 17:21:45 -0700776 path_to_payload = self.GenerateUpdateImageWithCache(src_path)
777 # Add links from the static directory to the update.
778 cache_path = _NonePathJoin(self.static_dir, path_to_payload)
779 self._SymlinkUpdateFiles(cache_path, self.static_dir)
joychen121fc9b2013-08-02 14:30:30 -0700780 else:
781 label = label or ''
782 label_list = label.split('/')
783 # Suppose that the path follows old protocol of indexing straight
784 # into static_dir with board/version label.
785 # Attempt to get the update in that directory, generating if necc.
786 path_to_payload = self.GetUpdateForLabel(client_version, label)
787 if path_to_payload is None:
788 # There was no update or image found in the directory.
789 # Let XBuddy find an image, and then generate an update to it.
790 if label_list[0] == 'xbuddy':
791 # If path explicitly calls xbuddy, pop off the tag.
792 label_list.pop()
Chris Sosa75490802013-09-30 17:21:45 -0700793 x_label, image_name = self.xbuddy.Translate(label_list, board=board)
joychen121fc9b2013-08-02 14:30:30 -0700794 if image_name not in constants.ALL_IMAGES:
795 raise AutoupdateError(
796 "Use an image alias: dev, base, test, or recovery.")
797 # Path has been resolved, try to get the image.
798 path_to_payload = self.GetUpdateForLabel(client_version, x_label,
799 image_name)
800 if path_to_payload is None:
801 # Neither image nor update payload found after translation.
802 # Try to get an update to a test image from GS using the label.
803 path_to_payload, _image_name = self.xbuddy.Get(
804 ['remote', label, 'full_payload'])
805
806 # One of the above options should have gotten us a relative path.
807 if path_to_payload is None:
808 raise AutoupdateError('Failed to get an update for: %s' % label)
809 else:
Chris Sosa75490802013-09-30 17:21:45 -0700810 return path_to_payload
joychen121fc9b2013-08-02 14:30:30 -0700811
David Zeuthen52ccd012013-10-31 12:58:26 -0700812 @staticmethod
813 def _SignMetadataHash(private_key_path, metadata_hash):
814 """Signs metadata hash.
815
816 Signs a metadata hash with a private key. This includes padding the
817 hash with PKCS#1 v1.5 padding as well as an ASN.1 header.
818
819 Args:
820 private_key_path: The path to a private key to use for signing.
821 metadata_hash: A raw SHA-256 hash (32 bytes).
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700822
David Zeuthen52ccd012013-10-31 12:58:26 -0700823 Returns:
824 The raw signature.
825 """
826 args = ['openssl', 'rsautl', '-pkcs', '-sign', '-inkey', private_key_path]
827 padded_metadata_hash = ('\x30\x31\x30\x0d\x06\x09\x60\x86'
828 '\x48\x01\x65\x03\x04\x02\x01\x05'
829 '\x00\x04\x20') + metadata_hash
830 child = subprocess.Popen(args,
831 stdin=subprocess.PIPE,
832 stdout=subprocess.PIPE)
833 signature, _ = child.communicate(input=padded_metadata_hash)
834 return signature
835
joychen121fc9b2013-08-02 14:30:30 -0700836 def HandleUpdatePing(self, data, label=''):
Chris Sosa6a3697f2013-01-29 16:44:43 -0800837 """Handles an update ping from an update client.
838
839 Args:
840 data: XML blob from client.
841 label: optional label for the update.
Gilad Arnoldd8d595c2014-03-21 13:00:41 -0700842
Chris Sosa6a3697f2013-01-29 16:44:43 -0800843 Returns:
844 Update payload message for client.
845 """
846 # Get the static url base that will form that base of our update url e.g.
847 # http://hostname:8080/static/update.gz.
848 static_urlbase = self._GetStaticUrl()
849
850 # Parse the XML we got into the components we care about.
851 protocol, app, event, update_check = autoupdate_lib.ParseUpdateRequest(data)
852
Chris Sosab26b1202013-08-16 16:40:55 -0700853 # Process attributes of the update check.
Gilad Arnolde7819e72014-03-21 12:50:48 -0700854 request_attrs = self._ProcessUpdateComponents(app, event)
Chris Sosab26b1202013-08-16 16:40:55 -0700855
joychen121fc9b2013-08-02 14:30:30 -0700856 if not update_check:
Gilad Arnolde7819e72014-03-21 12:50:48 -0700857 if ((request_attrs.event_type ==
858 autoupdate_lib.EVENT_TYPE_UPDATE_DOWNLOAD_STARTED) and
859 request_attrs.event_result == autoupdate_lib.EVENT_RESULT_SUCCESS):
860 with self._update_count_lock:
861 if self.max_updates == 0:
862 _Log('Received too many download_started notifications. This '
863 'probably means a bug in the test environment, such as too '
864 'many clients running concurrently. Alternatively, it could '
865 'be a bug in the update client.')
866 elif self.max_updates > 0:
867 self.max_updates -= 1
joychen121fc9b2013-08-02 14:30:30 -0700868
Gilad Arnolde7819e72014-03-21 12:50:48 -0700869 _Log('A non-update event notification received. Returning an ack.')
870 return autoupdate_lib.GetEventResponse(protocol)
871
872 if request_attrs.forced_update_label:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800873 if label:
874 _Log('Label: %s set but being overwritten to %s by request', label,
Gilad Arnolde7819e72014-03-21 12:50:48 -0700875 request_attrs.forced_update_label)
876 label = request_attrs.forced_update_label
Chris Sosa6a3697f2013-01-29 16:44:43 -0800877
Gilad Arnolde7819e72014-03-21 12:50:48 -0700878 # Make sure that we did not already exceed the max number of allowed update
879 # responses. Note that the counter is only decremented when the client
880 # reports an actual download, to avoid race conditions between concurrent
881 # update requests from the same client due to a timeout.
joychen121fc9b2013-08-02 14:30:30 -0700882 if self.max_updates == 0:
Gilad Arnolde7819e72014-03-21 12:50:48 -0700883 _Log('Request received but max number of updates already served.')
joychen121fc9b2013-08-02 14:30:30 -0700884 return autoupdate_lib.GetNoUpdateResponse(protocol)
885
Gilad Arnolde7819e72014-03-21 12:50:48 -0700886 _Log('Update Check Received. Client is using protocol version: %s',
887 protocol)
joychen121fc9b2013-08-02 14:30:30 -0700888
Chris Sosa6a3697f2013-01-29 16:44:43 -0800889 # Finally its time to generate the omaha response to give to client that
890 # lets them know where to find the payload and its associated metadata.
891 metadata_obj = None
892
893 try:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700894 # Are we provisioning a remote or local payload?
895 if self.remote_payload:
Chris Sosa4b951602014-04-09 20:26:07 -0700896
897 self._CheckOmahaRequest(app)
898
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700899 # If no explicit label was provided, use the value of --payload.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800900 if not label:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700901 label = self.payload_path
Chris Sosa0356d3b2010-09-16 15:46:22 -0700902
Chris Sosa52f15bc2013-08-13 17:14:15 -0700903 # TODO(sosa): Remove backwards-compatible hack.
Chris Sosab26b1202013-08-16 16:40:55 -0700904 if not '.bin' in label:
Chris Sosa52f15bc2013-08-13 17:14:15 -0700905 url = _NonePathJoin(static_urlbase, label, 'update.gz')
906 else:
907 url = _NonePathJoin(static_urlbase, label)
Chris Sosa5d342a22010-09-28 16:54:41 -0700908
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700909 # Get remote payload attributes.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800910 metadata_obj = self._GetRemotePayloadAttrs(url)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700911 else:
Gilad Arnolde7819e72014-03-21 12:50:48 -0700912 path_to_payload = self.GetPathToPayload(
913 label, request_attrs.client_version, request_attrs.board)
joychen121fc9b2013-08-02 14:30:30 -0700914 url = _NonePathJoin(static_urlbase, path_to_payload,
joychen7c2054a2013-07-25 11:14:07 -0700915 constants.UPDATE_FILE)
joychen121fc9b2013-08-02 14:30:30 -0700916 local_payload_dir = _NonePathJoin(self.static_dir, path_to_payload)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800917 metadata_obj = self.GetLocalPayloadAttrs(local_payload_dir)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800918 except AutoupdateError as e:
919 # Raised if we fail to generate an update payload.
920 _Log('Failed to process an update: %r', e)
921 return autoupdate_lib.GetNoUpdateResponse(protocol)
922
David Zeuthen52ccd012013-10-31 12:58:26 -0700923 # Sign the metadata hash, if requested.
924 signed_metadata_hash = None
925 if self.private_key_for_metadata_hash_signature:
926 signed_metadata_hash = base64.b64encode(Autoupdate._SignMetadataHash(
927 self.private_key_for_metadata_hash_signature,
928 base64.b64decode(metadata_obj.metadata_hash)))
929
930 # Include public key, if requested.
931 public_key_data = None
932 if self.public_key:
933 public_key_data = base64.b64encode(open(self.public_key, 'r').read())
934
Chris Sosa4b951602014-04-09 20:26:07 -0700935 update_response = autoupdate_lib.GetUpdateResponse(
Chris Sosa6a3697f2013-01-29 16:44:43 -0800936 metadata_obj.sha1, metadata_obj.sha256, metadata_obj.size, url,
David Zeuthen52ccd012013-10-31 12:58:26 -0700937 metadata_obj.is_delta_format, metadata_obj.metadata_size,
938 signed_metadata_hash, public_key_data, protocol, self.critical_update)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700939
Gilad Arnolde7819e72014-03-21 12:50:48 -0700940 _Log('Responding to client to use url %s to get image', url)
Gilad Arnoldd0c71752013-12-06 11:48:45 -0800941 return update_response
942
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700943 def HandleHostInfoPing(self, ip):
944 """Returns host info dictionary for the given IP in JSON format."""
945 assert ip, 'No ip provided.'
Gilad Arnold286a0062012-01-12 13:47:02 -0800946 if ip in self.host_infos.table:
947 return json.dumps(self.host_infos.GetHostInfo(ip).attrs)
948
949 def HandleHostLogPing(self, ip):
950 """Returns a complete log of events for host in JSON format."""
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700951 # If all events requested, return a dictionary of logs keyed by IP address.
Gilad Arnold286a0062012-01-12 13:47:02 -0800952 if ip == 'all':
953 return json.dumps(
954 dict([(key, self.host_infos.table[key].log)
955 for key in self.host_infos.table]))
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700956
957 # Otherwise we're looking for a specific IP address, so find its log.
Gilad Arnold286a0062012-01-12 13:47:02 -0800958 if ip in self.host_infos.table:
959 return json.dumps(self.host_infos.GetHostInfo(ip).log)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700960
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700961 # If no events were logged for this IP, return an empty log.
962 return json.dumps([])
963
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700964 def HandleSetUpdatePing(self, ip, label):
965 """Sets forced_update_label for a given host."""
966 assert ip, 'No ip provided.'
967 assert label, 'No label provided.'
Gilad Arnold286a0062012-01-12 13:47:02 -0800968 self.host_infos.GetInitHostInfo(ip).attrs['forced_update_label'] = label