contrib/openpam/doc/man/pam_prompt.3

   1 .\" Generated from pam_prompt.c by gendoc.pl
   2 .\" $Id: pam_prompt.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 12, 2014
   4 .Dt PAM_PROMPT 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_prompt
   8 .Nd call the conversation function
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "int"
  15 .Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_prompt
  19 function constructs a message from the specified format
  20 string and arguments and passes it to the given PAM context's
  21 conversation function.
  22 .Pp
  23 A pointer to the response, or
  24 .Dv NULL
  25 if the conversation function did
  26 not return one, is stored in the location pointed to by the
  27 .Fa resp
  28 argument.
  29 .Pp
  30 See
  31 .Xr pam_vprompt 3
  32 for further details.
  33 .Pp
  34 .Sh RETURN VALUES
  35 The
  36 .Fn pam_prompt
  37 function returns one of the following values:
  38 .Bl -tag -width 18n
  39 .It Bq Er PAM_BUF_ERR
  40 Memory buffer error.
  41 .It Bq Er PAM_CONV_ERR
  42 Conversation failure.
  43 .It Bq Er PAM_SYSTEM_ERR
  44 System error.
  45 .El
  46 .Sh SEE ALSO
  47 .Xr pam 3 ,
  48 .Xr pam_error 3 ,
  49 .Xr pam_info 3 ,
  50 .Xr pam_strerror 3 ,
  51 .Xr pam_vprompt 3
  52 .Sh STANDARDS
  53 The
  54 .Fn pam_prompt
  55 function is an OpenPAM extension.
  56 .Sh AUTHORS
  57 The
  58 .Fn pam_prompt
  59 function and this manual page were
  60 developed for the
  61 .Fx
  62 Project by ThinkSec AS and Network Associates Laboratories, the
  63 Security Research Division of Network Associates, Inc.\& under
  64 DARPA/SPAWAR contract N66001-01-C-8035
  65 .Pq Dq CBOSS ,
  66 as part of the DARPA CHATS research program.
  67 .Pp
  68 The OpenPAM library is maintained by
  69 .An Dag-Erling Sm\(/orgrav Aq des@des.no .