Copyright (c) 2001-2003 Networks Associates Technology, Inc.
Copyright (c) 2004-2011 Dag-Erling Sm��rgrav
All rights reserved.
This software was developed for the FreeBSD Project by ThinkSec AS and
Network Associates Laboratories, the Security Research Division of
Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
("CBOSS"), as part of the DARPA CHATS research program.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$Id$
.Dd December 18, 2011 .Dt OPENPAM_SUBST 3 .Os .Sh NAME .Nm openpam_subst .Nd substitute PAM item values in a string .Sh LIBRARY .Lb libpam .Sh SYNOPSIS n sys/types.h n security/pam_appl.h n security/openpam.h .Ft "int" .Fn openpam_subst "const pam_handle_t *pamh" "char *buf" "size_t *bufsize" "const char *template" .Sh DESCRIPTION The .Nm function expands a string, substituting PAM item values for all occurrences of specific substitution codes. The .Fa template argument points to the initial string. The result is stored in the buffer pointed to by the .Fa buf argument; the .Fa bufsize argument specifies the size of that buffer. The actual size of the resulting string, including the terminating NUL character, is stored in the location pointed to by the .Fa bufsize argument.
p If .Fa buf is NULL, or if the buffer is too small to hold the expanded string, .Fa bufsize is updated to reflect the amount of space required to hold the entire string, and .Nm returns .Dv PAM_TRY_AGAIN .
p If .Nm fails for any other reason, the .Fa bufsize argument is untouched, but part of the buffer may still have been overwritten.
p Substitution codes are introduced by a percent character and correspond to PAM items: l -tag -width 18n t %H Replaced by the current value of the .Dv PAM_RHOST item. t %h Replaced by the current value of the .Dv PAM_HOST item. t %s Replaced by the current value of the .Dv PAM_SERVICE item. t %t Replaced by the current value of the .Dv PAM_TTY item. t %U Replaced by the current value of the .Dv PAM_RUSER item. t %u Replaced by the current value of the .Dv PAM_USER item. .El
p .Sh RETURN VALUES The .Nm function returns one of the following values: l -tag -width 18n t Bq Er PAM_SYSTEM_ERR System error. t Bq Er PAM_TRY_AGAIN Try again. .El .Sh SEE ALSO .Xr pam 3 , .Xr pam_get_authtok 3 , .Xr pam_get_item 3 , .Xr pam_get_user 3 , .Xr pam_strerror 3 .Sh STANDARDS The .Nm function is an OpenPAM extension. .Sh AUTHORS The .Nm function and this manual page were developed for the .Fx Project by .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .