1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2007 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.\" $P4$ 36.\" 37.Dd December 21, 2007 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 51The 52.Nm 53function stores a pointer to the item specified by 54the 55.Fa item_type 56argument in the location specified by the 57.Fa item 58argument. 59The item is retrieved from the PAM context specified by the 60.Fa pamh 61argument. 62The following item types are recognized: 63.Bl -tag -width 18n 64.It Dv PAM_SERVICE 65The name of the requesting service. 66.It Dv PAM_USER 67The name of the user the application is trying to 68authenticate. 69.It Dv PAM_TTY 70The name of the current terminal. 71.It Dv PAM_RHOST 72The name of the applicant's host. 73.It Dv PAM_CONV 74A 75.Vt struct pam_conv 76describing the current conversation 77function. 78.It Dv PAM_AUTHTOK 79The current authentication token. 80.It Dv PAM_OLDAUTHTOK 81The expired authentication token. 82.It Dv PAM_RUSER 83The name of the applicant. 84.It Dv PAM_USER_PROMPT 85The prompt to use when asking the applicant for a user 86name to authenticate as. 87.It Dv PAM_AUTHTOK_PROMPT 88The prompt to use when asking the applicant for an 89authentication token. 90.It Dv PAM_OLDAUTHTOK_PROMPT 91The prompt to use when asking the applicant for an 92expired authentication token prior to changing it. 93.El 94.Pp 95See 96.Xr pam_start 3 97for a description of 98.Vt struct pam_conv . 99.Pp 100.Sh RETURN VALUES 101The 102.Nm 103function returns one of the following values: 104.Bl -tag -width 18n 105.It Bq Er PAM_SYMBOL_ERR 106Invalid symbol. 107.It Bq Er PAM_SYSTEM_ERR 108System error. 109.El 110.Sh SEE ALSO 111.Xr pam 3 , 112.Xr pam_set_item 3 , 113.Xr pam_start 3 , 114.Xr pam_strerror 3 115.Sh STANDARDS 116.Rs 117.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 118.%D "June 1997" 119.Re 120.Sh AUTHORS 121The 122.Nm 123function and this manual page were developed for the 124.Fx 125Project by ThinkSec AS and Network Associates Laboratories, the 126Security Research Division of Network Associates, Inc.\& under 127DARPA/SPAWAR contract N66001-01-C-8035 128.Pq Dq CBOSS , 129as part of the DARPA CHATS research program. 130