← Back to branch summary

~ubuntu-branches/ubuntu/dapper/lasso/dapper

« back to all changes in this revision

Viewing changes to docs/reference/html/LassoLogout.html

  • Committer: Bazaar Package Importer
  • Author(s): Loic Pefferkorn
  • Date: 2005-11-25 19:20:59 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051125192059-m4894lhpynmkrmwr
Tags: 0.6.3-4ubuntu1
Resynchronise with Debian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/LassoLogout.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>LassoLogout</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Lasso Reference Manual"><link rel="up" href="idff.html" title="Identity Federation Framework"><link rel="prev" href="LassoLecp.html" title="LassoLecp"><link rel="next" href="LassoDefederation.html" title="LassoDefederation"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="chapter" href="lasso.html" title="Lasso &amp; Liberty Alliance Overview"><link rel="chapter" href="architecture.html" title="Lasso Architecture"><link rel="chapter" href="idff.html" title="Identity Federation Framework"><link rel="chapter" href="idwsf.html" title="Identity Web Services Framework"><link rel="chapter" href="xml.html" title="Schemas"><link rel="chapter" href="misc.html" title="Misc"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="LassoLecp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="idff.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">Lasso Reference Manual</th><td><a accesskey="n" href="LassoDefederation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="LassoLogout"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">LassoLogout</span></h2><p>LassoLogout &#8212; Single Logout Profile</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>LassoLogout</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="Lasso Reference Manual">
 
7
<link rel="up" href="idff.html" title="Identity Federation Framework">
 
8
<link rel="prev" href="LassoLecp.html" title="LassoLecp">
 
9
<link rel="next" href="LassoDefederation.html" title="LassoDefederation">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="chapter" href="lasso.html" title="Lasso &amp; Liberty Alliance Overview">
 
13
<link rel="chapter" href="architecture.html" title="Lasso Architecture">
 
14
<link rel="chapter" href="idff.html" title="Identity Federation Framework">
 
15
<link rel="chapter" href="idwsf.html" title="Identity Web Services Framework">
 
16
<link rel="chapter" href="xml.html" title="Schemas">
 
17
<link rel="chapter" href="misc.html" title="Misc">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
21
<td><a accesskey="p" href="LassoLecp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
22
<td><a accesskey="u" href="idff.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
24
<th width="100%" align="center">Lasso Reference Manual</th>
 
25
<td><a accesskey="n" href="LassoDefederation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
26
</tr></table>
 
27
<div class="refentry" lang="en">
 
28
<a name="LassoLogout"></a><div class="titlepage"></div>
 
29
<div class="refnamediv"><table width="100%"><tr>
 
30
<td valign="top">
 
31
<h2><span class="refentrytitle">LassoLogout</span></h2>
 
32
<p>LassoLogout &#8212; Single Logout Profile</p>
 
33
</td>
 
34
<td valign="top" align="right"></td>
 
35
</tr></table></div>
 
36
<div class="refsynopsisdiv">
 
37
<h2>Synopsis</h2>
 
38
<pre class="synopsis">
2
39
 
3
40
#include &lt;lasso/lasso.h&gt;
4
41
 
26
63
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);
27
64
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="LassoLogout.html#lasso-logout-validate-request">lasso_logout_validate_request</a>   (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);
28
65
 
29
 
</pre></div><div class="refsect1" lang="en"><a name="id2554756"></a><h2>Object Hierarchy</h2><pre class="synopsis">
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1" lang="en">
 
69
<a name="id2539439"></a><h2>Object Hierarchy</h2>
 
70
<pre class="synopsis">
30
71
 
31
72
  <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK>
32
73
   +----<a href="LassoNode.html" title="LassoNode">LassoNode</a>
33
74
         +----<a href="LassoProfile.html" title="LassoProfile">LassoProfile</a>
34
75
               +----LassoLogout
35
 
</pre></div><div class="refsect1" lang="en"><a name="id2554790"></a><h2>Description</h2><p>
36
 
 
37
 
