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