blob: 0ef1942a0cc6bec21065622a94a3846d9cfffe92 [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>
24 Add extra APK name/key pairs as though they appeared in
Doug Zongkerad88c7c2009-04-14 12:34:27 -070025 apkcerts.txt (so mappings specified by -k and -d are applied).
26 Keys specified in -e override any value for that app contained
27 in the apkcerts.txt file. Option may be repeated to give
28 multiple extra packages.
Doug Zongkereef39442009-04-02 12:14:19 -070029
30 -k (--key_mapping) <src_key=dest_key>
31 Add a mapping from the key name as specified in apkcerts.txt (the
32 src_key) to the real key you wish to sign the package with
33 (dest_key). Option may be repeated to give multiple key
34 mappings.
35
36 -d (--default_key_mappings) <dir>
37 Set up the following key mappings:
38
Doug Zongker831840e2011-09-22 10:28:04 -070039 $devkey/devkey ==> $dir/releasekey
40 $devkey/testkey ==> $dir/releasekey
41 $devkey/media ==> $dir/media
42 $devkey/shared ==> $dir/shared
43 $devkey/platform ==> $dir/platform
44
45 where $devkey is the directory part of the value of
46 default_system_dev_certificate from the input target-files's
47 META/misc_info.txt. (Defaulting to "build/target/product/security"
48 if the value is not present in misc_info.
Doug Zongkereef39442009-04-02 12:14:19 -070049
50 -d and -k options are added to the set of mappings in the order
51 in which they appear on the command line.
Doug Zongker8e931bf2009-04-06 15:21:45 -070052
53 -o (--replace_ota_keys)
Tao Baoa80ed222016-06-16 14:41:24 -070054 Replace the certificate (public key) used by OTA package verification
55 with the ones specified in the input target_files zip (in the
56 META/otakeys.txt file). Key remapping (-k and -d) is performed on the
57 keys. For A/B devices, the payload verification key will be replaced
58 as well. If there're multiple OTA keys, only the first one will be used
59 for payload verification.
Doug Zongker17aa9442009-04-17 10:15:58 -070060
Doug Zongkerae877012009-04-21 10:04:51 -070061 -t (--tag_changes) <+tag>,<-tag>,...
62 Comma-separated list of changes to make to the set of tags (in
63 the last component of the build fingerprint). Prefix each with
64 '+' or '-' to indicate whether that tag should be added or
65 removed. Changes are processed in the order they appear.
Doug Zongker831840e2011-09-22 10:28:04 -070066 Default value is "-test-keys,-dev-keys,+release-keys".
Doug Zongkerae877012009-04-21 10:04:51 -070067
Tao Bao8adcfd12016-06-17 17:01:22 -070068 --replace_verity_private_key <key>
69 Replace the private key used for verity signing. It expects a filename
70 WITHOUT the extension (e.g. verity_key).
71
72 --replace_verity_public_key <key>
73 Replace the certificate (public key) used for verity verification. The
74 key file replaces the one at BOOT/RAMDISK/verity_key (or ROOT/verity_key
75 for devices using system_root_image). It expects the key filename WITH
76 the extension (e.g. verity_key.pub).
77
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -070078 --replace_verity_keyid <path_to_X509_PEM_cert_file>
79 Replace the veritykeyid in BOOT/cmdline of input_target_file_zip
Tao Bao8adcfd12016-06-17 17:01:22 -070080 with keyid of the cert pointed by <path_to_X509_PEM_cert_file>.
Doug Zongkereef39442009-04-02 12:14:19 -070081"""
82
83import sys
84
Doug Zongkercf6d5a92014-02-18 10:57:07 -080085if sys.hexversion < 0x02070000:
86 print >> sys.stderr, "Python 2.7 or newer is required."
Doug Zongkereef39442009-04-02 12:14:19 -070087 sys.exit(1)
88
Robert Craig817c5742013-04-19 10:59:22 -040089import base64
Doug Zongker8e931bf2009-04-06 15:21:45 -070090import cStringIO
91import copy
Robert Craig817c5742013-04-19 10:59:22 -040092import errno
Doug Zongkereef39442009-04-02 12:14:19 -070093import os
94import re
95import subprocess
96import tempfile
97import zipfile
98
Doug Zongker3c84f562014-07-31 11:06:30 -070099import add_img_to_target_files
Doug Zongkereef39442009-04-02 12:14:19 -0700100import common
101
102OPTIONS = common.OPTIONS
103
104OPTIONS.extra_apks = {}
105OPTIONS.key_map = {}
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700106OPTIONS.rebuild_recovery = False
Doug Zongker8e931bf2009-04-06 15:21:45 -0700107OPTIONS.replace_ota_keys = False
Geremy Condraf19b3652014-07-29 17:54:54 -0700108OPTIONS.replace_verity_public_key = False
109OPTIONS.replace_verity_private_key = False
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700110OPTIONS.replace_verity_keyid = False
Doug Zongker831840e2011-09-22 10:28:04 -0700111OPTIONS.tag_changes = ("-test-keys", "-dev-keys", "+release-keys")
Doug Zongkereef39442009-04-02 12:14:19 -0700112
113def GetApkCerts(tf_zip):
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800114 certmap = common.ReadApkCerts(tf_zip)
115
116 # apply the key remapping to the contents of the file
117 for apk, cert in certmap.iteritems():
118 certmap[apk] = OPTIONS.key_map.get(cert, cert)
119
120 # apply all the -e options, overriding anything in the file
Doug Zongkerad88c7c2009-04-14 12:34:27 -0700121 for apk, cert in OPTIONS.extra_apks.iteritems():
Doug Zongkerdecf9952009-12-15 17:27:49 -0800122 if not cert:
123 cert = "PRESIGNED"
Doug Zongkerad88c7c2009-04-14 12:34:27 -0700124 certmap[apk] = OPTIONS.key_map.get(cert, cert)
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800125
Doug Zongkereef39442009-04-02 12:14:19 -0700126 return certmap
127
128
Doug Zongkereb338ef2009-05-20 16:50:49 -0700129def CheckAllApksSigned(input_tf_zip, apk_key_map):
130 """Check that all the APKs we want to sign have keys specified, and
131 error out if they don't."""
132 unknown_apks = []
133 for info in input_tf_zip.infolist():
134 if info.filename.endswith(".apk"):
135 name = os.path.basename(info.filename)
136 if name not in apk_key_map:
137 unknown_apks.append(name)
138 if unknown_apks:
139 print "ERROR: no key specified for:\n\n ",
140 print "\n ".join(unknown_apks)
141 print "\nUse '-e <apkname>=' to specify a key (which may be an"
142 print "empty string to not sign this apk)."
143 sys.exit(1)
144
145
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800146def SignApk(data, keyname, pw, platform_api_level, codename_to_api_level_map):
Doug Zongkereef39442009-04-02 12:14:19 -0700147 unsigned = tempfile.NamedTemporaryFile()
148 unsigned.write(data)
149 unsigned.flush()
150
151 signed = tempfile.NamedTemporaryFile()
152
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800153 # For pre-N builds, don't upgrade to SHA-256 JAR signatures based on the APK's
154 # minSdkVersion to avoid increasing incremental OTA update sizes. If an APK
155 # didn't change, we don't want its signature to change due to the switch
156 # from SHA-1 to SHA-256.
157 # By default, APK signer chooses SHA-256 signatures if the APK's minSdkVersion
158 # is 18 or higher. For pre-N builds we disable this mechanism by pretending
159 # that the APK's minSdkVersion is 1.
160 # For N+ builds, we let APK signer rely on the APK's minSdkVersion to
161 # determine whether to use SHA-256.
162 min_api_level = None
163 if platform_api_level > 23:
164 # Let APK signer choose whether to use SHA-1 or SHA-256, based on the APK's
165 # minSdkVersion attribute
166 min_api_level = None
167 else:
168 # Force APK signer to use SHA-1
169 min_api_level = 1
170
171 common.SignFile(unsigned.name, signed.name, keyname, pw,
172 min_api_level=min_api_level,
173 codename_to_api_level_map=codename_to_api_level_map)
Doug Zongkereef39442009-04-02 12:14:19 -0700174
175 data = signed.read()
176 unsigned.close()
177 signed.close()
178
179 return data
180
181
Doug Zongker412c02f2014-02-13 10:58:24 -0800182def ProcessTargetFiles(input_tf_zip, output_tf_zip, misc_info,
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800183 apk_key_map, key_passwords, platform_api_level,
184 codename_to_api_level_map):
Michael Rungedc2661a2014-06-03 14:43:11 -0700185
Doug Zongkereef39442009-04-02 12:14:19 -0700186 maxsize = max([len(os.path.basename(i.filename))
187 for i in input_tf_zip.infolist()
188 if i.filename.endswith('.apk')])
Tao Baoa80ed222016-06-16 14:41:24 -0700189 system_root_image = misc_info.get("system_root_image") == "true"
Doug Zongker412c02f2014-02-13 10:58:24 -0800190
Doug Zongkereef39442009-04-02 12:14:19 -0700191 for info in input_tf_zip.infolist():
Dan Albert8b72aef2015-03-23 19:13:21 -0700192 if info.filename.startswith("IMAGES/"):
193 continue
Doug Zongker3c84f562014-07-31 11:06:30 -0700194
Doug Zongkereef39442009-04-02 12:14:19 -0700195 data = input_tf_zip.read(info.filename)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700196 out_info = copy.copy(info)
Doug Zongker412c02f2014-02-13 10:58:24 -0800197
Tao Baof2cffbd2015-07-22 12:33:18 -0700198 # Sign APKs.
Doug Zongkereef39442009-04-02 12:14:19 -0700199 if info.filename.endswith(".apk"):
200 name = os.path.basename(info.filename)
Doug Zongker43874f82009-04-14 14:05:15 -0700201 key = apk_key_map[name]
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800202 if key not in common.SPECIAL_CERT_STRINGS:
Doug Zongker43874f82009-04-14 14:05:15 -0700203 print " signing: %-*s (%s)" % (maxsize, name, key)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800204 signed_data = SignApk(data, key, key_passwords[key], platform_api_level,
205 codename_to_api_level_map)
Tao Bao2ed665a2015-04-01 11:21:55 -0700206 common.ZipWriteStr(output_tf_zip, out_info, signed_data)
Doug Zongkereef39442009-04-02 12:14:19 -0700207 else:
208 # an APK we're not supposed to sign.
Doug Zongker43874f82009-04-14 14:05:15 -0700209 print "NOT signing: %s" % (name,)
Tao Bao2ed665a2015-04-01 11:21:55 -0700210 common.ZipWriteStr(output_tf_zip, out_info, data)
Tao Baoa80ed222016-06-16 14:41:24 -0700211
212 # System properties.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700213 elif info.filename in ("SYSTEM/build.prop",
Jesse Zhao2625d272015-02-06 09:49:55 -0800214 "VENDOR/build.prop",
Hung-ying Tyanf829b402017-05-01 21:56:26 +0800215 "SYSTEM/etc/prop.default",
216 "BOOT/RAMDISK/prop.default",
217 "BOOT/RAMDISK/default.prop", # legacy
218 "ROOT/default.prop", # legacy
219 "RECOVERY/RAMDISK/prop.default",
220 "RECOVERY/RAMDISK/default.prop"): # legacy
Doug Zongker17aa9442009-04-17 10:15:58 -0700221 print "rewriting %s:" % (info.filename,)
Hung-ying Tyanf829b402017-05-01 21:56:26 +0800222 if stat.S_ISLNK(info.external_attr >> 16):
223 new_data = data
224 else:
225 new_data = RewriteProps(data, misc_info)
Tao Bao2ed665a2015-04-01 11:21:55 -0700226 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700227
Robert Craig817c5742013-04-19 10:59:22 -0400228 elif info.filename.endswith("mac_permissions.xml"):
229 print "rewriting %s with new keys." % (info.filename,)
230 new_data = ReplaceCerts(data)
Tao Bao2ed665a2015-04-01 11:21:55 -0700231 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700232
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700233 # Ask add_img_to_target_files to rebuild the recovery patch if needed.
Doug Zongker412c02f2014-02-13 10:58:24 -0800234 elif info.filename in ("SYSTEM/recovery-from-boot.p",
Tao Baof2cffbd2015-07-22 12:33:18 -0700235 "SYSTEM/etc/recovery.img",
Doug Zongker412c02f2014-02-13 10:58:24 -0800236 "SYSTEM/bin/install-recovery.sh"):
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700237 OPTIONS.rebuild_recovery = True
Tao Baoa80ed222016-06-16 14:41:24 -0700238
239 # Don't copy OTA keys if we're replacing them.
Doug Zongker412c02f2014-02-13 10:58:24 -0800240 elif (OPTIONS.replace_ota_keys and
Tao Baoa80ed222016-06-16 14:41:24 -0700241 info.filename in (
242 "BOOT/RAMDISK/res/keys",
Alex Deymob3e8ce62016-08-04 16:06:12 -0700243 "BOOT/RAMDISK/etc/update_engine/update-payload-key.pub.pem",
Tao Baoa80ed222016-06-16 14:41:24 -0700244 "RECOVERY/RAMDISK/res/keys",
245 "SYSTEM/etc/security/otacerts.zip",
246 "SYSTEM/etc/update_engine/update-payload-key.pub.pem")):
Doug Zongker412c02f2014-02-13 10:58:24 -0800247 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700248
Tao Bao8adcfd12016-06-17 17:01:22 -0700249 # Skip META/misc_info.txt if we will replace the verity private key later.
Michael Runge947894f2014-10-14 20:58:38 -0700250 elif (OPTIONS.replace_verity_private_key and
Geremy Condraf19b3652014-07-29 17:54:54 -0700251 info.filename == "META/misc_info.txt"):
252 pass
Tao Bao8adcfd12016-06-17 17:01:22 -0700253
254 # Skip verity public key if we will replace it.
Michael Runge947894f2014-10-14 20:58:38 -0700255 elif (OPTIONS.replace_verity_public_key and
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700256 info.filename in ("BOOT/RAMDISK/verity_key",
Tao Bao8adcfd12016-06-17 17:01:22 -0700257 "ROOT/verity_key")):
Geremy Condraf19b3652014-07-29 17:54:54 -0700258 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700259
Tao Bao8adcfd12016-06-17 17:01:22 -0700260 # Skip verity keyid (for system_root_image use) if we will replace it.
261 elif (OPTIONS.replace_verity_keyid and
262 info.filename == "BOOT/cmdline"):
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700263 pass
264
Tianjie Xu4f099002016-08-11 18:04:27 -0700265 # Skip the care_map as we will regenerate the system/vendor images.
Tao Bao9aa4b9b2016-09-29 17:53:56 -0700266 elif info.filename == "META/care_map.txt":
Tianjie Xu4f099002016-08-11 18:04:27 -0700267 pass
268
Tao Baoa80ed222016-06-16 14:41:24 -0700269 # A non-APK file; copy it verbatim.
Doug Zongkereef39442009-04-02 12:14:19 -0700270 else:
Tao Bao2ed665a2015-04-01 11:21:55 -0700271 common.ZipWriteStr(output_tf_zip, out_info, data)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700272
Doug Zongker412c02f2014-02-13 10:58:24 -0800273 if OPTIONS.replace_ota_keys:
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700274 ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info)
Doug Zongker412c02f2014-02-13 10:58:24 -0800275
Tao Bao8adcfd12016-06-17 17:01:22 -0700276 # Replace the keyid string in META/misc_info.txt.
277 if OPTIONS.replace_verity_private_key:
278 ReplaceVerityPrivateKey(input_tf_zip, output_tf_zip, misc_info,
279 OPTIONS.replace_verity_private_key[1])
280
281 if OPTIONS.replace_verity_public_key:
282 if system_root_image:
283 dest = "ROOT/verity_key"
284 else:
285 dest = "BOOT/RAMDISK/verity_key"
286 # We are replacing the one in boot image only, since the one under
287 # recovery won't ever be needed.
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700288 ReplaceVerityPublicKey(
Tao Bao8adcfd12016-06-17 17:01:22 -0700289 output_tf_zip, dest, OPTIONS.replace_verity_public_key[1])
Tao Bao8adcfd12016-06-17 17:01:22 -0700290
291 # Replace the keyid string in BOOT/cmdline.
292 if OPTIONS.replace_verity_keyid:
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700293 ReplaceVerityKeyId(input_tf_zip, output_tf_zip,
294 OPTIONS.replace_verity_keyid[1])
Doug Zongker412c02f2014-02-13 10:58:24 -0800295
Doug Zongker8e931bf2009-04-06 15:21:45 -0700296
Robert Craig817c5742013-04-19 10:59:22 -0400297def ReplaceCerts(data):
298 """Given a string of data, replace all occurences of a set
299 of X509 certs with a newer set of X509 certs and return
300 the updated data string."""
301 for old, new in OPTIONS.key_map.iteritems():
302 try:
303 if OPTIONS.verbose:
304 print " Replacing %s.x509.pem with %s.x509.pem" % (old, new)
305 f = open(old + ".x509.pem")
306 old_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
307 f.close()
308 f = open(new + ".x509.pem")
309 new_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
310 f.close()
311 # Only match entire certs.
312 pattern = "\\b"+old_cert16+"\\b"
313 (data, num) = re.subn(pattern, new_cert16, data, flags=re.IGNORECASE)
314 if OPTIONS.verbose:
315 print " Replaced %d occurence(s) of %s.x509.pem with " \
316 "%s.x509.pem" % (num, old, new)
Dan Albert8b72aef2015-03-23 19:13:21 -0700317 except IOError as e:
318 if e.errno == errno.ENOENT and not OPTIONS.verbose:
Robert Craig817c5742013-04-19 10:59:22 -0400319 continue
320
321 print " Error accessing %s. %s. Skip replacing %s.x509.pem " \
322 "with %s.x509.pem." % (e.filename, e.strerror, old, new)
323
324 return data
325
326
Doug Zongkerc09abc82010-01-11 13:09:15 -0800327def EditTags(tags):
328 """Given a string containing comma-separated tags, apply the edits
329 specified in OPTIONS.tag_changes and return the updated string."""
330 tags = set(tags.split(","))
331 for ch in OPTIONS.tag_changes:
332 if ch[0] == "-":
333 tags.discard(ch[1:])
334 elif ch[0] == "+":
335 tags.add(ch[1:])
336 return ",".join(sorted(tags))
337
338
Michael Rungedc2661a2014-06-03 14:43:11 -0700339def RewriteProps(data, misc_info):
Doug Zongker17aa9442009-04-17 10:15:58 -0700340 output = []
341 for line in data.split("\n"):
342 line = line.strip()
343 original_line = line
Michael Rungedc2661a2014-06-03 14:43:11 -0700344 if line and line[0] != '#' and "=" in line:
Doug Zongker17aa9442009-04-17 10:15:58 -0700345 key, value = line.split("=", 1)
Michael Rungee07c75a2014-12-09 13:54:23 -0800346 if (key in ("ro.build.fingerprint", "ro.vendor.build.fingerprint")
Michael Rungedc2661a2014-06-03 14:43:11 -0700347 and misc_info.get("oem_fingerprint_properties") is None):
348 pieces = value.split("/")
349 pieces[-1] = EditTags(pieces[-1])
350 value = "/".join(pieces)
Michael Rungee07c75a2014-12-09 13:54:23 -0800351 elif (key in ("ro.build.thumbprint", "ro.vendor.build.thumbprint")
Dan Albert8b72aef2015-03-23 19:13:21 -0700352 and misc_info.get("oem_fingerprint_properties") is not None):
Doug Zongkerc09abc82010-01-11 13:09:15 -0800353 pieces = value.split("/")
354 pieces[-1] = EditTags(pieces[-1])
355 value = "/".join(pieces)
Tao Baocb7ff772015-09-11 15:27:56 -0700356 elif key == "ro.bootimage.build.fingerprint":
357 pieces = value.split("/")
358 pieces[-1] = EditTags(pieces[-1])
359 value = "/".join(pieces)
Doug Zongker17aa9442009-04-17 10:15:58 -0700360 elif key == "ro.build.description":
Doug Zongkerc09abc82010-01-11 13:09:15 -0800361 pieces = value.split(" ")
Doug Zongker17aa9442009-04-17 10:15:58 -0700362 assert len(pieces) == 5
Doug Zongkerc09abc82010-01-11 13:09:15 -0800363 pieces[-1] = EditTags(pieces[-1])
364 value = " ".join(pieces)
365 elif key == "ro.build.tags":
366 value = EditTags(value)
Doug Zongkera8608a72013-07-23 11:51:04 -0700367 elif key == "ro.build.display.id":
368 # change, eg, "JWR66N dev-keys" to "JWR66N"
369 value = value.split()
Michael Rungedc2661a2014-06-03 14:43:11 -0700370 if len(value) > 1 and value[-1].endswith("-keys"):
Andrew Boie73d5abb2013-12-11 12:42:03 -0800371 value.pop()
372 value = " ".join(value)
Doug Zongkerc09abc82010-01-11 13:09:15 -0800373 line = key + "=" + value
Doug Zongker17aa9442009-04-17 10:15:58 -0700374 if line != original_line:
375 print " replace: ", original_line
376 print " with: ", line
377 output.append(line)
378 return "\n".join(output) + "\n"
379
380
Doug Zongker831840e2011-09-22 10:28:04 -0700381def ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info):
Doug Zongker8e931bf2009-04-06 15:21:45 -0700382 try:
383 keylist = input_tf_zip.read("META/otakeys.txt").split()
384 except KeyError:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700385 raise common.ExternalError("can't read META/otakeys.txt from input")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700386
Doug Zongkere121d6a2011-02-01 14:13:52 -0800387 extra_recovery_keys = misc_info.get("extra_recovery_keys", None)
388 if extra_recovery_keys:
389 extra_recovery_keys = [OPTIONS.key_map.get(k, k) + ".x509.pem"
390 for k in extra_recovery_keys.split()]
391 if extra_recovery_keys:
392 print "extra recovery-only key(s): " + ", ".join(extra_recovery_keys)
393 else:
394 extra_recovery_keys = []
395
Doug Zongker8e931bf2009-04-06 15:21:45 -0700396 mapped_keys = []
397 for k in keylist:
398 m = re.match(r"^(.*)\.x509\.pem$", k)
399 if not m:
Doug Zongker412c02f2014-02-13 10:58:24 -0800400 raise common.ExternalError(
401 "can't parse \"%s\" from META/otakeys.txt" % (k,))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700402 k = m.group(1)
403 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
404
Doug Zongkere05628c2009-08-20 17:38:42 -0700405 if mapped_keys:
406 print "using:\n ", "\n ".join(mapped_keys)
407 print "for OTA package verification"
408 else:
Doug Zongker831840e2011-09-22 10:28:04 -0700409 devkey = misc_info.get("default_system_dev_certificate",
410 "build/target/product/security/testkey")
Doug Zongkere05628c2009-08-20 17:38:42 -0700411 mapped_keys.append(
Doug Zongker831840e2011-09-22 10:28:04 -0700412 OPTIONS.key_map.get(devkey, devkey) + ".x509.pem")
Tao Baoa80ed222016-06-16 14:41:24 -0700413 print("META/otakeys.txt has no keys; using %s for OTA package"
414 " verification." % (mapped_keys[0],))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700415
416 # recovery uses a version of the key that has been slightly
417 # predigested (by DumpPublicKey.java) and put in res/keys.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800418 # extra_recovery_keys are used only in recovery.
Tao Baoe95540e2016-11-08 12:08:53 -0800419 cmd = ([OPTIONS.java_path] + OPTIONS.java_args +
420 ["-jar",
421 os.path.join(OPTIONS.search_path, "framework", "dumpkey.jar")] +
422 mapped_keys + extra_recovery_keys)
423 p = common.Run(cmd, stdout=subprocess.PIPE)
Doug Zongker412c02f2014-02-13 10:58:24 -0800424 new_recovery_keys, _ = p.communicate()
Doug Zongker8e931bf2009-04-06 15:21:45 -0700425 if p.returncode != 0:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700426 raise common.ExternalError("failed to run dumpkeys")
Tao Baoa80ed222016-06-16 14:41:24 -0700427
428 # system_root_image puts the recovery keys at BOOT/RAMDISK.
429 if misc_info.get("system_root_image") == "true":
430 recovery_keys_location = "BOOT/RAMDISK/res/keys"
431 else:
432 recovery_keys_location = "RECOVERY/RAMDISK/res/keys"
433 common.ZipWriteStr(output_tf_zip, recovery_keys_location, new_recovery_keys)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700434
435 # SystemUpdateActivity uses the x509.pem version of the keys, but
436 # put into a zipfile system/etc/security/otacerts.zip.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800437 # We DO NOT include the extra_recovery_keys (if any) here.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700438
Dan Albert8b72aef2015-03-23 19:13:21 -0700439 temp_file = cStringIO.StringIO()
440 certs_zip = zipfile.ZipFile(temp_file, "w")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700441 for k in mapped_keys:
Tao Bao83cd79d2016-04-11 23:05:52 -0700442 common.ZipWrite(certs_zip, k)
443 common.ZipClose(certs_zip)
Doug Zongker048e7ca2009-06-15 14:31:53 -0700444 common.ZipWriteStr(output_tf_zip, "SYSTEM/etc/security/otacerts.zip",
Dan Albert8b72aef2015-03-23 19:13:21 -0700445 temp_file.getvalue())
Doug Zongkereef39442009-04-02 12:14:19 -0700446
Tao Baoa80ed222016-06-16 14:41:24 -0700447 # For A/B devices, update the payload verification key.
448 if misc_info.get("ab_update") == "true":
449 # Unlike otacerts.zip that may contain multiple keys, we can only specify
450 # ONE payload verification key.
451 if len(mapped_keys) > 1:
452 print("\n WARNING: Found more than one OTA keys; Using the first one"
453 " as payload verification key.\n\n")
454
455 print "Using %s for payload verification." % (mapped_keys[0],)
Tao Bao13b69622016-07-06 15:28:59 -0700456 cmd = common.Run(
457 ["openssl", "x509", "-pubkey", "-noout", "-in", mapped_keys[0]],
458 stdout=subprocess.PIPE)
459 pubkey, _ = cmd.communicate()
460 common.ZipWriteStr(
Tao Baoa80ed222016-06-16 14:41:24 -0700461 output_tf_zip,
Tao Bao13b69622016-07-06 15:28:59 -0700462 "SYSTEM/etc/update_engine/update-payload-key.pub.pem",
463 pubkey)
Alex Deymob3e8ce62016-08-04 16:06:12 -0700464 common.ZipWriteStr(
465 output_tf_zip,
466 "BOOT/RAMDISK/etc/update_engine/update-payload-key.pub.pem",
467 pubkey)
Tao Baoa80ed222016-06-16 14:41:24 -0700468
Doug Zongker412c02f2014-02-13 10:58:24 -0800469 return new_recovery_keys
470
Tao Bao8adcfd12016-06-17 17:01:22 -0700471
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700472def ReplaceVerityPublicKey(targetfile_zip, filename, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700473 print "Replacing verity public key with %s" % key_path
474 with open(key_path) as f:
Andrew Boied083f0b2014-09-15 16:01:07 -0700475 data = f.read()
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700476 common.ZipWriteStr(targetfile_zip, filename, data)
Andrew Boied083f0b2014-09-15 16:01:07 -0700477 return data
Geremy Condraf19b3652014-07-29 17:54:54 -0700478
Tao Bao8adcfd12016-06-17 17:01:22 -0700479
Dan Albert8b72aef2015-03-23 19:13:21 -0700480def ReplaceVerityPrivateKey(targetfile_input_zip, targetfile_output_zip,
481 misc_info, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700482 print "Replacing verity private key with %s" % key_path
483 current_key = misc_info["verity_key"]
484 original_misc_info = targetfile_input_zip.read("META/misc_info.txt")
485 new_misc_info = original_misc_info.replace(current_key, key_path)
486 common.ZipWriteStr(targetfile_output_zip, "META/misc_info.txt", new_misc_info)
Andrew Boied083f0b2014-09-15 16:01:07 -0700487 misc_info["verity_key"] = key_path
Doug Zongkereef39442009-04-02 12:14:19 -0700488
Tao Bao8adcfd12016-06-17 17:01:22 -0700489
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700490def ReplaceVerityKeyId(targetfile_input_zip, targetfile_output_zip, keypath):
491 in_cmdline = targetfile_input_zip.read("BOOT/cmdline")
492 # copy in_cmdline to output_zip if veritykeyid is not present in in_cmdline
493 if "veritykeyid" not in in_cmdline:
494 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", in_cmdline)
495 return in_cmdline
496 out_cmdline = []
497 for param in in_cmdline.split():
498 if "veritykeyid" in param:
499 # extract keyid using openssl command
Tao Bao9aa4b9b2016-09-29 17:53:56 -0700500 p = common.Run(
501 ["openssl", "x509", "-in", keypath, "-text"],
502 stdout=subprocess.PIPE)
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700503 keyid, stderr = p.communicate()
Tao Bao9aa4b9b2016-09-29 17:53:56 -0700504 keyid = re.search(
505 r'keyid:([0-9a-fA-F:]*)', keyid).group(1).replace(':', '').lower()
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700506 print "Replacing verity keyid with %s error=%s" % (keyid, stderr)
507 out_cmdline.append("veritykeyid=id:%s" % (keyid,))
508 else:
509 out_cmdline.append(param)
510
511 out_cmdline = ' '.join(out_cmdline)
512 out_cmdline = out_cmdline.strip()
513 print "out_cmdline %s" % (out_cmdline)
514 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", out_cmdline)
515 return out_cmdline
516
Tao Bao8adcfd12016-06-17 17:01:22 -0700517
Doug Zongker831840e2011-09-22 10:28:04 -0700518def BuildKeyMap(misc_info, key_mapping_options):
519 for s, d in key_mapping_options:
520 if s is None: # -d option
521 devkey = misc_info.get("default_system_dev_certificate",
522 "build/target/product/security/testkey")
523 devkeydir = os.path.dirname(devkey)
524
525 OPTIONS.key_map.update({
526 devkeydir + "/testkey": d + "/releasekey",
527 devkeydir + "/devkey": d + "/releasekey",
528 devkeydir + "/media": d + "/media",
529 devkeydir + "/shared": d + "/shared",
530 devkeydir + "/platform": d + "/platform",
531 })
532 else:
533 OPTIONS.key_map[s] = d
534
535
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800536def GetApiLevelAndCodename(input_tf_zip):
537 data = input_tf_zip.read("SYSTEM/build.prop")
538 api_level = None
539 codename = None
540 for line in data.split("\n"):
541 line = line.strip()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800542 if line and line[0] != '#' and "=" in line:
543 key, value = line.split("=", 1)
544 key = key.strip()
545 if key == "ro.build.version.sdk":
546 api_level = int(value.strip())
547 elif key == "ro.build.version.codename":
548 codename = value.strip()
549
550 if api_level is None:
551 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
552 if codename is None:
553 raise ValueError("No ro.build.version.codename in SYSTEM/build.prop")
554
555 return (api_level, codename)
556
557
558def GetCodenameToApiLevelMap(input_tf_zip):
559 data = input_tf_zip.read("SYSTEM/build.prop")
560 api_level = None
561 codenames = None
562 for line in data.split("\n"):
563 line = line.strip()
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800564 if line and line[0] != '#' and "=" in line:
565 key, value = line.split("=", 1)
566 key = key.strip()
567 if key == "ro.build.version.sdk":
568 api_level = int(value.strip())
569 elif key == "ro.build.version.all_codenames":
570 codenames = value.strip().split(",")
571
572 if api_level is None:
573 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
574 if codenames is None:
575 raise ValueError("No ro.build.version.all_codenames in SYSTEM/build.prop")
576
577 result = dict()
578 for codename in codenames:
579 codename = codename.strip()
580 if len(codename) > 0:
581 result[codename] = api_level
582 return result
583
584
Doug Zongkereef39442009-04-02 12:14:19 -0700585def main(argv):
586
Doug Zongker831840e2011-09-22 10:28:04 -0700587 key_mapping_options = []
588
Doug Zongkereef39442009-04-02 12:14:19 -0700589 def option_handler(o, a):
Doug Zongker05d3dea2009-06-22 11:32:31 -0700590 if o in ("-e", "--extra_apks"):
Doug Zongkereef39442009-04-02 12:14:19 -0700591 names, key = a.split("=")
592 names = names.split(",")
593 for n in names:
594 OPTIONS.extra_apks[n] = key
595 elif o in ("-d", "--default_key_mappings"):
Doug Zongker831840e2011-09-22 10:28:04 -0700596 key_mapping_options.append((None, a))
Doug Zongkereef39442009-04-02 12:14:19 -0700597 elif o in ("-k", "--key_mapping"):
Doug Zongker831840e2011-09-22 10:28:04 -0700598 key_mapping_options.append(a.split("=", 1))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700599 elif o in ("-o", "--replace_ota_keys"):
600 OPTIONS.replace_ota_keys = True
Doug Zongkerae877012009-04-21 10:04:51 -0700601 elif o in ("-t", "--tag_changes"):
602 new = []
603 for i in a.split(","):
604 i = i.strip()
605 if not i or i[0] not in "-+":
606 raise ValueError("Bad tag change '%s'" % (i,))
607 new.append(i[0] + i[1:].strip())
608 OPTIONS.tag_changes = tuple(new)
Geremy Condraf19b3652014-07-29 17:54:54 -0700609 elif o == "--replace_verity_public_key":
610 OPTIONS.replace_verity_public_key = (True, a)
611 elif o == "--replace_verity_private_key":
612 OPTIONS.replace_verity_private_key = (True, a)
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700613 elif o == "--replace_verity_keyid":
614 OPTIONS.replace_verity_keyid = (True, a)
Doug Zongkereef39442009-04-02 12:14:19 -0700615 else:
616 return False
617 return True
618
619 args = common.ParseOptions(argv, __doc__,
Doug Zongker05d3dea2009-06-22 11:32:31 -0700620 extra_opts="e:d:k:ot:",
621 extra_long_opts=["extra_apks=",
Doug Zongkereef39442009-04-02 12:14:19 -0700622 "default_key_mappings=",
Doug Zongker8e931bf2009-04-06 15:21:45 -0700623 "key_mapping=",
Doug Zongker17aa9442009-04-17 10:15:58 -0700624 "replace_ota_keys",
Geremy Condraf19b3652014-07-29 17:54:54 -0700625 "tag_changes=",
626 "replace_verity_public_key=",
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700627 "replace_verity_private_key=",
628 "replace_verity_keyid="],
Doug Zongkereef39442009-04-02 12:14:19 -0700629 extra_option_handler=option_handler)
630
631 if len(args) != 2:
632 common.Usage(__doc__)
633 sys.exit(1)
634
635 input_zip = zipfile.ZipFile(args[0], "r")
636 output_zip = zipfile.ZipFile(args[1], "w")
637
Doug Zongker831840e2011-09-22 10:28:04 -0700638 misc_info = common.LoadInfoDict(input_zip)
639
640 BuildKeyMap(misc_info, key_mapping_options)
641
Doug Zongkereb338ef2009-05-20 16:50:49 -0700642 apk_key_map = GetApkCerts(input_zip)
643 CheckAllApksSigned(input_zip, apk_key_map)
Doug Zongkereb338ef2009-05-20 16:50:49 -0700644
645 key_passwords = common.GetKeyPasswords(set(apk_key_map.values()))
Tao Bao9aa4b9b2016-09-29 17:53:56 -0700646 platform_api_level, _ = GetApiLevelAndCodename(input_zip)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800647 codename_to_api_level_map = GetCodenameToApiLevelMap(input_zip)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800648
Doug Zongker412c02f2014-02-13 10:58:24 -0800649 ProcessTargetFiles(input_zip, output_zip, misc_info,
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800650 apk_key_map, key_passwords,
651 platform_api_level,
652 codename_to_api_level_map)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700653
Tao Bao2ed665a2015-04-01 11:21:55 -0700654 common.ZipClose(input_zip)
655 common.ZipClose(output_zip)
Doug Zongkereef39442009-04-02 12:14:19 -0700656
Tianjie Xub48589a2016-08-03 19:21:52 -0700657 # Skip building userdata.img and cache.img when signing the target files.
Tianjie Xu616fbeb2017-05-23 14:51:02 -0700658 new_args = ["--is_signing"]
659 # add_img_to_target_files builds the system image from scratch, so the
660 # recovery patch is guaranteed to be regenerated there.
661 if OPTIONS.rebuild_recovery:
662 new_args.append("--rebuild_recovery")
663 new_args.append(args[1])
Tianjie Xub48589a2016-08-03 19:21:52 -0700664 add_img_to_target_files.main(new_args)
Doug Zongker3c84f562014-07-31 11:06:30 -0700665
Doug Zongkereef39442009-04-02 12:14:19 -0700666 print "done."
667
668
669if __name__ == '__main__':
670 try:
671 main(sys.argv[1:])
672 except common.ExternalError, e:
673 print
674 print " ERROR: %s" % (e,)
675 print
676 sys.exit(1)