</p></div><div class="refsect1" lang="en"><a name="id2554800"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2554805"></a><h3><a name="LassoLogout-struct"></a>LassoLogout</h3><a class="indexterm" name="id2554816"></a><pre class="programlisting">typedef struct _LassoLogout LassoLogout;</pre><p>
38
 
 
39
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2554831"></a><h3><a name="lasso-logout-new"></a>lasso_logout_new ()</h3><a class="indexterm" name="id2554842"></a><pre class="programlisting"><a href="LassoLogout.html" title="LassoLogout">LassoLogout</a>* lasso_logout_new               (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server);</pre><p>
40
 
Creates a new <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>.</p><p>
41
 
 
42
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>server</code></em>�:</span></td><td> the <a href="LassoServer.html" title="LassoServer"><span class="type">LassoServer</span></a>
43
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> a newly created <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a> object; or NULL if an error
 
76
</pre>
 
77
</div>
 
78
<div class="refsect1" lang="en">
 
79
<a name="id2539473"></a><h2>Description</h2>
 
80
<p>
 
81
 
 
82
</p>
 
83
</div>
 
84
<div class="refsect1" lang="en">
 
85
<a name="id2539483"></a><h2>Details</h2>
 
86
<div class="refsect2" lang="en">
 
87
<a name="id2539489"></a><h3>
 
88
<a name="LassoLogout-struct"></a>LassoLogout</h3>
 
89
<a class="indexterm" name="id2539499"></a><pre class="programlisting">typedef struct _LassoLogout LassoLogout;</pre>
 
90
<p>
 
91
 
 
92
</p>
 
93
</div>
 
94
<hr>
 
95
<div class="refsect2" lang="en">
 
96
<a name="id2539514"></a><h3>
 
97
<a name="lasso-logout-new"></a>lasso_logout_new ()</h3>
 
98
<a class="indexterm" name="id2539525"></a><pre class="programlisting"><a href="LassoLogout.html" title="LassoLogout">LassoLogout</a>* lasso_logout_new               (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server);</pre>
 
99
<p>
 
100
Creates a new <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>.</p>
 
101
<p>
 
102
 
 
103
</p>
 
104
<div class="variablelist"><table border="0">
 
105
<col align="left" valign="top">
 
106
<tbody>
 
107
<tr>
 
108
<td>
 
109
<span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></td>
 
110
<td> the <a href="LassoServer.html" title="LassoServer"><span class="type">LassoServer</span></a>
 
111
</td>
 
112
</tr>
 
113
<tr>
 
114
<td>
 
115
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
116
<td> a newly created <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a> object; or NULL if an error
44
117
    occured
45
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2554926"></a><h3><a name="lasso-logout-new-from-dump"></a>lasso_logout_new_from_dump ()</h3><a class="indexterm" name="id2554939"></a><pre class="programlisting"><a href="LassoLogout.html" title="LassoLogout">LassoLogout</a>* lasso_logout_new_from_dump     (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server,
46
 
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *dump);</pre><p>
47
 
Restores the <em class="parameter"><code>dump</code></em> to a new <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>.</p><p>
 
118
</td>
 
119
</tr>
 
120
</tbody>
 
121
</table></div>
 
122
</div>
 
123
<hr>
 
124
<div class="refsect2" lang="en">
 
125
<a name="id2539609"></a><h3>
 
126
<a name="lasso-logout-new-from-dump"></a>lasso_logout_new_from_dump ()</h3>
 
127
<a class="indexterm" name="id2539620"></a><pre class="programlisting"><a href="LassoLogout.html" title="LassoLogout">LassoLogout</a>* lasso_logout_new_from_dump     (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server,
 
128
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *dump);</pre>
 
129
<p>
 
130
Restores the <em class="parameter"><code>dump</code></em> to a new <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>.</p>
 
131
<p>
48
132
 
