ssh-zone-handler/tests/test_ssh_zone_handler.py at ffdeaa1b1af69876ef17c6d31badf29a1d58b035 · andreaso/ssh-zone-handler · GitHub

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
# ruff: noqa: ANN001, ANN201, S101
"""Testing top level functionality"""

import os
import sys
from pathlib import Path

import pytest

from ssh_zone_handler.bind import BindCommand
from ssh_zone_handler.cli import (
    ConfigFileError,
    _read_config,
    ssh_keys,
    sudoers,
    wrapper,
)
from ssh_zone_handler.knot import KnotCommand


def test_cli_read_config():
    example_config = _read_config(Path("./tests/data/bind-example-config.yaml"))
    assert example_config.model_dump() == {
        "system": {
            "journalctl_user": "szh-logviewer",
            "login_user": "zones",
            "server_type": "bind",
            "server_user": "bind",
            "systemd_unit": "named.service",
        },
        "users": {
            "alice": {
                "ssh_keys": [
                    "[email protected] AAAAGnNrLXNzaC1lZDI1NTE5QG9wZW5zc2guY29tAAAAIGlLAm/yjw76GuHsUDlqEJMrIRiyHSMlXlx/XlpRn1dfAAAABHNzaDo=",
                    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIOy9uTo12niUl2JCWUebyzr/5pMa64BuFc/0nGjtQad",
                ],
                "zones": ["example.com", "example.net"],
            },
            "bob": {
                "ssh_keys": [
                    "[email protected] AAAAInNrLWVjZHNhLXNoYTItbmlzdHAyNTZAb3BlbnNzaC5jb20AAAAIbmlzdHAyNTYAAABBBPnGjVz9axrV3stm+5onXYSO/MIOdggKBw5Y5jYJReqwnkIuQ+OMME6oQUuvev+hCURpnKBlfC8zcHRKWUYFF1IAAAAEc3NoOg==",
                ],
                "zones": ["example.org"],
            },
        },
    }

    alternative_config = _read_config(Path("./tests/data/bind-alternative-config.yaml"))
    assert alternative_config.model_dump() == {
        "system": {
            "journalctl_user": "odin",
            "login_user": "zones",
            "server_type": "bind",
            "server_user": "named",
            "systemd_unit": "bind9.service",
        },
        "users": {
            "bob": {
                "ssh_keys": [],
                "zones": [],
            },
        },
    }

    knot_config = _read_config(Path("./tests/data/knot-example-config.yaml"))
    assert knot_config.model_dump() == {
        "system": {
            "journalctl_user": "szh-logviewer",
            "login_user": "zones",
            "server_type": "knot",
            "server_user": "knot",
            "systemd_unit": "knot.service",
        },
        "users": {
            "alice": {
                "ssh_keys": [
                    "[email protected] AAAAGnNrLXNzaC1lZDI1NTE5QG9wZW5zc2guY29tAAAAIGlLAm/yjw76GuHsUDlqEJMrIRiyHSMlXlx/XlpRn1dfAAAABHNzaDo=",
                    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIOy9uTo12niUl2JCWUebyzr/5pMa64BuFc/0nGjtQad",
                ],
                "zones": ["example.com", "example.net"],
            },
            "bob": {
                "ssh_keys": [
                    "[email protected] AAAAInNrLWVjZHNhLXNoYTItbmlzdHAyNTZAb3BlbnNzaC5jb20AAAAIbmlzdHAyNTYAAABBBPnGjVz9axrV3stm+5onXYSO/MIOdggKBw5Y5jYJReqwnkIuQ+OMME6oQUuvev+hCURpnKBlfC8zcHRKWUYFF1IAAAAEc3NoOg==",
                ],
                "zones": ["example.org"],
            },
        },
    }

    with pytest.raises(ConfigFileError):
        _read_config(Path("./tests/data/outdated-config.yaml"))


def test_cli_zone_ssh_keys(caplog, capsys):
    wrapper = Path(sys.argv[0]).absolute().parent / "szh-wrapper"

    ssh_keys(Path("./tests/data/bind-example-config.yaml"))
    captured_expected = capsys.readouterr()

    assert captured_expected.out == "\n".join(
        [
            f'command="{wrapper} alice",restrict [email protected] AAAAGnNrLXNzaC1lZDI1NTE5QG9wZW5zc2guY29tAAAAIGlLAm/yjw76GuHsUDlqEJMrIRiyHSMlXlx/XlpRn1dfAAAABHNzaDo=',
            f'command="{wrapper} alice",restrict ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIOy9uTo12niUl2JCWUebyzr/5pMa64BuFc/0nGjtQad',
            f'command="{wrapper} bob",restrict [email protected] AAAAInNrLWVjZHNhLXNoYTItbmlzdHAyNTZAb3BlbnNzaC5jb20AAAAIbmlzdHAyNTYAAABBBPnGjVz9axrV3stm+5onXYSO/MIOdggKBw5Y5jYJReqwnkIuQ+OMME6oQUuvev+hCURpnKBlfC8zcHRKWUYFF1IAAAAEc3NoOg==\n',
        ]
    )

    caplog.clear()
    ssh_keys(Path("./tests/data/bind-alternative-config.yaml"))
    captured_alternate_expected = capsys.readouterr()

    assert captured_alternate_expected.out == "\n".join([])

    caplog.clear()
    with pytest.raises(SystemExit):
        sudoers(Path("./tests/data/duplicate-ssh-keys-config.yaml"))


