Skip to content

Commit

Permalink
man: update with info about conf file
Browse files Browse the repository at this point in the history
The SCONFDIR variable is expanded by the build system within
the pam_u2f.8 manpage.
  • Loading branch information
dacav committed Jan 23, 2025
1 parent f56790e commit 1a9a44a
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ m4/ltsugar.m4
m4/ltversion.m4
m4/lt~obsolete.m4
man/pam_u2f.8
man/pam_u2f.8.txt
man/pamu2fcfg.1
pamu2fcfg/cmdline.c
pamu2fcfg/cmdline.h
Expand Down
1 change: 1 addition & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ AC_CONFIG_FILES([
tests/Makefile
fuzz/Makefile
man/Makefile
man/pam_u2f.8.txt
])

creduser=$(whoami)
Expand Down
1 change: 1 addition & 0 deletions man/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ dist_man1_MANS = pamu2fcfg.1
dist_man8_MANS = pam_u2f.8
MAINTAINERCLEANFILES = $(MANS)
EXTRA_DIST = $(MANS:=.txt)
DISTCLEANFILES = pam_u2f.8

SUFFIXES = .1.txt .1 .8.txt .8

Expand Down
28 changes: 28 additions & 0 deletions man/pam_u2f.8.txt → man/pam_u2f.8.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ FIDO devices. It is not possible to mix native credentials and SSH
credentials. Once this option is enabled all credentials will be parsed
as SSH.

*conf*=_path/to/pam_u2f.conf_::
Set an alternative location for the configuration file.
The supplied path must be absolute and must correspond to an existing
regular file.
See *CONFIGURATION FILE*.

== EXAMPLES

Second factor authentication deferring user verification configuration to the
Expand Down Expand Up @@ -162,6 +168,28 @@ mapping file in an encrypted home directory, will result in the
impossibility of logging into the system. The partition is decrypted
after login and the mapping file can not be accessed.

== CONFIGURATION FILE

A configuration file can be used to set the default module arguments.

- The file has a `name = value` format, with comments starting with the `#`
character.

- White spaces at the beginning of line, end of line, and around the `=` sign
are ignored.

- Any `conf` argument in the configuration file is ignored.

- The maximum size for the configuration file is 4 KiB.

- The default path for the configuration file is `@SCONFDIR@/pam_u2f.conf`.
Note that it may have been set to another value by the distribution. The
default file is allowed to not exist. An alternative path may be set in the
module command line options.

- The options specified on the module command line override the values from the
configuration file.

== NOTES

*Nodetect*
Expand Down

0 comments on commit 1a9a44a

Please sign in to comment.