blob: 3341f9f5d60265ecded1c578439e388275a0dbaf [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",
258 "RECOVERY/RAMDISK/res/keys",
259 "SYSTEM/etc/security/otacerts.zip",
260 "SYSTEM/etc/update_engine/update-payload-key.pub.pem")):
Doug Zongker412c02f2014-02-13 10:58:24 -0800261 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700262
Tao Bao8adcfd12016-06-17 17:01:22 -0700263 # Skip META/misc_info.txt if we will replace the verity private key later.
Michael Runge947894f2014-10-14 20:58:38 -0700264 elif (OPTIONS.replace_verity_private_key and
Geremy Condraf19b3652014-07-29 17:54:54 -0700265 info.filename == "META/misc_info.txt"):
266 pass
Tao Bao8adcfd12016-06-17 17:01:22 -0700267
268 # Skip verity public key if we will replace it.
Michael Runge947894f2014-10-14 20:58:38 -0700269 elif (OPTIONS.replace_verity_public_key and
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700270 info.filename in ("BOOT/RAMDISK/verity_key",
Tao Bao8adcfd12016-06-17 17:01:22 -0700271 "ROOT/verity_key")):
Geremy Condraf19b3652014-07-29 17:54:54 -0700272 pass
Tao Baoa80ed222016-06-16 14:41:24 -0700273
Tao Bao8adcfd12016-06-17 17:01:22 -0700274 # Skip verity keyid (for system_root_image use) if we will replace it.
275 elif (OPTIONS.replace_verity_keyid and
276 info.filename == "BOOT/cmdline"):
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700277 pass
278
Tao Baoa80ed222016-06-16 14:41:24 -0700279 # Copy BOOT/, RECOVERY/, META/, ROOT/ to rebuild recovery patch. This case
280 # must come AFTER other matching rules.
281 elif (info.filename.startswith("BOOT/") or
282 info.filename.startswith("RECOVERY/") or
283 info.filename.startswith("META/") or
284 info.filename.startswith("ROOT/") or
285 info.filename == "SYSTEM/etc/recovery-resource.dat"):
286 write_to_temp(info.filename, info.external_attr, data)
287 common.ZipWriteStr(output_tf_zip, out_info, data)
288
289 # A non-APK file; copy it verbatim.
Doug Zongkereef39442009-04-02 12:14:19 -0700290 else:
Tao Bao2ed665a2015-04-01 11:21:55 -0700291 common.ZipWriteStr(output_tf_zip, out_info, data)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700292
Doug Zongker412c02f2014-02-13 10:58:24 -0800293 if OPTIONS.replace_ota_keys:
294 new_recovery_keys = ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info)
295 if new_recovery_keys:
Tao Baoa80ed222016-06-16 14:41:24 -0700296 if system_root_image:
297 recovery_keys_location = "BOOT/RAMDISK/res/keys"
298 else:
299 recovery_keys_location = "RECOVERY/RAMDISK/res/keys"
300 # The "new_recovery_keys" has been already written into the output_tf_zip
301 # while calling ReplaceOtaKeys(). We're just putting the same copy to
302 # tmpdir in case we need to regenerate the recovery-from-boot patch.
303 write_to_temp(recovery_keys_location, 0o755 << 16, new_recovery_keys)
Doug Zongker412c02f2014-02-13 10:58:24 -0800304
Tao Bao8adcfd12016-06-17 17:01:22 -0700305 # Replace the keyid string in META/misc_info.txt.
306 if OPTIONS.replace_verity_private_key:
307 ReplaceVerityPrivateKey(input_tf_zip, output_tf_zip, misc_info,
308 OPTIONS.replace_verity_private_key[1])
309
310 if OPTIONS.replace_verity_public_key:
311 if system_root_image:
312 dest = "ROOT/verity_key"
313 else:
314 dest = "BOOT/RAMDISK/verity_key"
315 # We are replacing the one in boot image only, since the one under
316 # recovery won't ever be needed.
317 new_data = ReplaceVerityPublicKey(
318 output_tf_zip, dest, OPTIONS.replace_verity_public_key[1])
319 write_to_temp(dest, 0o755 << 16, new_data)
320
321 # Replace the keyid string in BOOT/cmdline.
322 if OPTIONS.replace_verity_keyid:
323 new_cmdline = ReplaceVerityKeyId(input_tf_zip, output_tf_zip,
324 OPTIONS.replace_verity_keyid[1])
325 # Writing the new cmdline to tmpdir is redundant as the bootimage
326 # gets build in the add_image_to_target_files and rebuild_recovery
327 # is not exercised while building the boot image for the A/B
328 # path
329 write_to_temp("BOOT/cmdline", 0o755 << 16, new_cmdline)
330
Doug Zongker412c02f2014-02-13 10:58:24 -0800331 if rebuild_recovery:
332 recovery_img = common.GetBootableImage(
333 "recovery.img", "recovery.img", tmpdir, "RECOVERY", info_dict=misc_info)
334 boot_img = common.GetBootableImage(
335 "boot.img", "boot.img", tmpdir, "BOOT", info_dict=misc_info)
336
337 def output_sink(fn, data):
Tao Bao2ed665a2015-04-01 11:21:55 -0700338 common.ZipWriteStr(output_tf_zip, "SYSTEM/" + fn, data)
Doug Zongker412c02f2014-02-13 10:58:24 -0800339
340 common.MakeRecoveryPatch(tmpdir, output_sink, recovery_img, boot_img,
341 info_dict=misc_info)
342
343 shutil.rmtree(tmpdir)
344
Doug Zongker8e931bf2009-04-06 15:21:45 -0700345
Robert Craig817c5742013-04-19 10:59:22 -0400346def ReplaceCerts(data):
347 """Given a string of data, replace all occurences of a set
348 of X509 certs with a newer set of X509 certs and return
349 the updated data string."""
350 for old, new in OPTIONS.key_map.iteritems():
351 try:
352 if OPTIONS.verbose:
353 print " Replacing %s.x509.pem with %s.x509.pem" % (old, new)
354 f = open(old + ".x509.pem")
355 old_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
356 f.close()
357 f = open(new + ".x509.pem")
358 new_cert16 = base64.b16encode(common.ParseCertificate(f.read())).lower()
359 f.close()
360 # Only match entire certs.
361 pattern = "\\b"+old_cert16+"\\b"
362 (data, num) = re.subn(pattern, new_cert16, data, flags=re.IGNORECASE)
363 if OPTIONS.verbose:
364 print " Replaced %d occurence(s) of %s.x509.pem with " \
365 "%s.x509.pem" % (num, old, new)
Dan Albert8b72aef2015-03-23 19:13:21 -0700366 except IOError as e:
367 if e.errno == errno.ENOENT and not OPTIONS.verbose:
Robert Craig817c5742013-04-19 10:59:22 -0400368 continue
369
370 print " Error accessing %s. %s. Skip replacing %s.x509.pem " \
371 "with %s.x509.pem." % (e.filename, e.strerror, old, new)
372
373 return data
374
375
Doug Zongkerc09abc82010-01-11 13:09:15 -0800376def EditTags(tags):
377 """Given a string containing comma-separated tags, apply the edits
378 specified in OPTIONS.tag_changes and return the updated string."""
379 tags = set(tags.split(","))
380 for ch in OPTIONS.tag_changes:
381 if ch[0] == "-":
382 tags.discard(ch[1:])
383 elif ch[0] == "+":
384 tags.add(ch[1:])
385 return ",".join(sorted(tags))
386
387
Michael Rungedc2661a2014-06-03 14:43:11 -0700388def RewriteProps(data, misc_info):
Doug Zongker17aa9442009-04-17 10:15:58 -0700389 output = []
390 for line in data.split("\n"):
391 line = line.strip()
392 original_line = line
Michael Rungedc2661a2014-06-03 14:43:11 -0700393 if line and line[0] != '#' and "=" in line:
Doug Zongker17aa9442009-04-17 10:15:58 -0700394 key, value = line.split("=", 1)
Michael Rungee07c75a2014-12-09 13:54:23 -0800395 if (key in ("ro.build.fingerprint", "ro.vendor.build.fingerprint")
Michael Rungedc2661a2014-06-03 14:43:11 -0700396 and misc_info.get("oem_fingerprint_properties") is None):
397 pieces = value.split("/")
398 pieces[-1] = EditTags(pieces[-1])
399 value = "/".join(pieces)
Michael Rungee07c75a2014-12-09 13:54:23 -0800400 elif (key in ("ro.build.thumbprint", "ro.vendor.build.thumbprint")
Dan Albert8b72aef2015-03-23 19:13:21 -0700401 and misc_info.get("oem_fingerprint_properties") is not None):
Doug Zongkerc09abc82010-01-11 13:09:15 -0800402 pieces = value.split("/")
403 pieces[-1] = EditTags(pieces[-1])
404 value = "/".join(pieces)
Tao Baocb7ff772015-09-11 15:27:56 -0700405 elif key == "ro.bootimage.build.fingerprint":
406 pieces = value.split("/")
407 pieces[-1] = EditTags(pieces[-1])
408 value = "/".join(pieces)
Doug Zongker17aa9442009-04-17 10:15:58 -0700409 elif key == "ro.build.description":
Doug Zongkerc09abc82010-01-11 13:09:15 -0800410 pieces = value.split(" ")
Doug Zongker17aa9442009-04-17 10:15:58 -0700411 assert len(pieces) == 5
Doug Zongkerc09abc82010-01-11 13:09:15 -0800412 pieces[-1] = EditTags(pieces[-1])
413 value = " ".join(pieces)
414 elif key == "ro.build.tags":
415 value = EditTags(value)
Doug Zongkera8608a72013-07-23 11:51:04 -0700416 elif key == "ro.build.display.id":
417 # change, eg, "JWR66N dev-keys" to "JWR66N"
418 value = value.split()
Michael Rungedc2661a2014-06-03 14:43:11 -0700419 if len(value) > 1 and value[-1].endswith("-keys"):
Andrew Boie73d5abb2013-12-11 12:42:03 -0800420 value.pop()
421 value = " ".join(value)
Doug Zongkerc09abc82010-01-11 13:09:15 -0800422 line = key + "=" + value
Doug Zongker17aa9442009-04-17 10:15:58 -0700423 if line != original_line:
424 print " replace: ", original_line
425 print " with: ", line
426 output.append(line)
427 return "\n".join(output) + "\n"
428
429
Doug Zongker831840e2011-09-22 10:28:04 -0700430def ReplaceOtaKeys(input_tf_zip, output_tf_zip, misc_info):
Doug Zongker8e931bf2009-04-06 15:21:45 -0700431 try:
432 keylist = input_tf_zip.read("META/otakeys.txt").split()
433 except KeyError:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700434 raise common.ExternalError("can't read META/otakeys.txt from input")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700435
Doug Zongkere121d6a2011-02-01 14:13:52 -0800436 extra_recovery_keys = misc_info.get("extra_recovery_keys", None)
437 if extra_recovery_keys:
438 extra_recovery_keys = [OPTIONS.key_map.get(k, k) + ".x509.pem"
439 for k in extra_recovery_keys.split()]
440 if extra_recovery_keys:
441 print "extra recovery-only key(s): " + ", ".join(extra_recovery_keys)
442 else:
443 extra_recovery_keys = []
444
Doug Zongker8e931bf2009-04-06 15:21:45 -0700445 mapped_keys = []
446 for k in keylist:
447 m = re.match(r"^(.*)\.x509\.pem$", k)
448 if not m:
Doug Zongker412c02f2014-02-13 10:58:24 -0800449 raise common.ExternalError(
450 "can't parse \"%s\" from META/otakeys.txt" % (k,))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700451 k = m.group(1)
452 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
453
Doug Zongkere05628c2009-08-20 17:38:42 -0700454 if mapped_keys:
455 print "using:\n ", "\n ".join(mapped_keys)
456 print "for OTA package verification"
457 else:
Doug Zongker831840e2011-09-22 10:28:04 -0700458 devkey = misc_info.get("default_system_dev_certificate",
459 "build/target/product/security/testkey")
Doug Zongkere05628c2009-08-20 17:38:42 -0700460 mapped_keys.append(
Doug Zongker831840e2011-09-22 10:28:04 -0700461 OPTIONS.key_map.get(devkey, devkey) + ".x509.pem")
Tao Baoa80ed222016-06-16 14:41:24 -0700462 print("META/otakeys.txt has no keys; using %s for OTA package"
463 " verification." % (mapped_keys[0],))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700464
465 # recovery uses a version of the key that has been slightly
466 # predigested (by DumpPublicKey.java) and put in res/keys.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800467 # extra_recovery_keys are used only in recovery.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700468
Doug Zongker602a84e2009-06-18 08:35:12 -0700469 p = common.Run(["java", "-jar",
470 os.path.join(OPTIONS.search_path, "framework", "dumpkey.jar")]
Doug Zongkere121d6a2011-02-01 14:13:52 -0800471 + mapped_keys + extra_recovery_keys,
Doug Zongker8e931bf2009-04-06 15:21:45 -0700472 stdout=subprocess.PIPE)
Doug Zongker412c02f2014-02-13 10:58:24 -0800473 new_recovery_keys, _ = p.communicate()
Doug Zongker8e931bf2009-04-06 15:21:45 -0700474 if p.returncode != 0:
T.R. Fullharta28acc62013-03-18 10:31:26 -0700475 raise common.ExternalError("failed to run dumpkeys")
Tao Baoa80ed222016-06-16 14:41:24 -0700476
477 # system_root_image puts the recovery keys at BOOT/RAMDISK.
478 if misc_info.get("system_root_image") == "true":
479 recovery_keys_location = "BOOT/RAMDISK/res/keys"
480 else:
481 recovery_keys_location = "RECOVERY/RAMDISK/res/keys"
482 common.ZipWriteStr(output_tf_zip, recovery_keys_location, new_recovery_keys)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700483
484 # SystemUpdateActivity uses the x509.pem version of the keys, but
485 # put into a zipfile system/etc/security/otacerts.zip.
Doug Zongkere121d6a2011-02-01 14:13:52 -0800486 # We DO NOT include the extra_recovery_keys (if any) here.
Doug Zongker8e931bf2009-04-06 15:21:45 -0700487
Dan Albert8b72aef2015-03-23 19:13:21 -0700488 temp_file = cStringIO.StringIO()
489 certs_zip = zipfile.ZipFile(temp_file, "w")
Doug Zongker8e931bf2009-04-06 15:21:45 -0700490 for k in mapped_keys:
Tao Bao83cd79d2016-04-11 23:05:52 -0700491 common.ZipWrite(certs_zip, k)
492 common.ZipClose(certs_zip)
Doug Zongker048e7ca2009-06-15 14:31:53 -0700493 common.ZipWriteStr(output_tf_zip, "SYSTEM/etc/security/otacerts.zip",
Dan Albert8b72aef2015-03-23 19:13:21 -0700494 temp_file.getvalue())
Doug Zongkereef39442009-04-02 12:14:19 -0700495
Tao Baoa80ed222016-06-16 14:41:24 -0700496 # For A/B devices, update the payload verification key.
497 if misc_info.get("ab_update") == "true":
498 # Unlike otacerts.zip that may contain multiple keys, we can only specify
499 # ONE payload verification key.
500 if len(mapped_keys) > 1:
501 print("\n WARNING: Found more than one OTA keys; Using the first one"
502 " as payload verification key.\n\n")
503
504 print "Using %s for payload verification." % (mapped_keys[0],)
505 common.ZipWrite(
506 output_tf_zip,
507 mapped_keys[0],
508 arcname="SYSTEM/etc/update_engine/update-payload-key.pub.pem")
509
Doug Zongker412c02f2014-02-13 10:58:24 -0800510 return new_recovery_keys
511
Tao Bao8adcfd12016-06-17 17:01:22 -0700512
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700513def ReplaceVerityPublicKey(targetfile_zip, filename, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700514 print "Replacing verity public key with %s" % key_path
515 with open(key_path) as f:
Andrew Boied083f0b2014-09-15 16:01:07 -0700516 data = f.read()
Tao Bao7a5bf8a2015-07-21 18:01:20 -0700517 common.ZipWriteStr(targetfile_zip, filename, data)
Andrew Boied083f0b2014-09-15 16:01:07 -0700518 return data
Geremy Condraf19b3652014-07-29 17:54:54 -0700519
Tao Bao8adcfd12016-06-17 17:01:22 -0700520
Dan Albert8b72aef2015-03-23 19:13:21 -0700521def ReplaceVerityPrivateKey(targetfile_input_zip, targetfile_output_zip,
522 misc_info, key_path):
Geremy Condraf19b3652014-07-29 17:54:54 -0700523 print "Replacing verity private key with %s" % key_path
524 current_key = misc_info["verity_key"]
525 original_misc_info = targetfile_input_zip.read("META/misc_info.txt")
526 new_misc_info = original_misc_info.replace(current_key, key_path)
527 common.ZipWriteStr(targetfile_output_zip, "META/misc_info.txt", new_misc_info)
Andrew Boied083f0b2014-09-15 16:01:07 -0700528 misc_info["verity_key"] = key_path
Doug Zongkereef39442009-04-02 12:14:19 -0700529
Tao Bao8adcfd12016-06-17 17:01:22 -0700530
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700531def ReplaceVerityKeyId(targetfile_input_zip, targetfile_output_zip, keypath):
532 in_cmdline = targetfile_input_zip.read("BOOT/cmdline")
533 # copy in_cmdline to output_zip if veritykeyid is not present in in_cmdline
534 if "veritykeyid" not in in_cmdline:
535 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", in_cmdline)
536 return in_cmdline
537 out_cmdline = []
538 for param in in_cmdline.split():
539 if "veritykeyid" in param:
540 # extract keyid using openssl command
541 p = common.Run(["openssl", "x509", "-in", keypath, "-text"], stdout=subprocess.PIPE)
542 keyid, stderr = p.communicate()
543 keyid = re.search(r'keyid:([0-9a-fA-F:]*)', keyid).group(1).replace(':', '').lower()
544 print "Replacing verity keyid with %s error=%s" % (keyid, stderr)
545 out_cmdline.append("veritykeyid=id:%s" % (keyid,))
546 else:
547 out_cmdline.append(param)
548
549 out_cmdline = ' '.join(out_cmdline)
550 out_cmdline = out_cmdline.strip()
551 print "out_cmdline %s" % (out_cmdline)
552 common.ZipWriteStr(targetfile_output_zip, "BOOT/cmdline", out_cmdline)
553 return out_cmdline
554
Tao Bao8adcfd12016-06-17 17:01:22 -0700555
Doug Zongker831840e2011-09-22 10:28:04 -0700556def BuildKeyMap(misc_info, key_mapping_options):
557 for s, d in key_mapping_options:
558 if s is None: # -d option
559 devkey = misc_info.get("default_system_dev_certificate",
560 "build/target/product/security/testkey")
561 devkeydir = os.path.dirname(devkey)
562
563 OPTIONS.key_map.update({
564 devkeydir + "/testkey": d + "/releasekey",
565 devkeydir + "/devkey": d + "/releasekey",
566 devkeydir + "/media": d + "/media",
567 devkeydir + "/shared": d + "/shared",
568 devkeydir + "/platform": d + "/platform",
569 })
570 else:
571 OPTIONS.key_map[s] = d
572
573
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800574def GetApiLevelAndCodename(input_tf_zip):
575 data = input_tf_zip.read("SYSTEM/build.prop")
576 api_level = None
577 codename = None
578 for line in data.split("\n"):
579 line = line.strip()
580 original_line = line
581 if line and line[0] != '#' and "=" in line:
582 key, value = line.split("=", 1)
583 key = key.strip()
584 if key == "ro.build.version.sdk":
585 api_level = int(value.strip())
586 elif key == "ro.build.version.codename":
587 codename = value.strip()
588
589 if api_level is None:
590 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
591 if codename is None:
592 raise ValueError("No ro.build.version.codename in SYSTEM/build.prop")
593
594 return (api_level, codename)
595
596
597def GetCodenameToApiLevelMap(input_tf_zip):
598 data = input_tf_zip.read("SYSTEM/build.prop")
599 api_level = None
600 codenames = None
601 for line in data.split("\n"):
602 line = line.strip()
603 original_line = line
604 if line and line[0] != '#' and "=" in line:
605 key, value = line.split("=", 1)
606 key = key.strip()
607 if key == "ro.build.version.sdk":
608 api_level = int(value.strip())
609 elif key == "ro.build.version.all_codenames":
610 codenames = value.strip().split(",")
611
612 if api_level is None:
613 raise ValueError("No ro.build.version.sdk in SYSTEM/build.prop")
614 if codenames is None:
615 raise ValueError("No ro.build.version.all_codenames in SYSTEM/build.prop")
616
617 result = dict()
618 for codename in codenames:
619 codename = codename.strip()
620 if len(codename) > 0:
621 result[codename] = api_level
622 return result
623
624
Doug Zongkereef39442009-04-02 12:14:19 -0700625def main(argv):
626
Doug Zongker831840e2011-09-22 10:28:04 -0700627 key_mapping_options = []
628
Doug Zongkereef39442009-04-02 12:14:19 -0700629 def option_handler(o, a):
Doug Zongker05d3dea2009-06-22 11:32:31 -0700630 if o in ("-e", "--extra_apks"):
Doug Zongkereef39442009-04-02 12:14:19 -0700631 names, key = a.split("=")
632 names = names.split(",")
633 for n in names:
634 OPTIONS.extra_apks[n] = key
635 elif o in ("-d", "--default_key_mappings"):
Doug Zongker831840e2011-09-22 10:28:04 -0700636 key_mapping_options.append((None, a))
Doug Zongkereef39442009-04-02 12:14:19 -0700637 elif o in ("-k", "--key_mapping"):
Doug Zongker831840e2011-09-22 10:28:04 -0700638 key_mapping_options.append(a.split("=", 1))
Doug Zongker8e931bf2009-04-06 15:21:45 -0700639 elif o in ("-o", "--replace_ota_keys"):
640 OPTIONS.replace_ota_keys = True
Doug Zongkerae877012009-04-21 10:04:51 -0700641 elif o in ("-t", "--tag_changes"):
642 new = []
643 for i in a.split(","):
644 i = i.strip()
645 if not i or i[0] not in "-+":
646 raise ValueError("Bad tag change '%s'" % (i,))
647 new.append(i[0] + i[1:].strip())
648 OPTIONS.tag_changes = tuple(new)
Geremy Condraf19b3652014-07-29 17:54:54 -0700649 elif o == "--replace_verity_public_key":
650 OPTIONS.replace_verity_public_key = (True, a)
651 elif o == "--replace_verity_private_key":
652 OPTIONS.replace_verity_private_key = (True, a)
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700653 elif o == "--replace_verity_keyid":
654 OPTIONS.replace_verity_keyid = (True, a)
Doug Zongkereef39442009-04-02 12:14:19 -0700655 else:
656 return False
657 return True
658
659 args = common.ParseOptions(argv, __doc__,
Doug Zongker05d3dea2009-06-22 11:32:31 -0700660 extra_opts="e:d:k:ot:",
661 extra_long_opts=["extra_apks=",
Doug Zongkereef39442009-04-02 12:14:19 -0700662 "default_key_mappings=",
Doug Zongker8e931bf2009-04-06 15:21:45 -0700663 "key_mapping=",
Doug Zongker17aa9442009-04-17 10:15:58 -0700664 "replace_ota_keys",
Geremy Condraf19b3652014-07-29 17:54:54 -0700665 "tag_changes=",
666 "replace_verity_public_key=",
Badhri Jagan Sridharan35c9b122016-06-16 19:58:44 -0700667 "replace_verity_private_key=",
668 "replace_verity_keyid="],
Doug Zongkereef39442009-04-02 12:14:19 -0700669 extra_option_handler=option_handler)
670
671 if len(args) != 2:
672 common.Usage(__doc__)
673 sys.exit(1)
674
675 input_zip = zipfile.ZipFile(args[0], "r")
676 output_zip = zipfile.ZipFile(args[1], "w")
677
Doug Zongker831840e2011-09-22 10:28:04 -0700678 misc_info = common.LoadInfoDict(input_zip)
679
680 BuildKeyMap(misc_info, key_mapping_options)
681
Doug Zongkereb338ef2009-05-20 16:50:49 -0700682 apk_key_map = GetApkCerts(input_zip)
683 CheckAllApksSigned(input_zip, apk_key_map)
Doug Zongkereb338ef2009-05-20 16:50:49 -0700684
685 key_passwords = common.GetKeyPasswords(set(apk_key_map.values()))
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800686 platform_api_level, platform_codename = GetApiLevelAndCodename(input_zip)
687 codename_to_api_level_map = GetCodenameToApiLevelMap(input_zip)
688 # Android N will be API Level 24, but isn't yet.
689 # TODO: Remove this workaround once Android N is officially API Level 24.
690 if platform_api_level == 23 and platform_codename == "N":
691 platform_api_level = 24
692
Doug Zongker412c02f2014-02-13 10:58:24 -0800693 ProcessTargetFiles(input_zip, output_zip, misc_info,
Alex Klyubin2cfd1d12016-01-13 10:32:47 -0800694 apk_key_map, key_passwords,
695 platform_api_level,
696 codename_to_api_level_map)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700697
Tao Bao2ed665a2015-04-01 11:21:55 -0700698 common.ZipClose(input_zip)
699 common.ZipClose(output_zip)
Doug Zongkereef39442009-04-02 12:14:19 -0700700
Doug Zongker3c84f562014-07-31 11:06:30 -0700701 add_img_to_target_files.AddImagesToTargetFiles(args[1])
702
Doug Zongkereef39442009-04-02 12:14:19 -0700703 print "done."
704
705
706if __name__ == '__main__':
707 try:
708 main(sys.argv[1:])
709 except common.ExternalError, e:
710 print
711 print " ERROR: %s" % (e,)
712 print
713 sys.exit(1)