granicus.if.org Git - linux-pam/blob - doc/man/pam_prompt.3.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="pam_prompt">
   6
   7   <refmeta>
   8     <refentrytitle>pam_prompt</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_prompt-name">
  14     <refname>pam_prompt</refname>
  15     <refname>pam_vprompt</refname>
  16     <refpurpose>interface to conversation function</refpurpose>
  17   </refnamediv>
  18
  19 <!-- body begins here -->
  20
  21   <refsynopsisdiv id="pam_prompt-synopsis">
  22     <funcsynopsis>
  23       <funcsynopsisinfo>#include &lt;security/pam_ext.h&gt;</funcsynopsisinfo>
  24       <funcprototype>
  25         <funcdef>void <function>pam_prompt</function></funcdef>
  26         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  27         <paramdef>int <parameter>style</parameter></paramdef>
  28         <paramdef>char **<parameter>response</parameter></paramdef>
  29         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  30         <paramdef><parameter>...</parameter></paramdef>
  31       </funcprototype>
  32       <funcprototype>
  33         <funcdef>void <function>pam_vprompt</function></funcdef>
  34         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  35         <paramdef>int <parameter>style</parameter></paramdef>
  36         <paramdef>char **<parameter>response</parameter></paramdef>
  37         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  38         <paramdef>va_list <parameter>args</parameter></paramdef>
  39       </funcprototype>
  40     </funcsynopsis>
  41   </refsynopsisdiv>
  42
  43   <refsect1 id='pam_prompt-description'>
  44     <title>DESCRIPTION</title>
  45     <para>
  46       The <function>pam_prompt</function> function constructs a message
  47       from the specified format string and arguments and passes it to the
  48       conversation function as set by the service. Upon successful return,
  49       <emphasis>response</emphasis> is set to point to a string
  50       returned from the conversation function. This string is allocated
  51       on heap and should be freed.
  52     </para>
  53   </refsect1>
  54
  55   <refsect1 id="pam_prompt-return_values">
  56     <title>RETURN VALUES</title>
  57     <variablelist>
  58       <varlistentry>
  59         <term>PAM_BUF_ERR</term>
  60         <listitem>
  61            <para>
  62               Memory buffer error.
  63           </para>
  64         </listitem>
  65       </varlistentry>
  66       <varlistentry>
  67         <term>PAM_CONV_ERR</term>
  68         <listitem>
  69            <para>
  70               Conversation failure.
  71           </para>
  72         </listitem>
  73       </varlistentry>
  74       <varlistentry>
  75         <term>PAM_SUCCESS</term>
  76         <listitem>
  77            <para>
  78              Transaction was successful created.
  79           </para>
  80         </listitem>
  81       </varlistentry>
  82       <varlistentry>
  83         <term>PAM_SYSTEM_ERR</term>
  84         <listitem>
  85            <para>
  86               System error.
  87           </para>
  88         </listitem>
  89       </varlistentry>
  90     </variablelist>
  91   </refsect1>
  92
  93
  94   <refsect1 id='pam_prompt-see_also'>
  95     <title>SEE ALSO</title>
  96     <para>
  97       <citerefentry>
  98         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  99       </citerefentry>,
 100       <citerefentry>
 101         <refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum>
 102       </citerefentry>
 103     </para>
 104   </refsect1>
 105
 106   <refsect1 id='pam_prompt-standards'>
 107     <title>STANDARDS</title>
 108     <para>
 109       The <function>pam_prompt</function> and <function>pam_vprompt</function>
 110       functions are Linux-PAM extensions.
 111     </para>
 112   </refsect1>
 113
 114 </refentry>