commit 5f5d38e88f5a30bc85dce244d2dece22f5dc4e90 · pyrox.dev/nixpkgs

+56

nixos/doc/manual/release-notes/rl-2103.xml

···

       172
        
            All services should use <xref linkend="opt-systemd.services._name_.startLimitIntervalSec" /> or <literal>StartLimitIntervalSec</literal> in <xref linkend="opt-systemd.services._name_.unitConfig" /> instead.

     

       173
        
           </para>

     

       174
        
          </listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       175
        
         </itemizedlist>

     

       176
        
        </section>

     

       177
        
       </section>

···

       172
        
            All services should use <xref linkend="opt-systemd.services._name_.startLimitIntervalSec" /> or <literal>StartLimitIntervalSec</literal> in <xref linkend="opt-systemd.services._name_.unitConfig" /> instead.

     

       173
        
           </para>

     

       174
        
          </listitem>

     

       175
       +
          <listitem>

     

       176
       +
           <para>

     

       177
       +
            The Unbound DNS resolver service (<literal>services.unbound</literal>) has been refactored to allow reloading, control sockets and to fix startup ordering issues.

     

       178
       +
           </para>

     

       179
       +
       

     

       180
       +
           <para>

     

       181
       +
            It is now possible to enable a local UNIX control socket for unbound by setting the <xref linkend="opt-services.unbound.localControlSocketPath" />

     

       182
       +
            option.

     

       183
       +
           </para>

     

       184
       +
       

     

       185
       +
           <para>

     

       186
       +
            Previously we just applied a very minimal set of restrictions and

     

       187
       +
            trusted unbound to properly drop root privs and capabilities.

     

       188
       +
           </para>

     

       189
       +
       

     

       190
       +
           <para>

     

       191
       +
            As of this we are (for the most part) just using the upstream

     

       192
       +
            example unit file for unbound. The main difference is that we start

     

       193
       +
            unbound as <literal>unbound</literal> user with the required capabilities instead of

     

       194
       +
            letting unbound do the chroot &amp; uid/gid changes.

     

       195
       +
           </para>

     

       196
       +
       

     

       197
       +
           <para>

     

       198
       +
            The upstream unit configuration this is based on is a lot stricter with

     

       199
       +
            all kinds of permissions then our previous variant. It also came with

     

       200
       +
            the default of having the <literal>Type</literal> set to <literal>notify</literal>, therefore we are now also

     

       201
       +
            using the <literal>unbound-with-systemd</literal> package here. Unbound will start up,

     

       202
       +
            read the configuration files and start listening on the configured ports

     

       203
       +
            before systemd will declare the unit <literal>active (running)</literal>.

     

       204
       +
            This will likely help with startup order and the occasional race condition during system

     

       205
       +
            activation where the DNS service is started but not yet ready to answer

     

       206
       +
            queries. Services depending on <literal>nss-lookup.target</literal> or <literal>unbound.service</literal>

     

       207
       +
            are now be able to use unbound when those targets have been reached.

     

       208
       +
           </para>

     

       209
       +
       

     

       210
       +
           <para>

     

       211
       +
            Aditionally to the much stricter runtime environmet the

     

       212
       +
            <literal>/dev/urandom</literal> mount lines we previously had in the code (that would

     

       213
       +
            randomly failed during the stop-phase) have been removed as systemd will take care of those for us.

     

       214
       +
           </para>

     

       215
       +
       

     

       216
       +
           <para>

     

       217
       +
            The <literal>preStart</literal> script is now only required if we enabled the trust

     

       218
       +
             anchor updates (which are still enabled by default).

     

       219
       +
           </para>

     

       220
       +
       

     

       221
       +
           <para>

     

       222
       +
            Another benefit of the refactoring is that we can now issue reloads via

     

       223
       +
            either <literal>pkill -HUP unbound</literal> and <literal>systemctl reload unbound</literal> to reload the

     

       224
       +
            running configuration without taking the daemon offline. A prerequisite

     

       225
       +
            of this was that unbound configuration is available on a well known path

     

       226
       +
            on the file system. We are using the path <literal>/etc/unbound/unbound.conf</literal> as that is the

     

       227
       +
            default in the CLI tooling which in turn enables us to use

     

       228
       +
            <literal>unbound-control</literal> without passing a custom configuration location.

     

       229
       +
           </para>

     

       230
       +
          </listitem>

     

       231
        
         </itemizedlist>

     

       232
        
        </section>

     

       233
        
       </section>

+104 -33

nixos/modules/services/networking/unbound.nix

···

       1
        
       { config, lib, pkgs, ... }:

     

       2
        
       

     

       3
        
       with lib;

     

       4
       -
       

     

       5
        
       let

     

       6
       -
       

     

       7
        
         cfg = config.services.unbound;

     

       8
        
       

     

       9
        
         stateDir = "/var/lib/unbound";

     
···

       17
        
         forward =

     

       18
        
           optionalString (any isLocalAddress cfg.forwardAddresses) ''

     

       19
        
             do-not-query-localhost: no

     

       20
       -
           '' +

     

       21
       -
           optionalString (cfg.forwardAddresses != []) ''

     

       22
        
             forward-zone:

     

       23
        
               name: .

     

       24
       -
           '' +

     

       25
       -
           concatMapStringsSep "\n" (x: "    forward-addr: ${x}") cfg.forwardAddresses;

     

       26
        
       

     

       27
        
         rootTrustAnchorFile = "${stateDir}/root.key";

     

       28
        
       

     
