2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" All rights reserved.
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.
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
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
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
41 .Nd retrieve user name
46 .In security/pam_appl.h
48 .Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt"
52 function returns the name of the target user, as
55 If no user was specified, nor set using
58 will prompt for a user name.
59 Either way, a pointer to the user name is stored in the location
66 argument specifies a prompt to use if no user name is
75 a hardcoded default prompt will be used.
80 function returns one of the following values:
84 .It Bq Er PAM_CONV_ERR
86 .It Bq Er PAM_SYSTEM_ERR
91 .Xr pam_get_authtok 3 ,
98 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
104 function and this manual page were developed for the
106 Project by ThinkSec AS and Network Associates Laboratories, the
107 Security Research Division of Network Associates, Inc.& under
108 DARPA/SPAWAR contract N66001-01-C-8035
110 as part of the DARPA CHATS research program.