Skip to content

Commit

Permalink
squash! Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
dacav committed Dec 16, 2024
1 parent 0096fbd commit 611e678
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 31 deletions.
39 changes: 21 additions & 18 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,9 @@ Test your configuration thoroughly before closing the root shell.
=== Module Arguments

The following table documents the set of arguments recognized by the module.
Defaults values are hard-wired, but they can be overridden by a
<<confFile,configuration file>>, if any is found.
The definitions from the configuration file can be in turn overridden by
individual files under `/etc/pam.d/`.
Hard-wired defaults can be overridden by a <<confFile,configuration file>>,
if any is found. The definitions from the configuration file can be in turn
overridden by individual files under `/etc/pam.d/`.

[horizontal]
debug::
Expand Down Expand Up @@ -419,25 +418,29 @@ restarts from the top of the list.
[[confFile]]
== Configuration file

A global configuration file can be supplied in order to override
the hard-wired defaults for the `pam_u2f.so` module arguments.
A configuration file can be supplied to provide system-level default values for
the `pam_u2f.so` module arguments.

The file can contain the same arguments as
<<moduleArguments,defined above>> with a few caveats:
- The `conf_file=` argument is special, in that it can only appear in a file
under `/etc/pam.d/`, and not in the `pam_u2f.so` configuration file itself.
- Brackets around arguments are *not* needed in order to get spaces correctly
recognized.
The file can contain, one per line, the same arguments as
<<moduleArguments,defined above>>, with the following caveats:

Arguments appear one per line.
Heading whitespaces are ignored.
Lines starting with `#` and empty lines are interpreted as comments.
- The `conf_file=` argument can only appear in a file under `/etc/pam.d/`, and
not in the `pam_u2f.so` configuration file itself.

The default position of the configuration file is
- Square brackets around arguments, needed under `/etc/pam.d` to get spaces
correctly recognized, must not be supplied.

Lines starting with `#` are interpreted as comments and skipped together with
empty lines.
Heading white-spaces (intended as in `isspace(3)`) are ignored. Everything
from the first non-white-space character till the end of line is interpreted
verbatim.

The default file-system location of the configuration file is
`/etc/security/pam_u2f.conf`.
Individual files under `/etc/pam.d/` can override such path
file by means of the `conf_file=` argument.
The override will not affect other `/etc/pam.d/` files.
by means of the `conf_file=` argument, with no side effect on
other `/etc/pam.d/` files.

== SELinux Note

Expand Down
31 changes: 18 additions & 13 deletions man/pam_u2f.8.txt
Original file line number Diff line number Diff line change
Expand Up @@ -169,24 +169,29 @@ impossibility of logging into the system. The partition is decrypted
after login and the mapping file can not be accessed.

== CONFIGURATION FILE
A global configuration file can be supplied in order to override
the hard-wired defaults for the `pam_u2f.so` module arguments.
A configuration file can be supplied to provide system-level default
values for the `pam_u2f.so` module arguments.

The file can contain the same arguments as defined above, with a few caveats:
- The `conf_file=` argument is special, in that it can only appear in a file
under `/etc/pam.d/`, and not in the `pam_u2f.so` configuration file itself.
- Brackets around arguments are *not* needed in order to get spaces correctly
recognized.
The file can contain, one per line, the same arguments as defined in the *OPTIONS*
section above, with the following caveats:

Arguments appear one per line.
Heading whitespaces are ignored.
Lines starting with `#` and empty lines are interpreted as comments.
- The `conf_file=` argument can only appear in a file under `/etc/pam.d/`, and
not in the `pam_u2f.so` configuration file itself.

The default position of the configuration file is
- Square brackets around arguments, needed under `/etc/pam.d` to get spaces
correctly recognized, must not be supplied.

Lines starting with `#` are interpreted as comments and skipped together with
empty lines.
Heading white-spaces (intended as in `isspace(3)`) are ignored. Everything
from the first non-white-space character till the end of line is interpreted
verbatim.

The default file-system location of the configuration file is
`/etc/security/pam_u2f.conf`.
Individual files under `/etc/pam.d/` can override such path
file by means of the `conf_file=` argument.
The override will not affect other `/etc/pam.d/` files.
by means of the `conf_file=` argument, with no side effect on
other `/etc/pam.d/` files.

== NOTES

Expand Down

0 comments on commit 611e678

Please sign in to comment.