···

       31
        
       

     

       32
        
         confFile = pkgs.writeText "unbound.conf" ''

     

       33
        
           server:

     

       0
        
       
     

       34
        
             directory: "${stateDir}"

     

       35
        
             username: unbound

     

       36
       -
             chroot: "${stateDir}"

     

       37
        
             pidfile: ""

     

       0
        
       
     

       0
        
       
     

       38
        
             ${interfaces}

     

       39
        
             ${access}

     

       40
        
             ${trustAnchor}

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       41
        
           ${cfg.extraConfig}

     

       42
        
           ${forward}

     

       43
        
         '';

     

       44
       -
       

     

       45
        
       in

     

       46
       -
       

     

       47
        
       {

     

       48
        
       

     

       49
        
         ###### interface

     
···

       55
        
       

     

       56
        
             package = mkOption {

     

       57
        
               type = types.package;

     

       58
       -
               default = pkgs.unbound;

     

       59
       -
               defaultText = "pkgs.unbound";

     

       60
        
               description = "The unbound package to use";

     

       61
        
             };

     

       62
        
       

     
···

       69
        
             interfaces = mkOption {

     

       70
        
               default = [ "127.0.0.1" ] ++ optional config.networking.enableIPv6 "::1";

     

       71
        
               type = types.listOf types.str;

     

       72
       -
               description = "What addresses the server should listen on.";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       73
        
             };

     

       74
        
       

     

       75
        
             forwardAddresses = mkOption {

     

       76
       -
               default = [ ];

     

       77
        
               type = types.listOf types.str;

     

       78
        
               description = "What servers to forward queries to.";

     

       79
        
             };

     
···

       84
        
               description = "Use and update root trust anchor for DNSSEC validation.";

     

       85
        
             };

     

       86
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       87
        
             extraConfig = mkOption {

     

       88
        
               default = "";

     

       89
        
               type = types.lines;

     
···

       106
        
           users.users.unbound = {

     

       107
        
             description = "unbound daemon user";

     

       108
        
             isSystemUser = true;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       109
        
           };

     

       110
        
       

     

       111
        
           networking.resolvconf.useLocalResolver = mkDefault true;

     

       112
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       113
        
           systemd.services.unbound = {

     

       114
        
             description = "Unbound recursive Domain Name Server";

     

       115
        
             after = [ "network.target" ];

     

       116
        
             before = [ "nss-lookup.target" ];

     

       117
       -
             wants = [ "nss-lookup.target" ];

     

       118
       -
             wantedBy = [ "multi-user.target" ];

     

       119
        
       

     

       120
       -
             preStart = ''

     

       121
       -
               mkdir -m 0755 -p ${stateDir}/dev/

     

       122
       -
               cp ${confFile} ${stateDir}/unbound.conf

     

       123
       -
               ${optionalString cfg.enableRootTrustAnchor ''

     

       124
       -
                 ${cfg.package}/bin/unbound-anchor -a ${rootTrustAnchorFile} || echo "Root anchor updated!"

     

       125
       -
                 chown unbound ${stateDir} ${rootTrustAnchorFile}

     

       126
       -
               ''}

     

       127
       -
               touch ${stateDir}/dev/random

     

       128
       -
               ${pkgs.utillinux}/bin/mount --bind -n /dev/urandom ${stateDir}/dev/random

     

       129
        
             '';

     

       130
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       131
        
             serviceConfig = {

     

       132
       -
               ExecStart = "${cfg.package}/bin/unbound -d -c ${stateDir}/unbound.conf";

     

       133
       -
               ExecStopPost="${pkgs.utillinux}/bin/umount ${stateDir}/dev/random";

     

       134
        
       

     

       135
       -
               ProtectSystem = true;

     

       136
       -
               ProtectHome = true;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       137
        
               PrivateDevices = true;

     

       138
       -
               Restart = "always";

     

       139
       -
               RestartSec = "5s";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       140
        
             };

     

       141
        
           };

     

       142
       -
       

     

       143
        
           # If networkmanager is enabled, ask it to interface with unbound.

     

       144
        
           networking.networkmanager.dns = "unbound";

     

       145
       -
       

     

       146
        
         };

     

       147
       -
       

     

       148
        
       }

···

       1
        
       { config, lib, pkgs, ... }:

     

       2
        
       

     

       3
        
       with lib;

     

       0
        
       
     

       4
        
       let

     

       0
        
       
     

       5
        
         cfg = config.services.unbound;

     

       6
        
       

     

       7
        
         stateDir = "/var/lib/unbound";

     
···

       15
        
         forward =

     

       16
        
           optionalString (any isLocalAddress cfg.forwardAddresses) ''

     

       17
        
             do-not-query-localhost: no

     

       18
       +
           ''

     

       19
       +
           + optionalString (cfg.forwardAddresses != []) ''

     

       20
        
             forward-zone:

     

       21
        
               name: .

     

       22
       +
           ''

     

       23
       +
           + concatMapStringsSep "\n" (x: "    forward-addr: ${x}") cfg.forwardAddresses;

     

       24
        
       

     

       25
        
         rootTrustAnchorFile = "${stateDir}/root.key";

     

       26
        
       

     
