1 .\" Copyright (c) 2001,2003 Networks Associates Technology, Inc.
2 .\" Copyright (c) 2017 Dag-Erling Smørgrav
3 .\" Copyright (c) 2018 Thomas Munro
4 .\" All rights reserved.
6 .\" Portions of this software were developed for the FreeBSD Project by
7 .\" ThinkSec AS and NAI Labs, the Security Research Division of Network
8 .\" Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. The name of the author may not be used to endorse or promote
20 .\" products derived from this software without specific prior written
23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 The exec service module for PAM executes the program designated by
51 its first argument if no options are specified, with its remaining
52 arguments as command-line arguments.
53 If options are specified, the program and its arguments follow the last
56 if the program name conflicts with an option name.
58 The following options may be passed before the program and its
60 .Bl -tag -width indent
62 Capture text printed by the program to its standard error stream and
63 pass it to the conversation function as error messages.
64 No attempt is made at buffering the text, so results may vary.
66 Capture text printed by the program to its standard output stream and
67 pass it to the conversation function as informational messages.
68 No attempt is made at buffering the text, so results may vary.
70 Ignored for compatibility reasons.
72 Ignored for compatibility reasons.
73 .It Cm return_prog_exit_status
74 Use the program exit status as the return code of the pam_sm_* function.
75 It must be a valid return value for this function.
77 Write the authentication token to the program's standard input stream,
78 followed by a NUL character.
81 program and its arguments follow.
84 The child's environment is set to the current PAM environment list,
86 .Xr pam_getenvlist 3 .
87 In addition, the following PAM items are exported as environment
99 variable contains the name of the PAM service module function being
102 .Bl -dash -offset indent -compact
118 .Cm return_prog_exit_status
119 is not set (default), the
123 if the program exit status is 0,
128 .Cm return_prog_exit_status
129 is set, the program exit status is used.
132 or one of the error codes allowed by the calling
135 The valid codes are documented in each function man page.
136 If the exit status is not a valid return code,
139 Each valid codes numerical value is available as an environment variable
142 .Ev PAM_USER_UNKNOWN ,
144 This is useful in shell scripts for instance.
149 .Xr pam_sm_acct_mgmt 8 ,
150 .Xr pam_sm_authenticate 8 ,
151 .Xr pam_sm_chauthtok 8 ,
152 .Xr pam_sm_close_session 8 ,
153 .Xr pam_sm_open_session 8 ,
158 module and this manual page were developed for the
161 ThinkSec AS and NAI Labs, the Security Research Division of Network
162 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
164 as part of the DARPA CHATS research program.