···

       
1
       
 
       
# This module defines global configuration for Haka.

     

       
2
       
-
       


     

       
3
       
 
       
{

     

       
4
       
 
       
  config,

     

       
5
       
 
       
  lib,

     

       
6
       
 
       
  pkgs,

     

       
7
       
 
       
  ...

     

       
8
       
 
       
}:

     

       
9
       
-
       


     

       
10
       
-
       
with lib;

     

       
11
       
-
       


     

       
12
       
 
       
let

     

       
13
       
 
       


     

       
14
       
 
       
  cfg = config.services.haka;

     
···

       
23
       
 
       
      else

     

       
24
       
 
       
        "${haka}/share/haka/sample/${cfg.configFile}"

     

       
25
       
 
       
    }

     

       
26
       
-
       
    ${optionalString (builtins.lessThan 0 cfg.threads) "thread = ${cfg.threads}"}

     

       
27
       
 
       


     

       
28
       
 
       
    [packet]

     

       
29
       
-
       
    ${optionalString cfg.pcap ''module = "packet/pcap"''}

     

       
30
       
-
       
    ${optionalString cfg.nfqueue ''module = "packet/nqueue"''}

     

       
31
       
-
       
    ${optionalString cfg.dump.enable ''dump = "yes"''}

     

       
32
       
-
       
    ${optionalString cfg.dump.enable ''dump_input = "${cfg.dump.input}"''}

     

       
33
       
-
       
    ${optionalString cfg.dump.enable ''dump_output = "${cfg.dump.output}"''}

     

       
34
       
 
       


     

       
35
       
 
       
    interfaces = "${lib.strings.concatStringsSep "," cfg.interfaces}"

     

       
36
       
 
       


     
···

       
62
       
 
       


     

       
63
       
 
       
    services.haka = {

     

       
64
       
 
       


     

       
65
       
-
       
      enable = mkEnableOption "Haka";

     

       
66
       
 
       


     

       
67
       
-
       
      package = mkPackageOption pkgs "haka" { };

     

       
68
       
 
       


     

       
69
       
-
       
      configFile = mkOption {

     

       
70
       
 
       
        default = "empty.lua";

     

       
71
       
 
       
        example = "/srv/haka/myfilter.lua";

     

       
72
       
-
       
        type = types.str;

     

       
73
       
 
       
        description = ''

     

       
74
       
 
       
          Specify which configuration file Haka uses.

     

       
75
       
 
       
          It can be absolute path or a path relative to the sample directory of

     
···

       
77
       
 
       
        '';

     

       
78
       
 
       
      };

     

       
79
       
 
       


     

       
80
       
-
       
      interfaces = mkOption {

     

       
81
       
 
       
        default = [ "eth0" ];

     

       
82
       
 
       
        example = [ "any" ];

     

       
83
       
-
       
        type = with types; listOf str;

     

       
84
       
 
       
        description = ''

     

       
85
       
 
       
          Specify which interface(s) Haka listens to.

     

       
86
       
 
       
          Use 'any' to listen to all interfaces.

     

       
87
       
 
       
        '';

     

       
88
       
 
       
      };

     

       
89
       
 
       


     

       
90
       
-
       
      threads = mkOption {

     

       
91
       
 
       
        default = 0;

     

       
92
       
 
       
        example = 4;

     

       
93
       
-
       
        type = types.int;

     

       
94
       
 
       
        description = ''

     

       
95
       
 
       
          The number of threads that will be used.

     

       
96
       
 
       
          All system threads are used by default.

     

       
97
       
 
       
        '';

     

       
98
       
 
       
      };

     

       
99
       
 
       


     

       
100
       
-
       
      pcap = mkOption {

     

       
101
       
 
       
        default = true;

     

       
102
       
-
       
        type = types.bool;

     

       
103
       
 
       
        description = "Whether to enable pcap";

     

       
104
       
 
       
      };

     

       
105
       
 
       


     

       
106
       
-
       
      nfqueue = mkEnableOption "nfqueue";

     

       
107
       
 
       


     

       
108
       
-
       
      dump.enable = mkEnableOption "dump";

     

       
109
       
-
       
      dump.input = mkOption {

     

       
110
       
 
       
        default = "/tmp/input.pcap";

     

       
111
       
 
       
        example = "/path/to/file.pcap";

     

       
112
       
-
       
        type = types.path;

     

       
113
       
 
       
        description = "Path to file where incoming packets are dumped";

     

       
114
       
 
       
      };

     

       
115
       
 
       


     

       
116
       
-
       
      dump.output = mkOption {

     

       
117
       
 
       
        default = "/tmp/output.pcap";

     

       
118
       
 
       
        example = "/path/to/file.pcap";

     

       
119
       
-
       
        type = types.path;

     

       
120
       
 
       
        description = "Path to file where outgoing packets are dumped";

     

       
121
       
 
       
      };

     

       
122
       
 
       
    };

     
···

       
124
       
 
       


     

       
125
       
 
       
  ###### implementation

     

       
126
       
 
       


     

       
127
       
