chiark / gitweb /
convert internal dict keys to match fdroidclient's Apk class
[fdroidserver.git] / fdroidserver / scanner.py
1 #!/usr/bin/env python3
2 #
3 # scanner.py - part of the FDroid server tools
4 # Copyright (C) 2010-13, Ciaran Gultnieks, ciaran@ciarang.com
5 #
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.
10 #
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.
15 #
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/>.
18
19 import os
20 import re
21 import traceback
22 from argparse import ArgumentParser
23 import logging
24
25 from . import common
26 from . import metadata
27 from .common import BuildException, VCSException
28
29 config = None
30 options = None
31
32
33 def get_gradle_compile_commands(build):
34     compileCommands = ['compile', 'releaseCompile']
35     if build.gradle and build.gradle != ['yes']:
36         compileCommands += [flavor + 'Compile' for flavor in build.gradle]
37         compileCommands += [flavor + 'ReleaseCompile' for flavor in build.gradle]
38
39     return [re.compile(r'\s*' + c, re.IGNORECASE) for c in compileCommands]
40
41
42 # Scan the source code in the given directory (and all subdirectories)
43 # and return the number of fatal problems encountered
44 def scan_source(build_dir, root_dir, build):
45
46     count = 0
47
48     # Common known non-free blobs (always lower case):
49     usual_suspects = {
50         exp: re.compile(r'.*' + exp, re.IGNORECASE) for exp in [
51             r'flurryagent',
52             r'paypal.*mpl',
53             r'google.*analytics',
54             r'admob.*sdk.*android',
55             r'google.*ad.*view',
56             r'google.*admob',
57             r'google.*play.*services',
58             r'crittercism',
59             r'heyzap',
60             r'jpct.*ae',
61             r'youtube.*android.*player.*api',
62             r'bugsense',
63             r'crashlytics',
64             r'ouya.*sdk',
65             r'libspen23',
66             r'firebase',
67         ]
68     }
69
70     def suspects_found(s):
71         for n, r in usual_suspects.items():
72             if r.match(s):
73                 yield n
74
75     gradle_mavenrepo = re.compile(r'maven *{ *(url)? *[\'"]?([^ \'"]*)[\'"]?')
76
77     allowed_repos = [re.compile(r'^https?://' + re.escape(repo) + r'/*') for repo in [
78         'repo1.maven.org/maven2',  # mavenCentral()
79         'jcenter.bintray.com',     # jcenter()
80         'jitpack.io',
81         'repo.maven.apache.org/maven2',
82         'oss.jfrog.org/artifactory/oss-snapshot-local',
83         'oss.sonatype.org/content/repositories/snapshots',
84         'oss.sonatype.org/content/repositories/releases',
85         'oss.sonatype.org/content/groups/public',
86         'clojars.org/repo',  # Clojure free software libs
87         's3.amazonaws.com/repo.commonsware.com',  # CommonsWare
88         'plugins.gradle.org/m2',  # Gradle plugin repo
89         ]
90     ]
91
92     scanignore = common.getpaths_map(build_dir, build.scanignore)
93     scandelete = common.getpaths_map(build_dir, build.scandelete)
94
95     scanignore_worked = set()
96     scandelete_worked = set()
97
98     def toignore(fd):
99         for k, paths in scanignore.items():
100             for p in paths:
101                 if fd.startswith(p):
102                     scanignore_worked.add(k)
103                     return True
104         return False
105
106     def todelete(fd):
107         for k, paths in scandelete.items():
108             for p in paths:
109                 if fd.startswith(p):
110                     scandelete_worked.add(k)
111                     return True
112         return False
113
114     def ignoreproblem(what, fd, fp):
115         logging.info('Ignoring %s at %s' % (what, fd))
116         return 0
117
118     def removeproblem(what, fd, fp):
119         logging.info('Removing %s at %s' % (what, fd))
120         os.remove(fp)
121         return 0
122
123     def warnproblem(what, fd):
124         if toignore(fd):
125             return
126         logging.warn('Found %s at %s' % (what, fd))
127
128     def handleproblem(what, fd, fp):
129         if toignore(fd):
130             return ignoreproblem(what, fd, fp)
131         if todelete(fd):
132             return removeproblem(what, fd, fp)
133         logging.error('Found %s at %s' % (what, fd))
134         return 1
135
136     def is_executable(path):
137         return os.path.exists(path) and os.access(path, os.X_OK)
138
139     textchars = bytearray({7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7f})
140
141     def is_binary(path):
142         d = None
143         with open(path, 'rb') as f:
144             d = f.read(1024)
145         return bool(d.translate(None, textchars))
146
147     # False positives patterns for files that are binary and executable.
148     safe_paths = [re.compile(r) for r in [
149         r".*/drawable[^/]*/.*\.png$",  # png drawables
150         r".*/mipmap[^/]*/.*\.png$",    # png mipmaps
151         ]
152     ]
153
154     def safe_path(path):
155         for sp in safe_paths:
156             if sp.match(path):
157                 return True
158         return False
159
160     gradle_compile_commands = get_gradle_compile_commands(build)
161
162     def is_used_by_gradle(line):
163         return any(command.match(line) for command in gradle_compile_commands)
164
165     # Iterate through all files in the source code
166     for r, d, f in os.walk(build_dir, topdown=True):
167
168         # It's topdown, so checking the basename is enough
169         for ignoredir in ('.hg', '.git', '.svn', '.bzr'):
170             if ignoredir in d:
171                 d.remove(ignoredir)
172
173         for curfile in f:
174
175             if curfile in ['.DS_Store']:
176                 continue
177
178             # Path (relative) to the file
179             fp = os.path.join(r, curfile)
180
181             if os.path.islink(fp):
182                 continue
183
184             fd = fp[len(build_dir) + 1:]
185             _, ext = common.get_extension(fd)
186
187             if ext == 'so':
188                 count += handleproblem('shared library', fd, fp)
189             elif ext == 'a':
190                 count += handleproblem('static library', fd, fp)
191             elif ext == 'class':
192                 count += handleproblem('Java compiled class', fd, fp)
193             elif ext == 'apk':
194                 removeproblem('APK file', fd, fp)
195
196             elif ext == 'jar':
197                 for name in suspects_found(curfile):
198                     count += handleproblem('usual supect \'%s\'' % name, fd, fp)
199                 warnproblem('JAR file', fd)
200
201             elif ext == 'java':
202                 if not os.path.isfile(fp):
203                     continue
204                 with open(fp, 'r', encoding='utf8', errors='replace') as f:
205                     for line in f:
206                         if 'DexClassLoader' in line:
207                             count += handleproblem('DexClassLoader', fd, fp)
208                             break
209
210             elif ext == 'gradle':
211                 if not os.path.isfile(fp):
212                     continue
213                 with open(fp, 'r', encoding='utf8', errors='replace') as f:
214                     lines = f.readlines()
215                 for i, line in enumerate(lines):
216                     if is_used_by_gradle(line):
217                         for name in suspects_found(line):
218                             count += handleproblem('usual supect \'%s\' at line %d' % (name, i + 1), fd, fp)
219                 noncomment_lines = [l for l in lines if not common.gradle_comment.match(l)]
220                 joined = re.sub(r'[\n\r\s]+', ' ', ' '.join(noncomment_lines))
221                 for m in gradle_mavenrepo.finditer(joined):
222                     url = m.group(2)
223                     if not any(r.match(url) for r in allowed_repos):
224                         count += handleproblem('unknown maven repo \'%s\'' % url, fd, fp)
225
226             elif ext in ['', 'bin', 'out', 'exe']:
227                 if is_binary(fp):
228                     count += handleproblem('binary', fd, fp)
229
230             elif is_executable(fp):
231                 if is_binary(fp) and not safe_path(fd):
232                     warnproblem('possible binary', fd)
233
234     for p in scanignore:
235         if p not in scanignore_worked:
236             logging.error('Unused scanignore path: %s' % p)
237             count += 1
238
239     for p in scandelete:
240         if p not in scandelete_worked:
241             logging.error('Unused scandelete path: %s' % p)
242             count += 1
243
244     return count
245
246
247 def main():
248
249     global config, options
250
251     # Parse command line...
252     parser = ArgumentParser(usage="%(prog)s [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
253     common.setup_global_opts(parser)
254     parser.add_argument("appid", nargs='*', help="app-id with optional versionCode in the form APPID[:VERCODE]")
255     metadata.add_metadata_arguments(parser)
256     options = parser.parse_args()
257     metadata.warnings_action = options.W
258
259     config = common.read_config(options)
260
261     # Read all app and srclib metadata
262     allapps = metadata.read_metadata()
263     apps = common.read_app_args(options.appid, allapps, True)
264
265     probcount = 0
266
267     build_dir = 'build'
268     if not os.path.isdir(build_dir):
269         logging.info("Creating build directory")
270         os.makedirs(build_dir)
271     srclib_dir = os.path.join(build_dir, 'srclib')
272     extlib_dir = os.path.join(build_dir, 'extlib')
273
274     for appid, app in apps.items():
275
276         if app.Disabled:
277             logging.info("Skipping %s: disabled" % appid)
278             continue
279         if not app.builds:
280             logging.info("Skipping %s: no builds specified" % appid)
281             continue
282
283         logging.info("Processing " + appid)
284
285         try:
286
287             if app.RepoType == 'srclib':
288                 build_dir = os.path.join('build', 'srclib', app.Repo)
289             else:
290                 build_dir = os.path.join('build', appid)
291
292             # Set up vcs interface and make sure we have the latest code...
293             vcs = common.getvcs(app.RepoType, app.Repo, build_dir)
294
295             for build in app.builds:
296
297                 if build.disable:
298                     logging.info("...skipping version %s - %s" % (
299                         build.versionName, build.get('disable', build.commit[1:])))
300                 else:
301                     logging.info("...scanning version " + build.versionName)
302
303                     # Prepare the source code...
304                     root_dir, _ = common.prepare_source(vcs, app, build,
305                                                         build_dir, srclib_dir,
306                                                         extlib_dir, False)
307
308                     # Do the scan...
309                     count = scan_source(build_dir, root_dir, build)
310                     if count > 0:
311                         logging.warn('Scanner found %d problems in %s (%s)' % (
312                             count, appid, build.versionCode))
313                         probcount += count
314
315         except BuildException as be:
316             logging.warn("Could not scan app %s due to BuildException: %s" % (
317                 appid, be))
318             probcount += 1
319         except VCSException as vcse:
320             logging.warn("VCS error while scanning app %s: %s" % (appid, vcse))
321             probcount += 1
322         except Exception:
323             logging.warn("Could not scan app %s due to unknown error: %s" % (
324                 appid, traceback.format_exc()))
325             probcount += 1
326
327     logging.info("Finished:")
328     print("%d problems found" % probcount)
329
330
331 if __name__ == "__main__":
332     main()