49
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>server</code></em>�:</span></td><td> the <a href="LassoServer.html" title="LassoServer"><span class="type">LassoServer</span></a>
50
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>dump</code></em>�:</span></td><td> XML logout dump
51
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> a newly created <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>; or NULL if an error occured
52
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555050"></a><h3><a name="lasso-logout-build-request-msg"></a>lasso_logout_build_request_msg ()</h3><a class="indexterm" name="id2555062"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_build_request_msg  (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
 
133
</p>
 
134
<div class="variablelist"><table border="0">
 
135
<col align="left" valign="top">
 
136
<tbody>
 
137
<tr>
 
138
<td>
 
139
<span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></td>
 
140
<td> the <a href="LassoServer.html" title="LassoServer"><span class="type">LassoServer</span></a>
 
141
</td>
 
142
</tr>
 
143
<tr>
 
144
<td>
 
145
<span class="term"><em class="parameter"><code>dump</code></em>&#160;:</span></td>
 
146
<td> XML logout dump
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td>
 
151
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
152
<td> a newly created <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>; or NULL if an error occured
 
153
</td>
 
154
</tr>
 
155
</tbody>
 
156
</table></div>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" lang="en">
 
160
<a name="id2539732"></a><h3>
 
161
<a name="lasso-logout-build-request-msg"></a>lasso_logout_build_request_msg ()</h3>
 
162
<a class="indexterm" name="id2539743"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_build_request_msg  (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
163
<p>
53
164
Builds the logout request message.
54
 
</p><p>
 
165
</p>
 
166
<p>
55
167
It gets the HTTP method retrieved to send the request and:
56
 
</p><div class="itemizedlist"><ul type="disc"><li><p>
 
168
</p>
 
169
<div class="itemizedlist"><ul type="disc">
 
170
<li><p>
57
171
  if it is a SOAP method, then it builds the logout request SOAP message,
58
172
  sets the msg_body attribute, gets the single logout service url and sets
59
173
  <em class="parameter"><code>msg_url</code></em> in the logout object.
60
 
</p></li><li><p>
 
174
</p></li>
 
175
<li><p>
61
176
  if it is a HTTP-Redirect method, then it builds the logout request QUERY
62
177
  message, builds the logout request url, sets <em class="parameter"><code>msg_url</code></em> in the logout
63
178
  request url, sets <em class="parameter"><code>msg_body</code></em> to NULL.
64
 
</p></li></ul></div><p>
65
 
</p><p>
 
179
</p></li>
 
180
</ul></div>
 
181
<p>
 
182
</p>
 
183
<p>
66
184
If private key and certificate are set in server object it will also signs
67
185
the message (either with X509 if SOAP or with a simple signature for query
68
 
strings).</p><p>
 
186
strings).</p>
 
187
<p>
69
188
 
70
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
71
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
72
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555176"></a><h3><a name="lasso-logout-build-response-msg"></a>lasso_logout_build_response_msg ()</h3><a class="indexterm" name="id2555188"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_build_response_msg (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
 
189
</p>
 
190
<div class="variablelist"><table border="0">
 
191
<col align="left" valign="top">
 
192
<tbody>
 
193
<tr>
 
194
<td>
 
195
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
196
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
197
</td>
 
198
</tr>
 
199
<tr>
 
200
<td>
 
201
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
202
<td> 0 on success; or a negative value otherwise.
 
203
</td>
 
204
</tr>
 
205
</tbody>
 
206
</table></div>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2" lang="en">
 
210
<a name="id2539857"></a><h3>
 
211
<a name="lasso-logout-build-response-msg"></a>lasso_logout_build_response_msg ()</h3>
 
