blob: 0bcbac7a28cc0a2fcdf9213c82382c605227c45f [file] [log] [blame]
Jooyung Han504105f2021-10-26 15:54:50 +09001#!/usr/bin/env python
2#
3# Copyright (C) 2021 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16"""sign_virt_apex is a command line tool for sign the Virt APEX file.
17
Jooyung Han98498f42022-02-07 15:23:08 +090018Typical usage:
Jooyung Han486609f2022-04-20 11:38:00 +090019 sign_virt_apex payload_key payload_dir
20 -v, --verbose
21 --verify
22 --avbtool path_to_avbtool
23 --signing_args args
Jooyung Han504105f2021-10-26 15:54:50 +090024
25sign_virt_apex uses external tools which are assumed to be available via PATH.
26- avbtool (--avbtool can override the tool)
Shikha Panwara7605cf2023-01-12 09:29:39 +000027- lpmake, lpunpack, simg2img, img2simg, initrd_bootconfig
Jooyung Han504105f2021-10-26 15:54:50 +090028"""
29import argparse
Alice Wang2a6caf12024-01-11 08:14:05 +000030import binascii
Nikita Ioffee1112032023-11-13 15:09:39 +000031import builtins
Jooyung Han02dceed2021-11-08 17:50:22 +090032import hashlib
Jooyung Han504105f2021-10-26 15:54:50 +090033import os
34import re
Jooyung Han98498f42022-02-07 15:23:08 +090035import shlex
Jooyung Han504105f2021-10-26 15:54:50 +090036import subprocess
37import sys
38import tempfile
Jooyung Han486609f2022-04-20 11:38:00 +090039import traceback
40from concurrent import futures
41
42# pylint: disable=line-too-long,consider-using-with
43
44# Use executor to parallelize the invocation of external tools
45# If a task depends on another, pass the future object of the previous task as wait list.
46# Every future object created by a task should be consumed with AwaitAll()
47# so that exceptions are propagated .
48executor = futures.ThreadPoolExecutor()
49
50# Temporary directory for unpacked super.img.
51# We could put its creation/deletion into the task graph as well, but
52# having it as a global setup is much simpler.
53unpack_dir = tempfile.TemporaryDirectory()
54
55# tasks created with Async() are kept in a list so that they are awaited
56# before exit.
57tasks = []
58
59# create an async task and return a future value of it.
60def Async(fn, *args, wait=None, **kwargs):
61
62 # wrap a function with AwaitAll()
63 def wrapped():
64 AwaitAll(wait)
65 fn(*args, **kwargs)
66
67 task = executor.submit(wrapped)
68 tasks.append(task)
69 return task
70
71
72# waits for task (captured in fs as future values) with future.result()
73# so that any exception raised during task can be raised upward.
74def AwaitAll(fs):
75 if fs:
76 for f in fs:
77 f.result()
Jooyung Han504105f2021-10-26 15:54:50 +090078
79
80def ParseArgs(argv):
81 parser = argparse.ArgumentParser(description='Sign the Virt APEX')
Jooyung Han02dceed2021-11-08 17:50:22 +090082 parser.add_argument('--verify', action='store_true',
83 help='Verify the Virt APEX')
Jooyung Han504105f2021-10-26 15:54:50 +090084 parser.add_argument(
85 '-v', '--verbose',
86 action='store_true',
87 help='verbose execution')
88 parser.add_argument(
89 '--avbtool',
90 default='avbtool',
91 help='Optional flag that specifies the AVB tool to use. Defaults to `avbtool`.')
92 parser.add_argument(
Jooyung Han98498f42022-02-07 15:23:08 +090093 '--signing_args',
94 help='the extra signing arguments passed to avbtool.'
95 )
96 parser.add_argument(
Jooyung Han1c3d2fa2022-02-24 02:35:59 +090097 '--key_override',
98 metavar="filename=key",
99 action='append',
100 help='Overrides a signing key for a file e.g. microdroid_bootloader=mykey (for testing)')
101 parser.add_argument(
Jooyung Han504105f2021-10-26 15:54:50 +0900102 'key',
103 help='path to the private key file.')
104 parser.add_argument(
105 'input_dir',
106 help='the directory having files to be packaged')
Shikha Panwara7605cf2023-01-12 09:29:39 +0000107 parser.add_argument(
108 '--do_not_update_bootconfigs',
109 action='store_true',
110 help='This will NOT update the vbmeta related bootconfigs while signing the apex.\
111 Used for testing only!!')
Nikita Ioffe314d7e32023-12-18 17:38:18 +0000112 parser.add_argument('--do_not_validate_avb_version', action='store_true', help='Do not validate the avb_version when updating vbmeta bootconfig. Only use in tests!')
Jooyung Han1c3d2fa2022-02-24 02:35:59 +0900113 args = parser.parse_args(argv)
114 # preprocess --key_override into a map
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900115 args.key_overrides = {}
Jooyung Han1c3d2fa2022-02-24 02:35:59 +0900116 if args.key_override:
117 for pair in args.key_override:
118 name, key = pair.split('=')
119 args.key_overrides[name] = key
120 return args
Jooyung Han504105f2021-10-26 15:54:50 +0900121
122
Jooyung Han486609f2022-04-20 11:38:00 +0900123def RunCommand(args, cmd, env=None, expected_return_values=None):
124 expected_return_values = expected_return_values or {0}
Jooyung Han504105f2021-10-26 15:54:50 +0900125 env = env or {}
126 env.update(os.environ.copy())
127
128 # TODO(b/193504286): we need a way to find other tool (cmd[0]) in various contexts
129 # e.g. sign_apex.py, sign_target_files_apk.py
130 if cmd[0] == 'avbtool':
131 cmd[0] = args.avbtool
132
133 if args.verbose:
134 print('Running: ' + ' '.join(cmd))
135 p = subprocess.Popen(
136 cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, env=env, universal_newlines=True)
137 output, _ = p.communicate()
138
139 if args.verbose or p.returncode not in expected_return_values:
140 print(output.rstrip())
141
142 assert p.returncode in expected_return_values, (
143 '%d Failed to execute: ' + ' '.join(cmd)) % p.returncode
144 return (output, p.returncode)
145
146
147def ReadBytesSize(value):
148 return int(value.removesuffix(' bytes'))
149
150
Jooyung Han832d11d2021-11-08 12:51:47 +0900151def ExtractAvbPubkey(args, key, output):
152 RunCommand(args, ['avbtool', 'extract_public_key',
153 '--key', key, '--output', output])
154
155
156def AvbInfo(args, image_path):
Jooyung Han504105f2021-10-26 15:54:50 +0900157 """Parses avbtool --info image output
158
159 Args:
160 args: program arguments.
161 image_path: The path to the image.
162 descriptor_name: Descriptor name of interest.
163
164 Returns:
165 A pair of
166 - a dict that contains VBMeta info. None if there's no VBMeta info.
Jooyung Han832d11d2021-11-08 12:51:47 +0900167 - a list of descriptors.
Jooyung Han504105f2021-10-26 15:54:50 +0900168 """
169 if not os.path.exists(image_path):
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900170 raise ValueError(f'Failed to find image: {image_path}')
Jooyung Han504105f2021-10-26 15:54:50 +0900171
172 output, ret_code = RunCommand(
173 args, ['avbtool', 'info_image', '--image', image_path], expected_return_values={0, 1})
174 if ret_code == 1:
175 return None, None
176
Jooyung Han832d11d2021-11-08 12:51:47 +0900177 info, descriptors = {}, []
Jooyung Han504105f2021-10-26 15:54:50 +0900178
179 # Read `avbtool info_image` output as "key:value" lines
180 matcher = re.compile(r'^(\s*)([^:]+):\s*(.*)$')
181
182 def IterateLine(output):
183 for line in output.split('\n'):
184 line_info = matcher.match(line)
185 if not line_info:
186 continue
187 yield line_info.group(1), line_info.group(2), line_info.group(3)
188
189 gen = IterateLine(output)
Jooyung Han832d11d2021-11-08 12:51:47 +0900190
191 def ReadDescriptors(cur_indent, cur_name, cur_value):
192 descriptor = cur_value if cur_name == 'Prop' else {}
193 descriptors.append((cur_name, descriptor))
194 for indent, key, value in gen:
195 if indent <= cur_indent:
196 # read descriptors recursively to pass the read key as descriptor name
197 ReadDescriptors(indent, key, value)
198 break
199 descriptor[key] = value
200
Jooyung Han504105f2021-10-26 15:54:50 +0900201 # Read VBMeta info
202 for _, key, value in gen:
203 if key == 'Descriptors':
Jooyung Han832d11d2021-11-08 12:51:47 +0900204 ReadDescriptors(*next(gen))
Jooyung Han504105f2021-10-26 15:54:50 +0900205 break
206 info[key] = value
207
Jooyung Han832d11d2021-11-08 12:51:47 +0900208 return info, descriptors
Jooyung Han504105f2021-10-26 15:54:50 +0900209
Jooyung Han832d11d2021-11-08 12:51:47 +0900210
Shikha Panwarc149d242023-01-20 16:23:04 +0000211# Look up a list of (key, value) with a key. Returns the list of value(s) with the matching key.
212# The order of those values is maintained.
Jooyung Han832d11d2021-11-08 12:51:47 +0900213def LookUp(pairs, key):
Shikha Panwarc149d242023-01-20 16:23:04 +0000214 return [v for (k, v) in pairs if k == key]
Jooyung Han504105f2021-10-26 15:54:50 +0900215
Seungjae Yoob18d1632024-01-10 11:08:19 +0900216# Extract properties from the descriptors of original vbmeta image,
217# append to command as parameter.
218def AppendPropArgument(cmd, descriptors):
219 for prop in LookUp(descriptors, 'Prop'):
220 cmd.append('--prop')
221 result = re.match(r"(.+) -> '(.+)'", prop)
222 cmd.append(result.group(1) + ":" + result.group(2))
Jooyung Han504105f2021-10-26 15:54:50 +0900223
Seungjae Yoo3f46c7f2024-01-10 14:32:54 +0900224
225def check_no_size_change_on_resigned_image(image_path, original_image_info, resigned_image_info):
226 assert original_image_info is not None, f'no avbinfo on original image: {image_path}'
227 assert resigned_image_info is not None, f'no avbinfo on resigned image: {image_path}'
Alice Wang2a6caf12024-01-11 08:14:05 +0000228 assert_same_value(original_image_info, resigned_image_info, "Header Block", image_path)
229 assert_same_value(original_image_info, resigned_image_info, "Authentication Block", image_path)
230 assert_same_value(original_image_info, resigned_image_info, "Auxiliary Block", image_path)
Seungjae Yoo3f46c7f2024-01-10 14:32:54 +0900231
Seungjae Yoo43574482024-01-11 16:27:51 +0900232def AddHashFooter(args, key, image_path, additional_images=None):
Jooyung Han1c3d2fa2022-02-24 02:35:59 +0900233 if os.path.basename(image_path) in args.key_overrides:
234 key = args.key_overrides[os.path.basename(image_path)]
Seungjae Yoob18d1632024-01-10 11:08:19 +0900235 info, descriptors = AvbInfo(args, image_path)
Jooyung Han504105f2021-10-26 15:54:50 +0900236 if info:
Seungjae Yoo43574482024-01-11 16:27:51 +0900237 # Extract hash descriptor of original image.
238 descs = {desc['Partition Name']:desc for desc in LookUp(descriptors, 'Hash descriptor')}
239 if additional_images:
240 for additional_image in additional_images:
241 _, additional_desc = AvbInfo(args, additional_image)
242 del descs[LookUp(additional_desc, 'Hash descriptor')[0]['Partition Name']]
243 assert len(descs) == 1, \
244 f'multiple hash descriptors except additional descriptors exist in {image_path}'
245 original_image_descriptor = list(descs.values())[0]
246
Jooyung Han504105f2021-10-26 15:54:50 +0900247 image_size = ReadBytesSize(info['Image size'])
248 algorithm = info['Algorithm']
Seungjae Yoo43574482024-01-11 16:27:51 +0900249 original_image_partition_name = original_image_descriptor['Partition Name']
250 original_image_salt = original_image_descriptor['Salt']
Jooyung Han504105f2021-10-26 15:54:50 +0900251 partition_size = str(image_size)
252
253 cmd = ['avbtool', 'add_hash_footer',
254 '--key', key,
255 '--algorithm', algorithm,
Seungjae Yoo43574482024-01-11 16:27:51 +0900256 '--partition_name', original_image_partition_name,
257 '--salt', original_image_salt,
Jooyung Han504105f2021-10-26 15:54:50 +0900258 '--partition_size', partition_size,
259 '--image', image_path]
Seungjae Yoob18d1632024-01-10 11:08:19 +0900260 AppendPropArgument(cmd, descriptors)
Jooyung Han98498f42022-02-07 15:23:08 +0900261 if args.signing_args:
262 cmd.extend(shlex.split(args.signing_args))
Seungjae Yoo43574482024-01-11 16:27:51 +0900263 if additional_images:
264 for additional_image in additional_images:
265 cmd.extend(['--include_descriptors_from_image', additional_image])
Shikha Panwar2a788662023-09-11 14:04:24 +0000266
267 if 'Rollback Index' in info:
268 cmd.extend(['--rollback_index', info['Rollback Index']])
Jooyung Han504105f2021-10-26 15:54:50 +0900269 RunCommand(args, cmd)
Seungjae Yoo3f46c7f2024-01-10 14:32:54 +0900270 resigned_info, _ = AvbInfo(args, image_path)
271 check_no_size_change_on_resigned_image(image_path, info, resigned_info)
Jooyung Han504105f2021-10-26 15:54:50 +0900272
273def AddHashTreeFooter(args, key, image_path):
Jooyung Han1c3d2fa2022-02-24 02:35:59 +0900274 if os.path.basename(image_path) in args.key_overrides:
275 key = args.key_overrides[os.path.basename(image_path)]
Jooyung Han832d11d2021-11-08 12:51:47 +0900276 info, descriptors = AvbInfo(args, image_path)
Jooyung Han504105f2021-10-26 15:54:50 +0900277 if info:
Shikha Panwarc149d242023-01-20 16:23:04 +0000278 descriptor = LookUp(descriptors, 'Hashtree descriptor')[0]
Jooyung Han504105f2021-10-26 15:54:50 +0900279 image_size = ReadBytesSize(info['Image size'])
280 algorithm = info['Algorithm']
281 partition_name = descriptor['Partition Name']
Shikha Panwar638119b2023-01-03 06:00:26 +0000282 hash_algorithm = descriptor['Hash Algorithm']
Seungjae Yoo43574482024-01-11 16:27:51 +0900283 salt = descriptor['Salt']
Jooyung Han504105f2021-10-26 15:54:50 +0900284 partition_size = str(image_size)
Jooyung Han504105f2021-10-26 15:54:50 +0900285 cmd = ['avbtool', 'add_hashtree_footer',
286 '--key', key,
287 '--algorithm', algorithm,
288 '--partition_name', partition_name,
289 '--partition_size', partition_size,
290 '--do_not_generate_fec',
Shikha Panwar638119b2023-01-03 06:00:26 +0000291 '--hash_algorithm', hash_algorithm,
Seungjae Yoo43574482024-01-11 16:27:51 +0900292 '--salt', salt,
Jooyung Han504105f2021-10-26 15:54:50 +0900293 '--image', image_path]
Seungjae Yoob18d1632024-01-10 11:08:19 +0900294 AppendPropArgument(cmd, descriptors)
Jooyung Han98498f42022-02-07 15:23:08 +0900295 if args.signing_args:
296 cmd.extend(shlex.split(args.signing_args))
Jooyung Han504105f2021-10-26 15:54:50 +0900297 RunCommand(args, cmd)
Seungjae Yoo3f46c7f2024-01-10 14:32:54 +0900298 resigned_info, _ = AvbInfo(args, image_path)
299 check_no_size_change_on_resigned_image(image_path, info, resigned_info)
Jooyung Han504105f2021-10-26 15:54:50 +0900300
301
Shikha Panwara7605cf2023-01-12 09:29:39 +0000302def UpdateVbmetaBootconfig(args, initrds, vbmeta_img):
303 # Update the bootconfigs in ramdisk
304 def detach_bootconfigs(initrd_bc, initrd, bc):
305 cmd = ['initrd_bootconfig', 'detach', initrd_bc, initrd, bc]
306 RunCommand(args, cmd)
307
308 def attach_bootconfigs(initrd_bc, initrd, bc):
309 cmd = ['initrd_bootconfig', 'attach',
310 initrd, bc, '--output', initrd_bc]
311 RunCommand(args, cmd)
312
313 # Validate that avb version used while signing the apex is the same as used by build server
314 def validate_avb_version(bootconfigs):
315 cmd = ['avbtool', 'version']
316 stdout, _ = RunCommand(args, cmd)
317 avb_version_curr = stdout.split(" ")[1].strip()
318 avb_version_curr = avb_version_curr[0:avb_version_curr.rfind('.')]
319
320 avb_version_bc = re.search(
321 r"androidboot.vbmeta.avb_version = \"([^\"]*)\"", bootconfigs).group(1)
322 if avb_version_curr != avb_version_bc:
Nikita Ioffee1112032023-11-13 15:09:39 +0000323 raise builtins.Exception(f'AVB version mismatch between current & one & \
Shikha Panwara7605cf2023-01-12 09:29:39 +0000324 used to build bootconfigs:{avb_version_curr}&{avb_version_bc}')
325
326 def calc_vbmeta_digest():
327 cmd = ['avbtool', 'calculate_vbmeta_digest', '--image',
328 vbmeta_img, '--hash_algorithm', 'sha256']
329 stdout, _ = RunCommand(args, cmd)
330 return stdout.strip()
331
332 def calc_vbmeta_size():
333 cmd = ['avbtool', 'info_image', '--image', vbmeta_img]
334 stdout, _ = RunCommand(args, cmd)
335 size = 0
336 for line in stdout.split("\n"):
337 line = line.split(":")
338 if line[0] in ['Header Block', 'Authentication Block', 'Auxiliary Block']:
339 size += int(line[1].strip()[0:-6])
340 return size
341
342 def update_vbmeta_digest(bootconfigs):
343 # Update androidboot.vbmeta.digest in bootconfigs
344 result = re.search(
345 r"androidboot.vbmeta.digest = \"[^\"]*\"", bootconfigs)
346 if not result:
347 raise ValueError("Failed to find androidboot.vbmeta.digest")
348
349 return bootconfigs.replace(result.group(),
350 f'androidboot.vbmeta.digest = "{calc_vbmeta_digest()}"')
351
352 def update_vbmeta_size(bootconfigs):
353 # Update androidboot.vbmeta.size in bootconfigs
354 result = re.search(r"androidboot.vbmeta.size = [0-9]+", bootconfigs)
355 if not result:
356 raise ValueError("Failed to find androidboot.vbmeta.size")
357 return bootconfigs.replace(result.group(),
358 f'androidboot.vbmeta.size = {calc_vbmeta_size()}')
359
360 with tempfile.TemporaryDirectory() as work_dir:
361 tmp_initrd = os.path.join(work_dir, 'initrd')
362 tmp_bc = os.path.join(work_dir, 'bc')
363
364 for initrd in initrds:
365 detach_bootconfigs(initrd, tmp_initrd, tmp_bc)
366 bc_file = open(tmp_bc, "rt", encoding="utf-8")
367 bc_data = bc_file.read()
Nikita Ioffe314d7e32023-12-18 17:38:18 +0000368 if not args.do_not_validate_avb_version:
369 validate_avb_version(bc_data)
Shikha Panwara7605cf2023-01-12 09:29:39 +0000370 bc_data = update_vbmeta_digest(bc_data)
371 bc_data = update_vbmeta_size(bc_data)
372 bc_file.close()
373 bc_file = open(tmp_bc, "wt", encoding="utf-8")
374 bc_file.write(bc_data)
375 bc_file.flush()
376 attach_bootconfigs(initrd, tmp_initrd, tmp_bc)
377
378
Jooyung Han832d11d2021-11-08 12:51:47 +0900379def MakeVbmetaImage(args, key, vbmeta_img, images=None, chained_partitions=None):
Jooyung Han1c3d2fa2022-02-24 02:35:59 +0900380 if os.path.basename(vbmeta_img) in args.key_overrides:
381 key = args.key_overrides[os.path.basename(vbmeta_img)]
Jooyung Han832d11d2021-11-08 12:51:47 +0900382 info, descriptors = AvbInfo(args, vbmeta_img)
383 if info is None:
384 return
385
Jooyung Han486609f2022-04-20 11:38:00 +0900386 with tempfile.TemporaryDirectory() as work_dir:
Jooyung Han504105f2021-10-26 15:54:50 +0900387 algorithm = info['Algorithm']
388 rollback_index = info['Rollback Index']
389 rollback_index_location = info['Rollback Index Location']
390
391 cmd = ['avbtool', 'make_vbmeta_image',
392 '--key', key,
393 '--algorithm', algorithm,
394 '--rollback_index', rollback_index,
395 '--rollback_index_location', rollback_index_location,
396 '--output', vbmeta_img]
Jooyung Han832d11d2021-11-08 12:51:47 +0900397 if images:
398 for img in images:
399 cmd.extend(['--include_descriptors_from_image', img])
400
401 # replace pubkeys of chained_partitions as well
402 for name, descriptor in descriptors:
403 if name == 'Chain Partition descriptor':
404 part_name = descriptor['Partition Name']
405 ril = descriptor['Rollback Index Location']
406 part_key = chained_partitions[part_name]
407 avbpubkey = os.path.join(work_dir, part_name + '.avbpubkey')
408 ExtractAvbPubkey(args, part_key, avbpubkey)
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900409 cmd.extend(['--chain_partition', f'{part_name}:{ril}:{avbpubkey}'])
Jooyung Han832d11d2021-11-08 12:51:47 +0900410
Jooyung Han98498f42022-02-07 15:23:08 +0900411 if args.signing_args:
412 cmd.extend(shlex.split(args.signing_args))
413
Jooyung Han504105f2021-10-26 15:54:50 +0900414 RunCommand(args, cmd)
Seungjae Yoo3f46c7f2024-01-10 14:32:54 +0900415 resigned_info, _ = AvbInfo(args, vbmeta_img)
416 check_no_size_change_on_resigned_image(vbmeta_img, info, resigned_info)
Jooyung Han504105f2021-10-26 15:54:50 +0900417 # libavb expects to be able to read the maximum vbmeta size, so we must provide a partition
418 # which matches this or the read will fail.
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900419 with open(vbmeta_img, 'a', encoding='utf8') as f:
Jooyung Handcb0b492022-02-26 09:04:17 +0900420 f.truncate(65536)
Jooyung Han504105f2021-10-26 15:54:50 +0900421
422
Jooyung Han486609f2022-04-20 11:38:00 +0900423def UnpackSuperImg(args, super_img, work_dir):
424 tmp_super_img = os.path.join(work_dir, 'super.img')
425 RunCommand(args, ['simg2img', super_img, tmp_super_img])
426 RunCommand(args, ['lpunpack', tmp_super_img, work_dir])
Jooyung Han504105f2021-10-26 15:54:50 +0900427
428
429def MakeSuperImage(args, partitions, output):
Jooyung Han486609f2022-04-20 11:38:00 +0900430 with tempfile.TemporaryDirectory() as work_dir:
Jooyung Han504105f2021-10-26 15:54:50 +0900431 cmd = ['lpmake', '--device-size=auto', '--metadata-slots=2', # A/B
432 '--metadata-size=65536', '--sparse', '--output=' + output]
433
434 for part, img in partitions.items():
435 tmp_img = os.path.join(work_dir, part)
436 RunCommand(args, ['img2simg', img, tmp_img])
437
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900438 image_arg = f'--image={part}={img}'
439 partition_arg = f'--partition={part}:readonly:{os.path.getsize(img)}:default'
Jooyung Han504105f2021-10-26 15:54:50 +0900440 cmd.extend([image_arg, partition_arg])
441
442 RunCommand(args, cmd)
443
444
Seungjae Yoo43574482024-01-11 16:27:51 +0900445def GenVbmetaImage(args, image, output, partition_name, salt):
Shikha Panwarc149d242023-01-20 16:23:04 +0000446 cmd = ['avbtool', 'add_hash_footer', '--dynamic_partition_size',
447 '--do_not_append_vbmeta_image',
448 '--partition_name', partition_name,
Seungjae Yoo43574482024-01-11 16:27:51 +0900449 '--salt', salt,
Shikha Panwarc149d242023-01-20 16:23:04 +0000450 '--image', image,
451 '--output_vbmeta_image', output]
452 RunCommand(args, cmd)
453
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900454
Inseob Kim0276f612023-12-07 17:25:18 +0900455gki_versions = ['android14-6.1']
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900456
Jooyung Han486609f2022-04-20 11:38:00 +0900457# dict of (key, file) for re-sign/verification. keys are un-versioned for readability.
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900458virt_apex_non_gki_files = {
Shikha Panwara7605cf2023-01-12 09:29:39 +0000459 'kernel': 'etc/fs/microdroid_kernel',
Jooyung Han486609f2022-04-20 11:38:00 +0900460 'vbmeta.img': 'etc/fs/microdroid_vbmeta.img',
Shikha Panwara7605cf2023-01-12 09:29:39 +0000461 'super.img': 'etc/fs/microdroid_super.img',
462 'initrd_normal.img': 'etc/microdroid_initrd_normal.img',
463 'initrd_debuggable.img': 'etc/microdroid_initrd_debuggable.img',
Alice Wangbe8330c2023-10-19 08:55:07 +0000464 'rialto': 'etc/rialto.bin',
Jooyung Han486609f2022-04-20 11:38:00 +0900465}
466
Jooyung Han486609f2022-04-20 11:38:00 +0900467def TargetFiles(input_dir):
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900468 ret = {k: os.path.join(input_dir, v) for k, v in virt_apex_non_gki_files.items()}
469
470 for ver in gki_versions:
471 kernel = os.path.join(input_dir, f'etc/fs/microdroid_gki-{ver}_kernel')
472 initrd_normal = os.path.join(input_dir, f'etc/microdroid_gki-{ver}_initrd_normal.img')
473 initrd_debug = os.path.join(input_dir, f'etc/microdroid_gki-{ver}_initrd_debuggable.img')
474
475 if os.path.isfile(kernel):
476 ret[f'gki-{ver}_kernel'] = kernel
477 ret[f'gki-{ver}_initrd_normal.img'] = initrd_normal
478 ret[f'gki-{ver}_initrd_debuggable.img'] = initrd_debug
479
480 return ret
481
482def IsInitrdImage(path):
483 return path.endswith('initrd_normal.img') or path.endswith('initrd_debuggable.img')
Jooyung Han486609f2022-04-20 11:38:00 +0900484
485
Jooyung Han504105f2021-10-26 15:54:50 +0900486def SignVirtApex(args):
487 key = args.key
488 input_dir = args.input_dir
Jooyung Han486609f2022-04-20 11:38:00 +0900489 files = TargetFiles(input_dir)
Jooyung Han504105f2021-10-26 15:54:50 +0900490
Jooyung Han486609f2022-04-20 11:38:00 +0900491 # unpacked files (will be unpacked from super.img below)
492 system_a_img = os.path.join(unpack_dir.name, 'system_a.img')
Nikita Ioffee1112032023-11-13 15:09:39 +0000493 vendor_a_img = os.path.join(unpack_dir.name, 'vendor_a.img')
Jooyung Han504105f2021-10-26 15:54:50 +0900494
Jooyung Han504105f2021-10-26 15:54:50 +0900495 # re-sign super.img
Jooyung Hanbae6ce42022-09-13 15:15:18 +0900496 # 1. unpack super.img
Nikita Ioffee1112032023-11-13 15:09:39 +0000497 # 2. resign system and vendor (if exists)
498 # 3. repack super.img out of resigned system and vendor (if exists)
Jooyung Hanbae6ce42022-09-13 15:15:18 +0900499 UnpackSuperImg(args, files['super.img'], unpack_dir.name)
500 system_a_f = Async(AddHashTreeFooter, args, key, system_a_img)
Nikita Ioffebaf578d2023-06-14 20:29:37 +0000501 partitions = {"system_a": system_a_img}
Nikita Ioffee1112032023-11-13 15:09:39 +0000502 images = [system_a_img]
503 images_f = [system_a_f]
504
505 # if vendor_a.img exists, resign it
506 if os.path.exists(vendor_a_img):
507 partitions.update({'vendor_a': vendor_a_img})
508 images.append(vendor_a_img)
509 vendor_a_f = Async(AddHashTreeFooter, args, key, vendor_a_img)
510 images_f.append(vendor_a_f)
511
Shikha Panwara7605cf2023-01-12 09:29:39 +0000512 Async(MakeSuperImage, args, partitions,
Nikita Ioffee1112032023-11-13 15:09:39 +0000513 files['super.img'], wait=images_f)
Jooyung Han504105f2021-10-26 15:54:50 +0900514
Nikita Ioffebaf578d2023-06-14 20:29:37 +0000515 # re-generate vbmeta from re-signed system_a.img
Shikha Panwara7605cf2023-01-12 09:29:39 +0000516 vbmeta_f = Async(MakeVbmetaImage, args, key, files['vbmeta.img'],
Nikita Ioffee1112032023-11-13 15:09:39 +0000517 images=images,
518 wait=images_f)
Jooyung Han504105f2021-10-26 15:54:50 +0900519
Shikha Panwarc149d242023-01-20 16:23:04 +0000520 vbmeta_bc_f = None
Shikha Panwara7605cf2023-01-12 09:29:39 +0000521 if not args.do_not_update_bootconfigs:
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900522 initrd_files = [v for k, v in files.items() if IsInitrdImage(k)]
Inseob Kim77c7f712023-11-06 17:01:02 +0900523 vbmeta_bc_f = Async(UpdateVbmetaBootconfig, args, initrd_files,
524 files['vbmeta.img'],
Shikha Panwarc149d242023-01-20 16:23:04 +0000525 wait=[vbmeta_f])
Jooyung Han832d11d2021-11-08 12:51:47 +0900526
Shikha Panwarc149d242023-01-20 16:23:04 +0000527 # Re-sign kernel. Note kernel's vbmeta contain addition descriptor from ramdisk(s)
Inseob Kim77c7f712023-11-06 17:01:02 +0900528 def resign_kernel(kernel, initrd_normal, initrd_debug):
529 kernel_file = files[kernel]
530 initrd_normal_file = files[initrd_normal]
531 initrd_debug_file = files[initrd_debug]
532
Seungjae Yoo43574482024-01-11 16:27:51 +0900533 _, kernel_image_descriptors = AvbInfo(args, kernel_file)
534 salts = {desc['Partition Name']:desc['Salt'] for desc in LookUp(kernel_image_descriptors, 'Hash descriptor')}
Inseob Kim77c7f712023-11-06 17:01:02 +0900535 initrd_normal_hashdesc = tempfile.NamedTemporaryFile(delete=False).name
536 initrd_debug_hashdesc = tempfile.NamedTemporaryFile(delete=False).name
537 initrd_n_f = Async(GenVbmetaImage, args, initrd_normal_file,
Seungjae Yoo43574482024-01-11 16:27:51 +0900538 initrd_normal_hashdesc, "initrd_normal", salts["initrd_normal"],
Inseob Kim77c7f712023-11-06 17:01:02 +0900539 wait=[vbmeta_bc_f] if vbmeta_bc_f is not None else [])
540 initrd_d_f = Async(GenVbmetaImage, args, initrd_debug_file,
Seungjae Yoo43574482024-01-11 16:27:51 +0900541 initrd_debug_hashdesc, "initrd_debug", salts["initrd_debug"],
Inseob Kim77c7f712023-11-06 17:01:02 +0900542 wait=[vbmeta_bc_f] if vbmeta_bc_f is not None else [])
Alice Wang2a6caf12024-01-11 08:14:05 +0000543 return Async(AddHashFooter, args, key, kernel_file,
544 additional_images=[initrd_normal_hashdesc, initrd_debug_hashdesc],
Inseob Kim77c7f712023-11-06 17:01:02 +0900545 wait=[initrd_n_f, initrd_d_f])
546
Alice Wang2a6caf12024-01-11 08:14:05 +0000547 _, original_kernel_descriptors = AvbInfo(args, files['kernel'])
548 resign_kernel_task = resign_kernel('kernel', 'initrd_normal.img', 'initrd_debuggable.img')
Inseob Kim77c7f712023-11-06 17:01:02 +0900549
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900550 for ver in gki_versions:
551 if f'gki-{ver}_kernel' in files:
552 resign_kernel(
553 f'gki-{ver}_kernel',
554 f'gki-{ver}_initrd_normal.img',
555 f'gki-{ver}_initrd_debuggable.img')
Jooyung Han832d11d2021-11-08 12:51:47 +0900556
Alice Wangbe8330c2023-10-19 08:55:07 +0000557 # Re-sign rialto if it exists. Rialto only exists in arm64 environment.
558 if os.path.exists(files['rialto']):
Alice Wang2a6caf12024-01-11 08:14:05 +0000559 update_kernel_hashes_task = Async(
560 update_initrd_hashes_in_rialto, original_kernel_descriptors, args,
561 files, wait=[resign_kernel_task])
562 Async(resign_rialto, args, key, files['rialto'], wait=[update_kernel_hashes_task])
Alice Wangbe8330c2023-10-19 08:55:07 +0000563
Alice Wang2a6caf12024-01-11 08:14:05 +0000564def resign_rialto(args, key, rialto_path):
565 original_info, original_descriptors = AvbInfo(args, rialto_path)
566 AddHashFooter(args, key, rialto_path)
567
568 # Verify the new AVB footer.
569 updated_info, updated_descriptors = AvbInfo(args, rialto_path)
570 assert_same_value(original_info, updated_info, "Original image size", "rialto")
571 original_descriptor = find_hash_descriptor_by_partition_name(original_descriptors, 'boot')
572 updated_descriptor = find_hash_descriptor_by_partition_name(updated_descriptors, 'boot')
573 # Since salt is not updated, the change of digest reflects the change of content of rialto
574 # kernel.
575 assert_same_value(original_descriptor, updated_descriptor, "Salt", "rialto_hash_descriptor")
576 if not args.do_not_update_bootconfigs:
577 assert_different_value(original_descriptor, updated_descriptor, "Digest",
578 "rialto_hash_descriptor")
579
580def assert_same_value(original, updated, key, context):
581 assert original[key] == updated[key], \
582 f"Value of '{key}' should not change for '{context}'" \
583 f"Original value: {original[key]}, updated value: {updated[key]}"
584
585def assert_different_value(original, updated, key, context):
586 assert original[key] != updated[key], \
587 f"Value of '{key}' should change for '{context}'" \
588 f"Original value: {original[key]}, updated value: {updated[key]}"
589
590def update_initrd_hashes_in_rialto(original_descriptors, args, files):
591 _, updated_descriptors = AvbInfo(args, files['kernel'])
592
593 original_kernel_descriptor = find_hash_descriptor_by_partition_name(
594 original_descriptors, 'boot')
595 updated_kernel_descriptor = find_hash_descriptor_by_partition_name(
596 updated_descriptors, 'boot')
597 assert_same_value(original_kernel_descriptor, updated_kernel_descriptor,
598 "Digest", "microdroid_kernel_hash_descriptor")
599
600 # Update the hashes of initrd_normal and initrd_debug in rialto if the
601 # bootconfigs in them are updated.
602 if args.do_not_update_bootconfigs:
603 return
604
605 with open(files['rialto'], "rb") as file:
606 content = file.read()
607
608 partition_names = ['initrd_normal', 'initrd_debug']
609 all_digests = set()
610 for partition_name in partition_names:
611 original_descriptor = find_hash_descriptor_by_partition_name(
612 original_descriptors, partition_name)
613 update_descriptor = find_hash_descriptor_by_partition_name(
614 updated_descriptors, partition_name)
615
616 original_digest = binascii.unhexlify(original_descriptor['Digest'])
617 updated_digest = binascii.unhexlify(update_descriptor['Digest'])
618 assert len(original_digest) == len(updated_digest), \
619 f"Length of original_digest and updated_digest must be the same for {partition_name}." \
620 f" Original digest: {original_digest}, updated digest: {updated_digest}"
621 assert original_digest != updated_digest, \
622 f"Digest of the partition {partition_name} should change. " \
623 f"Original digest: {original_digest}, updated digest: {updated_digest}"
624 all_digests.add(original_digest)
625 all_digests.add(updated_digest)
626
627 new_content = content.replace(original_digest, updated_digest)
628 assert len(new_content) == len(content), \
629 "Length of new_content and content must be the same."
630 assert new_content != content, \
631 f"original digest of the partition {partition_name} not found. " \
632 f"Original descriptor: {original_descriptor}"
633 content = new_content
634
635 assert len(all_digests) == len(partition_names) * 2, \
636 f"There should be {len(partition_names) * 2} different digests for the original and " \
637 f"updated descriptors for initrd. Original descriptors: {original_descriptors}, " \
638 f"updated descriptors: {updated_descriptors}"
639
640 with open(files['rialto'], "wb") as file:
641 file.write(content)
642
643def find_hash_descriptor_by_partition_name(descriptors, partition_name):
644 """Find the hash descriptor of the partition in the descriptors."""
645 for descriptor_type, descriptor in descriptors:
646 if descriptor_type == 'Hash descriptor' and descriptor['Partition Name'] == partition_name:
647 return descriptor
648 assert False, f'Failed to find hash descriptor for partition {partition_name}'
Jooyung Han504105f2021-10-26 15:54:50 +0900649
Jooyung Han02dceed2021-11-08 17:50:22 +0900650def VerifyVirtApex(args):
Jooyung Han486609f2022-04-20 11:38:00 +0900651 key = args.key
652 input_dir = args.input_dir
653 files = TargetFiles(input_dir)
Jooyung Han02dceed2021-11-08 17:50:22 +0900654
Jooyung Han486609f2022-04-20 11:38:00 +0900655 # unpacked files
656 UnpackSuperImg(args, files['super.img'], unpack_dir.name)
657 system_a_img = os.path.join(unpack_dir.name, 'system_a.img')
Jooyung Han02dceed2021-11-08 17:50:22 +0900658
Jooyung Han486609f2022-04-20 11:38:00 +0900659 # Read pubkey digest from the input key
660 with tempfile.NamedTemporaryFile() as pubkey_file:
661 ExtractAvbPubkey(args, key, pubkey_file.name)
662 with open(pubkey_file.name, 'rb') as f:
663 pubkey = f.read()
664 pubkey_digest = hashlib.sha1(pubkey).hexdigest()
Jooyung Han02dceed2021-11-08 17:50:22 +0900665
Jooyung Han486609f2022-04-20 11:38:00 +0900666 def check_avb_pubkey(file):
667 info, _ = AvbInfo(args, file)
Jiyong Park40bf2dc2022-05-23 23:41:25 +0900668 assert info is not None, f'no avbinfo: {file}'
669 assert info['Public key (sha1)'] == pubkey_digest, f'pubkey mismatch: {file}'
Jooyung Han486609f2022-04-20 11:38:00 +0900670
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900671 for k, f in files.items():
672 if IsInitrdImage(k):
Shikha Panwara7605cf2023-01-12 09:29:39 +0000673 # TODO(b/245277660): Verify that ramdisks contain the correct vbmeta digest
674 continue
Alice Wangbe8330c2023-10-19 08:55:07 +0000675 if k == 'rialto' and not os.path.exists(f):
676 # Rialto only exists in arm64 environment.
677 continue
Inseob Kim7a1fc8f2023-11-22 18:45:28 +0900678 if k == 'super.img':
Jooyung Han486609f2022-04-20 11:38:00 +0900679 Async(check_avb_pubkey, system_a_img)
Jooyung Han486609f2022-04-20 11:38:00 +0900680 else:
681 # Check pubkey for other files using avbtool
682 Async(check_avb_pubkey, f)
Jooyung Han02dceed2021-11-08 17:50:22 +0900683
684
Jooyung Han504105f2021-10-26 15:54:50 +0900685def main(argv):
686 try:
687 args = ParseArgs(argv)
Jooyung Han02dceed2021-11-08 17:50:22 +0900688 if args.verify:
689 VerifyVirtApex(args)
690 else:
691 SignVirtApex(args)
Jooyung Han486609f2022-04-20 11:38:00 +0900692 # ensure all tasks are completed without exceptions
693 AwaitAll(tasks)
Shikha Panwara7605cf2023-01-12 09:29:39 +0000694 except: # pylint: disable=bare-except
Jooyung Han486609f2022-04-20 11:38:00 +0900695 traceback.print_exc()
Jooyung Han504105f2021-10-26 15:54:50 +0900696 sys.exit(1)
697
698
699if __name__ == '__main__':
700 main(sys.argv[1:])