contrib/openpam/doc/man/pam_get_item.3

   1 .\" Generated from pam_get_item.c by gendoc.pl
   2 .\" $Id: pam_get_item.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt PAM_GET_ITEM 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_get_item
   8 .Nd get PAM information
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "int"
  15 .Fn pam_get_item "const pam_handle_t *pamh" "int item_type" "const void **item"
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_get_item
  19 function stores a pointer to the item specified by
  20 the
  21 .Fa item_type
  22 argument in the location pointed to by the
  23 .Fa item
  24 argument.
  25 The item is retrieved from the PAM context specified by the
  26 .Fa pamh
  27 argument.
  28 If
  29 .Fn pam_get_item
  30 fails, the
  31 .Fa item
  32 argument is untouched.
  33 .Pp
  34 The following item types are recognized:
  35 .Bl -tag -width 18n
  36 .It Dv PAM_SERVICE
  37 The name of the requesting service.
  38 .It Dv PAM_USER
  39 The name of the user the application is trying to
  40 authenticate.
  41 .It Dv PAM_TTY
  42 The name of the current terminal.
  43 .It Dv PAM_RHOST
  44 The name of the applicant's host.
  45 .It Dv PAM_CONV
  46 A
  47 .Vt struct pam_conv
  48 describing the current conversation
  49 function.
  50 .It Dv PAM_AUTHTOK
  51 The current authentication token.
  52 .It Dv PAM_OLDAUTHTOK
  53 The expired authentication token.
  54 .It Dv PAM_RUSER
  55 The name of the applicant.
  56 .It Dv PAM_USER_PROMPT
  57 The prompt to use when asking the applicant for a user
  58 name to authenticate as.
  59 .It Dv PAM_AUTHTOK_PROMPT
  60 The prompt to use when asking the applicant for an
  61 authentication token.
  62 .It Dv PAM_OLDAUTHTOK_PROMPT
  63 The prompt to use when asking the applicant for an
  64 expired authentication token prior to changing it.
  65 .It Dv PAM_HOST
  66 The name of the host the application runs on.
  67 .El
  68 .Pp
  69 See
  70 .Xr pam_start 3
  71 for a description of
  72 .Vt struct pam_conv .
  73 .Pp
  74 .Sh RETURN VALUES
  75 The
  76 .Fn pam_get_item
  77 function returns one of the following values:
  78 .Bl -tag -width 18n
  79 .It Bq Er PAM_SYMBOL_ERR
  80 Invalid symbol.
  81 .It Bq Er PAM_SYSTEM_ERR
  82 System error.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr pam 3 ,
  86 .Xr pam_set_item 3 ,
  87 .Xr pam_start 3 ,
  88 .Xr pam_strerror 3
  89 .Sh STANDARDS
  90 .Rs
  91 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  92 .%D "June 1997"
  93 .Re
  94 .Sh AUTHORS
  95 The
  96 .Fn pam_get_item
  97 function and this manual page were
  98 developed for the
  99 .Fx
 100 Project by ThinkSec AS and Network Associates Laboratories, the
 101 Security Research Division of Network Associates, Inc.\& under
 102 DARPA/SPAWAR contract N66001-01-C-8035
 103 .Pq Dq CBOSS ,
 104 as part of the DARPA CHATS research program.
 105 .Pp
 106 The OpenPAM library is maintained by
 107 .An Dag-Erling Sm\(/orgrav Aq des@des.no .