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