pam_get_user(3) [freebsd man page]

PAM_GET_USER(3) 					   BSD Library Functions Manual 					   PAM_GET_USER(3)

NAME

     pam_get_user -- retrieve user name

LIBRARY

     Pluggable Authentication Module Library (libpam, -lpam)

SYNOPSIS

     #include <sys/types.h>
     #include <security/pam_appl.h>

     int
     pam_get_user(pam_handle_t *pamh, const char **user, const char *prompt);

DESCRIPTION

     The pam_get_user() function returns the name of the target user, as specified to pam_start(3).  If no user was specified, nor set using
     pam_set_item(3), pam_get_user() will prompt for a user name.  Either way, a pointer to the user name is stored in the location pointed to by
     the user argument, and the corresponding PAM item is updated.

     The prompt argument specifies a prompt to use if no user name is cached.  If it is NULL, the PAM_USER_PROMPT item will be used.  If that item
     is also NULL, a hardcoded default prompt will be used.  Additionally, when pam_get_user() is called from a service module, the prompt may be
     affected by module options as described below.  The prompt is then expanded using openpam_subst(3) before it is passed to the conversation
     function.

MODULE OPTIONS

     When called by a service module, pam_get_user() will recognize the following module options:

     user_prompt	 Prompt to use when asking for the user name.  This option overrides both the prompt argument and the PAM_USER_PROMPT
			 item.

RETURN VALUES

     The pam_get_user() function returns one of the following values:

     [PAM_BUF_ERR]	 Memory buffer error.

     [PAM_CONV_ERR]	 Conversation failure.

     [PAM_SYSTEM_ERR]	 System error.

SEE ALSO

     openpam_get_option(3), openpam_subst(3), pam(3), pam_conv(3), pam_get_authtok(3), pam_get_item(3), pam_set_item(3), pam_start(3),
     pam_strerror(3)

STANDARDS

     X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules, June 1997.

AUTHORS

     The pam_get_user() 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.

     The OpenPAM library is maintained by Dag-Erling Smorgrav <des@des.no>.

BSD
								September 12, 2014							       BSD

pam_get_user(3PAM)					       PAM Library Functions						pam_get_user(3PAM)

NAME

       pam_get_user - PAM routine to retrieve user name

SYNOPSIS

       cc [ flag ... ] file ...  -lpam [ library ... ]
       #include <security/pam_appl.h>

       int pam_get_user(pam_handle_t *pamh, char **user,
	    const char *prompt);

DESCRIPTION

       The  pam_get_user()  function  is used by  PAM service modules to retrieve the current user name from the  PAM handle. If the user name has
       not been set with pam_start() or  pam_set_item(), the PAM conversation function will be used to prompt the user for the user name with  the
       string  "prompt". If prompt is  NULL, then pam_get_item() is called and the value of PAM_USER_PROMPT is used for prompting. If the value of
       PAM_USER_PROMPT is  NULL, the following default prompt is used:

	 Please enter user name:

       After the user name is gathered by the conversation function, pam_set_item() is called to set the value of  PAM_USER. By convention, appli-
       cations	that  need to prompt for a user name should  call pam_set_item() and set the value of PAM_USER_PROMPT before calling pam_authenti-
       cate(). The service module's pam_sm_authenticate() function will then call pam_get_user() to prompt for the user name.

       Note that certain  PAM service modules, such as a smart card module, may override the value of	PAM_USER_PROMPT  and  pass  in	their  own
       prompt.	Applications  that  call  pam_authenticate() multiple times should set the value of  PAM_USER to  NULL with  pam_set_item() before
       calling pam_authenticate(), if they want the user to be prompted  for  a  new  user  name  each	time.  The  value  of  user  retrieved	by
       pam_get_user() should not be modified or freed.	The item will be released by pam_end().

RETURN VALUES

       Upon  success, pam_get_user() returns  PAM_SUCCESS; otherwise it returns an error code. Refer to pam(3PAM) for information on error related
       return values.

ATTRIBUTES

       See attributes(5) for description of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     | Stable			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe with exceptions	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       pam(3PAM),  pam_authenticate(3PAM),  pam_end(3PAM),  pam_get_item(3PAM),   pam_set_item(3PAM),	pam_sm(3PAM),	pam_sm_authenticate(3PAM),
       pam_start(3PAM), attributes(5)

NOTES

       The interfaces in  libpam are MT-Safe only if each thread within the multithreaded application uses its own PAM handle.

SunOS 5.11							    13 Oct 1998 						pam_get_user(3PAM)