···

       29
        
       

     

       30
        
         confFile = pkgs.writeText "unbound.conf" ''

     

       31
        
           server:

     

       32
       +
             ip-freebind: yes

     

       33
        
             directory: "${stateDir}"

     

       34
        
             username: unbound

     

       35
       +
             chroot: ""

     

       36
        
             pidfile: ""

     

       37
       +
             # when running under systemd there is no need to daemonize

     

       38
       +
             do-daemonize: no

     

       39
        
             ${interfaces}

     

       40
        
             ${access}

     

       41
        
             ${trustAnchor}

     

       42
       +
           ${lib.optionalString (cfg.localControlSocketPath != null) ''

     

       43
       +
             remote-control:

     

       44
       +
               control-enable: yes

     

       45
       +
               control-interface: ${cfg.localControlSocketPath}

     

       46
       +
           ''}

     

       47
        
           ${cfg.extraConfig}

     

       48
        
           ${forward}

     

       49
        
         '';

     

       0
        
       
     

       50
        
       in

     

       0
        
       
     

       51
        
       {

     

       52
        
       

     

       53
        
         ###### interface

     
···

       59
        
       

     

       60
        
             package = mkOption {

     

       61
        
               type = types.package;

     

       62
       +
               default = pkgs.unbound-with-systemd;

     

       63
       +
               defaultText = "pkgs.unbound-with-systemd";

     

       64
        
               description = "The unbound package to use";

     

       65
        
             };

     

       66
        
       

     
···

       73
        
             interfaces = mkOption {

     

       74
        
               default = [ "127.0.0.1" ] ++ optional config.networking.enableIPv6 "::1";

     

       75
        
               type = types.listOf types.str;

     

       76
       +
               description =  ''

     

       77
       +
                 What addresses the server should listen on. This supports the interface syntax documented in

     

       78
       +
                 <citerefentry><refentrytitle>unbound.conf</refentrytitle><manvolnum>8</manvolnum></citerefentry>.

     

       79
       +
               '';

     

       80
        
             };

     

       81
        
       

     

       82
        
             forwardAddresses = mkOption {

     

       83
       +
               default = [];

     

       84
        
               type = types.listOf types.str;

     

       85
        
               description = "What servers to forward queries to.";

     

       86
        
             };

     
···

       91
        
               description = "Use and update root trust anchor for DNSSEC validation.";

     

       92
        
             };

     

       93
        
       

     

       94
       +
             localControlSocketPath = mkOption {

     

       95
       +
               default = null;

     

       96
       +
               # FIXME: What is the proper type here so users can specify strings,

     

       97
       +
               # paths and null?

     

       98
       +
               # My guess would be `types.nullOr (types.either types.str types.path)`

     

       99
       +
               # but I haven't verified yet.

     

       100
       +
               type = types.nullOr types.str;

     

       101
       +
               example = "/run/unbound/unbound.ctl";

     

       102
       +
               description = ''

     

       103
       +
                 When not set to <literal>null</literal> this option defines the path

     

       104
       +
                 at which the unbound remote control socket should be created at. The

     

       105
       +
                 socket will be owned by the unbound user (<literal>unbound</literal>)

     

       106
       +
                 and group will be <literal>nogroup</literal>.

     

       107
       +
       

     

       108
       +
                 Users that should be permitted to access the socket must be in the

     

       109
       +
                 <literal>unbound</literal> group.

     

       110
       +
       

     

       111
       +
                 If this option is <literal>null</literal> remote control will not be

     

       112
       +
                 configured at all. Unbounds default values apply.

     

       113
       +
               '';

     

       114
       +
             };

     

       115
       +
       

     

       116
        
             extraConfig = mkOption {

     

       117
        
               default = "";

     

       118
        
               type = types.lines;

     
···

       135
        
           users.users.unbound = {

     

       136
        
             description = "unbound daemon user";

     

       137
        
             isSystemUser = true;

     

       138
       +
             group = lib.mkIf (cfg.localControlSocketPath != null) (lib.mkDefault "unbound");

     

       139
       +
           };

     

       140
       +
       

     

       141
       +
           # We need a group so that we can give users access to the configured

     

       142
       +
           # control socket. Unbound allows access to the socket only to the unbound

     

       143
       +
           # user and the primary group.

     

       144
       +
           users.groups = lib.mkIf (cfg.localControlSocketPath != null) {

     

       145
       +
             unbound = {};

     

       146
        
           };

     

       147
        
       

     

       148
        
           networking.resolvconf.useLocalResolver = mkDefault true;

     

       149
        
       

     

       150
       +
       

     

       151
       +
           environment.etc."unbound/unbound.conf".source = confFile;

     

       152
       +
       

     

       153
        
           systemd.services.unbound = {

     

       154
        
             description = "Unbound recursive Domain Name Server";

     

       155
        
             after = [ "network.target" ];

     

       156
        
             before = [ "nss-lookup.target" ];

     

       157
       +
             wantedBy = [ "multi-user.target" "nss-lookup.target" ];

     

       0
        
       
     

       158
        
       

     

       159
       +
             preStart = lib.mkIf cfg.enableRootTrustAnchor ''

     

       160
       +
               ${cfg.package}/bin/unbound-anchor -a ${rootTrustAnchorFile} || echo "Root anchor updated!"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       161
        
             '';

     

       162
        
       

     

       163
       +
             restartTriggers = [

     

       164
       +
               confFile

     

       165
       +
             ];

     

       166
       +
       

     

       167
        
             serviceConfig = {

     

       168
       +
               ExecStart = "${cfg.package}/bin/unbound -p -d -c /etc/unbound/unbound.conf";

     

       169
       +
               ExecReload = "+/run/current-system/sw/bin/kill -HUP $MAINPID";

     

       170
        
       

     

       171
       +
               NotifyAccess = "main";

     

       172
       +
               Type = "notify";

     

       173
       +
       

     

       174
       +
               # FIXME: Which of these do we actualy need, can we drop the chroot flag?

     

       175
       +
               AmbientCapabilities = [

     

       176
       +
                 "CAP_NET_BIND_SERVICE"

     

       177
       +
                 "CAP_NET_RAW"

     

       178
       +
                 "CAP_SETGID"

     

       179
       +
                 "CAP_SETUID"

     

       180
       +
                 "CAP_SYS_CHROOT"

     

       181
       +
                 "CAP_SYS_RESOURCE"

     

       182
       +
               ];

     

       183
       +
       

     

       184
       +
               User = "unbound";

     

       185
       +
               Group = lib.mkIf (cfg.localControlSocketPath != null) (lib.mkDefault "unbound");

     

       186
       +
       

     

       187
       +
               MemoryDenyWriteExecute = true;

     

       188
       +
               NoNewPrivileges = true;

     

       189
        
               PrivateDevices = true;

     

       190
       +
               PrivateTmp = true;

     

       191
       +
               ProtectHome = true;

     

       192
       +
               ProtectControlGroups = true;

     

       193
       +
               ProtectKernelModules = true;

     

       194
       +
               ProtectSystem = "strict";

     

       195
       +
               RuntimeDirectory = "unbound";

     

       196
       +
               ConfigurationDirectory = "unbound";

     

       197
       +
               StateDirectory = "unbound";

     

       198
       +
               RestrictAddressFamilies = [ "AF_INET" "AF_INET6" "AF_UNIX" ];

     

       199
       +
               RestrictRealtime = true;

     

       200
       +
               SystemCallArchitectures = "native";

     

       201
       +
               SystemCallFilter = [

     

       202
       +
                 "~@clock"

     

       203
       +
                 "@cpu-emulation"

     

       204
       +
                 "@debug"

     

       205
       +
                 "@keyring"

     

       206
       +
                 "@module"

     

       207
       +
                 "mount"

     

       208
       +
                 "@obsolete"

     

       209
       +
                 "@resources"

     

       210
       +
               ];

     

       211
       +
               RestrictNamespaces = true;

     

       212
       +
               LockPersonality = true;

     

       213
       +
               RestrictSUIDSGID = true;

     

       214
        
             };

     

       215
        
           };

     

       0
        
       
     

       216
        
           # If networkmanager is enabled, ask it to interface with unbound.

     

       217
        
           networking.networkmanager.dns = "unbound";

     

       0
        
       
     

       218
        
         };

     

       0
        
       
     

       219
        
       }