212
<a class="indexterm" name="id2539868"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_build_response_msg (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
213
<p>
73
214
Builds the logout response message.
74
 
</p><p>
 
215
</p>
 
216
<p>
75
217
It gets the request message method and:
76
 
</p><div class="itemizedlist"><ul type="disc"><li><p>
 
218
</p>
 
219
<div class="itemizedlist"><ul type="disc">
 
220
<li><p>
77
221
   if it is a SOAP method, then it builds the logout response SOAP message,
78
222
   sets the msg_body attribute, gets the single logout service return url
79
223
   and sets <em class="parameter"><code>msg_url</code></em> in the logout object.
80
 
</p></li><li><p>
 
224
</p></li>
 
225
<li><p>
81
226
   if it is a HTTP-Redirect method, then it builds the logout response QUERY message,
82
227
   builds the logout response url, sets <em class="parameter"><code>msg_url</code></em> with the logout response url,
83
228
   sets <em class="parameter"><code>msg_body</code></em> to NULL
84
 
</p></li></ul></div><p>
85
 
</p><p>
 
229
</p></li>
 
230
</ul></div>
 
231
<p>
 
232
</p>
 
233
<p>
86
234
If private key and certificate are set in server object it will also signs
87
235
the message (either with X509 if SOAP or with a simple signature for query
88
 
strings).</p><p>
89
 
 
90
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
91
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
92
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555302"></a><h3><a name="lasso-logout-destroy"></a>lasso_logout_destroy ()</h3><a class="indexterm" name="id2555314"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_logout_destroy            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
93
 
Destroys a logout object.</p><p>
94
 
 
95
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
96
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555371"></a><h3><a name="lasso-logout-dump"></a>lasso_logout_dump ()</h3><a class="indexterm" name="id2555383"></a><pre class="programlisting"><GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK>*      lasso_logout_dump               (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
97
 
Dumps <em class="parameter"><code>logout</code></em> content to an XML string.</p><p>
98
 
 
99
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
100
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> the dump string.  It must be freed by the caller.
101
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555457"></a><h3><a name="lasso-logout-get-next-providerID"></a>lasso_logout_get_next_providerID ()</h3><a class="indexterm" name="id2555468"></a><pre class="programlisting"><GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK>*      lasso_logout_get_next_providerID
102
 
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
 
236
strings).</p>
 
237
<p>
 
238
 
 
239
</p>
 
240
<div class="variablelist"><table border="0">
 
241
<col align="left" valign="top">
 
242
<tbody>
 
243
<tr>
 
244
<td>
 
245
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
246
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
247
</td>
 
248
</tr>
 
249
<tr>
 
250
<td>
 
251
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
252
<td> 0 on success; or a negative value otherwise.
 
253
</td>
 
254
</tr>
 
255
</tbody>
 
256
</table></div>
 
257
</div>
 
258
<hr>
 
259
<div class="refsect2" lang="en">
 
260
<a name="id2539983"></a><h3>
 
261
<a name="lasso-logout-destroy"></a>lasso_logout_destroy ()</h3>
 
262
<a class="indexterm" name="id2539994"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_logout_destroy            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
263
<p>
 
264
Destroys a logout object.</p>
 
265
<p>
 
266
 
 
267
</p>
 
268
<div class="variablelist"><table border="0">
 
269
<col align="left" valign="top">
 
270
<tbody><tr>
 
271
<td>
 
272
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
273
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
274
</td>
 
275
</tr></tbody>
 
276
</table></div>
 
277
</div>
 
278
<hr>
 
279
<div class="refsect2" lang="en">
 
280
<a name="id2540051"></a><h3>
 
281
<a name="lasso-logout-dump"></a>lasso_logout_dump ()</h3>
 