def test_cli_zone_sudoers(caplog, capsys):
    sudoers(Path("./tests/data/bind-example-config.yaml"))
    captured_expected = capsys.readouterr()

    assert captured_expected.out == "\n".join(
        [
            "zones\tALL=(szh-logviewer) NOPASSWD: /usr/bin/journalctl --unit=named.service --since=-5days --utc",
            "zones\tALL=(bind) NOPASSWD: /usr/sbin/rndc retransfer *",
            "zones\tALL=(bind) NOPASSWD: /usr/sbin/rndc zonestatus *\n",
        ]
    )

    caplog.clear()
    sudoers(Path("./tests/data/knot-example-config.yaml"))
    captured_knot_expected = capsys.readouterr()

    assert captured_knot_expected.out == "\n".join(
        [
            "zones\tALL=(szh-logviewer) NOPASSWD: /usr/bin/journalctl --unit=knot.service --since=-5days --utc",
            "zones\tALL=(knot) NOPASSWD: /usr/sbin/knotc zone-read *",
            "zones\tALL=(knot) NOPASSWD: /usr/sbin/knotc zone-retransfer *\n",
        ]
    )

    caplog.clear()
    with pytest.raises(SystemExit):
        sudoers(Path("./tests/data/outdated-config.yaml"))
    captured_outdated = caplog.text
    assert (
        "Invalid server side config file\n\n5 validation errors for ZoneHandlerConf"
        in captured_outdated
    )


def test_cli_zone_wrapper(caplog, capsys, mocker):
    mocker.patch("sys.argv", ["_", "alice"])

    os.environ["SSH_ORIGINAL_COMMAND"] = "list"
    wrapper(Path("./tests/data/bind-example-config.yaml"))
    captured_passing = capsys.readouterr()
    assert captured_passing.out == "example.com\nexample.net\n"

    caplog.clear()
    os.environ["SSH_ORIGINAL_COMMAND"] = "sing"
    with pytest.raises(SystemExit):
        wrapper(Path("./tests/data/bind-example-config.yaml"))
    captured_invalid = caplog.text
    assert captured_invalid == 'Invalid command, try "help"\n'

    caplog.clear()
    os.environ["SSH_ORIGINAL_COMMAND"] = "logs example.org"
    with pytest.raises(SystemExit):
        wrapper(Path("./tests/data/bind-example-config.yaml"))
    captured_wrong_zone = caplog.text
    assert captured_wrong_zone == "No valid zone provided\n"

    caplog.clear()
    os.environ["SSH_ORIGINAL_COMMAND"] = "list"
    with pytest.raises(SystemExit):
        wrapper(Path("./tests/data/outdated-config.yaml"))
    captured_outdated = caplog.text
    assert captured_outdated == "Invalid server side config file\n"

    caplog.clear()
    mocker.patch("sys.argv", ["_", "bob"])
    os.environ["SSH_ORIGINAL_COMMAND"] = "help"
    with pytest.raises(SystemExit):
        wrapper(Path("./tests/data/bind-alternative-config.yaml"))
    captured_nozones_user = caplog.text
    assert captured_nozones_user == 'No zones configured for user "bob"\n'

    caplog.clear()
    mocker.patch("sys.argv", ["_", "mallory"])
    os.environ["SSH_ORIGINAL_COMMAND"] = "help"
    with pytest.raises(KeyError):
        wrapper(Path("./tests/data/bind-example-config.yaml"))


def test_bind_log_filtering():
    filtered_file_net = Path("./tests/data/filtered-named-example-net.txt")
    filtered_data_net = filtered_file_net.read_text(encoding="utf-8").rstrip()

    filtered_file_com_net = Path("./tests/data/filtered-named-example-com-net.txt")
    filtered_data_com_net = filtered_file_com_net.read_text(encoding="utf-8").rstrip()

    log_file = Path("./tests/data/journald-named.txt")
    log_data = log_file.read_text(encoding="utf-8")
    log_lines = log_data.split("\n")

    zones = ["example.net"]
    filtered = []
    for line in BindCommand._filter_logs(log_lines, zones):
        filtered.append(line)
    assert filtered == filtered_data_net.split("\n")

    zones = ["example.com", "example.net"]
    filtered = []
    for line in BindCommand._filter_logs(log_lines, zones):
        filtered.append(line)
    assert filtered == filtered_data_com_net.split("\n")


def test_knot_log_filtering():
    filtered_file_net = Path("./tests/data/filtered-knot-example-net.txt")
    filtered_data_net = filtered_file_net.read_text(encoding="utf-8").rstrip()

    filtered_file_com_net = Path("./tests/data/filtered-knot-example-com-net.txt")
    filtered_data_com_net = filtered_file_com_net.read_text(encoding="utf-8").rstrip()

    log_file = Path("./tests/data/journald-knot.txt")
    log_data = log_file.read_text(encoding="utf-8")
    log_lines = log_data.split("\n")

    zones = ["example.net"]
    filtered = []
    for line in KnotCommand._filter_logs(log_lines, zones):
        filtered.append(line)
    assert filtered == filtered_data_net.split("\n")

    zones = ["example.com", "example.net"]
    filtered = []
    for line in KnotCommand._filter_logs(log_lines, zones):
        filtered.append(line)
    assert filtered == filtered_data_com_net.split("\n")