contrib/openpam/doc/man/pam_prompt.3

   1 .\" Generated from pam_prompt.c by gendoc.pl
   2 .\" $OpenPAM: pam_prompt.c 938 2017-04-30 21:34:42Z des $
   3 .Dd April 30, 2017
   4 .Dt PAM_PROMPT 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_prompt
   8 .Nd call the conversation function
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_prompt
  17 function constructs a message from the specified format
  18 string and arguments and passes it to the given PAM context's
  19 conversation function.
  20 .Pp
  21 A pointer to the response, or
  22 .Dv NULL
  23 if the conversation function did
  24 not return one, is stored in the location pointed to by the
  25 .Fa resp
  26 argument.
  27 .Pp
  28 See
  29 .Xr pam_vprompt 3
  30 for further details.
  31 .Pp
  32 .Sh RETURN VALUES
  33 The
  34 .Fn pam_prompt
  35 function returns one of the following values:
  36 .Bl -tag -width 18n
  37 .It Bq Er PAM_SUCCESS
  38 Success.
  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 Mt des@des.no .