pyrox.dev
1import ./make-test-python.nix ({ pkgs, ... }: let
2 snakeOil = pkgs.runCommand "snakeoil-certs" {
3 outputs = [ "out" "cacert" "cert" "key" "crl" ];
4 buildInputs = [ pkgs.gnutls.bin ];
5 caTemplate = pkgs.writeText "snakeoil-ca.template" ''
6 cn = server
7 expiration_days = -1
8 cert_signing_key
9 ca
10 '';
11 certTemplate = pkgs.writeText "snakeoil-cert.template" ''
12 cn = server
13 expiration_days = -1
14 tls_www_server
15 encryption_key
16 signing_key
17 '';
18 crlTemplate = pkgs.writeText "snakeoil-crl.template" ''
19 expiration_days = -1
20 '';
21 userCertTemplate = pkgs.writeText "snakeoil-user-cert.template" ''
22 organization = snakeoil
23 cn = server
24 expiration_days = -1
25 tls_www_client
26 encryption_key
27 signing_key
28 '';
29 } ''
30 certtool -p --bits 4096 --outfile ca.key
31 certtool -s --template "$caTemplate" --load-privkey ca.key \
32 --outfile "$cacert"
33 certtool -p --bits 4096 --outfile "$key"
34 certtool -c --template "$certTemplate" \
35 --load-ca-privkey ca.key \
36 --load-ca-certificate "$cacert" \
37 --load-privkey "$key" \
38 --outfile "$cert"
39 certtool --generate-crl --template "$crlTemplate" \
40 --load-ca-privkey ca.key \
41 --load-ca-certificate "$cacert" \
42 --outfile "$crl"
43
44 mkdir "$out"
45
46 # Stripping key information before the actual PEM-encoded values is solely
47 # to make test output a bit less verbose when copying the client key to the
48 # actual client.
49 certtool -p --bits 4096 | sed -n \
50 -e '/^----* *BEGIN/,/^----* *END/p' > "$out/alice.key"
51
52 certtool -c --template "$userCertTemplate" \
53 --load-privkey "$out/alice.key" \
54 --load-ca-privkey ca.key \
55 --load-ca-certificate "$cacert" \
56 --outfile "$out/alice.cert"
57 '';
58
59in {
60 name = "taskserver";
61
62 nodes = rec {
63 server = {
64 services.taskserver.enable = true;
65 services.taskserver.listenHost = "::";
66 services.taskserver.fqdn = "server";
67 services.taskserver.organisations = {
68 testOrganisation.users = [ "alice" "foo" ];
69 anotherOrganisation.users = [ "bob" ];
70 };
71 };
72
73 # New generation of the server with manual config
74 newServer = { lib, nodes, ... }: {
75 imports = [ server ];
76 services.taskserver.pki.manual = {
77 ca.cert = snakeOil.cacert;
78 server.cert = snakeOil.cert;
79 server.key = snakeOil.key;
80 server.crl = snakeOil.crl;
81 };
82 # This is to avoid assigning a different network address to the new
83 # generation.
84 networking = lib.mapAttrs (lib.const lib.mkForce) {
85 interfaces.eth1.ipv4 = nodes.server.config.networking.interfaces.eth1.ipv4;
86 inherit (nodes.server.config.networking)
87 hostName primaryIPAddress extraHosts;
88 };
89 };
90
91 client1 = { pkgs, ... }: {
92 environment.systemPackages = [ pkgs.taskwarrior pkgs.gnutls ];
93 users.users.alice.isNormalUser = true;
94 users.users.bob.isNormalUser = true;
95 users.users.foo.isNormalUser = true;
96 users.users.bar.isNormalUser = true;
97 };
98
99 client2 = client1;
100 };
101
102 testScript = { nodes, ... }: let
103 cfg = nodes.server.config.services.taskserver;
104 portStr = toString cfg.listenPort;
105 newServerSystem = nodes.newServer.config.system.build.toplevel;
106 switchToNewServer = "${newServerSystem}/bin/switch-to-configuration test";
107 in ''
108 from shlex import quote
109
110
111 def su(user, cmd):
112 return f"su - {user} -c {quote(cmd)}"
113
114
115 def no_extra_init(client, org, user):
116 pass
117
118
119 def setup_clients_for(org, user, extra_init=no_extra_init):
120 for client in [client1, client2]:
121 with client.nested(f"initialize client for user {user}"):
122 client.succeed(
123 su(user, f"rm -rf /home/{user}/.task"),
124 su(user, "task rc.confirmation=no config confirmation no"),
125 )
126
127 exportinfo = server.succeed(f"nixos-taskserver user export {org} {user}")
128
129 with client.nested("importing taskwarrior configuration"):
130 client.succeed(su(user, f"eval {quote(exportinfo)} >&2"))
131
132 extra_init(client, org, user)
133
134 client.succeed(su(user, "task config taskd.server server:${portStr} >&2"))
135
136 client.succeed(su(user, "task sync init >&2"))
137
138
139 def restart_server():
140 server.systemctl("restart taskserver.service")
141 server.wait_for_open_port(${portStr})
142
143
144 def re_add_imperative_user():
145 with server.nested("(re-)add imperative user bar"):
146 server.execute("nixos-taskserver org remove imperativeOrg")
147 server.succeed(
148 "nixos-taskserver org add imperativeOrg",
149 "nixos-taskserver user add imperativeOrg bar",
150 )
151 setup_clients_for("imperativeOrg", "bar")
152
153
154 def test_sync(user):
155 with subtest(f"sync for user {user}"):
156 client1.succeed(su(user, "task add foo >&2"))
157 client1.succeed(su(user, "task sync >&2"))
158 client2.fail(su(user, "task list >&2"))
159 client2.succeed(su(user, "task sync >&2"))
160 client2.succeed(su(user, "task list >&2"))
161
162
163 def check_client_cert(user):
164 # debug level 3 is a workaround for gnutls issue https://gitlab.com/gnutls/gnutls/-/issues/1040
165 cmd = (
166 f"gnutls-cli -d 3"
167 f" --x509cafile=/home/{user}/.task/keys/ca.cert"
168 f" --x509keyfile=/home/{user}/.task/keys/private.key"
169 f" --x509certfile=/home/{user}/.task/keys/public.cert"
170 f" --port=${portStr} server < /dev/null"
171 )
172 return su(user, cmd)
173
174
175 # Explicitly start the VMs so that we don't accidentally start newServer
176 server.start()
177 client1.start()
178 client2.start()
179
180 server.wait_for_unit("taskserver.service")
181
182 server.succeed(
183 "nixos-taskserver user list testOrganisation | grep -qxF alice",
184 "nixos-taskserver user list testOrganisation | grep -qxF foo",
185 "nixos-taskserver user list anotherOrganisation | grep -qxF bob",
186 )
187
188 server.wait_for_open_port(${portStr})
189
190 client1.wait_for_unit("multi-user.target")
191 client2.wait_for_unit("multi-user.target")
192
193 setup_clients_for("testOrganisation", "alice")
194 setup_clients_for("testOrganisation", "foo")
195 setup_clients_for("anotherOrganisation", "bob")
196
197 for user in ["alice", "bob", "foo"]:
198 test_sync(user)
199
200 server.fail("nixos-taskserver user add imperativeOrg bar")
201 re_add_imperative_user()
202
203 test_sync("bar")
204
205 with subtest("checking certificate revocation of user bar"):
206 client1.succeed(check_client_cert("bar"))
207
208 server.succeed("nixos-taskserver user remove imperativeOrg bar")
209 restart_server()
210
211 client1.fail(check_client_cert("bar"))
212
213 client1.succeed(su("bar", "task add destroy everything >&2"))
214 client1.fail(su("bar", "task sync >&2"))
215
216 re_add_imperative_user()
217
218 with subtest("checking certificate revocation of org imperativeOrg"):
219 client1.succeed(check_client_cert("bar"))
220
221 server.succeed("nixos-taskserver org remove imperativeOrg")
222 restart_server()
223
224 client1.fail(check_client_cert("bar"))
225
226 client1.succeed(su("bar", "task add destroy even more >&2"))
227 client1.fail(su("bar", "task sync >&2"))
228
229 re_add_imperative_user()
230
231 with subtest("check whether declarative config overrides user bar"):
232 restart_server()
233 test_sync("bar")
234
235
236 def init_manual_config(client, org, user):
237 cfgpath = f"/home/{user}/.task"
238
239 client.copy_from_host(
240 "${snakeOil.cacert}",
241 f"{cfgpath}/ca.cert",
242 )
243 for file in ["alice.key", "alice.cert"]:
244 client.copy_from_host(
245 f"${snakeOil}/{file}",
246 f"{cfgpath}/{file}",
247 )
248
249 for file in [f"{user}.key", f"{user}.cert"]:
250 client.copy_from_host(
251 f"${snakeOil}/{file}",
252 f"{cfgpath}/{file}",
253 )
254
255 client.succeed(
256 su("alice", f"task config taskd.ca {cfgpath}/ca.cert"),
257 su("alice", f"task config taskd.key {cfgpath}/{user}.key"),
258 su(user, f"task config taskd.certificate {cfgpath}/{user}.cert"),
259 )
260
261
262 with subtest("check manual configuration"):
263 # Remove the keys from automatic CA creation, to make sure the new
264 # generation doesn't use keys from before.
265 server.succeed("rm -rf ${cfg.dataDir}/keys/* >&2")
266
267 server.succeed(
268 "${switchToNewServer} >&2"
269 )
270 server.wait_for_unit("taskserver.service")
271 server.wait_for_open_port(${portStr})
272
273 server.succeed(
274 "nixos-taskserver org add manualOrg",
275 "nixos-taskserver user add manualOrg alice",
276 )
277
278 setup_clients_for("manualOrg", "alice", init_manual_config)
279
280 test_sync("alice")
281 '';
282})