dist/openpam/doc/man/pam_prompt.3

   1 .\"     $NetBSD: pam_prompt.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_PROMPT 3
  41 .Os
  42 .Sh NAME
  43 .Nm pam_prompt
  44 .Nd call the conversation function
  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_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 function constructs a message from the specified format
  56 string and arguments and passes it to the given PAM context's
  57 conversation function.
  58 .Pp
  59 A pointer to the response, or
  60 .Dv NULL
  61 if the conversation function did
  62 not return one, is stored in the location pointed to by the
  63 .Fa resp
  64 argument.
  65 .Pp
  66 See
  67 .Xr pam_vprompt 3
  68 for further details.
  69 .Sh RETURN VALUES
  70 The
  71 .Nm
  72 function returns one of the following values:
  73 .Bl -tag -width 18n
  74 .It Bq Er PAM_BUF_ERR
  75 Memory buffer error.
  76 .It Bq Er PAM_CONV_ERR
  77 Conversation failure.
  78 .It Bq Er PAM_SYSTEM_ERR
  79 System error.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr pam 3 ,
  83 .Xr pam_error 3 ,
  84 .Xr pam_info 3 ,
  85 .Xr pam_strerror 3 ,
  86 .Xr pam_vprompt 3
  87 .Sh STANDARDS
  88 The
  89 .Nm
  90 function is an OpenPAM extension.
  91 .Sh AUTHORS
  92 The
  93 .Nm
  94 function and this manual page were developed for the
  95 .Fx
  96 Project by ThinkSec AS and Network Associates Laboratories, the
  97 Security Research Division of Network Associates, Inc.\& under
  98 DARPA/SPAWAR contract N66001-01-C-8035
  99 .Pq Dq CBOSS ,
 100 as part of the DARPA CHATS research program.