blob: 890cb51c25a74b9c93a69bbf55450716453016c4 [file] [log] [blame]
Doug Zongkereef39442009-04-02 12:14:19 -07001#!/usr/bin/env python
2#
3# Copyright (C) 2008 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
17"""
18Signs all the APK files in a target-files zipfile, producing a new
19target-files zip.
20
21Usage: sign_target_files_apks [flags] input_target_files output_target_files
22
Doug Zongkereef39442009-04-02 12:14:19 -070023 -e (--extra_apks) <name,name,...=key>
Tao Baoaa7e9932019-03-15 09:37:01 -070024 Add extra APK/APEX name/key pairs as though they appeared in apkcerts.txt
25 or apexkeys.txt (so mappings specified by -k and -d are applied). Keys
26 specified in -e override any value for that app contained in the
27 apkcerts.txt file, or the container key for an APEX. Option may be
28 repeated to give multiple extra packages.
29
30 --extra_apex_payload_key <name=key>
31 Add a mapping for APEX package name to payload signing key, which will
32 override the default payload signing key in apexkeys.txt. Note that the
33 container key should be overridden via the `--extra_apks` flag above.
34 Option may be repeated for multiple APEXes.
Doug Zongkereef39442009-04-02 12:14:19 -070035
Tao Bao93c2a012018-06-19 12:19:35 -070036 --skip_apks_with_path_prefix <prefix>
37 Skip signing an APK if it has the matching prefix in its path. The prefix
38 should be matching the entry name, which has partition names in upper
39 case, e.g. "VENDOR/app/", or "SYSTEM_OTHER/preloads/". Option may be
40 repeated to give multiple prefixes.
41
Doug Zongkereef39442009-04-02 12:14:19 -070042 -k (--key_mapping) <src_key=dest_key>
43 Add a mapping from the key name as specified in apkcerts.txt (the
44 src_key) to the real key you wish to sign the package with
45 (dest_key). Option may be repeated to give multiple key
46 mappings.
47
48 -d (--default_key_mappings) <dir>
49 Set up the following key mappings:
50
Doug Zongker831840e2011-09-22 10:28:04 -070051 $devkey/devkey ==> $dir/releasekey
52 $devkey/testkey ==> $dir/releasekey
53 $devkey/media ==> $dir/media
54 $devkey/shared ==> $dir/shared
55 $devkey/platform ==> $dir/platform
56
57 where $devkey is the directory part of the value of
58 default_system_dev_certificate from the input target-files's
Dan Willemsen0ab1be62019-04-09 21:35:37 -070059 META/misc_info.txt. (Defaulting to "build/make/target/product/security"
Doug Zongker831840e2011-09-22 10:28:04 -070060 if the value is not present in misc_info.
Doug Zongkereef39442009-04-02 12:14:19 -070061
62 -d and -k options are added to the set of mappings in the order
63 in which they appear on the command line.
Doug Zongker8e931bf2009-04-06 15:21:45 -070064
65 -o (--replace_ota_keys)
Tao Baoa80ed222016-06-16 14:41:24 -070066 Replace the certificate (public key) used by OTA package verification
67 with the ones specified in the input target_files zip (in the
68 META/otakeys.txt file). Key remapping (-k and -d) is performed on the
69 keys. For A/B devices, the payload verification key will be replaced
70 as well. If there're multiple OTA keys, only the first one will be used
71 for payload verification.
Doug Zongker17aa9442009-04-17 10:15:58 -070072
Doug Zongkerae877012009-04-21 10:04:51 -070073 -t (--tag_changes) <+tag>,<-tag>,...
74 Comma-separated list of changes to make to the set of tags (in
75 the last component of the build fingerprint). Prefix each with
76 '+' or '-' to indicate whether that tag should be added or
77 removed. Changes are processed in the order they appear.
Doug Zongker831840e2011-09-22 10:28:04 -070078 Default value is "-test-keys,-dev-keys,+release-keys".
Doug Zongkerae877012009-04-21 10:04:51 -070079
Tao Bao8adcfd12016-06-17 17:01:22 -070080 --replace_verity_private_key <key>
81 Replace the private key used for verity signing. It expects a filename
82 WITHOUT the extension (e.g. verity_key).
83
84 --replace_verity_public_key <key>
85 Replace the certificate (public key) used for verity verification. The
86 key file replaces the one at BOOT/RAMDISK/verity_key (or ROOT/verity_key
87 for devices using system_root_image). It expects the key filename WITH
88 the extension (e.g. verity_key.pub).
89
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -070090 --replace_verity_keyid <path_to_X509_PEM_cert_file>
91 Replace the veritykeyid in BOOT/cmdline of input_target_file_zip
Tao Bao8adcfd12016-06-17 17:01:22 -070092 with keyid of the cert pointed by <path_to_X509_PEM_cert_file>.
Tao Bao639118f2017-06-19 15:48:02 -070093
Bowgo Tsai2fe786a2020-02-21 17:48:18 +080094 --remove_avb_public_keys <key1>,<key2>,...
95 Remove AVB public keys from the first-stage ramdisk. The key file to
96 remove is located at either of the following dirs:
97 - BOOT/RAMDISK/avb/ or
98 - BOOT/RAMDISK/first_stage_ramdisk/avb/
99 The second dir will be used for lookup if BOARD_USES_RECOVERY_AS_BOOT is
100 set to true.
101
Tao Baod6085d62019-05-06 12:55:42 -0700102 --avb_{boot,system,system_other,vendor,dtbo,vbmeta,vbmeta_system,
103 vbmeta_vendor}_algorithm <algorithm>
104 --avb_{boot,system,system_other,vendor,dtbo,vbmeta,vbmeta_system,
105 vbmeta_vendor}_key <key>
Tao Bao639118f2017-06-19 15:48:02 -0700106 Use the specified algorithm (e.g. SHA256_RSA4096) and the key to AVB-sign
107 the specified image. Otherwise it uses the existing values in info dict.
108
Tao Baod6085d62019-05-06 12:55:42 -0700109 --avb_{apex,boot,system,system_other,vendor,dtbo,vbmeta,vbmeta_system,
110 vbmeta_vendor}_extra_args <args>
Tao Bao639118f2017-06-19 15:48:02 -0700111 Specify any additional args that are needed to AVB-sign the image
112 (e.g. "--signing_helper /path/to/helper"). The args will be appended to
113 the existing ones in info dict.
Tianjie Xu88a759d2020-01-23 10:47:54 -0800114
Hongguang Chenf23364d2020-04-27 18:36:36 -0700115 --avb_extra_custom_image_key <partition=key>
116 --avb_extra_custom_image_algorithm <partition=algorithm>
117 Use the specified algorithm (e.g. SHA256_RSA4096) and the key to AVB-sign
118 the specified custom images mounted on the partition. Otherwise it uses
119 the existing values in info dict.
120
121 --avb_extra_custom_image_extra_args <partition=extra_args>
122 Specify any additional args that are needed to AVB-sign the custom images
123 mounted on the partition (e.g. "--signing_helper /path/to/helper"). The
124 args will be appended to the existing ones in info dict.
125
Tianjie Xu88a759d2020-01-23 10:47:54 -0800126 --android_jar_path <path>
127 Path to the android.jar to repack the apex file.
Doug Zongkereef39442009-04-02 12:14:19 -0700128"""
129
Tao Bao0c28d2d2017-12-24 10:37:38 -0800130from __future__ import print_function
Doug Zongkereef39442009-04-02 12:14:19 -0700131
Robert Craig817c5742013-04-19 10:59:22 -0400132import base64
Doug Zongker8e931bf2009-04-06 15:21:45 -0700133import copy
Robert Craig817c5742013-04-19 10:59:22 -0400134import errno
Narayan Kamatha07bf042017-08-14 14:49:21 +0100135import gzip
Tao Baobb733882019-07-24 23:31:19 -0700136import io
Tao Baoaa7e9932019-03-15 09:37:01 -0700137import itertools
Tao Baobadceb22019-03-15 09:33:43 -0700138import logging
Doug Zongkereef39442009-04-02 12:14:19 -0700139import os
140import re
Narayan Kamatha07bf042017-08-14 14:49:21 +0100141import shutil
Tao Bao9fdd00f2017-07-12 11:57:05 -0700142import stat
Doug Zongkereef39442009-04-02 12:14:19 -0700143import subprocess
Tao Bao0c28d2d2017-12-24 10:37:38 -0800144import sys
Doug Zongkereef39442009-04-02 12:14:19 -0700145import tempfile
146import zipfile
Tao Bao66472632017-12-04 17:16:36 -0800147from xml.etree import ElementTree
Doug Zongkereef39442009-04-02 12:14:19 -0700148
Doug Zongker3c84f562014-07-31 11:06:30 -0700149import add_img_to_target_files
Tao Baoaa7e9932019-03-15 09:37:01 -0700150import apex_utils
Doug Zongkereef39442009-04-02 12:14:19 -0700151import common
152
Tao Bao0c28d2d2017-12-24 10:37:38 -0800153
154if sys.hexversion < 0x02070000:
155 print("Python 2.7 or newer is required.", file=sys.stderr)
156 sys.exit(1)
157
158
Tao Baobadceb22019-03-15 09:33:43 -0700159logger = logging.getLogger(__name__)
160
Doug Zongkereef39442009-04-02 12:14:19 -0700161OPTIONS = common.OPTIONS
162
163OPTIONS.extra_apks = {}
Tao Baoaa7e9932019-03-15 09:37:01 -0700164OPTIONS.extra_apex_payload_keys = {}
Tao Bao93c2a012018-06-19 12:19:35 -0700165OPTIONS.skip_apks_with_path_prefix = set()
Doug Zongkereef39442009-04-02 12:14:19 -0700166OPTIONS.key_map = {}
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700167OPTIONS.rebuild_recovery = False
Doug Zongker8e931bf2009-04-06 15:21:45 -0700168OPTIONS.replace_ota_keys = False
Geremy Condraf19b3652014-07-29 17:54:54 -0700169OPTIONS.replace_verity_public_key = False
170OPTIONS.replace_verity_private_key = False
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700171OPTIONS.replace_verity_keyid = False
Bowgo Tsai2fe786a2020-02-21 17:48:18 +0800172OPTIONS.remove_avb_public_keys = None
Doug Zongker831840e2011-09-22 10:28:04 -0700173OPTIONS.tag_changes = ("-test-keys", "-dev-keys", "+release-keys")
Tao Bao639118f2017-06-19 15:48:02 -0700174OPTIONS.avb_keys = {}
175OPTIONS.avb_algorithms = {}
176OPTIONS.avb_extra_args = {}
Tianjie Xu88a759d2020-01-23 10:47:54 -0800177OPTIONS.android_jar_path = None
Doug Zongkereef39442009-04-02 12:14:19 -0700178
Tao Bao0c28d2d2017-12-24 10:37:38 -0800179
Tao Bao19b02fe2019-10-09 00:04:28 -0700180AVB_FOOTER_ARGS_BY_PARTITION = {
181 'boot' : 'avb_boot_add_hash_footer_args',
182 'dtbo' : 'avb_dtbo_add_hash_footer_args',
183 'recovery' : 'avb_recovery_add_hash_footer_args',
184 'system' : 'avb_system_add_hashtree_footer_args',
185 'system_other' : 'avb_system_other_add_hashtree_footer_args',
186 'vendor' : 'avb_vendor_add_hashtree_footer_args',
187 'vendor_boot' : 'avb_vendor_boot_add_hash_footer_args',
188 'vbmeta' : 'avb_vbmeta_args',
189 'vbmeta_system' : 'avb_vbmeta_system_args',
190 'vbmeta_vendor' : 'avb_vbmeta_vendor_args',
191}
192
193
Narayan Kamatha07bf042017-08-14 14:49:21 +0100194def GetApkCerts(certmap):
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800195 # apply the key remapping to the contents of the file
Tao Baoa3705452019-06-24 15:33:41 -0700196 for apk, cert in certmap.items():
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800197 certmap[apk] = OPTIONS.key_map.get(cert, cert)
198
199 # apply all the -e options, overriding anything in the file
Tao Baoa3705452019-06-24 15:33:41 -0700200 for apk, cert in OPTIONS.extra_apks.items():
Doug Zongkerdecf9952009-12-15 17:27:49 -0800201 if not cert:
202 cert = "PRESIGNED"
Doug Zongkerad88c7c2009-04-14 12:34:27 -0700203 certmap[apk] = OPTIONS.key_map.get(cert, cert)
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800204
Doug Zongkereef39442009-04-02 12:14:19 -0700205 return certmap
206
207
Tao Baoaa7e9932019-03-15 09:37:01 -0700208def GetApexKeys(keys_info, key_map):
209 """Gets APEX payload and container signing keys by applying the mapping rules.
210
Tao Baoe1343992019-03-19 12:24:03 -0700211 Presigned payload / container keys will be set accordingly.
Tao Baoaa7e9932019-03-15 09:37:01 -0700212
213 Args:
214 keys_info: A dict that maps from APEX filenames to a tuple of (payload_key,
215 container_key).
216 key_map: A dict that overrides the keys, specified via command-line input.
217
218 Returns:
219 A dict that contains the updated APEX key mapping, which should be used for
220 the current signing.
Tao Baof98fa102019-04-24 14:51:25 -0700221
222 Raises:
223 AssertionError: On invalid container / payload key overrides.
Tao Baoaa7e9932019-03-15 09:37:01 -0700224 """
225 # Apply all the --extra_apex_payload_key options to override the payload
226 # signing keys in the given keys_info.
227 for apex, key in OPTIONS.extra_apex_payload_keys.items():
Tao Baoe1343992019-03-19 12:24:03 -0700228 if not key:
229 key = 'PRESIGNED'
Tao Bao34223092019-07-11 11:52:52 -0700230 if apex not in keys_info:
231 logger.warning('Failed to find %s in target_files; Ignored', apex)
232 continue
Tao Baoaa7e9932019-03-15 09:37:01 -0700233 keys_info[apex] = (key, keys_info[apex][1])
234
235 # Apply the key remapping to container keys.
236 for apex, (payload_key, container_key) in keys_info.items():
237 keys_info[apex] = (payload_key, key_map.get(container_key, container_key))
238
239 # Apply all the --extra_apks options to override the container keys.
240 for apex, key in OPTIONS.extra_apks.items():
241 # Skip non-APEX containers.
242 if apex not in keys_info:
243 continue
Tao Baoe1343992019-03-19 12:24:03 -0700244 if not key:
245 key = 'PRESIGNED'
Tao Baofa9de0a2019-03-18 10:24:17 -0700246 keys_info[apex] = (keys_info[apex][0], key_map.get(key, key))
Tao Baoaa7e9932019-03-15 09:37:01 -0700247
Tao Baof98fa102019-04-24 14:51:25 -0700248 # A PRESIGNED container entails a PRESIGNED payload. Apply this to all the
249 # APEX key pairs. However, a PRESIGNED container with non-PRESIGNED payload
250 # (overridden via commandline) indicates a config error, which should not be
251 # allowed.
252 for apex, (payload_key, container_key) in keys_info.items():
253 if container_key != 'PRESIGNED':
254 continue
255 if apex in OPTIONS.extra_apex_payload_keys:
256 payload_override = OPTIONS.extra_apex_payload_keys[apex]
257 assert payload_override == '', \
258 ("Invalid APEX key overrides: {} has PRESIGNED container but "
259 "non-PRESIGNED payload key {}").format(apex, payload_override)
260 if payload_key != 'PRESIGNED':
261 print(
262 "Setting {} payload as PRESIGNED due to PRESIGNED container".format(
263 apex))
264 keys_info[apex] = ('PRESIGNED', 'PRESIGNED')
265
Tao Baoaa7e9932019-03-15 09:37:01 -0700266 return keys_info
267
268
Tao Bao93c2a012018-06-19 12:19:35 -0700269def GetApkFileInfo(filename, compressed_extension, skipped_prefixes):
Tao Bao11f955c2018-06-19 12:19:35 -0700270 """Returns the APK info based on the given filename.
271
272 Checks if the given filename (with path) looks like an APK file, by taking the
Tao Bao93c2a012018-06-19 12:19:35 -0700273 compressed extension into consideration. If it appears to be an APK file,
274 further checks if the APK file should be skipped when signing, based on the
275 given path prefixes.
Tao Bao11f955c2018-06-19 12:19:35 -0700276
277 Args:
278 filename: Path to the file.
279 compressed_extension: The extension string of compressed APKs (e.g. ".gz"),
280 or None if there's no compressed APKs.
Tao Bao93c2a012018-06-19 12:19:35 -0700281 skipped_prefixes: A set/list/tuple of the path prefixes to be skipped.
Tao Bao11f955c2018-06-19 12:19:35 -0700282
283 Returns:
Tao Bao93c2a012018-06-19 12:19:35 -0700284 (is_apk, is_compressed, should_be_skipped): is_apk indicates whether the
285 given filename is an APK file. is_compressed indicates whether the APK file
286 is compressed (only meaningful when is_apk is True). should_be_skipped
287 indicates whether the filename matches any of the given prefixes to be
288 skipped.
Tao Bao11f955c2018-06-19 12:19:35 -0700289
290 Raises:
Tao Bao93c2a012018-06-19 12:19:35 -0700291 AssertionError: On invalid compressed_extension or skipped_prefixes inputs.
Tao Bao11f955c2018-06-19 12:19:35 -0700292 """
293 assert compressed_extension is None or compressed_extension.startswith('.'), \
294 "Invalid compressed_extension arg: '{}'".format(compressed_extension)
295
Tao Bao93c2a012018-06-19 12:19:35 -0700296 # skipped_prefixes should be one of set/list/tuple types. Other types such as
297 # str shouldn't be accepted.
Tao Baobadceb22019-03-15 09:33:43 -0700298 assert isinstance(skipped_prefixes, (set, list, tuple)), \
299 "Invalid skipped_prefixes input type: {}".format(type(skipped_prefixes))
Tao Bao93c2a012018-06-19 12:19:35 -0700300
Tao Bao11f955c2018-06-19 12:19:35 -0700301 compressed_apk_extension = (
302 ".apk" + compressed_extension if compressed_extension else None)
303 is_apk = (filename.endswith(".apk") or
304 (compressed_apk_extension and
305 filename.endswith(compressed_apk_extension)))
306 if not is_apk:
Tao Bao93c2a012018-06-19 12:19:35 -0700307 return (False, False, False)
Tao Bao11f955c2018-06-19 12:19:35 -0700308
309 is_compressed = (compressed_apk_extension and
310 filename.endswith(compressed_apk_extension))
Tao Bao93c2a012018-06-19 12:19:35 -0700311 should_be_skipped = filename.startswith(tuple(skipped_prefixes))
312 return (True, is_compressed, should_be_skipped)
Tao Bao11f955c2018-06-19 12:19:35 -0700313
314
Tao Baoaa7e9932019-03-15 09:37:01 -0700315def CheckApkAndApexKeysAvailable(input_tf_zip, known_keys,
Tao Baoe1343992019-03-19 12:24:03 -0700316 compressed_extension, apex_keys):
Tao Baoaa7e9932019-03-15 09:37:01 -0700317 """Checks that all the APKs and APEXes have keys specified.
Tao Bao11f955c2018-06-19 12:19:35 -0700318
319 Args:
320 input_tf_zip: An open target_files zip file.
Tao Baoaa7e9932019-03-15 09:37:01 -0700321 known_keys: A set of APKs and APEXes that have known signing keys.
Tao Bao11f955c2018-06-19 12:19:35 -0700322 compressed_extension: The extension string of compressed APKs, such as
Tao Baoaa7e9932019-03-15 09:37:01 -0700323 '.gz', or None if there's no compressed APKs.
Tao Baoe1343992019-03-19 12:24:03 -0700324 apex_keys: A dict that contains the key mapping from APEX name to
325 (payload_key, container_key).
Tao Bao11f955c2018-06-19 12:19:35 -0700326
327 Raises:
Tao Baoaa7e9932019-03-15 09:37:01 -0700328 AssertionError: On finding unknown APKs and APEXes.
Tao Bao11f955c2018-06-19 12:19:35 -0700329 """
Tao Baoaa7e9932019-03-15 09:37:01 -0700330 unknown_files = []
Doug Zongkereb338ef2009-05-20 16:50:49 -0700331 for info in input_tf_zip.infolist():
Tao Baoaa7e9932019-03-15 09:37:01 -0700332 # Handle APEXes first, e.g. SYSTEM/apex/com.android.tzdata.apex.
333 if (info.filename.startswith('SYSTEM/apex') and
334 info.filename.endswith('.apex')):
335 name = os.path.basename(info.filename)
336 if name not in known_keys:
337 unknown_files.append(name)
338 continue
339
340 # And APKs.
Tao Bao93c2a012018-06-19 12:19:35 -0700341 (is_apk, is_compressed, should_be_skipped) = GetApkFileInfo(
342 info.filename, compressed_extension, OPTIONS.skip_apks_with_path_prefix)
343 if not is_apk or should_be_skipped:
Tao Bao11f955c2018-06-19 12:19:35 -0700344 continue
Tao Baoaa7e9932019-03-15 09:37:01 -0700345
Tao Bao11f955c2018-06-19 12:19:35 -0700346 name = os.path.basename(info.filename)
347 if is_compressed:
348 name = name[:-len(compressed_extension)]
Tao Baoaa7e9932019-03-15 09:37:01 -0700349 if name not in known_keys:
350 unknown_files.append(name)
Tao Bao11f955c2018-06-19 12:19:35 -0700351
Tao Baoaa7e9932019-03-15 09:37:01 -0700352 assert not unknown_files, \
Tao Bao11f955c2018-06-19 12:19:35 -0700353 ("No key specified for:\n {}\n"
354 "Use '-e <apkname>=' to specify a key (which may be an empty string to "
Tao Baoaa7e9932019-03-15 09:37:01 -0700355 "not sign this apk).".format("\n ".join(unknown_files)))
Doug Zongkereb338ef2009-05-20 16:50:49 -0700356
Tao Baoe1343992019-03-19 12:24:03 -0700357 # For all the APEXes, double check that we won't have an APEX that has only
Tao Baof98fa102019-04-24 14:51:25 -0700358 # one of the payload / container keys set. Note that non-PRESIGNED container
359 # with PRESIGNED payload could be allowed but currently unsupported. It would
360 # require changing SignApex implementation.
Tao Baoe1343992019-03-19 12:24:03 -0700361 if not apex_keys:
362 return
363
364 invalid_apexes = []
365 for info in input_tf_zip.infolist():
366 if (not info.filename.startswith('SYSTEM/apex') or
367 not info.filename.endswith('.apex')):
368 continue
369
370 name = os.path.basename(info.filename)
371 (payload_key, container_key) = apex_keys[name]
372 if ((payload_key in common.SPECIAL_CERT_STRINGS and
373 container_key not in common.SPECIAL_CERT_STRINGS) or
374 (payload_key not in common.SPECIAL_CERT_STRINGS and
375 container_key in common.SPECIAL_CERT_STRINGS)):
376 invalid_apexes.append(
377 "{}: payload_key {}, container_key {}".format(
378 name, payload_key, container_key))
379
380 assert not invalid_apexes, \
381 "Invalid APEX keys specified:\n {}\n".format(
382 "\n ".join(invalid_apexes))
383
Doug Zongkereb338ef2009-05-20 16:50:49 -0700384
Narayan Kamatha07bf042017-08-14 14:49:21 +0100385def SignApk(data, keyname, pw, platform_api_level, codename_to_api_level_map,
Oleg Aravin8046cb02020-06-02 16:02:38 -0700386 is_compressed, apk_name):
387 unsigned = tempfile.NamedTemporaryFile(suffix='_' + apk_name)
Doug Zongkereef39442009-04-02 12:14:19 -0700388 unsigned.write(data)
389 unsigned.flush()
390
Narayan Kamatha07bf042017-08-14 14:49:21 +0100391 if is_compressed:
392 uncompressed = tempfile.NamedTemporaryFile()
Tao Bao0c28d2d2017-12-24 10:37:38 -0800393 with gzip.open(unsigned.name, "rb") as in_file, \
394 open(uncompressed.name, "wb") as out_file:
Narayan Kamatha07bf042017-08-14 14:49:21 +0100395 shutil.copyfileobj(in_file, out_file)
396
397 # Finally, close the "unsigned" file (which is gzip compressed), and then
398 # replace it with the uncompressed version.
399 #
400 # TODO(narayan): All this nastiness can be avoided if python 3.2 is in use,
401 # we could just gzip / gunzip in-memory buffers instead.
402 unsigned.close()
403 unsigned = uncompressed
404
Oleg Aravin8046cb02020-06-02 16:02:38 -0700405 signed = tempfile.NamedTemporaryFile(suffix='_' + apk_name)
Doug Zongkereef39442009-04-02 12:14:19 -0700406
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800407 # For pre-N builds, don't upgrade to SHA-256 JAR signatures based on the APK's
408 # minSdkVersion to avoid increasing incremental OTA update sizes. If an APK
409 # didn't change, we don't want its signature to change due to the switch
410 # from SHA-1 to SHA-256.
411 # By default, APK signer chooses SHA-256 signatures if the APK's minSdkVersion
412 # is 18 or higher. For pre-N builds we disable this mechanism by pretending
413 # that the APK's minSdkVersion is 1.
414 # For N+ builds, we let APK signer rely on the APK's minSdkVersion to
415 # determine whether to use SHA-256.
416 min_api_level = None
417 if platform_api_level > 23:
418 # Let APK signer choose whether to use SHA-1 or SHA-256, based on the APK's
419 # minSdkVersion attribute
420 min_api_level = None
421 else:
422 # Force APK signer to use SHA-1
423 min_api_level = 1
424
425 common.SignFile(unsigned.name, signed.name, keyname, pw,
Tao Bao0c28d2d2017-12-24 10:37:38 -0800426 min_api_level=min_api_level,
427 codename_to_api_level_map=codename_to_api_level_map)
Doug Zongkereef39442009-04-02 12:14:19 -0700428
Tao Bao0c28d2d2017-12-24 10:37:38 -0800429 data = None
Narayan Kamatha07bf042017-08-14 14:49:21 +0100430 if is_compressed:
431 # Recompress the file after it has been signed.
432 compressed = tempfile.NamedTemporaryFile()
Tao Bao0c28d2d2017-12-24 10:37:38 -0800433 with open(signed.name, "rb") as in_file, \
434 gzip.open(compressed.name, "wb") as out_file:
Narayan Kamatha07bf042017-08-14 14:49:21 +0100435 shutil.copyfileobj(in_file, out_file)
436
437 data = compressed.read()
438 compressed.close()
439 else:
440 data = signed.read()
441
Doug Zongkereef39442009-04-02 12:14:19 -0700442 unsigned.close()
443 signed.close()
444
445 return data
446
Kelvin Zhang119f2792021-02-10 12:45:24 -0500447def IsBuildPropFile(filename):
448 return filename in (
449 "SYSTEM/etc/prop.default",
450 "BOOT/RAMDISK/prop.default",
451 "RECOVERY/RAMDISK/prop.default",
452
453 "VENDOR_BOOT/RAMDISK/default.prop",
454 "VENDOR_BOOT/RAMDISK/prop.default",
455
456 # ROOT/default.prop is a legacy path, but may still exist for upgrading
457 # devices that don't support `property_overrides_split_enabled`.
458 "ROOT/default.prop",
459
460 # RECOVERY/RAMDISK/default.prop is a legacy path, but will always exist
461 # as a symlink in the current code. So it's a no-op here. Keeping the
462 # path here for clarity.
463 "RECOVERY/RAMDISK/default.prop") or filename.endswith("build.prop")
Doug Zongkereef39442009-04-02 12:14:19 -0700464
Doug Zongker412c02f2014-02-13 10:58:24 -0800465def ProcessTargetFiles(input_tf_zip, output_tf_zip, misc_info,
Tao Baoaa7e9932019-03-15 09:37:01 -0700466 apk_keys, apex_keys, key_passwords,
467 platform_api_level, codename_to_api_level_map,
Narayan Kamatha07bf042017-08-14 14:49:21 +0100468 compressed_extension):
Tao Bao93c2a012018-06-19 12:19:35 -0700469 # maxsize measures the maximum filename length, including the ones to be
470 # skipped.
Tao Bao0c28d2d2017-12-24 10:37:38 -0800471 maxsize = max(
472 [len(os.path.basename(i.filename)) for i in input_tf_zip.infolist()
Tao Bao93c2a012018-06-19 12:19:35 -0700473 if GetApkFileInfo(i.filename, compressed_extension, [])[0]])
Tao Baoa80ed222016-06-16 14:41:24 -0700474 system_root_image = misc_info.get("system_root_image") == "true"
Doug Zongker412c02f2014-02-13 10:58:24 -0800475
Doug Zongkereef39442009-04-02 12:14:19 -0700476 for info in input_tf_zip.infolist():
Tao Bao11f955c2018-06-19 12:19:35 -0700477 filename = info.filename
478 if filename.startswith("IMAGES/"):
Dan Albert8b72aef2015-03-23 19:13:21 -0700479 continue
Doug Zongker3c84f562014-07-31 11:06:30 -0700480
Tao Bao04808502019-07-25 23:11:41 -0700481 # Skip OTA-specific images (e.g. split super images), which will be
482 # re-generated during signing.
Tao Bao33bf2682019-01-11 12:37:35 -0800483 if filename.startswith("OTA/") and filename.endswith(".img"):
484 continue
485
Tao Bao11f955c2018-06-19 12:19:35 -0700486 data = input_tf_zip.read(filename)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700487 out_info = copy.copy(info)
Tao Bao93c2a012018-06-19 12:19:35 -0700488 (is_apk, is_compressed, should_be_skipped) = GetApkFileInfo(
489 filename, compressed_extension, OPTIONS.skip_apks_with_path_prefix)
490
491 if is_apk and should_be_skipped:
492 # Copy skipped APKs verbatim.
493 print(
494 "NOT signing: %s\n"
495 " (skipped due to matching prefix)" % (filename,))
496 common.ZipWriteStr(output_tf_zip, out_info, data)
Doug Zongker412c02f2014-02-13 10:58:24 -0800497
Tao Baof2cffbd2015-07-22 12:33:18 -0700498 # Sign APKs.
Tao Bao93c2a012018-06-19 12:19:35 -0700499 elif is_apk:
Tao Bao11f955c2018-06-19 12:19:35 -0700500 name = os.path.basename(filename)
Narayan Kamatha07bf042017-08-14 14:49:21 +0100501 if is_compressed:
502 name = name[:-len(compressed_extension)]
503
Tao Baoaa7e9932019-03-15 09:37:01 -0700504 key = apk_keys[name]
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800505 if key not in common.SPECIAL_CERT_STRINGS:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800506 print(" signing: %-*s (%s)" % (maxsize, name, key))
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800507 signed_data = SignApk(data, key, key_passwords[key], platform_api_level,
Oleg Aravin8046cb02020-06-02 16:02:38 -0700508 codename_to_api_level_map, is_compressed, name)
Tao Bao2ed665a2015-04-01 11:21:55 -0700509 common.ZipWriteStr(output_tf_zip, out_info, signed_data)
Doug Zongkereef39442009-04-02 12:14:19 -0700510 else:
511 # an APK we're not supposed to sign.
Tao Bao93c2a012018-06-19 12:19:35 -0700512 print(
513 "NOT signing: %s\n"
514 " (skipped due to special cert string)" % (name,))
Tao Bao2ed665a2015-04-01 11:21:55 -0700515 common.ZipWriteStr(output_tf_zip, out_info, data)
Tao Baoa80ed222016-06-16 14:41:24 -0700516
Tao Baoaa7e9932019-03-15 09:37:01 -0700517 # Sign bundled APEX files.
518 elif filename.startswith("SYSTEM/apex") and filename.endswith(".apex"):
519 name = os.path.basename(filename)
520 payload_key, container_key = apex_keys[name]
521
Tao Baoe1343992019-03-19 12:24:03 -0700522 # We've asserted not having a case with only one of them PRESIGNED.
523 if (payload_key not in common.SPECIAL_CERT_STRINGS and
524 container_key not in common.SPECIAL_CERT_STRINGS):
525 print(" signing: %-*s container (%s)" % (
526 maxsize, name, container_key))
527 print(" : %-*s payload (%s)" % (
528 maxsize, name, payload_key))
Tao Baoaa7e9932019-03-15 09:37:01 -0700529
Tao Baoe7354ba2019-05-09 16:54:15 -0700530 signed_apex = apex_utils.SignApex(
Tao Bao1ac886e2019-06-26 11:58:22 -0700531 misc_info['avb_avbtool'],
Tao Baoe1343992019-03-19 12:24:03 -0700532 data,
533 payload_key,
534 container_key,
Oleh Cherpake555ab12020-10-05 17:04:59 +0300535 key_passwords,
Tianjie Xu88a759d2020-01-23 10:47:54 -0800536 apk_keys,
Tao Baoe1343992019-03-19 12:24:03 -0700537 codename_to_api_level_map,
Tao Bao448004a2019-09-19 07:55:02 -0700538 no_hashtree=True,
539 signing_args=OPTIONS.avb_extra_args.get('apex'))
Tao Baoe1343992019-03-19 12:24:03 -0700540 common.ZipWrite(output_tf_zip, signed_apex, filename)
Tao Baoaa7e9932019-03-15 09:37:01 -0700541
Tao Baoe1343992019-03-19 12:24:03 -0700542 else:
543 print(
544 "NOT signing: %s\n"
545 " (skipped due to special cert string)" % (name,))
546 common.ZipWriteStr(output_tf_zip, out_info, data)
Tao Baoaa7e9932019-03-15 09:37:01 -0700547
548 # AVB public keys for the installed APEXes, which will be updated later.
549 elif (os.path.dirname(filename) == 'SYSTEM/etc/security/apex' and
550 filename != 'SYSTEM/etc/security/apex/'):
551 continue
552
Tao Baoa80ed222016-06-16 14:41:24 -0700553 # System properties.
Kelvin Zhang119f2792021-02-10 12:45:24 -0500554 elif IsBuildPropFile(filename):
Tao Bao11f955c2018-06-19 12:19:35 -0700555 print("Rewriting %s:" % (filename,))
Hung-ying Tyan7eb6a922017-05-01 21:56:26 +0800556 if stat.S_ISLNK(info.external_attr >> 16):
557 new_data = data
558 else:
Tao Baoa3705452019-06-24 15:33:41 -0700559 new_data = RewriteProps(data.decode())
Tao Bao2ed665a2015-04-01 11:21:55 -0700560 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700561
Tao Bao66472632017-12-04 17:16:36 -0800562 # Replace the certs in *mac_permissions.xml (there could be multiple, such
563 # as {system,vendor}/etc/selinux/{plat,nonplat}_mac_permissions.xml).
Tao Bao11f955c2018-06-19 12:19:35 -0700564 elif filename.endswith("mac_permissions.xml"):
565 print("Rewriting %s with new keys." % (filename,))
Tao Baoa3705452019-06-24 15:33:41 -0700566 new_data = ReplaceCerts(data.decode())
Tao Bao2ed665a2015-04-01 11:21:55 -0700567 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700568
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700569 # Ask add_img_to_target_files to rebuild the recovery patch if needed.
Tao Bao11f955c2018-06-19 12:19:35 -0700570 elif filename in ("SYSTEM/recovery-from-boot.p",
Robin Leeda427de2020-01-03 19:16:32 +0100571 "VENDOR/recovery-from-boot.p",
572
Tao Bao11f955c2018-06-19 12:19:35 -0700573 "SYSTEM/etc/recovery.img",
Robin Leeda427de2020-01-03 19:16:32 +0100574 "VENDOR/etc/recovery.img",
575
576 "SYSTEM/bin/install-recovery.sh",
577 "VENDOR/bin/install-recovery.sh"):
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700578 OPTIONS.rebuild_recovery = True
Tao Baoa80ed222016-06-16 14:41:24 -0700579
Tianjie Xuffbe6b92018-10-19 14:34:15 -0700580 # Don't copy OTA certs if we're replacing them.
Tianjie Xu2df23d72019-10-15 18:06:25 -0700581 # Replacement of update-payload-key.pub.pem was removed in b/116660991.
Kelvin Zhang9f781ff2021-02-11 19:10:44 -0500582 elif OPTIONS.replace_ota_keys and filename.endswith("/otacerts.zip"):
Doug Zongker412c02f2014-02-13 10:58:24 -0800583 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700584
Tao Bao46a59992017-06-05 11:55:16 -0700585 # Skip META/misc_info.txt since we will write back the new values later.
Tao Bao11f955c2018-06-19 12:19:35 -0700586 elif filename == "META/misc_info.txt":
Geremy Condraf19b3652014-07-29 17:54:54 -0700587 pass
Tao Bao8adcfd12016-06-17 17:01:22 -0700588
589 # Skip verity public key if we will replace it.
Michael Runge947894f2014-10-14 20:58:38 -0700590 elif (OPTIONS.replace_verity_public_key and
Tao Bao11f955c2018-06-19 12:19:35 -0700591 filename in ("BOOT/RAMDISK/verity_key",
592 "ROOT/verity_key")):
Geremy Condraf19b3652014-07-29 17:54:54 -0700593 pass
Bowgo Tsai2fe786a2020-02-21 17:48:18 +0800594 elif (OPTIONS.remove_avb_public_keys and
595 (filename.startswith("BOOT/RAMDISK/avb/") or
596 filename.startswith("BOOT/RAMDISK/first_stage_ramdisk/avb/"))):
Kelvin Zhang0876c412020-06-23 15:06:58 -0400597 matched_removal = False
598 for key_to_remove in OPTIONS.remove_avb_public_keys:
599 if filename.endswith(key_to_remove):
600 matched_removal = True
601 print("Removing AVB public key from ramdisk: %s" % filename)
602 break
603 if not matched_removal:
604 # Copy it verbatim if we don't want to remove it.
605 common.ZipWriteStr(output_tf_zip, out_info, data)
Tao Baoa80ed222016-06-16 14:41:24 -0700606
Tao Bao8adcfd12016-06-17 17:01:22 -0700607 # Skip verity keyid (for system_root_image use) if we will replace it.
Tao Bao11f955c2018-06-19 12:19:35 -0700608 elif OPTIONS.replace_verity_keyid and filename == "BOOT/cmdline":
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700609 pass
610
Tianjie Xu4f099002016-08-11 18:04:27 -0700611 # Skip the care_map as we will regenerate the system/vendor images.
Kelvin Zhang0876c412020-06-23 15:06:58 -0400612 elif filename in ["META/care_map.pb", "META/care_map.txt"]:
Tianjie Xu4f099002016-08-11 18:04:27 -0700613 pass
614
Kelvin Zhang5f0fcee2021-01-19 15:30:46 -0500615 # Skip apex_info.pb because we sign/modify apexes
616 elif filename == "META/apex_info.pb":
617 pass
618
Bowgo Tsaie4544b12019-02-27 10:15:51 +0800619 # Updates system_other.avbpubkey in /product/etc/.
620 elif filename in (
621 "PRODUCT/etc/security/avb/system_other.avbpubkey",
622 "SYSTEM/product/etc/security/avb/system_other.avbpubkey"):
623 # Only update system_other's public key, if the corresponding signing
624 # key is specified via --avb_system_other_key.
625 signing_key = OPTIONS.avb_keys.get("system_other")
626 if signing_key:
Tao Bao1ac886e2019-06-26 11:58:22 -0700627 public_key = common.ExtractAvbPublicKey(
628 misc_info['avb_avbtool'], signing_key)
Bowgo Tsaie4544b12019-02-27 10:15:51 +0800629 print(" Rewriting AVB public key of system_other in /product")
630 common.ZipWrite(output_tf_zip, public_key, filename)
631
Bowgo Tsai78369eb2019-04-23 12:28:44 +0800632 # Should NOT sign boot-debug.img.
633 elif filename in (
634 "BOOT/RAMDISK/force_debuggable",
Bowgo Tsai2fe786a2020-02-21 17:48:18 +0800635 "BOOT/RAMDISK/first_stage_ramdisk/force_debuggable"):
Bowgo Tsai78369eb2019-04-23 12:28:44 +0800636 raise common.ExternalError("debuggable boot.img cannot be signed")
637
Tao Baoa80ed222016-06-16 14:41:24 -0700638 # A non-APK file; copy it verbatim.
Doug Zongkereef39442009-04-02 12:14:19 -0700639 else:
Tao Bao2ed665a2015-04-01 11:21:55 -0700640 common.ZipWriteStr(output_tf_zip, out_info, data)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700641
Doug Zongker412c02f2014-02-13 10:58:24 -0800642 if OPTIONS.replace_ota_keys:
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700643 ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info)
Doug Zongker412c02f2014-02-13 10:58:24 -0800644
Tao Bao46a59992017-06-05 11:55:16 -0700645 # Replace the keyid string in misc_info dict.
Tao Bao8adcfd12016-06-17 17:01:22 -0700646 if OPTIONS.replace_verity_private_key:
Tao Bao46a59992017-06-05 11:55:16 -0700647 ReplaceVerityPrivateKey(misc_info, OPTIONS.replace_verity_private_key[1])
Tao Bao8adcfd12016-06-17 17:01:22 -0700648
649 if OPTIONS.replace_verity_public_key:
Tao Baoc9981932019-09-16 12:10:43 -0700650 # Replace the one in root dir in system.img.
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700651 ReplaceVerityPublicKey(
Tao Baoc9981932019-09-16 12:10:43 -0700652 output_tf_zip, 'ROOT/verity_key', OPTIONS.replace_verity_public_key[1])
653
654 if not system_root_image:
655 # Additionally replace the copy in ramdisk if not using system-as-root.
656 ReplaceVerityPublicKey(
657 output_tf_zip,
658 'BOOT/RAMDISK/verity_key',
659 OPTIONS.replace_verity_public_key[1])
Tao Bao8adcfd12016-06-17 17:01:22 -0700660
661 # Replace the keyid string in BOOT/cmdline.
662 if OPTIONS.replace_verity_keyid:
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700663 ReplaceVerityKeyId(input_tf_zip, output_tf_zip,
664 OPTIONS.replace_verity_keyid[1])
Doug Zongker412c02f2014-02-13 10:58:24 -0800665
Tao Bao639118f2017-06-19 15:48:02 -0700666 # Replace the AVB signing keys, if any.
667 ReplaceAvbSigningKeys(misc_info)
668
Tao Bao19b02fe2019-10-09 00:04:28 -0700669 # Rewrite the props in AVB signing args.
670 if misc_info.get('avb_enable') == 'true':
671 RewriteAvbProps(misc_info)
672
Tao Bao46a59992017-06-05 11:55:16 -0700673 # Write back misc_info with the latest values.
674 ReplaceMiscInfoTxt(input_tf_zip, output_tf_zip, misc_info)
675
Doug Zongker8e931bf2009-04-06 15:21:45 -0700676
Robert Craig817c5742013-04-19 10:59:22 -0400677def ReplaceCerts(data):
Tao Bao66472632017-12-04 17:16:36 -0800678 """Replaces all the occurences of X.509 certs with the new ones.
Robert Craig817c5742013-04-19 10:59:22 -0400679
Tao Bao66472632017-12-04 17:16:36 -0800680 The mapping info is read from OPTIONS.key_map. Non-existent certificate will
681 be skipped. After the replacement, it additionally checks for duplicate
682 entries, which would otherwise fail the policy loading code in
683 frameworks/base/services/core/java/com/android/server/pm/SELinuxMMAC.java.
684
685 Args:
686 data: Input string that contains a set of X.509 certs.
687
688 Returns:
689 A string after the replacement.
690
691 Raises:
692 AssertionError: On finding duplicate entries.
693 """
Tao Baoa3705452019-06-24 15:33:41 -0700694 for old, new in OPTIONS.key_map.items():
Tao Bao66472632017-12-04 17:16:36 -0800695 if OPTIONS.verbose:
696 print(" Replacing %s.x509.pem with %s.x509.pem" % (old, new))
697
698 try:
699 with open(old + ".x509.pem") as old_fp:
700 old_cert16 = base64.b16encode(
Tao Baoa3705452019-06-24 15:33:41 -0700701 common.ParseCertificate(old_fp.read())).decode().lower()
Tao Bao66472632017-12-04 17:16:36 -0800702 with open(new + ".x509.pem") as new_fp:
703 new_cert16 = base64.b16encode(
Tao Baoa3705452019-06-24 15:33:41 -0700704 common.ParseCertificate(new_fp.read())).decode().lower()
Tao Bao66472632017-12-04 17:16:36 -0800705 except IOError as e:
706 if OPTIONS.verbose or e.errno != errno.ENOENT:
707 print(" Error accessing %s: %s.\nSkip replacing %s.x509.pem with "
708 "%s.x509.pem." % (e.filename, e.strerror, old, new))
709 continue
710
711 # Only match entire certs.
712 pattern = "\\b" + old_cert16 + "\\b"
713 (data, num) = re.subn(pattern, new_cert16, data, flags=re.IGNORECASE)
714
715 if OPTIONS.verbose:
716 print(" Replaced %d occurence(s) of %s.x509.pem with %s.x509.pem" % (
717 num, old, new))
718
719 # Verify that there're no duplicate entries after the replacement. Note that
720 # it's only checking entries with global seinfo at the moment (i.e. ignoring
721 # the ones with inner packages). (Bug: 69479366)
722 root = ElementTree.fromstring(data)
723 signatures = [signer.attrib['signature'] for signer in root.findall('signer')]
724 assert len(signatures) == len(set(signatures)), \
725 "Found duplicate entries after cert replacement: {}".format(data)
Robert Craig817c5742013-04-19 10:59:22 -0400726
727 return data
728
729
Doug Zongkerc09abc82010-01-11 13:09:15 -0800730def EditTags(tags):
Tao Baoa7054ee2017-12-08 14:42:16 -0800731 """Applies the edits to the tag string as specified in OPTIONS.tag_changes.
732
733 Args:
734 tags: The input string that contains comma-separated tags.
735
736 Returns:
737 The updated tags (comma-separated and sorted).
738 """
Doug Zongkerc09abc82010-01-11 13:09:15 -0800739 tags = set(tags.split(","))
740 for ch in OPTIONS.tag_changes:
741 if ch[0] == "-":
742 tags.discard(ch[1:])
743 elif ch[0] == "+":
744 tags.add(ch[1:])
745 return ",".join(sorted(tags))
746
747
Tao Baoa7054ee2017-12-08 14:42:16 -0800748def RewriteProps(data):
749 """Rewrites the system properties in the given string.
750
751 Each property is expected in 'key=value' format. The properties that contain
752 build tags (i.e. test-keys, dev-keys) will be updated accordingly by calling
753 EditTags().
754
755 Args:
756 data: Input string, separated by newlines.
757
758 Returns:
759 The string with modified properties.
760 """
Doug Zongker17aa9442009-04-17 10:15:58 -0700761 output = []
762 for line in data.split("\n"):
763 line = line.strip()
764 original_line = line
Michael Rungedc2661a2014-06-03 14:43:11 -0700765 if line and line[0] != '#' and "=" in line:
Doug Zongker17aa9442009-04-17 10:15:58 -0700766 key, value = line.split("=", 1)
Magnus Strandh234f4b42019-05-01 23:09:30 +0200767 if (key.startswith("ro.") and
768 key.endswith((".build.fingerprint", ".build.thumbprint"))):
Doug Zongkerc09abc82010-01-11 13:09:15 -0800769 pieces = value.split("/")
770 pieces[-1] = EditTags(pieces[-1])
771 value = "/".join(pieces)
Tao Baocb7ff772015-09-11 15:27:56 -0700772 elif key == "ro.bootimage.build.fingerprint":
773 pieces = value.split("/")
774 pieces[-1] = EditTags(pieces[-1])
775 value = "/".join(pieces)
Doug Zongker17aa9442009-04-17 10:15:58 -0700776 elif key == "ro.build.description":
Doug Zongkerc09abc82010-01-11 13:09:15 -0800777 pieces = value.split(" ")
Doug Zongker17aa9442009-04-17 10:15:58 -0700778 assert len(pieces) == 5
Doug Zongkerc09abc82010-01-11 13:09:15 -0800779 pieces[-1] = EditTags(pieces[-1])
780 value = " ".join(pieces)
Magnus Strandh234f4b42019-05-01 23:09:30 +0200781 elif key.startswith("ro.") and key.endswith(".build.tags"):
Doug Zongkerc09abc82010-01-11 13:09:15 -0800782 value = EditTags(value)
Doug Zongkera8608a72013-07-23 11:51:04 -0700783 elif key == "ro.build.display.id":
784 # change, eg, "JWR66N dev-keys" to "JWR66N"
785 value = value.split()
Michael Rungedc2661a2014-06-03 14:43:11 -0700786 if len(value) > 1 and value[-1].endswith("-keys"):
Andrew Boie73d5abb2013-12-11 12:42:03 -0800787 value.pop()
788 value = " ".join(value)
Doug Zongkerc09abc82010-01-11 13:09:15 -0800789 line = key + "=" + value
Doug Zongker17aa9442009-04-17 10:15:58 -0700790 if line != original_line:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800791 print(" replace: ", original_line)
792 print(" with: ", line)
Doug Zongker17aa9442009-04-17 10:15:58 -0700793 output.append(line)
794 return "\n".join(output) + "\n"
795
796
Tianjie Xuffbe6b92018-10-19 14:34:15 -0700797def WriteOtacerts(output_zip, filename, keys):
798 """Constructs a zipfile from given keys; and writes it to output_zip.
799
800 Args:
801 output_zip: The output target_files zip.
802 filename: The archive name in the output zip.
803 keys: A list of public keys to use during OTA package verification.
804 """
Tao Baobb733882019-07-24 23:31:19 -0700805 temp_file = io.BytesIO()
Kelvin Zhang928c2342020-09-22 16:15:57 -0400806 certs_zip = zipfile.ZipFile(temp_file, "w", allowZip64=True)
Tianjie Xuffbe6b92018-10-19 14:34:15 -0700807 for k in keys:
808 common.ZipWrite(certs_zip, k)
809 common.ZipClose(certs_zip)
810 common.ZipWriteStr(output_zip, filename, temp_file.getvalue())
811
812
Doug Zongker831840e2011-09-22 10:28:04 -0700813def ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info):
Doug Zongker8e931bf2009-04-06 15:21:45 -0700814 try:
815 keylist = input_tf_zip.read("META/otakeys.txt").split()
816 except KeyError:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700817 raise common.ExternalError("can't read META/otakeys.txt from input")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700818
Tao Baof718f902017-11-09 10:10:10 -0800819 extra_recovery_keys = misc_info.get("extra_recovery_keys")
Doug Zongkere121d6a2011-02-01 14:13:52 -0800820 if extra_recovery_keys:
821 extra_recovery_keys = [OPTIONS.key_map.get(k, k) + ".x509.pem"
822 for k in extra_recovery_keys.split()]
823 if extra_recovery_keys:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800824 print("extra recovery-only key(s): " + ", ".join(extra_recovery_keys))
Doug Zongkere121d6a2011-02-01 14:13:52 -0800825 else:
826 extra_recovery_keys = []
827
Doug Zongker8e931bf2009-04-06 15:21:45 -0700828 mapped_keys = []
829 for k in keylist:
830 m = re.match(r"^(.*)\.x509\.pem$", k)
831 if not m:
Doug Zongker412c02f2014-02-13 10:58:24 -0800832 raise common.ExternalError(
833 "can't parse \"%s\" from META/otakeys.txt" % (k,))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700834 k = m.group(1)
835 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
836
Doug Zongkere05628c2009-08-20 17:38:42 -0700837 if mapped_keys:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800838 print("using:\n ", "\n ".join(mapped_keys))
839 print("for OTA package verification")
Doug Zongkere05628c2009-08-20 17:38:42 -0700840 else:
Doug Zongker831840e2011-09-22 10:28:04 -0700841 devkey = misc_info.get("default_system_dev_certificate",
Dan Willemsen0ab1be62019-04-09 21:35:37 -0700842 "build/make/target/product/security/testkey")
Tao Baof718f902017-11-09 10:10:10 -0800843 mapped_devkey = OPTIONS.key_map.get(devkey, devkey)
844 if mapped_devkey != devkey:
845 misc_info["default_system_dev_certificate"] = mapped_devkey
846 mapped_keys.append(mapped_devkey + ".x509.pem")
Tao Baoa80ed222016-06-16 14:41:24 -0700847 print("META/otakeys.txt has no keys; using %s for OTA package"
848 " verification." % (mapped_keys[0],))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700849
Kelvin Zhang9f781ff2021-02-11 19:10:44 -0500850 otacerts = [info
851 for info in input_tf_zip.infolist()
852 if info.filename.endswith("/otacerts.zip")]
853 for info in otacerts:
854 print("Rewriting OTA key:", info.filename, mapped_keys)
855 WriteOtacerts(output_tf_zip, info.filename, mapped_keys)
Doug Zongkereef39442009-04-02 12:14:19 -0700856
Tao Baoa80ed222016-06-16 14:41:24 -0700857
Tao Bao0c28d2d2017-12-24 10:37:38 -0800858def ReplaceVerityPublicKey(output_zip, filename, key_path):
859 """Replaces the verity public key at the given path in the given zip.
860
861 Args:
862 output_zip: The output target_files zip.
863 filename: The archive name in the output zip.
864 key_path: The path to the public key.
865 """
866 print("Replacing verity public key with %s" % (key_path,))
867 common.ZipWrite(output_zip, key_path, arcname=filename)
Geremy Condraf19b3652014-07-29 17:54:54 -0700868
Tao Bao8adcfd12016-06-17 17:01:22 -0700869
Tao Bao46a59992017-06-05 11:55:16 -0700870def ReplaceVerityPrivateKey(misc_info, key_path):
Tao Bao0c28d2d2017-12-24 10:37:38 -0800871 """Replaces the verity private key in misc_info dict.
872
873 Args:
874 misc_info: The info dict.
875 key_path: The path to the private key in PKCS#8 format.
876 """
877 print("Replacing verity private key with %s" % (key_path,))
Andrew Boied083f0b2014-09-15 16:01:07 -0700878 misc_info["verity_key"] = key_path
Doug Zongkereef39442009-04-02 12:14:19 -0700879
Tao Bao8adcfd12016-06-17 17:01:22 -0700880
Tao Baoe838d142017-12-23 23:44:48 -0800881def ReplaceVerityKeyId(input_zip, output_zip, key_path):
882 """Replaces the veritykeyid parameter in BOOT/cmdline.
883
884 Args:
885 input_zip: The input target_files zip, which should be already open.
886 output_zip: The output target_files zip, which should be already open and
887 writable.
888 key_path: The path to the PEM encoded X.509 certificate.
889 """
Tao Baoa3705452019-06-24 15:33:41 -0700890 in_cmdline = input_zip.read("BOOT/cmdline").decode()
Tao Baoe838d142017-12-23 23:44:48 -0800891 # Copy in_cmdline to output_zip if veritykeyid is not present.
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700892 if "veritykeyid" not in in_cmdline:
Tao Baoe838d142017-12-23 23:44:48 -0800893 common.ZipWriteStr(output_zip, "BOOT/cmdline", in_cmdline)
894 return
895
Tao Bao0c28d2d2017-12-24 10:37:38 -0800896 out_buffer = []
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700897 for param in in_cmdline.split():
Tao Baoe838d142017-12-23 23:44:48 -0800898 if "veritykeyid" not in param:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800899 out_buffer.append(param)
Tao Baoe838d142017-12-23 23:44:48 -0800900 continue
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700901
Tao Baoe838d142017-12-23 23:44:48 -0800902 # Extract keyid using openssl command.
903 p = common.Run(["openssl", "x509", "-in", key_path, "-text"],
Tao Baode1d4792018-02-20 10:05:46 -0800904 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Tao Baoe838d142017-12-23 23:44:48 -0800905 keyid, stderr = p.communicate()
906 assert p.returncode == 0, "Failed to dump certificate: {}".format(stderr)
907 keyid = re.search(
908 r'keyid:([0-9a-fA-F:]*)', keyid).group(1).replace(':', '').lower()
909 print("Replacing verity keyid with {}".format(keyid))
910 out_buffer.append("veritykeyid=id:%s" % (keyid,))
911
912 out_cmdline = ' '.join(out_buffer).strip() + '\n'
913 common.ZipWriteStr(output_zip, "BOOT/cmdline", out_cmdline)
Tao Bao46a59992017-06-05 11:55:16 -0700914
915
916def ReplaceMiscInfoTxt(input_zip, output_zip, misc_info):
917 """Replaces META/misc_info.txt.
918
919 Only writes back the ones in the original META/misc_info.txt. Because the
920 current in-memory dict contains additional items computed at runtime.
921 """
922 misc_info_old = common.LoadDictionaryFromLines(
Tao Baoa3705452019-06-24 15:33:41 -0700923 input_zip.read('META/misc_info.txt').decode().split('\n'))
Tao Bao46a59992017-06-05 11:55:16 -0700924 items = []
925 for key in sorted(misc_info):
926 if key in misc_info_old:
927 items.append('%s=%s' % (key, misc_info[key]))
928 common.ZipWriteStr(output_zip, "META/misc_info.txt", '\n'.join(items))
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700929
Tao Bao8adcfd12016-06-17 17:01:22 -0700930
Tao Bao639118f2017-06-19 15:48:02 -0700931def ReplaceAvbSigningKeys(misc_info):
932 """Replaces the AVB signing keys."""
933
Tao Bao639118f2017-06-19 15:48:02 -0700934 def ReplaceAvbPartitionSigningKey(partition):
935 key = OPTIONS.avb_keys.get(partition)
936 if not key:
937 return
938
939 algorithm = OPTIONS.avb_algorithms.get(partition)
940 assert algorithm, 'Missing AVB signing algorithm for %s' % (partition,)
941
Tao Bao0c28d2d2017-12-24 10:37:38 -0800942 print('Replacing AVB signing key for %s with "%s" (%s)' % (
943 partition, key, algorithm))
Tao Bao639118f2017-06-19 15:48:02 -0700944 misc_info['avb_' + partition + '_algorithm'] = algorithm
945 misc_info['avb_' + partition + '_key_path'] = key
946
947 extra_args = OPTIONS.avb_extra_args.get(partition)
948 if extra_args:
Tao Bao0c28d2d2017-12-24 10:37:38 -0800949 print('Setting extra AVB signing args for %s to "%s"' % (
950 partition, extra_args))
Kelvin Zhang0876c412020-06-23 15:06:58 -0400951 args_key = AVB_FOOTER_ARGS_BY_PARTITION.get(
952 partition,
953 # custom partition
954 "avb_{}_add_hashtree_footer_args".format(partition))
Tao Bao639118f2017-06-19 15:48:02 -0700955 misc_info[args_key] = (misc_info.get(args_key, '') + ' ' + extra_args)
956
957 for partition in AVB_FOOTER_ARGS_BY_PARTITION:
958 ReplaceAvbPartitionSigningKey(partition)
959
Hongguang Chenf23364d2020-04-27 18:36:36 -0700960 for custom_partition in misc_info.get(
961 "avb_custom_images_partition_list", "").strip().split():
962 ReplaceAvbPartitionSigningKey(custom_partition)
963
Tao Bao639118f2017-06-19 15:48:02 -0700964
Tao Bao19b02fe2019-10-09 00:04:28 -0700965def RewriteAvbProps(misc_info):
966 """Rewrites the props in AVB signing args."""
967 for partition, args_key in AVB_FOOTER_ARGS_BY_PARTITION.items():
968 args = misc_info.get(args_key)
969 if not args:
970 continue
971
972 tokens = []
973 changed = False
974 for token in args.split(' '):
975 fingerprint_key = 'com.android.build.{}.fingerprint'.format(partition)
976 if not token.startswith(fingerprint_key):
977 tokens.append(token)
978 continue
979 prefix, tag = token.rsplit('/', 1)
980 tokens.append('{}/{}'.format(prefix, EditTags(tag)))
981 changed = True
982
983 if changed:
984 result = ' '.join(tokens)
985 print('Rewriting AVB prop for {}:\n'.format(partition))
986 print(' replace: {}'.format(args))
987 print(' with: {}'.format(result))
988 misc_info[args_key] = result
989
990
Doug Zongker831840e2011-09-22 10:28:04 -0700991def BuildKeyMap(misc_info, key_mapping_options):
992 for s, d in key_mapping_options:
993 if s is None: # -d option
994 devkey = misc_info.get("default_system_dev_certificate",
Dan Willemsen0ab1be62019-04-09 21:35:37 -0700995 "build/make/target/product/security/testkey")
Doug Zongker831840e2011-09-22 10:28:04 -0700996 devkeydir = os.path.dirname(devkey)
997
998 OPTIONS.key_map.update({
999 devkeydir + "/testkey": d + "/releasekey",
1000 devkeydir + "/devkey": d + "/releasekey",
1001 devkeydir + "/media": d + "/media",
1002 devkeydir + "/shared": d + "/shared",
1003 devkeydir + "/platform": d + "/platform",
Oleh Cherpak982e6082019-12-10 12:58:54 +02001004 devkeydir + "/networkstack": d + "/networkstack",
Doug Zongker831840e2011-09-22 10:28:04 -07001005 })
1006 else:
1007 OPTIONS.key_map[s] = d
1008
1009
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001010def GetApiLevelAndCodename(input_tf_zip):
Tao Baoa3705452019-06-24 15:33:41 -07001011 data = input_tf_zip.read("SYSTEM/build.prop").decode()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001012 api_level = None
1013 codename = None
1014 for line in data.split("\n"):
1015 line = line.strip()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001016 if line and line[0] != '#' and "=" in line:
1017 key, value = line.split("=", 1)
1018 key = key.strip()
1019 if key == "ro.build.version.sdk":
1020 api_level = int(value.strip())
1021 elif key == "ro.build.version.codename":
1022 codename = value.strip()
1023
1024 if api_level is None:
1025 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
1026 if codename is None:
1027 raise ValueError("No ro.build.version.codename in SYSTEM/build.prop")
1028
1029 return (api_level, codename)
1030
1031
1032def GetCodenameToApiLevelMap(input_tf_zip):
Tao Baoa3705452019-06-24 15:33:41 -07001033 data = input_tf_zip.read("SYSTEM/build.prop").decode()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001034 api_level = None
1035 codenames = None
1036 for line in data.split("\n"):
1037 line = line.strip()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001038 if line and line[0] != '#' and "=" in line:
1039 key, value = line.split("=", 1)
1040 key = key.strip()
1041 if key == "ro.build.version.sdk":
1042 api_level = int(value.strip())
1043 elif key == "ro.build.version.all_codenames":
1044 codenames = value.strip().split(",")
1045
1046 if api_level is None:
1047 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
1048 if codenames is None:
1049 raise ValueError("No ro.build.version.all_codenames in SYSTEM/build.prop")
1050
Tao Baoa3705452019-06-24 15:33:41 -07001051 result = {}
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001052 for codename in codenames:
1053 codename = codename.strip()
Tao Baobadceb22019-03-15 09:33:43 -07001054 if codename:
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001055 result[codename] = api_level
1056 return result
1057
1058
Tao Baoaa7e9932019-03-15 09:37:01 -07001059def ReadApexKeysInfo(tf_zip):
1060 """Parses the APEX keys info from a given target-files zip.
1061
1062 Given a target-files ZipFile, parses the META/apexkeys.txt entry and returns a
1063 dict that contains the mapping from APEX names (e.g. com.android.tzdata) to a
1064 tuple of (payload_key, container_key).
1065
1066 Args:
1067 tf_zip: The input target_files ZipFile (already open).
1068
1069 Returns:
1070 (payload_key, container_key): payload_key contains the path to the payload
1071 signing key; container_key contains the path to the container signing
1072 key.
1073 """
1074 keys = {}
Tao Baoa3705452019-06-24 15:33:41 -07001075 for line in tf_zip.read('META/apexkeys.txt').decode().split('\n'):
Tao Baoaa7e9932019-03-15 09:37:01 -07001076 line = line.strip()
1077 if not line:
1078 continue
1079 matches = re.match(
1080 r'^name="(?P<NAME>.*)"\s+'
1081 r'public_key="(?P<PAYLOAD_PUBLIC_KEY>.*)"\s+'
1082 r'private_key="(?P<PAYLOAD_PRIVATE_KEY>.*)"\s+'
1083 r'container_certificate="(?P<CONTAINER_CERT>.*)"\s+'
Bill Peckham5c7b0342020-04-03 15:36:23 -07001084 r'container_private_key="(?P<CONTAINER_PRIVATE_KEY>.*?)"'
1085 r'(\s+partition="(?P<PARTITION>.*?)")?$',
Tao Baoaa7e9932019-03-15 09:37:01 -07001086 line)
1087 if not matches:
1088 continue
1089
1090 name = matches.group('NAME')
Tao Baoaa7e9932019-03-15 09:37:01 -07001091 payload_private_key = matches.group("PAYLOAD_PRIVATE_KEY")
1092
1093 def CompareKeys(pubkey, pubkey_suffix, privkey, privkey_suffix):
1094 pubkey_suffix_len = len(pubkey_suffix)
1095 privkey_suffix_len = len(privkey_suffix)
1096 return (pubkey.endswith(pubkey_suffix) and
1097 privkey.endswith(privkey_suffix) and
1098 pubkey[:-pubkey_suffix_len] == privkey[:-privkey_suffix_len])
1099
Ivan Lozanob021b2a2020-07-28 09:31:06 -04001100 # Check the container key names, as we'll carry them without the
Tao Bao6d9e3da2019-03-26 12:59:25 -07001101 # extensions. This doesn't apply to payload keys though, which we will use
1102 # full names only.
Tao Baoaa7e9932019-03-15 09:37:01 -07001103 container_cert = matches.group("CONTAINER_CERT")
1104 container_private_key = matches.group("CONTAINER_PRIVATE_KEY")
Tao Baof454c3a2019-04-24 23:53:42 -07001105 if container_cert == 'PRESIGNED' and container_private_key == 'PRESIGNED':
1106 container_key = 'PRESIGNED'
1107 elif CompareKeys(
Tao Baoaa7e9932019-03-15 09:37:01 -07001108 container_cert, OPTIONS.public_key_suffix,
1109 container_private_key, OPTIONS.private_key_suffix):
Tao Baof454c3a2019-04-24 23:53:42 -07001110 container_key = container_cert[:-len(OPTIONS.public_key_suffix)]
1111 else:
Tao Baoaa7e9932019-03-15 09:37:01 -07001112 raise ValueError("Failed to parse container keys: \n{}".format(line))
1113
Tao Baof454c3a2019-04-24 23:53:42 -07001114 keys[name] = (payload_private_key, container_key)
Tao Baoaa7e9932019-03-15 09:37:01 -07001115
1116 return keys
1117
1118
Doug Zongkereef39442009-04-02 12:14:19 -07001119def main(argv):
1120
Doug Zongker831840e2011-09-22 10:28:04 -07001121 key_mapping_options = []
1122
Doug Zongkereef39442009-04-02 12:14:19 -07001123 def option_handler(o, a):
Doug Zongker05d3dea2009-06-22 11:32:31 -07001124 if o in ("-e", "--extra_apks"):
Doug Zongkereef39442009-04-02 12:14:19 -07001125 names, key = a.split("=")
1126 names = names.split(",")
1127 for n in names:
1128 OPTIONS.extra_apks[n] = key
Tao Baoaa7e9932019-03-15 09:37:01 -07001129 elif o == "--extra_apex_payload_key":
1130 apex_name, key = a.split("=")
1131 OPTIONS.extra_apex_payload_keys[apex_name] = key
Tao Bao93c2a012018-06-19 12:19:35 -07001132 elif o == "--skip_apks_with_path_prefix":
Tianjiea85bdf02020-07-29 11:56:19 -07001133 # Check the prefix, which must be in all upper case.
Tao Bao93c2a012018-06-19 12:19:35 -07001134 prefix = a.split('/')[0]
1135 if not prefix or prefix != prefix.upper():
1136 raise ValueError("Invalid path prefix '%s'" % (a,))
1137 OPTIONS.skip_apks_with_path_prefix.add(a)
Doug Zongkereef39442009-04-02 12:14:19 -07001138 elif o in ("-d", "--default_key_mappings"):
Doug Zongker831840e2011-09-22 10:28:04 -07001139 key_mapping_options.append((None, a))
Doug Zongkereef39442009-04-02 12:14:19 -07001140 elif o in ("-k", "--key_mapping"):
Doug Zongker831840e2011-09-22 10:28:04 -07001141 key_mapping_options.append(a.split("=", 1))
Doug Zongker8e931bf2009-04-06 15:21:45 -07001142 elif o in ("-o", "--replace_ota_keys"):
1143 OPTIONS.replace_ota_keys = True
Doug Zongkerae877012009-04-21 10:04:51 -07001144 elif o in ("-t", "--tag_changes"):
1145 new = []
1146 for i in a.split(","):
1147 i = i.strip()
1148 if not i or i[0] not in "-+":
1149 raise ValueError("Bad tag change '%s'" % (i,))
1150 new.append(i[0] + i[1:].strip())
1151 OPTIONS.tag_changes = tuple(new)
Geremy Condraf19b3652014-07-29 17:54:54 -07001152 elif o == "--replace_verity_public_key":
1153 OPTIONS.replace_verity_public_key = (True, a)
1154 elif o == "--replace_verity_private_key":
1155 OPTIONS.replace_verity_private_key = (True, a)
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -07001156 elif o == "--replace_verity_keyid":
1157 OPTIONS.replace_verity_keyid = (True, a)
Bowgo Tsai2fe786a2020-02-21 17:48:18 +08001158 elif o == "--remove_avb_public_keys":
1159 OPTIONS.remove_avb_public_keys = a.split(",")
Tao Bao639118f2017-06-19 15:48:02 -07001160 elif o == "--avb_vbmeta_key":
1161 OPTIONS.avb_keys['vbmeta'] = a
1162 elif o == "--avb_vbmeta_algorithm":
1163 OPTIONS.avb_algorithms['vbmeta'] = a
1164 elif o == "--avb_vbmeta_extra_args":
1165 OPTIONS.avb_extra_args['vbmeta'] = a
1166 elif o == "--avb_boot_key":
1167 OPTIONS.avb_keys['boot'] = a
1168 elif o == "--avb_boot_algorithm":
1169 OPTIONS.avb_algorithms['boot'] = a
1170 elif o == "--avb_boot_extra_args":
1171 OPTIONS.avb_extra_args['boot'] = a
1172 elif o == "--avb_dtbo_key":
1173 OPTIONS.avb_keys['dtbo'] = a
1174 elif o == "--avb_dtbo_algorithm":
1175 OPTIONS.avb_algorithms['dtbo'] = a
1176 elif o == "--avb_dtbo_extra_args":
1177 OPTIONS.avb_extra_args['dtbo'] = a
1178 elif o == "--avb_system_key":
1179 OPTIONS.avb_keys['system'] = a
1180 elif o == "--avb_system_algorithm":
1181 OPTIONS.avb_algorithms['system'] = a
1182 elif o == "--avb_system_extra_args":
1183 OPTIONS.avb_extra_args['system'] = a
Bowgo Tsaie4544b12019-02-27 10:15:51 +08001184 elif o == "--avb_system_other_key":
1185 OPTIONS.avb_keys['system_other'] = a
1186 elif o == "--avb_system_other_algorithm":
1187 OPTIONS.avb_algorithms['system_other'] = a
1188 elif o == "--avb_system_other_extra_args":
1189 OPTIONS.avb_extra_args['system_other'] = a
Tao Bao639118f2017-06-19 15:48:02 -07001190 elif o == "--avb_vendor_key":
1191 OPTIONS.avb_keys['vendor'] = a
1192 elif o == "--avb_vendor_algorithm":
1193 OPTIONS.avb_algorithms['vendor'] = a
1194 elif o == "--avb_vendor_extra_args":
1195 OPTIONS.avb_extra_args['vendor'] = a
Tao Baod6085d62019-05-06 12:55:42 -07001196 elif o == "--avb_vbmeta_system_key":
1197 OPTIONS.avb_keys['vbmeta_system'] = a
1198 elif o == "--avb_vbmeta_system_algorithm":
1199 OPTIONS.avb_algorithms['vbmeta_system'] = a
1200 elif o == "--avb_vbmeta_system_extra_args":
1201 OPTIONS.avb_extra_args['vbmeta_system'] = a
1202 elif o == "--avb_vbmeta_vendor_key":
1203 OPTIONS.avb_keys['vbmeta_vendor'] = a
1204 elif o == "--avb_vbmeta_vendor_algorithm":
1205 OPTIONS.avb_algorithms['vbmeta_vendor'] = a
1206 elif o == "--avb_vbmeta_vendor_extra_args":
1207 OPTIONS.avb_extra_args['vbmeta_vendor'] = a
Tao Baoaa7e9932019-03-15 09:37:01 -07001208 elif o == "--avb_apex_extra_args":
1209 OPTIONS.avb_extra_args['apex'] = a
Hongguang Chenf23364d2020-04-27 18:36:36 -07001210 elif o == "--avb_extra_custom_image_key":
1211 partition, key = a.split("=")
1212 OPTIONS.avb_keys[partition] = key
1213 elif o == "--avb_extra_custom_image_algorithm":
1214 partition, algorithm = a.split("=")
1215 OPTIONS.avb_algorithms[partition] = algorithm
1216 elif o == "--avb_extra_custom_image_extra_args":
Hongguang Chen883eecb2020-05-23 22:20:19 -07001217 # Setting the maxsplit parameter to one, which will return a list with
1218 # two elements. e.g., the second '=' should not be splitted for
1219 # 'oem=--signing_helper_with_files=/tmp/avbsigner.sh'.
1220 partition, extra_args = a.split("=", 1)
Hongguang Chenf23364d2020-04-27 18:36:36 -07001221 OPTIONS.avb_extra_args[partition] = extra_args
Doug Zongkereef39442009-04-02 12:14:19 -07001222 else:
1223 return False
1224 return True
1225
Tao Bao639118f2017-06-19 15:48:02 -07001226 args = common.ParseOptions(
1227 argv, __doc__,
1228 extra_opts="e:d:k:ot:",
1229 extra_long_opts=[
Tao Bao0c28d2d2017-12-24 10:37:38 -08001230 "extra_apks=",
Tao Baoaa7e9932019-03-15 09:37:01 -07001231 "extra_apex_payload_key=",
Tao Bao93c2a012018-06-19 12:19:35 -07001232 "skip_apks_with_path_prefix=",
Tao Bao0c28d2d2017-12-24 10:37:38 -08001233 "default_key_mappings=",
1234 "key_mapping=",
1235 "replace_ota_keys",
1236 "tag_changes=",
1237 "replace_verity_public_key=",
1238 "replace_verity_private_key=",
1239 "replace_verity_keyid=",
Bowgo Tsai2fe786a2020-02-21 17:48:18 +08001240 "remove_avb_public_keys=",
Tao Baoaa7e9932019-03-15 09:37:01 -07001241 "avb_apex_extra_args=",
Tao Bao0c28d2d2017-12-24 10:37:38 -08001242 "avb_vbmeta_algorithm=",
1243 "avb_vbmeta_key=",
1244 "avb_vbmeta_extra_args=",
1245 "avb_boot_algorithm=",
1246 "avb_boot_key=",
1247 "avb_boot_extra_args=",
1248 "avb_dtbo_algorithm=",
1249 "avb_dtbo_key=",
1250 "avb_dtbo_extra_args=",
1251 "avb_system_algorithm=",
1252 "avb_system_key=",
1253 "avb_system_extra_args=",
Bowgo Tsaie4544b12019-02-27 10:15:51 +08001254 "avb_system_other_algorithm=",
1255 "avb_system_other_key=",
1256 "avb_system_other_extra_args=",
Tao Bao0c28d2d2017-12-24 10:37:38 -08001257 "avb_vendor_algorithm=",
1258 "avb_vendor_key=",
1259 "avb_vendor_extra_args=",
Tao Baod6085d62019-05-06 12:55:42 -07001260 "avb_vbmeta_system_algorithm=",
1261 "avb_vbmeta_system_key=",
1262 "avb_vbmeta_system_extra_args=",
1263 "avb_vbmeta_vendor_algorithm=",
1264 "avb_vbmeta_vendor_key=",
1265 "avb_vbmeta_vendor_extra_args=",
Hongguang Chenf23364d2020-04-27 18:36:36 -07001266 "avb_extra_custom_image_key=",
1267 "avb_extra_custom_image_algorithm=",
1268 "avb_extra_custom_image_extra_args=",
Tao Bao639118f2017-06-19 15:48:02 -07001269 ],
1270 extra_option_handler=option_handler)
Doug Zongkereef39442009-04-02 12:14:19 -07001271
1272 if len(args) != 2:
1273 common.Usage(__doc__)
1274 sys.exit(1)
1275
Tao Baobadceb22019-03-15 09:33:43 -07001276 common.InitLogging()
1277
Kelvin Zhang928c2342020-09-22 16:15:57 -04001278 input_zip = zipfile.ZipFile(args[0], "r", allowZip64=True)
Tao Bao2b8f4892017-06-13 12:54:58 -07001279 output_zip = zipfile.ZipFile(args[1], "w",
1280 compression=zipfile.ZIP_DEFLATED,
1281 allowZip64=True)
Doug Zongkereef39442009-04-02 12:14:19 -07001282
Doug Zongker831840e2011-09-22 10:28:04 -07001283 misc_info = common.LoadInfoDict(input_zip)
1284
1285 BuildKeyMap(misc_info, key_mapping_options)
1286
Tao Baoaa7e9932019-03-15 09:37:01 -07001287 apk_keys_info, compressed_extension = common.ReadApkCerts(input_zip)
1288 apk_keys = GetApkCerts(apk_keys_info)
Doug Zongkereb338ef2009-05-20 16:50:49 -07001289
Tao Baoaa7e9932019-03-15 09:37:01 -07001290 apex_keys_info = ReadApexKeysInfo(input_zip)
1291 apex_keys = GetApexKeys(apex_keys_info, apk_keys)
1292
Tianjie Xu88a759d2020-01-23 10:47:54 -08001293 # TODO(xunchang) check for the apks inside the apex files, and abort early if
1294 # the keys are not available.
Tao Baoaa7e9932019-03-15 09:37:01 -07001295 CheckApkAndApexKeysAvailable(
1296 input_zip,
1297 set(apk_keys.keys()) | set(apex_keys.keys()),
Tao Baoe1343992019-03-19 12:24:03 -07001298 compressed_extension,
1299 apex_keys)
Tao Baoaa7e9932019-03-15 09:37:01 -07001300
1301 key_passwords = common.GetKeyPasswords(
1302 set(apk_keys.values()) | set(itertools.chain(*apex_keys.values())))
Tao Bao9aa4b9b2016-09-29 17:53:56 -07001303 platform_api_level, _ = GetApiLevelAndCodename(input_zip)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001304 codename_to_api_level_map = GetCodenameToApiLevelMap(input_zip)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -08001305
Doug Zongker412c02f2014-02-13 10:58:24 -08001306 ProcessTargetFiles(input_zip, output_zip, misc_info,
Tao Baoaa7e9932019-03-15 09:37:01 -07001307 apk_keys, apex_keys, key_passwords,
1308 platform_api_level, codename_to_api_level_map,
Narayan Kamatha07bf042017-08-14 14:49:21 +01001309 compressed_extension)
Doug Zongker8e931bf2009-04-06 15:21:45 -07001310
Tao Bao2ed665a2015-04-01 11:21:55 -07001311 common.ZipClose(input_zip)
1312 common.ZipClose(output_zip)
Doug Zongkereef39442009-04-02 12:14:19 -07001313
Tianjie Xub48589a2016-08-03 19:21:52 -07001314 # Skip building userdata.img and cache.img when signing the target files.
Tianjie Xu616fbeb2017-05-23 14:51:02 -07001315 new_args = ["--is_signing"]
1316 # add_img_to_target_files builds the system image from scratch, so the
1317 # recovery patch is guaranteed to be regenerated there.
1318 if OPTIONS.rebuild_recovery:
1319 new_args.append("--rebuild_recovery")
1320 new_args.append(args[1])
Tianjie Xub48589a2016-08-03 19:21:52 -07001321 add_img_to_target_files.main(new_args)
Doug Zongker3c84f562014-07-31 11:06:30 -07001322
Tao Bao0c28d2d2017-12-24 10:37:38 -08001323 print("done.")
Doug Zongkereef39442009-04-02 12:14:19 -07001324
1325
1326if __name__ == '__main__':
1327 try:
1328 main(sys.argv[1:])
Tao Bao0c28d2d2017-12-24 10:37:38 -08001329 except common.ExternalError as e:
1330 print("\n ERROR: %s\n" % (e,))
Doug Zongkereef39442009-04-02 12:14:19 -07001331 sys.exit(1)
Tao Bao639118f2017-06-19 15:48:02 -07001332 finally:
1333 common.Cleanup()