summaryrefslogtreecommitdiffstats
path: root/nixos/tests/custom-ca.nix
blob: 2606c21da0dd71529e240fe28f573eba9b0b1498 (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
# Checks that `security.pki` options are working in curl and the main browser
# engines: Gecko (via Firefox), Chromium, QtWebEngine (via qutebrowser).
# The test checks that certificates issued by a custom
# trusted CA are accepted but those from an unknown CA are rejected.

{ runTest, pkgs }:

let
  inherit (pkgs) lib;

  makeCert =
    { caName, domain }:
    pkgs.runCommand "example-cert" { buildInputs = [ pkgs.gnutls ]; } ''
      mkdir $out

      # CA cert template
      cat >ca.template <<EOF
      organization = "${caName}"
      cn = "${caName}"
      expiration_days = 365
      ca
      cert_signing_key
      crl_signing_key
      EOF

      # server cert template
      cat >server.template <<EOF
      organization = "An example company"
      cn = "${domain}"
      expiration_days = 30
      dns_name = "${domain}"
      encryption_key
      signing_key
      EOF

      # generate CA keypair
      certtool                \
        --generate-privkey    \
        --key-type rsa        \
        --sec-param High      \
        --outfile $out/ca.key
      certtool                     \
        --generate-self-signed     \
        --load-privkey $out/ca.key \
        --template ca.template     \
        --outfile $out/ca.crt

      # generate server keypair
      certtool                    \
        --generate-privkey        \
        --key-type rsa            \
        --sec-param High          \
        --outfile $out/server.key
      certtool                            \
        --generate-certificate            \
        --load-privkey $out/server.key    \
        --load-ca-privkey $out/ca.key     \
        --load-ca-certificate $out/ca.crt \
        --template server.template        \
        --outfile $out/server.crt
    '';

  example-good-cert = makeCert {
    caName = "Example good CA";
    domain = "good.example.com";
  };

  example-bad-cert = makeCert {
    caName = "Unknown CA";
    domain = "bad.example.com";
  };

  webserverConfig = {
    networking.hosts."127.0.0.1" = [
      "good.example.com"
      "bad.example.com"
    ];
    security.pki.certificateFiles = [ "${example-good-cert}/ca.crt" ];

    services.nginx.enable = true;
    services.nginx.virtualHosts."good.example.com" = {
      onlySSL = true;
      sslCertificate = "${example-good-cert}/server.crt";
      sslCertificateKey = "${example-good-cert}/server.key";
      locations."/".extraConfig = ''
        add_header Content-Type text/plain;
        return 200 'It works!';
      '';
    };
    services.nginx.virtualHosts."bad.example.com" = {
      onlySSL = true;
      sslCertificate = "${example-bad-cert}/server.crt";
      sslCertificateKey = "${example-bad-cert}/server.key";
      locations."/".extraConfig = ''
        add_header Content-Type text/plain;
        return 200 'It does not work!';
      '';
    };
  };

  curlTest = runTest {
    name = "custom-ca-curl";
    meta.maintainers = with lib.maintainers; [ rnhmjoj ];
    nodes.machine = { ... }: webserverConfig;
    testScript = ''
      with subtest("Good certificate is trusted in curl"):
          machine.wait_for_unit("nginx")
          machine.wait_for_open_port(443)
          machine.succeed("curl -fv https://good.example.com")

      with subtest("Unknown CA is untrusted in curl"):
          machine.fail("curl -fv https://bad.example.com")
    '';
  };

  mkBrowserTest =
    browser: testParams:
    runTest {
      name = "custom-ca-${browser}";
      meta.maintainers = with lib.maintainers; [ rnhmjoj ];

      enableOCR = true;

      nodes.machine =
        { pkgs, ... }:
        {
          imports = [
            ./common/user-account.nix
            ./common/x11.nix
            webserverConfig
          ];

          # chromium-based browsers refuse to run as root
          test-support.displayManager.auto.user = "alice";

          # machine often runs out of memory with less
          virtualisation.memorySize = 1024;

          environment.systemPackages = [
            pkgs.xdotool
            pkgs.${browser}
          ];
        };

      testScript = ''
        from typing import Tuple
        def execute_as(user: str, cmd: str) -> Tuple[int, str]:
            """
            Run a shell command as a specific user.
            """
            return machine.execute(f"sudo -u {user} {cmd}")


        def wait_for_window_as(user: str, cls: str) -> None:
            """
            Wait until a X11 window of a given user appears.
            """

            def window_is_visible(last_try: bool) -> bool:
                ret, stdout = execute_as(user, f"xdotool search --onlyvisible --class {cls}")
                if last_try:
                    machine.log(f"Last chance to match {cls} on the window list")
                return ret == 0

            with machine.nested("Waiting for a window to appear"):
                retry(window_is_visible)


        machine.start()
        machine.wait_for_x()

        command = "${browser} ${testParams.args or ""}"
        with subtest("Good certificate is trusted in ${browser}"):
            execute_as(
                "alice", f"{command} https://good.example.com >&2 &"
            )
            wait_for_window_as("alice", "${browser}")
            machine.sleep(4)
            execute_as("alice", "xdotool key ctrl+r")  # reload to be safe
            machine.wait_for_text("It works!")
            machine.screenshot("good${browser}")
            execute_as("alice", "xdotool key ctrl+w")  # close tab

        with subtest("Unknown CA is untrusted in ${browser}"):
            execute_as("alice", f"{command} https://bad.example.com >&2 &")
            machine.wait_for_text("${testParams.error}")
            machine.screenshot("bad${browser}")
      '';
    };

in

{
  curl = curlTest;
}
// lib.mapAttrs mkBrowserTest {
  firefox = {
    error = "Security Risk";
  };
  chromium = {
    error = "not private";
  };
  qutebrowser = {
    args = "-T";
    error = "Certificate error";
  };
}