2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
4 .\" All rights reserved.
6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
7 .\" Network Associates Laboratories, the Security Research Division of
8 .\" Network 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
42 .Nd substitute PAM item values in a string
47 .In security/pam_appl.h
48 .In security/openpam.h
50 .Fn openpam_subst "const pam_handle_t *pamh" "char *buf" "size_t *bufsize" "const char *template"
54 function expands a string, substituting PAM item
55 values for all occurrences of specific substitution codes.
58 argument points to the initial string.
59 The result is stored in the buffer pointed to by the
63 argument specifies the size of that buffer.
64 The actual size of the resulting string, including the terminating NUL
65 character, is stored in the location pointed to by the
71 is NULL, or if the buffer is too small to hold the expanded
74 is updated to reflect the amount of space required to
75 hold the entire string, and
82 fails for any other reason, the
85 untouched, but part of the buffer may still have been overwritten.
87 Substitution codes are introduced by a percent character and correspond
91 Replaced by the current value of the
95 Replaced by the current value of the
99 Replaced by the current value of the
103 Replaced by the current value of the
107 Replaced by the current value of the
111 Replaced by the current value of the
118 function returns one of the following values:
120 .It Bq Er PAM_SYSTEM_ERR
122 .It Bq Er PAM_TRY_AGAIN
127 .Xr pam_get_authtok 3 ,
134 function is an OpenPAM extension.
138 function and this manual page were
140 .An Dag-Erling Sm\(/orgrav Aq des@des.no .