nixos/modules/services/networking/scion/scion.nix

   1 { config, lib, pkgs, ... }:
   2
   3 with lib;
   4
   5 let
   6   cfg = config.services.scion;
   7 in
   8 {
   9   options.services.scion = {
  10     enable = mkEnableOption "all of the scion components and services";
  11     package = mkPackageOption pkgs "scion" { };
  12     stateless = mkOption {
  13       type = types.bool;
  14       default = true;
  15       description = ''
  16         Setting this value to false (stateful) can lead to improved caching and
  17         performance.
  18
  19         This option decides whether to persist the SCION path sqlite databases
  20         on disk or not. Persisting this data can lead to database corruption in
  21         extreme cases such as power outage, meaning SCION fails to work on the
  22         next boot. This is being investigated.
  23
  24         If true, /run/scion-* is used for data
  25         If false, use /var/lib/scion-* is used for data
  26       '';
  27     };
  28     bypassBootstrapWarning = mkOption {
  29       type = types.bool;
  30       default = false;
  31       description = ''
  32         bypass Nix warning about SCION PKI bootstrapping
  33       '';
  34     };
  35   };
  36   config = mkIf cfg.enable {
  37     environment.systemPackages = [
  38       cfg.package
  39     ];
  40     services.scion = {
  41       scion-dispatcher.enable = true;
  42       scion-daemon.enable = true;
  43       scion-router.enable = true;
  44       scion-control.enable = true;
  45       scion-ip-gateway.enable = true;
  46     };
  47     assertions = [
  48       { assertion = cfg.bypassBootstrapWarning == true;
  49         message = ''
  50           SCION is a routing protocol and requires bootstrapping with a manual, imperative key signing ceremony. You may want to join an existing Isolation Domain (ISD) such as scionlab.org, or bootstrap your own. If you have completed and configured the public key infrastructure for SCION and are sure this process is complete, then add the following to your configuration:
  51
  52           services.scion.bypassBootstrapWarning = true;
  53
  54           refer to docs.scion.org for more information
  55         '';
  56       }
  57     ];
  58   };
  59 }
  60