nixos/tests/all-tests.nix

···

       368
        
         trezord = handleTest ./trezord.nix {};

     

       369
        
         trickster = handleTest ./trickster.nix {};

     

       370
        
         tuptime = handleTest ./tuptime.nix {};

     

       0
        
       
     

       371
        
         udisks2 = handleTest ./udisks2.nix {};

     

       372
        
         unit-php = handleTest ./web-servers/unit-php.nix {};

     

       373
        
         upnp = handleTest ./upnp.nix {};

···

       368
        
         trezord = handleTest ./trezord.nix {};

     

       369
        
         trickster = handleTest ./trickster.nix {};

     

       370
        
         tuptime = handleTest ./tuptime.nix {};

     

       371
       +
         unbound = handleTest ./unbound.nix {};

     

       372
        
         udisks2 = handleTest ./udisks2.nix {};

     

       373
        
         unit-php = handleTest ./web-servers/unit-php.nix {};

     

       374
        
         upnp = handleTest ./upnp.nix {};

+278

nixos/tests/unbound.nix

···

       1
       +
       /*

     

       2
       +
        Test that our unbound module indeed works as most users would expect.

     

       3
       +
        There are a few settings that we must consider when modifying the test. The

     

       4
       +
        ususal use-cases for unbound are

     

       5
       +
          * running a recursive DNS resolver on the local machine

     

       6
       +
          * running a recursive DNS resolver on the local machine, forwarding to a local DNS server via UDP/53 & TCP/53

     

       7
       +
          * running a recursive DNS resolver on the local machine, forwarding to a local DNS server via TCP/853 (DoT)

     

       8
       +
          * running a recursive DNS resolver on a machine in the network awaiting input from clients over TCP/53 & UDP/53

     

       9
       +
          * running a recursive DNS resolver on a machine in the network awaiting input from clients over TCP/853 (DoT)

     

       10
       +
       

     

       11
       +
        In the below test setup we are trying to implement all of those use cases.

     

       12
       +
       

     

       13
       +
        Another aspect that we cover is access to the local control UNIX socket. It

     

       14
       +
        can optionally be enabled and users can optionally be in a group to gain

     

       15
       +
        access. Users that are not in the group (except for root) should not have

     

       16
       +
        access to that socket. Also, when there is no socket configured, users

     

       17
       +
        shouldn't be able to access the control socket at all. Not even root.

     

       18
       +
       */

     

       19
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }:

     

       20
       +
         let

     

       21
       +
           # common client configuration that we can just use for the multitude of

     

       22
       +
           # clients we are constructing

     

       23
       +
           common = { lib, pkgs, ... }: {

     

       24
       +
             config = {

     

       25
       +
               environment.systemPackages = [ pkgs.knot-dns ];

     

       26
       +
       

     

       27
       +
               # disable the root anchor update as we do not have internet access during

     

       28
       +
               # the test execution

     

       29
       +
               services.unbound.enableRootTrustAnchor = false;

     

       30
       +
             };

     

       31
       +
           };

     

       32
       +
       

     

       33
       +
           cert = pkgs.runCommandNoCC "selfSignedCerts" { buildInputs = [ pkgs.openssl ]; } ''

     

       34
       +
             openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -nodes -subj '/CN=dns.example.local'

     

       35
       +
             mkdir -p $out

     

       36
       +
             cp key.pem cert.pem $out

     

       37
       +
           '';

     

       38
       +
         in

     

       39
       +
         {

     

       40
       +
           name = "unbound";

     

       41
       +
           meta = with pkgs.stdenv.lib.maintainers; {

     

       42
       +
             maintainers = [ andir ];

     

       43
       +
           };

     

       44
       +
       

     

       45
       +
           nodes = {

     

       46
       +
       

     

       47
       +
             # The server that actually serves our zones, this tests unbounds authoriative mode

     

       48
       +
             authoritative = { lib, pkgs, config, ... }: {

     

       49
       +
               imports = [ common ];

     

       50
       +
               networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       51
       +
                 { address = "192.168.0.1"; prefixLength = 24; }

     

       52
       +
               ];

     

       53
       +
               networking.interfaces.eth1.ipv6.addresses = lib.mkForce [

     

       54
       +
                 { address = "fd21::1"; prefixLength = 64; }

     

       55
       +
               ];

     

       56
       +
               networking.firewall.allowedTCPPorts = [ 53 ];

     

       57
       +
               networking.firewall.allowedUDPPorts = [ 53 ];

     

       58
       +
       

     

       59
       +
               services.unbound = {

     

       60
       +
                 enable = true;

     

       61
       +
                 interfaces = [ "192.168.0.1" "fd21::1" "::1" "127.0.0.1" ];

     

       62
       +
                 allowedAccess = [ "192.168.0.0/24" "fd21::/64" "::1" "127.0.0.0/8" ];

     

       63
       +
                 extraConfig = ''

     

       64
       +
                   server:

     

       65
       +
                     local-data: "example.local. IN A 1.2.3.4"

     

       66
       +
                     local-data: "example.local. IN AAAA abcd::eeff"

     

       67
       +
                 '';

     

       68
       +
               };

     

       69
       +
             };

     

       70
       +
       

     

       71
       +
             # The resolver that knows that fowards (only) to the authoritative server

     

       72
       +
             # and listens on UDP/53, TCP/53 & TCP/853.

     

       73
       +
             resolver = { lib, nodes, ... }: {

     

       74
       +
               imports = [ common ];

     

       75
       +
               networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       76
       +
                 { address = "192.168.0.2"; prefixLength = 24; }

     

       77
       +
               ];

     

       78
       +
               networking.interfaces.eth1.ipv6.addresses = lib.mkForce [

     

       79
       +
                 { address = "fd21::2"; prefixLength = 64; }

     

       80
       +
               ];

     

       81
       +
               networking.firewall.allowedTCPPorts = [

     

       82
       +
                 53 # regular DNS

     

       83
       +
                 853 # DNS over TLS

     

       84
       +
               ];

     

       85
       +
               networking.firewall.allowedUDPPorts = [ 53 ];

     

       86
       +
       

     

       87
       +
               services.unbound = {

     

       88
       +
                 enable = true;

     

       89
       +
                 allowedAccess = [ "192.168.0.0/24" "fd21::/64" "::1" "127.0.0.0/8" ];

     

       90
       +
                 interfaces = [ "::1" "127.0.0.1" "192.168.0.2" "fd21::2" "192.168.0.2@853" "fd21::2@853" "::1@853" "127.0.0.1@853" ];

     

       91
       +
                 forwardAddresses = [

     

       92
       +
                   (lib.head nodes.authoritative.config.networking.interfaces.eth1.ipv6.addresses).address

     

       93
       +
                   (lib.head nodes.authoritative.config.networking.interfaces.eth1.ipv4.addresses).address

     

       94
       +
                 ];

     

       95
       +
                 extraConfig = ''

     

       96
       +
                   server:

     

       97
       +
                     tls-service-pem: ${cert}/cert.pem

     

       98
       +
                     tls-service-key: ${cert}/key.pem

     

       99
       +
                 '';

     

       100
       +
               };

     

       101
       +
             };

     

       102
       +
       

     

       103
       +
             # machine that runs a local unbound that will be reconfigured during test execution

     

       104
       +
             local_resolver = { lib, nodes, config, ... }: {

     

       105
       +
               imports = [ common ];

     

       106
       +
               networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       107
       +
                 { address = "192.168.0.3"; prefixLength = 24; }

     

       108
       +
               ];

     

       109
       +
               networking.interfaces.eth1.ipv6.addresses = lib.mkForce [

     

       110
       +
                 { address = "fd21::3"; prefixLength = 64; }

     

       111
       +
               ];

     

       112
       +
               networking.firewall.allowedTCPPorts = [

     

       113
       +
                 53 # regular DNS

     

       114
       +
               ];

     

       115
       +
               networking.firewall.allowedUDPPorts = [ 53 ];

     

       116
       +
       

     

       117
       +
               services.unbound = {

     

       118
       +
                 enable = true;

     

       119
       +
                 allowedAccess = [ "::1" "127.0.0.0/8" ];

     

       120
       +
                 interfaces = [ "::1" "127.0.0.1" ];

     

       121
       +
                 localControlSocketPath = "/run/unbound/unbound.ctl";

     

       122
       +
                 extraConfig = ''

     

       123
       +
                   include: "/etc/unbound/extra*.conf"

     

       124
       +
                 '';

     

       125
       +
               };

     

       126
       +
       

     

       127
       +
               users.users = {

     

       128
       +
                 # user that is permitted to access the unix socket

     

       129
       +
                 someuser.extraGroups = [

     

       130
       +
                   config.users.users.unbound.group

     

       131
       +
                 ];

     

       132
       +
       

     

       133
       +
                 # user that is not permitted to access the unix socket

     

       134
       +
                 unauthorizeduser = {};

     

       135
       +
               };

     

       136
       +
       

     

       137
       +
               environment.etc = {

     

       138
       +
                 "unbound-extra1.conf".text = ''

     

       139
       +
                   forward-zone:

     

       140
       +
                     name: "example.local."

     

       141
       +
                     forward-addr: ${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv6.addresses).address}

     

       142
       +
                     forward-addr: ${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv4.addresses).address}

     

       143
       +
                 '';

     

       144
       +
                 "unbound-extra2.conf".text = ''

     

       145
       +
                   auth-zone:

     

       146
       +
                     name: something.local.

     

       147
       +
                     zonefile: ${pkgs.writeText "zone" ''

     

       148
       +
                       something.local. IN A 3.4.5.6

     

       149
       +
                     ''}

     

       150
       +
                 '';

     

       151
       +
               };

     

       152
       +
             };

     

       153
       +
       

     

       154
       +
       

     

       155
       +
             # plain node that only has network access and doesn't run any part of the

     

       156
       +
             # resolver software locally

     

       157
       +
             client = { lib, nodes, ... }: {

     

       158
       +
               imports = [ common ];

     

       159
       +
               networking.nameservers = [

     

       160
       +
                 (lib.head nodes.resolver.config.networking.interfaces.eth1.ipv6.addresses).address

     

       161
       +
                 (lib.head nodes.resolver.config.networking.interfaces.eth1.ipv4.addresses).address

     

       162
       +
               ];

     

       163
       +
               networking.interfaces.eth1.ipv4.addresses = [

     

       164
       +
                 { address = "192.168.0.10"; prefixLength = 24; }

     

       165
       +
               ];

     

       166
       +
               networking.interfaces.eth1.ipv6.addresses = [

     

       167
       +
                 { address = "fd21::10"; prefixLength = 64; }

     

       168
       +
               ];

     

       169
       +
             };

     

       170
       +
           };

     

       171
       +
       

     

       172
       +
           testScript = { nodes, ... }: ''

     

       173
       +
             import typing

     

       174
       +
             import json

     

       175
       +
       

     

       176
       +
             zone = "example.local."

     

       177
       +
             records = [("AAAA", "abcd::eeff"), ("A", "1.2.3.4")]

     

       178
       +
       

     

       179
       +
       

     

       180
       +
             def query(

     

       181
       +
                 machine,

     

       182
       +
                 host: str,

     

       183
       +
                 query_type: str,

     

       184
       +
                 query: str,

     

       185
       +
                 expected: typing.Optional[str] = None,

     

       186
       +
                 args: typing.Optional[typing.List[str]] = None,

     

       187
       +
             ):

     

       188
       +
                 """

     

       189
       +
                 Execute a single query and compare the result with expectation

     

       190
       +
                 """

     

       191
       +
                 text_args = ""

     

       192
       +
                 if args:

     

       193
       +
                     text_args = " ".join(args)

     

       194
       +
       

     

       195
       +
                 out = machine.succeed(

     

       196
       +
                     f"kdig {text_args} {query} {query_type} @{host} +short"

     

       197
       +
                 ).strip()

     

       198
       +
                 machine.log(f"{host} replied with {out}")

     

       199
       +
                 if expected:

     

       200
       +
                     assert expected == out, f"Expected `{expected}` but got `{out}`"

     

       201
       +
       

     

       202
       +
       

     

       203
       +
             def test(machine, remotes, /, doh=False, zone=zone, records=records, args=[]):

     

       204
       +
                 """

     

       205
       +
                 Run queries for the given remotes on the given machine.

     

       206
       +
                 """

     

       207
       +
                 for query_type, expected in records:

     

       208
       +
                     for remote in remotes:

     

       209
       +
                         query(machine, remote, query_type, zone, expected, args)

     

       210
       +
                         query(machine, remote, query_type, zone, expected, ["+tcp"] + args)

     

       211
       +
                         if doh:

     

       212
       +
                             query(

     

       213
       +
                                 machine,

     

       214
       +
                                 remote,

     

       215
       +
                                 query_type,

     

       216
       +
                                 zone,

     

       217
       +
                                 expected,

     

       218
       +
                                 ["+tcp", "+tls"] + args,

     

       219
       +
                             )

     

       220
       +
       

     

       221
       +
       

     

       222
       +
             client.start()

     

       223
       +
             authoritative.wait_for_unit("unbound.service")

     

       224
       +
       

     

       225
       +
             # verify that we can resolve locally

     

       226
       +
             with subtest("test the authoritative servers local responses"):

     

       227
       +
                 test(authoritative, ["::1", "127.0.0.1"])

     

       228
       +
       

     

       229
       +
             resolver.wait_for_unit("unbound.service")

     

       230
       +
       

     

       231
       +
             with subtest("root is unable to use unbounc-control when the socket is not configured"):

     

       232
       +
                 resolver.succeed("which unbound-control")  # the binary must exist

     

       233
       +
                 resolver.fail("unbound-control list_forwards")  # the invocation must fail

     

       234
       +
       

     

       235
       +
             # verify that the resolver is able to resolve on all the local protocols

     

       236
       +
             with subtest("test that the resolver resolves on all protocols and transports"):

     

       237
       +
                 test(resolver, ["::1", "127.0.0.1"], doh=True)

     

       238
       +
       

     

       239
       +
             resolver.wait_for_unit("multi-user.target")

     

       240
       +
       

     

       241
       +
             with subtest("client should be able to query the resolver"):

     

       242
       +
                 test(client, ["${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv6.addresses).address}", "${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv4.addresses).address}"], doh=True)

     

       243
       +
       

     

       244
       +
             # discard the client we do not need anymore

     

       245
       +
             client.shutdown()

     

       246
       +
       

     

       247
       +
             local_resolver.wait_for_unit("multi-user.target")

     

       248
       +
       

     

       249
       +
             # link a new config file to /etc/unbound/extra.conf

     

       250
       +
             local_resolver.succeed("ln -s /etc/unbound-extra1.conf /etc/unbound/extra1.conf")

     

       251
       +
       

     

       252
       +
             # reload the server & ensure the forwarding works

     

       253
       +
             with subtest("test that the local resolver resolves on all protocols and transports"):

     

       254
       +
                 local_resolver.succeed("systemctl reload unbound")

     

       255
       +
                 print(local_resolver.succeed("journalctl -u unbound -n 1000"))

     

       256
       +
                 test(local_resolver, ["::1", "127.0.0.1"], args=["+timeout=60"])

     

       257
       +
       

     

       258
       +
             with subtest("test that we can use the unbound control socket"):

     

       259
       +
                 out = local_resolver.succeed(

     

       260
       +
                     "sudo -u someuser -- unbound-control list_forwards"

     

       261
       +
                 ).strip()

     

       262
       +
       

     

       263
       +
                 # Thank you black! Can't really break this line into a readable version.

     

       264
       +
                 expected = "example.local. IN forward ${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv6.addresses).address} ${(lib.head nodes.resolver.config.networking.interfaces.eth1.ipv4.addresses).address}"

     

       265
       +
                 assert out == expected, f"Expected `{expected}` but got `{out}` instead."

     

       266
       +
                 local_resolver.fail("sudo -u unauthorizeduser -- unbound-control list_forwards")

     

       267
       +
       

     

       268
       +
       

     

       269
       +
             # link a new config file to /etc/unbound/extra.conf

     

       270
       +
             local_resolver.succeed("ln -sf /etc/unbound-extra2.conf /etc/unbound/extra2.conf")

     

       271
       +
       

     

       272
       +
             # reload the server & ensure the new local zone works

     

       273
       +
             with subtest("test that we can query the new local zone"):

     

       274
       +
                 local_resolver.succeed("unbound-control reload")

     

       275
       +
                 r = [("A", "3.4.5.6")]

     

       276
       +
                 test(local_resolver, ["::1", "127.0.0.1"], zone="something.local.", records=r)

     

       277
       +
           '';

     

       278
       +
         })

