3 # Copyright (C) 2008 The Android Open Source Project
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 Signs all the APK files in a target-files zipfile, producing a new
21 Usage: sign_target_files_apks [flags] input_target_files output_target_files
23 -e (--extra_apks) <name,name,...=key>
24 Add extra APK name/key pairs as though they appeared in
25 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.
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
36 -d (--default_key_mappings) <dir>
37 Set up the following key mappings:
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
44 -d and -k options are added to the set of mappings in the order
45 in which they appear on the command line.
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.
53 -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,+release-keys".
64 if sys.hexversion < 0x02040000:
65 print >> sys.stderr, "Python 2.4 or newer is required."
78 OPTIONS = common.OPTIONS
80 OPTIONS.extra_apks = {}
82 OPTIONS.replace_ota_keys = False
83 OPTIONS.tag_changes = ("-test-keys", "+release-keys")
85 def GetApkCerts(tf_zip):
87 for line in tf_zip.read("META/apkcerts.txt").split("\n"):
90 m = re.match(r'^name="(.*)"\s+certificate="(.*)\.x509\.pem"\s+'
91 r'private_key="\2\.pk8"$', line)
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))
95 for apk, cert in OPTIONS.extra_apks.iteritems():
96 certmap[apk] = OPTIONS.key_map.get(cert, cert)
100 def 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."""
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)
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)."
117 def SharedUserForApk(data):
118 tmp = tempfile.NamedTemporaryFile()
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")
129 m = re.match(r'^\s*A: android:sharedUserId\([0-9a-fx]*\)="([^"]*)" .*$', i)
135 def 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."""
139 shared_user_apks = {}
140 maxlen = len("(unknown key)")
142 for info in input_tf_zip.infolist():
143 if info.filename.endswith(".apk"):
144 data = input_tf_zip.read(info.filename)
146 name = os.path.basename(info.filename)
147 shared_user = SharedUserForApk(data)
148 key = apk_key_map[name]
149 maxlen = max(maxlen, len(key))
151 if shared_user is not None:
152 shared_user_apks.setdefault(
153 shared_user, {}).setdefault(key, []).append(name)
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.
160 errors.append((k, v))
162 if not errors: return
164 print "ERROR: shared user inconsistency. All apks wanting to use"
165 print " a given shared user must be signed with the same key."
168 for user, keys in errors:
169 print 'shared user id "%s":' % (user,)
170 for key, apps in keys.iteritems():
171 print ' %-*s %s' % (maxlen, key or "(unknown key)", apps[0])
173 print (' ' * (maxlen+5)) + a
179 def SignApk(data, keyname, pw):
180 unsigned = tempfile.NamedTemporaryFile()
184 signed = tempfile.NamedTemporaryFile()
186 common.SignFile(unsigned.name, signed.name, keyname, pw, align=4)
195 def SignApks(input_tf_zip, output_tf_zip, apk_key_map, key_passwords):
196 maxsize = max([len(os.path.basename(i.filename))
197 for i in input_tf_zip.infolist()
198 if i.filename.endswith('.apk')])
200 for info in input_tf_zip.infolist():
201 data = input_tf_zip.read(info.filename)
202 out_info = copy.copy(info)
203 if info.filename.endswith(".apk"):
204 name = os.path.basename(info.filename)
205 key = apk_key_map[name]
207 print " signing: %-*s (%s)" % (maxsize, name, key)
208 signed_data = SignApk(data, key, key_passwords[key])
209 output_tf_zip.writestr(out_info, signed_data)
211 # an APK we're not supposed to sign.
212 print "NOT signing: %s" % (name,)
213 output_tf_zip.writestr(out_info, data)
214 elif info.filename in ("SYSTEM/build.prop",
215 "RECOVERY/RAMDISK/default.prop"):
216 print "rewriting %s:" % (info.filename,)
217 new_data = RewriteProps(data)
218 output_tf_zip.writestr(out_info, new_data)
220 # a non-APK file; copy it verbatim
221 output_tf_zip.writestr(out_info, data)
224 def RewriteProps(data):
226 for line in data.split("\n"):
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(","))
234 for ch in OPTIONS.tag_changes:
239 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(","))
244 for ch in OPTIONS.tag_changes:
249 line = " ".join(pieces[:-1] + [",".join(sorted(tags))])
250 if line != original_line:
251 print " replace: ", original_line
252 print " with: ", line
254 return "\n".join(output) + "\n"
257 def ReplaceOtaKeys(input_tf_zip, output_tf_zip):
259 keylist = input_tf_zip.read("META/otakeys.txt").split()
261 raise ExternalError("can't read META/otakeys.txt from input")
265 m = re.match(r"^(.*)\.x509\.pem$", k)
267 raise ExternalError("can't parse \"%s\" from META/otakeys.txt" % (k,))
269 mapped_keys.append(OPTIONS.key_map.get(k, k) + ".x509.pem")
272 print "using:\n ", "\n ".join(mapped_keys)
273 print "for OTA package verification"
276 OPTIONS.key_map["build/target/product/security/testkey"] + ".x509.pem")
277 print "META/otakeys.txt has no keys; using", mapped_keys[0]
279 # recovery uses a version of the key that has been slightly
280 # predigested (by DumpPublicKey.java) and put in res/keys.
282 p = common.Run(["java", "-jar",
283 os.path.join(OPTIONS.search_path, "framework", "dumpkey.jar")]
285 stdout=subprocess.PIPE)
286 data, _ = p.communicate()
287 if p.returncode != 0:
288 raise ExternalError("failed to run dumpkeys")
289 common.ZipWriteStr(output_tf_zip, "RECOVERY/RAMDISK/res/keys", data)
291 # SystemUpdateActivity uses the x509.pem version of the keys, but
292 # put into a zipfile system/etc/security/otacerts.zip.
294 tempfile = cStringIO.StringIO()
295 certs_zip = zipfile.ZipFile(tempfile, "w")
296 for k in mapped_keys:
299 common.ZipWriteStr(output_tf_zip, "SYSTEM/etc/security/otacerts.zip",
305 def option_handler(o, a):
306 if o in ("-e", "--extra_apks"):
307 names, key = a.split("=")
308 names = names.split(",")
310 OPTIONS.extra_apks[n] = key
311 elif o in ("-d", "--default_key_mappings"):
312 OPTIONS.key_map.update({
313 "build/target/product/security/testkey": "%s/releasekey" % (a,),
314 "build/target/product/security/media": "%s/media" % (a,),
315 "build/target/product/security/shared": "%s/shared" % (a,),
316 "build/target/product/security/platform": "%s/platform" % (a,),
318 elif o in ("-k", "--key_mapping"):
320 OPTIONS.key_map[s] = d
321 elif o in ("-o", "--replace_ota_keys"):
322 OPTIONS.replace_ota_keys = True
323 elif o in ("-t", "--tag_changes"):
325 for i in a.split(","):
327 if not i or i[0] not in "-+":
328 raise ValueError("Bad tag change '%s'" % (i,))
329 new.append(i[0] + i[1:].strip())
330 OPTIONS.tag_changes = tuple(new)
335 args = common.ParseOptions(argv, __doc__,
336 extra_opts="e:d:k:ot:",
337 extra_long_opts=["extra_apks=",
338 "default_key_mappings=",
342 extra_option_handler=option_handler)
345 common.Usage(__doc__)
348 input_zip = zipfile.ZipFile(args[0], "r")
349 output_zip = zipfile.ZipFile(args[1], "w")
351 apk_key_map = GetApkCerts(input_zip)
352 CheckAllApksSigned(input_zip, apk_key_map)
353 CheckSharedUserIdsConsistent(input_zip, apk_key_map)
355 key_passwords = common.GetKeyPasswords(set(apk_key_map.values()))
356 SignApks(input_zip, output_zip, apk_key_map, key_passwords)
358 if OPTIONS.replace_ota_keys:
359 ReplaceOtaKeys(input_zip, output_zip)
367 if __name__ == '__main__':
370 except common.ExternalError, e:
372 print " ERROR: %s" % (e,)