pam_get_user man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]


       pam_get_user - PAM routine to retrieve user name

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

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

       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,
       applications  that  need	 to  prompt  for  a  user  name	 should	  call
       pam_set_item() and set the  value  of  PAM_USER_PROMPT  before  calling
       pam_authenticate(). 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

       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.

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

       │Interface Stability │  Stable		      │
       │MT-Level	    │ MT-Safe with exceptions │

       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)

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

				 Oct 13, 1998		    PAM_GET_USER(3PAM)

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net