blob: 5153398e17560ad72289aa24746815bf8a1cdf05 [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
39 build/target/product/security/testkey ==> $dir/releasekey
40 build/target/product/security/media ==> $dir/media
41 build/target/product/security/shared ==> $dir/shared
42 build/target/product/security/platform ==> $dir/platform
43
44 -d and -k options are added to the set of mappings in the order
45 in which they appear on the command line.
Doug Zongker8e931bf2009-04-06 15:21:45 -070046
47 -o (--replace_ota_keys)
48 Replace the certificate (public key) used by OTA package
49 verification with the one specified in the input target_files
50 zip (in the META/otakeys.txt file). Key remapping (-k and -d)
51 is performed on this key.
Doug Zongker17aa9442009-04-17 10:15:58 -070052
Doug Zongkerae877012009-04-21 10:04:51 -070053 -t (--tag_changes) <+tag>,<-tag>,...
54 Comma-separated list of changes to make to the set of tags (in
55 the last component of the build fingerprint). Prefix each with
56 '+' or '-' to indicate whether that tag should be added or
57 removed. Changes are processed in the order they appear.
58 Default value is "-test-keys,+ota-rel-keys,+release-keys".
59
Doug Zongkereef39442009-04-02 12:14:19 -070060"""
61
62import sys
63
64if sys.hexversion < 0x02040000:
65 print >> sys.stderr, "Python 2.4 or newer is required."
66 sys.exit(1)
67
Doug Zongker8e931bf2009-04-06 15:21:45 -070068import cStringIO
69import copy
Doug Zongkereef39442009-04-02 12:14:19 -070070import os
71import re
72import subprocess
73import tempfile
74import zipfile
75
76import common
77
78OPTIONS = common.OPTIONS
79
80OPTIONS.extra_apks = {}
81OPTIONS.key_map = {}
Doug Zongker8e931bf2009-04-06 15:21:45 -070082OPTIONS.replace_ota_keys = False
Doug Zongkerae877012009-04-21 10:04:51 -070083OPTIONS.tag_changes = ("-test-keys", "+ota-rel-keys", "+release-keys")
Doug Zongkereef39442009-04-02 12:14:19 -070084
85def GetApkCerts(tf_zip):
Doug Zongkerad88c7c2009-04-14 12:34:27 -070086 certmap = {}
Doug Zongkereef39442009-04-02 12:14:19 -070087 for line in tf_zip.read("META/apkcerts.txt").split("\n"):
88 line = line.strip()
89 if not line: continue
90 m = re.match(r'^name="(.*)"\s+certificate="(.*)\.x509\.pem"\s+'
91 r'private_key="\2\.pk8"$', line)
92 if not m:
93 raise SigningError("failed to parse line from apkcerts.txt:\n" + line)
94 certmap[m.group(1)] = OPTIONS.key_map.get(m.group(2), m.group(2))
Doug Zongkerad88c7c2009-04-14 12:34:27 -070095 for apk, cert in OPTIONS.extra_apks.iteritems():
96 certmap[apk] = OPTIONS.key_map.get(cert, cert)
Doug Zongkereef39442009-04-02 12:14:19 -070097 return certmap
98
99
Doug Zongkereb338ef2009-05-20 16:50:49 -0700100def CheckAllApksSigned(input_tf_zip, apk_key_map):
101 """Check that all the APKs we want to sign have keys specified, and
102 error out if they don't."""
103 unknown_apks = []
104 for info in input_tf_zip.infolist():
105 if info.filename.endswith(".apk"):
106 name = os.path.basename(info.filename)
107 if name not in apk_key_map:
108 unknown_apks.append(name)
109 if unknown_apks:
110 print "ERROR: no key specified for:\n\n ",
111 print "\n ".join(unknown_apks)
112 print "\nUse '-e <apkname>=' to specify a key (which may be an"
113 print "empty string to not sign this apk)."
114 sys.exit(1)
115
116
117def SharedUserForApk(data):
118 tmp = tempfile.NamedTemporaryFile()
119 tmp.write(data)
120 tmp.flush()
121
122 p = common.Run(["aapt", "dump", "xmltree", tmp.name, "AndroidManifest.xml"],
123 stdout=subprocess.PIPE)
124 data, _ = p.communicate()
125 if p.returncode != 0:
126 raise ExternalError("failed to run aapt dump")
127 lines = data.split("\n")
128 for i in lines:
129 m = re.match(r'^\s*A: android:sharedUserId\([0-9a-fx]*\)="([^"]*)" .*$', i)
130 if m:
131 return m.group(1)
132 return None
133
134
135def CheckSharedUserIdsConsistent(input_tf_zip, apk_key_map):
136 """Check that all packages that request the same shared user id are
137 going to be signed with the same key."""
138
139 shared_user_apks = {}
Doug Zongker8ce7c252009-05-22 13:34:54 -0700140 maxlen = len("(unknown key)")
Doug Zongkereb338ef2009-05-20 16:50:49 -0700141
142 for info in input_tf_zip.infolist():
143 if info.filename.endswith(".apk"):
144 data = input_tf_zip.read(info.filename)
145
146 name = os.path.basename(info.filename)
147 shared_user = SharedUserForApk(data)
148 key = apk_key_map[name]
149 maxlen = max(maxlen, len(key))
150
151 if shared_user is not None:
152 shared_user_apks.setdefault(
153 shared_user, {}).setdefault(key, []).append(name)
154
155 errors = []
156 for k, v in shared_user_apks.iteritems():
157 # each shared user should have exactly one key used for all the
158 # apks that want that user.
159 if len(v) > 1:
160 errors.append((k, v))
161
162 if not errors: return
163
164 print "ERROR: shared user inconsistency. All apks wanting to use"
165 print " a given shared user must be signed with the same key."
166 print
167 errors.sort()
168 for user, keys in errors:
169 print 'shared user id "%s":' % (user,)
170 for key, apps in keys.iteritems():
Doug Zongker8ce7c252009-05-22 13:34:54 -0700171 print ' %-*s %s' % (maxlen, key or "(unknown key)", apps[0])
Doug Zongkereb338ef2009-05-20 16:50:49 -0700172 for a in apps[1:]:
173 print (' ' * (maxlen+5)) + a
174 print
175
176 sys.exit(1)
177
178
Doug Zongkereef39442009-04-02 12:14:19 -0700179def SignApk(data, keyname, pw):
180 unsigned = tempfile.NamedTemporaryFile()
181 unsigned.write(data)
182 unsigned.flush()
183
184 signed = tempfile.NamedTemporaryFile()
185
186 common.SignFile(unsigned.name, signed.name, keyname, pw, align=4)
187
188 data = signed.read()
189 unsigned.close()
190 signed.close()
191
192 return data
193
194
Doug Zongkereb338ef2009-05-20 16:50:49 -0700195def SignApks(input_tf_zip, output_tf_zip, apk_key_map, key_passwords):
Doug Zongkereef39442009-04-02 12:14:19 -0700196 maxsize = max([len(os.path.basename(i.filename))
197 for i in input_tf_zip.infolist()
198 if i.filename.endswith('.apk')])
199
200 for info in input_tf_zip.infolist():
201 data = input_tf_zip.read(info.filename)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700202 out_info = copy.copy(info)
Doug Zongkereef39442009-04-02 12:14:19 -0700203 if info.filename.endswith(".apk"):
204 name = os.path.basename(info.filename)
Doug Zongker43874f82009-04-14 14:05:15 -0700205 key = apk_key_map[name]
206 if key:
207 print " signing: %-*s (%s)" % (maxsize, name, key)
Doug Zongkereef39442009-04-02 12:14:19 -0700208 signed_data = SignApk(data, key, key_passwords[key])
Doug Zongker8e931bf2009-04-06 15:21:45 -0700209 output_tf_zip.writestr(out_info, signed_data)
Doug Zongkereef39442009-04-02 12:14:19 -0700210 else:
211 # an APK we're not supposed to sign.
Doug Zongker43874f82009-04-14 14:05:15 -0700212 print "NOT signing: %s" % (name,)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700213 output_tf_zip.writestr(out_info, data)
214 elif info.filename in ("SYSTEM/build.prop",
215 "RECOVERY/RAMDISK/default.prop"):
Doug Zongker17aa9442009-04-17 10:15:58 -0700216 print "rewriting %s:" % (info.filename,)
217 new_data = RewriteProps(data)
218 output_tf_zip.writestr(out_info, new_data)
Doug Zongkereef39442009-04-02 12:14:19 -0700219 else:
220 # a non-APK file; copy it verbatim
Doug Zongker8e931bf2009-04-06 15:21:45 -0700221 output_tf_zip.writestr(out_info, data)
222
223
Doug Zongker17aa9442009-04-17 10:15:58 -0700224def RewriteProps(data):
225 output = []
226 for line in data.split("\n"):
227 line = line.strip()
228 original_line = line
229 if line and line[0] != '#':
230 key, value = line.split("=", 1)
231 if key == "ro.build.fingerprint":
232 pieces = line.split("/")
233 tags = set(pieces[-1].split(","))
Doug Zongkerae877012009-04-21 10:04:51 -0700234 for ch in OPTIONS.tag_changes:
235 if ch[0] == "-":
236 tags.discard(ch[1:])
237 elif ch[0] == "+":
238 tags.add(ch[1:])
Doug Zongker17aa9442009-04-17 10:15:58 -0700239 line = "/".join(pieces[:-1] + [",".join(sorted(tags))])
240 elif key == "ro.build.description":
241 pieces = line.split(" ")
242 assert len(pieces) == 5
243 tags = set(pieces[-1].split(","))
Doug Zongkerae877012009-04-21 10:04:51 -0700244 for ch in OPTIONS.tag_changes:
245 if ch[0] == "-":
246 tags.discard(ch[1:])
247 elif ch[0] == "+":
248 tags.add(ch[1:])
Doug Zongker17aa9442009-04-17 10:15:58 -0700249 line = " ".join(pieces[:-1] + [",".join(sorted(tags))])
250 if line != original_line:
251 print " replace: ", original_line
252 print " with: ", line
253 output.append(line)
254 return "\n".join(output) + "\n"
255
256
Doug Zongker8e931bf2009-04-06 15:21:45 -0700257def ReplaceOtaKeys(input_tf_zip, output_tf_zip):
258 try:
259 keylist = input_tf_zip.read("META/otakeys.txt").split()
260 except KeyError:
261 raise ExternalError("can't read META/otakeys.txt from input")
262
263 mapped_keys = []
264 for k in keylist:
265 m = re.match(r"^(.*)\.x509\.pem$", k)
266 if not m:
267 raise ExternalError("can't parse \"%s\" from META/otakeys.txt" % (k,))
268 k = m.group(1)
269 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
270
271 print "using:\n ", "\n ".join(mapped_keys)
272 print "for OTA package verification"
273
274 # recovery uses a version of the key that has been slightly
275 # predigested (by DumpPublicKey.java) and put in res/keys.
276
Doug Zongker602a84e2009-06-18 08:35:12 -0700277 p = common.Run(["java", "-jar",
278 os.path.join(OPTIONS.search_path, "framework", "dumpkey.jar")]
279 + mapped_keys,
Doug Zongker8e931bf2009-04-06 15:21:45 -0700280 stdout=subprocess.PIPE)
281 data, _ = p.communicate()
282 if p.returncode != 0:
283 raise ExternalError("failed to run dumpkeys")
Doug Zongker048e7ca2009-06-15 14:31:53 -0700284 common.ZipWriteStr(output_tf_zip, "RECOVERY/RAMDISK/res/keys", data)
Doug Zongker8e931bf2009-04-06 15:21:45 -0700285
286 # SystemUpdateActivity uses the x509.pem version of the keys, but
287 # put into a zipfile system/etc/security/otacerts.zip.
288
289 tempfile = cStringIO.StringIO()
290 certs_zip = zipfile.ZipFile(tempfile, "w")
291 for k in mapped_keys:
292 certs_zip.write(k)
293 certs_zip.close()
Doug Zongker048e7ca2009-06-15 14:31:53 -0700294 common.ZipWriteStr(output_tf_zip, "SYSTEM/etc/security/otacerts.zip",
295 tempfile.getvalue())
Doug Zongkereef39442009-04-02 12:14:19 -0700296
297
298def main(argv):
299
300 def option_handler(o, a):
Doug Zongker05d3dea2009-06-22 11:32:31 -0700301 if o in ("-e", "--extra_apks"):
Doug Zongkereef39442009-04-02 12:14:19 -0700302 names, key = a.split("=")
303 names = names.split(",")
304 for n in names:
305 OPTIONS.extra_apks[n] = key
306 elif o in ("-d", "--default_key_mappings"):
307 OPTIONS.key_map.update({
308 "build/target/product/security/testkey": "%s/releasekey" % (a,),
309 "build/target/product/security/media": "%s/media" % (a,),
310 "build/target/product/security/shared": "%s/shared" % (a,),
311 "build/target/product/security/platform": "%s/platform" % (a,),
312 })
313 elif o in ("-k", "--key_mapping"):
314 s, d = a.split("=")
315 OPTIONS.key_map[s] = d
Doug Zongker8e931bf2009-04-06 15:21:45 -0700316 elif o in ("-o", "--replace_ota_keys"):
317 OPTIONS.replace_ota_keys = True
Doug Zongkerae877012009-04-21 10:04:51 -0700318 elif o in ("-t", "--tag_changes"):
319 new = []
320 for i in a.split(","):
321 i = i.strip()
322 if not i or i[0] not in "-+":
323 raise ValueError("Bad tag change '%s'" % (i,))
324 new.append(i[0] + i[1:].strip())
325 OPTIONS.tag_changes = tuple(new)
Doug Zongkereef39442009-04-02 12:14:19 -0700326 else:
327 return False
328 return True
329
330 args = common.ParseOptions(argv, __doc__,
Doug Zongker05d3dea2009-06-22 11:32:31 -0700331 extra_opts="e:d:k:ot:",
332 extra_long_opts=["extra_apks=",
Doug Zongkereef39442009-04-02 12:14:19 -0700333 "default_key_mappings=",
Doug Zongker8e931bf2009-04-06 15:21:45 -0700334 "key_mapping=",
Doug Zongker17aa9442009-04-17 10:15:58 -0700335 "replace_ota_keys",
Doug Zongkerae877012009-04-21 10:04:51 -0700336 "tag_changes="],
Doug Zongkereef39442009-04-02 12:14:19 -0700337 extra_option_handler=option_handler)
338
339 if len(args) != 2:
340 common.Usage(__doc__)
341 sys.exit(1)
342
343 input_zip = zipfile.ZipFile(args[0], "r")
344 output_zip = zipfile.ZipFile(args[1], "w")
345
Doug Zongkereb338ef2009-05-20 16:50:49 -0700346 apk_key_map = GetApkCerts(input_zip)
347 CheckAllApksSigned(input_zip, apk_key_map)
348 CheckSharedUserIdsConsistent(input_zip, apk_key_map)
349
350 key_passwords = common.GetKeyPasswords(set(apk_key_map.values()))
351 SignApks(input_zip, output_zip, apk_key_map, key_passwords)
Doug Zongkereef39442009-04-02 12:14:19 -0700352
Doug Zongker8e931bf2009-04-06 15:21:45 -0700353 if OPTIONS.replace_ota_keys:
354 ReplaceOtaKeys(input_zip, output_zip)
355
Doug Zongkereef39442009-04-02 12:14:19 -0700356 input_zip.close()
357 output_zip.close()
358
359 print "done."
360
361
362if __name__ == '__main__':
363 try:
364 main(sys.argv[1:])
365 except common.ExternalError, e:
366 print
367 print " ERROR: %s" % (e,)
368 print
369 sys.exit(1)