Merge pull request #316466 from uninsane/rebrand-trust-dns

- [trust-dns](https://trust-dns.org/), a Rust based DNS server built to be safe

  and secure from the ground up. Available as

  [services.trust-dns](#opt-services.trust-dns.enable).

  `services.trust-dns`.

- [osquery](https://www.osquery.io/), a SQL powered operating system

  instrumentation, monitoring, and analytics. Available as

- The `xdg.portal.gtkUsePortal` option has been removed, as it had been deprecated for over 2 years. Using the `GTK_USE_PORTAL` environment variable in this manner is not intended nor encouraged by the GTK developers, but can still be done manually via `environment.sessionVariables`.

- The `services.trust-dns` module has been renamed to `services.hickory-dns`.

## Other Notable Changes {#sec-release-24.11-notable-changes}

<!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

  ./services/networking/harmonia.nix

  ./services/networking/haproxy.nix

  ./services/networking/headscale.nix

  ./services/networking/hickory-dns.nix

  ./services/networking/hostapd.nix

  ./services/networking/htpdate.nix

  ./services/networking/https-dns-proxy.nix

  ./services/networking/tox-node.nix

  ./services/networking/toxvpn.nix

  ./services/networking/trickster.nix

  ./services/networking/trust-dns.nix

  ./services/networking/tvheadend.nix

  ./services/networking/twingate.nix

  ./services/networking/ucarp.nix

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

let

  cfg = config.services.trust-dns;

  cfg = config.services.hickory-dns;

  toml = pkgs.formats.toml { };

  configFile = toml.generate "trust-dns.toml" (

  configFile = toml.generate "hickory-dns.toml" (

    lib.filterAttrsRecursive (_: v: v != null) cfg.settings

  );

          - "Forward" (a cached zone where all requests are forwarded to another resolver).

          For more details about these zone types, consult the documentation for BIND,

          though note that trust-dns supports only a subset of BIND's zone types:

          though note that hickory-dns supports only a subset of BIND's zone types:

          <https://bind9.readthedocs.io/en/v9_18_4/reference.html#type>

        '';

      };

in

{

  meta.maintainers = with lib.maintainers; [ colinsane ];

  imports = with lib; [

    (mkRenamedOptionModule [ "services" "trust-dns" "enable" ] [ "services" "hickory-dns" "enable" ])

    (mkRenamedOptionModule [ "services" "trust-dns" "package" ] [ "services" "hickory-dns" "package" ])

    (mkRenamedOptionModule [ "services" "trust-dns" "settings" ] [ "services" "hickory-dns" "settings" ])

    (mkRenamedOptionModule [ "services" "trust-dns" "quiet" ] [ "services" "hickory-dns" "quiet" ])

    (mkRenamedOptionModule [ "services" "trust-dns" "debug" ] [ "services" "hickory-dns" "debug" ])

  ];

  options = {

    services.trust-dns = with lib; {

      enable = mkEnableOption "trust-dns";

      package = mkPackageOption pkgs "trust-dns" {

    services.hickory-dns = with lib; {

      enable = mkEnableOption "hickory-dns";

      package = mkPackageOption pkgs "hickory-dns" {

        extraDescription = ''

          ::: {.note}

          The package must provide `meta.mainProgram` which names the server binary; any other utilities (client, resolver) are not needed.

      };

      settings = mkOption {

        description = ''

          Settings for trust-dns. The options enumerated here are not exhaustive.

          Settings for hickory-dns. The options enumerated here are not exhaustive.

          Refer to upstream documentation for all available options:

          - [Example settings](https://github.com/bluejekyll/trust-dns/blob/main/tests/test-data/test_configs/example.toml)

          - [Example settings](https://github.com/hickory-dns/hickory-dns/blob/main/tests/test-data/test_configs/example.toml)

        '';

        type = types.submodule {

          freeformType = toml.type;

            };

            directory = mkOption {

              type = types.str;

              default = "/var/lib/trust-dns";

              default = "/var/lib/hickory-dns";

              description = ''

                The directory in which trust-dns should look for .zone files,

                The directory in which hickory-dns should look for .zone files,

                whenever zones aren't specified by absolute path.

              '';

            };

  };

  config = lib.mkIf cfg.enable {

    systemd.services.trust-dns = {

      description = "trust-dns Domain Name Server";

      unitConfig.Documentation = "https://trust-dns.org/";

    systemd.services.hickory-dns = {

      description = "hickory-dns Domain Name Server";

      unitConfig.Documentation = "https://hickory-dns.org/";

      serviceConfig = {

        ExecStart =

        let

          flags =  (lib.optional cfg.debug "--debug") ++ (lib.optional cfg.quiet "--quiet");

          flagsStr = builtins.concatStringsSep " " flags;

        in ''

          ${cfg.package}/bin/${cfg.package.meta.mainProgram} --config ${configFile} ${flagsStr}

          ${lib.getExe cfg.package} --config ${configFile} ${flagsStr}

        '';

        Type = "simple";

        Restart = "on-failure";

        RestartSec = "10s";

        DynamicUser = true;

        StateDirectory = "trust-dns";

        StateDirectory = "hickory-dns";

        ReadWritePaths = [ cfg.settings.directory ];

        AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ];

}:

rustPlatform.buildRustPackage rec {

  pname = "trust-dns";

  pname = "hickory-dns";

  version = "0.24.1";

  src = fetchFromGitHub {

    rev = "v${version}";

    hash = "sha256-szq21RuRmkhAfHlzhGQYpwjiIRkavFCPETOt+6TxhP4=";

  };

  cargoHash = "sha256-zGn5vHwsHgpkgOr30QiyScqnfXjH55LQIVtxoUUox64=";

  cargoHash = "sha256-LcMjHHEuDlhSfDXGIrSMXewraSxEgRw2g2DOoH4i5RU=";

  buildInputs = [ openssl ];

  nativeBuildInputs = [ pkg-config ];

  meta = with lib; {

    description = "Rust based DNS client, server, and resolver";

    homepage = "https://trust-dns.org/";

    homepage = "https://hickory-dns.org/";

    maintainers = with maintainers; [ colinsane ];

    platforms = platforms.linux;

    license = with licenses; [ asl20 mit ];