about summary refs log tree commit diff
path: root/pkgs/os-specific/linux/kernel/update-hardened.py
blob: 089e991d06bcb7fd5ec5a6679c33aa6d5c6f24ac (plain) (blame)
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
#! /usr/bin/env nix-shell
#! nix-shell -i python -p "python3.withPackages (ps: [ps.PyGithub])" git gnupg

# This is automatically called by ./update.sh.

import re
import json
import sys
import os.path
from glob import glob
import subprocess
from tempfile import TemporaryDirectory

from github import Github

HERE = os.path.dirname(os.path.realpath(__file__))
HARDENED_GITHUB_REPO = 'anthraxx/linux-hardened'
HARDENED_TRUSTED_KEY = os.path.join(HERE, 'anthraxx.asc')
HARDENED_PATCHES_PATH = os.path.join(HERE, 'hardened-patches.json')
MIN_KERNEL = (4, 14)

HARDENED_VERSION_RE = re.compile(r'''
    (?P<kernel_version> [\d.]+) \.
    (?P<version_suffix> [a-z]+)
''', re.VERBOSE)

def parse_version(version):
    match = HARDENED_VERSION_RE.fullmatch(version)
    if match:
        return match.groups()

def run(*args, **kwargs):
    try:
        return subprocess.run(
            args, **kwargs,
            check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
        )
    except subprocess.CalledProcessError as err:
        print(
            f'error: `{err.cmd}` failed unexpectedly\n'
            f'status code: {err.returncode}\n'
            f'stdout:\n{err.stdout.decode("utf-8").strip()}\n'
            f'stderr:\n{err.stderr.decode("utf-8").strip()}',
            file=sys.stderr,
        )
        sys.exit(1)

def nix_prefetch_url(url):
    output = run('nix-prefetch-url', '--print-path', url).stdout
    return output.decode('utf-8').strip().split('\n')

def verify_openpgp_signature(*, name, trusted_key, sig_path, data_path):
    with TemporaryDirectory(suffix='.nixpkgs-gnupg-home') as gnupg_home:
        run('gpg', '--homedir', gnupg_home, '--import', trusted_key)
        keyring = os.path.join(gnupg_home, 'pubring.kbx')
        try:
            subprocess.run(
                ('gpgv', '--keyring', keyring, sig_path, data_path),
                check=True, stderr=subprocess.PIPE,
            )
            return True
        except subprocess.CalledProcessError as err:
            print(
                f'error: signature for {name} failed to verify!',
                file=sys.stderr,
            )
            print(err.stderr.decode('utf-8'), file=sys.stderr, end='')
            return False

def fetch_patch(*, name, release):
    def find_asset(filename):
        try:
            return next(
                asset.browser_download_url
                for asset in release.get_assets()
                if asset.name == filename
            )
        except StopIteration:
            raise KeyError(filename)

    try:
        patch_url = find_asset(f'{name}.patch')
        sig_url = find_asset(f'{name}.patch.sig')
    except KeyError:
        print(f'error: {name}.patch{{,sig}} not present', file=sys.stderr)
        return None

    sha256, patch_path = nix_prefetch_url(patch_url)
    _, sig_path = nix_prefetch_url(sig_url)
    sig_ok = verify_openpgp_signature(
        name=name,
        trusted_key=HARDENED_TRUSTED_KEY,
        sig_path=sig_path,
        data_path=patch_path,
    )
    if not sig_ok:
        return None

    return {
        'url': patch_url,
        'sha256': sha256,
    }

def commit_patches(*, kernel_version, message):
    with open(HARDENED_PATCHES_PATH + '.new', 'w') as new_patches_file:
        json.dump(patches, new_patches_file, indent=4, sort_keys=True)
        new_patches_file.write('\n')
    os.rename(HARDENED_PATCHES_PATH + '.new', HARDENED_PATCHES_PATH)
    message = f'linux/hardened-patches/{kernel_version}: {message}'
    print(message)
    if os.environ.get('COMMIT'):
        run(
            'git', '-C', HERE, 'commit', f'--message={message}',
            'hardened-patches.json',
        )

# Load the existing patches.
with open(HARDENED_PATCHES_PATH) as patches_file:
    patches = json.load(patches_file)

NIX_VERSION_RE = re.compile(r'''
    \s* version \s* =
    \s* " (?P<version> [^"]*) "
    \s* ; \s* \n
''', re.VERBOSE)

# Get the set of currently packaged kernel versions.
kernel_versions = set()
for filename in os.listdir(HERE):
    filename_match = re.fullmatch(r'linux-(\d+)\.(\d+)\.nix', filename)
    if filename_match:
        if tuple(int(v) for v in filename_match.groups()) < MIN_KERNEL:
            continue
        with open(os.path.join(HERE, filename)) as nix_file:
            for nix_line in nix_file:
                match = NIX_VERSION_RE.fullmatch(nix_line)
                if match:
                    kernel_versions.add(match.group('version'))

# Remove patches for old kernel versions.
for kernel_version in patches.keys() - kernel_versions:
    del patches[kernel_version]
    commit_patches(kernel_version=kernel_version, message='remove')

g = Github(os.environ.get('GITHUB_TOKEN'))
repo = g.get_repo(HARDENED_GITHUB_REPO)
releases = repo.get_releases()

found_kernel_versions = set()
failures = False

for release in releases:
    remaining_kernel_versions = kernel_versions - found_kernel_versions

    if not remaining_kernel_versions:
        break

    version = release.tag_name
    name = f'linux-hardened-{version}'
    version_info = parse_version(version)
    if not version_info:
        continue
    kernel_version, version_suffix = version_info

    if kernel_version in remaining_kernel_versions:
        found_kernel_versions.add(kernel_version)
        try:
            old_version_suffix = patches[kernel_version]['version_suffix']
            old_version = f'{kernel_version}.{old_version_suffix}'
            update = old_version_suffix < version_suffix
        except KeyError:
            update = True
            old_version = None

        if update:
            patch = fetch_patch(name=name, release=release)
            if patch is None:
                failures = True
            else:
                patch['version_suffix'] = version_suffix
                patches[kernel_version] = patch
                if old_version:
                    message = f'{old_version} -> {version}'
                else:
                    message = f'init at {version}'
                commit_patches(kernel_version=kernel_version, message=message)

missing_kernel_versions = kernel_versions - patches.keys()

if missing_kernel_versions:
    print(
        f'warning: no patches for kernel versions ' +
        ', '.join(missing_kernel_versions) +
        '\nwarning: consider manually backporting older patches (bump '
        'JSON key, set version_suffix to "NixOS-a")',
        file=sys.stderr,
    )

if failures:
    sys.exit(1)