contrib/openpam/doc/man/pam_get_user.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4 .\" All rights reserved.
   5 .\"
   6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   7 .\" Network Associates Laboratories, the Security Research Division of
   8 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The name of the author may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $Id$
  36 .\"
  37 .Dd December 18, 2011
  38 .Dt PAM_GET_USER 3
  39 .Os
  40 .Sh NAME
  41 .Nm pam_get_user
  42 .Nd retrieve user name
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .Ft "int"
  49 .Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt"
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 function returns the name of the target user, as
  54 specified to
  55 .Xr pam_start 3 .
  56 If no user was specified, nor set using
  57 .Xr pam_set_item 3 ,
  58 .Nm
  59 will prompt for a user name.
  60 Either way, a pointer to the user name is stored in the location
  61 pointed to by the
  62 .Fa user
  63 argument.
  64 .Pp
  65 The
  66 .Fa prompt
  67 argument specifies a prompt to use if no user name is
  68 cached.
  69 If it is
  70 .Dv NULL ,
  71 the
  72 .Dv PAM_USER_PROMPT
  73 item will be used.
  74 If that item is also
  75 .Dv NULL ,
  76 a hardcoded default prompt will be used.
  77 Either way, the prompt is expanded using
  78 .Xr openpam_subst 3
  79 before it is
  80 passed to the conversation function.
  81 .Pp
  82 If
  83 .Nm
  84 is called from a module and the
  85 .Dv user_prompt
  86 option is
  87 set in the policy file, the value of that option takes precedence over
  88 both the
  89 .Fa prompt
  90 argument and the
  91 .Dv PAM_USER_PROMPT
  92 item.
  93 .Pp
  94 .Sh RETURN VALUES
  95 The
  96 .Nm
  97 function returns one of the following values:
  98 .Bl -tag -width 18n
  99 .It Bq Er PAM_BUF_ERR
 100 Memory buffer error.
 101 .It Bq Er PAM_CONV_ERR
 102 Conversation failure.
 103 .It Bq Er PAM_SYSTEM_ERR
 104 System error.
 105 .El
 106 .Sh SEE ALSO
 107 .Xr openpam_subst 3 ,
 108 .Xr pam 3 ,
 109 .Xr pam_get_authtok 3 ,
 110 .Xr pam_get_item 3 ,
 111 .Xr pam_set_item 3 ,
 112 .Xr pam_start 3 ,
 113 .Xr pam_strerror 3
 114 .Sh STANDARDS
 115 .Rs
 116 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 117 .%D "June 1997"
 118 .Re
 119 .Sh AUTHORS
 120 The
 121 .Nm
 122 function and this manual page were developed for the
 123 .Fx
 124 Project by
 125 ThinkSec AS and Network Associates Laboratories, the
 126 Security Research Division of Network Associates, Inc.\& under
 127 DARPA/SPAWAR contract N66001-01-C-8035
 128 .Pq Dq CBOSS ,
 129 as part of the DARPA CHATS research program.