contrib/openpam/doc/man/pam_get_item.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4 .\" All rights reserved.
   5 .\"
   6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   7 .\" Network Associates Laboratories, the Security Research Division of
   8 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The name of the author may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $Id$
  36 .\"
  37 .Dd May 26, 2012
  38 .Dt PAM_GET_ITEM 3
  39 .Os
  40 .Sh NAME
  41 .Nm pam_get_item
  42 .Nd get PAM information
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .Ft "int"
  49 .Fn pam_get_item "const pam_handle_t *pamh" "int item_type" "const void **item"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn pam_get_item
  53 function stores a pointer to the item specified by
  54 the
  55 .Fa item_type
  56 argument in the location pointed to by the
  57 .Fa item
  58 argument.
  59 The item is retrieved from the PAM context specified by the
  60 .Fa pamh
  61 argument.
  62 If
  63 .Fn pam_get_item
  64 fails, the
  65 .Fa item
  66 argument is untouched.
  67 .Pp
  68 The following item types are recognized:
  69 .Bl -tag -width 18n
  70 .It Dv PAM_SERVICE
  71 The name of the requesting service.
  72 .It Dv PAM_USER
  73 The name of the user the application is trying to
  74 authenticate.
  75 .It Dv PAM_TTY
  76 The name of the current terminal.
  77 .It Dv PAM_RHOST
  78 The name of the applicant's host.
  79 .It Dv PAM_CONV
  80 A
  81 .Vt struct pam_conv
  82 describing the current conversation
  83 function.
  84 .It Dv PAM_AUTHTOK
  85 The current authentication token.
  86 .It Dv PAM_OLDAUTHTOK
  87 The expired authentication token.
  88 .It Dv PAM_RUSER
  89 The name of the applicant.
  90 .It Dv PAM_USER_PROMPT
  91 The prompt to use when asking the applicant for a user
  92 name to authenticate as.
  93 .It Dv PAM_AUTHTOK_PROMPT
  94 The prompt to use when asking the applicant for an
  95 authentication token.
  96 .It Dv PAM_OLDAUTHTOK_PROMPT
  97 The prompt to use when asking the applicant for an
  98 expired authentication token prior to changing it.
  99 .It Dv PAM_HOST
 100 The name of the host the application runs on.
 101 .El
 102 .Pp
 103 See
 104 .Xr pam_start 3
 105 for a description of
 106 .Vt struct pam_conv .
 107 .Pp
 108 .Sh RETURN VALUES
 109 The
 110 .Fn pam_get_item
 111 function returns one of the following values:
 112 .Bl -tag -width 18n
 113 .It Bq Er PAM_SYMBOL_ERR
 114 Invalid symbol.
 115 .It Bq Er PAM_SYSTEM_ERR
 116 System error.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr pam 3 ,
 120 .Xr pam_set_item 3 ,
 121 .Xr pam_start 3 ,
 122 .Xr pam_strerror 3
 123 .Sh STANDARDS
 124 .Rs
 125 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 126 .%D "June 1997"
 127 .Re
 128 .Sh AUTHORS
 129 The
 130 .Fn pam_get_item
 131 function and this manual page were
 132 developed for the
 133 .Fx
 134 Project by ThinkSec AS and Network Associates Laboratories, the
 135 Security Research Division of Network Associates, Inc.\& under
 136 DARPA/SPAWAR contract N66001-01-C-8035
 137 .Pq Dq CBOSS ,
 138 as part of the DARPA CHATS research program.