commit 94e6323de09f028bbf9186272cc00b6b5b6521a0 · pyrox.dev/nixpkgs

+12 -2

nixos/doc/manual/configuration/wireless.xml

···

       18
        
       networking.wireless.enable = true;

     

       19
        
       </programlisting>

     

       20
        
       

     

       21
       -
       NixOS currently does not generate wpa_supplicant's

     

       22
       -
       configuration file, <literal>/etc/wpa_supplicant.conf</literal>. You should edit this file

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
       yourself to define wireless networks, WPA keys and so on (see

     

       24
        
       wpa_supplicant.conf(5)).

     

       25
        
       </para>

···

       18
        
       networking.wireless.enable = true;

     

       19
        
       </programlisting>

     

       20
        
       

     

       21
       +
       NixOS lets you specify networks for wpa_supplicant declaratively:

     

       22
       +
       <programlisting>

     

       23
       +
       networking.wireless.networks = {

     

       24
       +
         echelon = {

     

       25
       +
           psk = "abcdefgh";

     

       26
       +
         };

     

       27
       +
         "free.wifi" = {};

     

       28
       +
       }

     

       29
       +
       </programlisting>

     

       30
       +
       

     

       31
       +
       When no networks are set it will default to using a configuration file at

     

       32
       +
       <literal>/etc/wpa_supplicant.conf</literal>. You should edit this file

     

       33
        
       yourself to define wireless networks, WPA keys and so on (see

     

       34
        
       wpa_supplicant.conf(5)).

     

       35
        
       </para>

+75 -85

nixos/modules/services/networking/wpa_supplicant.nix

