summaryrefslogtreecommitdiff
path: root/modules/pam_debug/pam_debug.8
blob: b3e68e21da6814814456fe3055beeb8b741807c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
'\" t
.\"     Title: pam_debug
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 09/03/2021
.\"    Manual: Linux-PAM Manual
.\"    Source: Linux-PAM Manual
.\"  Language: English
.\"
.TH "PAM_DEBUG" "8" "09/03/2021" "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>\&.