← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/libsoup2.4/jaunty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/xml/soup-auth.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-12-17 14:51:11 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20081217145111-sqbz10l57fmrh4vz
Tags: 2.25.4-0ubuntu1
* New upstream version
* debian/control.in:
  - build-depends on libgconf2-dev, libproxy-dev
* Updated to list the new libsoup-gnome binaries
* debian/rules:
  - updated shlibs version and list the new library

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/soup-auth.xml
11
11
<refnamediv>
12
12
<refname>SoupAuth</refname>
13
13
<refpurpose>HTTP client-side authentication support</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="SoupAuth.synopsis" role="synopsis">
19
18
 
20
19
<synopsis>
21
20
struct              <link linkend="SoupAuth-struct">SoupAuth</link>;
22
 
<link linkend="SoupAuth">SoupAuth</link>*           <link linkend="soup-auth-new">soup_auth_new</link>                       (<link linkend="GType">GType</link> type,
 
21
<link linkend="SoupAuth">SoupAuth</link> *          <link linkend="soup-auth-new">soup_auth_new</link>                       (<link linkend="GType">GType</link> type,
23
22
                                                         <link linkend="SoupMessage">SoupMessage</link> *msg,
24
23
                                                         const <link linkend="char">char</link> *auth_header);
25
24
<link linkend="gboolean">gboolean</link>            <link linkend="soup-auth-update">soup_auth_update</link>                    (<link linkend="SoupAuth">SoupAuth</link> *auth,
27
26
                                                         const <link linkend="char">char</link> *auth_header);
28
27
 
29
28
<link linkend="gboolean">gboolean</link>            <link linkend="soup-auth-is-for-proxy">soup_auth_is_for_proxy</link>              (<link linkend="SoupAuth">SoupAuth</link> *auth);
30
 
const <link linkend="char">char</link>*         <link linkend="soup-auth-get-scheme-name">soup_auth_get_scheme_name</link>           (<link linkend="SoupAuth">SoupAuth</link> *auth);
31
 
const <link linkend="char">char</link>*         <link linkend="soup-auth-get-host">soup_auth_get_host</link>                  (<link linkend="SoupAuth">SoupAuth</link> *auth);
32
 
const <link linkend="char">char</link>*         <link linkend="soup-auth-get-realm">soup_auth_get_realm</link>                 (<link linkend="SoupAuth">SoupAuth</link> *auth);
33
 
<link linkend="char">char</link>*               <link linkend="soup-auth-get-info">soup_auth_get_info</link>                  (<link linkend="SoupAuth">SoupAuth</link> *auth);
 
29
const <link linkend="char">char</link> *        <link linkend="soup-auth-get-scheme-name">soup_auth_get_scheme_name</link>           (<link linkend="SoupAuth">SoupAuth</link> *auth);
 
30
const <link linkend="char">char</link> *        <link linkend="soup-auth-get-host">soup_auth_get_host</link>                  (<link linkend="SoupAuth">SoupAuth</link> *auth);
 
31
const <link linkend="char">char</link> *        <link linkend="soup-auth-get-realm">soup_auth_get_realm</link>                 (<link linkend="SoupAuth">SoupAuth</link> *auth);
 
32
<link linkend="char">char</link> *              <link linkend="soup-auth-get-info">soup_auth_get_info</link>                  (<link linkend="SoupAuth">SoupAuth</link> *auth);
34
33
 
35
34
<link linkend="void">void</link>                <link linkend="soup-auth-authenticate">soup_auth_authenticate</link>              (<link linkend="SoupAuth">SoupAuth</link> *auth,
36
35
                                                         const <link linkend="char">char</link> *username,
37
36
                                                         const <link linkend="char">char</link> *password);
38
37
<link linkend="gboolean">gboolean</link>            <link linkend="soup-auth-is-authenticated">soup_auth_is_authenticated</link>          (<link linkend="SoupAuth">SoupAuth</link> *auth);
39
38
 
40
 
<link linkend="char">char</link>*               <link linkend="soup-auth-get-authorization">soup_auth_get_authorization</link>         (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
39
<link linkend="char">char</link> *              <link linkend="soup-auth-get-authorization">soup_auth_get_authorization</link>         (<link linkend="SoupAuth">SoupAuth</link> *auth,
41
40
                                                         <link linkend="SoupMessage">SoupMessage</link> *msg);
42
 
<link linkend="GSList">GSList</link>*             <link linkend="soup-auth-get-protection-space">soup_auth_get_protection_space</link>      (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
41
<link linkend="GSList">GSList</link> *            <link linkend="soup-auth-get-protection-space">soup_auth_get_protection_space</link>      (<link linkend="SoupAuth">SoupAuth</link> *auth,
43
42
                                                         <link linkend="SoupURI">SoupURI</link> *source_uri);
44
43
<link linkend="void">void</link>                <link linkend="soup-auth-free-protection-space">soup_auth_free_protection_space</link>     (<link linkend="SoupAuth">SoupAuth</link> *auth,
45
44
                                                         <link linkend="GSList">GSList</link> *space);
46
45
 
47
 
#define             <link linkend="SOUP-AUTH-SCHEME-NAME:CAPS">SOUP_AUTH_SCHEME_NAME</link>
48
 
#define             <link linkend="SOUP-AUTH-REALM:CAPS">SOUP_AUTH_REALM</link>
49
 
#define             <link linkend="SOUP-AUTH-HOST:CAPS">SOUP_AUTH_HOST</link>
50
 
#define             <link linkend="SOUP-AUTH-IS-FOR-PROXY:CAPS">SOUP_AUTH_IS_FOR_PROXY</link>
51
 
#define             <link linkend="SOUP-AUTH-IS-AUTHENTICATED:CAPS">SOUP_AUTH_IS_AUTHENTICATED</link>
 
46
#define             <link linkend="SOUP-AUTH-SCHEME-NAME--CAPS">SOUP_AUTH_SCHEME_NAME</link>
 
47
#define             <link linkend="SOUP-AUTH-REALM--CAPS">SOUP_AUTH_REALM</link>
 
48
#define             <link linkend="SOUP-AUTH-HOST--CAPS">SOUP_AUTH_HOST</link>
 
49
#define             <link linkend="SOUP-AUTH-IS-FOR-PROXY--CAPS">SOUP_AUTH_IS_FOR_PROXY</link>
 
50
#define             <link linkend="SOUP-AUTH-IS-AUTHENTICATED--CAPS">SOUP_AUTH_IS_AUTHENTICATED</link>
52
51
</synopsis>
53
52
</refsynopsisdiv>
54
53
 
58
57
  <link linkend="GObject">GObject</link>
59
58
   +----SoupAuth
60
59
</synopsis>
61
 
 
62
60
</refsect1>
63
61
 
64
62
 
85
83
given bit of web space. They are created automatically by
86
84
<link linkend="SoupSession"><type>SoupSession</type></link>.</para>
87
85
<para>
88
 
 
89
86
</para>
90
87
</refsect1>
91
88
 
93
90
<title role="details.title">Details</title>
94
91
<refsect2 id="SoupAuth-struct" role="struct">
95
92
<title>struct SoupAuth</title>
96
 
<indexterm zone="SoupAuth-struct"><primary>SoupAuth</primary></indexterm><programlisting>struct SoupAuth;</programlisting>
 
93
<indexterm zone="SoupAuth-struct"><primary sortas="SoupAuth">SoupAuth</primary></indexterm><programlisting>struct SoupAuth;</programlisting>
97
94
<para>
98
95
The abstract base class for handling authentication. Specific HTTP
99
96
Authentication mechanisms are implemented by its subclasses, but
100
97
applications never need to be aware of the specific subclasses
101
98
being used.</para>
102
99
<para>
103
 
 
104
100
</para></refsect2>
105
101
<refsect2 id="soup-auth-new" role="function">
106
102
<title>soup_auth_new ()</title>
107
 
<indexterm zone="soup-auth-new"><primary>soup_auth_new</primary></indexterm><programlisting><link linkend="SoupAuth">SoupAuth</link>*           soup_auth_new                       (<link linkend="GType">GType</link> type,
 
103
<indexterm zone="soup-auth-new"><primary sortas="soup_auth_new">soup_auth_new</primary></indexterm><programlisting><link linkend="SoupAuth">SoupAuth</link> *          soup_auth_new                       (<link linkend="GType">GType</link> type,
108
104
                                                         <link linkend="SoupMessage">SoupMessage</link> *msg,
109
105
                                                         const <link linkend="char">char</link> *auth_header);</programlisting>
110
106
<para>
115
111
This is called by <link linkend="SoupSession"><type>SoupSession</type></link>; you will normally not create auths
116
112
yourself.</para>
117
113
<para>
118
 
 
119
114
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
115
<varlistentry><term><parameter>type</parameter>&#160;:</term>
121
116
<listitem><simpara> the type of auth to create (a subtype of <link linkend="SoupAuth"><type>SoupAuth</type></link>)
122
117
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
124
119
<listitem><simpara> the <link linkend="SoupMessage"><type>SoupMessage</type></link> the auth is being created for
125
120
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>auth_header</parameter>&nbsp;:</term>
 
121
<varlistentry><term><parameter>auth_header</parameter>&#160;:</term>
127
122
<listitem><simpara> the WWW-Authenticate/Proxy-Authenticate header
128
123
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="SoupAuth"><type>SoupAuth</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it could not be
 
124
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="SoupAuth"><type>SoupAuth</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if it could not be
130
125
created
131
126
</simpara></listitem></varlistentry>
132
127
</variablelist></refsect2>
133
128
<refsect2 id="soup-auth-update" role="function">
134
129
<title>soup_auth_update ()</title>
135
 
<indexterm zone="soup-auth-update"><primary>soup_auth_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_update                    (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
130
<indexterm zone="soup-auth-update"><primary sortas="soup_auth_update">soup_auth_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_update                    (<link linkend="SoupAuth">SoupAuth</link> *auth,
136
131
                                                         <link linkend="SoupMessage">SoupMessage</link> *msg,
137
132
                                                         const <link linkend="char">char</link> *auth_header);</programlisting>
138
133
<para>
140
135
possibly un-authenticating it. As with <link linkend="soup-auth-new"><function>soup_auth_new()</function></link>, this is
141
136
normally only used by <link linkend="SoupSession"><type>SoupSession</type></link>.</para>
142
137
<para>
143
 
 
144
138
</para><variablelist role="params">
145
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
139
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
146
140
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
147
141
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
142
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
149
143
<listitem><simpara> the <link linkend="SoupMessage"><type>SoupMessage</type></link> <parameter>auth</parameter> is being updated for
150
144
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><parameter>auth_header</parameter>&nbsp;:</term>
 
145
<varlistentry><term><parameter>auth_header</parameter>&#160;:</term>
152
146
<listitem><simpara> the WWW-Authenticate/Proxy-Authenticate header
153
147
</simpara></listitem></varlistentry>
154
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>auth</parameter> is still a valid (but potentially
155
 
unauthenticated) <link linkend="SoupAuth"><type>SoupAuth</type></link>. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if something about <parameter>auth_params</parameter>
 
148
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>auth</parameter> is still a valid (but potentially
 
149
unauthenticated) <link linkend="SoupAuth"><type>SoupAuth</type></link>. <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if something about <parameter>auth_params</parameter>
156
150
could not be parsed or incorporated into <parameter>auth</parameter> at all.
157
151
</simpara></listitem></varlistentry>
158
152
</variablelist></refsect2>
159
153
<refsect2 id="soup-auth-is-for-proxy" role="function">
160
154
<title>soup_auth_is_for_proxy ()</title>
161
 
<indexterm zone="soup-auth-is-for-proxy"><primary>soup_auth_is_for_proxy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_is_for_proxy              (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
155
<indexterm zone="soup-auth-is-for-proxy"><primary sortas="soup_auth_is_for_proxy">soup_auth_is_for_proxy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_is_for_proxy              (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
162
156
<para>
163
157
Tests whether or not <parameter>auth</parameter> is associated with a proxy server rather
164
158
than an "origin" server.</para>
165
159
<para>
166
 
 
167
160
</para><variablelist role="params">
168
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
169
162
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
170
163
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
 
164
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
172
165
</simpara></listitem></varlistentry>
173
166
</variablelist></refsect2>
174
167
<refsect2 id="soup-auth-get-scheme-name" role="function">
175
168
<title>soup_auth_get_scheme_name ()</title>
176
 
<indexterm zone="soup-auth-get-scheme-name"><primary>soup_auth_get_scheme_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         soup_auth_get_scheme_name           (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
169
<indexterm zone="soup-auth-get-scheme-name"><primary sortas="soup_auth_get_scheme_name">soup_auth_get_scheme_name</primary></indexterm><programlisting>const <link linkend="char">char</link> *        soup_auth_get_scheme_name           (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
177
170
<para>
178
171
Returns <parameter>auth</parameter>'s scheme name. (Eg, "Basic", "Digest", or "NTLM")</para>
179
172
<para>
180
 
 
181
173
</para><variablelist role="params">
182
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
174
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
183
175
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
184
176
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the scheme name
 
177
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the scheme name
186
178
</simpara></listitem></varlistentry>
187
179
</variablelist></refsect2>
188
180
<refsect2 id="soup-auth-get-host" role="function">
189
181
<title>soup_auth_get_host ()</title>
190
 
<indexterm zone="soup-auth-get-host"><primary>soup_auth_get_host</primary></indexterm><programlisting>const <link linkend="char">char</link>*         soup_auth_get_host                  (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
182
<indexterm zone="soup-auth-get-host"><primary sortas="soup_auth_get_host">soup_auth_get_host</primary></indexterm><programlisting>const <link linkend="char">char</link> *        soup_auth_get_host                  (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
191
183
<para>
192
184
Returns the host that <parameter>auth</parameter> is associated with.</para>
193
185
<para>
194
 
 
195
186
</para><variablelist role="params">
196
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
187
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
197
188
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
198
189
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the hostname
 
190
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the hostname
200
191
</simpara></listitem></varlistentry>
201
192
</variablelist></refsect2>
202
193
<refsect2 id="soup-auth-get-realm" role="function">
203
194
<title>soup_auth_get_realm ()</title>
204
 
<indexterm zone="soup-auth-get-realm"><primary>soup_auth_get_realm</primary></indexterm><programlisting>const <link linkend="char">char</link>*         soup_auth_get_realm                 (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
195
<indexterm zone="soup-auth-get-realm"><primary sortas="soup_auth_get_realm">soup_auth_get_realm</primary></indexterm><programlisting>const <link linkend="char">char</link> *        soup_auth_get_realm                 (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
205
196
<para>
206
197
Returns <parameter>auth</parameter>'s realm. This is an identifier that distinguishes
207
198
separate authentication spaces on a given server, and may be some
208
199
string that is meaningful to the user. (Although it is probably not
209
200
localized.)</para>
210
201
<para>
211
 
 
212
202
</para><variablelist role="params">
213
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
203
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
214
204
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
215
205
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the realm name
 
206
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the realm name
217
207
</simpara></listitem></varlistentry>
218
208
</variablelist></refsect2>
219
209
<refsect2 id="soup-auth-get-info" role="function">
220
210
<title>soup_auth_get_info ()</title>
221
 
<indexterm zone="soup-auth-get-info"><primary>soup_auth_get_info</primary></indexterm><programlisting><link linkend="char">char</link>*               soup_auth_get_info                  (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
211
<indexterm zone="soup-auth-get-info"><primary sortas="soup_auth_get_info">soup_auth_get_info</primary></indexterm><programlisting><link linkend="char">char</link> *              soup_auth_get_info                  (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
222
212
<para>
223
213
Gets an opaque identifier for <parameter>auth</parameter>, for use as a hash key or the
224
214
like. <link linkend="SoupAuth"><type>SoupAuth</type></link> objects from the same server with the same
225
215
identifier refer to the same authentication domain (eg, the URLs
226
216
associated with them take the same usernames and passwords).</para>
227
217
<para>
228
 
 
229
218
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
219
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
231
220
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
232
221
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the identifier
 
222
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the identifier
234
223
</simpara></listitem></varlistentry>
235
224
</variablelist></refsect2>
236
225
<refsect2 id="soup-auth-authenticate" role="function">
237
226
<title>soup_auth_authenticate ()</title>
238
 
<indexterm zone="soup-auth-authenticate"><primary>soup_auth_authenticate</primary></indexterm><programlisting><link linkend="void">void</link>                soup_auth_authenticate              (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
227
<indexterm zone="soup-auth-authenticate"><primary sortas="soup_auth_authenticate">soup_auth_authenticate</primary></indexterm><programlisting><link linkend="void">void</link>                soup_auth_authenticate              (<link linkend="SoupAuth">SoupAuth</link> *auth,
239
228
                                                         const <link linkend="char">char</link> *username,
240
229
                                                         const <link linkend="char">char</link> *password);</programlisting>
241
230
<para>
242
231
Call this on an auth to authenticate it; normally this will cause
243
232
the auth's message to be requeued with the new authentication info.</para>
244
233
<para>
245
 
 
246
234
</para><variablelist role="params">
247
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
235
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
248
236
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
249
237
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>username</parameter>&nbsp;:</term>
 
238
<varlistentry><term><parameter>username</parameter>&#160;:</term>
251
239
<listitem><simpara> the username provided by the user or client
252
240
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><parameter>password</parameter>&nbsp;:</term>
 
241
<varlistentry><term><parameter>password</parameter>&#160;:</term>
254
242
<listitem><simpara> the password provided by the user or client
255
243
</simpara></listitem></varlistentry>
256
244
</variablelist></refsect2>
257
245
<refsect2 id="soup-auth-is-authenticated" role="function">
258
246
<title>soup_auth_is_authenticated ()</title>
259
 
<indexterm zone="soup-auth-is-authenticated"><primary>soup_auth_is_authenticated</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_is_authenticated          (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
 
247
<indexterm zone="soup-auth-is-authenticated"><primary sortas="soup_auth_is_authenticated">soup_auth_is_authenticated</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            soup_auth_is_authenticated          (<link linkend="SoupAuth">SoupAuth</link> *auth);</programlisting>
260
248
<para>
261
249
Tests if <parameter>auth</parameter> has been given a username and password</para>
262
250
<para>
263
 
 
264
251
</para><variablelist role="params">
265
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
252
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
266
253
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
267
254
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>auth</parameter> has been given a username and password
 
255
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>auth</parameter> has been given a username and password
269
256
</simpara></listitem></varlistentry>
270
257
</variablelist></refsect2>
271
258
<refsect2 id="soup-auth-get-authorization" role="function">
272
259
<title>soup_auth_get_authorization ()</title>
273
 
<indexterm zone="soup-auth-get-authorization"><primary>soup_auth_get_authorization</primary></indexterm><programlisting><link linkend="char">char</link>*               soup_auth_get_authorization         (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
260
<indexterm zone="soup-auth-get-authorization"><primary sortas="soup_auth_get_authorization">soup_auth_get_authorization</primary></indexterm><programlisting><link linkend="char">char</link> *              soup_auth_get_authorization         (<link linkend="SoupAuth">SoupAuth</link> *auth,
274
261
                                                         <link linkend="SoupMessage">SoupMessage</link> *msg);</programlisting>
275
262
<para>
276
263
Generates an appropriate "Authorization" header for <parameter>msg</parameter>. (The
277
264
session will only call this if <link linkend="soup-auth-is-authenticated"><function>soup_auth_is_authenticated()</function></link>
278
 
returned <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.)</para>
 
265
returned <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.)</para>
279
266
<para>
280
 
 
281
267
</para><variablelist role="params">
282
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
268
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
283
269
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
284
270
</simpara></listitem></varlistentry>
285
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
271
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
286
272
<listitem><simpara> the <link linkend="SoupMessage"><type>SoupMessage</type></link> to be authorized
287
273
</simpara></listitem></varlistentry>
288
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the "Authorization" header, which must be freed.
 
274
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the "Authorization" header, which must be freed.
289
275
</simpara></listitem></varlistentry>
290
276
</variablelist></refsect2>
291
277
<refsect2 id="soup-auth-get-protection-space" role="function">
292
278
<title>soup_auth_get_protection_space ()</title>
293
 
<indexterm zone="soup-auth-get-protection-space"><primary>soup_auth_get_protection_space</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             soup_auth_get_protection_space      (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
279
<indexterm zone="soup-auth-get-protection-space"><primary sortas="soup_auth_get_protection_space">soup_auth_get_protection_space</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            soup_auth_get_protection_space      (<link linkend="SoupAuth">SoupAuth</link> *auth,
294
280
                                                         <link linkend="SoupURI">SoupURI</link> *source_uri);</programlisting>
295
281
<para>
296
282
Returns a list of paths on the server which <parameter>auth</parameter> extends over.
298
284
of <parameter>auth</parameter>'s protection space, unless otherwise discovered not to
299
285
be.)</para>
300
286
<para>
301
 
 
302
287
</para><variablelist role="params">
303
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
288
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
304
289
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
305
290
</simpara></listitem></varlistentry>
306
 
<varlistentry><term><parameter>source_uri</parameter>&nbsp;:</term>
 
291
<varlistentry><term><parameter>source_uri</parameter>&#160;:</term>
307
292
<listitem><simpara> the URI of the request that <parameter>auth</parameter> was generated in
308
293
response to.
309
294
</simpara></listitem></varlistentry>
310
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the list of paths, which must be freed with
 
295
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the list of paths, which must be freed with
311
296
<link linkend="soup-auth-free-protection-space"><function>soup_auth_free_protection_space()</function></link>.
312
297
</simpara></listitem></varlistentry>
313
298
</variablelist></refsect2>
314
299
<refsect2 id="soup-auth-free-protection-space" role="function">
315
300
<title>soup_auth_free_protection_space ()</title>
316
 
<indexterm zone="soup-auth-free-protection-space"><primary>soup_auth_free_protection_space</primary></indexterm><programlisting><link linkend="void">void</link>                soup_auth_free_protection_space     (<link linkend="SoupAuth">SoupAuth</link> *auth,
 
301
<indexterm zone="soup-auth-free-protection-space"><primary sortas="soup_auth_free_protection_space">soup_auth_free_protection_space</primary></indexterm><programlisting><link linkend="void">void</link>                soup_auth_free_protection_space     (<link linkend="SoupAuth">SoupAuth</link> *auth,
317
302
                                                         <link linkend="GSList">GSList</link> *space);</programlisting>
318
303
<para>
319
304
Frees <parameter>space</parameter>.</para>
320
305
<para>
321
 
 
322
306
</para><variablelist role="params">
323
 
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
 
307
<varlistentry><term><parameter>auth</parameter>&#160;:</term>
324
308
<listitem><simpara> a <link linkend="SoupAuth"><type>SoupAuth</type></link>
325
309
</simpara></listitem></varlistentry>
326
 
<varlistentry><term><parameter>space</parameter>&nbsp;:</term>
 
310
<varlistentry><term><parameter>space</parameter>&#160;:</term>
327
311
<listitem><simpara> the return value from <link linkend="soup-auth-get-protection-space"><function>soup_auth_get_protection_space()</function></link>
328
312
</simpara></listitem></varlistentry>
329
313
</variablelist></refsect2>
330
 
<refsect2 id="SOUP-AUTH-SCHEME-NAME:CAPS" role="macro">
 
314
<refsect2 id="SOUP-AUTH-SCHEME-NAME--CAPS" role="macro">
331
315
<title>SOUP_AUTH_SCHEME_NAME</title>
332
 
<indexterm zone="SOUP-AUTH-SCHEME-NAME:CAPS"><primary>SOUP_AUTH_SCHEME_NAME</primary></indexterm><programlisting>#define SOUP_AUTH_SCHEME_NAME      "scheme-name"
 
316
<indexterm zone="SOUP-AUTH-SCHEME-NAME--CAPS"><primary sortas="SOUP_AUTH_SCHEME_NAME">SOUP_AUTH_SCHEME_NAME</primary></indexterm><programlisting>#define SOUP_AUTH_SCHEME_NAME      "scheme-name"
333
317
</programlisting>
334
318
<para>
335
 
 
336
319
</para></refsect2>
337
 
<refsect2 id="SOUP-AUTH-REALM:CAPS" role="macro">
 
320
<refsect2 id="SOUP-AUTH-REALM--CAPS" role="macro">
338
321
<title>SOUP_AUTH_REALM</title>
339
 
<indexterm zone="SOUP-AUTH-REALM:CAPS"><primary>SOUP_AUTH_REALM</primary></indexterm><programlisting>#define SOUP_AUTH_REALM            "realm"
 
322
<indexterm zone="SOUP-AUTH-REALM--CAPS"><primary sortas="SOUP_AUTH_REALM">SOUP_AUTH_REALM</primary></indexterm><programlisting>#define SOUP_AUTH_REALM            "realm"
340
323
</programlisting>
341
324
<para>
342
 
 
343
325
</para></refsect2>
344
 
<refsect2 id="SOUP-AUTH-HOST:CAPS" role="macro">
 
326
<refsect2 id="SOUP-AUTH-HOST--CAPS" role="macro">
345
327
<title>SOUP_AUTH_HOST</title>
346
 
<indexterm zone="SOUP-AUTH-HOST:CAPS"><primary>SOUP_AUTH_HOST</primary></indexterm><programlisting>#define SOUP_AUTH_HOST             "host"
 
328
<indexterm zone="SOUP-AUTH-HOST--CAPS"><primary sortas="SOUP_AUTH_HOST">SOUP_AUTH_HOST</primary></indexterm><programlisting>#define SOUP_AUTH_HOST             "host"
347
329
</programlisting>
348
330
<para>
349
 
 
350
331
</para></refsect2>
351
 
<refsect2 id="SOUP-AUTH-IS-FOR-PROXY:CAPS" role="macro">
 
332
<refsect2 id="SOUP-AUTH-IS-FOR-PROXY--CAPS" role="macro">
352
333
<title>SOUP_AUTH_IS_FOR_PROXY</title>
353
 
<indexterm zone="SOUP-AUTH-IS-FOR-PROXY:CAPS"><primary>SOUP_AUTH_IS_FOR_PROXY</primary></indexterm><programlisting>#define SOUP_AUTH_IS_FOR_PROXY     "is-for-proxy"
 
334
<indexterm zone="SOUP-AUTH-IS-FOR-PROXY--CAPS"><primary sortas="SOUP_AUTH_IS_FOR_PROXY">SOUP_AUTH_IS_FOR_PROXY</primary></indexterm><programlisting>#define SOUP_AUTH_IS_FOR_PROXY     "is-for-proxy"
354
335
</programlisting>
355
336
<para>
356
 
 
357
337
</para></refsect2>
358
 
<refsect2 id="SOUP-AUTH-IS-AUTHENTICATED:CAPS" role="macro">
 
338
<refsect2 id="SOUP-AUTH-IS-AUTHENTICATED--CAPS" role="macro">
359
339
<title>SOUP_AUTH_IS_AUTHENTICATED</title>
360
 
<indexterm zone="SOUP-AUTH-IS-AUTHENTICATED:CAPS"><primary>SOUP_AUTH_IS_AUTHENTICATED</primary></indexterm><programlisting>#define SOUP_AUTH_IS_AUTHENTICATED "is-authenticated"
 
340
<indexterm zone="SOUP-AUTH-IS-AUTHENTICATED--CAPS"><primary sortas="SOUP_AUTH_IS_AUTHENTICATED">SOUP_AUTH_IS_AUTHENTICATED</primary></indexterm><programlisting>#define SOUP_AUTH_IS_AUTHENTICATED "is-authenticated"
361
341
</programlisting>
362
342
<para>
363
 
 
364
343
</para></refsect2>
365
344
 
366
345
</refsect1>
367
346
<refsect1 id="SoupAuth.property-details" role="property_details">
368
347
<title role="property_details.title">Property Details</title>
369
 
<refsect2 id="SoupAuth--host"><title>The <literal>&quot;host&quot;</literal> property</title>
370
 
<indexterm zone="SoupAuth--host"><primary>SoupAuth:host</primary></indexterm><programlisting>  &quot;host&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
348
<refsect2 id="SoupAuth--host" role="property"><title>The <literal>&quot;host&quot;</literal> property</title>
 
349
<indexterm zone="SoupAuth--host"><primary sortas="SoupAuth:host">SoupAuth:host</primary></indexterm><programlisting>  &quot;host&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
371
350
<para>Authentication host.</para><para>Default value: NULL</para>
372
351
</refsect2>
373
 
<refsect2 id="SoupAuth--is-authenticated"><title>The <literal>&quot;is-authenticated&quot;</literal> property</title>
374
 
<indexterm zone="SoupAuth--is-authenticated"><primary>SoupAuth:is-authenticated</primary></indexterm><programlisting>  &quot;is-authenticated&quot;         <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
352
<refsect2 id="SoupAuth--is-authenticated" role="property"><title>The <literal>&quot;is-authenticated&quot;</literal> property</title>
 
353
<indexterm zone="SoupAuth--is-authenticated"><primary sortas="SoupAuth:is-authenticated">SoupAuth:is-authenticated</primary></indexterm><programlisting>  &quot;is-authenticated&quot;         <link linkend="gboolean">gboolean</link>              : Read</programlisting>
375
354
<para>Whether or not the auth is authenticated.</para><para>Default value: FALSE</para>
376
355
</refsect2>
377
 
<refsect2 id="SoupAuth--is-for-proxy"><title>The <literal>&quot;is-for-proxy&quot;</literal> property</title>
378
 
<indexterm zone="SoupAuth--is-for-proxy"><primary>SoupAuth:is-for-proxy</primary></indexterm><programlisting>  &quot;is-for-proxy&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
356
<refsect2 id="SoupAuth--is-for-proxy" role="property"><title>The <literal>&quot;is-for-proxy&quot;</literal> property</title>
 
357
<indexterm zone="SoupAuth--is-for-proxy"><primary sortas="SoupAuth:is-for-proxy">SoupAuth:is-for-proxy</primary></indexterm><programlisting>  &quot;is-for-proxy&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
379
358
<para>Whether or not the auth is for a proxy server.</para><para>Default value: FALSE</para>
380
359
</refsect2>
381
 
<refsect2 id="SoupAuth--realm"><title>The <literal>&quot;realm&quot;</literal> property</title>
382
 
<indexterm zone="SoupAuth--realm"><primary>SoupAuth:realm</primary></indexterm><programlisting>  &quot;realm&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
360
<refsect2 id="SoupAuth--realm" role="property"><title>The <literal>&quot;realm&quot;</literal> property</title>
 
361
<indexterm zone="SoupAuth--realm"><primary sortas="SoupAuth:realm">SoupAuth:realm</primary></indexterm><programlisting>  &quot;realm&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
383
362
<para>Authentication realm.</para><para>Default value: NULL</para>
384
363
</refsect2>
385
 
<refsect2 id="SoupAuth--scheme-name"><title>The <literal>&quot;scheme-name&quot;</literal> property</title>
386
 
<indexterm zone="SoupAuth--scheme-name"><primary>SoupAuth:scheme-name</primary></indexterm><programlisting>  &quot;scheme-name&quot;              <link linkend="gchar">gchar</link>*                : Read</programlisting>
 
364
<refsect2 id="SoupAuth--scheme-name" role="property"><title>The <literal>&quot;scheme-name&quot;</literal> property</title>
 
365
<indexterm zone="SoupAuth--scheme-name"><primary sortas="SoupAuth:scheme-name">SoupAuth:scheme-name</primary></indexterm><programlisting>  &quot;scheme-name&quot;              <link linkend="gchar">gchar</link>*                : Read</programlisting>
387
366
<para>Authentication scheme name.</para><para>Default value: NULL</para>
388
367
</refsect2>
389
 
 
390
368
</refsect1>
391
369
 
392
370
 
393
371
 
394
372
<refsect1 id="SoupAuth.see-also">
395
373
<title>See Also</title>
396
 
<link linkend="SoupSession"><type>SoupSession</type></link>
 
374
#SoupSession
397
375
</refsect1>
398
376
 
399
377
</refentry>