1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>SoupAuth</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch02.html" title="libsoup API Reference">
<link rel="prev" href="SoupAddress.html" title="SoupAddress">
<link rel="next" href="SoupConnection.html" title="SoupConnection">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="libsoup Tutorial">
<link rel="chapter" href="ch02.html" title="libsoup API Reference">
<link rel="chapter" href="ch03.html" title="libsoup internals">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="SoupAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsoup Reference Manual</th>
<td><a accesskey="n" href="SoupConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id337980" class="shortcut">Top</a>
 | 
<a href="#id369933" class="shortcut">Description</a>
 | 
<a href="#id369856" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="SoupAuth"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id337980"></a><span class="refentrytitle">SoupAuth</span>
</h2>
<p>SoupAuth — HTTP Authentication support</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="SoupAuthBasic"></a><a name="SoupAuthDigest"></a><pre class="synopsis">
<a href="SoupAuth.html#SoupAuth-struct">SoupAuth</a>;
<a href="SoupAuth.html#SoupAuthBasic-struct">SoupAuthBasic</a>;
<a href="SoupAuth.html#SoupAuthDigest-struct">SoupAuthDigest</a>;
<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a>* <a href="SoupAuth.html#soup-auth-new-from-header-list">soup_auth_new_from_header_list</a> (const <a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *vals);
const char* <a href="SoupAuth.html#soup-auth-get-scheme-name">soup_auth_get_scheme_name</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);
const char* <a href="SoupAuth.html#soup-auth-get-realm">soup_auth_get_realm</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);
void <a href="SoupAuth.html#soup-auth-authenticate">soup_auth_authenticate</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
const char *username,
const char *password);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="SoupAuth.html#soup-auth-is-authenticated">soup_auth_is_authenticated</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);
char* <a href="SoupAuth.html#soup-auth-get-authorization">soup_auth_get_authorization</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
<a href="SoupMessage.html" title="SoupMessage">SoupMessage</a> *msg);
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* <a href="SoupAuth.html#soup-auth-get-protection-space">soup_auth_get_protection_space</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
const <a href="libsoup-SoupUri.html#SoupUri">SoupUri</a> *source_uri);
void <a href="SoupAuth.html#soup-auth-free-protection-space">soup_auth_free_protection_space</a> (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *space);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id369856"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----SoupAuth
+----<a href="SoupAuth.html#SoupAuthBasic">SoupAuthBasic</a>
+----<a href="SoupAuth.html#SoupAuthDigest">SoupAuthDigest</a>
</pre>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a>
+----SoupAuthBasic
</pre>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a>
+----SoupAuthDigest
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id369933"></a><h2>Description</h2>
<p>
<a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> objects store the authentication data associated with a
given bit of webspace. They are created and maintained automatically
by <a href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id359855"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id359866"></a><h3>
<a name="SoupAuth-struct"></a>SoupAuth</h3>
<a class="indexterm" name="id359880"></a><pre class="programlisting">typedef struct _SoupAuth SoupAuth;</pre>
<p>
The abstract base class for handling authentication. Specific HTTP
Authentication mechanisms are implemented by its subclasses. (NTLM
authentication, which works quite differently from normal HTTP
authentication, is handled by <a href="SoupConnectionNTLM.html" title="SoupConnectionNTLM"><span class="type">SoupConnectionNTLM</span></a>.)
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id359906"></a><h3>
<a name="SoupAuthBasic-struct"></a>SoupAuthBasic</h3>
<a class="indexterm" name="id359919"></a><pre class="programlisting">typedef struct _SoupAuthBasic SoupAuthBasic;</pre>
<p>
An object representing Basic HTTP authentication.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id359935"></a><h3>
<a name="SoupAuthDigest-struct"></a>SoupAuthDigest</h3>
<a class="indexterm" name="id359948"></a><pre class="programlisting">typedef struct _SoupAuthDigest SoupAuthDigest;</pre>
<p>
An object representing Digest HTTP authentication.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id359965"></a><h3>
<a name="soup-auth-new-from-header-list"></a>soup_auth_new_from_header_list ()</h3>
<a class="indexterm" name="id352761"></a><pre class="programlisting"><a href="SoupAuth.html" title="SoupAuth">SoupAuth</a>* soup_auth_new_from_header_list (const <a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *vals);</pre>
<p>
Creates a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> value based on the strongest available
supported auth type in <em class="parameter"><code>vals</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>vals</code></em> :</span></td>
<td> a list of WWW-Authenticate headers from a server response
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if none could be created.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id352858"></a><h3>
<a name="soup-auth-get-scheme-name"></a>soup_auth_get_scheme_name ()</h3>
<a class="indexterm" name="id352871"></a><pre class="programlisting">const char* soup_auth_get_scheme_name (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);</pre>
<p>
Returns <em class="parameter"><code>auth</code></em>'s scheme name. (Eg, "Basic")</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the scheme name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id352953"></a><h3>
<a name="soup-auth-get-realm"></a>soup_auth_get_realm ()</h3>
<a class="indexterm" name="id352966"></a><pre class="programlisting">const char* soup_auth_get_realm (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);</pre>
<p>
Returns <em class="parameter"><code>auth</code></em>'s realm.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the realm name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id371579"></a><h3>
<a name="soup-auth-authenticate"></a>soup_auth_authenticate ()</h3>
<a class="indexterm" name="id371592"></a><pre class="programlisting">void soup_auth_authenticate (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
const char *username,
const char *password);</pre>
<p>
This is called by the session after requesting a username and
password from the application. <em class="parameter"><code>auth</code></em> will take the information
and do whatever scheme-specific processing is needed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>username</code></em> :</span></td>
<td> the username provided by the user or client
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>password</code></em> :</span></td>
<td> the password provided by the user or client
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id371706"></a><h3>
<a name="soup-auth-is-authenticated"></a>soup_auth_is_authenticated ()</h3>
<a class="indexterm" name="id371716"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> soup_auth_is_authenticated (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth);</pre>
<p>
Tests if <em class="parameter"><code>auth</code></em> has been given a username and password</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>auth</code></em> has been given a username and password
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id371791"></a><h3>
<a name="soup-auth-get-authorization"></a>soup_auth_get_authorization ()</h3>
<a class="indexterm" name="id371801"></a><pre class="programlisting">char* soup_auth_get_authorization (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
<a href="SoupMessage.html" title="SoupMessage">SoupMessage</a> *msg);</pre>
<p>
Generates an appropriate "Authorization" header for <em class="parameter"><code>msg</code></em>. (The
session will only call this if <a href="SoupAuth.html#soup-auth-is-authenticated"><code class="function">soup_auth_is_authenticated()</code></a>
returned <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>msg</code></em> :</span></td>
<td> the <a href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> to be authorized
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the "Authorization" header, which must be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id371909"></a><h3>
<a name="soup-auth-get-protection-space"></a>soup_auth_get_protection_space ()</h3>
<a class="indexterm" name="id371921"></a><pre class="programlisting"><a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* soup_auth_get_protection_space (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
const <a href="libsoup-SoupUri.html#SoupUri">SoupUri</a> *source_uri);</pre>
<p>
Returns a list of paths on the server which <em class="parameter"><code>auth</code></em> extends over.
(All subdirectories of these paths are also assumed to be part
of <em class="parameter"><code>auth</code></em>'s protection space, unless otherwise discovered not to
be.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>source_uri</code></em> :</span></td>
<td> the URI of the request that <em class="parameter"><code>auth</code></em> was generated in
response to.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list of paths, which must be freed with
<a href="SoupAuth.html#soup-auth-free-protection-space"><code class="function">soup_auth_free_protection_space()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id372034"></a><h3>
<a name="soup-auth-free-protection-space"></a>soup_auth_free_protection_space ()</h3>
<a class="indexterm" name="id372046"></a><pre class="programlisting">void soup_auth_free_protection_space (<a href="SoupAuth.html" title="SoupAuth">SoupAuth</a> *auth,
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *space);</pre>
<p>
Frees <em class="parameter"><code>space</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>auth</code></em> :</span></td>
<td> a <a href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>space</code></em> :</span></td>
<td> the return value from <a href="SoupAuth.html#soup-auth-get-protection-space"><code class="function">soup_auth_get_protection_space()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id372136"></a><h2>See Also</h2>
<p>
<a href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, <a href="SoupConnectionNTLM.html" title="SoupConnectionNTLM"><span class="type">SoupConnectionNTLM</span></a>
</p>
</div>
</div>
</body>
</html>
|
