dist/openpam/doc/man/pam_get_item.3

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