Skip to content

Commit

Permalink
hickory-dns: rename from trust-dns
Browse files Browse the repository at this point in the history
  • Loading branch information
uninsane committed Jun 30, 2024
1 parent 338d49d commit f20e1fa
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 22 deletions.
2 changes: 1 addition & 1 deletion nixos/doc/manual/release-notes/rl-2311.section.md
Original file line number Diff line number Diff line change
Expand Up @@ -1017,7 +1017,7 @@ Make sure to also check the many updates in the [Nixpkgs library](#sec-release-2
- [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](options.html#opt-services.trust-dns.enable).
- [osquery](https://www.osquery.io/), a SQL powered operating system
instrumentation, monitoring, and analytics. Available as
Expand Down
2 changes: 1 addition & 1 deletion nixos/modules/module-list.nix
Original file line number Diff line number Diff line change
Expand Up @@ -1029,6 +1029,7 @@
./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
Expand Down Expand Up @@ -1214,7 +1215,6 @@
./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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{ 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
);

Expand All @@ -26,7 +26,7 @@ let
- "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>
'';
};
Expand All @@ -45,10 +45,19 @@ let
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.
Expand All @@ -75,9 +84,9 @@ in
};
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;
Expand Down Expand Up @@ -106,9 +115,9 @@ in
};
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.
'';
};
Expand All @@ -124,23 +133,23 @@ in
};

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" ];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
}:

rustPlatform.buildRustPackage rec {
pname = "trust-dns";
pname = "hickory-dns";
version = "0.24.1";

src = fetchFromGitHub {
Expand All @@ -15,7 +15,7 @@ rustPlatform.buildRustPackage rec {
rev = "v${version}";
hash = "sha256-szq21RuRmkhAfHlzhGQYpwjiIRkavFCPETOt+6TxhP4=";
};
cargoHash = "sha256-zGn5vHwsHgpkgOr30QiyScqnfXjH55LQIVtxoUUox64=";
cargoHash = "sha256-LcMjHHEuDlhSfDXGIrSMXewraSxEgRw2g2DOoH4i5RU=";

buildInputs = [ openssl ];
nativeBuildInputs = [ pkg-config ];
Expand All @@ -25,7 +25,7 @@ rustPlatform.buildRustPackage rec {

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 ];
Expand Down
1 change: 1 addition & 0 deletions pkgs/top-level/aliases.nix
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,7 @@ mapAliases ({
transfig = fig2dev; # Added 2022-02-15
transifex-client = transifex-cli; # Added 2023-12-29
trezor_agent = trezor-agent; # Added 2024-01-07
trust-dns = hickory-dns; # Added 2024-06-30
trustedGrub = throw "trustedGrub has been removed, because it is not maintained upstream anymore"; # Added 2023-05-10
trustedGrub-for-HP = throw "trustedGrub-for-HP has been removed, because it is not maintained upstream anymore"; # Added 2023-05-10
tvbrowser-bin = tvbrowser; # Added 2023-03-02
Expand Down
2 changes: 0 additions & 2 deletions pkgs/top-level/all-packages.nix
Original file line number Diff line number Diff line change
Expand Up @@ -27820,8 +27820,6 @@ with pkgs;
inherit (darwin.apple_sdk.frameworks) Security;
};

trust-dns = callPackage ../servers/dns/trust-dns { };

trustymail = callPackage ../tools/security/trustymail { };

tunctl = callPackage ../os-specific/linux/tunctl { };
Expand Down

0 comments on commit f20e1fa

Please sign in to comment.