Debian Codegraph @

upstream/debian-unstable/man8/pam_stress.8

raw
1 '\" t
2 .\" Title: pam_stress
3 .\" Author: [see the "AUTHORS" 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_STRESS" "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_stress \- The stress\-testing PAM module
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_stress\&.so\fR\ 'u
34 \fBpam_stress\&.so\fR [debug] [no_warn] [use_first_pass] [try_first_pass] [rootok] [expired] [fail_1] [fail_2] [prelim] [required]
35 .SH "DESCRIPTION"
36 .PP
37 The pam_stress PAM module is mainly intended to give the impression of failing as a fully functioning module might\&.
38 .SH "OPTIONS"
39 .PP
40 debug
41 .RS 4
42 Put lots of information in syslog\&. *NOTE* this option writes passwords to syslog, so don\*(Aqt use anything sensitive when testing\&.
43 .RE
44 .PP
45 no_warn
46 .RS 4
47 Do not give warnings about things (otherwise warnings are issued via the conversation function)
48 .RE
49 .PP
50 use_first_pass
51 .RS 4
52 Do not prompt for a password, for pam_sm_authentication function just use item PAM_AUTHTOK\&.
53 .RE
54 .PP
55 try_first_pass
56 .RS 4
57 Do not prompt for a password unless there has been no previous authentication token (item PAM_AUTHTOK is NULL)
58 .RE
59 .PP
60 rootok
61 .RS 4
62 This is intended for the pam_sm_chauthtok function and it instructs this function to permit root to change the user\*(Aqs password without entering the old password\&.
63 .RE
64 .PP
65 expired
66 .RS 4
67 An argument intended for the account and chauthtok module parts\&. It instructs the module to act as if the user\*(Aqs password has expired
68 .RE
69 .PP
70 fail_1
71 .RS 4
72 This instructs the module to make its first function fail\&.
73 .RE
74 .PP
75 fail_2
76 .RS 4
77 This instructs the module to make its second function (if there is one) fail\&.
78 .RE
79 .PP
80 prelim
81 .RS 4
82 For pam_sm_chauthtok, means fail on PAM_PRELIM_CHECK\&.
83 .RE
84 .PP
85 required
86 .RS 4
87 For pam_sm_chauthtok, means fail if the user hasn\*(Aqt already been authenticated by this module\&. (See stress_new_pwd data string in the NOTES\&.)
88 .RE
89 .SH "MODULE TYPES PROVIDED"
90 .PP
91 All module types (\fBauth\fR,
92 \fBaccount\fR,
93 \fBpassword\fR
94 and
95 \fBsession\fR) are provided\&.
96 .SH "RETURN VALUES"
97 .PP
98 PAM_BUF_ERR
99 .RS 4
100 Memory buffer error\&.
101 .RE
102 .PP
103 PAM_PERM_DENIED
104 .RS 4
105 Permission denied\&.
106 .RE
107 .PP
108 PAM_AUTH_ERR
109 .RS 4
110 Access to the system was denied\&.
111 .RE
112 .PP
113 PAM_CONV_ERR
114 .RS 4
115 Conversation failure\&.
116 .RE
117 .PP
118 PAM_SUCCESS
119 .RS 4
120 The function passes all checks\&.
121 .RE
122 .PP
123 PAM_USER_UNKNOWN
124 .RS 4
125 The user is not known to the system\&.
126 .RE
127 .PP
128 PAM_CRED_ERR
129 .RS 4
130 Failure involving user credentials\&.
131 .RE
132 .PP
133 PAM_NEW_AUTHTOK_REQD
134 .RS 4
135 Authentication token is no longer valid; new one required\&.
136 .RE
137 .PP
138 PAM_SESSION_ERR
139 .RS 4
140 Session failure\&.
141 .RE
142 .PP
143 PAM_TRY_AGAIN
144 .RS 4
145 Failed preliminary check by service\&.
146 .RE
147 .PP
148 PAM_AUTHTOK_LOCK_BUSY
149 .RS 4
150 Authentication token lock busy\&.
151 .RE
152 .PP
153 PAM_AUTHTOK_ERR
154 .RS 4
155 Authentication token manipulation error\&.
156 .RE
157 .PP
158 PAM_SYSTEM_ERR
159 .RS 4
160 System error\&.
161 .RE
162 .SH "NOTES"
163 .PP
164 This module uses the stress_new_pwd data string which tells pam_sm_chauthtok that pam_sm_acct_mgmt says we need a new password\&. The only possible value for this data string is \*(Aqyes\*(Aq\&.
165 .SH "EXAMPLES"
166 .sp
167 .if n \{\
168 .RS 4
169 .\}
170 .nf
171 #%PAM\-1\&.0
172 #
173 # Any of the following will suffice
174 account required pam_stress\&.so
175 auth required pam_stress\&.so
176 password required pam_stress\&.so
177 session required pam_stress\&.so
178
179 .fi
180 .if n \{\
181 .RE
182 .\}
183 .SH "SEE ALSO"
184 .PP
185 \fBpam.conf\fR(5),
186 \fBpam.d\fR(5),
187 \fBpam\fR(8)\&.
188 .SH "AUTHORS"
189 .PP
190 The pam_stress PAM module was developed by Andrew Morgan <morgan@linux\&.kernel\&.org>\&. The man page for pam_stress was written by Lucas Ramage <ramage\&.lucas@protonmail\&.com>\&.