mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-05 05:13:04 +00:00
ab5dcc7068
This can be used for options to tweak the behavior around the database.
145 lines
4.6 KiB
Nix
145 lines
4.6 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.sks;
|
|
sksPkg = cfg.package;
|
|
dbConfig = pkgs.writeText "DB_CONFIG" ''
|
|
${cfg.extraDbConfig}
|
|
'';
|
|
|
|
in {
|
|
meta.maintainers = with maintainers; [ primeos calbrecht jcumming ];
|
|
|
|
options = {
|
|
|
|
services.sks = {
|
|
|
|
enable = mkEnableOption ''
|
|
SKS (synchronizing key server for OpenPGP) and start the database
|
|
server. You need to create "''${dataDir}/dump/*.gpg" for the initial
|
|
import'';
|
|
|
|
package = mkOption {
|
|
default = pkgs.sks;
|
|
defaultText = "pkgs.sks";
|
|
type = types.package;
|
|
description = "Which SKS derivation to use.";
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.path;
|
|
default = "/var/db/sks";
|
|
example = "/var/lib/sks";
|
|
# TODO: The default might change to "/var/lib/sks" as this is more
|
|
# common. There's also https://github.com/NixOS/nixpkgs/issues/26256
|
|
# and "/var/db" is not FHS compliant (seems to come from BSD).
|
|
description = ''
|
|
Data directory (-basedir) for SKS, where the database and all
|
|
configuration files are located (e.g. KDB, PTree, membership and
|
|
sksconf).
|
|
'';
|
|
};
|
|
|
|
extraDbConfig = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
description = ''
|
|
Set contents of the files "KDB/DB_CONFIG" and "PTree/DB_CONFIG" within
|
|
the ''${dataDir} directory. This is used to configure options for the
|
|
database for the sks key server.
|
|
|
|
Documentation of available options are available in the file named
|
|
"sampleConfig/DB_CONFIG" in the following repository:
|
|
https://bitbucket.org/skskeyserver/sks-keyserver/src
|
|
'';
|
|
};
|
|
|
|
hkpAddress = mkOption {
|
|
default = [ "127.0.0.1" "::1" ];
|
|
type = types.listOf types.str;
|
|
description = ''
|
|
Domain names, IPv4 and/or IPv6 addresses to listen on for HKP
|
|
requests.
|
|
'';
|
|
};
|
|
|
|
hkpPort = mkOption {
|
|
default = 11371;
|
|
type = types.ints.u16;
|
|
description = "HKP port to listen on.";
|
|
};
|
|
|
|
webroot = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = "${sksPkg.webSamples}/OpenPKG";
|
|
defaultText = "\${pkgs.sks.webSamples}/OpenPKG";
|
|
description = ''
|
|
Source directory (will be symlinked, if not null) for the files the
|
|
built-in webserver should serve. SKS (''${pkgs.sks.webSamples})
|
|
provides the following examples: "HTML5", "OpenPKG", and "XHTML+ES".
|
|
The index file can be named index.html, index.htm, index.xhtm, or
|
|
index.xhtml. Files with the extensions .css, .es, .js, .jpg, .jpeg,
|
|
.png, or .gif are supported. Subdirectories and filenames with
|
|
anything other than alphanumeric characters and the '.' character
|
|
will be ignored.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
users = {
|
|
users.sks = {
|
|
isSystemUser = true;
|
|
description = "SKS user";
|
|
home = cfg.dataDir;
|
|
createHome = true;
|
|
group = "sks";
|
|
useDefaultShell = true;
|
|
packages = [ sksPkg pkgs.db ];
|
|
};
|
|
groups.sks = { };
|
|
};
|
|
|
|
systemd.services = let
|
|
hkpAddress = "'" + (builtins.concatStringsSep " " cfg.hkpAddress) + "'" ;
|
|
hkpPort = builtins.toString cfg.hkpPort;
|
|
in {
|
|
"sks-db" = {
|
|
description = "SKS database server";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
preStart = ''
|
|
${lib.optionalString (cfg.webroot != null)
|
|
"ln -sfT \"${cfg.webroot}\" web"}
|
|
mkdir -p dump
|
|
# Check that both database configs are symlinks before overwriting them
|
|
if [ -e KDB/DB_CONFIG ] && [ ! -L KBD/DB_CONFIG ]; then
|
|
echo "KDB/DB_CONFIG exists but is not a symlink." >&2
|
|
exit 1
|
|
fi
|
|
if [ -e PTree/DB_CONFIG ] && [ ! -L PTree/DB_CONFIG ]; then
|
|
echo "PTree/DB_CONFIG exists but is not a symlink." >&2
|
|
exit 1
|
|
fi
|
|
ln -sf ${dbConfig} KDB/DB_CONFIG
|
|
ln -sf ${dbConfig} PTree/DB_CONFIG
|
|
${sksPkg}/bin/sks build dump/*.gpg -n 10 -cache 100 || true #*/
|
|
${sksPkg}/bin/sks cleandb || true
|
|
${sksPkg}/bin/sks pbuild -cache 20 -ptree_cache 70 || true
|
|
'';
|
|
serviceConfig = {
|
|
WorkingDirectory = "~";
|
|
User = "sks";
|
|
Group = "sks";
|
|
Restart = "always";
|
|
ExecStart = "${sksPkg}/bin/sks db -hkp_address ${hkpAddress} -hkp_port ${hkpPort}";
|
|
};
|
|
};
|
|
};
|
|
};
|
|
}
|