blob: 3ab4a2c1d73ee74c2d248d0f3b267bf936b1c3fa [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
Doug Zongker412c02f2014-02-13 10:58:24 -080095import shutil
Doug Zongkereef39442009-04-02 12:14:19 -070096import subprocess
97import tempfile
98import zipfile
99
Doug Zongker3c84f562014-07-31 11:06:30 -0700100import add_img_to_target_files
Doug Zongkereef39442009-04-02 12:14:19 -0700101import common
102
103OPTIONS = common.OPTIONS
104
105OPTIONS.extra_apks = {}
106OPTIONS.key_map = {}
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')])
Doug Zongker412c02f2014-02-13 10:58:24 -0800189 rebuild_recovery = False
Tao Baoa80ed222016-06-16 14:41:24 -0700190 system_root_image = misc_info.get("system_root_image") == "true"
Doug Zongker412c02f2014-02-13 10:58:24 -0800191
Tao Baoa80ed222016-06-16 14:41:24 -0700192 # tmpdir will only be used to regenerate the recovery-from-boot patch.
Doug Zongker412c02f2014-02-13 10:58:24 -0800193 tmpdir = tempfile.mkdtemp()
194 def write_to_temp(fn, attr, data):
195 fn = os.path.join(tmpdir, fn)
196 if fn.endswith("/"):
197 fn = os.path.join(tmpdir, fn)
198 os.mkdir(fn)
199 else:
200 d = os.path.dirname(fn)
201 if d and not os.path.exists(d):
202 os.makedirs(d)
203
204 if attr >> 16 == 0xa1ff:
205 os.symlink(data, fn)
206 else:
207 with open(fn, "wb") as f:
208 f.write(data)
Doug Zongkereef39442009-04-02 12:14:19 -0700209
210 for info in input_tf_zip.infolist():
Dan Albert8b72aef2015-03-23 19:13:21 -0700211 if info.filename.startswith("IMAGES/"):
212 continue
Doug Zongker3c84f562014-07-31 11:06:30 -0700213
Doug Zongkereef39442009-04-02 12:14:19 -0700214 data = input_tf_zip.read(info.filename)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700215 out_info = copy.copy(info)
Doug Zongker412c02f2014-02-13 10:58:24 -0800216
Tao Baof2cffbd2015-07-22 12:33:18 -0700217 # Sign APKs.
Doug Zongkereef39442009-04-02 12:14:19 -0700218 if info.filename.endswith(".apk"):
219 name = os.path.basename(info.filename)
Doug Zongker43874f82009-04-14 14:05:15 -0700220 key = apk_key_map[name]
Doug Zongkerf6a53aa2009-12-15 15:06:55 -0800221 if key not in common.SPECIAL_CERT_STRINGS:
Doug Zongker43874f82009-04-14 14:05:15 -0700222 print " signing: %-*s (%s)" % (maxsize, name, key)
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800223 signed_data = SignApk(data, key, key_passwords[key], platform_api_level,
224 codename_to_api_level_map)
Tao Bao2ed665a2015-04-01 11:21:55 -0700225 common.ZipWriteStr(output_tf_zip, out_info, signed_data)
Doug Zongkereef39442009-04-02 12:14:19 -0700226 else:
227 # an APK we're not supposed to sign.
Doug Zongker43874f82009-04-14 14:05:15 -0700228 print "NOT signing: %s" % (name,)
Tao Bao2ed665a2015-04-01 11:21:55 -0700229 common.ZipWriteStr(output_tf_zip, out_info, data)
Tao Baoa80ed222016-06-16 14:41:24 -0700230
231 # System properties.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700232 elif info.filename in ("SYSTEM/build.prop",
Jesse Zhao2625d272015-02-06 09:49:55 -0800233 "VENDOR/build.prop",
Tao Baocb7ff772015-09-11 15:27:56 -0700234 "BOOT/RAMDISK/default.prop",
Doug Zongker8e931bf2009-04-06 15:21:45 -0700235 "RECOVERY/RAMDISK/default.prop"):
Doug Zongker17aa9442009-04-17 10:15:58 -0700236 print "rewriting %s:" % (info.filename,)
Michael Rungedc2661a2014-06-03 14:43:11 -0700237 new_data = RewriteProps(data, misc_info)
Tao Bao2ed665a2015-04-01 11:21:55 -0700238 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baocb7ff772015-09-11 15:27:56 -0700239 if info.filename in ("BOOT/RAMDISK/default.prop",
240 "RECOVERY/RAMDISK/default.prop"):
Doug Zongker412c02f2014-02-13 10:58:24 -0800241 write_to_temp(info.filename, info.external_attr, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700242
Robert Craig817c5742013-04-19 10:59:22 -0400243 elif info.filename.endswith("mac_permissions.xml"):
244 print "rewriting %s with new keys." % (info.filename,)
245 new_data = ReplaceCerts(data)
Tao Bao2ed665a2015-04-01 11:21:55 -0700246 common.ZipWriteStr(output_tf_zip, out_info, new_data)
Tao Baoa80ed222016-06-16 14:41:24 -0700247
248 # Trigger a rebuild of the recovery patch if needed.
Doug Zongker412c02f2014-02-13 10:58:24 -0800249 elif info.filename in ("SYSTEM/recovery-from-boot.p",
Tao Baof2cffbd2015-07-22 12:33:18 -0700250 "SYSTEM/etc/recovery.img",
Doug Zongker412c02f2014-02-13 10:58:24 -0800251 "SYSTEM/bin/install-recovery.sh"):
252 rebuild_recovery = True
Tao Baoa80ed222016-06-16 14:41:24 -0700253
254 # Don't copy OTA keys if we're replacing them.
Doug Zongker412c02f2014-02-13 10:58:24 -0800255 elif (OPTIONS.replace_ota_keys and
Tao Baoa80ed222016-06-16 14:41:24 -0700256 info.filename in (
257 "BOOT/RAMDISK/res/keys",
Alex Deymob3e8ce62016-08-04 16:06:12 -0700258 "BOOT/RAMDISK/etc/update_engine/update-payload-key.pub.pem",
Tao Baoa80ed222016-06-16 14:41:24 -0700259 "RECOVERY/RAMDISK/res/keys",
260 "SYSTEM/etc/security/otacerts.zip",
261 "SYSTEM/etc/update_engine/update-payload-key.pub.pem")):
Doug Zongker412c02f2014-02-13 10:58:24 -0800262 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700263
Tao Bao8adcfd12016-06-17 17:01:22 -0700264 # Skip META/misc_info.txt if we will replace the verity private key later.
Michael Runge947894f2014-10-14 20:58:38 -0700265 elif (OPTIONS.replace_verity_private_key and
Geremy Condraf19b3652014-07-29 17:54:54 -0700266 info.filename == "META/misc_info.txt"):
267 pass
Tao Bao8adcfd12016-06-17 17:01:22 -0700268
269 # Skip verity public key if we will replace it.
Michael Runge947894f2014-10-14 20:58:38 -0700270 elif (OPTIONS.replace_verity_public_key and
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700271 info.filename in ("BOOT/RAMDISK/verity_key",
Tao Bao8adcfd12016-06-17 17:01:22 -0700272 "ROOT/verity_key")):
Geremy Condraf19b3652014-07-29 17:54:54 -0700273 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700274
Tao Bao8adcfd12016-06-17 17:01:22 -0700275 # Skip verity keyid (for system_root_image use) if we will replace it.
276 elif (OPTIONS.replace_verity_keyid and
277 info.filename == "BOOT/cmdline"):
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700278 pass
279
Tao Baoa80ed222016-06-16 14:41:24 -0700280 # Copy BOOT/, RECOVERY/, META/, ROOT/ to rebuild recovery patch. This case
281 # must come AFTER other matching rules.
282 elif (info.filename.startswith("BOOT/") or
283 info.filename.startswith("RECOVERY/") or
284 info.filename.startswith("META/") or
285 info.filename.startswith("ROOT/") or
286 info.filename == "SYSTEM/etc/recovery-resource.dat"):
287 write_to_temp(info.filename, info.external_attr, data)
288 common.ZipWriteStr(output_tf_zip, out_info, data)
289
290 # A non-APK file; copy it verbatim.
Doug Zongkereef39442009-04-02 12:14:19 -0700291 else:
Tao Bao2ed665a2015-04-01 11:21:55 -0700292 common.ZipWriteStr(output_tf_zip, out_info, data)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700293
Doug Zongker412c02f2014-02-13 10:58:24 -0800294 if OPTIONS.replace_ota_keys:
295 new_recovery_keys = ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info)
296 if new_recovery_keys:
Tao Baoa80ed222016-06-16 14:41:24 -0700297 if system_root_image:
298 recovery_keys_location = "BOOT/RAMDISK/res/keys"
299 else:
300 recovery_keys_location = "RECOVERY/RAMDISK/res/keys"
301 # The "new_recovery_keys" has been already written into the output_tf_zip
302 # while calling ReplaceOtaKeys(). We're just putting the same copy to
303 # tmpdir in case we need to regenerate the recovery-from-boot patch.
304 write_to_temp(recovery_keys_location, 0o755 << 16, new_recovery_keys)
Doug Zongker412c02f2014-02-13 10:58:24 -0800305
Tao Bao8adcfd12016-06-17 17:01:22 -0700306 # Replace the keyid string in META/misc_info.txt.
307 if OPTIONS.replace_verity_private_key:
308 ReplaceVerityPrivateKey(input_tf_zip, output_tf_zip, misc_info,
309 OPTIONS.replace_verity_private_key[1])
310
311 if OPTIONS.replace_verity_public_key:
312 if system_root_image:
313 dest = "ROOT/verity_key"
314 else:
315 dest = "BOOT/RAMDISK/verity_key"
316 # We are replacing the one in boot image only, since the one under
317 # recovery won't ever be needed.
318 new_data = ReplaceVerityPublicKey(
319 output_tf_zip, dest, OPTIONS.replace_verity_public_key[1])
320 write_to_temp(dest, 0o755 << 16, new_data)
321
322 # Replace the keyid string in BOOT/cmdline.
323 if OPTIONS.replace_verity_keyid:
324 new_cmdline = ReplaceVerityKeyId(input_tf_zip, output_tf_zip,
325 OPTIONS.replace_verity_keyid[1])
326 # Writing the new cmdline to tmpdir is redundant as the bootimage
327 # gets build in the add_image_to_target_files and rebuild_recovery
328 # is not exercised while building the boot image for the A/B
329 # path
330 write_to_temp("BOOT/cmdline", 0o755 << 16, new_cmdline)
331
Doug Zongker412c02f2014-02-13 10:58:24 -0800332 if rebuild_recovery:
333 recovery_img = common.GetBootableImage(
334 "recovery.img", "recovery.img", tmpdir, "RECOVERY", info_dict=misc_info)
335 boot_img = common.GetBootableImage(
336 "boot.img", "boot.img", tmpdir, "BOOT", info_dict=misc_info)
337
338 def output_sink(fn, data):
Tao Bao2ed665a2015-04-01 11:21:55 -0700339 common.ZipWriteStr(output_tf_zip, "SYSTEM/" + fn, data)
Doug Zongker412c02f2014-02-13 10:58:24 -0800340
341 common.MakeRecoveryPatch(tmpdir, output_sink, recovery_img, boot_img,
342 info_dict=misc_info)
343
344 shutil.rmtree(tmpdir)
345
Doug Zongker8e931bf2009-04-06 15:21:45 -0700346
Robert Craig817c5742013-04-19 10:59:22 -0400347def ReplaceCerts(data):
348 """Given a string of data, replace all occurences of a set
349 of X509 certs with a newer set of X509 certs and return
350 the updated data string."""
351 for old, new in OPTIONS.key_map.iteritems():
352 try:
353 if OPTIONS.verbose:
354 print " Replacing %s.x509.pem with %s.x509.pem" % (old, new)
355 f = open(old + ".x509.pem")
356 old_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
357 f.close()
358 f = open(new + ".x509.pem")
359 new_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
360 f.close()
361 # Only match entire certs.
362 pattern = "\\b"+old_cert16+"\\b"
363 (data, num) = re.subn(pattern, new_cert16, data, flags=re.IGNORECASE)
364 if OPTIONS.verbose:
365 print " Replaced %d occurence(s) of %s.x509.pem with " \
366 "%s.x509.pem" % (num, old, new)
Dan Albert8b72aef2015-03-23 19:13:21 -0700367 except IOError as e:
368 if e.errno == errno.ENOENT and not OPTIONS.verbose:
Robert Craig817c5742013-04-19 10:59:22 -0400369 continue
370
371 print " Error accessing %s. %s. Skip replacing %s.x509.pem " \
372 "with %s.x509.pem." % (e.filename, e.strerror, old, new)
373
374 return data
375
376
Doug Zongkerc09abc82010-01-11 13:09:15 -0800377def EditTags(tags):
378 """Given a string containing comma-separated tags, apply the edits
379 specified in OPTIONS.tag_changes and return the updated string."""
380 tags = set(tags.split(","))
381 for ch in OPTIONS.tag_changes:
382 if ch[0] == "-":
383 tags.discard(ch[1:])
384 elif ch[0] == "+":
385 tags.add(ch[1:])
386 return ",".join(sorted(tags))
387
388
Michael Rungedc2661a2014-06-03 14:43:11 -0700389def RewriteProps(data, misc_info):
Doug Zongker17aa9442009-04-17 10:15:58 -0700390 output = []
391 for line in data.split("\n"):
392 line = line.strip()
393 original_line = line
Michael Rungedc2661a2014-06-03 14:43:11 -0700394 if line and line[0] != '#' and "=" in line:
Doug Zongker17aa9442009-04-17 10:15:58 -0700395 key, value = line.split("=", 1)
Michael Rungee07c75a2014-12-09 13:54:23 -0800396 if (key in ("ro.build.fingerprint", "ro.vendor.build.fingerprint")
Michael Rungedc2661a2014-06-03 14:43:11 -0700397 and misc_info.get("oem_fingerprint_properties") is None):
398 pieces = value.split("/")
399 pieces[-1] = EditTags(pieces[-1])
400 value = "/".join(pieces)
Michael Rungee07c75a2014-12-09 13:54:23 -0800401 elif (key in ("ro.build.thumbprint", "ro.vendor.build.thumbprint")
Dan Albert8b72aef2015-03-23 19:13:21 -0700402 and misc_info.get("oem_fingerprint_properties") is not None):
Doug Zongkerc09abc82010-01-11 13:09:15 -0800403 pieces = value.split("/")
404 pieces[-1] = EditTags(pieces[-1])
405 value = "/".join(pieces)
Tao Baocb7ff772015-09-11 15:27:56 -0700406 elif key == "ro.bootimage.build.fingerprint":
407 pieces = value.split("/")
408 pieces[-1] = EditTags(pieces[-1])
409 value = "/".join(pieces)
Doug Zongker17aa9442009-04-17 10:15:58 -0700410 elif key == "ro.build.description":
Doug Zongkerc09abc82010-01-11 13:09:15 -0800411 pieces = value.split(" ")
Doug Zongker17aa9442009-04-17 10:15:58 -0700412 assert len(pieces) == 5
Doug Zongkerc09abc82010-01-11 13:09:15 -0800413 pieces[-1] = EditTags(pieces[-1])
414 value = " ".join(pieces)
415 elif key == "ro.build.tags":
416 value = EditTags(value)
Doug Zongkera8608a72013-07-23 11:51:04 -0700417 elif key == "ro.build.display.id":
418 # change, eg, "JWR66N dev-keys" to "JWR66N"
419 value = value.split()
Michael Rungedc2661a2014-06-03 14:43:11 -0700420 if len(value) > 1 and value[-1].endswith("-keys"):
Andrew Boie73d5abb2013-12-11 12:42:03 -0800421 value.pop()
422 value = " ".join(value)
Doug Zongkerc09abc82010-01-11 13:09:15 -0800423 line = key + "=" + value
Doug Zongker17aa9442009-04-17 10:15:58 -0700424 if line != original_line:
425 print " replace: ", original_line
426 print " with: ", line
427 output.append(line)
428 return "\n".join(output) + "\n"
429
430
Doug Zongker831840e2011-09-22 10:28:04 -0700431def ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info):
Doug Zongker8e931bf2009-04-06 15:21:45 -0700432 try:
433 keylist = input_tf_zip.read("META/otakeys.txt").split()
434 except KeyError:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700435 raise common.ExternalError("can't read META/otakeys.txt from input")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700436
Doug Zongkere121d6a2011-02-01 14:13:52 -0800437 extra_recovery_keys = misc_info.get("extra_recovery_keys", None)
438 if extra_recovery_keys:
439 extra_recovery_keys = [OPTIONS.key_map.get(k, k) + ".x509.pem"
440 for k in extra_recovery_keys.split()]
441 if extra_recovery_keys:
442 print "extra recovery-only key(s): " + ", ".join(extra_recovery_keys)
443 else:
444 extra_recovery_keys = []
445
Doug Zongker8e931bf2009-04-06 15:21:45 -0700446 mapped_keys = []
447 for k in keylist:
448 m = re.match(r"^(.*)\.x509\.pem$", k)
449 if not m:
Doug Zongker412c02f2014-02-13 10:58:24 -0800450 raise common.ExternalError(
451 "can't parse \"%s\" from META/otakeys.txt" % (k,))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700452 k = m.group(1)
453 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
454
Doug Zongkere05628c2009-08-20 17:38:42 -0700455 if mapped_keys:
456 print "using:\n ", "\n ".join(mapped_keys)
457 print "for OTA package verification"
458 else:
Doug Zongker831840e2011-09-22 10:28:04 -0700459 devkey = misc_info.get("default_system_dev_certificate",
460 "build/target/product/security/testkey")
Doug Zongkere05628c2009-08-20 17:38:42 -0700461 mapped_keys.append(
Doug Zongker831840e2011-09-22 10:28:04 -0700462 OPTIONS.key_map.get(devkey, devkey) + ".x509.pem")
Tao Baoa80ed222016-06-16 14:41:24 -0700463 print("META/otakeys.txt has no keys; using %s for OTA package"
464 " verification." % (mapped_keys[0],))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700465
466 # recovery uses a version of the key that has been slightly
467 # predigested (by DumpPublicKey.java) and put in res/keys.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800468 # extra_recovery_keys are used only in recovery.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700469
Doug Zongker602a84e2009-06-18 08:35:12 -0700470 p = common.Run(["java", "-jar",
471 os.path.join(OPTIONS.search_path, "framework", "dumpkey.jar")]
Doug Zongkere121d6a2011-02-01 14:13:52 -0800472 + mapped_keys + extra_recovery_keys,
Doug Zongker8e931bf2009-04-06 15:21:45 -0700473 stdout=subprocess.PIPE)
Doug Zongker412c02f2014-02-13 10:58:24 -0800474 new_recovery_keys, _ = p.communicate()
Doug Zongker8e931bf2009-04-06 15:21:45 -0700475 if p.returncode != 0:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700476 raise common.ExternalError("failed to run dumpkeys")
Tao Baoa80ed222016-06-16 14:41:24 -0700477
478 # system_root_image puts the recovery keys at BOOT/RAMDISK.
479 if misc_info.get("system_root_image") == "true":
480 recovery_keys_location = "BOOT/RAMDISK/res/keys"
481 else:
482 recovery_keys_location = "RECOVERY/RAMDISK/res/keys"
483 common.ZipWriteStr(output_tf_zip, recovery_keys_location, new_recovery_keys)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700484
485 # SystemUpdateActivity uses the x509.pem version of the keys, but
486 # put into a zipfile system/etc/security/otacerts.zip.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800487 # We DO NOT include the extra_recovery_keys (if any) here.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700488
Dan Albert8b72aef2015-03-23 19:13:21 -0700489 temp_file = cStringIO.StringIO()
490 certs_zip = zipfile.ZipFile(temp_file, "w")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700491 for k in mapped_keys:
Tao Bao83cd79d2016-04-11 23:05:52 -0700492 common.ZipWrite(certs_zip, k)
493 common.ZipClose(certs_zip)
Doug Zongker048e7ca2009-06-15 14:31:53 -0700494 common.ZipWriteStr(output_tf_zip, "SYSTEM/etc/security/otacerts.zip",
Dan Albert8b72aef2015-03-23 19:13:21 -0700495 temp_file.getvalue())
Doug Zongkereef39442009-04-02 12:14:19 -0700496
Tao Baoa80ed222016-06-16 14:41:24 -0700497 # For A/B devices, update the payload verification key.
498 if misc_info.get("ab_update") == "true":
499 # Unlike otacerts.zip that may contain multiple keys, we can only specify
500 # ONE payload verification key.
501 if len(mapped_keys) > 1:
502 print("\n WARNING: Found more than one OTA keys; Using the first one"
503 " as payload verification key.\n\n")
504
505 print "Using %s for payload verification." % (mapped_keys[0],)
Tao Bao13b69622016-07-06 15:28:59 -0700506 cmd = common.Run(
507 ["openssl", "x509", "-pubkey", "-noout", "-in", mapped_keys[0]],
508 stdout=subprocess.PIPE)
509 pubkey, _ = cmd.communicate()
510 common.ZipWriteStr(
Tao Baoa80ed222016-06-16 14:41:24 -0700511 output_tf_zip,
Tao Bao13b69622016-07-06 15:28:59 -0700512 "SYSTEM/etc/update_engine/update-payload-key.pub.pem",
513 pubkey)
Alex Deymob3e8ce62016-08-04 16:06:12 -0700514 common.ZipWriteStr(
515 output_tf_zip,
516 "BOOT/RAMDISK/etc/update_engine/update-payload-key.pub.pem",
517 pubkey)
Tao Baoa80ed222016-06-16 14:41:24 -0700518
Doug Zongker412c02f2014-02-13 10:58:24 -0800519 return new_recovery_keys
520
Tao Bao8adcfd12016-06-17 17:01:22 -0700521
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700522def ReplaceVerityPublicKey(targetfile_zip, filename, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700523 print "Replacing verity public key with %s" % key_path
524 with open(key_path) as f:
Andrew Boied083f0b2014-09-15 16:01:07 -0700525 data = f.read()
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700526 common.ZipWriteStr(targetfile_zip, filename, data)
Andrew Boied083f0b2014-09-15 16:01:07 -0700527 return data
Geremy Condraf19b3652014-07-29 17:54:54 -0700528
Tao Bao8adcfd12016-06-17 17:01:22 -0700529
Dan Albert8b72aef2015-03-23 19:13:21 -0700530def ReplaceVerityPrivateKey(targetfile_input_zip, targetfile_output_zip,
531 misc_info, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700532 print "Replacing verity private key with %s" % key_path
533 current_key = misc_info["verity_key"]
534 original_misc_info = targetfile_input_zip.read("META/misc_info.txt")
535 new_misc_info = original_misc_info.replace(current_key, key_path)
536 common.ZipWriteStr(targetfile_output_zip, "META/misc_info.txt", new_misc_info)
Andrew Boied083f0b2014-09-15 16:01:07 -0700537 misc_info["verity_key"] = key_path
Doug Zongkereef39442009-04-02 12:14:19 -0700538
Tao Bao8adcfd12016-06-17 17:01:22 -0700539
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700540def ReplaceVerityKeyId(targetfile_input_zip, targetfile_output_zip, keypath):
541 in_cmdline = targetfile_input_zip.read("BOOT/cmdline")
542 # copy in_cmdline to output_zip if veritykeyid is not present in in_cmdline
543 if "veritykeyid" not in in_cmdline:
544 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", in_cmdline)
545 return in_cmdline
546 out_cmdline = []
547 for param in in_cmdline.split():
548 if "veritykeyid" in param:
549 # extract keyid using openssl command
550 p = common.Run(["openssl", "x509", "-in", keypath, "-text"], stdout=subprocess.PIPE)
551 keyid, stderr = p.communicate()
552 keyid = re.search(r'keyid:([0-9a-fA-F:]*)', keyid).group(1).replace(':', '').lower()
553 print "Replacing verity keyid with %s error=%s" % (keyid, stderr)
554 out_cmdline.append("veritykeyid=id:%s" % (keyid,))
555 else:
556 out_cmdline.append(param)
557
558 out_cmdline = ' '.join(out_cmdline)
559 out_cmdline = out_cmdline.strip()
560 print "out_cmdline %s" % (out_cmdline)
561 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", out_cmdline)
562 return out_cmdline
563
Tao Bao8adcfd12016-06-17 17:01:22 -0700564
Doug Zongker831840e2011-09-22 10:28:04 -0700565def BuildKeyMap(misc_info, key_mapping_options):
566 for s, d in key_mapping_options:
567 if s is None: # -d option
568 devkey = misc_info.get("default_system_dev_certificate",
569 "build/target/product/security/testkey")
570 devkeydir = os.path.dirname(devkey)
571
572 OPTIONS.key_map.update({
573 devkeydir + "/testkey": d + "/releasekey",
574 devkeydir + "/devkey": d + "/releasekey",
575 devkeydir + "/media": d + "/media",
576 devkeydir + "/shared": d + "/shared",
577 devkeydir + "/platform": d + "/platform",
578 })
579 else:
580 OPTIONS.key_map[s] = d
581
582
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800583def GetApiLevelAndCodename(input_tf_zip):
584 data = input_tf_zip.read("SYSTEM/build.prop")
585 api_level = None
586 codename = None
587 for line in data.split("\n"):
588 line = line.strip()
589 original_line = line
590 if line and line[0] != '#' and "=" in line:
591 key, value = line.split("=", 1)
592 key = key.strip()
593 if key == "ro.build.version.sdk":
594 api_level = int(value.strip())
595 elif key == "ro.build.version.codename":
596 codename = value.strip()
597
598 if api_level is None:
599 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
600 if codename is None:
601 raise ValueError("No ro.build.version.codename in SYSTEM/build.prop")
602
603 return (api_level, codename)
604
605
606def GetCodenameToApiLevelMap(input_tf_zip):
607 data = input_tf_zip.read("SYSTEM/build.prop")
608 api_level = None
609 codenames = None
610 for line in data.split("\n"):
611 line = line.strip()
612 original_line = line
613 if line and line[0] != '#' and "=" in line:
614 key, value = line.split("=", 1)
615 key = key.strip()
616 if key == "ro.build.version.sdk":
617 api_level = int(value.strip())
618 elif key == "ro.build.version.all_codenames":
619 codenames = value.strip().split(",")
620
621 if api_level is None:
622 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
623 if codenames is None:
624 raise ValueError("No ro.build.version.all_codenames in SYSTEM/build.prop")
625
626 result = dict()
627 for codename in codenames:
628 codename = codename.strip()
629 if len(codename) > 0:
630 result[codename] = api_level
631 return result
632
633
Doug Zongkereef39442009-04-02 12:14:19 -0700634def main(argv):
635
Doug Zongker831840e2011-09-22 10:28:04 -0700636 key_mapping_options = []
637
Doug Zongkereef39442009-04-02 12:14:19 -0700638 def option_handler(o, a):
Doug Zongker05d3dea2009-06-22 11:32:31 -0700639 if o in ("-e", "--extra_apks"):
Doug Zongkereef39442009-04-02 12:14:19 -0700640 names, key = a.split("=")
641 names = names.split(",")
642 for n in names:
643 OPTIONS.extra_apks[n] = key
644 elif o in ("-d", "--default_key_mappings"):
Doug Zongker831840e2011-09-22 10:28:04 -0700645 key_mapping_options.append((None, a))
Doug Zongkereef39442009-04-02 12:14:19 -0700646 elif o in ("-k", "--key_mapping"):
Doug Zongker831840e2011-09-22 10:28:04 -0700647 key_mapping_options.append(a.split("=", 1))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700648 elif o in ("-o", "--replace_ota_keys"):
649 OPTIONS.replace_ota_keys = True
Doug Zongkerae877012009-04-21 10:04:51 -0700650 elif o in ("-t", "--tag_changes"):
651 new = []
652 for i in a.split(","):
653 i = i.strip()
654 if not i or i[0] not in "-+":
655 raise ValueError("Bad tag change '%s'" % (i,))
656 new.append(i[0] + i[1:].strip())
657 OPTIONS.tag_changes = tuple(new)
Geremy Condraf19b3652014-07-29 17:54:54 -0700658 elif o == "--replace_verity_public_key":
659 OPTIONS.replace_verity_public_key = (True, a)
660 elif o == "--replace_verity_private_key":
661 OPTIONS.replace_verity_private_key = (True, a)
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700662 elif o == "--replace_verity_keyid":
663 OPTIONS.replace_verity_keyid = (True, a)
Doug Zongkereef39442009-04-02 12:14:19 -0700664 else:
665 return False
666 return True
667
668 args = common.ParseOptions(argv, __doc__,
Doug Zongker05d3dea2009-06-22 11:32:31 -0700669 extra_opts="e:d:k:ot:",
670 extra_long_opts=["extra_apks=",
Doug Zongkereef39442009-04-02 12:14:19 -0700671 "default_key_mappings=",
Doug Zongker8e931bf2009-04-06 15:21:45 -0700672 "key_mapping=",
Doug Zongker17aa9442009-04-17 10:15:58 -0700673 "replace_ota_keys",
Geremy Condraf19b3652014-07-29 17:54:54 -0700674 "tag_changes=",
675 "replace_verity_public_key=",
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700676 "replace_verity_private_key=",
677 "replace_verity_keyid="],
Doug Zongkereef39442009-04-02 12:14:19 -0700678 extra_option_handler=option_handler)
679
680 if len(args) != 2:
681 common.Usage(__doc__)
682 sys.exit(1)
683
684 input_zip = zipfile.ZipFile(args[0], "r")
685 output_zip = zipfile.ZipFile(args[1], "w")
686
Doug Zongker831840e2011-09-22 10:28:04 -0700687 misc_info = common.LoadInfoDict(input_zip)
688
689 BuildKeyMap(misc_info, key_mapping_options)
690
Doug Zongkereb338ef2009-05-20 16:50:49 -0700691 apk_key_map = GetApkCerts(input_zip)
692 CheckAllApksSigned(input_zip, apk_key_map)
Doug Zongkereb338ef2009-05-20 16:50:49 -0700693
694 key_passwords = common.GetKeyPasswords(set(apk_key_map.values()))
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800695 platform_api_level, platform_codename = GetApiLevelAndCodename(input_zip)
696 codename_to_api_level_map = GetCodenameToApiLevelMap(input_zip)
697 # Android N will be API Level 24, but isn't yet.
698 # TODO: Remove this workaround once Android N is officially API Level 24.
699 if platform_api_level == 23 and platform_codename == "N":
700 platform_api_level = 24
701
Doug Zongker412c02f2014-02-13 10:58:24 -0800702 ProcessTargetFiles(input_zip, output_zip, misc_info,
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800703 apk_key_map, key_passwords,
704 platform_api_level,
705 codename_to_api_level_map)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700706
Tao Bao2ed665a2015-04-01 11:21:55 -0700707 common.ZipClose(input_zip)
708 common.ZipClose(output_zip)
Doug Zongkereef39442009-04-02 12:14:19 -0700709
Doug Zongker3c84f562014-07-31 11:06:30 -0700710 add_img_to_target_files.AddImagesToTargetFiles(args[1])
711
Doug Zongkereef39442009-04-02 12:14:19 -0700712 print "done."
713
714
715if __name__ == '__main__':
716 try:
717 main(sys.argv[1:])
718 except common.ExternalError, e:
719 print
720 print " ERROR: %s" % (e,)
721 print
722 sys.exit(1)