-
       
  config = mkIf cfg.enable {

     

       
128
       
 
       


     

       
129
       
 
       
    assertions = [

     

       
130
       
 
       
      {

     

···

       
1
       
 
       
# This module defines global configuration for Haka.

     

       
0
       
 
       

     

       
2
       
 
       
{

     

       
3
       
 
       
  config,

     

       
4
       
 
       
  lib,

     

       
5
       
 
       
  pkgs,

     

       
6
       
 
       
  ...

     

       
7
       
 
       
}:

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
8
       
 
       
let

     

       
9
       
 
       


     

       
10
       
 
       
  cfg = config.services.haka;

     
···

       
19
       
 
       
      else

     

       
20
       
 
       
        "${haka}/share/haka/sample/${cfg.configFile}"

     

       
21
       
 
       
    }

     

       
22
       
+
       
    ${lib.optionalString (builtins.lessThan 0 cfg.threads) "thread = ${cfg.threads}"}

     

       
23
       
 
       


     

       
24
       
 
       
    [packet]

     

       
25
       
+
       
    ${lib.optionalString cfg.pcap ''module = "packet/pcap"''}

     

       
26
       
+
       
    ${lib.optionalString cfg.nfqueue ''module = "packet/nqueue"''}

     

       
27
       
+
       
    ${lib.optionalString cfg.dump.enable ''dump = "yes"''}

     

       
28
       
+
       
    ${lib.optionalString cfg.dump.enable ''dump_input = "${cfg.dump.input}"''}

     

       
29
       
+
       
    ${lib.optionalString cfg.dump.enable ''dump_output = "${cfg.dump.output}"''}

     

       
30
       
 
       


     

       
31
       
 
       
    interfaces = "${lib.strings.concatStringsSep "," cfg.interfaces}"

     

       
32
       
 
       


     
···

       
58
       
 
       


     

       
59
       
 
       
    services.haka = {

     

       
60
       
 
       


     

       
61
       
+
       
      enable = lib.mkEnableOption "Haka";

     

       
62
       
 
       


     

       
63
       
+
       
      package = lib.mkPackageOption pkgs "haka" { };

     

       
64
       
 
       


     

       
65
       
+
       
      configFile = lib.mkOption {

     

       
66
       
 
       
        default = "empty.lua";

     

       
67
       
 
       
        example = "/srv/haka/myfilter.lua";

     

       
68
       
+
       
        type = lib.types.str;

     

       
69
       
 
       
        description = ''

     

       
70
       
 
       
          Specify which configuration file Haka uses.

     

       
71
       
 
       
          It can be absolute path or a path relative to the sample directory of

     
···

       
73
       
 
       
        '';

     

       
74
       
 
       
      };

     

       
75
       
 
       


     

       
76
       
+
       
      interfaces = lib.mkOption {

     

       
77
       
 
       
        default = [ "eth0" ];

     

       
78
       
 
       
        example = [ "any" ];

     

       
79
       
+
       
        type = with lib.types; listOf str;

     

       
80
       
 
       
        description = ''

     

       
81
       
 
       
          Specify which interface(s) Haka listens to.

     

       
82
       
 
       
          Use 'any' to listen to all interfaces.

     

       
83
       
 
       
        '';

     

       
84
       
 
       
      };

     

       
85
       
 
       


     

       
86
       
+
       
      threads = lib.mkOption {

     

       
87
       
 
       
        default = 0;

     

       
88
       
 
       
        example = 4;

     

       
89
       
+
       
        type = lib.types.int;

     

       
90
       
 
       
        description = ''

     

       
91
       
 
       
          The number of threads that will be used.

     

       
92
       
 
       
          All system threads are used by default.

     

       
93
       
 
       
        '';

     

       
94
       
 
       
      };

     

       
95
       
 
       


     

       
96
       
+
       
      pcap = lib.mkOption {

     

       
97
       
 
       
        default = true;

     

       
98
       
+
       
        type = lib.types.bool;

     

       
99
       
 
       
        description = "Whether to enable pcap";

     

       
100
       
 
       
      };

     

       
101
       
 
       


     

       
102
       
+
       
      nfqueue = lib.mkEnableOption "nfqueue";

     

       
103
       
 
       


     

       
104
       
+
       
      dump.enable = lib.mkEnableOption "dump";

     

       
105
       
+
       
      dump.input = lib.mkOption {

     

       
106
       
 
       
        default = "/tmp/input.pcap";

     

       
107
       
 
       
        example = "/path/to/file.pcap";

     

       
108
       
+
       
        type = lib.types.path;

     

       
109
       
 
       
        description = "Path to file where incoming packets are dumped";

     

       
110
       
 
       
      };

     

       
111
       
 
       


     

       
112
       
+
       
      dump.output = lib.mkOption {

     

       
113
       
 
       
        default = "/tmp/output.pcap";

     

       
114
       
 
       
        example = "/path/to/file.pcap";

     

       
115
       
+
       
        type = lib.types.path;

     

       
116
       
 
       
        description = "Path to file where outgoing packets are dumped";

     

       
117
       
 
       
      };

     

       
118
       
 
       
    };

     
···

       
120
       
 
       


     

       
121
       
 
       
  ###### implementation

     

       
122
       
 
       


     

       
123
       
+
       
  config = lib.mkIf cfg.enable {

     

       
124
       
 
       


     

       
125
       
 
       
    assertions = [

     

       
126
       
 
       
      {