xref: /freebsd/contrib/openpam/doc/man/pam_get_user.3 (revision ca236e63dd69b7ee0460d063ae47d0f870cd17e2)
15c1eca55SDag-Erling Smørgrav.\"-
231c521e9SDag-Erling Smørgrav.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
35c1eca55SDag-Erling Smørgrav.\" All rights reserved.
45c1eca55SDag-Erling Smørgrav.\"
55c1eca55SDag-Erling Smørgrav.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6ee02aaa9SDag-Erling Smørgrav.\" Network Associates Laboratories, the Security Research Division of
7ee02aaa9SDag-Erling Smørgrav.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8ee02aaa9SDag-Erling Smørgrav.\" ("CBOSS"), as part of the DARPA CHATS research program.
95c1eca55SDag-Erling Smørgrav.\"
105c1eca55SDag-Erling Smørgrav.\" Redistribution and use in source and binary forms, with or without
115c1eca55SDag-Erling Smørgrav.\" modification, are permitted provided that the following conditions
125c1eca55SDag-Erling Smørgrav.\" are met:
135c1eca55SDag-Erling Smørgrav.\" 1. Redistributions of source code must retain the above copyright
145c1eca55SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer.
155c1eca55SDag-Erling Smørgrav.\" 2. Redistributions in binary form must reproduce the above copyright
165c1eca55SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer in the
175c1eca55SDag-Erling Smørgrav.\"    documentation and/or other materials provided with the distribution.
185c1eca55SDag-Erling Smørgrav.\" 3. The name of the author may not be used to endorse or promote
195c1eca55SDag-Erling Smørgrav.\"    products derived from this software without specific prior written
205c1eca55SDag-Erling Smørgrav.\"    permission.
215c1eca55SDag-Erling Smørgrav.\"
225c1eca55SDag-Erling Smørgrav.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
235c1eca55SDag-Erling Smørgrav.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
245c1eca55SDag-Erling Smørgrav.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
255c1eca55SDag-Erling Smørgrav.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
265c1eca55SDag-Erling Smørgrav.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
275c1eca55SDag-Erling Smørgrav.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
285c1eca55SDag-Erling Smørgrav.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
295c1eca55SDag-Erling Smørgrav.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
305c1eca55SDag-Erling Smørgrav.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
315c1eca55SDag-Erling Smørgrav.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
325c1eca55SDag-Erling Smørgrav.\" SUCH DAMAGE.
335c1eca55SDag-Erling Smørgrav.\"
34ee02aaa9SDag-Erling Smørgrav.\" $P4$
355c1eca55SDag-Erling Smørgrav.\"
36ca236e63SDag-Erling Smørgrav.Dd July 15, 2003
375c1eca55SDag-Erling Smørgrav.Dt PAM_GET_USER 3
385c1eca55SDag-Erling Smørgrav.Os
395c1eca55SDag-Erling Smørgrav.Sh NAME
405c1eca55SDag-Erling Smørgrav.Nm pam_get_user
415c1eca55SDag-Erling Smørgrav.Nd retrieve user name
425c1eca55SDag-Erling Smørgrav.Sh LIBRARY
435c1eca55SDag-Erling Smørgrav.Lb libpam
445c1eca55SDag-Erling Smørgrav.Sh SYNOPSIS
45644f2b7cSDag-Erling Smørgrav.In sys/types.h
465c1eca55SDag-Erling Smørgrav.In security/pam_appl.h
47ca236e63SDag-Erling Smørgrav.Ft "int"
485c1eca55SDag-Erling Smørgrav.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt"
495c1eca55SDag-Erling Smørgrav.Sh DESCRIPTION
5093889be5SDag-Erling SmørgravThe
5193889be5SDag-Erling Smørgrav.Nm
5293889be5SDag-Erling Smørgravfunction returns the name of the target user, as
5393889be5SDag-Erling Smørgravspecified to
5493889be5SDag-Erling Smørgrav.Xr pam_start 3 .
5593889be5SDag-Erling SmørgravIf no user was specified, nor set using
5693889be5SDag-Erling Smørgrav.Xr pam_set_item 3 ,
5793889be5SDag-Erling Smørgrav.Nm
5893889be5SDag-Erling Smørgravwill prompt for a user name.  Either way,
5993889be5SDag-Erling Smørgrava pointer to the user name is stored in the location pointed to by the
6093889be5SDag-Erling Smørgrav.Va user
6193889be5SDag-Erling Smørgravargument.
6293889be5SDag-Erling Smørgrav.Pp
6393889be5SDag-Erling SmørgravThe
6493889be5SDag-Erling Smørgrav.Va prompt
6593889be5SDag-Erling Smørgravargument specifies a prompt to use if no user name is
6693889be5SDag-Erling Smørgravcached.  If it is
6793889be5SDag-Erling Smørgrav.Dv NULL ,
6893889be5SDag-Erling Smørgravthe
6993889be5SDag-Erling Smørgrav.Dv PAM_USER_PROMPT
7093889be5SDag-Erling Smørgravwill be used.  If that
7193889be5SDag-Erling Smørgravitem is also
7293889be5SDag-Erling Smørgrav.Dv NULL ,
7393889be5SDag-Erling Smørgrava hardcoded default prompt will be used.
7493889be5SDag-Erling Smørgrav.Pp
755c1eca55SDag-Erling Smørgrav.Sh RETURN VALUES
765c1eca55SDag-Erling SmørgravThe
7746acc370SDag-Erling Smørgrav.Nm
785c1eca55SDag-Erling Smørgravfunction returns one of the following values:
7946acc370SDag-Erling Smørgrav.Bl -tag -width 18n
8046acc370SDag-Erling Smørgrav.It Bq Er PAM_BUF_ERR
8146acc370SDag-Erling SmørgravMemory buffer error.
8246acc370SDag-Erling Smørgrav.It Bq Er PAM_CONV_ERR
8346acc370SDag-Erling SmørgravConversation failure.
8446acc370SDag-Erling Smørgrav.It Bq Er PAM_SYSTEM_ERR
8546acc370SDag-Erling SmørgravSystem error.
865c1eca55SDag-Erling Smørgrav.El
875c1eca55SDag-Erling Smørgrav.Sh SEE ALSO
8846acc370SDag-Erling Smørgrav.Xr pam 3 ,
8993889be5SDag-Erling Smørgrav.Xr pam_get_authtok 3 ,
9093889be5SDag-Erling Smørgrav.Xr pam_get_item 3 ,
9193889be5SDag-Erling Smørgrav.Xr pam_set_item 3 ,
9293889be5SDag-Erling Smørgrav.Xr pam_start 3 ,
9346acc370SDag-Erling Smørgrav.Xr pam_strerror 3
945c1eca55SDag-Erling Smørgrav.Sh STANDARDS
955c1eca55SDag-Erling Smørgrav.Rs
965c1eca55SDag-Erling Smørgrav.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
975c1eca55SDag-Erling Smørgrav.%D "June 1997"
985c1eca55SDag-Erling Smørgrav.Re
995c1eca55SDag-Erling Smørgrav.Sh AUTHORS
1005c1eca55SDag-Erling SmørgravThe
1015c1eca55SDag-Erling Smørgrav.Nm
102ca236e63SDag-Erling Smørgravfunction and this manual page were developed for the
103ca236e63SDag-Erling Smørgrav.Fx
104ca236e63SDag-Erling SmørgravProject by ThinkSec AS and Network Associates Laboratories, the
105ca236e63SDag-Erling SmørgravSecurity Research Division of Network Associates, Inc.  under
106ca236e63SDag-Erling SmørgravDARPA/SPAWAR contract N66001-01-C-8035
1075c1eca55SDag-Erling Smørgrav.Pq Dq CBOSS ,
1085c1eca55SDag-Erling Smørgravas part of the DARPA CHATS research program.
109