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_USER 3 38.Os 39.Sh NAME 40.Nm pam_get_user 41.Nd retrieve user name 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In security/pam_appl.h 46.Ft int 47.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" 48.Sh DESCRIPTION 49The 50.Nm 51function returns the name of the target user, as 52specified to 53.Xr pam_start 3 . 54If no user was specified, nor set using 55.Xr pam_set_item 3 , 56.Nm 57will prompt for a user name. Either way, 58a pointer to the user name is stored in the location pointed to by the 59.Va user 60argument. 61.Pp 62The 63.Va prompt 64argument specifies a prompt to use if no user name is 65cached. If it is 66.Dv NULL , 67the 68.Dv PAM_USER_PROMPT 69will be used. If that 70item is also 71.Dv NULL , 72a hardcoded default prompt will be used. 73.Pp 74.Sh RETURN VALUES 75The 76.Nm 77function returns one of the following values: 78.Bl -tag -width 18n 79.It Bq Er PAM_BUF_ERR 80Memory buffer error. 81.It Bq Er PAM_CONV_ERR 82Conversation failure. 83.It Bq Er PAM_SYSTEM_ERR 84System error. 85.El 86.Sh SEE ALSO 87.Xr pam 3 , 88.Xr pam_get_authtok 3 , 89.Xr pam_get_item 3 , 90.Xr pam_set_item 3 , 91.Xr pam_start 3 , 92.Xr pam_strerror 3 93.Sh STANDARDS 94.Rs 95.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 96.%D "June 1997" 97.Re 98.Sh AUTHORS 99The 100.Nm 101function and this manual page were developed for the FreeBSD Project 102by ThinkSec AS and Network Associates Laboratories, the Security 103Research Division of Network Associates, Inc. under DARPA/SPAWAR 104contract N66001-01-C-8035 105.Pq Dq CBOSS , 106as part of the DARPA CHATS research program. 107