pam_get_item.3 revision 294192
Generated from pam_get_item.c by gendoc.pl
$Id: pam_get_item.c 648 2013-03-05 17:54:27Z des $
.Dd September 12, 2014 .Dt PAM_GET_ITEM 3 .Os .Sh NAME .Nm pam_get_item .Nd get PAM information .Sh LIBRARY .Lb libpam .Sh SYNOPSIS n sys/types.h n security/pam_appl.h .Ft "int" .Fn pam_get_item "const pam_handle_t *pamh" "int item_type" "const void **item" .Sh DESCRIPTION The .Fn pam_get_item function stores a pointer to the item specified by the .Fa item_type argument in the location pointed to by the .Fa item argument. The item is retrieved from the PAM context specified by the .Fa pamh argument. If .Fn pam_get_item fails, the .Fa item argument is untouched.

p The following item types are recognized: l -tag -width 18n t Dv PAM_SERVICE The name of the requesting service. t Dv PAM_USER The name of the user the application is trying to authenticate. t Dv PAM_TTY The name of the current terminal. t Dv PAM_RHOST The name of the applicant's host. t Dv PAM_CONV A .Vt struct pam_conv describing the current conversation function. t Dv PAM_AUTHTOK The current authentication token. t Dv PAM_OLDAUTHTOK The expired authentication token. t Dv PAM_RUSER The name of the applicant. t Dv PAM_USER_PROMPT The prompt to use when asking the applicant for a user name to authenticate as. t Dv PAM_AUTHTOK_PROMPT The prompt to use when asking the applicant for an authentication token. t Dv PAM_OLDAUTHTOK_PROMPT The prompt to use when asking the applicant for an expired authentication token prior to changing it. t Dv PAM_HOST The name of the host the application runs on. .El

p See .Xr pam_start 3 for a description of .Vt struct pam_conv .

p .Sh RETURN VALUES The .Fn pam_get_item function returns one of the following values: l -tag -width 18n t Bq Er PAM_SYMBOL_ERR Invalid symbol. t Bq Er PAM_SYSTEM_ERR System error. .El .Sh SEE ALSO .Xr pam 3 , .Xr pam_set_item 3 , .Xr pam_start 3 , .Xr pam_strerror 3 .Sh STANDARDS .Rs .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" .%D "June 1997" .Re .Sh AUTHORS The .Fn pam_get_item function and this manual page were developed for the .Fx Project by ThinkSec AS and Network Associates Laboratories, the Security Research Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035

q Dq CBOSS , as part of the DARPA CHATS research program.

p The OpenPAM library is maintained by .An Dag-Erling Sm\(/orgrav Aq des@des.no .