Import Linux-PAM.
[profile/ivi/pam.git] / modules / pam_debug / pam_debug.8
1 .\"     Title: pam_debug
2 .\"    Author: [see the "AUTHOR" section]
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\"      Date: 06/21/2011
5 .\"    Manual: Linux-PAM Manual
6 .\"    Source: Linux-PAM Manual
7 .\"  Language: English
8 .\"
9 .TH "PAM_DEBUG" "8" "06/21/2011" "Linux-PAM Manual" "Linux\-PAM Manual"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 \." make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 \." make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 pam_debug \- PAM module to debug the PAM stack
171 .SH "Synopsis"
172 .fam C
173 .HP \w'\fBpam_debug\&.so\fR\ 'u
174 \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]
175 .fam
176 .SH "DESCRIPTION"
177 .PP
178 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\&.
179 .SH "OPTIONS"
180 .PP
181 \fBauth=\fR\fB\fIvalue\fR\fR
182 .RS 4
183 The
184 \fBpam_sm_authenticate\fR(3)
185 function will return
186 \fIvalue\fR\&.
187 .RE
188 .PP
189 \fBcred=\fR\fB\fIvalue\fR\fR
190 .RS 4
191 The
192 \fBpam_sm_setcred\fR(3)
193 function will return
194 \fIvalue\fR\&.
195 .RE
196 .PP
197 \fBacct=\fR\fB\fIvalue\fR\fR
198 .RS 4
199 The
200 \fBpam_sm_acct_mgmt\fR(3)
201 function will return
202 \fIvalue\fR\&.
203 .RE
204 .PP
205 \fBprechauthtok=\fR\fB\fIvalue\fR\fR
206 .RS 4
207 The
208 \fBpam_sm_chauthtok\fR(3)
209 function will return
210 \fIvalue\fR
211 if the
212 \fIPAM_PRELIM_CHECK\fR
213 flag is set\&.
214 .RE
215 .PP
216 \fBchauthtok=\fR\fB\fIvalue\fR\fR
217 .RS 4
218 The
219 \fBpam_sm_chauthtok\fR(3)
220 function will return
221 \fIvalue\fR
222 if the
223 \fIPAM_PRELIM_CHECK\fR
224 flag is
225 \fBnot\fR
226 set\&.
227 .RE
228 .PP
229 \fBopen_session=\fR\fB\fIvalue\fR\fR
230 .RS 4
231 The
232 \fBpam_sm_open_session\fR(3)
233 function will return
234 \fIvalue\fR\&.
235 .RE
236 .PP
237 \fBclose_session=\fR\fB\fIvalue\fR\fR
238 .RS 4
239 The
240 \fBpam_sm_close_session\fR(3)
241 function will return
242 \fIvalue\fR\&.
243 .RE
244 .PP
245 Where
246 \fIvalue\fR
247 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\&.
248 .SH "MODULE TYPES PROVIDED"
249 .PP
250 All module types (\fBauth\fR,
251 \fBaccount\fR,
252 \fBpassword\fR
253 and
254 \fBsession\fR) are provided\&.
255 .SH "RETURN VALUES"
256 .PP
257 PAM_SUCCESS
258 .RS 4
259 Default return code if no other value was specified, else specified return value\&.
260 .RE
261 .SH "EXAMPLES"
262 .sp
263 .if n \{\
264 .RS 4
265 .\}
266 .fam C
267 .ps -1
268 .nf
269 .if t \{\
270 .sp -1
271 .\}
272 .BB lightgray adjust-for-leading-newline
273 .sp -1
274
275 auth    requisite       pam_permit\&.so
276 auth    [success=2 default=ok]  pam_debug\&.so auth=perm_denied cred=success
277 auth    [default=reset]         pam_debug\&.so auth=success cred=perm_denied
278 auth    [success=done default=die] pam_debug\&.so
279 auth    optional        pam_debug\&.so auth=perm_denied cred=perm_denied
280 auth    sufficient      pam_debug\&.so auth=success cred=success
281     
282 .EB lightgray adjust-for-leading-newline
283 .if t \{\
284 .sp 1
285 .\}
286 .fi
287 .fam
288 .ps +1
289 .if n \{\
290 .RE
291 .\}
292 .SH "SEE ALSO"
293 .PP
294
295 \fBpam.conf\fR(5),
296 \fBpam.d\fR(5),
297 \fBpam\fR(8)
298 .SH "AUTHOR"
299 .PP
300 pam_debug was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.