openpam_subst(3) [netbsd man page]
OPENPAM_SUBST(3) BSD Library Functions Manual OPENPAM_SUBST(3) NAME
openpam_subst -- substitute PAM item values in a string LIBRARY
Pluggable Authentication Module Library (libpam, -lpam) SYNOPSIS
#include <sys/types.h> #include <security/pam_appl.h> #include <security/openpam.h> int openpam_subst(const pam_handle_t *pamh, char *buf, size_t *bufsize, const char *template); DESCRIPTION
The openpam_subst function expands a string, substituting PAM item values for all occurrences of specific substitution codes. The template argument points to the initial string. The result is stored in the buffer pointed to by the buf argument; the 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 bufsize argument. If buf is NULL, or if the buffer is too small to hold the expanded string, bufsize is updated to reflect the amount of space required to hold the entire string, and openpam_subst returns PAM_TRY_AGAIN. If openpam_subst fails for any other reason, the bufsize argument is untouched, but part of the buffer may still have been overwritten. Substitution codes are introduced by a percent character and correspond to PAM items: %H Replaced by the current value of the PAM_RHOST item. %h Replaced by the current value of the PAM_HOST item. %s Replaced by the current value of the PAM_SERVICE item. %t Replaced by the current value of the PAM_TTY item. %U Replaced by the current value of the PAM_RUSER item. %u Replaced by the current value of the PAM_USER item. RETURN VALUES
The openpam_subst function returns one of the following values: [PAM_SYSTEM_ERR] System error. [PAM_TRY_AGAIN] Try again. SEE ALSO
pam(3), pam_get_authtok(3), pam_get_item(3), pam_get_user(3), pam_strerror(3) STANDARDS
The openpam_subst function is an OpenPAM extension. AUTHORS
The openpam_subst function and this manual page were developed for the FreeBSD Project by Dag-Erling Smorgrav <des@FreeBSD.org>. BSD
December 18, 2011 BSD
Check Out this Related Man Page
PAM_GET_AUTHTOK(3) BSD Library Functions Manual PAM_GET_AUTHTOK(3) NAME
pam_get_authtok -- retrieve authentication token LIBRARY
Pluggable Authentication Module Library (libpam, -lpam) SYNOPSIS
#include <sys/types.h> #include <security/pam_appl.h> int pam_get_authtok(pam_handle_t *pamh, int item, const char **authtok, const char *prompt); DESCRIPTION
The pam_get_authtok function returns the cached authentication token, or prompts the user if no token is currently cached. Either way, a pointer to the authentication token is stored in the location pointed to by the authtok argument. The item argument must have one of the following values: PAM_AUTHTOK Returns the current authentication token, or the new token when changing authentication tokens. PAM_OLDAUTHTOK Returns the previous authentication token when changing authentication tokens. The prompt argument specifies a prompt to use if no token is cached. If it is NULL, the PAM_AUTHTOK_PROMPT or PAM_OLDAUTHTOK_PROMPT item, as appropriate, will be used. If that item is also NULL, a hardcoded default prompt will be used. If item is set to PAM_AUTHTOK and there is a non-null PAM_OLDAUTHTOK item, pam_get_authtok will ask the user to confirm the new token by retyping it. If there is a mismatch, pam_get_authtok will return PAM_TRY_AGAIN. RETURN VALUES
The pam_get_authtok function returns one of the following values: [PAM_BUF_ERR] Memory buffer error. [PAM_CONV_ERR] Conversation failure. [PAM_SYSTEM_ERR] System error. [PAM_TRY_AGAIN] Try again. SEE ALSO
pam(3), pam_get_item(3), pam_get_user(3), pam_strerror(3) STANDARDS
The pam_get_authtok function is an OpenPAM extension. AUTHORS
The pam_get_authtok function and this manual page were 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. BSD
December 21, 2007 BSD