contrib/openpam/doc/man/pam_vprompt.3

   1 .\" Generated from pam_vprompt.c by gendoc.pl
   2 .\" $OpenPAM: pam_vprompt.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   4 .Dt PAM_VPROMPT 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_vprompt
   8 .Nd call the conversation function
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .In security/openpam.h
  13 .Ft "int"
  14 .Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
  15 .Sh DESCRIPTION
  16 The
  17 .Fn pam_vprompt
  18 function constructs a string from the
  19 .Fa fmt
  20 and
  21 .Fa ap
  22 arguments using
  23 .Xr vsnprintf 3 ,
  24 and passes it to the given PAM context's
  25 conversation function.
  26 .Pp
  27 The
  28 .Fa style
  29 argument specifies the type of interaction requested, and
  30 must be one of the following:
  31 .Bl -tag -width 18n
  32 .It Dv PAM_PROMPT_ECHO_OFF
  33 Display the message and obtain the user's response without
  34 displaying it.
  35 .It Dv PAM_PROMPT_ECHO_ON
  36 Display the message and obtain the user's response.
  37 .It Dv PAM_ERROR_MSG
  38 Display the message as an error message, and do not wait
  39 for a response.
  40 .It Dv PAM_TEXT_INFO
  41 Display the message as an informational message, and do
  42 not wait for a response.
  43 .El
  44 .Pp
  45 A pointer to the response, or
  46 .Dv NULL
  47 if the conversation function did
  48 not return one, is stored in the location pointed to by the
  49 .Fa resp
  50 argument.
  51 .Pp
  52 The message and response should not exceed
  53 .Dv PAM_MAX_MSG_SIZE
  54 or
  55 .Dv PAM_MAX_RESP_SIZE ,
  56 respectively.
  57 If they do, they may be truncated.
  58 .Pp
  59 .Sh RETURN VALUES
  60 The
  61 .Fn pam_vprompt
  62 function returns one of the following values:
  63 .Bl -tag -width 18n
  64 .It Bq Er PAM_SUCCESS
  65 Success.
  66 .It Bq Er PAM_BUF_ERR
  67 Memory buffer error.
  68 .It Bq Er PAM_CONV_ERR
  69 Conversation failure.
  70 .It Bq Er PAM_SYSTEM_ERR
  71 System error.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr pam 3 ,
  75 .Xr pam_error 3 ,
  76 .Xr pam_info 3 ,
  77 .Xr pam_prompt 3 ,
  78 .Xr pam_strerror 3 ,
  79 .Xr pam_verror 3 ,
  80 .Xr pam_vinfo 3 ,
  81 .Xr vsnprintf 3
  82 .Sh STANDARDS
  83 The
  84 .Fn pam_vprompt
  85 function is an OpenPAM extension.
  86 .Sh AUTHORS
  87 The
  88 .Fn pam_vprompt
  89 function and this manual page were
  90 developed for the
  91 .Fx
  92 Project by ThinkSec AS and Network Associates Laboratories, the
  93 Security Research Division of Network Associates, Inc.\& under
  94 DARPA/SPAWAR contract N66001-01-C-8035
  95 .Pq Dq CBOSS ,
  96 as part of the DARPA CHATS research program.
  97 .Pp
  98 The OpenPAM library is maintained by
  99 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .