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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelSasl</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Crypto.html" title="Crypto Contexts">
<link rel="prev" href="camel-CamelSMIMEContext.html" title="CamelSMIMEContext">
<link rel="next" href="camel-CamelSaslAnonymous.html" title="CamelSaslAnonymous">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="camel-CamelSMIMEContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Crypto.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">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelSaslAnonymous.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelSasl.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelSasl.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelSasl">
<a name="camel-CamelSasl"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelSasl.top_of_page"></a>CamelSasl</span></h2>
<p>CamelSasl</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelSasl.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl">CamelSasl</a>;
<span class="returnvalue">GByteArray</span> * <a class="link" href="camel-CamelSasl.html#camel-sasl-challenge" title="camel_sasl_challenge ()">camel_sasl_challenge</a> (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GByteArray</span> *token</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelSasl.html#camel-sasl-challenge-base64" title="camel_sasl_challenge_base64 ()">camel_sasl_challenge_base64</a> (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-CamelSasl.html#camel-sasl-authenticated" title="camel_sasl_authenticated ()">camel_sasl_authenticated</a> (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);
<a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="returnvalue">CamelSasl</span></a> * <a class="link" href="camel-CamelSasl.html#camel-sasl-new" title="camel_sasl_new ()">camel_sasl_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *service_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *mechanism</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="camel-CamelSasl.html#camel-sasl-authtype-list" title="camel_sasl_authtype_list ()">camel_sasl_authtype_list</a> (<em class="parameter"><code><span class="type">gboolean</span> include_plain</code></em>);
<a class="link" href="camel-CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="returnvalue">CamelServiceAuthType</span></a> * <a class="link" href="camel-CamelSasl.html#camel-sasl-authtype" title="camel_sasl_authtype ()">camel_sasl_authtype</a> (<em class="parameter"><code>const <span class="type">gchar</span> *mechanism</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelSasl.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelSasl.details"></a><h2>Details</h2>
<div class="refsect2" title="CamelSasl">
<a name="CamelSasl"></a><h3>CamelSasl</h3>
<pre class="programlisting">typedef struct {
CamelObject parent_object;
gchar *service_name;
gchar *mech; /* mechanism */
CamelService *service;
gboolean authenticated;
} CamelSasl;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_sasl_challenge ()">
<a name="camel-sasl-challenge"></a><h3>camel_sasl_challenge ()</h3>
<pre class="programlisting"><span class="returnvalue">GByteArray</span> * camel_sasl_challenge (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GByteArray</span> *token</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
If <em class="parameter"><code>token</code></em> is <code class="literal">NULL</code>, generate the initial SASL message to send to
the server. (This will be <code class="literal">NULL</code> if the client doesn't initiate the
exchange.) Otherwise, <em class="parameter"><code>token</code></em> is a challenge from the server, and
the return value is the response.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
<td>a token, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the SASL response or <code class="literal">NULL</code>. If an error occurred, <em class="parameter"><code>ex</code></em> will
also be set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_sasl_challenge_base64 ()">
<a name="camel-sasl-challenge-base64"></a><h3>camel_sasl_challenge_base64 ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_sasl_challenge_base64 (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
<p>
As with <a class="link" href="camel-CamelSasl.html#camel-sasl-challenge" title="camel_sasl_challenge ()"><span class="type">camel_sasl_challenge</span></a>, but the challenge <em class="parameter"><code>token</code></em> and the
response are both base64-encoded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
<td>a base64-encoded token
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ex</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the base64 encoded challenge string
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_sasl_authenticated ()">
<a name="camel-sasl-authenticated"></a><h3>camel_sasl_authenticated ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_sasl_authenticated (<em class="parameter"><code><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> whether or not <em class="parameter"><code>sasl</code></em> has successfully authenticated the
user. This will be <code class="literal">TRUE</code> after it returns the last needed response.
The caller must still pass that information on to the server and
verify that it has accepted it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_sasl_new ()">
<a name="camel-sasl-new"></a><h3>camel_sasl_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="returnvalue">CamelSasl</span></a> * camel_sasl_new (<em class="parameter"><code>const <span class="type">gchar</span> *service_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *mechanism</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelService.html#CamelService" title="struct CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service_name</code></em> :</span></p></td>
<td>the SASL service name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mechanism</code></em> :</span></p></td>
<td>the SASL mechanism
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>the CamelService that will be using this SASL
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="camel-CamelSasl.html#CamelSasl" title="CamelSasl"><span class="type">CamelSasl</span></a> object for the given <em class="parameter"><code>service_name</code></em>,
<em class="parameter"><code>mechanism</code></em>, and <em class="parameter"><code>service</code></em>, or <code class="literal">NULL</code> if the mechanism is not
supported.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_sasl_authtype_list ()">
<a name="camel-sasl-authtype-list"></a><h3>camel_sasl_authtype_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * camel_sasl_authtype_list (<em class="parameter"><code><span class="type">gboolean</span> include_plain</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>include_plain</code></em> :</span></p></td>
<td>whether or not to include the PLAIN mechanism
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <span class="type">GList</span> of SASL-supported authtypes. The caller must
free the list, but not the contents.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_sasl_authtype ()">
<a name="camel-sasl-authtype"></a><h3>camel_sasl_authtype ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="returnvalue">CamelServiceAuthType</span></a> * camel_sasl_authtype (<em class="parameter"><code>const <span class="type">gchar</span> *mechanism</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mechanism</code></em> :</span></p></td>
<td>the SASL mechanism to get an authtype for
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="camel-CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="type">CamelServiceAuthType</span></a> for the given mechanism, if
it is supported.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
