summaryrefslogtreecommitdiff
path: root/morphlib/plugins/cve_check_plugin.py
blob: 3179d797db22d4330638250ff421819eaaf10d54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# Copyright (C) 2014-2015  Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

# This plugin is used as part of the Baserock automated release process.
#
# See: <http://wiki.baserock.org/guides/release-process> for more information.

import warnings

import re
import cliapp
import morphlib

class CVECheckPlugin(cliapp.Plugin):

    def enable(self):
        self.app.add_subcommand(
            'cve-check', self.cve_check,
            arg_synopsis='REPO REF MORPH [MORPH]...')

    def disable(self):
        pass

    def cve_check(self, args):
        '''Certify that any given system definition is reproducable.

        Command line arguments:

        * `REPO` is a git repository URL.
        * `REF` is a branch or other commit reference in that repository.
        * `MORPH` is a system morphology name at that ref.

        '''

        if len(args) < 3:
            raise cliapp.AppException(
                'Wrong number of arguments to certify command '
                '(see help)')

        repo, ref = args[0], args[1]
        system_filenames = map(morphlib.util.sanitise_morphology_path,
                               args[2:])

        self.lrc, self.rrc = morphlib.util.new_repo_caches(self.app)
        self.resolver = morphlib.artifactresolver.ArtifactResolver()
        self.cve_db = CVEDataBase()
        self.version_guesser = VersionGuesser()

        for system_filename in system_filenames:
            self.certify_system(repo, ref, system_filename)

    def certify_system(self, repo, ref, system_filename):
        '''Certify reproducibility of system.'''

        self.app.status(
            msg='Creating source pool for %s' % system_filename, chatty=True)
        source_pool = morphlib.sourceresolver.create_source_pool(
            self.lrc, self.rrc, repo, ref, system_filename,
            cachedir=self.app.settings['cachedir'],
            update_repos = not self.app.settings['no-git-update'],
            status_cb=self.app.status)

        self.app.status(
            msg='Resolving artifacts for %s' % system_filename, chatty=True)
        root_artifacts = self.resolver.resolve_root_artifacts(source_pool)

        def find_artifact_by_name(artifacts_list, filename):
            for a in artifacts_list:
                if a.source.filename == filename:
                    return a
            raise ValueError

        system_artifact = find_artifact_by_name(root_artifacts,
                                                system_filename)

        aliases = self.app.settings['repo-alias']
        resolver = morphlib.repoaliasresolver.RepoAliasResolver(aliases)

        for source in set(a.source for a in system_artifact.walk()):
            if source.morphology['kind'] != 'chunk':
                continue

            name = source.morphology['name']
            ref = source.original_ref

            print('  Checking chunk: {}'.format(name))

            # Ensure we have a cache of the repo
            if not self.lrc.has_repo(source.repo_name):
                self.lrc.cache_repo(source.repo_name)

            cached = self.lrc.get_repo(source.repo_name)
            version = self.version_guesser.guess_version(cached, ref)

            self.cve_db.check_vulnerability(name, version)


class CVEDetail:
    """
    A single CVE
    """

    def __init__(self, id, ranges):
        self.id = id
        self.ranges = ranges

    def check_vulnerability(self, version):
        print('    {}:'.format(self.id))
        for r in self.ranges:
            print('      version is {}; vulnerable range is: {} to {}'.
                  format(version, r[0], r[1]))

class CVESoftware:
    """
    A piece of software we track CVEs for
    """

    def __init__(self, name):
        self.name = name
        self.cves = []

    def add_cve(self, id, ranges):
        cve = CVEDetail(id, ranges)
        self.cves.append(cve)

    def check_vulnerability(self, version):
        for v in self.cves:
            v.check_vulnerability(version)

class CVEDataBase:
    """
    Provides CVE checking functionality
    """

    def __init__(self):
        # TODO: In the future this could connect to a DB or load YAML data
        #       For now it just creates a hardcoded DB
        self.db = []

        self._add_software('libpng',
                           [['CVE-2014-9495', [['0',     '1.5.20'],
                                               ['1.6.9', '1.6.15']]],
                            ['CVE-2014-0333', [['1.6.0', '1.6.9' ]]]
                           ])

        self._add_software('openssl-new',
                           [['CVE-2014-3567', [['1.0.1', '1.0.1i' ],
                                               ['1.0.0', '1.0.0n' ],
                                               ['0.9.8', '0.9.8zc']]],
                            ['CVE-2014-3568', [['1.0.1', '1.0.1i' ],
                                               ['1.0.0', '1.0.0n' ],
                                               ['0.9.8', '0.9.8zc']]],
                            ['CVE-2014-3513', [['1.0.1', '1.0.1i' ]]],
                            ['CVE-2015-0289', [['1.0.2', '1.0.2'  ],
                                               ['1.0.1', '1.0.1l' ],
                                               ['1.0.0', '1.0.0q' ],
                                               ['0.9.8', '0.9.8ze']]]
                           ])

    def _add_software(self, name, cves):
        sw = CVESoftware(name)
        for v in cves:
            sw.add_cve(v[0], v[1])
        self.db.append(sw)

    def check_vulnerability(self, name, version):
        for s in self.db:
            if s.name != name:
                continue

            s.check_vulnerability(version)
            break


class ProjectVersionGuesser(object):

    def __init__(self, interesting_files):
        self.interesting_files = interesting_files

    def file_contents(self, cached, ref, tree):
        filenames = [x for x in self.interesting_files if x in tree]
        if filenames:
            for filename in filenames:
                yield filename, cached.read_file(filename, ref)

class AutotoolsVersionGuesser(ProjectVersionGuesser):

    def __init__(self):
        ProjectVersionGuesser.__init__(self, [
            'configure.ac',
            'configure.in',
            'configure.ac.in',
            'configure.in.in',
        ])

    def guess_version(self, cached, ref, tree):
        version = None
        for filename, data in self.file_contents(cached, ref, tree):
            # First, try to grep for AC_INIT()
            version = self._check_ac_init(data)
            if version:
                break

        return version

    def _check_ac_init(self, data):
        data = data.replace('\n', ' ')
        for macro in ['AC_INIT', 'AM_INIT_AUTOMAKE']:
            pattern = r'.*%s\((.*?)\).*' % macro
            if not re.match(pattern, data):
                continue
            acinit = re.sub(pattern, r'\1', data)
            if acinit:
                version = acinit.split(',')
                if macro == 'AM_INIT_AUTOMAKE' and len(version) == 1:
                    continue
                version = version[0] if len(version) == 1 else version[1]
                version = re.sub('[\[\]]', '', version).strip()
                version = version.split()[0]
                if version:
                    if version and version[0].isdigit():
                        return version
        return None

class VersionGuesser(object):

    def __init__(self):
        self.guessers = [
            AutotoolsVersionGuesser()
        ]

    def guess_version(self, cached, ref):
        version = None
        tree = cached.list_files(ref, recurse=False)
        for guesser in self.guessers:
            version = guesser.guess_version(cached, ref, tree)
            if version:
                return version

        # Fall back to `git describe` which always gives something
        return cached.version_guess(ref)