2e751c0772
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.
51 lines
1.2 KiB
Nix
51 lines
1.2 KiB
Nix
# This module provides configuration for the OATH PAM modules.
|
|
|
|
{ lib, ... }:
|
|
|
|
with lib;
|
|
|
|
{
|
|
options = {
|
|
|
|
security.pam.oath = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Enable the OATH (one-time password) PAM module.
|
|
'';
|
|
};
|
|
|
|
digits = mkOption {
|
|
type = types.enum [ 6 7 8 ];
|
|
default = 6;
|
|
description = lib.mdDoc ''
|
|
Specify the length of the one-time password in number of
|
|
digits.
|
|
'';
|
|
};
|
|
|
|
window = mkOption {
|
|
type = types.int;
|
|
default = 5;
|
|
description = lib.mdDoc ''
|
|
Specify the number of one-time passwords to check in order
|
|
to accommodate for situations where the system and the
|
|
client are slightly out of sync (iteration for HOTP or time
|
|
steps for TOTP).
|
|
'';
|
|
};
|
|
|
|
usersFile = mkOption {
|
|
type = types.path;
|
|
default = "/etc/users.oath";
|
|
description = lib.mdDoc ''
|
|
Set the path to file where the user's credentials are
|
|
stored. This file must not be world readable!
|
|
'';
|
|
};
|
|
};
|
|
|
|
};
|
|
}
|