This repository has been archived by the owner on Sep 15, 2021. It is now read-only.
/
sign_android.py
executable file
·349 lines (326 loc) · 14.3 KB
/
sign_android.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
#!/usr/bin/env python
# ***** BEGIN LICENSE BLOCK *****
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
# ***** END LICENSE BLOCK *****
"""sign_android.py
"""
# TODO split out signing and transfers to helper objects so we can do
# the downloads/signing/uploads in parallel, speeding that up
# TODO retire this script when Android signing-on-demand lands.
from copy import deepcopy
import os
import sys
# load modules from parent dir
sys.path.insert(1, os.path.dirname(sys.path[0]))
from mozharness.base.log import ERROR, FATAL
from mozharness.base.transfer import TransferMixin
from mozharness.mozilla.release import ReleaseMixin
from mozharness.mozilla.signing import MobileSigningMixin
from mozharness.base.vcs.vcsbase import MercurialScript
from mozharness.mozilla.l10n.locales import LocalesMixin
# So far this only references the ftp platform name.
SUPPORTED_PLATFORMS = ["android", "android-armv6"]
# SignAndroid {{{1
class SignAndroid(LocalesMixin, ReleaseMixin, MobileSigningMixin,
TransferMixin, MercurialScript):
config_options = [[
['--locale',],
{"action": "extend",
"dest": "locales",
"type": "string",
"help": "Specify the locale(s) to sign and update"
}
],[
['--locales-file',],
{"action": "store",
"dest": "locales_file",
"type": "string",
"help": "Specify a json file to determine which locales to sign and update"
}
],[
['--tag-override',],
{"action": "store",
"dest": "tag_override",
"type": "string",
"help": "Override the tags set for all repos"
}
],[
['--platform',],
{"action": "extend",
"dest": "platforms",
"type": "choice",
"choices": SUPPORTED_PLATFORMS,
"help": "Specify the platform(s) to sign"
}
],[
['--user-repo-override',],
{"action": "store",
"dest": "user_repo_override",
"type": "string",
"help": "Override the user repo path for all repos"
}
],[
['--key-alias',],
{"action": "store",
"dest": "key_alias",
"type": "choice",
"choices": ['production', 'nightly'],
"help": "Specify the key alias"
}
],[
['--release-config-file',],
{"action": "store",
"dest": "release_config_file",
"type": "string",
"help": "Specify the release config file to use"
}
],[
['--version',],
{"action": "store",
"dest": "version",
"type": "string",
"help": "Specify the current version"
}
],[
['--buildnum',],
{"action": "store",
"dest": "buildnum",
"type": "int",
"default": 1,
"metavar": "INT",
"help": "Specify the current release build num (e.g. build1, build2)"
}
],[
['--keystore',],
{"action": "store",
"dest": "keystore",
"type": "string",
"help": "Specify the location of the signing keystore"
}
],[
# XXX this is a bit of a hack.
# Ideally we'd have fully configured partner repack info with their own
# actions so they could be handled discretely.
# However, the ideal long term solution will involve signing-on-demand;
# this, along with signing support in mobile_partner_repack.py,
# seems to be an acceptable interim solution.
['--with-partner-repacks',],
{"action": "store_true",
"dest": "enable_partner_repacks",
"default": False,
"help": "Download, sign, and verify partner repacks as well."
}
]]
def __init__(self, require_config_file=True):
self.release_config = {}
LocalesMixin.__init__(self)
MobileSigningMixin.__init__(self)
MercurialScript.__init__(self,
config_options=self.config_options,
all_actions=[
"passphrase",
"clobber",
"pull",
"download-unsigned-bits",
"sign",
"verify-signatures",
"upload-signed-bits",
],
require_config_file=require_config_file
)
# Helper methods {{{2
def add_failure(self, platform, locale, **kwargs):
s = "%s:%s" % (platform, locale)
if 'message' in kwargs:
kwargs['message'] = kwargs['message'] % {'platform': platform, 'locale': locale}
super(SignAndroid, self).add_failure(s, **kwargs)
def query_failure(self, platform, locale):
s = "%s:%s" % (platform, locale)
return super(SignAndroid, self).query_failure(s)
def query_platform_locales(self, platform):
return self.config['platform_config'][platform].get('locales', self.query_locales())
def query_platform_apk_base_name(self, platform):
return self.config['platform_config'][platform].get('apk_base_name', self.config['apk_base_name'])
# Actions {{{2
# passphrase() is in AndroidSigningMixin
# verify_passphrases() is in AndroidSigningMixin
# postflight_passphrase() is in AndroidSigningMixin
def pull(self):
c = self.config
dirs = self.query_abs_dirs()
repos = []
replace_dict = {}
if c.get("user_repo_override"):
replace_dict['user_repo_override'] = c['user_repo_override']
# deepcopy() needed because of self.config lock bug :(
for repo_dict in deepcopy(c['repos']):
repo_dict['repo'] = repo_dict['repo'] % replace_dict
repos.append(repo_dict)
else:
repos = c['repos']
self.vcs_checkout_repos(repos, parent_dir=dirs['abs_work_dir'],
tag_override=c.get('tag_override'))
def download_unsigned_bits(self):
c = self.config
rc = self.query_release_config()
dirs = self.query_abs_dirs()
replace_dict = {
'buildnum': rc['buildnum'],
'version': rc['version'],
}
success_count = total_count = 0
for platform in c['platforms']:
base_url = c['download_base_url'] + '/' + \
c['download_unsigned_base_subdir'] + '/' + \
self.query_platform_apk_base_name(platform)
replace_dict['platform'] = platform
locales = self.query_platform_locales(platform)
for locale in locales:
replace_dict['locale'] = locale
url = base_url % replace_dict
parent_dir = '%s/unsigned/%s/%s' % (dirs['abs_work_dir'],
platform, locale)
file_path = '%s/gecko.ap_' % parent_dir
self.mkdir_p(parent_dir)
total_count += 1
if not self.download_file(url, file_path):
self.add_failure(platform, locale,
message="Unable to download %(platform)s:%(locale)s unsigned apk!")
else:
success_count += 1
self.summarize_success_count(success_count, total_count,
message="Downloaded %d of %d unsigned apks successfully.")
if c['enable_partner_repacks']:
self.info("Downloading partner-repacks")
if replace_dict.get('platform'):
del(replace_dict['platform'])
remote_dir = c['ftp_upload_base_dir'] % replace_dict + '/unsigned/partner-repacks'
local_dir = os.path.join(dirs['abs_work_dir'], 'unsigned', 'partner-repacks')
self.mkdir_p(local_dir)
if self.rsync_download_directory(rc['ftp_ssh_key'], rc['ftp_user'],
rc['ftp_server'], remote_dir,
local_dir):
self.add_summary("Unable to download partner repacks!", level=ERROR)
self.rmtree(local_dir)
def preflight_sign(self):
if 'passphrase' not in self.actions:
self.passphrase()
self.verify_passphrases()
def sign(self):
c = self.config
rc = self.query_release_config()
dirs = self.query_abs_dirs()
success_count = total_count = 0
for platform in c['platforms']:
locales = self.query_platform_locales(platform)
for locale in locales:
if self.query_failure(platform, locale):
self.warning("%s:%s had previous issues; skipping!" % (platform, locale))
continue
unsigned_path = '%s/unsigned/%s/%s/gecko.ap_' % (dirs['abs_work_dir'], platform, locale)
signed_dir = '%s/signed/%s/%s' % (dirs['abs_work_dir'], platform, locale)
signed_file_name = self.query_platform_apk_base_name(platform) % {'version': rc['version'], 'locale': locale}
signed_path = "%s/%s" % (signed_dir, signed_file_name)
total_count += 1
self.info("Signing %s %s." % (platform, locale))
if not os.path.exists(unsigned_path):
self.error("Missing apk %s!" % unsigned_path)
continue
if self.sign_apk(unsigned_path, c['keystore'],
self.store_passphrase, self.key_passphrase,
c['key_alias']) != 0:
self.add_summary("Unable to sign %s:%s apk!" % (platform, locale),
level=FATAL)
else:
self.mkdir_p(signed_dir)
if self.align_apk(unsigned_path, signed_path):
self.add_failure(platform, locale,
message="Unable to align %(platform)s:%(locale)s apk!")
self.rmtree(signed_dir)
else:
success_count += 1
self.summarize_success_count(success_count, total_count,
message="Signed %d of %d apks successfully.")
if c['enable_partner_repacks']:
total_count = success_count = 0
self.info("Signing partner repacks.")
for partner in c.get("partners", []):
for platform in c.get("partner_platforms", []):
locales = self.query_platform_locales(platform)
for locale in locales:
file_name = self.query_platform_apk_base_name(platform) % {'version': rc['version'], 'locale': locale}
unsigned_path = '%s/unsigned/partner-repacks/%s/%s/%s/%s' % (dirs['abs_work_dir'], partner, platform, locale, file_name)
signed_dir = '%s/signed/partner-repacks/%s/%s/%s' % (dirs['abs_work_dir'], partner, platform, locale)
signed_path = '%s/%s' % (signed_dir, file_name)
total_count += 1
self.info("Signing %s %s %s." % (partner, platform, locale))
if not os.path.exists(unsigned_path):
self.warning("%s doesn't exist; skipping." % unsigned_path)
continue
if self.sign_apk(unsigned_path, c['keystore'],
self.store_passphrase, self.key_passphrase,
c['key_alias']) != 0:
self.add_summary("Unable to sign %s %s:%s apk!" % (partner, platform, locale),
level=ERROR)
continue
else:
self.mkdir_p(signed_dir)
if self.align_apk(unsigned_path, signed_path):
self.add_summary("Unable to align %s %s:%s apk!" % (partner, platform, locale))
self.rmtree(signed_dir)
else:
success_count += 1
self.summarize_success_count(success_count, total_count,
message="Signed %d of %d partner apks successfully.")
def verify_signatures(self):
c = self.config
rc = self.query_release_config()
dirs = self.query_abs_dirs()
env = self.query_env(partial_env=c.get("env"))
for platform in c['platforms']:
locales = self.query_platform_locales(platform)
for locale in locales:
if self.query_failure(platform, locale):
self.warning("%s:%s had previous issues; skipping!" % (platform, locale))
continue
signed_path = 'signed/%s/%s/%s' % (platform, locale,
self.query_platform_apk_base_name(platform) % {'version': rc['version'], 'locale': locale})
if not os.path.exists(os.path.join(dirs['abs_work_dir'],
signed_path)):
self.add_failure(platform, locale,
message="Can't verify nonexistent %(platform)s:%(locale)s apk!")
continue
status = self.verify_android_signature(
signed_path,
script=c['signature_verification_script'],
key_alias=c['key_alias'],
tools_dir="tools/",
env=env,
)
if status:
self.add_failure(platform, locale,
message="Errors verifying %(platform)s:%(locale)s apk!")
# rm to avoid uploading ?
self.rmtree(signed_path)
def upload_signed_bits(self):
c = self.config
dirs = self.query_abs_dirs()
if not c['platforms']:
self.info("No platforms to rsync! Skipping...")
return
rc = self.query_release_config()
signed_dir = os.path.join(dirs['abs_work_dir'], 'signed')
ftp_upload_dir = c['ftp_upload_base_dir'] % {
'version': rc['version'],
'buildnum': rc['buildnum'],
}
if self.rsync_upload_directory(signed_dir, rc['ftp_ssh_key'],
rc['ftp_user'], rc['ftp_server'],
ftp_upload_dir,):
self.return_code += 1
# main {{{1
if __name__ == '__main__':
sign_android = SignAndroid()
sign_android.run()