/usr/share/gtk-doc/html/camel/CamelSasl.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 | <!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.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Crypto.html" title="Crypto Contexts">
<link rel="prev" href="CamelSMIMEContext.html" title="CamelSMIMEContext">
<link rel="next" href="CamelSaslAnonymous.html" title="CamelSaslAnonymous">
<meta name="generator" content="GTK-Doc V1.18 (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="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="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="#CamelSasl.synopsis" class="shortcut">Top</a>
|
<a href="#CamelSasl.description" class="shortcut">Description</a>
|
<a href="#CamelSasl.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelSasl"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelSasl.top_of_page"></a>CamelSasl</span></h2>
<p>CamelSasl</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelSasl.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelSasl.html#CamelSasl-struct" title="struct CamelSasl">CamelSasl</a>;
<a class="link" href="CamelSasl.html" title="CamelSasl"><span class="returnvalue">CamelSasl</span></a> * <a class="link" href="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="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelSasl.html#camel-sasl-try-empty-password-sync" title="camel_sasl_try_empty_password_sync ()">camel_sasl_try_empty_password_sync</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSasl.html#camel-sasl-try-empty-password" title="camel_sasl_try_empty_password ()">camel_sasl_try_empty_password</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelSasl.html#camel-sasl-try-empty-password-finish" title="camel_sasl_try_empty_password_finish ()">camel_sasl_try_empty_password_finish</a>
(<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelSasl.html#camel-sasl-get-authenticated" title="camel_sasl_get_authenticated ()">camel_sasl_get_authenticated</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSasl.html#camel-sasl-set-authenticated" title="camel_sasl_set_authenticated ()">camel_sasl_set_authenticated</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> authenticated</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelSasl.html#camel-sasl-get-mechanism" title="camel_sasl_get_mechanism ()">camel_sasl_get_mechanism</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);
<a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * <a class="link" href="CamelSasl.html#camel-sasl-get-service" title="camel_sasl_get_service ()">camel_sasl_get_service</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelSasl.html#camel-sasl-get-service-name" title="camel_sasl_get_service_name ()">camel_sasl_get_service_name</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>);
<span class="returnvalue">GByteArray</span> * <a class="link" href="CamelSasl.html#camel-sasl-challenge-sync" title="camel_sasl_challenge_sync ()">camel_sasl_challenge_sync</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSasl.html#camel-sasl-challenge" title="camel_sasl_challenge ()">camel_sasl_challenge</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">GByteArray</span> * <a class="link" href="CamelSasl.html#camel-sasl-challenge-finish" title="camel_sasl_challenge_finish ()">camel_sasl_challenge_finish</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="CamelSasl.html#camel-sasl-challenge-base64-sync" title="camel_sasl_challenge_base64_sync ()">camel_sasl_challenge_base64_sync</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSasl.html#camel-sasl-challenge-base64" title="camel_sasl_challenge_base64 ()">camel_sasl_challenge_base64</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="CamelSasl.html#camel-sasl-challenge-base64-finish" title="camel_sasl_challenge_base64_finish ()">camel_sasl_challenge_base64_finish</a> (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="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="CamelService.html#CamelServiceAuthType" title="CamelServiceAuthType"><span class="returnvalue">CamelServiceAuthType</span></a> * <a class="link" href="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">
<a name="CamelSasl.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelSasl
+----<a class="link" href="CamelSaslAnonymous.html" title="CamelSaslAnonymous">CamelSaslAnonymous</a>
+----<a class="link" href="CamelSaslCramMd5.html" title="CamelSaslCramMd5">CamelSaslCramMd5</a>
+----<a class="link" href="CamelSaslDigestMd5.html" title="CamelSaslDigestMd5">CamelSaslDigestMd5</a>
+----<a class="link" href="CamelSaslGssapi.html" title="CamelSaslGssapi">CamelSaslGssapi</a>
+----<a class="link" href="CamelSaslLogin.html" title="CamelSaslLogin">CamelSaslLogin</a>
+----<a class="link" href="CamelSaslNTLM.html" title="CamelSaslNTLM">CamelSaslNTLM</a>
+----<a class="link" href="CamelSaslPlain.html" title="CamelSaslPlain">CamelSaslPlain</a>
+----<a class="link" href="CamelSaslPOPB4SMTP.html" title="CamelSaslPOPB4SMTP">CamelSaslPOPB4SMTP</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelSasl.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelSasl.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelSasl-struct"></a><h3>struct CamelSasl</h3>
<pre class="programlisting">struct CamelSasl;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-new"></a><h3>camel_sasl_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelSasl.html" 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="CamelService.html" title="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="CamelSasl.html" 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">
<a name="camel-sasl-try-empty-password-sync"></a><h3>camel_sasl_try_empty_password_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_sasl_try_empty_password_sync (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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> can attempt to authenticate without a
password being provided by the caller. This will be <code class="literal">TRUE</code> for an
authentication method which can attempt to use single-sign-on
credentials, but which can fall back to using a provided password
so it still has the <em class="parameter"><code>need_password</code></em> flag set in its description.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-try-empty-password"></a><h3>camel_sasl_try_empty_password ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_sasl_try_empty_password (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Asynchronously determine whether <em class="parameter"><code>sasl</code></em> can be used for password-less
authentication, for example single-sign-on using system credentials.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can then
call <a class="link" href="CamelSasl.html#camel-sasl-try-empty-password-finish" title="camel_sasl_try_empty_password_finish ()"><code class="function">camel_sasl_try_empty_password_finish()</code></a> to get the result of the
operation.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
<td>the I/O priority of the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-try-empty-password-finish"></a><h3>camel_sasl_try_empty_password_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_sasl_try_empty_password_finish
(<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="CamelSasl.html#camel-sasl-try-empty-password" title="camel_sasl_try_empty_password ()"><code class="function">camel_sasl_try_empty_password()</code></a>.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the SASL response. If an error occurred, <em class="parameter"><code>error</code></em> will also be set.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-get-authenticated"></a><h3>camel_sasl_get_authenticated ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_sasl_get_authenticated (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</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">
<a name="camel-sasl-set-authenticated"></a><h3>camel_sasl_set_authenticated ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_sasl_set_authenticated (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> authenticated</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>authenticated</code></em> :</span></p></td>
<td>whether we have successfully authenticated</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-get-mechanism"></a><h3>camel_sasl_get_mechanism ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_sasl_get_mechanism (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-get-service"></a><h3>camel_sasl_get_service ()</h3>
<pre class="programlisting"><a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * camel_sasl_get_service (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-get-service-name"></a><h3>camel_sasl_get_service_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_sasl_get_service_name (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge-sync"></a><h3>camel_sasl_challenge_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">GByteArray</span> * camel_sasl_challenge_sync (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</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>
<p>
Free the returned <span class="type">GByteArray</span> with <code class="function">g_byte_array_free()</code>.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</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>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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>error</code></em> will
also be set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge"></a><h3>camel_sasl_challenge ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_sasl_challenge (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
If <em class="parameter"><code>token</code></em> is <code class="literal">NULL</code>, asynchronously 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 asynchronous result is the response.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can then
call <a class="link" href="CamelSasl.html#camel-sasl-challenge-finish" title="camel_sasl_challenge_finish ()"><code class="function">camel_sasl_challenge_finish()</code></a> to get the result of the operation.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</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>io_priority</code></em> :</span></p></td>
<td>the I/O priority of the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge-finish"></a><h3>camel_sasl_challenge_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">GByteArray</span> * camel_sasl_challenge_finish (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="CamelSasl.html#camel-sasl-challenge" title="camel_sasl_challenge ()"><code class="function">camel_sasl_challenge()</code></a>. Free the
returned <span class="type">GByteArray</span> with <code class="function">g_byte_array_free()</code>.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</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>error</code></em> will
also be set.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge-base64-sync"></a><h3>camel_sasl_challenge_base64_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_sasl_challenge_base64_sync (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
As with <a class="link" href="CamelSasl.html#camel-sasl-challenge-sync" title="camel_sasl_challenge_sync ()"><code class="function">camel_sasl_challenge_sync()</code></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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</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>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the base64-encoded response</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge-base64"></a><h3>camel_sasl_challenge_base64 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_sasl_challenge_base64 (<em class="parameter"><code><a class="link" href="CamelSasl.html" 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><span class="type">gint</span> io_priority</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
As with <a class="link" href="CamelSasl.html#camel-sasl-challenge" title="camel_sasl_challenge ()"><code class="function">camel_sasl_challenge()</code></a>, but the challenge <em class="parameter"><code>token</code></em> and the
response are both base64-encoded.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can
then call <code class="function">camel_store_challenge_base64_finish()</code> to get the result of
the operation.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</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>io_priority</code></em> :</span></p></td>
<td>the I/O priority of the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-sasl-challenge-base64-finish"></a><h3>camel_sasl_challenge_base64_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_sasl_challenge_base64_finish (<em class="parameter"><code><a class="link" href="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a> *sasl</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="CamelSasl.html#camel-sasl-challenge-base64" title="camel_sasl_challenge_base64 ()"><code class="function">camel_sasl_challenge_base64()</code></a>.
</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="CamelSasl.html" title="CamelSasl"><span class="type">CamelSasl</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the base64-encoded response</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<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">
<a name="camel-sasl-authtype"></a><h3>camel_sasl_authtype ()</h3>
<pre class="programlisting"><a class="link" href="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="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.18</div>
</body>
</html>
|