282
<a class="indexterm" name="id2540062"></a><pre class="programlisting"><GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK>*      lasso_logout_dump               (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
283
<p>
 
284
Dumps <em class="parameter"><code>logout</code></em> content to an XML string.</p>
 
285
<p>
 
286
 
 
287
</p>
 
288
<div class="variablelist"><table border="0">
 
289
<col align="left" valign="top">
 
290
<tbody>
 
291
<tr>
 
292
<td>
 
293
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
294
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
295
</td>
 
296
</tr>
 
297
<tr>
 
298
<td>
 
299
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
300
<td> the dump string.  It must be freed by the caller.
 
301
</td>
 
302
</tr>
 
303
</tbody>
 
304
</table></div>
 
305
</div>
 
306
<hr>
 
307
<div class="refsect2" lang="en">
 
308
<a name="id2540136"></a><h3>
 
309
<a name="lasso-logout-get-next-providerID"></a>lasso_logout_get_next_providerID ()</h3>
 
310
<a class="indexterm" name="id2540147"></a><pre class="programlisting"><GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK>*      lasso_logout_get_next_providerID
 
311
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
312
<p>
103
313
Returns the provider id from providerID_index in list of providerIDs in
104
 
principal session with the exception of initial service provider ID.</p><p>
 
314
principal session with the exception of initial service provider ID.</p>
 
315
<p>
105
316
 
106
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
107
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> a newly allocated string or NULL
108
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555540"></a><h3><a name="lasso-logout-init-request"></a>lasso_logout_init_request ()</h3><a class="indexterm" name="id2555551"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_init_request       (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout,
 
317
</p>
 
318
<div class="variablelist"><table border="0">
 
319
<col align="left" valign="top">
 
320
<tbody>
 
321
<tr>
 
322
<td>
 
323
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
324
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
325
</td>
 
326
</tr>
 
327
<tr>
 
328
<td>
 
329
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
330
<td> a newly allocated string or NULL
 
331
</td>
 
332
</tr>
 
333
</tbody>
 
334
</table></div>
 
335
</div>
 
336
<hr>
 
337
<div class="refsect2" lang="en">
 
338
<a name="id2540219"></a><h3>
 
339
<a name="lasso-logout-init-request"></a>lasso_logout_init_request ()</h3>
 
340
<a class="indexterm" name="id2540230"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_init_request       (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout,
109
341
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *remote_providerID,
110
 
                                             <a href="LassoProvider.html#LassoHttpMethod">LassoHttpMethod</a> request_method);</pre><p>
111
 
Initializes a new lib:LogoutRequest.</p><p>
 
342
                                             <a href="LassoProvider.html#LassoHttpMethod">LassoHttpMethod</a> request_method);</pre>
 
343
<p>
 
344
Initializes a new lib:LogoutRequest.</p>
 
345
<p>
112
346
 
113
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
114
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>remote_providerID</code></em>�:</span></td><td> the providerID of the identity provider.  If NULL the
 
347
</p>
 
348
<div class="variablelist"><table border="0">
 
349
<col align="left" valign="top">
 
350
<tbody>
 
351
<tr>
 
352
<td>
 
353
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
354
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
355
</td>
 
356
</tr>
 
357
<tr>
 
358
<td>
 
359
<span class="term"><em class="parameter"><code>remote_providerID</code></em>&#160;:</span></td>
 
360
<td> the providerID of the identity provider.  If NULL the
115
361
    first identity provider is used.
116
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>request_method</code></em>�:</span></td><td> if set, then it get the protocol profile in metadata
 
362
</td>
 
363
</tr>
 
364
<tr>
 
365
<td>
 
366
<span class="term"><em class="parameter"><code>request_method</code></em>&#160;:</span></td>
 
367
<td> if set, then it get the protocol profile in metadata
117
368
    corresponding of this HTTP request method.
118
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
119
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555667"></a><h3><a name="lasso-logout-process-request-msg"></a>lasso_logout_process_request_msg ()</h3><a class="indexterm" name="id2555678"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_process_request_msg
 
369
</td>
 
370
</tr>
 
371
<tr>
 
372
<td>
 
373
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
374
<td> 0 on success; or a negative value otherwise.
 
375
</td>
 
376
</tr>
 
377
</tbody>
 
378
</table></div>
 
379
</div>
 
380
<hr>
 
381
<div class="refsect2" lang="en">
 
382
<a name="id2540345"></a><h3>
 
383
<a name="lasso-logout-process-request-msg"></a>lasso_logout_process_request_msg ()</h3>
 
384
<a class="indexterm" name="id2540356"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_process_request_msg
120
385
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout,
121
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *request_msg);</pre><p>
 