···

       3
        
       with lib;

     

       4
        
       

     

       5
        
       let

     

       6
       -
       

     

       7
        
         cfg = config.networking.wireless;

     

       8
       -
         configFile = "/etc/wpa_supplicant.conf";

     

       9
       -
       

     

       10
       -
         ifaces =

     

       11
       -
           cfg.interfaces ++

     

       12
       -
           optional (config.networking.WLANInterface != "") config.networking.WLANInterface;

     

       13
       -
       

     

       14
       -
       in

     

       15
       -
       

     

       16
       -
       {

     

       17
       -
       

     

       18
       -
         ###### interface

     

       19
       -
       

     

       0
        
       
     

       20
        
         options = {

     

       21
       -
       

     

       22
       -
           networking.WLANInterface = mkOption {

     

       23
       -
             default = "";

     

       24
       -
             description = "Obsolete. Use <option>networking.wireless.interfaces</option> instead.";

     

       25
       -
           };

     

       26
       -
       

     

       27
        
           networking.wireless = {

     

       28
       -
             enable = mkOption {

     

       29
       -
               type = types.bool;

     

       30
       -
               default = false;

     

       31
       -
               description = ''

     

       32
       -
                 Whether to start <command>wpa_supplicant</command> to scan for

     

       33
       -
                 and associate with wireless networks.  Note: NixOS currently

     

       34
       -
                 does not manage <command>wpa_supplicant</command>'s

     

       35
       -
                 configuration file, <filename>${configFile}</filename>.  You

     

       36
       -
                 should edit this file yourself to define wireless networks,

     

       37
       -
                 WPA keys and so on (see

     

       38
       -
                 <citerefentry><refentrytitle>wpa_supplicant.conf</refentrytitle>

     

       39
       -
                 <manvolnum>5</manvolnum></citerefentry>), or use

     

       40
       -
                 networking.wireless.userControlled.* to allow users to add entries

     

       41
       -
                 through <command>wpa_cli</command> and <command>wpa_gui</command>.

     

       42
       -
               '';

     

       43
       -
             };

     

       44
        
       

     

       45
        
             interfaces = mkOption {

     

       46
        
               type = types.listOf types.str;

     

       47
        
               default = [];

     

       48
        
               example = [ "wlan0" "wlan1" ];

     

       49
        
               description = ''

     

       50
       -
                 The interfaces <command>wpa_supplicant</command> will use.  If empty, it will

     

       51
        
                 automatically use all wireless interfaces.

     

       52
        
               '';

     

       53
        
             };

     
···

       58
        
               description = "Force a specific wpa_supplicant driver.";

     

       59
        
             };

     

       60
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       61
        
             userControlled = {

     

       62
        
               enable = mkOption {

     

       63
        
                 type = types.bool;

     
···

       68
        
                   to depend on a large package such as NetworkManager just to pick nearby

     

       69
        
                   access points.

     

       70
        
       

     

       71
       -
                   When you want to use this, make sure ${configFile} doesn't exist.

     

       72
       -
                   It will be created for you.

     

       73
       -
       

     

       74
       -
                   Currently it is also necessary to explicitly specify networking.wireless.interfaces.

     

       75
        
                 '';

     

       76
        
               };

     

       77
        
       

     
···

       85
        
           };

     

       86
        
         };

     

       87
        
       

     

       88
       -
       

     

       89
       -
         ###### implementation

     

       90
       -
       

     

       91
       -
         config = mkIf cfg.enable {

     

       92
       -
       

     

       93
       -
           environment.systemPackages =  [ pkgs.wpa_supplicant ];

     

       94
        
       

     

       95
       -
           services.dbus.packages = [ pkgs.wpa_supplicant ];

     

       96
        
       

     

       97
       -
           # FIXME: start a separate wpa_supplicant instance per interface.

     

       98
       -
           jobs.wpa_supplicant =

     

       99
       -
             { description = "WPA Supplicant";

     

       0
        
       
     

       0
        
       
     

       100
        
       

     

       101
        
               wantedBy = [ "network.target" ];

     

       102
        
       

     

       103
        
               path = [ pkgs.wpa_supplicant ];

     

       104
        
       

     

       105
       -
               preStart = ''

     

       106
       -
                 touch -a ${configFile}

     

       107
       -
                 chmod 600 ${configFile}

     

       108
       -
               '' + optionalString cfg.userControlled.enable ''

     

       109
       -
                 if [ ! -s ${configFile} ]; then

     

       110
       -
                   echo "ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=${cfg.userControlled.group}" >> ${configFile}

     

       111
       -
                   echo "update_config=1" >> ${configFile}

     

       112
       -
                 fi

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       113
        
               '';

     

       114
       -
       

     

       115
       -
               script =

     

       116
       -
                 ''

     

       117
       -
                   ${if ifaces == [] then ''

     

       118
       -
                     for i in $(cd /sys/class/net && echo *); do

     

       119
       -
                       DEVTYPE=

     

       120
       -
                       source /sys/class/net/$i/uevent

     

       121
       -
                       if [ "$DEVTYPE" = "wlan" -o -e /sys/class/net/$i/wireless ]; then

     

       122
       -
                         ifaces="$ifaces''${ifaces:+ -N} -i$i"

     

       123
       -
                       fi

     

       124
       -
                     done

     

       125
       -
                   '' else ''

     

       126
       -
                     ifaces="${concatStringsSep " -N " (map (i: "-i${i}") ifaces)}"

     

       127
       -
                   ''}

     

       128
       -
                   exec wpa_supplicant -s -u -D${cfg.driver} -c ${configFile} $ifaces

     

       129
       -
                 '';

     

       130
        
             };

     

       131
        
       

     

       132
       -
           powerManagement.resumeCommands =

     

       133
       -
             ''

     

       134
        
               ${config.systemd.package}/bin/systemctl try-restart wpa_supplicant

     

       135
        
             '';

     

       136
        
       

     

       137
       -
           assertions = [{ assertion = !cfg.userControlled.enable || cfg.interfaces != [];

     

       138
       -
                           message = "user controlled wpa_supplicant needs explicit networking.wireless.interfaces";}];

     

       139
       -
       

     

       140
       -
           # Restart wpa_supplicant when a wlan device appears or disappears.

     

       141
       -
           services.udev.extraRules =

     

       142
       -
             ''

     

       143
        
               ACTION=="add|remove", SUBSYSTEM=="net", ENV{DEVTYPE}=="wlan", RUN+="${config.systemd.package}/bin/systemctl try-restart wpa_supplicant.service"

     

       144
        
             '';

     

       145
       -
       

     

       146
       -
         };

     

       147
       -
       

     

       0
        
       
     

       0
        
       
     

       148
        
       }