+31 -9

pkgs/tools/networking/unbound/default.nix

···

       1
       -
       { stdenv, fetchurl, openssl, nettle, expat, libevent, dns-root-data }:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       2
        
       

     

       3
        
       stdenv.mkDerivation rec {

     

       4
        
         pname = "unbound";

     
···

       11
        
       

     

       12
        
         outputs = [ "out" "lib" "man" ]; # "dev" would only split ~20 kB

     

       13
        
       

     

       14
       -
         buildInputs = [ openssl nettle expat libevent ];

     

       15
        
       

     

       16
        
         configureFlags = [

     

       17
        
           "--with-ssl=${openssl.dev}"

     
···

       25
        
           "--enable-relro-now"

     

       26
        
         ] ++ stdenv.lib.optional stdenv.hostPlatform.isStatic [

     

       27
        
           "--disable-flto"

     

       0
        
       
     

       0
        
       
     

       28
        
         ];

     

       29
        
       

     

       30
        
         installFlags = [ "configfile=\${out}/etc/unbound/unbound.conf" ];

     
···

       33
        
           make unbound-event-install

     

       34
        
         '';

     

       35
        
       

     

       36
       -
         preFixup = stdenv.lib.optionalString (stdenv.isLinux && !stdenv.hostPlatform.isMusl) # XXX: revisit

     

       37
        
           # Build libunbound again, but only against nettle instead of openssl.

     

       38
        
           # This avoids gnutls.out -> unbound.lib -> openssl.out.

     

       39
        
           # There was some problem with this on Darwin; let's not complicate non-Linux.

     
···

       43
        
             buildPhase

     

       44
        
             installPhase

     

       45
        
           ''

     

       46
       -
           # get rid of runtime dependencies on $dev outputs

     

       47
        
         + ''substituteInPlace "$lib/lib/libunbound.la" ''

     

       48
       -
           + stdenv.lib.concatMapStrings

     

       49
       -
             (pkg: " --replace '-L${pkg.dev}/lib' '-L${pkg.out}/lib' --replace '-R${pkg.dev}/lib' '-R${pkg.out}/lib'")

     

       50
       -
             buildInputs;

     

       51
        
       

     

       52
       -
         meta = with stdenv.lib; {

     

       53
        
           description = "Validating, recursive, and caching DNS resolver";

     

       54
        
           license = licenses.bsd3;

     

       55
        
           homepage = "https://www.unbound.net";

     

       56
        
           maintainers = with maintainers; [ ehmry fpletz globin ];

     

       57
       -
           platforms = stdenv.lib.platforms.unix;

     

       58
        
         };

     

       59
        
       }