386
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *request_msg);</pre>
 
387
<p>
122
388
Processes a lib:LogoutRequest message.  Rebuilds a request object from the
123
 
message and optionally verifies its signature.</p><p>
 
389
message and optionally verifies its signature.</p>
 
390
<p>
124
391
 
125
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
126
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>request_msg</code></em>�:</span></td><td> the logout request message
127
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
128
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555771"></a><h3><a name="lasso-logout-process-response-msg"></a>lasso_logout_process_response_msg ()</h3><a class="indexterm" name="id2555784"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_process_response_msg
 
392
</p>
 
393
<div class="variablelist"><table border="0">
 
394
<col align="left" valign="top">
 
395
<tbody>
 
396
<tr>
 
397
<td>
 
398
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
399
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
400
</td>
 
401
</tr>
 
402
<tr>
 
403
<td>
 
404
<span class="term"><em class="parameter"><code>request_msg</code></em>&#160;:</span></td>
 
405
<td> the logout request message
 
406
</td>
 
407
</tr>
 
408
<tr>
 
409
<td>
 
410
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
411
<td> 0 on success; or a negative value otherwise.
 
412
</td>
 
413
</tr>
 
414
</tbody>
 
415
</table></div>
 
416
</div>
 
417
<hr>
 
418
<div class="refsect2" lang="en">
 
419
<a name="id2540449"></a><h3>
 
420
<a name="lasso-logout-process-response-msg"></a>lasso_logout_process_response_msg ()</h3>
 
421
<a class="indexterm" name="id2540461"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_process_response_msg
129
422
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout,
130
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *response_msg);</pre><p>
 
423
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *response_msg);</pre>
 
424
<p>
131
425
Parses the response message and builds the response object.
132
 
</p><p>
 
426
</p>
 
427
<p>
133
428
Checks the status code value and if it is not success, then if the local
134
429
provider is a Service Provider and response method is SOAP, then builds a
135
430
new logout request message for HTTP Redirect / GET method and returns the
136
431
error code LASSO_LOGOUT_ERROR_UNSUPPORTED_PROFILE.
137
 
</p><p>
 
432
</p>
 
433
<p>
138
434
If it is a SOAP method or, IDP type and http method is Redirect/GET,
139
435
then removes assertion.
140
 
</p><p>
 
436
</p>
 
437
<p>
141
438
If local server is an Identity Provider and if there is no more assertion
142
439
(Identity Provider has logged out every Service Providers), then restores
143
 
the initial response.</p><p>
144
 
 
145
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
146
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>response_msg</code></em>�:</span></td><td> the response message
147
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
148
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555894"></a><h3><a name="lasso-logout-reset-providerID-index"></a>lasso_logout_reset_providerID_index ()</h3><a class="indexterm" name="id2555907"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_reset_providerID_index
149
 
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
150
 
Reset the providerID_index attribute (set to 0).</p><p>
151
 
 
152
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
153
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
154
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555976"></a><h3><a name="lasso-logout-validate-request"></a>lasso_logout_validate_request ()</h3><a class="indexterm" name="id2555988"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_validate_request   (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre><p>
155
 
</p><div class="itemizedlist"><ul type="disc"><li>
 
440
the initial response.</p>
 
441
<p>
 
442
 
 
443
</p>
 
444
<div class="variablelist"><table border="0">
 
445
<col align="left" valign="top">
 
446
<tbody>
 
447
<tr>
 
448
<td>
 
449
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
450
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
451
</td>
 
452
</tr>
 
453
<tr>
 
454
<td>
 
455
<span class="term"><em class="parameter"><code>response_msg</code></em>&#160;:</span></td>
 
456
<td> the response message
 
457
</td>
 
458
</tr>
 
459
<tr>
 
460
<td>
 
461
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
462
<td> 0 on success; or a negative value otherwise.
 
463
</td>
 
464
</tr>
 
465
</tbody>
 
466
</table></div>
 
