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