diff options
Diffstat (limited to '')
| -rw-r--r-- | modules/pam_debug/pam_debug.8 | 144 | ||||
| -rw-r--r-- | modules/pam_debug/pam_debug.8.xml | 231 |
2 files changed, 375 insertions, 0 deletions
diff --git a/modules/pam_debug/pam_debug.8 b/modules/pam_debug/pam_debug.8 new file mode 100644 index 0000000..552da6b --- /dev/null +++ b/modules/pam_debug/pam_debug.8 @@ -0,0 +1,144 @@ +'\" t +.\" Title: pam_debug +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 06/08/2020 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_DEBUG" "8" "06/08/2020" "Linux-PAM Manual" "Linux\-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_debug \- PAM module to debug the PAM stack +.SH "SYNOPSIS" +.HP \w'\fBpam_debug\&.so\fR\ 'u +\fBpam_debug\&.so\fR [auth=\fIvalue\fR] [cred=\fIvalue\fR] [acct=\fIvalue\fR] [prechauthtok=\fIvalue\fR] [chauthtok=\fIvalue\fR] [auth=\fIvalue\fR] [open_session=\fIvalue\fR] [close_session=\fIvalue\fR] +.SH "DESCRIPTION" +.PP +The pam_debug PAM module is intended as a debugging aide for determining how the PAM stack is operating\&. This module returns what its module arguments tell it to return\&. +.SH "OPTIONS" +.PP +\fBauth=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_authenticate\fR(3) +function will return +\fIvalue\fR\&. +.RE +.PP +\fBcred=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_setcred\fR(3) +function will return +\fIvalue\fR\&. +.RE +.PP +\fBacct=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_acct_mgmt\fR(3) +function will return +\fIvalue\fR\&. +.RE +.PP +\fBprechauthtok=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_chauthtok\fR(3) +function will return +\fIvalue\fR +if the +\fIPAM_PRELIM_CHECK\fR +flag is set\&. +.RE +.PP +\fBchauthtok=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_chauthtok\fR(3) +function will return +\fIvalue\fR +if the +\fIPAM_PRELIM_CHECK\fR +flag is +\fBnot\fR +set\&. +.RE +.PP +\fBopen_session=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_open_session\fR(3) +function will return +\fIvalue\fR\&. +.RE +.PP +\fBclose_session=\fR\fB\fIvalue\fR\fR +.RS 4 +The +\fBpam_sm_close_session\fR(3) +function will return +\fIvalue\fR\&. +.RE +.PP +Where +\fIvalue\fR +can be one of: success, open_err, symbol_err, service_err, system_err, buf_err, perm_denied, auth_err, cred_insufficient, authinfo_unavail, user_unknown, maxtries, new_authtok_reqd, acct_expired, session_err, cred_unavail, cred_expired, cred_err, no_module_data, conv_err, authtok_err, authtok_recover_err, authtok_lock_busy, authtok_disable_aging, try_again, ignore, abort, authtok_expired, module_unknown, bad_item, conv_again, incomplete\&. +.SH "MODULE TYPES PROVIDED" +.PP +All module types (\fBauth\fR, +\fBaccount\fR, +\fBpassword\fR +and +\fBsession\fR) are provided\&. +.SH "RETURN VALUES" +.PP +PAM_SUCCESS +.RS 4 +Default return code if no other value was specified, else specified return value\&. +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +auth requisite pam_permit\&.so +auth [success=2 default=ok] pam_debug\&.so auth=perm_denied cred=success +auth [default=reset] pam_debug\&.so auth=success cred=perm_denied +auth [success=done default=die] pam_debug\&.so +auth optional pam_debug\&.so auth=perm_denied cred=perm_denied +auth sufficient pam_debug\&.so auth=success cred=success + +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBpam.conf\fR(5), +\fBpam.d\fR(5), +\fBpam\fR(8) +.SH "AUTHOR" +.PP +pam_debug was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&. diff --git a/modules/pam_debug/pam_debug.8.xml b/modules/pam_debug/pam_debug.8.xml new file mode 100644 index 0000000..3d85f4d --- /dev/null +++ b/modules/pam_debug/pam_debug.8.xml @@ -0,0 +1,231 @@ +<?xml version="1.0" encoding='UTF-8'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> + +<refentry id="pam_debug"> + + <refmeta> + <refentrytitle>pam_debug</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_debug-name"> + <refname>pam_debug</refname> + <refpurpose>PAM module to debug the PAM stack</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="pam_debug-cmdsynopsis"> + <command>pam_debug.so</command> + <arg choice="opt"> + auth=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + cred=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + acct=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + prechauthtok=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + chauthtok=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + auth=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + open_session=<replaceable>value</replaceable> + </arg> + <arg choice="opt"> + close_session=<replaceable>value</replaceable> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id="pam_debug-description"> + <title>DESCRIPTION</title> + <para> + The pam_debug PAM module is intended as a debugging aide for + determining how the PAM stack is operating. This module returns + what its module arguments tell it to return. + </para> + </refsect1> + + <refsect1 id="pam_debug-options"> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term> + <option>auth=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_authenticate</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>cred=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_setcred</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>acct=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_acct_mgmt</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>prechauthtok=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_chauthtok</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable> if the + <emphasis>PAM_PRELIM_CHECK</emphasis> flag is set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>chauthtok=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_chauthtok</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable> if the + <emphasis>PAM_PRELIM_CHECK</emphasis> flag is + <emphasis remap='B'>not</emphasis> set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>open_session=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_open_session</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>close_session=<replaceable>value</replaceable></option> + </term> + <listitem> + <para> + The + <citerefentry> + <refentrytitle>pam_sm_close_session</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function will return + <replaceable>value</replaceable>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Where <replaceable>value</replaceable> can be one of: success, + open_err, symbol_err, service_err, system_err, buf_err, perm_denied, + auth_err, cred_insufficient, authinfo_unavail, user_unknown, + maxtries, new_authtok_reqd, acct_expired, session_err, cred_unavail, + cred_expired, cred_err, no_module_data, conv_err, authtok_err, + authtok_recover_err, authtok_lock_busy, authtok_disable_aging, + try_again, ignore, abort, authtok_expired, module_unknown, + bad_item, conv_again, incomplete. + </para> + </refsect1> + + <refsect1 id="pam_debug-types"> + <title>MODULE TYPES PROVIDED</title> + <para> + All module types (<option>auth</option>, <option>account</option>, + <option>password</option> and <option>session</option>) are provided. + </para> + </refsect1> + + <refsect1 id='pam_debug-return_values'> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + Default return code if no other value was specified, + else specified return value. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='pam_debug-examples'> + <title>EXAMPLES</title> + <programlisting> +auth requisite pam_permit.so +auth [success=2 default=ok] pam_debug.so auth=perm_denied cred=success +auth [default=reset] pam_debug.so auth=success cred=perm_denied +auth [success=done default=die] pam_debug.so +auth optional pam_debug.so auth=perm_denied cred=perm_denied +auth sufficient pam_debug.so auth=success cred=success + </programlisting> + </refsect1> + + <refsect1 id='pam_debug-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> + + <refsect1 id='pam_debug-author'> + <title>AUTHOR</title> + <para> + pam_debug was written by Andrew G. Morgan <morgan@kernel.org>. + </para> + </refsect1> + +</refentry> |