summary refs log tree commit diff
path: root/nixos/modules/services/networking/wpa_supplicant.nix
blob: 5979ab7fbe3370ced4ab13d45cdd9a81eeeae8fd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
{ config, lib, pkgs, ... }:

with lib;

let
  cfg = config.networking.wireless;
  configFile = "/etc/wpa_supplicant.conf";
in {
  options = {
    networking.wireless = {
      enable = mkOption {
        type = types.bool;
        default = false;
        description = ''
          Whether to start <command>wpa_supplicant</command> to scan for
          and associate with wireless networks.  Note: NixOS currently
          does not manage <command>wpa_supplicant</command>'s
          configuration file, <filename>${configFile}</filename>.  You
          should edit this file yourself to define wireless networks,
          WPA keys and so on (see
          <citerefentry><refentrytitle>wpa_supplicant.conf</refentrytitle>
          <manvolnum>5</manvolnum></citerefentry>), or use
          networking.wireless.userControlled.* to allow users to add entries
          through <command>wpa_cli</command> and <command>wpa_gui</command>.
        '';
      };

      interfaces = mkOption {
        type = types.listOf types.str;
        default = [];
        example = [ "wlan0" "wlan1" ];
        description = ''
          The interfaces <command>wpa_supplicant</command> will use.  If empty, it will
          automatically use all wireless interfaces.
        '';
      };

      driver = mkOption {
        type = types.str;
        default = "nl80211,wext";
        description = "Force a specific wpa_supplicant driver.";
      };

      userControlled = {
        enable = mkOption {
          type = types.bool;
          default = false;
          description = ''
            Allow normal users to control wpa_supplicant through wpa_gui or wpa_cli.
            This is useful for laptop users that switch networks a lot and don't want
            to depend on a large package such as NetworkManager just to pick nearby
            access points.

            When you want to use this, make sure ${configFile} doesn't exist.
            It will be created for you.

            Currently it is also necessary to explicitly specify networking.wireless.interfaces.
          '';
        };

        group = mkOption {
          type = types.str;
          default = "wheel";
          example = "network";
          description = "Members of this group can control wpa_supplicant.";
        };
      };
    };
  };

  config = mkMerge [
    (mkIf cfg.enable {
      environment.systemPackages =  [ pkgs.wpa_supplicant ];

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

      # FIXME: start a separate wpa_supplicant instance per interface.
      systemd.services.wpa_supplicant = let
        ifaces = cfg.interfaces;
      in {
        description = "WPA Supplicant";

        wantedBy = [ "network.target" ];

        path = [ pkgs.wpa_supplicant ];

        preStart = ''
          touch -a ${configFile}
          chmod 600 ${configFile}
        '' + optionalString cfg.userControlled.enable ''
          if [ ! -s ${configFile} ]; then
            echo "ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=${cfg.userControlled.group}" >> ${configFile}
            echo "update_config=1" >> ${configFile}
          fi
        '';

        script = ''
          ${if ifaces == [] then ''
            for i in $(cd /sys/class/net && echo *); do
              DEVTYPE=
              source /sys/class/net/$i/uevent
              if [ "$DEVTYPE" = "wlan" -o -e /sys/class/net/$i/wireless ]; then
                ifaces="$ifaces''${ifaces:+ -N} -i$i"
              fi
            done
          '' else ''
            ifaces="${concatStringsSep " -N " (map (i: "-i${i}") ifaces)}"
          ''}
          exec wpa_supplicant -s -u -D${cfg.driver} -c ${configFile} $ifaces
        '';
      };

      powerManagement.resumeCommands = ''
        ${config.systemd.package}/bin/systemctl try-restart wpa_supplicant
      '';

      # Restart wpa_supplicant when a wlan device appears or disappears.
      services.udev.extraRules = ''
        ACTION=="add|remove", SUBSYSTEM=="net", ENV{DEVTYPE}=="wlan", RUN+="${config.systemd.package}/bin/systemctl try-restart wpa_supplicant.service"
      '';
    })
    {
      meta.maintainers = with lib.maintainers; [ globin ];
    }
  ];
}