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.
220 lines
6.1 KiB
Nix
220 lines
6.1 KiB
Nix
{ config, lib, pkgs, utils, ... }:
|
|
|
|
# TODO:
|
|
#
|
|
# asserts
|
|
# ensure that the nl80211 module is loaded/compiled in the kernel
|
|
# wpa_supplicant and hostapd on the same wireless interface doesn't make any sense
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.services.hostapd;
|
|
|
|
escapedInterface = utils.escapeSystemdPath cfg.interface;
|
|
|
|
configFile = pkgs.writeText "hostapd.conf" ''
|
|
interface=${cfg.interface}
|
|
driver=${cfg.driver}
|
|
ssid=${cfg.ssid}
|
|
hw_mode=${cfg.hwMode}
|
|
channel=${toString cfg.channel}
|
|
${optionalString (cfg.countryCode != null) "country_code=${cfg.countryCode}"}
|
|
${optionalString (cfg.countryCode != null) "ieee80211d=1"}
|
|
|
|
# logging (debug level)
|
|
logger_syslog=-1
|
|
logger_syslog_level=${toString cfg.logLevel}
|
|
logger_stdout=-1
|
|
logger_stdout_level=${toString cfg.logLevel}
|
|
|
|
ctrl_interface=/run/hostapd
|
|
ctrl_interface_group=${cfg.group}
|
|
|
|
${optionalString cfg.wpa ''
|
|
wpa=2
|
|
wpa_passphrase=${cfg.wpaPassphrase}
|
|
''}
|
|
${optionalString cfg.noScan "noscan=1"}
|
|
|
|
${cfg.extraConfig}
|
|
'' ;
|
|
|
|
in
|
|
|
|
{
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
services.hostapd = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Enable putting a wireless interface into infrastructure mode,
|
|
allowing other wireless devices to associate with the wireless
|
|
interface and do wireless networking. A simple access point will
|
|
{option}`enable hostapd.wpa`,
|
|
{option}`hostapd.wpaPassphrase`, and
|
|
{option}`hostapd.ssid`, as well as DHCP on the wireless
|
|
interface to provide IP addresses to the associated stations, and
|
|
NAT (from the wireless interface to an upstream interface).
|
|
'';
|
|
};
|
|
|
|
interface = mkOption {
|
|
default = "";
|
|
example = "wlp2s0";
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
The interfaces {command}`hostapd` will use.
|
|
'';
|
|
};
|
|
|
|
noScan = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Do not scan for overlapping BSSs in HT40+/- mode.
|
|
Caution: turning this on will violate regulatory requirements!
|
|
'';
|
|
};
|
|
|
|
driver = mkOption {
|
|
default = "nl80211";
|
|
example = "hostapd";
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
Which driver {command}`hostapd` will use.
|
|
Most applications will probably use the default.
|
|
'';
|
|
};
|
|
|
|
ssid = mkOption {
|
|
default = "nixos";
|
|
example = "mySpecialSSID";
|
|
type = types.str;
|
|
description = lib.mdDoc "SSID to be used in IEEE 802.11 management frames.";
|
|
};
|
|
|
|
hwMode = mkOption {
|
|
default = "g";
|
|
type = types.enum [ "a" "b" "g" ];
|
|
description = lib.mdDoc ''
|
|
Operation mode.
|
|
(a = IEEE 802.11a, b = IEEE 802.11b, g = IEEE 802.11g).
|
|
'';
|
|
};
|
|
|
|
channel = mkOption {
|
|
default = 7;
|
|
example = 11;
|
|
type = types.int;
|
|
description = lib.mdDoc ''
|
|
Channel number (IEEE 802.11)
|
|
Please note that some drivers do not use this value from
|
|
{command}`hostapd` and the channel will need to be configured
|
|
separately with {command}`iwconfig`.
|
|
'';
|
|
};
|
|
|
|
group = mkOption {
|
|
default = "wheel";
|
|
example = "network";
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
Members of this group can control {command}`hostapd`.
|
|
'';
|
|
};
|
|
|
|
wpa = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Enable WPA (IEEE 802.11i/D3.0) to authenticate with the access point.
|
|
'';
|
|
};
|
|
|
|
wpaPassphrase = mkOption {
|
|
default = "my_sekret";
|
|
example = "any_64_char_string";
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
WPA-PSK (pre-shared-key) passphrase. Clients will need this
|
|
passphrase to associate with this access point.
|
|
Warning: This passphrase will get put into a world-readable file in
|
|
the Nix store!
|
|
'';
|
|
};
|
|
|
|
logLevel = mkOption {
|
|
default = 2;
|
|
type = types.int;
|
|
description = lib.mdDoc ''
|
|
Levels (minimum value for logged events):
|
|
0 = verbose debugging
|
|
1 = debugging
|
|
2 = informational messages
|
|
3 = notification
|
|
4 = warning
|
|
'';
|
|
};
|
|
|
|
countryCode = mkOption {
|
|
default = null;
|
|
example = "US";
|
|
type = with types; nullOr str;
|
|
description = lib.mdDoc ''
|
|
Country code (ISO/IEC 3166-1). Used to set regulatory domain.
|
|
Set as needed to indicate country in which device is operating.
|
|
This can limit available channels and transmit power.
|
|
These two octets are used as the first two octets of the Country String
|
|
(dot11CountryString).
|
|
If set this enables IEEE 802.11d. This advertises the countryCode and
|
|
the set of allowed channels and transmit power levels based on the
|
|
regulatory limits.
|
|
'';
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
default = "";
|
|
example = ''
|
|
auth_algo=0
|
|
ieee80211n=1
|
|
ht_capab=[HT40-][SHORT-GI-40][DSSS_CCK-40]
|
|
'';
|
|
type = types.lines;
|
|
description = lib.mdDoc "Extra configuration options to put in hostapd.conf.";
|
|
};
|
|
};
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
environment.systemPackages = [ pkgs.hostapd ];
|
|
|
|
services.udev.packages = optional (cfg.countryCode != null) [ pkgs.crda ];
|
|
|
|
systemd.services.hostapd =
|
|
{ description = "hostapd wireless AP";
|
|
|
|
path = [ pkgs.hostapd ];
|
|
after = [ "sys-subsystem-net-devices-${escapedInterface}.device" ];
|
|
bindsTo = [ "sys-subsystem-net-devices-${escapedInterface}.device" ];
|
|
requiredBy = [ "network-link-${cfg.interface}.service" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
serviceConfig =
|
|
{ ExecStart = "${pkgs.hostapd}/bin/hostapd ${configFile}";
|
|
Restart = "always";
|
|
};
|
|
};
|
|
};
|
|
}
|