1.\" $NetBSD: pam_get_user.3,v 1.2 2011/12/25 22:27:55 christos Exp $ 2.\" 3.\"- 4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 5.\" Copyright (c) 2004-2011 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.\" Id 38.\" 39.Dd December 18, 2011 40.Dt PAM_GET_USER 3 41.Os 42.Sh NAME 43.Nm pam_get_user 44.Nd retrieve user name 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_user "pam_handle_t *pamh" "const char **user" "const char *prompt" 52.Sh DESCRIPTION 53The 54.Nm 55function returns the name of the target user, as 56specified to 57.Xr pam_start 3 . 58If no user was specified, nor set using 59.Xr pam_set_item 3 , 60.Nm 61will prompt for a user name. 62Either way, a pointer to the user name is stored in the location 63pointed to by the 64.Fa user 65argument. 66.Pp 67The 68.Fa prompt 69argument specifies a prompt to use if no user name is 70cached. 71If it is 72.Dv NULL , 73the 74.Dv PAM_USER_PROMPT 75item will be used. 76If that item is also 77.Dv NULL , 78a hardcoded default prompt will be used. 79Either way, the prompt is expanded using 80.Xr openpam_subst 3 81before it is 82passed to the conversation function. 83.Pp 84If 85.Nm 86is called from a module and the 87.Dv user_prompt 88option is 89set in the policy file, the value of that option takes precedence over 90both the 91.Fa prompt 92argument and the 93.Dv PAM_USER_PROMPT 94item. 95.Sh RETURN VALUES 96The 97.Nm 98function returns one of the following values: 99.Bl -tag -width 18n 100.It Bq Er PAM_BUF_ERR 101Memory buffer error. 102.It Bq Er PAM_CONV_ERR 103Conversation failure. 104.It Bq Er PAM_SYSTEM_ERR 105System error. 106.El 107.Sh SEE ALSO 108.Xr openpam_subst 3 , 109.Xr pam 3 , 110.Xr pam_get_authtok 3 , 111.Xr pam_get_item 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 126ThinkSec AS and Network Associates Laboratories, the 127Security Research Division of Network Associates, Inc.\& under 128DARPA/SPAWAR contract N66001-01-C-8035 129.Pq Dq CBOSS , 130as part of the DARPA CHATS research program. 131