111 lines
No EOL
3.5 KiB
XML
111 lines
No EOL
3.5 KiB
XML
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_prompt">
|
|
|
|
<refmeta>
|
|
<refentrytitle>pam_prompt</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="source">Linux-PAM</refmiscinfo>
|
|
<refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv xml:id="pam_prompt-name">
|
|
<refname>pam_prompt</refname>
|
|
<refname>pam_vprompt</refname>
|
|
<refpurpose>interface to conversation function</refpurpose>
|
|
</refnamediv>
|
|
|
|
<!-- body begins here -->
|
|
|
|
<refsynopsisdiv xml:id="pam_prompt-synopsis">
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <security/pam_ext.h></funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>int <function>pam_prompt</function></funcdef>
|
|
<paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
|
|
<paramdef>int <parameter>style</parameter></paramdef>
|
|
<paramdef>char **<parameter>response</parameter></paramdef>
|
|
<paramdef>const char *<parameter>fmt</parameter></paramdef>
|
|
<paramdef><parameter>...</parameter></paramdef>
|
|
</funcprototype>
|
|
<funcprototype>
|
|
<funcdef>int <function>pam_vprompt</function></funcdef>
|
|
<paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
|
|
<paramdef>int <parameter>style</parameter></paramdef>
|
|
<paramdef>char **<parameter>response</parameter></paramdef>
|
|
<paramdef>const char *<parameter>fmt</parameter></paramdef>
|
|
<paramdef>va_list <parameter>args</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 xml:id="pam_prompt-description">
|
|
<title>DESCRIPTION</title>
|
|
<para>
|
|
The <function>pam_prompt</function> function constructs a message
|
|
from the specified format string and arguments and passes it to the
|
|
conversation function as set by the service. Upon successful return,
|
|
<emphasis>response</emphasis> is set to point to a string
|
|
returned from the conversation function. This string is allocated
|
|
on heap and should be freed.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 xml:id="pam_prompt-return_values">
|
|
<title>RETURN VALUES</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>PAM_BUF_ERR</term>
|
|
<listitem>
|
|
<para>
|
|
Memory buffer error.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>PAM_CONV_ERR</term>
|
|
<listitem>
|
|
<para>
|
|
Conversation failure.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>PAM_SUCCESS</term>
|
|
<listitem>
|
|
<para>
|
|
Conversation succeeded, response is set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>PAM_SYSTEM_ERR</term>
|
|
<listitem>
|
|
<para>
|
|
System error.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 xml:id="pam_prompt-see_also">
|
|
<title>SEE ALSO</title>
|
|
<para>
|
|
<citerefentry>
|
|
<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
|
|
</citerefentry>,
|
|
<citerefentry>
|
|
<refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum>
|
|
</citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 xml:id="pam_prompt-standards">
|
|
<title>STANDARDS</title>
|
|
<para>
|
|
The <function>pam_prompt</function> and <function>pam_vprompt</function>
|
|
functions are Linux-PAM extensions.
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry> |