···

       3
        
       with lib;

     

       4
        
       

     

       5
        
       let

     

       0
        
       
     

       6
        
         cfg = config.networking.wireless;

     

       7
       +
         configFile = if cfg.networks != {} then pkgs.writeText "wpa_supplicant.conf" ''

     

       8
       +
           ${optionalString cfg.userControlled.enable ''

     

       9
       +
             ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=${cfg.userControlled.group}

     

       10
       +
             update_config=1''}

     

       11
       +
           ${concatStringsSep "\n" (mapAttrsToList (ssid: networkConfig: ''

     

       12
       +
             network={

     

       13
       +
               ssid="${ssid}"

     

       14
       +
               ${optionalString (networkConfig.psk != null) ''psk="${networkConfig.psk}"''}

     

       15
       +
               ${optionalString (networkConfig.psk == null) ''key_mgmt=NONE''}

     

       16
       +
             }

     

       17
       +
           '') cfg.networks)}

     

       18
       +
         '' else "/etc/wpa_supplicant.conf";

     

       19
       +
       in {

     

       20
        
         options = {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
           networking.wireless = {

     

       22
       +
             enable = mkEnableOption "wpa_supplicant";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
       

     

       24
        
             interfaces = mkOption {

     

       25
        
               type = types.listOf types.str;

     

       26
        
               default = [];

     

       27
        
               example = [ "wlan0" "wlan1" ];

     

       28
        
               description = ''

     

       29
       +
                 The interfaces <command>wpa_supplicant</command> will use. If empty, it will

     

       30
        
                 automatically use all wireless interfaces.

     

       31
        
               '';

     

       32
        
             };

     
···

       37
        
               description = "Force a specific wpa_supplicant driver.";

     

       38
        
             };

     

       39
        
       

     

       40
       +
             networks = mkOption {

     

       41
       +
               type = types.attrsOf (types.submodule {

     

       42
       +
                 options = {

     

       43
       +
                   psk = mkOption {

     

       44
       +
                     type = types.nullOr types.str;

     

       45
       +
                     default = null;

     

       46
       +
                     description = ''

     

       47
       +
                       The network's pre-shared key in plaintext defaulting

     

       48
       +
                       to being a network without any authentication.

     

       49
       +
                     '';

     

       50
       +
                   };

     

       51
       +
                 };

     

       52
       +
               });

     

       53
       +
               description = ''

     

       54
       +
                 The network definitions to automatically connect to when

     

       55
       +
                  <command>wpa_supplicant</command> is running. If this

     

       56
       +
                  parameter is left empty wpa_supplicant will use

     

       57
       +
                 /etc/wpa_supplicant.conf as the configuration file.

     

       58
       +
               '';

     

       59
       +
               default = {};

     

       60
       +
               example = literalExample ''

     

       61
       +
                 echelon = {

     

       62
       +
                   psk = "abcdefgh";

     

       63
       +
                 };

     

       64
       +
                 "free.wifi" = {};

     

       65
       +
               '';

     

       66
       +
             };

     

       67
       +
       

     

       68
        
             userControlled = {

     

       69
        
               enable = mkOption {

     

       70
        
                 type = types.bool;

     
···

       75
        
                   to depend on a large package such as NetworkManager just to pick nearby

     

       76
        
                   access points.

     

       77
        
       

     

       78
       +
                   When using a declarative network specification you cannot persist any

     

       79
       +
                   settings via wpa_gui or wpa_cli.

     

       0
        
       
     

       0
        
       
     

       80
        
                 '';

     

       81
        
               };

     

       82
        
       

     
···

       90
        
           };

     

       91
        
         };

     

       92
        
       

     

       93
       +
         config = mkMerge [

     

       94
       +
           (mkIf cfg.enable {

     

       95
       +
             environment.systemPackages =  [ pkgs.wpa_supplicant ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       96
        
       

     

       97
       +
             services.dbus.packages = [ pkgs.wpa_supplicant ];

     

       98
        
       

     

       99
       +
             # FIXME: start a separate wpa_supplicant instance per interface.

     

       100
       +
             systemd.services.wpa_supplicant = let

     

       101
       +
               ifaces = cfg.interfaces;

     

       102
       +
             in {

     

       103
       +
               description = "WPA Supplicant";

     

       104
        
       

     

       105
        
               wantedBy = [ "network.target" ];

     

       106
        
       

     

       107
        
               path = [ pkgs.wpa_supplicant ];

     

       108
        
       

     

       109
       +
               script = ''

     

       110
       +
                 ${if ifaces == [] then ''

     

       111
       +
                   for i in $(cd /sys/class/net && echo *); do

     

       112
       +
                     DEVTYPE=

     

       113
       +
                     source /sys/class/net/$i/uevent

     

       114
       +
                     if [ "$DEVTYPE" = "wlan" -o -e /sys/class/net/$i/wireless ]; then

     

       115
       +
                       ifaces="$ifaces''${ifaces:+ -N} -i$i"

     

       116
       +
                     fi

     

       117
       +
                   done

     

       118
       +
                 '' else ''

     

       119
       +
                   ifaces="${concatStringsSep " -N " (map (i: "-i${i}") ifaces)}"

     

       120
       +
                 ''}

     

       121
       +
                 exec wpa_supplicant -s -u -D${cfg.driver} -c ${configFile} $ifaces

     

       122
        
               '';

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       123
        
             };

     

       124
        
       

     

       125
       +
             powerManagement.resumeCommands = ''

     

       0
        
       
     

       126
        
               ${config.systemd.package}/bin/systemctl try-restart wpa_supplicant

     

       127
        
             '';

     

       128
        
       

     

       129
       +
             # Restart wpa_supplicant when a wlan device appears or disappears.

     

       130
       +
             services.udev.extraRules = ''

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       131
        
               ACTION=="add|remove", SUBSYSTEM=="net", ENV{DEVTYPE}=="wlan", RUN+="${config.systemd.package}/bin/systemctl try-restart wpa_supplicant.service"

     

       132
        
             '';

     

       133
       +
           })

     

       134
       +
           {

     

       135
       +
             meta.maintainers = with lib.maintainers; [ globin ];

     

       136
       +
           }

     

       137
       +
         ];

     

       138
        
       }