···

       1
       +
       { stdenv

     

       2
       +
       , lib

     

       3
       +
       , fetchurl

     

       4
       +
       , openssl

     

       5
       +
       , nettle

     

       6
       +
       , expat

     

       7
       +
       , libevent

     

       8
       +
       , dns-root-data

     

       9
       +
       , pkg-config

     

       10
       +
         #

     

       11
       +
         # By default unbound will not be built with systemd support. Unbound is a very

     

       12
       +
         # commmon dependency. The transitive dependency closure of systemd also

     

       13
       +
         # contains unbound.

     

       14
       +
         # Since most (all?) (lib)unbound users outside of the unbound daemon usage do

     

       15
       +
         # not need the systemd integration it is likely best to just default to no

     

       16
       +
         # systemd integration.

     

       17
       +
         # For the daemon use-case, that needs to notify systemd, use `unbound-with-systemd`.

     

       18
       +
         #

     

       19
       +
       , withSystemd ? false

     

       20
       +
       , systemd ? null

     

       21
       +
       }:

     

       22
        
       

     

       23
        
       stdenv.mkDerivation rec {

     

       24
        
         pname = "unbound";

     
···

       31
        
       

     

       32
        
         outputs = [ "out" "lib" "man" ]; # "dev" would only split ~20 kB

     

       33
        
       

     

       34
       +
         buildInputs = [ openssl nettle expat libevent ] ++ lib.optionals withSystemd [ pkg-config systemd ];

     

       35
        
       

     

       36
        
         configureFlags = [

     

       37
        
           "--with-ssl=${openssl.dev}"

     
···

       45
        
           "--enable-relro-now"

     

       46
        
         ] ++ stdenv.lib.optional stdenv.hostPlatform.isStatic [

     

       47
        
           "--disable-flto"

     

       48
       +
         ] ++ lib.optionals withSystemd [

     

       49
       +
           "--enable-systemd"

     

       50
        
         ];

     

       51
        
       

     

       52
        
         installFlags = [ "configfile=\${out}/etc/unbound/unbound.conf" ];

     
···

       55
        
           make unbound-event-install

     

       56
        
         '';

     

       57
        
       

     

       58
       +
         preFixup = lib.optionalString (stdenv.isLinux && !stdenv.hostPlatform.isMusl) # XXX: revisit

     

       59
        
           # Build libunbound again, but only against nettle instead of openssl.

     

       60
        
           # This avoids gnutls.out -> unbound.lib -> openssl.out.

     

       61
        
           # There was some problem with this on Darwin; let's not complicate non-Linux.

     
···

       65
        
             buildPhase

     

       66
        
             installPhase

     

       67
        
           ''

     

       68
       +
         # get rid of runtime dependencies on $dev outputs

     

       69
        
         + ''substituteInPlace "$lib/lib/libunbound.la" ''

     

       70
       +
         + lib.concatMapStrings

     

       71
       +
           (pkg: lib.optionalString (pkg ? dev) " --replace '-L${pkg.dev}/lib' '-L${pkg.out}/lib' --replace '-R${pkg.dev}/lib' '-R${pkg.out}/lib'")

     

       72
       +
           (builtins.filter (p: p != null) buildInputs);

     

       73
        
       

     

       74
       +
         meta = with lib; {

     

       75
        
           description = "Validating, recursive, and caching DNS resolver";

     

       76
        
           license = licenses.bsd3;

     

       77
        
           homepage = "https://www.unbound.net";

     

       78
        
           maintainers = with maintainers; [ ehmry fpletz globin ];

     

       79
       +
           platforms = platforms.unix;

     

       80
        
         };

     

       81
        
       }

+5 -1

pkgs/top-level/all-packages.nix

···

       8097
        
       

     

       8098
        
         unclutter-xfixes = callPackage ../tools/misc/unclutter-xfixes { };

     

       8099
        
       

     

       8100
       -
         unbound = callPackage ../tools/networking/unbound { };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       8101
        
       

     

       8102
        
         unicorn = callPackage ../development/libraries/unicorn { };

     

       8103

···

       8097
        
       

     

       8098
        
         unclutter-xfixes = callPackage ../tools/misc/unclutter-xfixes { };

     

       8099
        
       

     

       8100
       +
         unbound = callPackage ../tools/networking/unbound {};

     

       8101
       +
       

     

       8102
       +
         unbound-with-systemd = unbound.override {

     

       8103
       +
           withSystemd = true;

     

       8104
       +
         };

     

       8105
        
       

     

       8106
        
         unicorn = callPackage ../development/libraries/unicorn { };

     

       8107