commit 3990b1119015fcfd272f33a037922a8dcb5cd1aa · pyrox.dev/nixpkgs

nixos/doc/manual/development/nixos-tests.chapter.md

···

       10
       10
        
       running-nixos-tests.section.md

     

       11
       11
        
       running-nixos-tests-interactively.section.md

     

       12
       12
        
       linking-nixos-tests-to-packages.section.md

     

       13
       13
       +
       testing-hardware-features.section.md

     

       13
       14
        
       ```

+152

nixos/doc/manual/development/testing-hardware-features.section.md

···

       1
       1
       +
       # Testing Hardware Features {#sec-nixos-test-testing-hardware-features}

     

       2
       2
       +
       

     

       3
       3
       +
       This section covers how to test various features using NixOS tests that would

     

       4
       4
       +
       normally only be possible with hardware. It is designed to showcase the NixOS test

     

       5
       5
       +
       framework's flexibility when combined with various hardware simulation libraries

     

       6
       6
       +
       or kernel modules.

     

       7
       7
       +
       

     

       8
       8
       +
       ## Wi-Fi {#sec-nixos-test-wifi}

     

       9
       9
       +
       

     

       10
       10
       +
       Use `services.vwifi` to set up a virtual Wi-Fi physical layer. Create at least two nodes

     

       11
       11
       +
       for this kind of test: one with vwifi active, and either a station or an access point.

     

       12
       12
       +
       Give each a static IP address on the test network so they will never collide.

     

       13
       13
       +
       This module likely supports other topologies too; document them if you make one.

     

       14
       14
       +
       

     

       15
       15
       +
       This NixOS module leverages [vwifi](https://github.com/Raizo62/vwifi). Read the

     

       16
       16
       +
       upstream repository's documentation for more information.

     

       17
       17
       +
       

     

       18
       18
       +
       ### vwifi server {#sec-nixos-test-wifi-vwifi-server}

     

       19
       19
       +
       

     

       20
       20
       +
       This node runs the vwifi server, and otherwise does not interact with the network.

     

       21
       21
       +
       You can run `vwifi-ctrl` on this node to control characteristics of the simulated

     

       22
       22
       +
       physical layer.

     

       23
       23
       +
       

     

       24
       24
       +
       ```nix

     

       25
       25
       +
       airgap =

     

       26
       26
       +
         { config, ... }:

     

       27
       27
       +
         {

     

       28
       28
       +
           networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       29
       29
       +
             {

     

       30
       30
       +
               address = "192.168.1.2";

     

       31
       31
       +
               prefixLength = 24;

     

       32
       32
       +
             }

     

       33
       33
       +
           ];

     

       34
       34
       +
           services.vwifi = {

     

       35
       35
       +
             server = {

     

       36
       36
       +
               enable = true;

     

       37
       37
       +
               ports.tcp = 8212;

     

       38
       38
       +
               # uncomment if you want to enable monitor mode on another node

     

       39
       39
       +
               # ports.spy = 8213;

     

       40
       40
       +
               openFirewall = true;

     

       41
       41
       +
             };

     

       42
       42
       +
           };

     

       43
       43
       +
         };

     

       44
       44
       +
       ```

     

       45
       45
       +
       

     

       46
       46
       +
       ### AP {#sec-nixos-test-wifi-ap}

     

       47
       47
       +
       

     

       48
       48
       +
       A node like this will act as a wireless access point in infrastructure mode.

     

       49
       49
       +
       

     

       50
       50
       +
       ```nix

     

       51
       51
       +
       ap =

     

       52
       52
       +
         { config, ... }:

     

       53
       53
       +
         {

     

       54
       54
       +
           networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       55
       55
       +
             {

     

       56
       56
       +
               address = "192.168.1.3";

     

       57
       57
       +
               prefixLength = 24;

     

       58
       58
       +
             }

     

       59
       59
       +
           ];

     

       60
       60
       +
           services.hostapd = {

     

       61
       61
       +
             enable = true;

     

       62
       62
       +
             radios.wlan0 = {

     

       63
       63
       +
               channel = 1;

     

       64
       64
       +
               networks.wlan0 = {

     

       65
       65
       +
                 ssid = "NixOS Test Wi-Fi Network";

     

       66
       66
       +
                 authentication = {

     

       67
       67
       +
                   mode = "wpa3-sae";

     

       68
       68
       +
                   saePasswords = [ { password = "supersecret"; } ];

     

       69
       69
       +
                   enableRecommendedPairwiseCiphers = true;

     

       70
       70
       +
                 };

     

       71
       71
       +
               };

     

       72
       72
       +
             };

     

       73
       73
       +
           };

     

       74
       74
       +
           services.vwifi = {

     

       75
       75
       +
             module = {

     

       76
       76
       +
               enable = true;

     

       77
       77
       +
               macPrefix = "74:F8:F6:00:01";

     

       78
       78
       +
             };

     

       79
       79
       +
             client = {

     

       80
       80
       +
               enable = true;

     

       81
       81
       +
               serverAddress = "192.168.1.2";

     

       82
       82
       +
             };

     

       83
       83
       +
           };

     

       84
       84
       +
         };

     

       85
       85
       +
       ```

     

       86
       86
       +
       

     

       87
       87
       +
       ### Station {#sec-nixos-test-wifi-station}

     

       88
       88
       +
       

     

       89
       89
       +
       A node like this acts as a wireless client.

     

       90
       90
       +
       

     

       91
       91
       +
       ```nix

     

       92
       92
       +
       station =

     

       93
       93
       +
         { config, ... }:

     

       94
       94
       +
         {

     

       95
       95
       +
           networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       96
       96
       +
             {

     

       97
       97
       +
               address = "192.168.1.3";

     

       98
       98
       +
               prefixLength = 24;

     

       99
       99
       +
             }

     

       100
       100
       +
           ];

     

       101
       101
       +
           networking.wireless = {

     

       102
       102
       +
             # No, really, we want it enabled!

     

       103
       103
       +
             enable = lib.mkOverride 0 true;

     

       104
       104
       +
             interfaces = [ "wlan0" ];

     

       105
       105
       +
             networks = {

     

       106
       106
       +
               "NixOS Test Wi-Fi Network" = {

     

       107
       107
       +
                 psk = "supersecret";

     

       108
       108
       +
                 authProtocols = [ "SAE" ];

     

       109
       109
       +
               };

     

       110
       110
       +
             };

     

       111
       111
       +
           };

     

       112
       112
       +
           services.vwifi = {

     

       113
       113
       +
             module = {

     

       114
       114
       +
               enable = true;

     

       115
       115
       +
               macPrefix = "74:F8:F6:00:02";

     

       116
       116
       +
             };

     

       117
       117
       +
             client = {

     

       118
       118
       +
               enable = true;

     

       119
       119
       +
               serverAddress = "192.168.1.2";

     

       120
       120
       +
             };

     

       121
       121
       +
           };

     

       122
       122
       +
         };

     

       123
       123
       +
       ```

     

       124
       124
       +
       

     

       125
       125
       +
       ### Monitor {#sec-nixos-test-wifi-monitor}

     

       126
       126
       +
       

     

       127
       127
       +
       When the monitor mode interface is enabled, this node will receive

     

       128
       128
       +
       all packets broadcast by all other nodes through the spy interface.

     

       129
       129
       +
       

     

       130
       130
       +
       ```nix

     

       131
       131
       +
       monitor =

     

       132
       132
       +
         { config, ... }:

     

       133
       133
       +
         {

     

       134
       134
       +
           networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       135
       135
       +
             {

     

       136
       136
       +
               address = "192.168.1.4";

     

       137
       137
       +
               prefixLength = 24;

     

       138
       138
       +
             }

     

       139
       139
       +
           ];

     

       140
       140
       +
       

     

       141
       141
       +
           services.vwifi = {

     

       142
       142
       +
             module = {

     

       143
       143
       +
               enable = true;

     

       144
       144
       +
               macPrefix = "74:F8:F6:00:03";

     

       145
       145
       +
             };

     

       146
       146
       +
             client = {

     

       147
       147
       +
               enable = true;

     

       148
       148
       +
               spy = true;

     

       149
       149
       +
               serverAddress = "192.168.1.2";

     

       150
       150
       +
             };

     

       151
       151
       +
           };

     

       152
       152
       +
       ```

+18

nixos/doc/manual/redirects.json

···

       77
       77
        
         "sec-mattermost-plugins-build": [

     

       78
       78
        
           "index.html#sec-mattermost-plugins-build"

     

       79
       79
        
         ],

     

       80
       80
       +
         "sec-nixos-test-wifi": [

     

       81
       81
       +
           "index.html#sec-nixos-test-wifi"

     

       82
       82
       +
         ],

     

       83
       83
       +
         "sec-nixos-test-wifi-ap": [

     

       84
       84
       +
           "index.html#sec-nixos-test-wifi-ap"

     

       85
       85
       +
         ],

     

       86
       86
       +
         "sec-nixos-test-wifi-monitor": [

     

       87
       87
       +
           "index.html#sec-nixos-test-wifi-monitor"

     

       88
       88
       +
         ],

     

       89
       89
       +
         "sec-nixos-test-wifi-station": [

     

       90
       90
       +
           "index.html#sec-nixos-test-wifi-station"

     

       91
       91
       +
         ],

     

       92
       92
       +
         "sec-nixos-test-wifi-vwifi-server": [

     

       93
       93
       +
           "index.html#sec-nixos-test-wifi-vwifi-server"

     

       94
       94
       +
         ],

     

       80
       95
        
         "sec-obtaining": [

     

       81
       96
        
           "index.html#sec-obtaining"

     

       82
       97
        
         ],

     
···

       1894
       1909
        
         ],

     

       1895
       1910
        
         "sec-linking-nixos-tests-to-packages": [

     

       1896
       1911
        
           "index.html#sec-linking-nixos-tests-to-packages"

     

       1912
       1912
       +
         ],

     

       1913
       1913
       +
         "sec-nixos-test-testing-hardware-features": [

     

       1914
       1914
       +
           "index.html#sec-nixos-test-testing-hardware-features"

     

       1897
       1915
        
         ],

     

       1898
       1916
        
         "chap-developing-the-test-driver": [

     

       1899
       1917
        
           "index.html#chap-developing-the-test-driver"

nixos/doc/manual/release-notes/rl-2505.section.md

···

       56
       56
        
       

     

       57
       57
        
       - [Kimai](https://www.kimai.org/), a web-based multi-user time-tracking application. Available as [services.kimai](options.html#opt-services.kimai).

     

       58
       58
        
       

     

       59
       59
       +
       - [Kismet](https://www.kismetwireless.net/), a Wi-Fi, Bluetooth, and RF monitoring application supporting a wide range of hardware. Available as {option}`services.kismet`.

     

       60
       60
       +
       

     

       61
       61
       +
       - [vwifi](https://github.com/Raizo62/vwifi), a Wi-Fi simulator daemon leveraging the `mac80211_hwsim` and `vhost_vsock` kernel modules for efficient simulation of multi-node Wi-Fi networks. Available as {option}`services.vwifi`.

     

       62
       62
       +
       

     

       59
       63
        
       - [Homer](https://homer-demo.netlify.app/), a very simple static homepage for your server. Available as [services.homer](options.html#opt-services.homer).

     

       60
       64
        
       

     

       61
       65
        
       - [Ghidra](https://ghidra-sre.org/), a software reverse engineering (SRE) suite of tools. Available as [programs.ghidra](options.html#opt-programs.ghidra).

     
···

       521
       525
        
       - `bind.cacheNetworks` now only controls access for recursive queries, where it previously controlled access for all queries.

     

       522
       526
        
       

     

       523
       527
        
       - [`services.mongodb.enableAuth`](#opt-services.mongodb.enableAuth) now uses the newer [mongosh](https://github.com/mongodb-js/mongosh) shell instead of the legacy shell to configure the initial superuser. You can configure the mongosh package to use through the [`services.mongodb.mongoshPackage`](#opt-services.mongodb.mongoshPackage) option.

     

       528
       528
       +
       

     

       529
       529
       +
       - There is a new set of NixOS test tools for testing virtual Wi-Fi networks in many different topologies. See the {option}`services.vwifi` module, {option}`services.kismet` NixOS test, and [manual](https://nixos.org/manual/nixpkgs/unstable/#sec-nixos-test-wifi) for documentation and examples.

     

       524
       530
        
       

     

       525
       531
        
       - The paperless module now has an option for regular automatic export of

     

       526
       532
        
         documents data using the integrated document exporter.

nixos/modules/module-list.nix

···

       1175
       1175
        
         ./services/networking/kea.nix

     

       1176
       1176
        
         ./services/networking/keepalived/default.nix

     

       1177
       1177
        
         ./services/networking/keybase.nix

     

       1178
       1178
       +
         ./services/networking/kismet.nix

     

       1178
       1179
        
         ./services/networking/knot.nix

     

       1179
       1180
        
         ./services/networking/kresd.nix

     

       1180
       1181
        
         ./services/networking/lambdabot.nix

     
···

       1352
       1353
        
         ./services/networking/veilid.nix

     

       1353
       1354
        
         ./services/networking/vdirsyncer.nix

     

       1354
       1355
        
         ./services/networking/vsftpd.nix

     

       1356
       1356
       +
         ./services/networking/vwifi.nix

     

       1355
       1357
        
         ./services/networking/wasabibackend.nix

     

       1356
       1358
        
         ./services/networking/websockify.nix

     

       1357
       1359
        
         ./services/networking/wg-access-server.nix

+459

nixos/modules/services/networking/kismet.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib.trivial) isFloat isInt isBool;

     

       10
       10
       +
         inherit (lib.modules) mkIf;

     

       11
       11
       +
         inherit (lib.options)

     

       12
       12
       +
           literalExpression

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           mkPackageOption

     

       15
       15
       +
           mkEnableOption

     

       16
       16
       +
           ;

     

       17
       17
       +
         inherit (lib.strings)

     

       18
       18
       +
           isString

     

       19
       19
       +
           escapeShellArg

     

       20
       20
       +
           escapeShellArgs

     

       21
       21
       +
           concatMapStringsSep

     

       22
       22
       +
           concatMapAttrsStringSep

     

       23
       23
       +
           replaceStrings

     

       24
       24
       +
           substring

     

       25
       25
       +
           stringLength

     

       26
       26
       +
           hasInfix

     

       27
       27
       +
           hasSuffix

     

       28
       28
       +
           typeOf

     

       29
       29
       +
           match

     

       30
       30
       +
           ;

     

       31
       31
       +
         inherit (lib.lists) all isList flatten;

     

       32
       32
       +
         inherit (lib.attrsets)

     

       33
       33
       +
           attrsToList

     

       34
       34
       +
           filterAttrs

     

       35
       35
       +
           optionalAttrs

     

       36
       36
       +
           mapAttrs'

     

       37
       37
       +
           mapAttrsToList

     

       38
       38
       +
           nameValuePair

     

       39
       39
       +
           ;

     

       40
       40
       +
         inherit (lib.generators) toKeyValue;

     

       41
       41
       +
         inherit (lib) types;

     

       42
       42
       +
       

     

       43
       43
       +
         # Deeply checks types for a given type function. Calls `override` with type and value.

     

       44
       44
       +
         deep =

     

       45
       45
       +
           func: override: type:

     

       46
       46
       +
           let

     

       47
       47
       +
             prev = func type;

     

       48
       48
       +
           in

     

       49
       49
       +
           prev

     

       50
       50
       +
           // {

     

       51
       51
       +
             check = value: prev.check value && (override type value);

     

       52
       52
       +
           };

     

       53
       53
       +
       

     

       54
       54
       +
         # Deep listOf.

     

       55
       55
       +
         listOf' = deep types.listOf (type: value: all type.check value);

     

       56
       56
       +
       

     

       57
       57
       +
         # Deep attrsOf.

     

       58
       58
       +
         attrsOf' = deep types.attrsOf (type: value: all (item: type.check item.value) (attrsToList value));

     

       59
       59
       +
       

     

       60
       60
       +
         # Kismet config atoms.

     

       61
       61
       +
         atom =

     

       62
       62
       +
           with types;

     

       63
       63
       +
           oneOf [

     

       64
       64
       +
             number

     

       65
       65
       +
             bool

     

       66
       66
       +
             str

     

       67
       67
       +
           ];

     

       68
       68
       +
       

     

       69
       69
       +
         # Composite types.

     

       70
       70
       +
         listOfAtom = listOf' atom;

     

       71
       71
       +
         atomOrList = with types; either atom listOfAtom;

     

       72
       72
       +
         lists = listOf' atomOrList;

     

       73
       73
       +
         kvPair = attrsOf' atomOrList;

     

       74
       74
       +
         kvPairs = listOf' kvPair;

     

       75
       75
       +
       

     

       76
       76
       +
         # Options that eval to a string with a header (foo:key=value)

     

       77
       77
       +
         headerKvPair = attrsOf' (attrsOf' atomOrList);

     

       78
       78
       +
         headerKvPairs = attrsOf' (listOf' (attrsOf' atomOrList));

     

       79
       79
       +
       

     

       80
       80
       +
         # Toplevel config type.

     

       81
       81
       +
         topLevel =

     

       82
       82
       +
           let

     

       83
       83
       +
             topLevel' =

     

       84
       84
       +
               with types;

     

       85
       85
       +
               oneOf [

     

       86
       86
       +
                 headerKvPairs

     

       87
       87
       +
                 headerKvPair

     

       88
       88
       +
                 kvPairs

     

       89
       89
       +
                 kvPair

     

       90
       90
       +
                 listOfAtom

     

       91
       91
       +
                 lists

     

       92
       92
       +
                 atom

     

       93
       93
       +
               ];

     

       94
       94
       +
           in

     

       95
       95
       +
           topLevel'

     

       96
       96
       +
           // {

     

       97
       97
       +
             description = "Kismet config stanza";

     

       98
       98
       +
           };

     

       99
       99
       +
       

     

       100
       100
       +
         # Throws invalid.

     

       101
       101
       +
         invalid = atom: throw "invalid value '${toString atom}' of type '${typeOf atom}'";

     

       102
       102
       +
       

     

       103
       103
       +
         # Converts an atom.

     

       104
       104
       +
         mkAtom =

     

       105
       105
       +
           atom:

     

       106
       106
       +
           if isString atom then

     

       107
       107
       +
             if hasInfix "\"" atom || hasInfix "," atom then

     

       108
       108
       +
               ''"${replaceStrings [ ''"'' ] [ ''\"'' ] atom}"''

     

       109
       109
       +
             else

     

       110
       110
       +
               atom

     

       111
       111
       +
           else if isFloat atom || isInt atom || isBool atom then

     

       112
       112
       +
             toString atom

     

       113
       113
       +
           else

     

       114
       114
       +
             invalid atom;

     

       115
       115
       +
       

     

       116
       116
       +
         # Converts an inline atom or list to a string.

     

       117
       117
       +
         mkAtomOrListInline =

     

       118
       118
       +
           atomOrList:

     

       119
       119
       +
           if isList atomOrList then

     

       120
       120
       +
             mkAtom "${concatMapStringsSep "," mkAtom atomOrList}"

     

       121
       121
       +
           else

     

       122
       122
       +
             mkAtom atomOrList;

     

       123
       123
       +
       

     

       124
       124
       +
         # Converts an out of line atom or list to a string.

     

       125
       125
       +
         mkAtomOrList =

     

       126
       126
       +
           atomOrList:

     

       127
       127
       +
           if isList atomOrList then

     

       128
       128
       +
             "${concatMapStringsSep "," mkAtomOrListInline atomOrList}"

     

       129
       129
       +
           else

     

       130
       130
       +
             mkAtom atomOrList;

     

       131
       131
       +
       

     

       132
       132
       +
         # Throws if the string matches the given regex.

     

       133
       133
       +
         deny =

     

       134
       134
       +
           regex: str:

     

       135
       135
       +
           assert (match regex str) == null;

     

       136
       136
       +
           str;

     

       137
       137
       +
       

     

       138
       138
       +
         # Converts a set of k/v pairs.

     

       139
       139
       +
         convertKv = concatMapAttrsStringSep "," (

     

       140
       140
       +
           name: value: "${mkAtom (deny "=" name)}=${mkAtomOrListInline value}"

     

       141
       141
       +
         );

     

       142
       142
       +
       

     

       143
       143
       +
         # Converts k/v pairs with a header.

     

       144
       144
       +
         convertKvWithHeader = header: attrs: "${mkAtom (deny ":" header)}:${convertKv attrs}";

     

       145
       145
       +
       

     

       146
       146
       +
         # Converts the entire config.

     

       147
       147
       +
         convertConfig = mapAttrs' (

     

       148
       148
       +
           name: value:

     

       149
       149
       +
           let

     

       150
       150
       +
             # Convert foo' into 'foo+' for support for '+=' syntax.

     

       151
       151
       +
             newName = if hasSuffix "'" name then substring 0 (stringLength name - 1) name + "+" else name;

     

       152
       152
       +
       

     

       153
       153
       +
             # Get the stringified value.

     

       154
       154
       +
             newValue =

     

       155
       155
       +
               if headerKvPairs.check value then

     

       156
       156
       +
                 flatten (

     

       157
       157
       +
                   mapAttrsToList (header: values: (map (value: convertKvWithHeader header value) values)) value

     

       158
       158
       +
                 )

     

       159
       159
       +
               else if headerKvPair.check value then

     

       160
       160
       +
                 mapAttrsToList convertKvWithHeader value

     

       161
       161
       +
               else if kvPairs.check value then

     

       162
       162
       +
                 map convertKv value

     

       163
       163
       +
               else if kvPair.check value then

     

       164
       164
       +
                 convertKv value

     

       165
       165
       +
               else if listOfAtom.check value then

     

       166
       166
       +
                 mkAtomOrList value

     

       167
       167
       +
               else if lists.check value then

     

       168
       168
       +
                 map mkAtomOrList value

     

       169
       169
       +
               else if atom.check value then

     

       170
       170
       +
                 mkAtom value

     

       171
       171
       +
               else

     

       172
       172
       +
                 invalid value;

     

       173
       173
       +
           in

     

       174
       174
       +
           nameValuePair newName newValue

     

       175
       175
       +
         );

     

       176
       176
       +
       

     

       177
       177
       +
         mkKismetConf =

     

       178
       178
       +
           options:

     

       179
       179
       +
           (toKeyValue { listsAsDuplicateKeys = true; }) (

     

       180
       180
       +
             filterAttrs (_: value: value != null) (convertConfig options)

     

       181
       181
       +
           );

     

       182
       182
       +
       

     

       183
       183
       +
         cfg = config.services.kismet;

     

       184
       184
       +
       in

     

       185
       185
       +
       {

     

       186
       186
       +
         options.services.kismet = {

     

       187
       187
       +
           enable = mkEnableOption "kismet";

     

       188
       188
       +
           package = mkPackageOption pkgs "kismet" { };

     

       189
       189
       +
           user = mkOption {

     

       190
       190
       +
             description = "The user to run Kismet as.";

     

       191
       191
       +
             type = types.str;

     

       192
       192
       +
             default = "kismet";

     

       193
       193
       +
           };

     

       194
       194
       +
           group = mkOption {

     

       195
       195
       +
             description = "The group to run Kismet as.";

     

       196
       196
       +
             type = types.str;

     

       197
       197
       +
             default = "kismet";

     

       198
       198
       +
           };

     

       199
       199
       +
           serverName = mkOption {

     

       200
       200
       +
             description = "The name of the server.";

     

       201
       201
       +
             type = types.str;

     

       202
       202
       +
             default = "Kismet";

     

       203
       203
       +
           };

     

       204
       204
       +
           serverDescription = mkOption {

     

       205
       205
       +
             description = "The description of the server.";

     

       206
       206
       +
             type = types.str;

     

       207
       207
       +
             default = "NixOS Kismet server";

     

       208
       208
       +
           };

     

       209
       209
       +
           logTypes = mkOption {

     

       210
       210
       +
             description = "The log types.";

     

       211
       211
       +
             type = with types; listOf str;

     

       212
       212
       +
             default = [ "kismet" ];

     

       213
       213
       +
           };

     

       214
       214
       +
           dataDir = mkOption {

     

       215
       215
       +
             description = "The Kismet data directory.";

     

       216
       216
       +
             type = types.path;

     

       217
       217
       +
             default = "/var/lib/kismet";

     

       218
       218
       +
           };

     

       219
       219
       +
           httpd = {

     

       220
       220
       +
             enable = mkOption {

     

       221
       221
       +
               description = "True to enable the HTTP server.";

     

       222
       222
       +
               type = types.bool;

     

       223
       223
       +
               default = false;

     

       224
       224
       +
             };

     

       225
       225
       +
             address = mkOption {

     

       226
       226
       +
               description = "The address to listen on. Note that this cannot be a hostname or Kismet will not start.";

     

       227
       227
       +
               type = types.str;

     

       228
       228
       +
               default = "127.0.0.1";

     

       229
       229
       +
             };

     

       230
       230
       +
             port = mkOption {

     

       231
       231
       +
               description = "The port to listen on.";

     

       232
       232
       +
               type = types.port;

     

       233
       233
       +
               default = 2501;

     

       234
       234
       +
             };

     

       235
       235
       +
           };

     

       236
       236
       +
           settings = mkOption {

     

       237
       237
       +
             description = ''

     

       238
       238
       +
               Options for Kismet. See:

     

       239
       239
       +
               https://www.kismetwireless.net/docs/readme/configuring/configfiles/

     

       240
       240
       +
             '';

     

       241
       241
       +
             default = { };

     

       242
       242
       +
             type = with types; attrsOf topLevel;

     

       243
       243
       +
             example = literalExpression ''

     

       244
       244
       +
               {

     

       245
       245
       +
                 /* Examples for atoms */

     

       246
       246
       +
                 # dot11_link_bssts=false

     

       247
       247
       +
                 dot11_link_bssts = false; # Boolean

     

       248
       248
       +
       

     

       249
       249
       +
                 # dot11_related_bss_window=10000000

     

       250
       250
       +
                 dot11_related_bss_window = 10000000; # Integer

     

       251
       251
       +
       

     

       252
       252
       +
                 # devicefound=00:11:22:33:44:55

     

       253
       253
       +
                 devicefound = "00:11:22:33:44:55"; # String

     

       254
       254
       +
       

     

       255
       255
       +
                 # log_types+=wiglecsv

     

       256
       256
       +
                 log_types' = "wiglecsv";

     

       257
       257
       +
       

     

       258
       258
       +
                 /* Examples for lists of atoms */

     

       259
       259
       +
                 # wepkey=00:DE:AD:C0:DE:00,FEEDFACE42

     

       260
       260
       +
                 wepkey = [ "00:DE:AD:C0:DE:00" "FEEDFACE42" ];

     

       261
       261
       +
       

     

       262
       262
       +
                 # alert=ADHOCCONFLICT,5/min,1/sec

     

       263
       263
       +
                 # alert=ADVCRYPTCHANGE,5/min,1/sec

     

       264
       264
       +
                 alert = [

     

       265
       265
       +
                   [ "ADHOCCONFLICT"  "5/min" "1/sec" ]

     

       266
       266
       +
                   [ "ADVCRYPTCHANGE" "5/min" "1/sec" ]

     

       267
       267
       +
                 ];

     

       268
       268
       +
       

     

       269
       269
       +
                 /* Examples for sets of atoms */

     

       270
       270
       +
                 # source=wlan0:name=ath11k

     

       271
       271
       +
                 source.wlan0 = { name = "ath11k"; };

     

       272
       272
       +
       

     

       273
       273
       +
                 /* Examples with colon-suffixed headers */

     

       274
       274
       +
                 # gps=gpsd:host=localhost,port=2947

     

       275
       275
       +
                 gps.gpsd = {

     

       276
       276
       +
                   host = "localhost";

     

       277
       277
       +
                   port = 2947;

     

       278
       278
       +
                 };

     

       279
       279
       +
       

     

       280
       280
       +
                 # apspoof=Foo1:ssid=Bar1,validmacs="00:11:22:33:44:55,aa:bb:cc:dd:ee:ff"

     

       281
       281
       +
                 # apspoof=Foo1:ssid=Bar2,validmacs="01:12:23:34:45:56,ab:bc:cd:de:ef:f0"

     

       282
       282
       +
                 # apspoof=Foo2:ssid=Baz1,validmacs="11:22:33:44:55:66,bb:cc:dd:ee:ff:00"

     

       283
       283
       +
                 apspoof.Foo1 = [

     

       284
       284
       +
                   { ssid = "Bar1"; validmacs = [ "00:11:22:33:44:55" "aa:bb:cc:dd:ee:ff" ]; }

     

       285
       285
       +
                   { ssid = "Bar2"; validmacs = [ "01:12:23:34:45:56" "ab:bc:cd:de:ef:f0" ]; }

     

       286
       286
       +
                 ];

     

       287
       287
       +
       

     

       288
       288
       +
                 # because Foo1 is a list, Foo2 needs to be as well

     

       289
       289
       +
                 apspoof.Foo2 = [

     

       290
       290
       +
                   {

     

       291
       291
       +
                     ssid = "Bar2";

     

       292
       292
       +
                     validmacs = [ "00:11:22:33:44:55" "aa:bb:cc:dd:ee:ff" ];

     

       293
       293
       +
                   };

     

       294
       294
       +
                 ];

     

       295
       295
       +
               }

     

       296
       296
       +
             '';

     

       297
       297
       +
           };

     

       298
       298
       +
           extraConfig = mkOption {

     

       299
       299
       +
             description = ''

     

       300
       300
       +
               Literal Kismet config lines appended to the site config.

     

       301
       301
       +
               Note that `services.kismet.settings` allows you to define

     

       302
       302
       +
               all options here using Nix attribute sets.

     

       303
       303
       +
             '';

     

       304
       304
       +
             default = "";

     

       305
       305
       +
             type = types.str;

     

       306
       306
       +
             example = ''

     

       307
       307
       +
               # Looks like the following in `services.kismet.settings`:

     

       308
       308
       +
               # wepkey = [ "00:DE:AD:C0:DE:00" "FEEDFACE42" ];

     

       309
       309
       +
               wepkey=00:DE:AD:C0:DE:00,FEEDFACE42

     

       310
       310
       +
             '';

     

       311
       311
       +
           };

     

       312
       312
       +
         };

     

       313
       313
       +
       

     

       314
       314
       +
         config =

     

       315
       315
       +
           let

     

       316
       316
       +
             configDir = "${cfg.dataDir}/.kismet";

     

       317
       317
       +
             settings =

     

       318
       318
       +
               cfg.settings

     

       319
       319
       +
               // {

     

       320
       320
       +
                 server_name = cfg.serverName;

     

       321
       321
       +
                 server_description = cfg.serverDescription;

     

       322
       322
       +
                 logging_enabled = cfg.logTypes != [ ];

     

       323
       323
       +
                 log_types = cfg.logTypes;

     

       324
       324
       +
               }

     

       325
       325
       +
               // optionalAttrs cfg.httpd.enable {

     

       326
       326
       +
                 httpd_bind_address = cfg.httpd.address;

     

       327
       327
       +
                 httpd_port = cfg.httpd.port;

     

       328
       328
       +
                 httpd_auth_file = "${configDir}/kismet_httpd.conf";

     

       329
       329
       +
                 httpd_home = "${cfg.package}/share/kismet/httpd";

     

       330
       330
       +
               };

     

       331
       331
       +
           in

     

       332
       332
       +
           mkIf cfg.enable {

     

       333
       333
       +
             systemd.tmpfiles.settings = {

     

       334
       334
       +
               "10-kismet" = {

     

       335
       335
       +
                 ${cfg.dataDir} = {

     

       336
       336
       +
                   d = {

     

       337
       337
       +
                     inherit (cfg) user group;

     

       338
       338
       +
                     mode = "0750";

     

       339
       339
       +
                   };

     

       340
       340
       +
                 };

     

       341
       341
       +
                 ${configDir} = {

     

       342
       342
       +
                   d = {

     

       343
       343
       +
                     inherit (cfg) user group;

     

       344
       344
       +
                     mode = "0750";

     

       345
       345
       +
                   };

     

       346
       346
       +
                 };

     

       347
       347
       +
               };

     

       348
       348
       +
             };

     

       349
       349
       +
             systemd.services.kismet =

     

       350
       350
       +
               let

     

       351
       351
       +
                 kismetConf = pkgs.writeText "kismet.conf" ''

     

       352
       352
       +
                   ${mkKismetConf settings}

     

       353
       353
       +
                   ${cfg.extraConfig}

     

       354
       354
       +
                 '';

     

       355
       355
       +
               in

     

       356
       356
       +
               {

     

       357
       357
       +
                 description = "Kismet monitoring service";

     

       358
       358
       +
                 wants = [ "basic.target" ];

     

       359
       359
       +
                 after = [

     

       360
       360
       +
                   "basic.target"

     

       361
       361
       +
                   "network.target"

     

       362
       362
       +
                 ];

     

       363
       363
       +
                 wantedBy = [ "multi-user.target" ];

     

       364
       364
       +
                 serviceConfig =

     

       365
       365
       +
                   let

     

       366
       366
       +
                     capabilities = [

     

       367
       367
       +
                       "CAP_NET_ADMIN"

     

       368
       368
       +
                       "CAP_NET_RAW"

     

       369
       369
       +
                     ];

     

       370
       370
       +
                     kismetPreStart = pkgs.writeShellScript "kismet-pre-start" ''

     

       371
       371
       +
                       owner=${escapeShellArg "${cfg.user}:${cfg.group}"}

     

       372
       372
       +
                       mkdir -p ~/.kismet

     

       373
       373
       +
       

     

       374
       374
       +
                       # Ensure permissions on directories Kismet uses.

     

       375
       375
       +
                       chown "$owner" ~/ ~/.kismet

     

       376
       376
       +
                       cd ~/.kismet

     

       377
       377
       +
       

     

       378
       378
       +
                       package=${cfg.package}

     

       379
       379
       +
                       if [ -d "$package/etc" ]; then

     

       380
       380
       +
                         for file in "$package/etc"/*.conf; do

     

       381
       381
       +
                           # Symlink the config files if they exist or are already a link.

     

       382
       382
       +
                           base="''${file##*/}"

     

       383
       383
       +
                           if [ ! -f "$base" ] || [ -L "$base" ]; then

     

       384
       384
       +
                             ln -sf "$file" "$base"

     

       385
       385
       +
                           fi

     

       386
       386
       +
                         done

     

       387
       387
       +
                       fi

     

       388
       388
       +
       

     

       389
       389
       +
                       for file in kismet_httpd.conf; do

     

       390
       390
       +
                         # Un-symlink these files.

     

       391
       391
       +
                         if [ -L "$file" ]; then

     

       392
       392
       +
                           cp "$file" ".$file"

     

       393
       393
       +
                           rm -f "$file"

     

       394
       394
       +
                           mv ".$file" "$file"

     

       395
       395
       +
                           chmod 0640 "$file"

     

       396
       396
       +
                           chown "$owner" "$file"

     

       397
       397
       +
                         fi

     

       398
       398
       +
                       done

     

       399
       399
       +
       

     

       400
       400
       +
                       # Link the site config.

     

       401
       401
       +
                       ln -sf ${kismetConf} kismet_site.conf

     

       402
       402
       +
                     '';

     

       403
       403
       +
                   in

     

       404
       404
       +
                   {

     

       405
       405
       +
                     Type = "simple";

     

       406
       406
       +
                     ExecStart = escapeShellArgs [

     

       407
       407
       +
                       "${cfg.package}/bin/kismet"

     

       408
       408
       +
                       "--homedir"

     

       409
       409
       +
                       cfg.dataDir

     

       410
       410
       +
                       "--confdir"

     

       411
       411
       +
                       configDir

     

       412
       412
       +
                       "--datadir"

     

       413
       413
       +
                       "${cfg.package}/share"

     

       414
       414
       +
                       "--no-ncurses"

     

       415
       415
       +
                       "-f"

     

       416
       416
       +
                       "${configDir}/kismet.conf"

     

       417
       417
       +
                     ];

     

       418
       418
       +
                     WorkingDirectory = cfg.dataDir;

     

       419
       419
       +
                     ExecStartPre = "+${kismetPreStart}";

     

       420
       420
       +
                     Restart = "always";

     

       421
       421
       +
                     KillMode = "control-group";

     

       422
       422
       +
                     CapabilityBoundingSet = capabilities;

     

       423
       423
       +
                     AmbientCapabilities = capabilities;

     

       424
       424
       +
                     LockPersonality = true;

     

       425
       425
       +
                     NoNewPrivileges = true;

     

       426
       426
       +
                     PrivateDevices = false;

     

       427
       427
       +
                     PrivateTmp = true;

     

       428
       428
       +
                     PrivateUsers = false;

     

       429
       429
       +
                     ProtectClock = true;

     

       430
       430
       +
                     ProtectControlGroups = true;

     

       431
       431
       +
                     ProtectHome = true;

     

       432
       432
       +
                     ProtectHostname = true;

     

       433
       433
       +
                     ProtectKernelLogs = true;

     

       434
       434
       +
                     ProtectKernelModules = true;

     

       435
       435
       +
                     ProtectKernelTunables = true;

     

       436
       436
       +
                     ProtectProc = "invisible";

     

       437
       437
       +
                     ProtectSystem = "full";

     

       438
       438
       +
                     RestrictNamespaces = true;

     

       439
       439
       +
                     RestrictSUIDSGID = true;

     

       440
       440
       +
                     User = cfg.user;

     

       441
       441
       +
                     Group = cfg.group;

     

       442
       442
       +
                     UMask = "0007";

     

       443
       443
       +
                     TimeoutStopSec = 30;

     

       444
       444
       +
                   };

     

       445
       445
       +
       

     

       446
       446
       +
                 # Allow it to restart if the wifi interface is not up

     

       447
       447
       +
                 unitConfig.StartLimitIntervalSec = 5;

     

       448
       448
       +
               };

     

       449
       449
       +
             users.groups.${cfg.group} = { };

     

       450
       450
       +
             users.users.${cfg.user} = {

     

       451
       451
       +
               inherit (cfg) group;

     

       452
       452
       +
               description = "User for running Kismet";

     

       453
       453
       +
               isSystemUser = true;

     

       454
       454
       +
               home = cfg.dataDir;

     

       455
       455
       +
             };

     

       456
       456
       +
           };

     

       457
       457
       +
       

     

       458
       458
       +
         meta.maintainers = with lib.maintainers; [ numinit ];

     

       459
       459
       +
       }

+200

nixos/modules/services/networking/vwifi.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib.modules) mkIf mkMerge;

     

       10
       10
       +
         inherit (lib.options) mkOption mkPackageOption mkEnableOption;

     

       11
       11
       +
         inherit (lib.lists) optional optionals;

     

       12
       12
       +
         inherit (lib.strings)

     

       13
       13
       +
           hasSuffix

     

       14
       14
       +
           escapeShellArgs

     

       15
       15
       +
           ;

     

       16
       16
       +
         inherit (lib) types;

     

       17
       17
       +
         cfg = config.services.vwifi;

     

       18
       18
       +
       in

     

       19
       19
       +
       {

     

       20
       20
       +
         options = {

     

       21
       21
       +
           services.vwifi =

     

       22
       22
       +
             let

     

       23
       23
       +
               mkOptionalPort =

     

       24
       24
       +
                 name:

     

       25
       25
       +
                 mkOption {

     

       26
       26
       +
                   description = ''

     

       27
       27
       +
                     The ${name} port. Set to null if we should leave it unset.

     

       28
       28
       +
                   '';

     

       29
       29
       +
                   type = with types; nullOr port;

     

       30
       30
       +
                   default = null;

     

       31
       31
       +
                 };

     

       32
       32
       +
             in

     

       33
       33
       +
             {

     

       34
       34
       +
               package = mkPackageOption pkgs "vwifi" { };

     

       35
       35
       +
               module = {

     

       36
       36
       +
                 enable = mkEnableOption "mac80211_hwsim module";

     

       37
       37
       +
                 numRadios = mkOption {

     

       38
       38
       +
                   description = "The number of virtual radio interfaces to create.";

     

       39
       39
       +
                   type = types.int;

     

       40
       40
       +
                   default = 1;

     

       41
       41
       +
                 };

     

       42
       42
       +
                 macPrefix = mkOption {

     

       43
       43
       +
                   description = ''

     

       44
       44
       +
                     The prefix for MAC addresses to use, without the trailing ':'.

     

       45
       45
       +
                     If one radio is created, you can specify the whole MAC address here.

     

       46
       46
       +
                     The default is defined in vwifi/src/config.h.

     

       47
       47
       +
                   '';

     

       48
       48
       +
                   type = types.strMatching "^(([0-9A-Fa-f]{2}:){0,5}[0-9A-Fa-f]{2})$";

     

       49
       49
       +
                   default = "74:F8:F6";

     

       50
       50
       +
                 };

     

       51
       51
       +
               };

     

       52
       52
       +
               client = {

     

       53
       53
       +
                 enable = mkEnableOption "vwifi client";

     

       54
       54
       +
                 spy = mkEnableOption "spy mode, useful for wireless monitors";

     

       55
       55
       +
                 serverAddress = mkOption {

     

       56
       56
       +
                   description = ''

     

       57
       57
       +
                     The address of the server. If set to null, will try to use the vsock protocol.

     

       58
       58
       +
                     Note that this assumes that the server is spawned on the host and passed through to

     

       59
       59
       +
                     QEMU, with something like:

     

       60
       60
       +
       

     

       61
       61
       +
                     -device vhost-vsock-pci,id=vwifi0,guest-cid=42

     

       62
       62
       +
                   '';

     

       63
       63
       +
                   type = with types; nullOr str;

     

       64
       64
       +
                   default = null;

     

       65
       65
       +
                 };

     

       66
       66
       +
                 serverPort = mkOptionalPort "server port";

     

       67
       67
       +
                 extraArgs = mkOption {

     

       68
       68
       +
                   description = ''

     

       69
       69
       +
                     Extra arguments to pass to vwifi-client. You can use this if you want to bring

     

       70
       70
       +
                     the radios up using vwifi-client instead of at boot.

     

       71
       71
       +
                   '';

     

       72
       72
       +
                   type = with types; listOf str;

     

       73
       73
       +
                   default = [ ];

     

       74
       74
       +
                   example = [

     

       75
       75
       +
                     "--number"

     

       76
       76
       +
                     "3"

     

       77
       77
       +
                   ];

     

       78
       78
       +
                 };

     

       79
       79
       +
               };

     

       80
       80
       +
               server = {

     

       81
       81
       +
                 enable = mkEnableOption "vwifi server";

     

       82
       82
       +
                 vsock.enable = mkEnableOption "vsock kernel module";

     

       83
       83
       +
                 ports = {

     

       84
       84
       +
                   vhost = mkOptionalPort "vhost";

     

       85
       85
       +
                   tcp = mkOptionalPort "TCP server";

     

       86
       86
       +
                   spy = mkOptionalPort "spy interface";

     

       87
       87
       +
                   control = mkOptionalPort "control interface";

     

       88
       88
       +
                 };

     

       89
       89
       +
                 openFirewall = mkEnableOption "opening the firewall for the TCP and spy ports";

     

       90
       90
       +
                 extraArgs = mkOption {

     

       91
       91
       +
                   description = ''

     

       92
       92
       +
                     Extra arguments to pass to vwifi-server. You can use this for things including

     

       93
       93
       +
                     changing the ports or inducing packet loss.

     

       94
       94
       +
                   '';

     

       95
       95
       +
                   type = with types; listOf str;

     

       96
       96
       +
                   default = [ ];

     

       97
       97
       +
                   example = [ "--lost-packets" ];

     

       98
       98
       +
                 };

     

       99
       99
       +
               };

     

       100
       100
       +
             };

     

       101
       101
       +
         };

     

       102
       102
       +
       

     

       103
       103
       +
         config = mkMerge [

     

       104
       104
       +
           (mkIf cfg.module.enable {

     

       105
       105
       +
             boot.kernelModules = [

     

       106
       106
       +
               "mac80211_hwsim"

     

       107
       107
       +
             ];

     

       108
       108
       +
             boot.extraModprobeConfig = ''

     

       109
       109
       +
               # We'll add more radios using vwifi-add-interfaces in the systemd unit.

     

       110
       110
       +
               options mac80211_hwsim radios=0

     

       111
       111
       +
             '';

     

       112
       112
       +
             systemd.services.vwifi-add-interfaces = mkIf (cfg.module.numRadios > 0) {

     

       113
       113
       +
               description = "vwifi interface bringup";

     

       114
       114
       +
               wantedBy = [ "network-pre.target" ];

     

       115
       115
       +
               serviceConfig = {

     

       116
       116
       +
                 Type = "oneshot";

     

       117
       117
       +
                 ExecStart =

     

       118
       118
       +
                   let

     

       119
       119
       +
                     args = [

     

       120
       120
       +
                       (toString cfg.module.numRadios)

     

       121
       121
       +
                       cfg.module.macPrefix

     

       122
       122
       +
                     ];

     

       123
       123
       +
                   in

     

       124
       124
       +
                   "${cfg.package}/bin/vwifi-add-interfaces ${escapeShellArgs args}";

     

       125
       125
       +
               };

     

       126
       126
       +
             };

     

       127
       127
       +
             assertions = [

     

       128
       128
       +
               {

     

       129
       129
       +
                 assertion = !(hasSuffix ":" cfg.module.macPrefix);

     

       130
       130
       +
                 message = ''

     

       131
       131
       +
                   services.vwifi.module.macPrefix should not have a trailing ":".

     

       132
       132
       +
                 '';

     

       133
       133
       +
               }

     

       134
       134
       +
             ];

     

       135
       135
       +
           })

     

       136
       136
       +
           (mkIf cfg.client.enable {

     

       137
       137
       +
             systemd.services.vwifi-client =

     

       138
       138
       +
               let

     

       139
       139
       +
                 clientArgs =

     

       140
       140
       +
                   optional cfg.client.spy "--spy"

     

       141
       141
       +
                   ++ optional (cfg.client.serverAddress != null) cfg.client.serverAddress

     

       142
       142
       +
                   ++ optionals (cfg.client.serverPort != null) [

     

       143
       143
       +
                     "--port"

     

       144
       144
       +
                     cfg.client.serverPort

     

       145
       145
       +
                   ]

     

       146
       146
       +
                   ++ cfg.client.extraArgs;

     

       147
       147
       +
               in

     

       148
       148
       +
               rec {

     

       149
       149
       +
                 description = "vwifi client";

     

       150
       150
       +
                 wantedBy = [ "multi-user.target" ];

     

       151
       151
       +
                 after = [ "network.target" ];

     

       152
       152
       +
                 requires = after;

     

       153
       153
       +
                 serviceConfig = {

     

       154
       154
       +
                   ExecStart = "${cfg.package}/bin/vwifi-client ${escapeShellArgs clientArgs}";

     

       155
       155
       +
                 };

     

       156
       156
       +
               };

     

       157
       157
       +
           })

     

       158
       158
       +
           (mkIf cfg.server.enable {

     

       159
       159
       +
             boot.kernelModules = mkIf cfg.server.vsock.enable [

     

       160
       160
       +
               "vhost_vsock"

     

       161
       161
       +
             ];

     

       162
       162
       +
             networking.firewall.allowedTCPPorts = mkIf cfg.server.openFirewall (

     

       163
       163
       +
               optional (cfg.server.ports.tcp != null) cfg.server.ports.tcp

     

       164
       164
       +
               ++ optional (cfg.server.ports.spy != null) cfg.server.ports.spy

     

       165
       165
       +
             );

     

       166
       166
       +
             systemd.services.vwifi-server =

     

       167
       167
       +
               let

     

       168
       168
       +
                 serverArgs =

     

       169
       169
       +
                   optionals (cfg.server.ports.vhost != null) [

     

       170
       170
       +
                     "--port-vhost"

     

       171
       171
       +
                     (toString cfg.server.ports.vhost)

     

       172
       172
       +
                   ]

     

       173
       173
       +
                   ++ optionals (cfg.server.ports.tcp != null) [

     

       174
       174
       +
                     "--port-tcp"

     

       175
       175
       +
                     (toString cfg.server.ports.tcp)

     

       176
       176
       +
                   ]

     

       177
       177
       +
                   ++ optionals (cfg.server.ports.spy != null) [

     

       178
       178
       +
                     "--port-spy"

     

       179
       179
       +
                     (toString cfg.server.ports.spy)

     

       180
       180
       +
                   ]

     

       181
       181
       +
                   ++ optionals (cfg.server.ports.control != null) [

     

       182
       182
       +
                     "--port-ctrl"

     

       183
       183
       +
                     (toString cfg.server.ports.control)

     

       184
       184
       +
                   ]

     

       185
       185
       +
                   ++ cfg.server.extraArgs;

     

       186
       186
       +
               in

     

       187
       187
       +
               rec {

     

       188
       188
       +
                 description = "vwifi server";

     

       189
       189
       +
                 wantedBy = [ "multi-user.target" ];

     

       190
       190
       +
                 after = [ "network.target" ];

     

       191
       191
       +
                 requires = after;

     

       192
       192
       +
                 serviceConfig = {

     

       193
       193
       +
                   ExecStart = "${cfg.package}/bin/vwifi-server ${escapeShellArgs serverArgs}";

     

       194
       194
       +
                 };

     

       195
       195
       +
               };

     

       196
       196
       +
           })

     

       197
       197
       +
         ];

     

       198
       198
       +
       

     

       199
       199
       +
         meta.maintainers = with lib.maintainers; [ numinit ];

     

       200
       200
       +
       }

nixos/tests/all-tests.nix

···

       702
       702
        
         keyd = handleTest ./keyd.nix { };

     

       703
       703
        
         keymap = handleTest ./keymap.nix { };

     

       704
       704
        
         kimai = runTest ./kimai.nix;

     

       705
       705
       +
         kismet = runTest ./kismet.nix;

     

       705
       706
        
         kmonad = runTest ./kmonad.nix;

     

       706
       707
        
         knot = runTest ./knot.nix;

     

       707
       708
        
         komga = handleTest ./komga.nix { };

+266

nixos/tests/kismet.nix

···

       1
       1
       +
       { pkgs, lib, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         ssid = "Hydra SmokeNet";

     

       5
       5
       +
         psk = "stayoffmywifi";

     

       6
       6
       +
         wlanInterface = "wlan0";

     

       7
       7
       +
       in

     

       8
       8
       +
       {

     

       9
       9
       +
         name = "kismet";

     

       10
       10
       +
       

     

       11
       11
       +
         nodes =

     

       12
       12
       +
           let

     

       13
       13
       +
             hostAddress = id: "192.168.1.${toString (id + 1)}";

     

       14
       14
       +
             serverAddress = hostAddress 1;

     

       15
       15
       +
           in

     

       16
       16
       +
           {

     

       17
       17
       +
             airgap =

     

       18
       18
       +
               { config, ... }:

     

       19
       19
       +
               {

     

       20
       20
       +
                 networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       21
       21
       +
                   {

     

       22
       22
       +
                     address = serverAddress;

     

       23
       23
       +
                     prefixLength = 24;

     

       24
       24
       +
                   }

     

       25
       25
       +
                 ];

     

       26
       26
       +
                 services.vwifi = {

     

       27
       27
       +
                   server = {

     

       28
       28
       +
                     enable = true;

     

       29
       29
       +
                     ports.tcp = 8212;

     

       30
       30
       +
                     ports.spy = 8213;

     

       31
       31
       +
                     openFirewall = true;

     

       32
       32
       +
                   };

     

       33
       33
       +
                 };

     

       34
       34
       +
               };

     

       35
       35
       +
       

     

       36
       36
       +
             ap =

     

       37
       37
       +
               { config, ... }:

     

       38
       38
       +
               {

     

       39
       39
       +
                 networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       40
       40
       +
                   {

     

       41
       41
       +
                     address = hostAddress 2;

     

       42
       42
       +
                     prefixLength = 24;

     

       43
       43
       +
                   }

     

       44
       44
       +
                 ];

     

       45
       45
       +
                 services.hostapd = {

     

       46
       46
       +
                   enable = true;

     

       47
       47
       +
                   radios.${wlanInterface} = {

     

       48
       48
       +
                     channel = 1;

     

       49
       49
       +
                     networks.${wlanInterface} = {

     

       50
       50
       +
                       inherit ssid;

     

       51
       51
       +
                       authentication = {

     

       52
       52
       +
                         mode = "wpa3-sae";

     

       53
       53
       +
                         saePasswords = [ { password = psk; } ];

     

       54
       54
       +
                         enableRecommendedPairwiseCiphers = true;

     

       55
       55
       +
                       };

     

       56
       56
       +
                     };

     

       57
       57
       +
                   };

     

       58
       58
       +
                 };

     

       59
       59
       +
                 services.vwifi = {

     

       60
       60
       +
                   module = {

     

       61
       61
       +
                     enable = true;

     

       62
       62
       +
                     macPrefix = "74:F8:F6:00:01";

     

       63
       63
       +
                   };

     

       64
       64
       +
                   client = {

     

       65
       65
       +
                     enable = true;

     

       66
       66
       +
                     inherit serverAddress;

     

       67
       67
       +
                   };

     

       68
       68
       +
                 };

     

       69
       69
       +
               };

     

       70
       70
       +
       

     

       71
       71
       +
             station =

     

       72
       72
       +
               { config, ... }:

     

       73
       73
       +
               {

     

       74
       74
       +
                 networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       75
       75
       +
                   {

     

       76
       76
       +
                     address = hostAddress 3;

     

       77
       77
       +
                     prefixLength = 24;

     

       78
       78
       +
                   }

     

       79
       79
       +
                 ];

     

       80
       80
       +
                 networking.wireless = {

     

       81
       81
       +
                   # No, really, we want it enabled!

     

       82
       82
       +
                   enable = lib.mkOverride 0 true;

     

       83
       83
       +
                   interfaces = [ wlanInterface ];

     

       84
       84
       +
                   networks = {

     

       85
       85
       +
                     ${ssid} = {

     

       86
       86
       +
                       inherit psk;

     

       87
       87
       +
                       authProtocols = [ "SAE" ];

     

       88
       88
       +
                     };

     

       89
       89
       +
                   };

     

       90
       90
       +
                 };

     

       91
       91
       +
                 services.vwifi = {

     

       92
       92
       +
                   module = {

     

       93
       93
       +
                     enable = true;

     

       94
       94
       +
                     macPrefix = "74:F8:F6:00:02";

     

       95
       95
       +
                   };

     

       96
       96
       +
                   client = {

     

       97
       97
       +
                     enable = true;

     

       98
       98
       +
                     inherit serverAddress;

     

       99
       99
       +
                   };

     

       100
       100
       +
                 };

     

       101
       101
       +
               };

     

       102
       102
       +
       

     

       103
       103
       +
             monitor =

     

       104
       104
       +
               { config, ... }:

     

       105
       105
       +
               {

     

       106
       106
       +
                 networking.interfaces.eth1.ipv4.addresses = lib.mkForce [

     

       107
       107
       +
                   {

     

       108
       108
       +
                     address = hostAddress 4;

     

       109
       109
       +
                     prefixLength = 24;

     

       110
       110
       +
                   }

     

       111
       111
       +
                 ];

     

       112
       112
       +
       

     

       113
       113
       +
                 services.kismet = {

     

       114
       114
       +
                   enable = true;

     

       115
       115
       +
                   serverName = "NixOS Kismet Smoke Test";

     

       116
       116
       +
                   serverDescription = "Server testing virtual wifi devices running on Hydra";

     

       117
       117
       +
                   httpd.enable = true;

     

       118
       118
       +
                   # Check that the settings all eval correctly

     

       119
       119
       +
                   settings = {

     

       120
       120
       +
                     # Should append to log_types

     

       121
       121
       +
                     log_types' = "wiglecsv";

     

       122
       122
       +
       

     

       123
       123
       +
                     # Should all generate correctly

     

       124
       124
       +
                     wepkey = [

     

       125
       125
       +
                       "00:DE:AD:C0:DE:00"

     

       126
       126
       +
                       "FEEDFACE42"

     

       127
       127
       +
                     ];

     

       128
       128
       +
                     alert = [

     

       129
       129
       +
                       [

     

       130
       130
       +
                         "ADHOCCONFLICT"

     

       131
       131
       +
                         "5/min"

     

       132
       132
       +
                         "1/sec"

     

       133
       133
       +
                       ]

     

       134
       134
       +
                       [

     

       135
       135
       +
                         "ADVCRYPTCHANGE"

     

       136
       136
       +
                         "5/min"

     

       137
       137
       +
                         "1/sec"

     

       138
       138
       +
                       ]

     

       139
       139
       +
                     ];

     

       140
       140
       +
                     gps.gpsd = {

     

       141
       141
       +
                       host = "localhost";

     

       142
       142
       +
                       port = 2947;

     

       143
       143
       +
                     };

     

       144
       144
       +
                     apspoof.Foo1 = [

     

       145
       145
       +
                       {

     

       146
       146
       +
                         ssid = "Bar1";

     

       147
       147
       +
                         validmacs = [

     

       148
       148
       +
                           "00:11:22:33:44:55"

     

       149
       149
       +
                           "aa:bb:cc:dd:ee:ff"

     

       150
       150
       +
                         ];

     

       151
       151
       +
                       }

     

       152
       152
       +
                       {

     

       153
       153
       +
                         ssid = "Bar2";

     

       154
       154
       +
                         validmacs = [

     

       155
       155
       +
                           "01:12:23:34:45:56"

     

       156
       156
       +
                           "ab:bc:cd:de:ef:f0"

     

       157
       157
       +
                         ];

     

       158
       158
       +
                       }

     

       159
       159
       +
                     ];

     

       160
       160
       +
                     apspoof.Foo2 = [

     

       161
       161
       +
                       {

     

       162
       162
       +
                         ssid = "Bar2";

     

       163
       163
       +
                         validmacs = [

     

       164
       164
       +
                           "00:11:22:33:44:55"

     

       165
       165
       +
                           "aa:bb:cc:dd:ee:ff"

     

       166
       166
       +
                         ];

     

       167
       167
       +
                       }

     

       168
       168
       +
                     ];

     

       169
       169
       +
       

     

       170
       170
       +
                     # The actual source

     

       171
       171
       +
                     source.${wlanInterface} = {

     

       172
       172
       +
                       name = "Virtual Wifi";

     

       173
       173
       +
                     };

     

       174
       174
       +
                   };

     

       175
       175
       +
                   extraConfig = ''

     

       176
       176
       +
                     # this comment should be ignored

     

       177
       177
       +
                   '';

     

       178
       178
       +
                 };

     

       179
       179
       +
       

     

       180
       180
       +
                 services.vwifi = {

     

       181
       181
       +
                   module = {

     

       182
       182
       +
                     enable = true;

     

       183
       183
       +
                     macPrefix = "74:F8:F6:00:03";

     

       184
       184
       +
                   };

     

       185
       185
       +
                   client = {

     

       186
       186
       +
                     enable = true;

     

       187
       187
       +
                     spy = true;

     

       188
       188
       +
                     inherit serverAddress;

     

       189
       189
       +
                   };

     

       190
       190
       +
                 };

     

       191
       191
       +
       

     

       192
       192
       +
                 environment.systemPackages = with pkgs; [

     

       193
       193
       +
                   config.services.kismet.package

     

       194
       194
       +
                   config.services.vwifi.package

     

       195
       195
       +
                   jq

     

       196
       196
       +
                 ];

     

       197
       197
       +
               };

     

       198
       198
       +
           };

     

       199
       199
       +
       

     

       200
       200
       +
         testScript =

     

       201
       201
       +
           { nodes, ... }:

     

       202
       202
       +
           ''

     

       203
       203
       +
             import shlex

     

       204
       204
       +
       

     

       205
       205
       +
             # Wait for the vwifi server to come up

     

       206
       206
       +
             airgap.start()

     

       207
       207
       +
             airgap.wait_for_unit("vwifi-server.service")

     

       208
       208
       +
             airgap.wait_for_open_port(${toString nodes.airgap.services.vwifi.server.ports.tcp})

     

       209
       209
       +
       

     

       210
       210
       +
             httpd_port = ${toString nodes.monitor.services.kismet.httpd.port}

     

       211
       211
       +
             server_name = "${nodes.monitor.services.kismet.serverName}"

     

       212
       212
       +
             server_description = "${nodes.monitor.services.kismet.serverDescription}"

     

       213
       213
       +
             wlan_interface = "${wlanInterface}"

     

       214
       214
       +
             ap_essid = "${ssid}"

     

       215
       215
       +
             ap_mac_prefix = "${nodes.ap.services.vwifi.module.macPrefix}"

     

       216
       216
       +
             station_mac_prefix = "${nodes.station.services.vwifi.module.macPrefix}"

     

       217
       217
       +
       

     

       218
       218
       +
             # Spawn the other nodes.

     

       219
       219
       +
             monitor.start()

     

       220
       220
       +
       

     

       221
       221
       +
             # Wait for the monitor to come up

     

       222
       222
       +
             monitor.wait_for_unit("kismet.service")

     

       223
       223
       +
             monitor.wait_for_open_port(httpd_port)

     

       224
       224
       +
       

     

       225
       225
       +
             # Should be up but require authentication.

     

       226
       226
       +
             url = f"http://localhost:{httpd_port}"

     

       227
       227
       +
             monitor.succeed(f"curl {url} | tee /dev/stderr | grep '<title>Kismet</title>'")

     

       228
       228
       +
       

     

       229
       229
       +
             # Have to set the password now.

     

       230
       230
       +
             monitor.succeed("echo httpd_username=nixos >> ~kismet/.kismet/kismet_httpd.conf")

     

       231
       231
       +
             monitor.succeed("echo httpd_password=hydra >> ~kismet/.kismet/kismet_httpd.conf")

     

       232
       232
       +
             monitor.systemctl("restart kismet.service")

     

       233
       233
       +
             monitor.wait_for_unit("kismet.service")

     

       234
       234
       +
             monitor.wait_for_open_port(httpd_port)

     

       235
       235
       +
       

     

       236
       236
       +
             # Authentication should now work.

     

       237
       237
       +
             url = f"http://nixos:hydra@localhost:{httpd_port}"

     

       238
       238
       +
             monitor.succeed(f"curl {url}/system/status.json | tee /dev/stderr | jq -e --arg serverName {shlex.quote(server_name)} --arg serverDescription {shlex.quote(server_description)} '.\"kismet.system.server_name\" == $serverName and .\"kismet.system.server_description\" == $serverDescription'")

     

       239
       239
       +
       

     

       240
       240
       +
             # Wait for the station to connect to the AP while Kismet is monitoring

     

       241
       241
       +
             ap.start()

     

       242
       242
       +
             station.start()

     

       243
       243
       +
       

     

       244
       244
       +
             unit = f"wpa_supplicant-{wlan_interface}"

     

       245
       245
       +
       

     

       246
       246
       +
             # Generate handshakes until we detect both devices

     

       247
       247
       +
             success = False

     

       248
       248
       +
             for i in range(100):

     

       249
       249
       +
               station.wait_for_unit(f"wpa_supplicant-{wlan_interface}.service")

     

       250
       250
       +
               station.succeed(f"ifconfig {wlan_interface} down && ifconfig {wlan_interface} up")

     

       251
       251
       +
               station.wait_until_succeeds(f"journalctl -u {shlex.quote(unit)} -e | grep -Eqi {shlex.quote(wlan_interface + ': CTRL-EVENT-CONNECTED - Connection to ' + ap_mac_prefix + '[0-9a-f:]* completed')}")

     

       252
       252
       +
               station.succeed(f"journalctl --rotate --unit={shlex.quote(unit)}")

     

       253
       253
       +
               station.succeed(f"sleep 3 && journalctl --vacuum-time=1s --unit={shlex.quote(unit)}")

     

       254
       254
       +
       

     

       255
       255
       +
               # We're connected, make sure Kismet sees both of our devices

     

       256
       256
       +
               status, stdout = monitor.execute(f"curl {url}/devices/views/all/last-time/0/devices.json | tee /dev/stderr | jq -e --arg macPrefix {shlex.quote(ap_mac_prefix)} --arg ssid {shlex.quote(ap_essid)} '. | (map(select((.\"kismet.device.base.macaddr\"? | startswith($macPrefix)) and .\"dot11.device\"?.\"dot11.device.last_beaconed_ssid_record\"?.\"dot11.advertisedssid.ssid\" == $ssid)) | length) == 1'")

     

       257
       257
       +
               if status != 0:

     

       258
       258
       +
                 continue

     

       259
       259
       +
               status, stdout = monitor.execute(f"curl {url}/devices/views/all/last-time/0/devices.json | tee /dev/stderr | jq -e --arg macPrefix {shlex.quote(station_mac_prefix)} '. | (map(select((.\"kismet.device.base.macaddr\"? | startswith($macPrefix)))) | length) == 1'")

     

       260
       260
       +
               if status == 0:

     

       261
       261
       +
                 success = True

     

       262
       262
       +
                 break

     

       263
       263
       +
       

     

       264
       264
       +
             assert success

     

       265
       265
       +
           '';

     

       266
       266
       +
       }

pkgs/by-name/ki/kismet/package.nix

···

       15
       15
        
         lm_sensors,

     

       16
       16
        
         networkmanager,

     

       17
       17
        
         nix-update-script,

     

       18
       18
       +
         nixosTests,

     

       18
       19
        
         pcre2,

     

       19
       20
        
         pkg-config,

     

       20
       21
        
         openssl,

     
···

       115
       116
        
         enableParallelBuilding = true;

     

       116
       117
        
       

     

       117
       118
        
         passthru = {

     

       119
       119
       +
           tests.kismet = nixosTests.kismet;

     

       118
       120
        
           updateScript = nix-update-script {

     

       119
       121
        
             extraArgs = [

     

       120
       122
        
               "--version-regex"