summaryrefslogtreecommitdiff
path: root/tools/find-untrusted-exec.py
blob: 6143defd690552fe9f161e20119613d3e0570bb0 (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
# Copyright 2020 Red Hat Inc
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

import argparse
import json
import sys
import datetime
import requests
from pathlib import Path


def usage(argv):
    two_weeks_ago = datetime.datetime.utcnow() - datetime.timedelta(days=14)
    parser = argparse.ArgumentParser(
        description="Look for unstrusted command in builds log")
    parser.add_argument(
        "--since", default=two_weeks_ago, help="Date in YYYY-MM-DD format")
    parser.add_argument("zuul_url", help="The url of a zuul-web service")
    args = parser.parse_args(argv)

    args.zuul_url = args.zuul_url.rstrip("/")
    if not args.zuul_url.endswith("/api"):
        args.zuul_url += "/api"
    if not isinstance(args.since, datetime.datetime):
        args.since = datetime.datetime.strptime(args.since, "%Y-%m-%d")
    return args


def get_tenants(zuul_url):
    """ Fetch list of tenant names """
    is_witelabel = requests.get(
        "%s/info" % zuul_url).json().get('tenant', None) is not None
    if is_witelabel:
        raise RuntimeError("Need multitenant api")
    return [
        tenant["name"]
        for tenant in requests.get("%s/tenants" % zuul_url).json()
    ]


def is_build_in_range(build, since):
    """ Check if a build is in range """
    try:
        build_date = datetime.datetime.strptime(
            build["start_time"], "%Y-%m-%dT%H:%M:%S")
        return build_date > since
    except TypeError:
        return False


def get_builds(zuul_builds_url, since):
    """ Fecth list of builds that are in range """
    builds = []
    pos = 0
    step = 50
    while not builds or is_build_in_range(builds[-1], since):
        url = "%s?skip=%d&limit=%d" % (zuul_builds_url, pos, step)
        print("Querying %s" % url)
        builds += requests.get(url).json()
        pos += step
    return builds


def filter_unique_builds(builds):
    """ Filter the list of build to keep only one per job name """
    jobs = dict()
    for build in builds:
        if build["job_name"] not in jobs:
            jobs[build["job_name"]] = build
    unique_builds = list(jobs.values())
    print("Found %d unique job builds" % len(unique_builds))
    return unique_builds


def download(source_url, local_filename):
    """ Download a file using streaming request """
    with requests.get(source_url, local_filename, stream=True) as r:
        r.raise_for_status()
        with open(local_filename, 'wb') as f:
            for chunk in r.iter_content(chunk_size=8192):
                f.write(chunk)


def download_build_job_output(zuul_build_url, local_path):
    """ Download the job-output.json of a build """
    build = requests.get(zuul_build_url).json()
    if not build.get("log_url"):
        return "No log url"
    try:
        download(build["log_url"] + "job-output.json", local_path)
    except Exception as e:
        return str(e)


def examine(path):
    """ Look for forbidden tasks in  a job-output.json file path """
    data = json.load(open(path))
    to_fix = False
    for playbook in data:
        if playbook['trusted']:
            continue
        for play in playbook['plays']:
            for task in play['tasks']:
                for hostname, host in task['hosts'].items():
                    if hostname != 'localhost':
                        continue
                    if host['action'] in ['command', 'shell']:
                        print("Found disallowed task:")
                        print("  Playbook: %s" % playbook['playbook'])
                        print("  Role: %s" % task.get('role', {}).get('name'))
                        print("  Task: %s" % task.get('task', {}).get('name'))
                        to_fix = True
    return to_fix


def main(argv):
    args = usage(argv)
    cache_dir = Path("/tmp/zuul-logs")
    if not cache_dir.exists():
        cache_dir.mkdir()

    to_fix = set()
    failed_to_examine = set()
    for tenant in get_tenants(args.zuul_url):
        zuul_tenant_url = args.zuul_url + "/tenant/" + tenant
        print("Looking for unique build in %s" % zuul_tenant_url)
        for build in filter_unique_builds(
                get_builds(zuul_tenant_url + "/builds", args.since)):
            if not build.get("uuid"):
                # Probably a SKIPPED build, no need to examine
                continue
            local_path = cache_dir / (build["uuid"] + ".json")
            build_url = zuul_tenant_url + "/build/" + build["uuid"]
            if not local_path.exists():
                err = download_build_job_output(build_url, str(local_path))
                if err:
                    failed_to_examine.add((build_url, err))
                    continue
            try:
                if not examine(str(local_path)):
                    print("%s: ok" % build_url)
                else:
                    to_fix.add(build_url)
            except Exception as e:
                failed_to_examine.add((build_url, str(e)))

    if failed_to_examine:
        print("The following builds could not be examined:")
        for build_url, err in failed_to_examine:
            print("%s: %s" % (build_url, err))
        if not to_fix:
            exit(1)

    if to_fix:
        print("The following builds are using localhost command:")
        for build in to_fix:
            print(build.replace("/api/", "/t/"))
        exit(1)


if __name__ == "__main__":
    main(sys.argv[1:])