Skip to content

Commit 257c433

Browse files
committed
Update README file and manpages
1 parent 39f2eb0 commit 257c433

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

README

+43
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,14 @@ recommended that you start a separate shell with root privileges while
108108
configuring PAM to be able to revert changes if something goes wrong.
109109
Test your configuration thoroughly before closing the root shell.
110110

111+
[[moduleArguments]]
111112
=== Module Arguments
112113

114+
The following table documents the set of arguments recognized by the module.
115+
Hard-wired defaults can be overridden by a <<confFile,configuration file>>.
116+
The definitions from the configuration file can be in turn overridden by
117+
individual files under `/etc/pam.d/`.
118+
113119
[horizontal]
114120
debug::
115121
Enables debug output
@@ -240,6 +246,13 @@ FIDO devices. It is not possible to mix native credentials and SSH
240246
credentials. Once this option is enabled all credentials will be parsed
241247
as SSH.
242248

249+
conf_file=file::
250+
Set an alternative location for the <<confFile,configuration file>>.
251+
The supplied path must be absolute, and must correspond to an existing
252+
regular file.
253+
The specified path is not allowed to be missing, but it
254+
can be empty.
255+
243256
IMPORTANT: On dynamic networks (e.g. where hostnames are set by DHCP),
244257
users should not rely on the default origin and appid
245258
("pam://$HOSTNAME") but set those parameters explicitly to the same
@@ -404,6 +417,36 @@ defined in the authorization mapping file. If during an authentication attempt
404417
a connected device is removed or a new device is plugged in, the authentication
405418
restarts from the top of the list.
406419

420+
[[confFile]]
421+
== Configuration file
422+
423+
A configuration file can be supplied in order to provide system-level default
424+
values for the `pam_u2f.so` module arguments.
425+
426+
- The file can contain the same arguments as <<moduleArguments,defined above>>,
427+
one per line.
428+
429+
- The `conf_file=` argument, which can only appear under `/etc/pam.d/`.
430+
431+
- Lines starting with `#` are interpreted as comments and skipped together with
432+
empty lines.
433+
434+
- Heading white-spaces (intended as in `isspace(3)`) are ignored. Everything
435+
from the first non-white-space character till the end of line is interpreted
436+
verbatim.
437+
438+
- Square brackets around arguments, needed under `/etc/pam.d` to get spaces
439+
correctly recognized, must not be supplied.
440+
441+
The default path of the system-level configuration file is
442+
`/etc/security/pam_u2f.conf`. The file is allowed to be missing or empty, in
443+
which case the `pam_u2f.so` configuration will default to the hard-wired
444+
values.
445+
446+
Individual files under `/etc/pam.d/` can specify a different configuration file
447+
by means of the `conf_file=` argument. Doing so will not affect other
448+
`/etc/pam.d/` files.
449+
407450
== SELinux Note
408451

409452
Due to an issue with Fedora Linux, and possibly with other

man/pam_u2f.8.txt

+38
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ will be ignored.
8888
Set to prompt a message and wait before testing the presence of a U2F
8989
device. Recommended if your device doesn't have tactile trigger.
9090

91+
9192
*[prompt=your prompt here]*::
9293
Set individual prompt message for interactive mode. Watch the square
9394
brackets around this parameter to get spaces correctly recognized by
@@ -134,6 +135,14 @@ FIDO devices. It is not possible to mix native credentials and SSH
134135
credentials. Once this option is enabled all credentials will be parsed
135136
as SSH.
136137

138+
*conf_file*=_path_::
139+
Set an alternative location for the configuration file.
140+
The supplied path must be absolute, and must correspond to an existing
141+
regular file.
142+
The specified path is not allowed to be missing, but it
143+
can be empty.
144+
See *CONFIGURATION FILE*.
145+
137146
== EXAMPLES
138147

139148
Second factor authentication deferring user verification configuration to the
@@ -162,6 +171,35 @@ mapping file in an encrypted home directory, will result in the
162171
impossibility of logging into the system. The partition is decrypted
163172
after login and the mapping file can not be accessed.
164173

174+
== CONFIGURATION FILE
175+
A configuration file can be supplied in order to provide system-level default
176+
values for the `pam_u2f.so` module arguments.
177+
178+
- The file can contain the same arguments as <<moduleArguments,defined above>>,
179+
one per line.
180+
181+
- The `conf_file=` argument, which can only appear under `/etc/pam.d/`.
182+
183+
- Lines starting with `#` are interpreted as comments and skipped together with
184+
empty lines.
185+
186+
- Heading white-spaces (intended as in `isspace(3)`) are ignored. Everything
187+
from the first non-white-space character till the end of line is interpreted
188+
verbatim.
189+
190+
- Square brackets around arguments, needed under `/etc/pam.d` to get spaces
191+
correctly recognized, must not be supplied.
192+
193+
The default path of the system-level configuration file is
194+
`/etc/security/pam_u2f.conf`. The file is allowed to be missing or empty, in
195+
which case the `pam_u2f.so` configuration will default to the hard-wired
196+
values.
197+
198+
Individual files under `/etc/pam.d/` can specify a different configuration file
199+
by means of the `conf_file=` argument. Doing so will not affect other
200+
`/etc/pam.d/` files.
201+
202+
165203
== NOTES
166204

167205
*Nodetect*

0 commit comments

Comments
 (0)