--></head><body><div class="refentry"><a id="auth-login" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_login — Validate a userid and password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
#include <courierauth.h><br clear="none"/>
-</p></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_login</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">password</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int <var class="pdparam">(*callback_func)</var><code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm2
47882989472" shape="rect"> </a><h2>DESCRIPTION</h2><p>
+</p></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_login</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">password</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int <var class="pdparam">(*callback_func)</var><code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm2
55232852784" shape="rect"> </a><h2>DESCRIPTION</h2><p>
<code class="function">auth_login</code> verifies whether
<em class="replaceable"><code>userid</code></em> exists, and whether it's
<em class="replaceable"><code>password</code></em> is correct.
<em class="parameter"><code>service</code></em> specifies which so-called "service" is
being authenticated; like <span class="quote">“<span class="quote">imap</span>”</span> or <span class="quote">“<span class="quote">pop3</span>”</span>.
<em class="parameter"><code>service</code></em> may or may not be used by the Courier
-authentication library's configured back-end module.</p></div><div class="refsect1"><a id="idm2
47885295344" shape="rect"> </a><h2>RETURNS</h2><p>
+authentication library's configured back-end module.</p></div><div class="refsect1"><a id="idm2
55235549632" shape="rect"> </a><h2>RETURNS</h2><p>
<code class="function">callback_func</code> will be invoked if
<code class="function">auth_login</code>
succeeds, and <code class="function">callback_func</code>'s return value becomes
The second argument to <code class="function">callback_func</code> will be
<code class="function">callback_arg</code>, which is not interpreted by this
function in any way.
-The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="idm2
47886847920" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
+The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="idm2
55230204816" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
struct authinfo {
const char *sysusername;
const uid_t *sysuserid;
If the account has an encrypted password defined, this field
can be set to <code class="literal">NULL</code>.</p></dd><dt><span class="term">options</span></dt><dd><p>
A comma-separated list of miscellaneous account options.
-See below for more information.</p></dd></dl></div><div class="refsect2"><a id="idm2
47881555248" shape="rect"> </a><h3>Account options</h3><p>
+See below for more information.</p></dd></dl></div><div class="refsect2"><a id="idm2
55230129472" shape="rect"> </a><h3>Account options</h3><p>
Depending on the configuration of the Courier authentication library,
accounts may have individual options associated with them.
If the authentication library configuration does not implement account
access control lists say). See the virtual shared folder documentation
for more information.</p><p>
For technical reasons, group names may not include comma, tab, "/" or "|"
-characters.</p></dd></dl></div></div></div><div class="refsect1"><a id="idm2
47881468832" shape="rect"> </a><h2>SEE ALSO</h2><p>
+characters.</p></dd></dl></div></div></div><div class="refsect1"><a id="idm2
55230042464" shape="rect"> </a><h2>SEE ALSO</h2><p>
<a class="ulink" href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
<a class="ulink" href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
HCoop / hcoop / debian / courier-authlib.git / blobdiff