39 lines
5.4 KiB
HTML
39 lines
5.4 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>ne_set_server_auth</title><link rel="stylesheet" href="../manual.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="neon HTTP/WebDAV client library"><link rel="up" href="ref.html" title="neon API reference"><link rel="prev" href="refreqbody.html" title="ne_set_request_body_buffer"><link rel="next" href="refshave.html" title="ne_shave"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ne_set_server_auth</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="refreqbody.html">Prev</a> </td><th width="60%" align="center">neon API reference</th><td width="20%" align="right"> <a accesskey="n" href="refshave.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="refauth"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ne_set_server_auth, ne_set_proxy_auth, ne_forget_auth — register authentication callbacks</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <ne_auth.h></pre><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">typedef int (*<b class="fsfunc">ne_request_auth</b>)(</code>void *<var xmlns="" class="pdparam">userdata</var>, const char *<var xmlns="" class="pdparam">realm</var>, int <var xmlns="" class="pdparam">attempt</var>, char *<var xmlns="" class="pdparam">username</var>, char *<var xmlns="" class="pdparam">password</var><code xmlns="">)</code>;</code></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">void <b class="fsfunc">ne_set_server_auth</b>(</code>ne_session *<var xmlns="" class="pdparam">session</var>, ne_request_auth <var xmlns="" class="pdparam">callback</var>, void *<var xmlns="" class="pdparam">userdata</var><code xmlns="">)</code>;</code></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">void <b class="fsfunc">ne_set_proxy_auth</b>(</code>ne_session *<var xmlns="" class="pdparam">session</var>, ne_request_auth <var xmlns="" class="pdparam">callback</var>, void *<var xmlns="" class="pdparam">userdata</var><code xmlns="">)</code>;</code></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">void <b class="fsfunc">ne_forget_auth</b>(</code>ne_session *<var xmlns="" class="pdparam">session</var><code xmlns="">)</code>;</code></div></div></div><div class="refsect1" lang="en"><a name="id2939752"></a><h2>Description</h2><p>The <em class="type">ne_request_auth</em> function type defines a
|
||
callback which is invoked when a server or proxy server requires user
|
||
authentication for a particular request. The
|
||
<code class="parameter">realm</code> string is supplied by the server. The <code class="parameter">attempt</code> is a counter giving the
|
||
number of times the request has been retried with different
|
||
authentication credentials. The first time the callback is invoked
|
||
for a particular request, <code class="parameter">attempt</code> will be zero.</p><p>To retry the request using new authentication
|
||
credentials, the callback should return zero, and the
|
||
<code class="parameter">username</code> and <code class="parameter">password</code>
|
||
buffers must contain <code class="literal">NUL</code>-terminated strings. The
|
||
<code class="literal">NE_ABUFSIZ</code> constant gives the size of these
|
||
buffers.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>If you only wish to allow the user one attempt to enter
|
||
credentials, use the value of the <code class="parameter">attempt</code>
|
||
parameter as the return value of the callback.</p></div><p>To abort the request, the callback should return a
|
||
non-zero value; in which case the contents of the
|
||
<code class="parameter">username</code> and <code class="parameter">password</code>
|
||
buffers are ignored.</p><p>The <code class="function">ne_forget_auth</code> function can be
|
||
used to discard the cached authentication credentials.</p></div><div class="refsect1" lang="en"><a name="id2939865"></a><h2>Examples</h2><pre class="programlisting">
|
||
/* Function which prompts for a line of user input: */
|
||
extern char *prompt_for(const char *prompt);
|
||
|
||
static int
|
||
my_auth(void *userdata, const char *realm, int attempts,
|
||
char *username, char *password)
|
||
{
|
||
strncpy(username, prompt_for("Username: "), NE_ABUFSIZ);
|
||
strncpy(password, prompt_for("Password: "), NE_ABUFSIZ);
|
||
return attempts;
|
||
}
|
||
|
||
int main(...)
|
||
{
|
||
ne_session *sess = ne_session_create(...);
|
||
|
||
ne_set_server_auth(sess, my_auth, NULL);
|
||
|
||
/* ... */
|
||
}</pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="refreqbody.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="refshave.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ne_set_request_body_buffer </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> ne_shave</td></tr></table></div></body></html>
|