diff options
| author | Dmitry V. Levin <ldv@altlinux.org> | 2020-05-17 08:00:00 +0000 |
|---|---|---|
| committer | Dmitry V. Levin <ldv@altlinux.org> | 2020-05-17 23:59:12 +0000 |
| commit | 2e16ac35a0a535d394931711186b4f90e67b91ed (patch) | |
| tree | eefb9ebb386fed468658ac7e89f5752df12e2408 | |
| parent | 68a24e9204aa7e0eef9e725de53b018f7abdf716 (diff) | |
doc: fix the description of stack jump effects
Every stack jump, besides the jump itself, has a side effect which is
one of 'ignore', 'ok', or 'bad'. Unfortunately, the side effect is far
from obvious because it depends on the PAM function call, and the
documentation that contradicts the implementation does not help either.
* doc/man/pam.conf-syntax.xml (actionN): Rewrite the description
of stack jump effects to match the implementation.
Fixes: 871a6e14d65c3c446ae0af51166dabc7a47a2b56
| -rw-r--r-- | doc/man/pam.conf-syntax.xml | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/man/pam.conf-syntax.xml b/doc/man/pam.conf-syntax.xml index da7cfb70..7b4edbf2 100644 --- a/doc/man/pam.conf-syntax.xml +++ b/doc/man/pam.conf-syntax.xml @@ -306,9 +306,19 @@ <term>N (an unsigned integer)</term> <listitem> <para> - equivalent to ok with the side effect of jumping over the - next N modules in the stack. Note that N equal to 0 is not - allowed (and it would be identical to ok in such case). + jump over the next N modules in the stack. + Note that N equal to 0 is not allowed, + it would be treated as <emphasis>ignore</emphasis> in such case. + The side effect depends on the PAM function call: + for <emphasis>pam_authenticate</emphasis>, + <emphasis>pam_acct_mgmt</emphasis>, + <emphasis>pam_chauthtok</emphasis>, and + <emphasis>pam_open_session</emphasis> + it is <emphasis>ignore</emphasis>; + for <emphasis>pam_setcred</emphasis> and + <emphasis>pam_close_session</emphasis> it is + one of <emphasis>ignore</emphasis>, <emphasis>ok</emphasis>, + or <emphasis>bad</emphasis> depending on the module's return value. </para> </listitem> </varlistentry> |