the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
241 lines
8.9 KiB
Nix
241 lines
8.9 KiB
Nix
{ config, lib, utils, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.networking.supplicant;
|
|
|
|
# We must escape interfaces due to the systemd interpretation
|
|
subsystemDevice = interface:
|
|
"sys-subsystem-net-devices-${utils.escapeSystemdPath interface}.device";
|
|
|
|
serviceName = iface: "supplicant-${if (iface=="WLAN") then "wlan@" else (
|
|
if (iface=="LAN") then "lan@" else (
|
|
if (iface=="DBUS") then "dbus"
|
|
else (replaceChars [" "] ["-"] iface)))}";
|
|
|
|
# TODO: Use proper privilege separation for wpa_supplicant
|
|
supplicantService = iface: suppl:
|
|
let
|
|
deps = (if (iface=="WLAN"||iface=="LAN") then ["sys-subsystem-net-devices-%i.device"] else (
|
|
if (iface=="DBUS") then ["dbus.service"]
|
|
else (map subsystemDevice (splitString " " iface))))
|
|
++ optional (suppl.bridge!="") (subsystemDevice suppl.bridge);
|
|
|
|
ifaceArg = concatStringsSep " -N " (map (i: "-i${i}") (splitString " " iface));
|
|
driverArg = optionalString (suppl.driver != null) "-D${suppl.driver}";
|
|
bridgeArg = optionalString (suppl.bridge!="") "-b${suppl.bridge}";
|
|
confFileArg = optionalString (suppl.configFile.path!=null) "-c${suppl.configFile.path}";
|
|
extraConfFile = pkgs.writeText "supplicant-extra-conf-${replaceChars [" "] ["-"] iface}" ''
|
|
${optionalString suppl.userControlled.enable "ctrl_interface=DIR=${suppl.userControlled.socketDir} GROUP=${suppl.userControlled.group}"}
|
|
${optionalString suppl.configFile.writable "update_config=1"}
|
|
${suppl.extraConf}
|
|
'';
|
|
in
|
|
{ description = "Supplicant ${iface}${optionalString (iface=="WLAN"||iface=="LAN") " %I"}";
|
|
wantedBy = [ "multi-user.target" ] ++ deps;
|
|
wants = [ "network.target" ];
|
|
bindsTo = deps;
|
|
after = deps;
|
|
before = [ "network.target" ];
|
|
|
|
path = [ pkgs.coreutils ];
|
|
|
|
preStart = ''
|
|
${optionalString (suppl.configFile.path!=null && suppl.configFile.writable) ''
|
|
(umask 077 && touch -a "${suppl.configFile.path}")
|
|
''}
|
|
${optionalString suppl.userControlled.enable ''
|
|
install -dm770 -g "${suppl.userControlled.group}" "${suppl.userControlled.socketDir}"
|
|
''}
|
|
'';
|
|
|
|
serviceConfig.ExecStart = "${pkgs.wpa_supplicant}/bin/wpa_supplicant -s ${driverArg} ${confFileArg} -I${extraConfFile} ${bridgeArg} ${suppl.extraCmdArgs} ${if (iface=="WLAN"||iface=="LAN") then "-i%I" else (if (iface=="DBUS") then "-u" else ifaceArg)}";
|
|
|
|
};
|
|
|
|
|
|
in
|
|
|
|
{
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
networking.supplicant = mkOption {
|
|
type = with types; attrsOf (submodule {
|
|
options = {
|
|
|
|
configFile = {
|
|
|
|
path = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
example = literalExpression "/etc/wpa_supplicant.conf";
|
|
description = lib.mdDoc ''
|
|
External `wpa_supplicant.conf` configuration file.
|
|
The configuration options defined declaratively within `networking.supplicant` have
|
|
precedence over options defined in `configFile`.
|
|
'';
|
|
};
|
|
|
|
writable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether the configuration file at `configFile.path` should be written to by
|
|
`wpa_supplicant`.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
extraConf = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
example = ''
|
|
ap_scan=1
|
|
device_name=My-NixOS-Device
|
|
device_type=1-0050F204-1
|
|
driver_param=use_p2p_group_interface=1
|
|
disable_scan_offload=1
|
|
p2p_listen_reg_class=81
|
|
p2p_listen_channel=1
|
|
p2p_oper_reg_class=81
|
|
p2p_oper_channel=1
|
|
manufacturer=NixOS
|
|
model_name=NixOS_Unstable
|
|
model_number=2015
|
|
'';
|
|
description = lib.mdDoc ''
|
|
Configuration options for `wpa_supplicant.conf`.
|
|
Options defined here have precedence over options in `configFile`.
|
|
NOTE: Do not write sensitive data into `extraConf` as it will
|
|
be world-readable in the `nix-store`. For sensitive information
|
|
use the `configFile` instead.
|
|
'';
|
|
};
|
|
|
|
extraCmdArgs = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
example = "-e/run/wpa_supplicant/entropy.bin";
|
|
description =
|
|
lib.mdDoc "Command line arguments to add when executing `wpa_supplicant`.";
|
|
};
|
|
|
|
driver = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = "nl80211,wext";
|
|
description = lib.mdDoc "Force a specific wpa_supplicant driver.";
|
|
};
|
|
|
|
bridge = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
description = lib.mdDoc "Name of the bridge interface that wpa_supplicant should listen at.";
|
|
};
|
|
|
|
userControlled = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
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.
|
|
'';
|
|
};
|
|
|
|
socketDir = mkOption {
|
|
type = types.str;
|
|
default = "/run/wpa_supplicant";
|
|
description = lib.mdDoc "Directory of sockets for controlling wpa_supplicant.";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "wheel";
|
|
example = "network";
|
|
description = lib.mdDoc "Members of this group can control wpa_supplicant.";
|
|
};
|
|
|
|
};
|
|
};
|
|
});
|
|
|
|
default = { };
|
|
|
|
example = literalExpression ''
|
|
{ "wlan0 wlan1" = {
|
|
configFile.path = "/etc/wpa_supplicant.conf";
|
|
userControlled.group = "network";
|
|
extraConf = '''
|
|
ap_scan=1
|
|
p2p_disabled=1
|
|
''';
|
|
extraCmdArgs = "-u -W";
|
|
bridge = "br0";
|
|
};
|
|
}
|
|
'';
|
|
|
|
description = lib.mdDoc ''
|
|
Interfaces for which to start {command}`wpa_supplicant`.
|
|
The supplicant is used to scan for and associate with wireless networks,
|
|
or to authenticate with 802.1x capable network switches.
|
|
|
|
The value of this option is an attribute set. Each attribute configures a
|
|
{command}`wpa_supplicant` service, where the attribute name specifies
|
|
the name of the interface that {command}`wpa_supplicant` operates on.
|
|
The attribute name can be a space separated list of interfaces.
|
|
The attribute names `WLAN`, `LAN` and `DBUS`
|
|
have a special meaning. `WLAN` and `LAN` are
|
|
configurations for universal {command}`wpa_supplicant` service that is
|
|
started for each WLAN interface or for each LAN interface, respectively.
|
|
`DBUS` defines a device-unrelated {command}`wpa_supplicant`
|
|
service that can be accessed through `D-Bus`.
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = mkIf (cfg != {}) {
|
|
|
|
environment.systemPackages = [ pkgs.wpa_supplicant ];
|
|
|
|
services.dbus.packages = [ pkgs.wpa_supplicant ];
|
|
|
|
systemd.services = mapAttrs' (n: v: nameValuePair (serviceName n) (supplicantService n v)) cfg;
|
|
|
|
services.udev.packages = [
|
|
(pkgs.writeTextFile {
|
|
name = "99-zzz-60-supplicant.rules";
|
|
destination = "/etc/udev/rules.d/99-zzz-60-supplicant.rules";
|
|
text = ''
|
|
${flip (concatMapStringsSep "\n") (filter (n: n!="WLAN" && n!="LAN" && n!="DBUS") (attrNames cfg)) (iface:
|
|
flip (concatMapStringsSep "\n") (splitString " " iface) (i: ''
|
|
ACTION=="add", SUBSYSTEM=="net", ENV{INTERFACE}=="${i}", TAG+="systemd", ENV{SYSTEMD_WANTS}+="supplicant-${replaceChars [" "] ["-"] iface}.service", TAG+="SUPPLICANT_ASSIGNED"''))}
|
|
|
|
${optionalString (hasAttr "WLAN" cfg) ''
|
|
ACTION=="add", SUBSYSTEM=="net", ENV{DEVTYPE}=="wlan", TAG!="SUPPLICANT_ASSIGNED", TAG+="systemd", PROGRAM="/run/current-system/systemd/bin/systemd-escape -p %E{INTERFACE}", ENV{SYSTEMD_WANTS}+="supplicant-wlan@$result.service"
|
|
''}
|
|
${optionalString (hasAttr "LAN" cfg) ''
|
|
ACTION=="add", SUBSYSTEM=="net", ENV{DEVTYPE}=="lan", TAG!="SUPPLICANT_ASSIGNED", TAG+="systemd", PROGRAM="/run/current-system/systemd/bin/systemd-escape -p %E{INTERFACE}", ENV{SYSTEMD_WANTS}+="supplicant-lan@$result.service"
|
|
''}
|
|
'';
|
|
})];
|
|
|
|
};
|
|
|
|
}
|
|
|