3 # update.py - part of the FDroid server tools
4 # Copyright (C) 2017, Torsten Grote <t at grobox dot de>
5 # Copyright (C) 2016, Blue Jay Wireless
6 # Copyright (C) 2014-2016, Hans-Christoph Steiner <hans@eds.org>
7 # Copyright (C) 2010-2015, Ciaran Gultnieks <ciaran@ciarang.com>
8 # Copyright (C) 2013-2014, Daniel Martà <mvdan@mvdan.cc>
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU Affero General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU Affero General Public License for more details.
20 # You should have received a copy of the GNU Affero General Public License
21 # along with this program. If not, see <http://www.gnu.org/licenses/>.
33 from binascii import hexlify, unhexlify
34 from datetime import datetime
35 from xml.dom.minidom import Document
37 from fdroidserver import metadata, signindex, common, net
38 from fdroidserver.common import FDroidPopen, FDroidPopenBytes
39 from fdroidserver.exception import FDroidException, VerificationException, MetaDataException
42 def make(apps, sortedids, apks, repodir, archive):
43 """Generate the repo index files.
45 This requires properly initialized options and config objects.
47 :param apps: fully populated apps list
48 :param sortedids: app package IDs, sorted
49 :param apks: full populated apks list
50 :param repodir: the repo directory
51 :param archive: True if this is the archive repo, False if it's the
54 from fdroidserver.update import METADATA_VERSION
56 def _resolve_description_link(appid):
58 return "fdroid.app:" + appid, apps[appid].Name
59 raise MetaDataException("Cannot resolve app id " + appid)
62 if not common.options.nosign:
63 if 'repo_keyalias' not in common.config:
65 logging.critical("'repo_keyalias' not found in config.py!")
66 if 'keystore' not in common.config:
68 logging.critical("'keystore' not found in config.py!")
69 if 'keystorepass' not in common.config:
71 logging.critical("'keystorepass' not found in config.py!")
72 if 'keypass' not in common.config:
74 logging.critical("'keypass' not found in config.py!")
75 if not os.path.exists(common.config['keystore']):
77 logging.critical("'" + common.config['keystore'] + "' does not exist!")
79 raise FDroidException("`fdroid update` requires a signing key, " +
80 "you can create one using: fdroid update --create-key")
82 repodict = collections.OrderedDict()
83 repodict['timestamp'] = datetime.utcnow()
84 repodict['version'] = METADATA_VERSION
86 if common.config['repo_maxage'] != 0:
87 repodict['maxage'] = common.config['repo_maxage']
90 repodict['name'] = common.config['archive_name']
91 repodict['icon'] = os.path.basename(common.config['archive_icon'])
92 repodict['address'] = common.config['archive_url']
93 repodict['description'] = common.config['archive_description']
94 urlbasepath = os.path.basename(urllib.parse.urlparse(common.config['archive_url']).path)
96 repodict['name'] = common.config['repo_name']
97 repodict['icon'] = os.path.basename(common.config['repo_icon'])
98 repodict['address'] = common.config['repo_url']
99 repodict['description'] = common.config['repo_description']
100 urlbasepath = os.path.basename(urllib.parse.urlparse(common.config['repo_url']).path)
102 mirrorcheckfailed = False
104 for mirror in sorted(common.config.get('mirrors', [])):
105 base = os.path.basename(urllib.parse.urlparse(mirror).path.rstrip('/'))
106 if common.config.get('nonstandardwebroot') is not True and base != 'fdroid':
107 logging.error("mirror '" + mirror + "' does not end with 'fdroid'!")
108 mirrorcheckfailed = True
109 # must end with / or urljoin strips a whole path segment
110 if mirror.endswith('/'):
111 mirrors.append(urllib.parse.urljoin(mirror, urlbasepath))
113 mirrors.append(urllib.parse.urljoin(mirror + '/', urlbasepath))
114 for mirror in common.config.get('servergitmirrors', []):
115 mirror = get_mirror_service_url(mirror)
116 if mirror is not None:
117 mirrors.append(mirror + '/')
118 if mirrorcheckfailed:
119 raise FDroidException("Malformed repository mirrors.")
121 repodict['mirrors'] = mirrors
123 appsWithPackages = collections.OrderedDict()
124 for packageName in sortedids:
125 app = apps[packageName]
129 # only include apps with packages
131 if apk['packageName'] == packageName:
132 newapp = copy.copy(app) # update wiki needs unmodified description
133 newapp['Description'] = metadata.description_html(app['Description'],
134 _resolve_description_link)
135 appsWithPackages[packageName] = newapp
138 requestsdict = collections.OrderedDict()
139 for command in ('install', 'uninstall'):
141 key = command + '_list'
142 if key in common.config:
143 if isinstance(common.config[key], str):
144 packageNames = [common.config[key]]
145 elif all(isinstance(item, str) for item in common.config[key]):
146 packageNames = common.config[key]
148 raise TypeError('only accepts strings, lists, and tuples')
149 requestsdict[command] = packageNames
151 make_v0(appsWithPackages, apks, repodir, repodict, requestsdict)
152 make_v1(appsWithPackages, apks, repodir, repodict, requestsdict)
155 def make_v1(apps, packages, repodir, repodict, requestsdict):
157 def _index_encoder_default(obj):
158 if isinstance(obj, set):
160 if isinstance(obj, datetime):
161 return int(obj.timestamp() * 1000) # Java expects milliseconds
162 raise TypeError(repr(obj) + " is not JSON serializable")
164 output = collections.OrderedDict()
165 output['repo'] = repodict
166 output['requests'] = requestsdict
169 output['apps'] = appslist
170 for packageName, appdict in apps.items():
171 d = collections.OrderedDict()
173 for k, v in sorted(appdict.items()):
176 if k in ('builds', 'comments', 'metadatapath',
177 'ArchivePolicy', 'AutoUpdateMode', 'MaintainerNotes',
178 'Provides', 'Repo', 'RepoType', 'RequiresRoot',
179 'UpdateCheckData', 'UpdateCheckIgnore', 'UpdateCheckMode',
180 'UpdateCheckName', 'NoSourceSince', 'VercodeOperation'):
183 # name things after the App class fields in fdroidclient
186 elif k == 'CurrentVersionCode': # TODO make SuggestedVersionCode the canonical name
187 k = 'suggestedVersionCode'
188 elif k == 'CurrentVersion': # TODO make SuggestedVersionName the canonical name
189 k = 'suggestedVersionName'
190 elif k == 'AutoName':
191 if 'Name' not in apps[packageName]:
195 k = k[:1].lower() + k[1:]
198 output_packages = collections.OrderedDict()
199 output['packages'] = output_packages
200 for package in packages:
201 packageName = package['packageName']
202 if packageName not in apps:
203 logging.info('Ignoring package without metadata: ' + package['apkName'])
205 if packageName in output_packages:
206 packagelist = output_packages[packageName]
209 output_packages[packageName] = packagelist
210 d = collections.OrderedDict()
211 packagelist.append(d)
212 for k, v in sorted(package.items()):
215 if k in ('icon', 'icons', 'icons_src', 'name', ):
219 json_name = 'index-v1.json'
220 index_file = os.path.join(repodir, json_name)
221 with open(index_file, 'w') as fp:
222 if common.options.pretty:
223 json.dump(output, fp, default=_index_encoder_default, indent=2)
225 json.dump(output, fp, default=_index_encoder_default)
227 if common.options.nosign:
228 logging.debug('index-v1 must have a signature, use `fdroid signindex` to create it!')
230 signindex.config = common.config
231 signindex.sign_index_v1(repodir, json_name)
234 def make_v0(apps, apks, repodir, repodict, requestsdict):
236 aka index.jar aka index.xml
241 def addElement(name, value, doc, parent):
242 el = doc.createElement(name)
243 el.appendChild(doc.createTextNode(value))
244 parent.appendChild(el)
246 def addElementNonEmpty(name, value, doc, parent):
249 addElement(name, value, doc, parent)
251 def addElementIfInApk(name, apk, key, doc, parent):
254 value = str(apk[key])
255 addElement(name, value, doc, parent)
257 def addElementCDATA(name, value, doc, parent):
258 el = doc.createElement(name)
259 el.appendChild(doc.createCDATASection(value))
260 parent.appendChild(el)
262 root = doc.createElement("fdroid")
263 doc.appendChild(root)
265 repoel = doc.createElement("repo")
267 repoel.setAttribute("name", repodict['name'])
268 if 'maxage' in repodict:
269 repoel.setAttribute("maxage", str(repodict['maxage']))
270 repoel.setAttribute("icon", os.path.basename(repodict['icon']))
271 repoel.setAttribute("url", repodict['address'])
272 addElement('description', repodict['description'], doc, repoel)
273 for mirror in repodict.get('mirrors', []):
274 addElement('mirror', mirror, doc, repoel)
276 repoel.setAttribute("version", str(repodict['version']))
277 repoel.setAttribute("timestamp", '%d' % repodict['timestamp'].timestamp())
279 pubkey, repo_pubkey_fingerprint = extract_pubkey()
280 repoel.setAttribute("pubkey", pubkey.decode('utf-8'))
281 root.appendChild(repoel)
283 for command in ('install', 'uninstall'):
284 for packageName in requestsdict[command]:
285 element = doc.createElement(command)
286 root.appendChild(element)
287 element.setAttribute('packageName', packageName)
289 for appid, appdict in apps.items():
290 app = metadata.App(appdict)
292 if app.Disabled is not None:
295 # Get a list of the apks for this app...
298 if apk['packageName'] == appid:
301 if len(apklist) == 0:
304 apel = doc.createElement("application")
305 apel.setAttribute("id", app.id)
306 root.appendChild(apel)
308 addElement('id', app.id, doc, apel)
310 addElement('added', app.added.strftime('%Y-%m-%d'), doc, apel)
312 addElement('lastupdated', app.lastUpdated.strftime('%Y-%m-%d'), doc, apel)
313 addElement('name', app.Name, doc, apel)
314 addElement('summary', app.Summary, doc, apel)
316 addElement('icon', app.icon, doc, apel)
318 if app.get('Description'):
319 description = app.Description
321 description = '<p>No description available</p>'
322 addElement('desc', description, doc, apel)
323 addElement('license', app.License, doc, apel)
325 addElement('categories', ','.join(app.Categories), doc, apel)
326 # We put the first (primary) category in LAST, which will have
327 # the desired effect of making clients that only understand one
328 # category see that one.
329 addElement('category', app.Categories[0], doc, apel)
330 addElement('web', app.WebSite, doc, apel)
331 addElement('source', app.SourceCode, doc, apel)
332 addElement('tracker', app.IssueTracker, doc, apel)
333 addElementNonEmpty('changelog', app.Changelog, doc, apel)
334 addElementNonEmpty('author', app.AuthorName, doc, apel)
335 addElementNonEmpty('email', app.AuthorEmail, doc, apel)
336 addElementNonEmpty('donate', app.Donate, doc, apel)
337 addElementNonEmpty('bitcoin', app.Bitcoin, doc, apel)
338 addElementNonEmpty('litecoin', app.Litecoin, doc, apel)
339 addElementNonEmpty('flattr', app.FlattrID, doc, apel)
341 # These elements actually refer to the current version (i.e. which
342 # one is recommended. They are historically mis-named, and need
343 # changing, but stay like this for now to support existing clients.
344 addElement('marketversion', app.CurrentVersion, doc, apel)
345 addElement('marketvercode', app.CurrentVersionCode, doc, apel)
348 pv = app.Provides.split(',')
349 addElementNonEmpty('provides', ','.join(pv), doc, apel)
351 addElement('requirements', 'root', doc, apel)
353 # Sort the apk list into version order, just so the web site
354 # doesn't have to do any work by default...
355 apklist = sorted(apklist, key=lambda apk: apk['versionCode'], reverse=True)
357 if 'antiFeatures' in apklist[0]:
358 app.AntiFeatures.extend(apklist[0]['antiFeatures'])
360 addElementNonEmpty('antifeatures', ','.join(app.AntiFeatures), doc, apel)
362 # Check for duplicates - they will make the client unhappy...
363 for i in range(len(apklist) - 1):
364 if apklist[i]['versionCode'] == apklist[i + 1]['versionCode']:
365 raise FDroidException("duplicate versions: '%s' - '%s'" % (
366 apklist[i]['apkName'], apklist[i + 1]['apkName']))
368 current_version_code = 0
369 current_version_file = None
371 file_extension = common.get_file_extension(apk['apkName'])
372 # find the APK for the "Current Version"
373 if current_version_code < apk['versionCode']:
374 current_version_code = apk['versionCode']
375 if current_version_code < int(app.CurrentVersionCode):
376 current_version_file = apk['apkName']
378 apkel = doc.createElement("package")
379 apel.appendChild(apkel)
380 addElement('version', apk['versionName'], doc, apkel)
381 addElement('versioncode', str(apk['versionCode']), doc, apkel)
382 addElement('apkname', apk['apkName'], doc, apkel)
383 addElementIfInApk('srcname', apk, 'srcname', doc, apkel)
385 hashel = doc.createElement("hash")
386 hashel.setAttribute('type', 'sha256')
387 hashel.appendChild(doc.createTextNode(apk['hash']))
388 apkel.appendChild(hashel)
390 addElement('size', str(apk['size']), doc, apkel)
391 addElementIfInApk('sdkver', apk,
392 'minSdkVersion', doc, apkel)
393 addElementIfInApk('targetSdkVersion', apk,
394 'targetSdkVersion', doc, apkel)
395 addElementIfInApk('maxsdkver', apk,
396 'maxSdkVersion', doc, apkel)
397 addElementIfInApk('obbMainFile', apk,
398 'obbMainFile', doc, apkel)
399 addElementIfInApk('obbMainFileSha256', apk,
400 'obbMainFileSha256', doc, apkel)
401 addElementIfInApk('obbPatchFile', apk,
402 'obbPatchFile', doc, apkel)
403 addElementIfInApk('obbPatchFileSha256', apk,
404 'obbPatchFileSha256', doc, apkel)
406 addElement('added', apk['added'].strftime('%Y-%m-%d'), doc, apkel)
408 if file_extension == 'apk': # sig is required for APKs, but only APKs
409 addElement('sig', apk['sig'], doc, apkel)
411 old_permissions = set()
412 sorted_permissions = sorted(apk['uses-permission'])
413 for perm in sorted_permissions:
414 perm_name = perm.name
415 if perm_name.startswith("android.permission."):
416 perm_name = perm_name[19:]
417 old_permissions.add(perm_name)
418 addElementNonEmpty('permissions', ','.join(sorted(old_permissions)), doc, apkel)
420 for permission in sorted_permissions:
421 permel = doc.createElement('uses-permission')
422 permel.setAttribute('name', permission.name)
423 if permission.maxSdkVersion is not None:
424 permel.setAttribute('maxSdkVersion', '%d' % permission.maxSdkVersion)
425 apkel.appendChild(permel)
426 for permission_sdk_23 in sorted(apk['uses-permission-sdk-23']):
427 permel = doc.createElement('uses-permission-sdk-23')
428 permel.setAttribute('name', permission_sdk_23.name)
429 if permission_sdk_23.maxSdkVersion is not None:
430 permel.setAttribute('maxSdkVersion', '%d' % permission_sdk_23.maxSdkVersion)
431 apkel.appendChild(permel)
432 if 'nativecode' in apk:
433 addElement('nativecode', ','.join(sorted(apk['nativecode'])), doc, apkel)
434 addElementNonEmpty('features', ','.join(sorted(apk['features'])), doc, apkel)
436 if current_version_file is not None \
437 and common.config['make_current_version_link'] \
438 and repodir == 'repo': # only create these
439 namefield = common.config['current_version_name_source']
440 sanitized_name = re.sub(b'''[ '"&%?+=/]''', b'', app.get(namefield).encode('utf-8'))
441 apklinkname = sanitized_name + b'.apk'
442 current_version_path = os.path.join(repodir, current_version_file).encode('utf-8', 'surrogateescape')
443 if os.path.islink(apklinkname):
444 os.remove(apklinkname)
445 os.symlink(current_version_path, apklinkname)
446 # also symlink gpg signature, if it exists
447 for extension in (b'.asc', b'.sig'):
448 sigfile_path = current_version_path + extension
449 if os.path.exists(sigfile_path):
450 siglinkname = apklinkname + extension
451 if os.path.islink(siglinkname):
452 os.remove(siglinkname)
453 os.symlink(sigfile_path, siglinkname)
455 if common.options.pretty:
456 output = doc.toprettyxml(encoding='utf-8')
458 output = doc.toxml(encoding='utf-8')
460 with open(os.path.join(repodir, 'index.xml'), 'wb') as f:
463 if 'repo_keyalias' in common.config:
465 if common.options.nosign:
466 logging.info("Creating unsigned index in preparation for signing")
468 logging.info("Creating signed index with this key (SHA256):")
469 logging.info("%s" % repo_pubkey_fingerprint)
471 # Create a jar of the index...
472 jar_output = 'index_unsigned.jar' if common.options.nosign else 'index.jar'
473 p = FDroidPopen(['jar', 'cf', jar_output, 'index.xml'], cwd=repodir)
474 if p.returncode != 0:
475 raise FDroidException("Failed to create {0}".format(jar_output))
478 signed = os.path.join(repodir, 'index.jar')
479 if common.options.nosign:
480 # Remove old signed index if not signing
481 if os.path.exists(signed):
484 signindex.config = common.config
485 signindex.sign_jar(signed)
487 # Copy the repo icon into the repo directory...
488 icon_dir = os.path.join(repodir, 'icons')
489 iconfilename = os.path.join(icon_dir, os.path.basename(common.config['repo_icon']))
490 shutil.copyfile(common.config['repo_icon'], iconfilename)
493 def extract_pubkey():
495 Extracts and returns the repository's public key from the keystore.
496 :return: public key in hex, repository fingerprint
498 if 'repo_pubkey' in common.config:
499 pubkey = unhexlify(common.config['repo_pubkey'])
501 env_vars = {'FDROID_KEY_STORE_PASS': common.config['keystorepass']}
502 p = FDroidPopenBytes([common.config['keytool'], '-exportcert',
503 '-alias', common.config['repo_keyalias'],
504 '-keystore', common.config['keystore'],
505 '-storepass:env', 'FDROID_KEY_STORE_PASS']
506 + common.config['smartcardoptions'],
507 envs=env_vars, output=False, stderr_to_stdout=False)
508 if p.returncode != 0 or len(p.output) < 20:
509 msg = "Failed to get repo pubkey!"
510 if common.config['keystore'] == 'NONE':
511 msg += ' Is your crypto smartcard plugged in?'
512 raise FDroidException(msg)
514 repo_pubkey_fingerprint = common.get_cert_fingerprint(pubkey)
515 return hexlify(pubkey), repo_pubkey_fingerprint
518 def get_mirror_service_url(url):
519 '''Get direct URL from git service for use by fdroidclient
521 Via 'servergitmirrors', fdroidserver can create and push a mirror
522 to certain well known git services like gitlab or github. This
523 will always use the 'master' branch since that is the default
528 if url.startswith('git@'):
529 url = re.sub(r'^git@(.*):(.*)', r'https://\1/\2', url)
531 segments = url.split("/")
533 if segments[4].endswith('.git'):
534 segments[4] = segments[4][:-4]
536 hostname = segments[2]
542 if hostname == "github.com":
543 # Github-like RAW segments "https://raw.githubusercontent.com/user/repo/master/fdroid"
544 segments[2] = "raw.githubusercontent.com"
545 segments.extend([branch, folder])
546 elif hostname == "gitlab.com":
547 # Gitlab-like Pages segments "https://user.gitlab.com/repo/fdroid"
548 gitlab_url = ["https:", "", user + ".gitlab.io", repo, folder]
549 segments = gitlab_url
553 return '/'.join(segments)
556 def download_repo_index(url_str, etag=None, verify_fingerprint=True):
558 Downloads the repository index from the given :param url_str
559 and verifies the repository's fingerprint if :param verify_fingerprint is not False.
561 :raises: VerificationException() if the repository could not be verified
563 :return: A tuple consisting of:
564 - The index in JSON format or None if the index did not change
565 - The new eTag as returned by the HTTP request
567 url = urllib.parse.urlsplit(url_str)
570 if verify_fingerprint:
571 query = urllib.parse.parse_qs(url.query)
572 if 'fingerprint' not in query:
573 raise VerificationException("No fingerprint in URL.")
574 fingerprint = query['fingerprint'][0]
576 url = urllib.parse.SplitResult(url.scheme, url.netloc, url.path + '/index-v1.jar', '', '')
577 download, new_etag = net.http_get(url.geturl(), etag)
580 return None, new_etag
582 with tempfile.NamedTemporaryFile() as fp:
583 # write and open JAR file
585 jar = zipfile.ZipFile(fp)
587 # verify that the JAR signature is valid
588 verify_jar_signature(fp.name)
590 # get public key and its fingerprint from JAR
591 public_key, public_key_fingerprint = get_public_key_from_jar(jar)
593 # compare the fingerprint if verify_fingerprint is True
594 if verify_fingerprint and fingerprint.upper() != public_key_fingerprint:
595 raise VerificationException("The repository's fingerprint does not match.")
597 # load repository index from JSON
598 index = json.loads(jar.read('index-v1.json').decode("utf-8"))
599 index["repo"]["pubkey"] = hexlify(public_key).decode("utf-8")
600 index["repo"]["fingerprint"] = public_key_fingerprint
602 # turn the apps into App objects
603 index["apps"] = [metadata.App(app) for app in index["apps"]]
605 return index, new_etag
608 def verify_jar_signature(file):
610 Verifies the signature of a given JAR file.
612 :raises: VerificationException() if the JAR's signature could not be verified
614 if not common.verify_apk_signature(file, jar=True):
615 raise VerificationException("The repository's index could not be verified.")
618 def get_public_key_from_jar(jar):
620 Get the public key and its fingerprint from a JAR file.
622 :raises: VerificationException() if the JAR was not signed exactly once
624 :param jar: a zipfile.ZipFile object
625 :return: the public key from the jar and its fingerprint
627 # extract certificate from jar
628 certs = [n for n in jar.namelist() if common.CERT_PATH_REGEX.match(n)]
630 raise VerificationException("Found no signing certificates for repository.")
632 raise VerificationException("Found multiple signing certificates for repository.")
634 # extract public key from certificate
635 public_key = common.get_certificate(jar.read(certs[0]))
636 public_key_fingerprint = common.get_cert_fingerprint(public_key).replace(' ', '')
638 return public_key, public_key_fingerprint