Debian Codegraph @

upstream/debian-unstable/man8/pam_debug.8

raw
1 '\" t
2 .\" Title: pam_debug
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_DEBUG" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_debug \- PAM module to debug the PAM stack
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_debug\&.so\fR\ 'u
34 \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]
35 .SH "DESCRIPTION"
36 .PP
37 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\&.
38 .SH "OPTIONS"
39 .PP
40 auth=value
41 .RS 4
42 The
43 \fBpam_sm_authenticate\fR(3)
44 function will return
45 \fIvalue\fR\&.
46 .RE
47 .PP
48 cred=value
49 .RS 4
50 The
51 \fBpam_sm_setcred\fR(3)
52 function will return
53 \fIvalue\fR\&.
54 .RE
55 .PP
56 acct=value
57 .RS 4
58 The
59 \fBpam_sm_acct_mgmt\fR(3)
60 function will return
61 \fIvalue\fR\&.
62 .RE
63 .PP
64 prechauthtok=value
65 .RS 4
66 The
67 \fBpam_sm_chauthtok\fR(3)
68 function will return
69 \fIvalue\fR
70 if the
71 \fIPAM_PRELIM_CHECK\fR
72 flag is set\&.
73 .RE
74 .PP
75 chauthtok=value
76 .RS 4
77 The
78 \fBpam_sm_chauthtok\fR(3)
79 function will return
80 \fIvalue\fR
81 if the
82 \fIPAM_PRELIM_CHECK\fR
83 flag is
84 \fBnot\fR
85 set\&.
86 .RE
87 .PP
88 open_session=value
89 .RS 4
90 The
91 \fBpam_sm_open_session\fR(3)
92 function will return
93 \fIvalue\fR\&.
94 .RE
95 .PP
96 close_session=value
97 .RS 4
98 The
99 \fBpam_sm_close_session\fR(3)
100 function will return
101 \fIvalue\fR\&.
102 .RE
103 .PP
104 Where
105 \fIvalue\fR
106 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\&.
107 .SH "MODULE TYPES PROVIDED"
108 .PP
109 All module types (\fBauth\fR,
110 \fBaccount\fR,
111 \fBpassword\fR
112 and
113 \fBsession\fR) are provided\&.
114 .SH "RETURN VALUES"
115 .PP
116 PAM_SUCCESS
117 .RS 4
118 Default return code if no other value was specified, else specified return value\&.
119 .RE
120 .SH "EXAMPLES"
121 .sp
122 .if n \{\
123 .RS 4
124 .\}
125 .nf
126 auth requisite pam_permit\&.so
127 auth [success=2 default=ok] pam_debug\&.so auth=perm_denied cred=success
128 auth [default=reset] pam_debug\&.so auth=success cred=perm_denied
129 auth [success=done default=die] pam_debug\&.so
130 auth optional pam_debug\&.so auth=perm_denied cred=perm_denied
131 auth sufficient pam_debug\&.so auth=success cred=success
132
133 .fi
134 .if n \{\
135 .RE
136 .\}
137 .SH "SEE ALSO"
138 .PP
139 \fBpam.conf\fR(5),
140 \fBpam.d\fR(5),
141 \fBpam\fR(7)
142 .SH "AUTHOR"
143 .PP
144 pam_debug was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.