dist/openpam/doc/man/pam_get_user.3

   1 .\"     $NetBSD: pam_get_user.3,v 1.5 2006/02/05 02:37:45 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 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 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  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
  53 The
  54 .Nm
  55 function returns the name of the target user, as
  56 specified to
  57 .Xr pam_start 3 .
  58 If no user was specified, nor set using
  59 .Xr pam_set_item 3 ,
  60 .Nm
  61 will prompt for a user name.
  62 Either way, a pointer to the user name is stored in the location
  63 pointed to by the
  64 .Fa user
  65 argument.
  66 .Pp
  67 The
  68 .Fa prompt
  69 argument specifies a prompt to use if no user name is
  70 cached.
  71 If it is
  72 .Dv NULL ,
  73 the
  74 .Dv PAM_USER_PROMPT
  75 will be used.
  76 If that item is also
  77 .Dv NULL ,
  78 a hardcoded default prompt will be used.
  79 .Sh RETURN VALUES
  80 The
  81 .Nm
  82 function returns one of the following values:
  83 .Bl -tag -width 18n
  84 .It Bq Er PAM_BUF_ERR
  85 Memory buffer error.
  86 .It Bq Er PAM_CONV_ERR
  87 Conversation failure.
  88 .It Bq Er PAM_SYSTEM_ERR
  89 System error.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr pam 3 ,
  93 .Xr pam_get_authtok 3 ,
  94 .Xr pam_get_item 3 ,
  95 .Xr pam_set_item 3 ,
  96 .Xr pam_start 3 ,
  97 .Xr pam_strerror 3
  98 .Sh STANDARDS
  99 .Rs
 100 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 101 .%D "June 1997"
 102 .Re
 103 .Sh AUTHORS
 104 The
 105 .Nm
 106 function and this manual page were developed for the
 107 .Fx
 108 Project by ThinkSec AS and Network Associates Laboratories, the
 109 Security Research Division of Network Associates, Inc.\& under
 110 DARPA/SPAWAR contract N66001-01-C-8035
 111 .Pq Dq CBOSS ,
 112 as part of the DARPA CHATS research program.