467
</div>
 
468
<hr>
 
469
<div class="refsect2" lang="en">
 
470
<a name="id2540571"></a><h3>
 
471
<a name="lasso-logout-reset-providerID-index"></a>lasso_logout_reset_providerID_index ()</h3>
 
472
<a class="indexterm" name="id2540583"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_reset_providerID_index
 
473
                                            (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
474
<p>
 
475
Reset the providerID_index attribute (set to 0).</p>
 
476
<p>
 
477
 
 
478
</p>
 
479
<div class="variablelist"><table border="0">
 
480
<col align="left" valign="top">
 
481
<tbody>
 
482
<tr>
 
483
<td>
 
484
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
485
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
486
</td>
 
487
</tr>
 
488
<tr>
 
489
<td>
 
490
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
491
<td> 0 on success; or a negative value otherwise.
 
492
</td>
 
493
</tr>
 
494
</tbody>
 
495
</table></div>
 
496
</div>
 
497
<hr>
 
498
<div class="refsect2" lang="en">
 
499
<a name="id2540653"></a><h3>
 
500
<a name="lasso-logout-validate-request"></a>lasso_logout_validate_request ()</h3>
 
501
<a class="indexterm" name="id2540664"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_logout_validate_request   (<a href="LassoLogout.html" title="LassoLogout">LassoLogout</a> *logout);</pre>
 
502
<p>
 
503
</p>
 
504
<div class="itemizedlist"><ul type="disc">
 
505
<li>
156
506
  Sets the remote provider id
157
 
</li><li>
 
507
</li>
 
508
<li>
158
509
  Sets a logout response with status code value to success.
159
 
</li><li>
 
510
</li>
 
511
<li>
160
512
  Verifies federation and authentication.
161
 
</li><li>
 
513
</li>
 
514
<li>
162
515
  If the request http method is a SOAP method, then verifies every other
163
516
  Service Providers supports SOAP method : if not, then sets status code
164
517
  value to UnsupportedProfile and returns a code error with
165
518
  LASSO_LOGOUT_ERROR_UNSUPPORTED_PROFILE.
166
 
</li><li>
 
519
</li>
 
520
<li>
167
521
  Every tests are ok, then removes assertion.
168
 
</li><li>
 
522
</li>
 
523
<li>
169
524
  If local server is an Identity Provider and if there is more than one
170
525
  Service Provider (except the initial Service Provider), then saves the
171
526
  initial request, response and remote provider id.
172
 
</li></ul></div><p>
 
527
</li>
 
528
</ul></div>
 
529
<p>
173
530
 
174
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>logout</code></em>�:</span></td><td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
175
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
176
 
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="LassoLecp.html"><b>&lt;&lt;�LassoLecp</b></a></td><td align="right"><a accesskey="n" href="LassoDefederation.html"><b>LassoDefederation�&gt;&gt;</b></a></td></tr></table></body></html>
 
531
</p>
 
532
<div class="variablelist"><table border="0">
 
533
<col align="left" valign="top">
 
534
<tbody>
 
535
<tr>
 
536
<td>
 
537
<span class="term"><em class="parameter"><code>logout</code></em>&#160;:</span></td>
 
538
<td> a <a href="LassoLogout.html" title="LassoLogout"><span class="type">LassoLogout</span></a>
 
539
</td>
 
540
</tr>
 
541
<tr>
 
542
<td>
 
543
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
544
<td> 0 on success; or a negative value otherwise.
 
545
</td>
 
546
</tr>
 
547
</tbody>
 
548
</table></div>
 
549
</div>
 
550
</div>
 
551
</div>
 
552
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
553
<td align="left"><a accesskey="p" href="LassoLecp.html"><b>&lt;&lt;&#160;LassoLecp</b></a></td>
 
554
<td align="right"><a accesskey="n" href="LassoDefederation.html"><b>LassoDefederation&#160;&gt;&gt;</b></a></td>
 
555
</tr></table>
 
556
</body>
 
557
</html>