contrib/openpam/doc/man/pam_vprompt.3

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