3 # scanner.py - part of the FDroid server tools
4 # Copyright (C) 2010-13, Ciaran Gultnieks, ciaran@ciarang.com
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU Affero General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU Affero General Public License for more details.
16 # You should have received a copy of the GNU Affero General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
22 from argparse import ArgumentParser
27 from . import metadata
28 from .exception import BuildException, VCSException
34 def get_gradle_compile_commands(build):
35 compileCommands = ['compile', 'releaseCompile']
36 if build.gradle and build.gradle != ['yes']:
37 compileCommands += [flavor + 'Compile' for flavor in build.gradle]
38 compileCommands += [flavor + 'ReleaseCompile' for flavor in build.gradle]
40 return [re.compile(r'\s*' + c, re.IGNORECASE) for c in compileCommands]
43 def scan_source(build_dir, build):
44 """Scan the source code in the given directory (and all subdirectories)
45 and return the number of fatal problems encountered
50 # Common known non-free blobs (always lower case):
52 exp: re.compile(r'.*' + exp, re.IGNORECASE) for exp in [
56 r'admob.*sdk.*android',
59 r'google.*play.*services',
63 r'youtube.*android.*player.*api',
72 def suspects_found(s):
73 for n, r in usual_suspects.items():
77 gradle_mavenrepo = re.compile(r'maven *{ *(url)? *[\'"]?([^ \'"]*)[\'"]?')
79 allowed_repos = [re.compile(r'^https?://' + re.escape(repo) + r'/*') for repo in [
80 'repo1.maven.org/maven2', # mavenCentral()
81 'jcenter.bintray.com', # jcenter()
83 'repo.maven.apache.org/maven2',
84 'oss.jfrog.org/artifactory/oss-snapshot-local',
85 'oss.sonatype.org/content/repositories/snapshots',
86 'oss.sonatype.org/content/repositories/releases',
87 'oss.sonatype.org/content/groups/public',
88 'clojars.org/repo', # Clojure free software libs
89 's3.amazonaws.com/repo.commonsware.com', # CommonsWare
90 'plugins.gradle.org/m2', # Gradle plugin repo
91 'maven.google.com', # Google Maven Repo, https://developer.android.com/studio/build/dependencies.html#google-maven
95 scanignore = common.getpaths_map(build_dir, build.scanignore)
96 scandelete = common.getpaths_map(build_dir, build.scandelete)
98 scanignore_worked = set()
99 scandelete_worked = set()
101 def toignore(path_in_build_dir):
102 for k, paths in scanignore.items():
104 if path_in_build_dir.startswith(p):
105 scanignore_worked.add(k)
109 def todelete(path_in_build_dir):
110 for k, paths in scandelete.items():
112 if path_in_build_dir.startswith(p):
113 scandelete_worked.add(k)
117 def ignoreproblem(what, path_in_build_dir):
118 logging.info('Ignoring %s at %s' % (what, path_in_build_dir))
121 def removeproblem(what, path_in_build_dir, filepath):
122 logging.info('Removing %s at %s' % (what, path_in_build_dir))
126 def warnproblem(what, path_in_build_dir):
127 if toignore(path_in_build_dir):
129 logging.warn('Found %s at %s' % (what, path_in_build_dir))
131 def handleproblem(what, path_in_build_dir, filepath):
132 if toignore(path_in_build_dir):
133 return ignoreproblem(what, path_in_build_dir)
134 if todelete(path_in_build_dir):
135 return removeproblem(what, path_in_build_dir, filepath)
136 logging.error('Found %s at %s' % (what, path_in_build_dir))
139 def is_executable(path):
140 return os.path.exists(path) and os.access(path, os.X_OK)
142 textchars = bytearray({7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7f})
146 with open(path, 'rb') as f:
148 return bool(d.translate(None, textchars))
150 # False positives patterns for files that are binary and executable.
151 safe_paths = [re.compile(r) for r in [
152 r".*/drawable[^/]*/.*\.png$", # png drawables
153 r".*/mipmap[^/]*/.*\.png$", # png mipmaps
158 for sp in safe_paths:
163 gradle_compile_commands = get_gradle_compile_commands(build)
165 def is_used_by_gradle(line):
166 return any(command.match(line) for command in gradle_compile_commands)
168 # Iterate through all files in the source code
169 for root, dirs, files in os.walk(build_dir, topdown=True):
171 # It's topdown, so checking the basename is enough
172 for ignoredir in ('.hg', '.git', '.svn', '.bzr'):
173 if ignoredir in dirs:
174 dirs.remove(ignoredir)
176 for curfile in files:
178 if curfile in ['.DS_Store']:
181 # Path (relative) to the file
182 filepath = os.path.join(root, curfile)
184 if os.path.islink(filepath):
187 path_in_build_dir = os.path.relpath(filepath, build_dir)
188 _, ext = common.get_extension(path_in_build_dir)
191 count += handleproblem('shared library', path_in_build_dir, filepath)
193 count += handleproblem('static library', path_in_build_dir, filepath)
195 count += handleproblem('Java compiled class', path_in_build_dir, filepath)
197 removeproblem('APK file', path_in_build_dir, filepath)
200 for name in suspects_found(curfile):
201 count += handleproblem('usual supect \'%s\'' % name, path_in_build_dir, filepath)
202 warnproblem('JAR file', path_in_build_dir)
205 warnproblem('AAR file', path_in_build_dir)
208 if not os.path.isfile(filepath):
210 with open(filepath, 'r', encoding='utf8', errors='replace') as f:
212 if 'DexClassLoader' in line:
213 count += handleproblem('DexClassLoader', path_in_build_dir, filepath)
216 elif ext == 'gradle':
217 if not os.path.isfile(filepath):
219 with open(filepath, 'r', encoding='utf8', errors='replace') as f:
220 lines = f.readlines()
221 for i, line in enumerate(lines):
222 if is_used_by_gradle(line):
223 for name in suspects_found(line):
224 count += handleproblem('usual supect \'%s\' at line %d' % (name, i + 1), path_in_build_dir, filepath)
225 noncomment_lines = [l for l in lines if not common.gradle_comment.match(l)]
226 joined = re.sub(r'[\n\r\s]+', ' ', ' '.join(noncomment_lines))
227 for m in gradle_mavenrepo.finditer(joined):
229 if not any(r.match(url) for r in allowed_repos):
230 count += handleproblem('unknown maven repo \'%s\'' % url, path_in_build_dir, filepath)
232 elif ext in ['', 'bin', 'out', 'exe']:
233 if is_binary(filepath):
234 count += handleproblem('binary', path_in_build_dir, filepath)
236 elif is_executable(filepath):
237 if is_binary(filepath) and not safe_path(path_in_build_dir):
238 warnproblem('possible binary', path_in_build_dir)
241 if p not in scanignore_worked:
242 logging.error('Unused scanignore path: %s' % p)
246 if p not in scandelete_worked:
247 logging.error('Unused scandelete path: %s' % p)
255 global config, options
257 # Parse command line...
258 parser = ArgumentParser(usage="%(prog)s [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
259 common.setup_global_opts(parser)
260 parser.add_argument("appid", nargs='*', help=_("applicationId with optional versionCode in the form APPID[:VERCODE]"))
261 metadata.add_metadata_arguments(parser)
262 options = parser.parse_args()
263 metadata.warnings_action = options.W
265 config = common.read_config(options)
267 # Read all app and srclib metadata
268 allapps = metadata.read_metadata()
269 apps = common.read_app_args(options.appid, allapps, True)
274 if not os.path.isdir(build_dir):
275 logging.info("Creating build directory")
276 os.makedirs(build_dir)
277 srclib_dir = os.path.join(build_dir, 'srclib')
278 extlib_dir = os.path.join(build_dir, 'extlib')
280 for appid, app in apps.items():
283 logging.info(_("Skipping {appid}: disabled").format(appid=appid))
286 logging.info(_("Skipping {appid}: no builds specified").format(appid=appid))
289 logging.info(_("Processing {appid}").format(appid=appid))
293 if app.RepoType == 'srclib':
294 build_dir = os.path.join('build', 'srclib', app.Repo)
296 build_dir = os.path.join('build', appid)
298 # Set up vcs interface and make sure we have the latest code...
299 vcs = common.getvcs(app.RepoType, app.Repo, build_dir)
301 for build in app.builds:
304 logging.info("...skipping version %s - %s" % (
305 build.versionName, build.get('disable', build.commit[1:])))
307 logging.info("...scanning version " + build.versionName)
309 # Prepare the source code...
310 common.prepare_source(vcs, app, build,
311 build_dir, srclib_dir,
315 count = scan_source(build_dir, build)
317 logging.warn('Scanner found %d problems in %s (%s)' % (
318 count, appid, build.versionCode))
321 except BuildException as be:
322 logging.warn("Could not scan app %s due to BuildException: %s" % (
325 except VCSException as vcse:
326 logging.warn("VCS error while scanning app %s: %s" % (appid, vcse))
329 logging.warn("Could not scan app %s due to unknown error: %s" % (
330 appid, traceback.format_exc()))
333 logging.info(_("Finished"))
334 print(_("%d problems found") % probcount)
337 if __name__ == "__main__":