3 # common.py - part of the FDroid server tools
4 # Copyright (C) 2010-13, Ciaran Gultnieks, ciaran@ciarang.com
5 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 # common.py is imported by all modules, so do not import third-party
21 # libraries here as they will become a requirement for all commands.
40 import xml.etree.ElementTree as XMLElementTree
42 from binascii import hexlify
43 from datetime import datetime
44 from distutils.version import LooseVersion
45 from queue import Queue
46 from zipfile import ZipFile
48 from pyasn1.codec.der import decoder, encoder
49 from pyasn1_modules import rfc2315
50 from pyasn1.error import PyAsn1Error
52 from distutils.util import strtobool
54 import fdroidserver.metadata
55 from fdroidserver import _
56 from fdroidserver.exception import FDroidException, VCSException, BuildException, VerificationException
57 from .asynchronousfilereader import AsynchronousFileReader
60 # A signature block file with a .DSA, .RSA, or .EC extension
61 CERT_PATH_REGEX = re.compile(r'^META-INF/.*\.(DSA|EC|RSA)$')
62 APK_NAME_REGEX = re.compile(r'^([a-zA-Z][\w.]*)_(-?[0-9]+)_?([0-9a-f]{7})?\.apk')
63 STANDARD_FILE_NAME_REGEX = re.compile(r'^(\w[\w.]*)_(-?[0-9]+)\.\w+')
65 XMLElementTree.register_namespace('android', 'http://schemas.android.com/apk/res/android')
74 'sdk_path': "$ANDROID_HOME",
79 'r12b': "$ANDROID_NDK",
85 'build_tools': "25.0.2",
86 'force_build_tools': False,
91 'accepted_formats': ['txt', 'yml'],
92 'sync_from_local_copy_dir': False,
93 'allow_disabled_algorithms': False,
94 'per_app_repos': False,
95 'make_current_version_link': True,
96 'current_version_name_source': 'Name',
97 'update_stats': False,
101 'stats_to_carbon': False,
103 'build_server_always': False,
104 'keystore': 'keystore.jks',
105 'smartcardoptions': [],
115 'repo_url': "https://MyFirstFDroidRepo.org/fdroid/repo",
116 'repo_name': "My First FDroid Repo Demo",
117 'repo_icon': "fdroid-icon.png",
118 'repo_description': '''
119 This is a repository of apps to be used with FDroid. Applications in this
120 repository are either official binaries built by the original application
121 developers, or are binaries built from source by the admin of f-droid.org
122 using the tools on https://gitlab.com/u/fdroid.
128 def setup_global_opts(parser):
129 parser.add_argument("-v", "--verbose", action="store_true", default=False,
130 help=_("Spew out even more information than normal"))
131 parser.add_argument("-q", "--quiet", action="store_true", default=False,
132 help=_("Restrict output to warnings and errors"))
135 def _add_java_paths_to_config(pathlist, thisconfig):
136 def path_version_key(s):
138 for u in re.split('[^0-9]+', s):
140 versionlist.append(int(u))
145 for d in sorted(pathlist, key=path_version_key):
146 if os.path.islink(d):
148 j = os.path.basename(d)
149 # the last one found will be the canonical one, so order appropriately
151 r'^1\.([6-9])\.0\.jdk$', # OSX
152 r'^jdk1\.([6-9])\.0_[0-9]+.jdk$', # OSX and Oracle tarball
153 r'^jdk1\.([6-9])\.0_[0-9]+$', # Oracle Windows
154 r'^jdk([6-9])-openjdk$', # Arch
155 r'^java-([6-9])-openjdk$', # Arch
156 r'^java-([6-9])-jdk$', # Arch (oracle)
157 r'^java-1\.([6-9])\.0-.*$', # RedHat
158 r'^java-([6-9])-oracle$', # Debian WebUpd8
159 r'^jdk-([6-9])-oracle-.*$', # Debian make-jpkg
160 r'^java-([6-9])-openjdk-[^c][^o][^m].*$', # Debian
162 m = re.match(regex, j)
165 for p in [d, os.path.join(d, 'Contents', 'Home')]:
166 if os.path.exists(os.path.join(p, 'bin', 'javac')):
167 thisconfig['java_paths'][m.group(1)] = p
170 def fill_config_defaults(thisconfig):
171 for k, v in default_config.items():
172 if k not in thisconfig:
175 # Expand paths (~users and $vars)
176 def expand_path(path):
180 path = os.path.expanduser(path)
181 path = os.path.expandvars(path)
186 for k in ['sdk_path', 'ant', 'mvn3', 'gradle', 'keystore', 'repo_icon']:
191 thisconfig[k + '_orig'] = v
193 # find all installed JDKs for keytool, jarsigner, and JAVA[6-9]_HOME env vars
194 if thisconfig['java_paths'] is None:
195 thisconfig['java_paths'] = dict()
197 pathlist += glob.glob('/usr/lib/jvm/j*[6-9]*')
198 pathlist += glob.glob('/usr/java/jdk1.[6-9]*')
199 pathlist += glob.glob('/System/Library/Java/JavaVirtualMachines/1.[6-9].0.jdk')
200 pathlist += glob.glob('/Library/Java/JavaVirtualMachines/*jdk*[6-9]*')
201 if os.getenv('JAVA_HOME') is not None:
202 pathlist.append(os.getenv('JAVA_HOME'))
203 if os.getenv('PROGRAMFILES') is not None:
204 pathlist += glob.glob(os.path.join(os.getenv('PROGRAMFILES'), 'Java', 'jdk1.[6-9].*'))
205 _add_java_paths_to_config(pathlist, thisconfig)
207 for java_version in ('7', '8', '9'):
208 if java_version not in thisconfig['java_paths']:
210 java_home = thisconfig['java_paths'][java_version]
211 jarsigner = os.path.join(java_home, 'bin', 'jarsigner')
212 if os.path.exists(jarsigner):
213 thisconfig['jarsigner'] = jarsigner
214 thisconfig['keytool'] = os.path.join(java_home, 'bin', 'keytool')
215 break # Java7 is preferred, so quit if found
217 for k in ['ndk_paths', 'java_paths']:
223 thisconfig[k][k2] = exp
224 thisconfig[k][k2 + '_orig'] = v
227 def regsub_file(pattern, repl, path):
228 with open(path, 'rb') as f:
230 text = re.sub(bytes(pattern, 'utf8'), bytes(repl, 'utf8'), text)
231 with open(path, 'wb') as f:
235 def read_config(opts, config_file='config.py'):
236 """Read the repository config
238 The config is read from config_file, which is in the current
239 directory when any of the repo management commands are used. If
240 there is a local metadata file in the git repo, then config.py is
241 not required, just use defaults.
244 global config, options
246 if config is not None:
253 if os.path.isfile(config_file):
254 logging.debug(_("Reading '{config_file}'").format(config_file=config_file))
255 with io.open(config_file, "rb") as f:
256 code = compile(f.read(), config_file, 'exec')
257 exec(code, None, config)
259 logging.warning(_("No 'config.py' found, using defaults."))
261 for k in ('mirrors', 'install_list', 'uninstall_list', 'serverwebroot', 'servergitroot'):
263 if not type(config[k]) in (str, list, tuple):
265 _("'{field}' will be in random order! Use () or [] brackets if order is important!")
268 # smartcardoptions must be a list since its command line args for Popen
269 if 'smartcardoptions' in config:
270 config['smartcardoptions'] = config['smartcardoptions'].split(' ')
271 elif 'keystore' in config and config['keystore'] == 'NONE':
272 # keystore='NONE' means use smartcard, these are required defaults
273 config['smartcardoptions'] = ['-storetype', 'PKCS11', '-providerName',
274 'SunPKCS11-OpenSC', '-providerClass',
275 'sun.security.pkcs11.SunPKCS11',
276 '-providerArg', 'opensc-fdroid.cfg']
278 if any(k in config for k in ["keystore", "keystorepass", "keypass"]):
279 st = os.stat(config_file)
280 if st.st_mode & stat.S_IRWXG or st.st_mode & stat.S_IRWXO:
281 logging.warning(_("unsafe permissions on '{config_file}' (should be 0600)!")
282 .format(config_file=config_file))
284 fill_config_defaults(config)
286 for k in ["repo_description", "archive_description"]:
288 config[k] = clean_description(config[k])
290 if 'serverwebroot' in config:
291 if isinstance(config['serverwebroot'], str):
292 roots = [config['serverwebroot']]
293 elif all(isinstance(item, str) for item in config['serverwebroot']):
294 roots = config['serverwebroot']
296 raise TypeError(_('only accepts strings, lists, and tuples'))
298 for rootstr in roots:
299 # since this is used with rsync, where trailing slashes have
300 # meaning, ensure there is always a trailing slash
301 if rootstr[-1] != '/':
303 rootlist.append(rootstr.replace('//', '/'))
304 config['serverwebroot'] = rootlist
306 if 'servergitmirrors' in config:
307 if isinstance(config['servergitmirrors'], str):
308 roots = [config['servergitmirrors']]
309 elif all(isinstance(item, str) for item in config['servergitmirrors']):
310 roots = config['servergitmirrors']
312 raise TypeError(_('only accepts strings, lists, and tuples'))
313 config['servergitmirrors'] = roots
318 def assert_config_keystore(config):
319 """Check weather keystore is configured correctly and raise exception if not."""
322 if 'repo_keyalias' not in config:
324 logging.critical(_("'repo_keyalias' not found in config.py!"))
325 if 'keystore' not in config:
327 logging.critical(_("'keystore' not found in config.py!"))
328 elif not os.path.exists(config['keystore']):
330 logging.critical("'" + config['keystore'] + "' does not exist!")
331 if 'keystorepass' not in config:
333 logging.critical(_("'keystorepass' not found in config.py!"))
334 if 'keypass' not in config:
336 logging.critical(_("'keypass' not found in config.py!"))
338 raise FDroidException("This command requires a signing key, " +
339 "you can create one using: fdroid update --create-key")
342 def find_sdk_tools_cmd(cmd):
343 '''find a working path to a tool from the Android SDK'''
346 if config is not None and 'sdk_path' in config and os.path.exists(config['sdk_path']):
347 # try to find a working path to this command, in all the recent possible paths
348 if 'build_tools' in config:
349 build_tools = os.path.join(config['sdk_path'], 'build-tools')
350 # if 'build_tools' was manually set and exists, check only that one
351 configed_build_tools = os.path.join(build_tools, config['build_tools'])
352 if os.path.exists(configed_build_tools):
353 tooldirs.append(configed_build_tools)
355 # no configed version, so hunt known paths for it
356 for f in sorted(os.listdir(build_tools), reverse=True):
357 if os.path.isdir(os.path.join(build_tools, f)):
358 tooldirs.append(os.path.join(build_tools, f))
359 tooldirs.append(build_tools)
360 sdk_tools = os.path.join(config['sdk_path'], 'tools')
361 if os.path.exists(sdk_tools):
362 tooldirs.append(sdk_tools)
363 sdk_platform_tools = os.path.join(config['sdk_path'], 'platform-tools')
364 if os.path.exists(sdk_platform_tools):
365 tooldirs.append(sdk_platform_tools)
366 tooldirs.append('/usr/bin')
368 path = os.path.join(d, cmd)
369 if os.path.isfile(path):
371 test_aapt_version(path)
373 # did not find the command, exit with error message
374 ensure_build_tools_exists(config)
377 def test_aapt_version(aapt):
378 '''Check whether the version of aapt is new enough'''
379 output = subprocess.check_output([aapt, 'version'], universal_newlines=True)
380 if output is None or output == '':
381 logging.error(_("'{path}' failed to execute!").format(path=aapt))
383 m = re.match(r'.*v([0-9]+)\.([0-9]+)[.-]?([0-9.-]*)', output)
388 # the Debian package has the version string like "v0.2-23.0.2"
389 if '.' not in bugfix and LooseVersion('.'.join((major, minor, bugfix))) < LooseVersion('0.2.2166767'):
390 logging.warning(_("'{aapt}' is too old, fdroid requires build-tools-23.0.0 or newer!")
393 logging.warning(_('Unknown version of aapt, might cause problems: ') + output)
396 def test_sdk_exists(thisconfig):
397 if 'sdk_path' not in thisconfig:
398 if 'aapt' in thisconfig and os.path.isfile(thisconfig['aapt']):
399 test_aapt_version(thisconfig['aapt'])
402 logging.error(_("'sdk_path' not set in 'config.py'!"))
404 if thisconfig['sdk_path'] == default_config['sdk_path']:
405 logging.error(_('No Android SDK found!'))
406 logging.error(_('You can use ANDROID_HOME to set the path to your SDK, i.e.:'))
407 logging.error('\texport ANDROID_HOME=/opt/android-sdk')
409 if not os.path.exists(thisconfig['sdk_path']):
410 logging.critical(_("Android SDK path '{path}' does not exist!")
411 .format(path=thisconfig['sdk_path']))
413 if not os.path.isdir(thisconfig['sdk_path']):
414 logging.critical(_("Android SDK path '{path}' is not a directory!")
415 .format(path=thisconfig['sdk_path']))
417 for d in ['build-tools', 'platform-tools', 'tools']:
418 if not os.path.isdir(os.path.join(thisconfig['sdk_path'], d)):
419 logging.critical(_("Android SDK '{path}' does not have '{dirname}' installed!")
420 .format(path=thisconfig['sdk_path'], dirname=d))
425 def ensure_build_tools_exists(thisconfig):
426 if not test_sdk_exists(thisconfig):
427 raise FDroidException(_("Android SDK not found!"))
428 build_tools = os.path.join(thisconfig['sdk_path'], 'build-tools')
429 versioned_build_tools = os.path.join(build_tools, thisconfig['build_tools'])
430 if not os.path.isdir(versioned_build_tools):
431 raise FDroidException(
432 _("Android build-tools path '{path}' does not exist!")
433 .format(path=versioned_build_tools))
436 def get_local_metadata_files():
437 '''get any metadata files local to an app's source repo
439 This tries to ignore anything that does not count as app metdata,
440 including emacs cruft ending in ~ and the .fdroid.key*pass.txt files.
443 return glob.glob('.fdroid.[a-jl-z]*[a-rt-z]')
446 def read_pkg_args(args, allow_vercodes=False):
448 :param args: arguments in the form of multiple appid:[vc] strings
449 :returns: a dictionary with the set of vercodes specified for each package
457 if allow_vercodes and ':' in p:
458 package, vercode = p.split(':')
460 package, vercode = p, None
461 if package not in vercodes:
462 vercodes[package] = [vercode] if vercode else []
464 elif vercode and vercode not in vercodes[package]:
465 vercodes[package] += [vercode] if vercode else []
470 def read_app_args(args, allapps, allow_vercodes=False):
472 On top of what read_pkg_args does, this returns the whole app metadata, but
473 limiting the builds list to the builds matching the vercodes specified.
476 vercodes = read_pkg_args(args, allow_vercodes)
482 for appid, app in allapps.items():
483 if appid in vercodes:
486 if len(apps) != len(vercodes):
489 logging.critical(_("No such package: %s") % p)
490 raise FDroidException(_("Found invalid appids in arguments"))
492 raise FDroidException(_("No packages specified"))
495 for appid, app in apps.items():
499 app.builds = [b for b in app.builds if b.versionCode in vc]
500 if len(app.builds) != len(vercodes[appid]):
502 allvcs = [b.versionCode for b in app.builds]
503 for v in vercodes[appid]:
505 logging.critical(_("No such versionCode {versionCode} for app {appid}")
506 .format(versionCode=v, appid=appid))
509 raise FDroidException(_("Found invalid versionCodes for some apps"))
514 def get_extension(filename):
515 base, ext = os.path.splitext(filename)
518 return base, ext.lower()[1:]
521 def has_extension(filename, ext):
522 _ignored, f_ext = get_extension(filename)
526 publish_name_regex = re.compile(r"^(.+)_([0-9]+)\.(apk|zip)$")
529 def clean_description(description):
530 'Remove unneeded newlines and spaces from a block of description text'
532 # this is split up by paragraph to make removing the newlines easier
533 for paragraph in re.split(r'\n\n', description):
534 paragraph = re.sub('\r', '', paragraph)
535 paragraph = re.sub('\n', ' ', paragraph)
536 paragraph = re.sub(' {2,}', ' ', paragraph)
537 paragraph = re.sub('^\s*(\w)', r'\1', paragraph)
538 returnstring += paragraph + '\n\n'
539 return returnstring.rstrip('\n')
542 def publishednameinfo(filename):
543 filename = os.path.basename(filename)
544 m = publish_name_regex.match(filename)
546 result = (m.group(1), m.group(2))
547 except AttributeError:
548 raise FDroidException(_("Invalid name for published file: %s") % filename)
552 apk_release_filename = re.compile('(?P<appid>[a-zA-Z0-9_\.]+)_(?P<vercode>[0-9]+)\.apk')
553 apk_release_filename_with_sigfp = re.compile('(?P<appid>[a-zA-Z0-9_\.]+)_(?P<vercode>[0-9]+)_(?P<sigfp>[0-9a-f]{7})\.apk')
556 def apk_parse_release_filename(apkname):
557 """Parses the name of an APK file according the F-Droids APK naming
558 scheme and returns the tokens.
560 WARNING: Returned values don't necessarily represent the APKs actual
561 properties, the are just paresed from the file name.
563 :returns: A triplet containing (appid, versionCode, signer), where appid
564 should be the package name, versionCode should be the integer
565 represion of the APKs version and signer should be the first 7 hex
566 digists of the sha256 signing key fingerprint which was used to sign
569 m = apk_release_filename_with_sigfp.match(apkname)
571 return m.group('appid'), m.group('vercode'), m.group('sigfp')
572 m = apk_release_filename.match(apkname)
574 return m.group('appid'), m.group('vercode'), None
575 return None, None, None
578 def get_release_filename(app, build):
580 return "%s_%s.%s" % (app.id, build.versionCode, get_file_extension(build.output))
582 return "%s_%s.apk" % (app.id, build.versionCode)
585 def get_toolsversion_logname(app, build):
586 return "%s_%s_toolsversion.log" % (app.id, build.versionCode)
589 def getsrcname(app, build):
590 return "%s_%s_src.tar.gz" % (app.id, build.versionCode)
602 return '%s (%s)' % (app.CurrentVersion, app.CurrentVersionCode)
605 def get_build_dir(app):
606 '''get the dir that this app will be built in'''
608 if app.RepoType == 'srclib':
609 return os.path.join('build', 'srclib', app.Repo)
611 return os.path.join('build', app.id)
615 '''checkout code from VCS and return instance of vcs and the build dir'''
616 build_dir = get_build_dir(app)
618 # Set up vcs interface and make sure we have the latest code...
619 logging.debug("Getting {0} vcs interface for {1}"
620 .format(app.RepoType, app.Repo))
621 if app.RepoType == 'git' and os.path.exists('.fdroid.yml'):
625 vcs = getvcs(app.RepoType, remote, build_dir)
627 return vcs, build_dir
630 def getvcs(vcstype, remote, local):
632 return vcs_git(remote, local)
633 if vcstype == 'git-svn':
634 return vcs_gitsvn(remote, local)
636 return vcs_hg(remote, local)
638 return vcs_bzr(remote, local)
639 if vcstype == 'srclib':
640 if local != os.path.join('build', 'srclib', remote):
641 raise VCSException("Error: srclib paths are hard-coded!")
642 return getsrclib(remote, os.path.join('build', 'srclib'), raw=True)
644 raise VCSException("Deprecated vcs type 'svn' - please use 'git-svn' instead")
645 raise VCSException("Invalid vcs type " + vcstype)
648 def getsrclibvcs(name):
649 if name not in fdroidserver.metadata.srclibs:
650 raise VCSException("Missing srclib " + name)
651 return fdroidserver.metadata.srclibs[name]['Repo Type']
656 def __init__(self, remote, local):
658 # svn, git-svn and bzr may require auth
660 if self.repotype() in ('git-svn', 'bzr'):
662 if self.repotype == 'git-svn':
663 raise VCSException("Authentication is not supported for git-svn")
664 self.username, remote = remote.split('@')
665 if ':' not in self.username:
666 raise VCSException(_("Password required with username"))
667 self.username, self.password = self.username.split(':')
671 self.clone_failed = False
672 self.refreshed = False
678 def clientversion(self):
679 versionstr = FDroidPopen(self.clientversioncmd()).output
680 return versionstr[0:versionstr.find('\n')]
682 def clientversioncmd(self):
685 def gotorevision(self, rev, refresh=True):
686 """Take the local repository to a clean version of the given
687 revision, which is specificed in the VCS's native
688 format. Beforehand, the repository can be dirty, or even
689 non-existent. If the repository does already exist locally, it
690 will be updated from the origin, but only once in the lifetime
691 of the vcs object. None is acceptable for 'rev' if you know
692 you are cloning a clean copy of the repo - otherwise it must
693 specify a valid revision.
696 if self.clone_failed:
697 raise VCSException(_("Downloading the repository already failed once, not trying again."))
699 # The .fdroidvcs-id file for a repo tells us what VCS type
700 # and remote that directory was created from, allowing us to drop it
701 # automatically if either of those things changes.
702 fdpath = os.path.join(self.local, '..',
703 '.fdroidvcs-' + os.path.basename(self.local))
704 fdpath = os.path.normpath(fdpath)
705 cdata = self.repotype() + ' ' + self.remote
708 if os.path.exists(self.local):
709 if os.path.exists(fdpath):
710 with open(fdpath, 'r') as f:
711 fsdata = f.read().strip()
716 logging.info("Repository details for %s changed - deleting" % (
720 logging.info("Repository details for %s missing - deleting" % (
723 shutil.rmtree(self.local)
727 self.refreshed = True
730 self.gotorevisionx(rev)
731 except FDroidException as e:
734 # If necessary, write the .fdroidvcs file.
735 if writeback and not self.clone_failed:
736 os.makedirs(os.path.dirname(fdpath), exist_ok=True)
737 with open(fdpath, 'w+') as f:
743 def gotorevisionx(self, rev): # pylint: disable=unused-argument
744 """Derived classes need to implement this.
746 It's called once basic checking has been performed.
748 raise VCSException("This VCS type doesn't define gotorevisionx")
750 # Initialise and update submodules
751 def initsubmodules(self):
752 raise VCSException('Submodules not supported for this vcs type')
754 # Get a list of all known tags
756 if not self._gettags:
757 raise VCSException('gettags not supported for this vcs type')
759 for tag in self._gettags():
760 if re.match('[-A-Za-z0-9_. /]+$', tag):
764 def latesttags(self):
765 """Get a list of all the known tags, sorted from newest to oldest"""
766 raise VCSException('latesttags not supported for this vcs type')
769 """Get current commit reference (hash, revision, etc)"""
770 raise VCSException('getref not supported for this vcs type')
773 """Returns the srclib (name, path) used in setting up the current revision, or None."""
782 def clientversioncmd(self):
783 return ['git', '--version']
786 """If the local directory exists, but is somehow not a git repository,
787 git will traverse up the directory tree until it finds one
788 that is (i.e. fdroidserver) and then we'll proceed to destroy
789 it! This is called as a safety check.
793 p = FDroidPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local, output=False)
794 result = p.output.rstrip()
795 if not result.endswith(self.local):
796 raise VCSException('Repository mismatch')
798 def gotorevisionx(self, rev):
799 if not os.path.exists(self.local):
801 p = FDroidPopen(['git', 'clone', self.remote, self.local])
802 if p.returncode != 0:
803 self.clone_failed = True
804 raise VCSException("Git clone failed", p.output)
808 # Discard any working tree changes
809 p = FDroidPopen(['git', 'submodule', 'foreach', '--recursive',
810 'git', 'reset', '--hard'], cwd=self.local, output=False)
811 if p.returncode != 0:
812 raise VCSException(_("Git reset failed"), p.output)
813 # Remove untracked files now, in case they're tracked in the target
814 # revision (it happens!)
815 p = FDroidPopen(['git', 'submodule', 'foreach', '--recursive',
816 'git', 'clean', '-dffx'], cwd=self.local, output=False)
817 if p.returncode != 0:
818 raise VCSException(_("Git clean failed"), p.output)
819 if not self.refreshed:
820 # Get latest commits and tags from remote
821 p = FDroidPopen(['git', 'fetch', 'origin'], cwd=self.local)
822 if p.returncode != 0:
823 raise VCSException(_("Git fetch failed"), p.output)
824 p = FDroidPopen(['git', 'fetch', '--prune', '--tags', 'origin'], cwd=self.local, output=False)
825 if p.returncode != 0:
826 raise VCSException(_("Git fetch failed"), p.output)
827 # Recreate origin/HEAD as git clone would do it, in case it disappeared
828 p = FDroidPopen(['git', 'remote', 'set-head', 'origin', '--auto'], cwd=self.local, output=False)
829 if p.returncode != 0:
830 lines = p.output.splitlines()
831 if 'Multiple remote HEAD branches' not in lines[0]:
832 raise VCSException(_("Git remote set-head failed"), p.output)
833 branch = lines[1].split(' ')[-1]
834 p2 = FDroidPopen(['git', 'remote', 'set-head', 'origin', branch], cwd=self.local, output=False)
835 if p2.returncode != 0:
836 raise VCSException(_("Git remote set-head failed"), p.output + '\n' + p2.output)
837 self.refreshed = True
838 # origin/HEAD is the HEAD of the remote, e.g. the "default branch" on
839 # a github repo. Most of the time this is the same as origin/master.
840 rev = rev or 'origin/HEAD'
841 p = FDroidPopen(['git', 'checkout', '-f', rev], cwd=self.local, output=False)
842 if p.returncode != 0:
843 raise VCSException(_("Git checkout of '%s' failed") % rev, p.output)
844 # Get rid of any uncontrolled files left behind
845 p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
846 if p.returncode != 0:
847 raise VCSException(_("Git clean failed"), p.output)
849 def initsubmodules(self):
851 submfile = os.path.join(self.local, '.gitmodules')
852 if not os.path.isfile(submfile):
853 raise VCSException(_("No git submodules available"))
855 # fix submodules not accessible without an account and public key auth
856 with open(submfile, 'r') as f:
857 lines = f.readlines()
858 with open(submfile, 'w') as f:
860 if 'git@github.com' in line:
861 line = line.replace('git@github.com:', 'https://github.com/')
862 if 'git@gitlab.com' in line:
863 line = line.replace('git@gitlab.com:', 'https://gitlab.com/')
866 p = FDroidPopen(['git', 'submodule', 'sync'], cwd=self.local, output=False)
867 if p.returncode != 0:
868 raise VCSException(_("Git submodule sync failed"), p.output)
869 p = FDroidPopen(['git', 'submodule', 'update', '--init', '--force', '--recursive'], cwd=self.local)
870 if p.returncode != 0:
871 raise VCSException(_("Git submodule update failed"), p.output)
875 p = FDroidPopen(['git', 'tag'], cwd=self.local, output=False)
876 return p.output.splitlines()
878 tag_format = re.compile(r'tag: ([^),]*)')
880 def latesttags(self):
882 p = FDroidPopen(['git', 'log', '--tags',
883 '--simplify-by-decoration', '--pretty=format:%d'],
884 cwd=self.local, output=False)
886 for line in p.output.splitlines():
887 for tag in self.tag_format.findall(line):
892 class vcs_gitsvn(vcs):
897 def clientversioncmd(self):
898 return ['git', 'svn', '--version']
901 """If the local directory exists, but is somehow not a git repository,
902 git will traverse up the directory tree until it finds one that
903 is (i.e. fdroidserver) and then we'll proceed to destory it!
904 This is called as a safety check.
907 p = FDroidPopen(['git', 'rev-parse', '--show-toplevel'], cwd=self.local, output=False)
908 result = p.output.rstrip()
909 if not result.endswith(self.local):
910 raise VCSException('Repository mismatch')
912 def gotorevisionx(self, rev):
913 if not os.path.exists(self.local):
915 gitsvn_args = ['git', 'svn', 'clone']
916 if ';' in self.remote:
917 remote_split = self.remote.split(';')
918 for i in remote_split[1:]:
919 if i.startswith('trunk='):
920 gitsvn_args.extend(['-T', i[6:]])
921 elif i.startswith('tags='):
922 gitsvn_args.extend(['-t', i[5:]])
923 elif i.startswith('branches='):
924 gitsvn_args.extend(['-b', i[9:]])
925 gitsvn_args.extend([remote_split[0], self.local])
926 p = FDroidPopen(gitsvn_args, output=False)
927 if p.returncode != 0:
928 self.clone_failed = True
929 raise VCSException("Git svn clone failed", p.output)
931 gitsvn_args.extend([self.remote, self.local])
932 p = FDroidPopen(gitsvn_args, output=False)
933 if p.returncode != 0:
934 self.clone_failed = True
935 raise VCSException("Git svn clone failed", p.output)
939 # Discard any working tree changes
940 p = FDroidPopen(['git', 'reset', '--hard'], cwd=self.local, output=False)
941 if p.returncode != 0:
942 raise VCSException("Git reset failed", p.output)
943 # Remove untracked files now, in case they're tracked in the target
944 # revision (it happens!)
945 p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
946 if p.returncode != 0:
947 raise VCSException("Git clean failed", p.output)
948 if not self.refreshed:
949 # Get new commits, branches and tags from repo
950 p = FDroidPopen(['git', 'svn', 'fetch'], cwd=self.local, output=False)
951 if p.returncode != 0:
952 raise VCSException("Git svn fetch failed")
953 p = FDroidPopen(['git', 'svn', 'rebase'], cwd=self.local, output=False)
954 if p.returncode != 0:
955 raise VCSException("Git svn rebase failed", p.output)
956 self.refreshed = True
958 rev = rev or 'master'
960 nospaces_rev = rev.replace(' ', '%20')
961 # Try finding a svn tag
962 for treeish in ['origin/', '']:
963 p = FDroidPopen(['git', 'checkout', treeish + 'tags/' + nospaces_rev], cwd=self.local, output=False)
964 if p.returncode == 0:
966 if p.returncode != 0:
967 # No tag found, normal svn rev translation
968 # Translate svn rev into git format
969 rev_split = rev.split('/')
972 for treeish in ['origin/', '']:
973 if len(rev_split) > 1:
974 treeish += rev_split[0]
975 svn_rev = rev_split[1]
978 # if no branch is specified, then assume trunk (i.e. 'master' branch):
982 svn_rev = svn_rev if svn_rev[0] == 'r' else 'r' + svn_rev
984 p = FDroidPopen(['git', 'svn', 'find-rev', '--before', svn_rev, treeish], cwd=self.local, output=False)
985 git_rev = p.output.rstrip()
987 if p.returncode == 0 and git_rev:
990 if p.returncode != 0 or not git_rev:
991 # Try a plain git checkout as a last resort
992 p = FDroidPopen(['git', 'checkout', rev], cwd=self.local, output=False)
993 if p.returncode != 0:
994 raise VCSException("No git treeish found and direct git checkout of '%s' failed" % rev, p.output)
996 # Check out the git rev equivalent to the svn rev
997 p = FDroidPopen(['git', 'checkout', git_rev], cwd=self.local, output=False)
998 if p.returncode != 0:
999 raise VCSException(_("Git checkout of '%s' failed") % rev, p.output)
1001 # Get rid of any uncontrolled files left behind
1002 p = FDroidPopen(['git', 'clean', '-dffx'], cwd=self.local, output=False)
1003 if p.returncode != 0:
1004 raise VCSException(_("Git clean failed"), p.output)
1008 for treeish in ['origin/', '']:
1009 d = os.path.join(self.local, '.git', 'svn', 'refs', 'remotes', treeish, 'tags')
1010 if os.path.isdir(d):
1011 return os.listdir(d)
1015 p = FDroidPopen(['git', 'svn', 'find-rev', 'HEAD'], cwd=self.local, output=False)
1016 if p.returncode != 0:
1018 return p.output.strip()
1026 def clientversioncmd(self):
1027 return ['hg', '--version']
1029 def gotorevisionx(self, rev):
1030 if not os.path.exists(self.local):
1031 p = FDroidPopen(['hg', 'clone', self.remote, self.local], output=False)
1032 if p.returncode != 0:
1033 self.clone_failed = True
1034 raise VCSException("Hg clone failed", p.output)
1036 p = FDroidPopen(['hg', 'status', '-uS'], cwd=self.local, output=False)
1037 if p.returncode != 0:
1038 raise VCSException("Hg status failed", p.output)
1039 for line in p.output.splitlines():
1040 if not line.startswith('? '):
1041 raise VCSException("Unexpected output from hg status -uS: " + line)
1042 FDroidPopen(['rm', '-rf', line[2:]], cwd=self.local, output=False)
1043 if not self.refreshed:
1044 p = FDroidPopen(['hg', 'pull'], cwd=self.local, output=False)
1045 if p.returncode != 0:
1046 raise VCSException("Hg pull failed", p.output)
1047 self.refreshed = True
1049 rev = rev or 'default'
1052 p = FDroidPopen(['hg', 'update', '-C', rev], cwd=self.local, output=False)
1053 if p.returncode != 0:
1054 raise VCSException("Hg checkout of '%s' failed" % rev, p.output)
1055 p = FDroidPopen(['hg', 'purge', '--all'], cwd=self.local, output=False)
1056 # Also delete untracked files, we have to enable purge extension for that:
1057 if "'purge' is provided by the following extension" in p.output:
1058 with open(os.path.join(self.local, '.hg', 'hgrc'), "a") as myfile:
1059 myfile.write("\n[extensions]\nhgext.purge=\n")
1060 p = FDroidPopen(['hg', 'purge', '--all'], cwd=self.local, output=False)
1061 if p.returncode != 0:
1062 raise VCSException("HG purge failed", p.output)
1063 elif p.returncode != 0:
1064 raise VCSException("HG purge failed", p.output)
1067 p = FDroidPopen(['hg', 'tags', '-q'], cwd=self.local, output=False)
1068 return p.output.splitlines()[1:]
1076 def clientversioncmd(self):
1077 return ['bzr', '--version']
1079 def gotorevisionx(self, rev):
1080 if not os.path.exists(self.local):
1081 p = FDroidPopen(['bzr', 'branch', self.remote, self.local], output=False)
1082 if p.returncode != 0:
1083 self.clone_failed = True
1084 raise VCSException("Bzr branch failed", p.output)
1086 p = FDroidPopen(['bzr', 'clean-tree', '--force', '--unknown', '--ignored'], cwd=self.local, output=False)
1087 if p.returncode != 0:
1088 raise VCSException("Bzr revert failed", p.output)
1089 if not self.refreshed:
1090 p = FDroidPopen(['bzr', 'pull'], cwd=self.local, output=False)
1091 if p.returncode != 0:
1092 raise VCSException("Bzr update failed", p.output)
1093 self.refreshed = True
1095 revargs = list(['-r', rev] if rev else [])
1096 p = FDroidPopen(['bzr', 'revert'] + revargs, cwd=self.local, output=False)
1097 if p.returncode != 0:
1098 raise VCSException("Bzr revert of '%s' failed" % rev, p.output)
1101 p = FDroidPopen(['bzr', 'tags'], cwd=self.local, output=False)
1102 return [tag.split(' ')[0].strip() for tag in
1103 p.output.splitlines()]
1106 def unescape_string(string):
1109 if string[0] == '"' and string[-1] == '"':
1112 return string.replace("\\'", "'")
1115 def retrieve_string(app_dir, string, xmlfiles=None):
1117 if not string.startswith('@string/'):
1118 return unescape_string(string)
1120 if xmlfiles is None:
1123 os.path.join(app_dir, 'res'),
1124 os.path.join(app_dir, 'src', 'main', 'res'),
1126 for root, dirs, files in os.walk(res_dir):
1127 if os.path.basename(root) == 'values':
1128 xmlfiles += [os.path.join(root, x) for x in files if x.endswith('.xml')]
1130 name = string[len('@string/'):]
1132 def element_content(element):
1133 if element.text is None:
1135 s = XMLElementTree.tostring(element, encoding='utf-8', method='text')
1136 return s.decode('utf-8').strip()
1138 for path in xmlfiles:
1139 if not os.path.isfile(path):
1141 xml = parse_xml(path)
1142 element = xml.find('string[@name="' + name + '"]')
1143 if element is not None:
1144 content = element_content(element)
1145 return retrieve_string(app_dir, content, xmlfiles)
1150 def retrieve_string_singleline(app_dir, string, xmlfiles=None):
1151 return retrieve_string(app_dir, string, xmlfiles).replace('\n', ' ').strip()
1154 def manifest_paths(app_dir, flavours):
1155 '''Return list of existing files that will be used to find the highest vercode'''
1157 possible_manifests = \
1158 [os.path.join(app_dir, 'AndroidManifest.xml'),
1159 os.path.join(app_dir, 'src', 'main', 'AndroidManifest.xml'),
1160 os.path.join(app_dir, 'src', 'AndroidManifest.xml'),
1161 os.path.join(app_dir, 'build.gradle')]
1163 for flavour in flavours:
1164 if flavour == 'yes':
1166 possible_manifests.append(
1167 os.path.join(app_dir, 'src', flavour, 'AndroidManifest.xml'))
1169 return [path for path in possible_manifests if os.path.isfile(path)]
1172 def fetch_real_name(app_dir, flavours):
1173 '''Retrieve the package name. Returns the name, or None if not found.'''
1174 for path in manifest_paths(app_dir, flavours):
1175 if not has_extension(path, 'xml') or not os.path.isfile(path):
1177 logging.debug("fetch_real_name: Checking manifest at " + path)
1178 xml = parse_xml(path)
1179 app = xml.find('application')
1182 if "{http://schemas.android.com/apk/res/android}label" not in app.attrib:
1184 label = app.attrib["{http://schemas.android.com/apk/res/android}label"]
1185 result = retrieve_string_singleline(app_dir, label)
1187 result = result.strip()
1192 def get_library_references(root_dir):
1194 proppath = os.path.join(root_dir, 'project.properties')
1195 if not os.path.isfile(proppath):
1197 with open(proppath, 'r', encoding='iso-8859-1') as f:
1199 if not line.startswith('android.library.reference.'):
1201 path = line.split('=')[1].strip()
1202 relpath = os.path.join(root_dir, path)
1203 if not os.path.isdir(relpath):
1205 logging.debug("Found subproject at %s" % path)
1206 libraries.append(path)
1210 def ant_subprojects(root_dir):
1211 subprojects = get_library_references(root_dir)
1212 for subpath in subprojects:
1213 subrelpath = os.path.join(root_dir, subpath)
1214 for p in get_library_references(subrelpath):
1215 relp = os.path.normpath(os.path.join(subpath, p))
1216 if relp not in subprojects:
1217 subprojects.insert(0, relp)
1221 def remove_debuggable_flags(root_dir):
1222 # Remove forced debuggable flags
1223 logging.debug("Removing debuggable flags from %s" % root_dir)
1224 for root, dirs, files in os.walk(root_dir):
1225 if 'AndroidManifest.xml' in files and os.path.isfile(os.path.join(root, 'AndroidManifest.xml')):
1226 regsub_file(r'android:debuggable="[^"]*"',
1228 os.path.join(root, 'AndroidManifest.xml'))
1231 vcsearch_g = re.compile(r'''.*[Vv]ersionCode[ =]+["']*([0-9]+)["']*''').search
1232 vnsearch_g = re.compile(r'.*[Vv]ersionName *=* *(["\'])((?:(?=(\\?))\3.)*?)\1.*').search
1233 psearch_g = re.compile(r'.*(packageName|applicationId) *=* *["\']([^"]+)["\'].*').search
1236 def app_matches_packagename(app, package):
1239 appid = app.UpdateCheckName or app.id
1240 if appid is None or appid == "Ignore":
1242 return appid == package
1245 def parse_androidmanifests(paths, app):
1247 Extract some information from the AndroidManifest.xml at the given path.
1248 Returns (version, vercode, package), any or all of which might be None.
1249 All values returned are strings.
1252 ignoreversions = app.UpdateCheckIgnore
1253 ignoresearch = re.compile(ignoreversions).search if ignoreversions else None
1256 return (None, None, None)
1264 if not os.path.isfile(path):
1267 logging.debug(_("Parsing manifest at '{path}'").format(path=path))
1272 if has_extension(path, 'gradle'):
1273 with open(path, 'r') as f:
1275 if gradle_comment.match(line):
1277 # Grab first occurence of each to avoid running into
1278 # alternative flavours and builds.
1280 matches = psearch_g(line)
1282 s = matches.group(2)
1283 if app_matches_packagename(app, s):
1286 matches = vnsearch_g(line)
1288 version = matches.group(2)
1290 matches = vcsearch_g(line)
1292 vercode = matches.group(1)
1295 xml = parse_xml(path)
1296 if "package" in xml.attrib:
1297 s = xml.attrib["package"]
1298 if app_matches_packagename(app, s):
1300 if "{http://schemas.android.com/apk/res/android}versionName" in xml.attrib:
1301 version = xml.attrib["{http://schemas.android.com/apk/res/android}versionName"]
1302 base_dir = os.path.dirname(path)
1303 version = retrieve_string_singleline(base_dir, version)
1304 if "{http://schemas.android.com/apk/res/android}versionCode" in xml.attrib:
1305 a = xml.attrib["{http://schemas.android.com/apk/res/android}versionCode"]
1306 if string_is_integer(a):
1309 logging.warning(_("Problem with xml at '{path}'").format(path=path))
1311 # Remember package name, may be defined separately from version+vercode
1313 package = max_package
1315 logging.debug("..got package={0}, version={1}, vercode={2}"
1316 .format(package, version, vercode))
1318 # Always grab the package name and version name in case they are not
1319 # together with the highest version code
1320 if max_package is None and package is not None:
1321 max_package = package
1322 if max_version is None and version is not None:
1323 max_version = version
1325 if vercode is not None \
1326 and (max_vercode is None or vercode > max_vercode):
1327 if not ignoresearch or not ignoresearch(version):
1328 if version is not None:
1329 max_version = version
1330 if vercode is not None:
1331 max_vercode = vercode
1332 if package is not None:
1333 max_package = package
1335 max_version = "Ignore"
1337 if max_version is None:
1338 max_version = "Unknown"
1340 if max_package and not is_valid_package_name(max_package):
1341 raise FDroidException(_("Invalid package name {0}").format(max_package))
1343 return (max_version, max_vercode, max_package)
1346 def is_valid_package_name(name):
1347 return re.match("[A-Za-z_][A-Za-z_0-9.]+$", name)
1350 def getsrclib(spec, srclib_dir, subdir=None, basepath=False,
1351 raw=False, prepare=True, preponly=False, refresh=True,
1353 """Get the specified source library.
1355 Returns the path to it. Normally this is the path to be used when
1356 referencing it, which may be a subdirectory of the actual project. If
1357 you want the base directory of the project, pass 'basepath=True'.
1366 name, ref = spec.split('@')
1368 number, name = name.split(':', 1)
1370 name, subdir = name.split('/', 1)
1372 if name not in fdroidserver.metadata.srclibs:
1373 raise VCSException('srclib ' + name + ' not found.')
1375 srclib = fdroidserver.metadata.srclibs[name]
1377 sdir = os.path.join(srclib_dir, name)
1380 vcs = getvcs(srclib["Repo Type"], srclib["Repo"], sdir)
1381 vcs.srclib = (name, number, sdir)
1383 vcs.gotorevision(ref, refresh)
1390 libdir = os.path.join(sdir, subdir)
1391 elif srclib["Subdir"]:
1392 for subdir in srclib["Subdir"]:
1393 libdir_candidate = os.path.join(sdir, subdir)
1394 if os.path.exists(libdir_candidate):
1395 libdir = libdir_candidate
1401 remove_signing_keys(sdir)
1402 remove_debuggable_flags(sdir)
1406 if srclib["Prepare"]:
1407 cmd = replace_config_vars(srclib["Prepare"], build)
1409 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=libdir)
1410 if p.returncode != 0:
1411 raise BuildException("Error running prepare command for srclib %s"
1417 return (name, number, libdir)
1420 gradle_version_regex = re.compile(r"[^/]*'com\.android\.tools\.build:gradle:([^\.]+\.[^\.]+).*'.*")
1423 def prepare_source(vcs, app, build, build_dir, srclib_dir, extlib_dir, onserver=False, refresh=True):
1424 """ Prepare the source code for a particular build
1426 :param vcs: the appropriate vcs object for the application
1427 :param app: the application details from the metadata
1428 :param build: the build details from the metadata
1429 :param build_dir: the path to the build directory, usually 'build/app.id'
1430 :param srclib_dir: the path to the source libraries directory, usually 'build/srclib'
1431 :param extlib_dir: the path to the external libraries directory, usually 'build/extlib'
1433 Returns the (root, srclibpaths) where:
1434 :param root: is the root directory, which may be the same as 'build_dir' or may
1435 be a subdirectory of it.
1436 :param srclibpaths: is information on the srclibs being used
1439 # Optionally, the actual app source can be in a subdirectory
1441 root_dir = os.path.join(build_dir, build.subdir)
1443 root_dir = build_dir
1445 # Get a working copy of the right revision
1446 logging.info("Getting source for revision " + build.commit)
1447 vcs.gotorevision(build.commit, refresh)
1449 # Initialise submodules if required
1450 if build.submodules:
1451 logging.info(_("Initialising submodules"))
1452 vcs.initsubmodules()
1454 # Check that a subdir (if we're using one) exists. This has to happen
1455 # after the checkout, since it might not exist elsewhere
1456 if not os.path.exists(root_dir):
1457 raise BuildException('Missing subdir ' + root_dir)
1459 # Run an init command if one is required
1461 cmd = replace_config_vars(build.init, build)
1462 logging.info("Running 'init' commands in %s" % root_dir)
1464 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1465 if p.returncode != 0:
1466 raise BuildException("Error running init command for %s:%s" %
1467 (app.id, build.versionName), p.output)
1469 # Apply patches if any
1471 logging.info("Applying patches")
1472 for patch in build.patch:
1473 patch = patch.strip()
1474 logging.info("Applying " + patch)
1475 patch_path = os.path.join('metadata', app.id, patch)
1476 p = FDroidPopen(['patch', '-p1', '-i', os.path.abspath(patch_path)], cwd=build_dir)
1477 if p.returncode != 0:
1478 raise BuildException("Failed to apply patch %s" % patch_path)
1480 # Get required source libraries
1483 logging.info("Collecting source libraries")
1484 for lib in build.srclibs:
1485 srclibpaths.append(getsrclib(lib, srclib_dir, build, preponly=onserver,
1486 refresh=refresh, build=build))
1488 for name, number, libpath in srclibpaths:
1489 place_srclib(root_dir, int(number) if number else None, libpath)
1491 basesrclib = vcs.getsrclib()
1492 # If one was used for the main source, add that too.
1494 srclibpaths.append(basesrclib)
1496 # Update the local.properties file
1497 localprops = [os.path.join(build_dir, 'local.properties')]
1499 parts = build.subdir.split(os.sep)
1502 cur = os.path.join(cur, d)
1503 localprops += [os.path.join(cur, 'local.properties')]
1504 for path in localprops:
1506 if os.path.isfile(path):
1507 logging.info("Updating local.properties file at %s" % path)
1508 with open(path, 'r', encoding='iso-8859-1') as f:
1512 logging.info("Creating local.properties file at %s" % path)
1513 # Fix old-fashioned 'sdk-location' by copying
1514 # from sdk.dir, if necessary
1516 sdkloc = re.match(r".*^sdk.dir=(\S+)$.*", props,
1517 re.S | re.M).group(1)
1518 props += "sdk-location=%s\n" % sdkloc
1520 props += "sdk.dir=%s\n" % config['sdk_path']
1521 props += "sdk-location=%s\n" % config['sdk_path']
1522 ndk_path = build.ndk_path()
1523 # if for any reason the path isn't valid or the directory
1524 # doesn't exist, some versions of Gradle will error with a
1525 # cryptic message (even if the NDK is not even necessary).
1526 # https://gitlab.com/fdroid/fdroidserver/issues/171
1527 if ndk_path and os.path.exists(ndk_path):
1529 props += "ndk.dir=%s\n" % ndk_path
1530 props += "ndk-location=%s\n" % ndk_path
1531 # Add java.encoding if necessary
1533 props += "java.encoding=%s\n" % build.encoding
1534 with open(path, 'w', encoding='iso-8859-1') as f:
1538 if build.build_method() == 'gradle':
1539 flavours = build.gradle
1542 n = build.target.split('-')[1]
1543 regsub_file(r'compileSdkVersion[ =]+[0-9]+',
1544 r'compileSdkVersion %s' % n,
1545 os.path.join(root_dir, 'build.gradle'))
1547 # Remove forced debuggable flags
1548 remove_debuggable_flags(root_dir)
1550 # Insert version code and number into the manifest if necessary
1551 if build.forceversion:
1552 logging.info("Changing the version name")
1553 for path in manifest_paths(root_dir, flavours):
1554 if not os.path.isfile(path):
1556 if has_extension(path, 'xml'):
1557 regsub_file(r'android:versionName="[^"]*"',
1558 r'android:versionName="%s"' % build.versionName,
1560 elif has_extension(path, 'gradle'):
1561 regsub_file(r"""(\s*)versionName[\s'"=]+.*""",
1562 r"""\1versionName '%s'""" % build.versionName,
1565 if build.forcevercode:
1566 logging.info("Changing the version code")
1567 for path in manifest_paths(root_dir, flavours):
1568 if not os.path.isfile(path):
1570 if has_extension(path, 'xml'):
1571 regsub_file(r'android:versionCode="[^"]*"',
1572 r'android:versionCode="%s"' % build.versionCode,
1574 elif has_extension(path, 'gradle'):
1575 regsub_file(r'versionCode[ =]+[0-9]+',
1576 r'versionCode %s' % build.versionCode,
1579 # Delete unwanted files
1581 logging.info(_("Removing specified files"))
1582 for part in getpaths(build_dir, build.rm):
1583 dest = os.path.join(build_dir, part)
1584 logging.info("Removing {0}".format(part))
1585 if os.path.lexists(dest):
1586 if os.path.islink(dest):
1587 FDroidPopen(['unlink', dest], output=False)
1589 FDroidPopen(['rm', '-rf', dest], output=False)
1591 logging.info("...but it didn't exist")
1593 remove_signing_keys(build_dir)
1595 # Add required external libraries
1597 logging.info("Collecting prebuilt libraries")
1598 libsdir = os.path.join(root_dir, 'libs')
1599 if not os.path.exists(libsdir):
1601 for lib in build.extlibs:
1603 logging.info("...installing extlib {0}".format(lib))
1604 libf = os.path.basename(lib)
1605 libsrc = os.path.join(extlib_dir, lib)
1606 if not os.path.exists(libsrc):
1607 raise BuildException("Missing extlib file {0}".format(libsrc))
1608 shutil.copyfile(libsrc, os.path.join(libsdir, libf))
1610 # Run a pre-build command if one is required
1612 logging.info("Running 'prebuild' commands in %s" % root_dir)
1614 cmd = replace_config_vars(build.prebuild, build)
1616 # Substitute source library paths into prebuild commands
1617 for name, number, libpath in srclibpaths:
1618 libpath = os.path.relpath(libpath, root_dir)
1619 cmd = cmd.replace('$$' + name + '$$', libpath)
1621 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
1622 if p.returncode != 0:
1623 raise BuildException("Error running prebuild command for %s:%s" %
1624 (app.id, build.versionName), p.output)
1626 # Generate (or update) the ant build file, build.xml...
1627 if build.build_method() == 'ant' and build.androidupdate != ['no']:
1628 parms = ['android', 'update', 'lib-project']
1629 lparms = ['android', 'update', 'project']
1632 parms += ['-t', build.target]
1633 lparms += ['-t', build.target]
1634 if build.androidupdate:
1635 update_dirs = build.androidupdate
1637 update_dirs = ant_subprojects(root_dir) + ['.']
1639 for d in update_dirs:
1640 subdir = os.path.join(root_dir, d)
1642 logging.debug("Updating main project")
1643 cmd = parms + ['-p', d]
1645 logging.debug("Updating subproject %s" % d)
1646 cmd = lparms + ['-p', d]
1647 p = SdkToolsPopen(cmd, cwd=root_dir)
1648 # Check to see whether an error was returned without a proper exit
1649 # code (this is the case for the 'no target set or target invalid'
1651 if p.returncode != 0 or p.output.startswith("Error: "):
1652 raise BuildException("Failed to update project at %s" % d, p.output)
1653 # Clean update dirs via ant
1655 logging.info("Cleaning subproject %s" % d)
1656 p = FDroidPopen(['ant', 'clean'], cwd=subdir)
1658 return (root_dir, srclibpaths)
1661 def getpaths_map(build_dir, globpaths):
1662 """Extend via globbing the paths from a field and return them as a map from original path to resulting paths"""
1666 full_path = os.path.join(build_dir, p)
1667 full_path = os.path.normpath(full_path)
1668 paths[p] = [r[len(build_dir) + 1:] for r in glob.glob(full_path)]
1670 raise FDroidException("glob path '%s' did not match any files/dirs" % p)
1674 def getpaths(build_dir, globpaths):
1675 """Extend via globbing the paths from a field and return them as a set"""
1676 paths_map = getpaths_map(build_dir, globpaths)
1678 for k, v in paths_map.items():
1685 return [int(sp) if sp.isdigit() else sp for sp in re.split(r'(\d+)', s)]
1689 """permanent store of existing APKs with the date they were added
1691 This is currently the only way to permanently store the "updated"
1696 '''Load filename/date info about previously seen APKs
1698 Since the appid and date strings both will never have spaces,
1699 this is parsed as a list from the end to allow the filename to
1700 have any combo of spaces.
1703 self.path = os.path.join('stats', 'known_apks.txt')
1705 if os.path.isfile(self.path):
1706 with open(self.path, 'r', encoding='utf8') as f:
1708 t = line.rstrip().split(' ')
1710 self.apks[t[0]] = (t[1], None)
1713 date = datetime.strptime(t[-1], '%Y-%m-%d')
1714 filename = line[0:line.rfind(appid) - 1]
1715 self.apks[filename] = (appid, date)
1716 self.changed = False
1718 def writeifchanged(self):
1719 if not self.changed:
1722 if not os.path.exists('stats'):
1726 for apk, app in self.apks.items():
1728 line = apk + ' ' + appid
1730 line += ' ' + added.strftime('%Y-%m-%d')
1733 with open(self.path, 'w', encoding='utf8') as f:
1734 for line in sorted(lst, key=natural_key):
1735 f.write(line + '\n')
1737 def recordapk(self, apkName, app, default_date=None):
1739 Record an apk (if it's new, otherwise does nothing)
1740 Returns the date it was added as a datetime instance
1742 if apkName not in self.apks:
1743 if default_date is None:
1744 default_date = datetime.utcnow()
1745 self.apks[apkName] = (app, default_date)
1747 _ignored, added = self.apks[apkName]
1750 def getapp(self, apkname):
1751 """Look up information - given the 'apkname', returns (app id, date added/None).
1753 Or returns None for an unknown apk.
1755 if apkname in self.apks:
1756 return self.apks[apkname]
1759 def getlatest(self, num):
1760 """Get the most recent 'num' apps added to the repo, as a list of package ids with the most recent first"""
1762 for apk, app in self.apks.items():
1766 if apps[appid] > added:
1770 sortedapps = sorted(apps.items(), key=operator.itemgetter(1))[-num:]
1771 lst = [app for app, _ignored in sortedapps]
1776 def get_file_extension(filename):
1777 """get the normalized file extension, can be blank string but never None"""
1778 if isinstance(filename, bytes):
1779 filename = filename.decode('utf-8')
1780 return os.path.splitext(filename)[1].lower()[1:]
1783 def get_apk_debuggable_aapt(apkfile):
1784 p = SdkToolsPopen(['aapt', 'dump', 'xmltree', apkfile, 'AndroidManifest.xml'],
1786 if p.returncode != 0:
1787 raise FDroidException(_("Failed to get APK manifest information"))
1788 for line in p.output.splitlines():
1789 if 'android:debuggable' in line and not line.endswith('0x0'):
1794 def get_apk_debuggable_androguard(apkfile):
1796 from androguard.core.bytecodes.apk import APK
1798 raise FDroidException("androguard library is not installed and aapt not present")
1800 apkobject = APK(apkfile)
1801 if apkobject.is_valid_APK():
1802 debuggable = apkobject.get_element("application", "debuggable")
1803 if debuggable is not None:
1804 return bool(strtobool(debuggable))
1808 def isApkAndDebuggable(apkfile):
1809 """Returns True if the given file is an APK and is debuggable
1811 :param apkfile: full path to the apk to check"""
1813 if get_file_extension(apkfile) != 'apk':
1816 if SdkToolsPopen(['aapt', 'version'], output=False):
1817 return get_apk_debuggable_aapt(apkfile)
1819 return get_apk_debuggable_androguard(apkfile)
1822 def get_apk_id_aapt(apkfile):
1823 """Extrat identification information from APK using aapt.
1825 :param apkfile: path to an APK file.
1826 :returns: triplet (appid, version code, version name)
1828 r = re.compile("package: name='(?P<appid>.*)' versionCode='(?P<vercode>.*)' versionName='(?P<vername>.*)' platformBuildVersionName='.*'")
1829 p = SdkToolsPopen(['aapt', 'dump', 'badging', apkfile], output=False)
1830 for line in p.output.splitlines():
1833 return m.group('appid'), m.group('vercode'), m.group('vername')
1834 raise FDroidException(_("Reading packageName/versionCode/versionName failed, APK invalid: '{apkfilename}'")
1835 .format(apkfilename=apkfile))
1840 self.returncode = None
1844 def SdkToolsPopen(commands, cwd=None, output=True):
1846 if cmd not in config:
1847 config[cmd] = find_sdk_tools_cmd(commands[0])
1848 abscmd = config[cmd]
1850 raise FDroidException(_("Could not find '{command}' on your system").format(command=cmd))
1852 test_aapt_version(config['aapt'])
1853 return FDroidPopen([abscmd] + commands[1:],
1854 cwd=cwd, output=output)
1857 def FDroidPopenBytes(commands, cwd=None, envs=None, output=True, stderr_to_stdout=True):
1859 Run a command and capture the possibly huge output as bytes.
1861 :param commands: command and argument list like in subprocess.Popen
1862 :param cwd: optionally specifies a working directory
1863 :param envs: a optional dictionary of environment variables and their values
1864 :returns: A PopenResult.
1869 set_FDroidPopen_env()
1871 process_env = env.copy()
1872 if envs is not None and len(envs) > 0:
1873 process_env.update(envs)
1876 cwd = os.path.normpath(cwd)
1877 logging.debug("Directory: %s" % cwd)
1878 logging.debug("> %s" % ' '.join(commands))
1880 stderr_param = subprocess.STDOUT if stderr_to_stdout else subprocess.PIPE
1881 result = PopenResult()
1884 p = subprocess.Popen(commands, cwd=cwd, shell=False, env=process_env,
1885 stdout=subprocess.PIPE, stderr=stderr_param)
1886 except OSError as e:
1887 raise BuildException("OSError while trying to execute " +
1888 ' '.join(commands) + ': ' + str(e))
1890 if not stderr_to_stdout and options.verbose:
1891 stderr_queue = Queue()
1892 stderr_reader = AsynchronousFileReader(p.stderr, stderr_queue)
1894 while not stderr_reader.eof():
1895 while not stderr_queue.empty():
1896 line = stderr_queue.get()
1897 sys.stderr.buffer.write(line)
1902 stdout_queue = Queue()
1903 stdout_reader = AsynchronousFileReader(p.stdout, stdout_queue)
1906 # Check the queue for output (until there is no more to get)
1907 while not stdout_reader.eof():
1908 while not stdout_queue.empty():
1909 line = stdout_queue.get()
1910 if output and options.verbose:
1911 # Output directly to console
1912 sys.stderr.buffer.write(line)
1918 result.returncode = p.wait()
1919 result.output = buf.getvalue()
1921 # make sure all filestreams of the subprocess are closed
1922 for streamvar in ['stdin', 'stdout', 'stderr']:
1923 if hasattr(p, streamvar):
1924 stream = getattr(p, streamvar)
1930 def FDroidPopen(commands, cwd=None, envs=None, output=True, stderr_to_stdout=True):
1932 Run a command and capture the possibly huge output as a str.
1934 :param commands: command and argument list like in subprocess.Popen
1935 :param cwd: optionally specifies a working directory
1936 :param envs: a optional dictionary of environment variables and their values
1937 :returns: A PopenResult.
1939 result = FDroidPopenBytes(commands, cwd, envs, output, stderr_to_stdout)
1940 result.output = result.output.decode('utf-8', 'ignore')
1944 gradle_comment = re.compile(r'[ ]*//')
1945 gradle_signing_configs = re.compile(r'^[\t ]*signingConfigs[ \t]*{[ \t]*$')
1946 gradle_line_matches = [
1947 re.compile(r'^[\t ]*signingConfig [^ ]*$'),
1948 re.compile(r'.*android\.signingConfigs\.[^{]*$'),
1949 re.compile(r'.*\.readLine\(.*'),
1953 def remove_signing_keys(build_dir):
1954 for root, dirs, files in os.walk(build_dir):
1955 if 'build.gradle' in files:
1956 path = os.path.join(root, 'build.gradle')
1958 with open(path, "r", encoding='utf8') as o:
1959 lines = o.readlines()
1965 with open(path, "w", encoding='utf8') as o:
1966 while i < len(lines):
1969 while line.endswith('\\\n'):
1970 line = line.rstrip('\\\n') + lines[i]
1973 if gradle_comment.match(line):
1978 opened += line.count('{')
1979 opened -= line.count('}')
1982 if gradle_signing_configs.match(line):
1987 if any(s.match(line) for s in gradle_line_matches):
1995 logging.info("Cleaned build.gradle of keysigning configs at %s" % path)
1998 'project.properties',
2000 'default.properties',
2001 'ant.properties', ]:
2002 if propfile in files:
2003 path = os.path.join(root, propfile)
2005 with open(path, "r", encoding='iso-8859-1') as o:
2006 lines = o.readlines()
2010 with open(path, "w", encoding='iso-8859-1') as o:
2012 if any(line.startswith(s) for s in ('key.store', 'key.alias')):
2019 logging.info("Cleaned %s of keysigning configs at %s" % (propfile, path))
2022 def set_FDroidPopen_env(build=None):
2024 set up the environment variables for the build environment
2026 There is only a weak standard, the variables used by gradle, so also set
2027 up the most commonly used environment variables for SDK and NDK. Also, if
2028 there is no locale set, this will set the locale (e.g. LANG) to en_US.UTF-8.
2030 global env, orig_path
2034 orig_path = env['PATH']
2035 for n in ['ANDROID_HOME', 'ANDROID_SDK']:
2036 env[n] = config['sdk_path']
2037 for k, v in config['java_paths'].items():
2038 env['JAVA%s_HOME' % k] = v
2040 missinglocale = True
2041 for k, v in env.items():
2042 if k == 'LANG' and v != 'C':
2043 missinglocale = False
2045 missinglocale = False
2047 env['LANG'] = 'en_US.UTF-8'
2049 if build is not None:
2050 path = build.ndk_path()
2051 paths = orig_path.split(os.pathsep)
2052 if path not in paths:
2053 paths = [path] + paths
2054 env['PATH'] = os.pathsep.join(paths)
2055 for n in ['ANDROID_NDK', 'NDK', 'ANDROID_NDK_HOME']:
2056 env[n] = build.ndk_path()
2059 def replace_build_vars(cmd, build):
2060 cmd = cmd.replace('$$COMMIT$$', build.commit)
2061 cmd = cmd.replace('$$VERSION$$', build.versionName)
2062 cmd = cmd.replace('$$VERCODE$$', build.versionCode)
2066 def replace_config_vars(cmd, build):
2067 cmd = cmd.replace('$$SDK$$', config['sdk_path'])
2068 cmd = cmd.replace('$$NDK$$', build.ndk_path())
2069 cmd = cmd.replace('$$MVN3$$', config['mvn3'])
2070 cmd = cmd.replace('$$QT$$', config['qt_sdk_path'] or '')
2071 if build is not None:
2072 cmd = replace_build_vars(cmd, build)
2076 def place_srclib(root_dir, number, libpath):
2079 relpath = os.path.relpath(libpath, root_dir)
2080 proppath = os.path.join(root_dir, 'project.properties')
2083 if os.path.isfile(proppath):
2084 with open(proppath, "r", encoding='iso-8859-1') as o:
2085 lines = o.readlines()
2087 with open(proppath, "w", encoding='iso-8859-1') as o:
2090 if line.startswith('android.library.reference.%d=' % number):
2091 o.write('android.library.reference.%d=%s\n' % (number, relpath))
2096 o.write('android.library.reference.%d=%s\n' % (number, relpath))
2099 apk_sigfile = re.compile(r'META-INF/[0-9A-Za-z]+\.(SF|RSA|DSA|EC)')
2102 def signer_fingerprint_short(sig):
2103 """Obtain shortened sha256 signing-key fingerprint for pkcs7 signature.
2105 Extracts the first 7 hexadecimal digits of sha256 signing-key fingerprint
2106 for a given pkcs7 signature.
2108 :param sig: Contents of an APK signing certificate.
2109 :returns: shortened signing-key fingerprint.
2111 return signer_fingerprint(sig)[:7]
2114 def signer_fingerprint(sig):
2115 """Obtain sha256 signing-key fingerprint for pkcs7 signature.
2117 Extracts hexadecimal sha256 signing-key fingerprint string
2118 for a given pkcs7 signature.
2120 :param: Contents of an APK signature.
2121 :returns: shortened signature fingerprint.
2123 cert_encoded = get_certificate(sig)
2124 return hashlib.sha256(cert_encoded).hexdigest()
2127 def apk_signer_fingerprint(apk_path):
2128 """Obtain sha256 signing-key fingerprint for APK.
2130 Extracts hexadecimal sha256 signing-key fingerprint string
2133 :param apkpath: path to APK
2134 :returns: signature fingerprint
2137 with zipfile.ZipFile(apk_path, 'r') as apk:
2138 certs = [n for n in apk.namelist() if CERT_PATH_REGEX.match(n)]
2141 logging.error("Found no signing certificates on %s" % apk_path)
2144 logging.error("Found multiple signing certificates on %s" % apk_path)
2147 cert = apk.read(certs[0])
2148 return signer_fingerprint(cert)
2151 def apk_signer_fingerprint_short(apk_path):
2152 """Obtain shortened sha256 signing-key fingerprint for APK.
2154 Extracts the first 7 hexadecimal digits of sha256 signing-key fingerprint
2155 for a given pkcs7 APK.
2157 :param apk_path: path to APK
2158 :returns: shortened signing-key fingerprint
2160 return apk_signer_fingerprint(apk_path)[:7]
2163 def metadata_get_sigdir(appid, vercode=None):
2164 """Get signature directory for app"""
2166 return os.path.join('metadata', appid, 'signatures', vercode)
2168 return os.path.join('metadata', appid, 'signatures')
2171 def metadata_find_developer_signature(appid, vercode=None):
2172 """Tires to find the developer signature for given appid.
2174 This picks the first signature file found in metadata an returns its
2177 :returns: sha256 signing key fingerprint of the developer signing key.
2178 None in case no signature can not be found."""
2180 # fetch list of dirs for all versions of signatures
2183 appversigdirs.append(metadata_get_sigdir(appid, vercode))
2185 appsigdir = metadata_get_sigdir(appid)
2186 if os.path.isdir(appsigdir):
2187 numre = re.compile('[0-9]+')
2188 for ver in os.listdir(appsigdir):
2189 if numre.match(ver):
2190 appversigdir = os.path.join(appsigdir, ver)
2191 appversigdirs.append(appversigdir)
2193 for sigdir in appversigdirs:
2194 sigs = glob.glob(os.path.join(sigdir, '*.DSA')) + \
2195 glob.glob(os.path.join(sigdir, '*.EC')) + \
2196 glob.glob(os.path.join(sigdir, '*.RSA'))
2198 raise FDroidException('ambiguous signatures, please make sure there is only one signature in \'{}\'. (The signature has to be the App maintainers signature for version of the APK.)'.format(sigdir))
2200 with open(sig, 'rb') as f:
2201 return signer_fingerprint(f.read())
2205 def metadata_find_signing_files(appid, vercode):
2206 """Gets a list of singed manifests and signatures.
2208 :param appid: app id string
2209 :param vercode: app version code
2210 :returns: a list of triplets for each signing key with following paths:
2211 (signature_file, singed_file, manifest_file)
2214 sigdir = metadata_get_sigdir(appid, vercode)
2215 sigs = glob.glob(os.path.join(sigdir, '*.DSA')) + \
2216 glob.glob(os.path.join(sigdir, '*.EC')) + \
2217 glob.glob(os.path.join(sigdir, '*.RSA'))
2218 extre = re.compile('(\.DSA|\.EC|\.RSA)$')
2220 sf = extre.sub('.SF', sig)
2221 if os.path.isfile(sf):
2222 mf = os.path.join(sigdir, 'MANIFEST.MF')
2223 if os.path.isfile(mf):
2224 ret.append((sig, sf, mf))
2228 def metadata_find_developer_signing_files(appid, vercode):
2229 """Get developer signature files for specified app from metadata.
2231 :returns: A triplet of paths for signing files from metadata:
2232 (signature_file, singed_file, manifest_file)
2234 allsigningfiles = metadata_find_signing_files(appid, vercode)
2235 if allsigningfiles and len(allsigningfiles) == 1:
2236 return allsigningfiles[0]
2241 def apk_strip_signatures(signed_apk, strip_manifest=False):
2242 """Removes signatures from APK.
2244 :param signed_apk: path to apk file.
2245 :param strip_manifest: when set to True also the manifest file will
2246 be removed from the APK.
2248 with tempfile.TemporaryDirectory() as tmpdir:
2249 tmp_apk = os.path.join(tmpdir, 'tmp.apk')
2250 os.rename(signed_apk, tmp_apk)
2251 with ZipFile(tmp_apk, 'r') as in_apk:
2252 with ZipFile(signed_apk, 'w') as out_apk:
2253 for info in in_apk.infolist():
2254 if not apk_sigfile.match(info.filename):
2256 if info.filename != 'META-INF/MANIFEST.MF':
2257 buf = in_apk.read(info.filename)
2258 out_apk.writestr(info, buf)
2260 buf = in_apk.read(info.filename)
2261 out_apk.writestr(info, buf)
2264 def apk_implant_signatures(apkpath, signaturefile, signedfile, manifest):
2265 """Implats a signature from metadata into an APK.
2267 Note: this changes there supplied APK in place. So copy it if you
2268 need the original to be preserved.
2270 :param apkpath: location of the apk
2272 # get list of available signature files in metadata
2273 with tempfile.TemporaryDirectory() as tmpdir:
2274 apkwithnewsig = os.path.join(tmpdir, 'newsig.apk')
2275 with ZipFile(apkpath, 'r') as in_apk:
2276 with ZipFile(apkwithnewsig, 'w') as out_apk:
2277 for sig_file in [signaturefile, signedfile, manifest]:
2278 with open(sig_file, 'rb') as fp:
2280 info = zipfile.ZipInfo('META-INF/' + os.path.basename(sig_file))
2281 info.compress_type = zipfile.ZIP_DEFLATED
2282 info.create_system = 0 # "Windows" aka "FAT", what Android SDK uses
2283 out_apk.writestr(info, buf)
2284 for info in in_apk.infolist():
2285 if not apk_sigfile.match(info.filename):
2286 if info.filename != 'META-INF/MANIFEST.MF':
2287 buf = in_apk.read(info.filename)
2288 out_apk.writestr(info, buf)
2290 p = SdkToolsPopen(['zipalign', '-v', '4', apkwithnewsig, apkpath])
2291 if p.returncode != 0:
2292 raise BuildException("Failed to align application")
2295 def apk_extract_signatures(apkpath, outdir, manifest=True):
2296 """Extracts a signature files from APK and puts them into target directory.
2298 :param apkpath: location of the apk
2299 :param outdir: folder where the extracted signature files will be stored
2300 :param manifest: (optionally) disable extracting manifest file
2302 with ZipFile(apkpath, 'r') as in_apk:
2303 for f in in_apk.infolist():
2304 if apk_sigfile.match(f.filename) or \
2305 (manifest and f.filename == 'META-INF/MANIFEST.MF'):
2306 newpath = os.path.join(outdir, os.path.basename(f.filename))
2307 with open(newpath, 'wb') as out_file:
2308 out_file.write(in_apk.read(f.filename))
2311 def verify_apks(signed_apk, unsigned_apk, tmp_dir):
2312 """Verify that two apks are the same
2314 One of the inputs is signed, the other is unsigned. The signature metadata
2315 is transferred from the signed to the unsigned apk, and then jarsigner is
2316 used to verify that the signature from the signed apk is also varlid for
2317 the unsigned one. If the APK given as unsigned actually does have a
2318 signature, it will be stripped out and ignored.
2320 There are two SHA1 git commit IDs that fdroidserver includes in the builds
2321 it makes: fdroidserverid and buildserverid. Originally, these were inserted
2322 into AndroidManifest.xml, but that makes the build not reproducible. So
2323 instead they are included as separate files in the APK's META-INF/ folder.
2324 If those files exist in the signed APK, they will be part of the signature
2325 and need to also be included in the unsigned APK for it to validate.
2327 :param signed_apk: Path to a signed apk file
2328 :param unsigned_apk: Path to an unsigned apk file expected to match it
2329 :param tmp_dir: Path to directory for temporary files
2330 :returns: None if the verification is successful, otherwise a string
2331 describing what went wrong.
2334 if not os.path.isfile(signed_apk):
2335 return 'can not verify: file does not exists: {}'.format(signed_apk)
2337 if not os.path.isfile(unsigned_apk):
2338 return 'can not verify: file does not exists: {}'.format(unsigned_apk)
2340 with ZipFile(signed_apk, 'r') as signed:
2341 meta_inf_files = ['META-INF/MANIFEST.MF']
2342 for f in signed.namelist():
2343 if apk_sigfile.match(f) \
2344 or f in ['META-INF/fdroidserverid', 'META-INF/buildserverid']:
2345 meta_inf_files.append(f)
2346 if len(meta_inf_files) < 3:
2347 return "Signature files missing from {0}".format(signed_apk)
2349 tmp_apk = os.path.join(tmp_dir, 'sigcp_' + os.path.basename(unsigned_apk))
2350 with ZipFile(unsigned_apk, 'r') as unsigned:
2351 # only read the signature from the signed APK, everything else from unsigned
2352 with ZipFile(tmp_apk, 'w') as tmp:
2353 for filename in meta_inf_files:
2354 tmp.writestr(signed.getinfo(filename), signed.read(filename))
2355 for info in unsigned.infolist():
2356 if info.filename in meta_inf_files:
2357 logging.warning('Ignoring %s from %s',
2358 info.filename, unsigned_apk)
2360 if info.filename in tmp.namelist():
2361 return "duplicate filename found: " + info.filename
2362 tmp.writestr(info, unsigned.read(info.filename))
2364 verified = verify_apk_signature(tmp_apk)
2367 logging.info("...NOT verified - {0}".format(tmp_apk))
2368 return compare_apks(signed_apk, tmp_apk, tmp_dir,
2369 os.path.dirname(unsigned_apk))
2371 logging.info("...successfully verified")
2375 def verify_jar_signature(jar):
2376 """Verifies the signature of a given JAR file.
2378 jarsigner is very shitty: unsigned JARs pass as "verified"! So
2379 this has to turn on -strict then check for result 4, since this
2380 does not expect the signature to be from a CA-signed certificate.
2382 :raises: VerificationException() if the JAR's signature could not be verified
2386 if subprocess.call([config['jarsigner'], '-strict', '-verify', jar]) != 4:
2387 raise VerificationException(_("The repository's index could not be verified."))
2390 def verify_apk_signature(apk, min_sdk_version=None):
2391 """verify the signature on an APK
2393 Try to use apksigner whenever possible since jarsigner is very
2394 shitty: unsigned APKs pass as "verified"! Warning, this does
2395 not work on JARs with apksigner >= 0.7 (build-tools 26.0.1)
2397 :returns: boolean whether the APK was verified
2399 if set_command_in_config('apksigner'):
2400 args = [config['apksigner'], 'verify']
2402 args += ['--min-sdk-version=' + min_sdk_version]
2403 return subprocess.call(args + [apk]) == 0
2405 logging.warning("Using Java's jarsigner, not recommended for verifying APKs! Use apksigner")
2407 verify_jar_signature(apk)
2414 def verify_old_apk_signature(apk):
2415 """verify the signature on an archived APK, supporting deprecated algorithms
2417 F-Droid aims to keep every single binary that it ever published. Therefore,
2418 it needs to be able to verify APK signatures that include deprecated/removed
2419 algorithms. For example, jarsigner treats an MD5 signature as unsigned.
2421 jarsigner passes unsigned APKs as "verified"! So this has to turn
2422 on -strict then check for result 4.
2424 :returns: boolean whether the APK was verified
2427 _java_security = os.path.join(os.getcwd(), '.java.security')
2428 with open(_java_security, 'w') as fp:
2429 fp.write('jdk.jar.disabledAlgorithms=MD2, RSA keySize < 1024')
2431 return subprocess.call([config['jarsigner'], '-J-Djava.security.properties=' + _java_security,
2432 '-strict', '-verify', apk]) == 4
2435 apk_badchars = re.compile('''[/ :;'"]''')
2438 def compare_apks(apk1, apk2, tmp_dir, log_dir=None):
2441 Returns None if the apk content is the same (apart from the signing key),
2442 otherwise a string describing what's different, or what went wrong when
2443 trying to do the comparison.
2449 absapk1 = os.path.abspath(apk1)
2450 absapk2 = os.path.abspath(apk2)
2452 if set_command_in_config('diffoscope'):
2453 logfilename = os.path.join(log_dir, os.path.basename(absapk1))
2454 htmlfile = logfilename + '.diffoscope.html'
2455 textfile = logfilename + '.diffoscope.txt'
2456 if subprocess.call([config['diffoscope'],
2457 '--max-report-size', '12345678', '--max-diff-block-lines', '100',
2458 '--html', htmlfile, '--text', textfile,
2459 absapk1, absapk2]) != 0:
2460 return("Failed to unpack " + apk1)
2462 apk1dir = os.path.join(tmp_dir, apk_badchars.sub('_', apk1[0:-4])) # trim .apk
2463 apk2dir = os.path.join(tmp_dir, apk_badchars.sub('_', apk2[0:-4])) # trim .apk
2464 for d in [apk1dir, apk2dir]:
2465 if os.path.exists(d):
2468 os.mkdir(os.path.join(d, 'jar-xf'))
2470 if subprocess.call(['jar', 'xf',
2471 os.path.abspath(apk1)],
2472 cwd=os.path.join(apk1dir, 'jar-xf')) != 0:
2473 return("Failed to unpack " + apk1)
2474 if subprocess.call(['jar', 'xf',
2475 os.path.abspath(apk2)],
2476 cwd=os.path.join(apk2dir, 'jar-xf')) != 0:
2477 return("Failed to unpack " + apk2)
2479 if set_command_in_config('apktool'):
2480 if subprocess.call([config['apktool'], 'd', os.path.abspath(apk1), '--output', 'apktool'],
2482 return("Failed to unpack " + apk1)
2483 if subprocess.call([config['apktool'], 'd', os.path.abspath(apk2), '--output', 'apktool'],
2485 return("Failed to unpack " + apk2)
2487 p = FDroidPopen(['diff', '-r', apk1dir, apk2dir], output=False)
2488 lines = p.output.splitlines()
2489 if len(lines) != 1 or 'META-INF' not in lines[0]:
2490 if set_command_in_config('meld'):
2491 p = FDroidPopen([config['meld'], apk1dir, apk2dir], output=False)
2492 return("Unexpected diff output - " + p.output)
2494 # since everything verifies, delete the comparison to keep cruft down
2495 shutil.rmtree(apk1dir)
2496 shutil.rmtree(apk2dir)
2498 # If we get here, it seems like they're the same!
2502 def set_command_in_config(command):
2503 '''Try to find specified command in the path, if it hasn't been
2504 manually set in config.py. If found, it is added to the config
2505 dict. The return value says whether the command is available.
2508 if command in config:
2511 tmp = find_command(command)
2513 config[command] = tmp
2518 def find_command(command):
2519 '''find the full path of a command, or None if it can't be found in the PATH'''
2522 return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
2524 fpath, fname = os.path.split(command)
2529 for path in os.environ["PATH"].split(os.pathsep):
2530 path = path.strip('"')
2531 exe_file = os.path.join(path, command)
2532 if is_exe(exe_file):
2539 '''generate a random password for when generating keys'''
2540 h = hashlib.sha256()
2541 h.update(os.urandom(16)) # salt
2542 h.update(socket.getfqdn().encode('utf-8'))
2543 passwd = base64.b64encode(h.digest()).strip()
2544 return passwd.decode('utf-8')
2547 def genkeystore(localconfig):
2549 Generate a new key with password provided in :param localconfig and add it to new keystore
2550 :return: hexed public key, public key fingerprint
2552 logging.info('Generating a new key in "' + localconfig['keystore'] + '"...')
2553 keystoredir = os.path.dirname(localconfig['keystore'])
2554 if keystoredir is None or keystoredir == '':
2555 keystoredir = os.path.join(os.getcwd(), keystoredir)
2556 if not os.path.exists(keystoredir):
2557 os.makedirs(keystoredir, mode=0o700)
2560 'FDROID_KEY_STORE_PASS': localconfig['keystorepass'],
2561 'FDROID_KEY_PASS': localconfig['keypass'],
2563 p = FDroidPopen([config['keytool'], '-genkey',
2564 '-keystore', localconfig['keystore'],
2565 '-alias', localconfig['repo_keyalias'],
2566 '-keyalg', 'RSA', '-keysize', '4096',
2567 '-sigalg', 'SHA256withRSA',
2568 '-validity', '10000',
2569 '-storepass:env', 'FDROID_KEY_STORE_PASS',
2570 '-keypass:env', 'FDROID_KEY_PASS',
2571 '-dname', localconfig['keydname']], envs=env_vars)
2572 if p.returncode != 0:
2573 raise BuildException("Failed to generate key", p.output)
2574 os.chmod(localconfig['keystore'], 0o0600)
2575 if not options.quiet:
2576 # now show the lovely key that was just generated
2577 p = FDroidPopen([config['keytool'], '-list', '-v',
2578 '-keystore', localconfig['keystore'],
2579 '-alias', localconfig['repo_keyalias'],
2580 '-storepass:env', 'FDROID_KEY_STORE_PASS'], envs=env_vars)
2581 logging.info(p.output.strip() + '\n\n')
2582 # get the public key
2583 p = FDroidPopenBytes([config['keytool'], '-exportcert',
2584 '-keystore', localconfig['keystore'],
2585 '-alias', localconfig['repo_keyalias'],
2586 '-storepass:env', 'FDROID_KEY_STORE_PASS']
2587 + config['smartcardoptions'],
2588 envs=env_vars, output=False, stderr_to_stdout=False)
2589 if p.returncode != 0 or len(p.output) < 20:
2590 raise BuildException("Failed to get public key", p.output)
2592 fingerprint = get_cert_fingerprint(pubkey)
2593 return hexlify(pubkey), fingerprint
2596 def get_cert_fingerprint(pubkey):
2598 Generate a certificate fingerprint the same way keytool does it
2599 (but with slightly different formatting)
2601 digest = hashlib.sha256(pubkey).digest()
2602 ret = [' '.join("%02X" % b for b in bytearray(digest))]
2603 return " ".join(ret)
2606 def get_certificate(certificate_file):
2608 Extracts a certificate from the given file.
2609 :param certificate_file: file bytes (as string) representing the certificate
2610 :return: A binary representation of the certificate's public key, or None in case of error
2612 content = decoder.decode(certificate_file, asn1Spec=rfc2315.ContentInfo())[0]
2613 if content.getComponentByName('contentType') != rfc2315.signedData:
2615 content = decoder.decode(content.getComponentByName('content'),
2616 asn1Spec=rfc2315.SignedData())[0]
2618 certificates = content.getComponentByName('certificates')
2619 cert = certificates[0].getComponentByName('certificate')
2621 logging.error("Certificates not found.")
2623 return encoder.encode(cert)
2626 def load_stats_fdroid_signing_key_fingerprints():
2627 """Load list of signing-key fingerprints stored by fdroid publish from file.
2629 :returns: list of dictionanryies containing the singing-key fingerprints.
2631 jar_file = os.path.join('stats', 'publishsigkeys.jar')
2632 if not os.path.isfile(jar_file):
2634 cmd = [config['jarsigner'], '-strict', '-verify', jar_file]
2635 p = FDroidPopen(cmd, output=False)
2636 if p.returncode != 4:
2637 raise FDroidException("Signature validation of '{}' failed! "
2638 "Please run publish again to rebuild this file.".format(jar_file))
2640 jar_sigkey = apk_signer_fingerprint(jar_file)
2641 repo_key_sig = config.get('repo_key_sha256')
2643 if jar_sigkey != repo_key_sig:
2644 raise FDroidException("Signature key fingerprint of file '{}' does not match repo_key_sha256 in config.py (found fingerprint: '{}')".format(jar_file, jar_sigkey))
2646 logging.warning("repo_key_sha256 not in config.py, setting it to the signature key fingerprint of '{}'".format(jar_file))
2647 config['repo_key_sha256'] = jar_sigkey
2648 write_to_config(config, 'repo_key_sha256')
2650 with zipfile.ZipFile(jar_file, 'r') as f:
2651 return json.loads(str(f.read('publishsigkeys.json'), 'utf-8'))
2654 def write_to_config(thisconfig, key, value=None, config_file=None):
2655 '''write a key/value to the local config.py
2657 NOTE: only supports writing string variables.
2659 :param thisconfig: config dictionary
2660 :param key: variable name in config.py to be overwritten/added
2661 :param value: optional value to be written, instead of fetched
2662 from 'thisconfig' dictionary.
2665 origkey = key + '_orig'
2666 value = thisconfig[origkey] if origkey in thisconfig else thisconfig[key]
2667 cfg = config_file if config_file else 'config.py'
2669 # load config file, create one if it doesn't exist
2670 if not os.path.exists(cfg):
2671 open(cfg, 'a').close()
2672 logging.info("Creating empty " + cfg)
2673 with open(cfg, 'r', encoding="utf-8") as f:
2674 lines = f.readlines()
2676 # make sure the file ends with a carraige return
2678 if not lines[-1].endswith('\n'):
2681 # regex for finding and replacing python string variable
2682 # definitions/initializations
2683 pattern = re.compile('^[\s#]*' + key + '\s*=\s*"[^"]*"')
2684 repl = key + ' = "' + value + '"'
2685 pattern2 = re.compile('^[\s#]*' + key + "\s*=\s*'[^']*'")
2686 repl2 = key + " = '" + value + "'"
2688 # If we replaced this line once, we make sure won't be a
2689 # second instance of this line for this key in the document.
2692 with open(cfg, 'w', encoding="utf-8") as f:
2694 if pattern.match(line) or pattern2.match(line):
2696 line = pattern.sub(repl, line)
2697 line = pattern2.sub(repl2, line)
2708 def parse_xml(path):
2709 return XMLElementTree.parse(path).getroot()
2712 def string_is_integer(string):
2720 def get_per_app_repos():
2721 '''per-app repos are dirs named with the packageName of a single app'''
2723 # Android packageNames are Java packages, they may contain uppercase or
2724 # lowercase letters ('A' through 'Z'), numbers, and underscores
2725 # ('_'). However, individual package name parts may only start with
2726 # letters. https://developer.android.com/guide/topics/manifest/manifest-element.html#package
2727 p = re.compile('^([a-zA-Z][a-zA-Z0-9_]*(\\.[a-zA-Z][a-zA-Z0-9_]*)*)?$')
2730 for root, dirs, files in os.walk(os.getcwd()):
2732 print('checking', root, 'for', d)
2733 if d in ('archive', 'metadata', 'repo', 'srclibs', 'tmp'):
2734 # standard parts of an fdroid repo, so never packageNames
2737 and os.path.exists(os.path.join(d, 'fdroid', 'repo', 'index.jar')):
2743 def is_repo_file(filename):
2744 '''Whether the file in a repo is a build product to be delivered to users'''
2745 if isinstance(filename, str):
2746 filename = filename.encode('utf-8', errors="surrogateescape")
2747 return os.path.isfile(filename) \
2748 and not filename.endswith(b'.asc') \
2749 and not filename.endswith(b'.sig') \
2750 and os.path.basename(filename) not in [
2752 b'index_unsigned.jar',