← Back to branch summary

~ubuntu-branches/ubuntu/wily/qca2/wily-proposed

« back to all changes in this revision

Viewing changes to apidocs/html/classQCA_1_1SASLContext.html

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2007-10-27 18:51:54 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20071027185154-4ir9ys3h2q9fofrw
Tags: 2.0.0-2
Upload to unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
apidocs/html/classQCA_1_1SASLContext.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>Qt Cryptographic Architecture: QCA::SASLContext Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.2 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="modules.html"><span>Modules</span></a></li>
 
12
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
13
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
14
    <li><a href="files.html"><span>Files</span></a></li>
 
15
    <li><a href="dirs.html"><span>Directories</span></a></li>
 
16
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
17
    <li><a href="examples.html"><span>Examples</span></a></li>
 
18
  </ul>
 
19
</div>
 
20
<div class="tabs">
 
21
  <ul>
 
22
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
23
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
24
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
25
  </ul>
 
26
</div>
 
27
<div class="nav">
 
28
<a class="el" href="namespaceQCA.html">QCA</a>::<a class="el" href="classQCA_1_1SASLContext.html">SASLContext</a></div>
 
29
<h1>QCA::SASLContext Class Reference<br>
 
30
<small>
 
31
[<a class="el" href="group__ProviderAPI.html">QCA provider API</a>]</small>
 
32
</h1><!-- doxytag: class="QCA::SASLContext" --><!-- doxytag: inherits="QCA::Provider::Context" --><a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> provider.  
 
33
<a href="#_details">More...</a>
 
34
<p>
 
35
<code>#include &lt;<a class="el" href="qcaprovider_8h-source.html">QtCrypto</a>&gt;</code>
 
36
<p>
 
37
<p>Inheritance diagram for QCA::SASLContext:
 
38
<p><center><img src="classQCA_1_1SASLContext.png" usemap="#QCA::SASLContext_map" border="0" alt=""></center>
 
39
<map name="QCA::SASLContext_map">
 
40
<area href="classQCA_1_1Provider_1_1Context.html" alt="QCA::Provider::Context" shape="rect" coords="0,0,143,24">
 
41
</map>
 
42
Collaboration diagram for QCA::SASLContext:<p><center><img src="classQCA_1_1SASLContext__coll__graph.png" border="0" usemap="#QCA_1_1SASLContext__coll__map" alt="Collaboration graph"></center>
 
43
<map name="QCA_1_1SASLContext__coll__map">
 
44
<area shape="rect" href="classQCA_1_1Provider_1_1Context.html" title="Internal context class used for the plugin." alt="" coords="5,7,189,33"></map>
 
45
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classQCA_1_1SASLContext-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
46
<tr><td></td></tr>
 
47
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
 
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7">Result</a> { <br>
 
49
&nbsp;&nbsp;<a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7921b6a3a392e9a742666a92260275bd7">Success</a>, 
 
50
<a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7ab35895ebf3f45229b4ab79f109e1f26">Error</a>, 
 
51
<a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c710f0824aced5f0b38ac2eb7e7e705641">Params</a>, 
 
52
<a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7d063b66f1397ce4436bb9511f09b0ea5">AuthCheck</a>, 
 
53
<br>
 
54
&nbsp;&nbsp;<a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7ba6030cba03fa11b380bac218840357e">Continue</a>
 
55
<br>
 
56
 }</td></tr>
 
57
 
 
58
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
 
59
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466">resultsReady</a> ()</td></tr>
 
60
 
 
61
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classQCA_1_1SASL.html#68bc5ac69884a108b9068bc8e18a2af7">SASL::AuthCondition</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#2b607cb0f19b5d4e6fea01b889f4539b">authCondition</a> () const=0</td></tr>
 
63
 
 
64
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#e7bd5aa3ff3d3740c71e1c60e72426e6">authzid</a> () const=0</td></tr>
 
65
 
 
66
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classQCA_1_1SASL_1_1Params.html">SASL::Params</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#a3cb8c40dca27cc0a8860e0238444f86">clientParams</a> () const=0</td></tr>
 
67
 
 
68
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#d9579fe898586bd0746e5ca4ac8cc7ec">encoded</a> () const=0</td></tr>
 
69
 
 
70
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#ba61844884f2831fcf5704d053e6cde1">haveClientInit</a> () const=0</td></tr>
 
71
 
 
72
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#4f28aa43d2edc9b5b2a3251b976fd182">mech</a> () const=0</td></tr>
 
73
 
 
74
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#9cb9ff5e658107576183deb4269e2cde">mechlist</a> () const=0</td></tr>
 
75
 
 
76
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#fb0de515d310b726b06565be8dc607da">nextStep</a> (const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;from_net)=0</td></tr>
 
77
 
 
78
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#0361ece86da2c2f5b5f0f9ae86e01aed">realmlist</a> () const=0</td></tr>
 
79
 
 
80
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#cc59388f35f357b212325656073b5f59">reset</a> ()=0</td></tr>
 
81
 
 
82
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7">Result</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724">result</a> () const=0</td></tr>
 
83
 
 
84
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#7698637340129d9147856783ce1a3213">SASLContext</a> (<a class="el" href="classQCA_1_1Provider.html">Provider</a> *p)</td></tr>
 
85
 
 
86
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#0611a515605fbd2128517222f223e4a7">serverFirstStep</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;mech, const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> *clientInit)=0</td></tr>
 
87
 
 
88
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#cbdf40f72b60a96bdb3eca534a5cd6ff">setClientParams</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *user, const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *authzid, const <a class="el" href="classQCA_1_1SecureArray.html">SecureArray</a> *pass, const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *realm)=0</td></tr>
 
89
 
 
90
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#fb8ff63a9747affe909955ce3a097575">setConstraints</a> (<a class="el" href="classQCA_1_1SASL.html#fadd5c4ed30e4d0ccaa789967aa12684">SASL::AuthFlags</a> f, int minSSF, int maxSSF)=0</td></tr>
 
91
 
 
92
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#18073e693a56283a418492f074fdb844">setup</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;service, const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;host, const <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html">HostPort</a> *local, const <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html">HostPort</a> *remote, const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;ext_id, int ext_ssf)=0</td></tr>
 
93
 
 
94
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#79f8eb35c8b1e0e8d0d3eb407901170e">ssf</a> () const=0</td></tr>
 
95
 
 
96
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#f30c0aa6d5311f7d87bc33d0baa3bb75">startClient</a> (const <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> &amp;mechlist, bool allowClientSendFirst)=0</td></tr>
 
97
 
 
98
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#5b380093e78dbc54bd82643e86d125b4">startServer</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;realm, bool disableServerSendLast)=0</td></tr>
 
99
 
 
100
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#fa3457ed2e522d347a076909d77fb20c">stepData</a> () const=0</td></tr>
 
101
 
 
102
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#c58192f6f75a2ad008e8cccfa964a415">to_app</a> ()=0</td></tr>
 
103
 
 
104
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#0ab5bc6a36edc7364d4b4be955864de4">to_net</a> ()=0</td></tr>
 
105
 
 
106
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#677c83e57caf7a5369a1f2ccc259b66b">tryAgain</a> ()=0</td></tr>
 
107
 
 
108
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#d993cc4c0961d2719313b54c5b790b8d">update</a> (const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;from_net, const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;from_app)=0</td></tr>
 
109
 
 
110
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#9121e93703243e6384271cfa899b0ebf">username</a> () const=0</td></tr>
 
111
 
 
112
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext.html#956c04f947f323dd07cac0b0a6b79b49">waitForResultsReady</a> (int msecs)=0</td></tr>
 
113
 
 
114
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
 
115
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html">HostPort</a></td></tr>
 
116
 
 
117
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience class to hold an IP address and an associated port.  <a href="classQCA_1_1SASLContext_1_1HostPort.html#_details">More...</a><br></td></tr>
 
118
</table>
 
119
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
120
<a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> provider. 
 
121
<p>
 
122
<dl class="note" compact><dt><b>Note:</b></dt><dd>This class is part of the provider plugin interface and should not be used directly by applications. You probably want <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> instead. </dd></dl>
 
123
 
 
124
<p>
 
125
<hr><h2>Member Enumeration Documentation</h2>
 
126
<a class="anchor" name="f6a686e434d22b9458a92bf6241c38c7"></a><!-- doxytag: member="QCA::SASLContext::Result" ref="f6a686e434d22b9458a92bf6241c38c7" args="" -->
 
127
<div class="memitem">
 
128
<div class="memproto">
 
129
      <table class="memname">
 
130
        <tr>
 
131
          <td class="memname">enum <a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7">QCA::SASLContext::Result</a>          </td>
 
132
        </tr>
 
133
      </table>
 
134
</div>
 
135
<div class="memdoc">
 
136
 
 
137
<p>
 
138
Result of a <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> operation. 
 
139
<p>
 
140
<dl compact><dt><b>Enumerator: </b></dt><dd>
 
141
<table border="0" cellspacing="2" cellpadding="0">
 
142
<tr><td valign="top"><em><a class="anchor" name="f6a686e434d22b9458a92bf6241c38c7921b6a3a392e9a742666a92260275bd7"></a><!-- doxytag: member="Success" ref="f6a686e434d22b9458a92bf6241c38c7921b6a3a392e9a742666a92260275bd7" args="" -->Success</em>&nbsp;</td><td>
 
143
Operation completed. </td></tr>
 
144
<tr><td valign="top"><em><a class="anchor" name="f6a686e434d22b9458a92bf6241c38c7ab35895ebf3f45229b4ab79f109e1f26"></a><!-- doxytag: member="Error" ref="f6a686e434d22b9458a92bf6241c38c7ab35895ebf3f45229b4ab79f109e1f26" args="" -->Error</em>&nbsp;</td><td>
 
145
Operation failed. </td></tr>
 
146
<tr><td valign="top"><em><a class="anchor" name="f6a686e434d22b9458a92bf6241c38c710f0824aced5f0b38ac2eb7e7e705641"></a><!-- doxytag: member="Params" ref="f6a686e434d22b9458a92bf6241c38c710f0824aced5f0b38ac2eb7e7e705641" args="" -->Params</em>&nbsp;</td><td>
 
147
Parameters are needed to complete authentication. </td></tr>
 
148
<tr><td valign="top"><em><a class="anchor" name="f6a686e434d22b9458a92bf6241c38c7d063b66f1397ce4436bb9511f09b0ea5"></a><!-- doxytag: member="AuthCheck" ref="f6a686e434d22b9458a92bf6241c38c7d063b66f1397ce4436bb9511f09b0ea5" args="" -->AuthCheck</em>&nbsp;</td><td>
 
149
Client login can be inspected (server only). </td></tr>
 
150
<tr><td valign="top"><em><a class="anchor" name="f6a686e434d22b9458a92bf6241c38c7ba6030cba03fa11b380bac218840357e"></a><!-- doxytag: member="Continue" ref="f6a686e434d22b9458a92bf6241c38c7ba6030cba03fa11b380bac218840357e" args="" -->Continue</em>&nbsp;</td><td>
 
151
More steps needed to complete authentication. </td></tr>
 
152
</table>
 
153
</dl>
 
154
 
 
155
</div>
 
156
</div><p>
 
157
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
158
<a class="anchor" name="7698637340129d9147856783ce1a3213"></a><!-- doxytag: member="QCA::SASLContext::SASLContext" ref="7698637340129d9147856783ce1a3213" args="(Provider *p)" -->
 
159
<div class="memitem">
 
160
<div class="memproto">
 
161
      <table class="memname">
 
162
        <tr>
 
163
          <td class="memname">QCA::SASLContext::SASLContext           </td>
 
164
          <td>(</td>
 
165
          <td class="paramtype"><a class="el" href="classQCA_1_1Provider.html">Provider</a> *&nbsp;</td>
 
166
          <td class="paramname"> <em>p</em>          </td>
 
167
          <td>&nbsp;)&nbsp;</td>
 
168
          <td width="100%"><code> [inline]</code></td>
 
169
        </tr>
 
170
      </table>
 
171
</div>
 
172
<div class="memdoc">
 
173
 
 
174
<p>
 
175
Standard constructor. 
 
176
<p>
 
177
<dl compact><dt><b>Parameters:</b></dt><dd>
 
178
  <table border="0" cellspacing="2" cellpadding="0">
 
179
    <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>the <a class="el" href="classQCA_1_1Provider.html" title="Algorithm provider.">Provider</a> associated with this context </td></tr>
 
180
  </table>
 
181
</dl>
 
182
 
 
183
</div>
 
184
</div><p>
 
185
<hr><h2>Member Function Documentation</h2>
 
186
<a class="anchor" name="2b607cb0f19b5d4e6fea01b889f4539b"></a><!-- doxytag: member="QCA::SASLContext::authCondition" ref="2b607cb0f19b5d4e6fea01b889f4539b" args="() const=0" -->
 
187
<div class="memitem">
 
188
<div class="memproto">
 
189
      <table class="memname">
 
190
        <tr>
 
191
          <td class="memname">virtual <a class="el" href="classQCA_1_1SASL.html#68bc5ac69884a108b9068bc8e18a2af7">SASL::AuthCondition</a> QCA::SASLContext::authCondition           </td>
 
192
          <td>(</td>
 
193
          <td class="paramname">          </td>
 
194
          <td>&nbsp;)&nbsp;</td>
 
195
          <td width="100%"> const<code> [pure virtual]</code></td>
 
196
        </tr>
 
197
      </table>
 
198
</div>
 
199
<div class="memdoc">
 
200
 
 
201
<p>
 
202
Returns the reason for failure, if the authentication was not successful. 
 
203
<p>
 
204
This is only valid after authentication failure. 
 
205
</div>
 
206
</div><p>
 
207
<a class="anchor" name="e7bd5aa3ff3d3740c71e1c60e72426e6"></a><!-- doxytag: member="QCA::SASLContext::authzid" ref="e7bd5aa3ff3d3740c71e1c60e72426e6" args="() const=0" -->
 
208
<div class="memitem">
 
209
<div class="memproto">
 
210
      <table class="memname">
 
211
        <tr>
 
212
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> QCA::SASLContext::authzid           </td>
 
213
          <td>(</td>
 
214
          <td class="paramname">          </td>
 
215
          <td>&nbsp;)&nbsp;</td>
 
216
          <td width="100%"> const<code> [pure virtual]</code></td>
 
217
        </tr>
 
218
      </table>
 
219
</div>
 
220
<div class="memdoc">
 
221
 
 
222
<p>
 
223
Returns the authzid attempting to authorize (server mode only). 
 
224
<p>
 
225
This is only valid after receiving the AuthCheck result code. 
 
226
</div>
 
227
</div><p>
 
228
<a class="anchor" name="a3cb8c40dca27cc0a8860e0238444f86"></a><!-- doxytag: member="QCA::SASLContext::clientParams" ref="a3cb8c40dca27cc0a8860e0238444f86" args="() const=0" -->
 
229
<div class="memitem">
 
230
<div class="memproto">
 
231
      <table class="memname">
 
232
        <tr>
 
233
          <td class="memname">virtual <a class="el" href="classQCA_1_1SASL_1_1Params.html">SASL::Params</a> QCA::SASLContext::clientParams           </td>
 
234
          <td>(</td>
 
235
          <td class="paramname">          </td>
 
236
          <td>&nbsp;)&nbsp;</td>
 
237
          <td width="100%"> const<code> [pure virtual]</code></td>
 
238
        </tr>
 
239
      </table>
 
240
</div>
 
241
<div class="memdoc">
 
242
 
 
243
<p>
 
244
Returns the needed/optional client parameters. 
 
245
<p>
 
246
This is only valid after receiving the Params result code. 
 
247
</div>
 
248
</div><p>
 
249
<a class="anchor" name="d9579fe898586bd0746e5ca4ac8cc7ec"></a><!-- doxytag: member="QCA::SASLContext::encoded" ref="d9579fe898586bd0746e5ca4ac8cc7ec" args="() const=0" -->
 
250
<div class="memitem">
 
251
<div class="memproto">
 
252
      <table class="memname">
 
253
        <tr>
 
254
          <td class="memname">virtual int QCA::SASLContext::encoded           </td>
 
255
          <td>(</td>
 
256
          <td class="paramname">          </td>
 
257
          <td>&nbsp;)&nbsp;</td>
 
258
          <td width="100%"> const<code> [pure virtual]</code></td>
 
259
        </tr>
 
260
      </table>
 
261
</div>
 
262
<div class="memdoc">
 
263
 
 
264
<p>
 
265
Returns the number of bytes of plaintext data that is encoded inside of <a class="el" href="classQCA_1_1SASLContext.html#0ab5bc6a36edc7364d4b4be955864de4" title="Returns data that should be sent across the network (for the security layer).">to_net()</a>. 
 
266
<p>
 
267
 
 
268
</div>
 
269
</div><p>
 
270
<a class="anchor" name="ba61844884f2831fcf5704d053e6cde1"></a><!-- doxytag: member="QCA::SASLContext::haveClientInit" ref="ba61844884f2831fcf5704d053e6cde1" args="() const=0" -->
 
271
<div class="memitem">
 
272
<div class="memproto">
 
273
      <table class="memname">
 
274
        <tr>
 
275
          <td class="memname">virtual bool QCA::SASLContext::haveClientInit           </td>
 
276
          <td>(</td>
 
277
          <td class="paramname">          </td>
 
278
          <td>&nbsp;)&nbsp;</td>
 
279
          <td width="100%"> const<code> [pure virtual]</code></td>
 
280
        </tr>
 
281
      </table>
 
282
</div>
 
283
<div class="memdoc">
 
284
 
 
285
<p>
 
286
Returns true if the client has initialization data. 
 
287
<p>
 
288
 
 
289
</div>
 
290
</div><p>
 
291
<a class="anchor" name="4f28aa43d2edc9b5b2a3251b976fd182"></a><!-- doxytag: member="QCA::SASLContext::mech" ref="4f28aa43d2edc9b5b2a3251b976fd182" args="() const=0" -->
 
292
<div class="memitem">
 
293
<div class="memproto">
 
294
      <table class="memname">
 
295
        <tr>
 
296
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> QCA::SASLContext::mech           </td>
 
297
          <td>(</td>
 
298
          <td class="paramname">          </td>
 
299
          <td>&nbsp;)&nbsp;</td>
 
300
          <td width="100%"> const<code> [pure virtual]</code></td>
 
301
        </tr>
 
302
      </table>
 
303
</div>
 
304
<div class="memdoc">
 
305
 
 
306
<p>
 
307
Returns the mechanism selected. 
 
308
<p>
 
309
 
 
310
</div>
 
311
</div><p>
 
312
<a class="anchor" name="9cb9ff5e658107576183deb4269e2cde"></a><!-- doxytag: member="QCA::SASLContext::mechlist" ref="9cb9ff5e658107576183deb4269e2cde" args="() const=0" -->
 
313
<div class="memitem">
 
314
<div class="memproto">
 
315
      <table class="memname">
 
316
        <tr>
 
317
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> QCA::SASLContext::mechlist           </td>
 
318
          <td>(</td>
 
319
          <td class="paramname">          </td>
 
320
          <td>&nbsp;)&nbsp;</td>
 
321
          <td width="100%"> const<code> [pure virtual]</code></td>
 
322
        </tr>
 
323
      </table>
 
324
</div>
 
325
<div class="memdoc">
 
326
 
 
327
<p>
 
328
Returns the mechanism list (server mode only). 
 
329
<p>
 
330
 
 
331
</div>
 
332
</div><p>
 
333
<a class="anchor" name="fb0de515d310b726b06565be8dc607da"></a><!-- doxytag: member="QCA::SASLContext::nextStep" ref="fb0de515d310b726b06565be8dc607da" args="(const QByteArray &amp;from_net)=0" -->
 
334
<div class="memitem">
 
335
<div class="memproto">
 
336
      <table class="memname">
 
337
        <tr>
 
338
          <td class="memname">virtual void QCA::SASLContext::nextStep           </td>
 
339
          <td>(</td>
 
340
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;&nbsp;</td>
 
341
          <td class="paramname"> <em>from_net</em>          </td>
 
342
          <td>&nbsp;)&nbsp;</td>
 
343
          <td width="100%"><code> [pure virtual]</code></td>
 
344
        </tr>
 
345
      </table>
 
346
</div>
 
347
<div class="memdoc">
 
348
 
 
349
<p>
 
350
Perform another step of the <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> authentication. 
 
351
<p>
 
352
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
353
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> and <a class="el" href="classQCA_1_1SASLContext.html#fa3457ed2e522d347a076909d77fb20c" title="Returns an authentication payload for to be transmitted over the network.">stepData()</a> will be valid.<p>
 
354
<dl compact><dt><b>Parameters:</b></dt><dd>
 
355
  <table border="0" cellspacing="2" cellpadding="0">
 
356
    <tr><td valign="top"></td><td valign="top"><em>from_net</em>&nbsp;</td><td>the data from the "other side" of the protocol to be used for the next step. </td></tr>
 
357
  </table>
 
358
</dl>
 
359
 
 
360
</div>
 
361
</div><p>
 
362
<a class="anchor" name="0361ece86da2c2f5b5f0f9ae86e01aed"></a><!-- doxytag: member="QCA::SASLContext::realmlist" ref="0361ece86da2c2f5b5f0f9ae86e01aed" args="() const=0" -->
 
363
<div class="memitem">
 
364
<div class="memproto">
 
365
      <table class="memname">
 
366
        <tr>
 
367
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> QCA::SASLContext::realmlist           </td>
 
368
          <td>(</td>
 
369
          <td class="paramname">          </td>
 
370
          <td>&nbsp;)&nbsp;</td>
 
371
          <td width="100%"> const<code> [pure virtual]</code></td>
 
372
        </tr>
 
373
      </table>
 
374
</div>
 
375
<div class="memdoc">
 
376
 
 
377
<p>
 
378
Returns the realm list (client mode only). 
 
379
<p>
 
380
This is only valid after receiving the Params result code and <a class="el" href="classQCA_1_1SASL_1_1Params.html#8a24fba079ca714b06c9fd5c6634de1b" title="A Realm can be sent if desired.">SASL::Params::canSendRealm</a> is set to true. 
 
381
</div>
 
382
</div><p>
 
383
<a class="anchor" name="cc59388f35f357b212325656073b5f59"></a><!-- doxytag: member="QCA::SASLContext::reset" ref="cc59388f35f357b212325656073b5f59" args="()=0" -->
 
384
<div class="memitem">
 
385
<div class="memproto">
 
386
      <table class="memname">
 
387
        <tr>
 
388
          <td class="memname">virtual void QCA::SASLContext::reset           </td>
 
389
          <td>(</td>
 
390
          <td class="paramname">          </td>
 
391
          <td>&nbsp;)&nbsp;</td>
 
392
          <td width="100%"><code> [pure virtual]</code></td>
 
393
        </tr>
 
394
      </table>
 
395
</div>
 
396
<div class="memdoc">
 
397
 
 
398
<p>
 
399
Reset the object to its initial state. 
 
400
<p>
 
401
 
 
402
</div>
 
403
</div><p>
 
404
<a class="anchor" name="2152e510575047471636b0bb44174724"></a><!-- doxytag: member="QCA::SASLContext::result" ref="2152e510575047471636b0bb44174724" args="() const=0" -->
 
405
<div class="memitem">
 
406
<div class="memproto">
 
407
      <table class="memname">
 
408
        <tr>
 
409
          <td class="memname">virtual <a class="el" href="classQCA_1_1SASLContext.html#f6a686e434d22b9458a92bf6241c38c7">Result</a> QCA::SASLContext::result           </td>
 
410
          <td>(</td>
 
411
          <td class="paramname">          </td>
 
412
          <td>&nbsp;)&nbsp;</td>
 
413
          <td width="100%"> const<code> [pure virtual]</code></td>
 
414
        </tr>
 
415
      </table>
 
416
</div>
 
417
<div class="memdoc">
 
418
 
 
419
<p>
 
420
Returns the result code of an operation. 
 
421
<p>
 
422
 
 
423
</div>
 
424
</div><p>
 
425
<a class="anchor" name="8eac6a0d9461fc77229a4f725bb97466"></a><!-- doxytag: member="QCA::SASLContext::resultsReady" ref="8eac6a0d9461fc77229a4f725bb97466" args="()" -->
 
426
<div class="memitem">
 
427
<div class="memproto">
 
428
      <table class="memname">
 
429
        <tr>
 
430
          <td class="memname">void QCA::SASLContext::resultsReady           </td>
 
431
          <td>(</td>
 
432
          <td class="paramname">          </td>
 
433
          <td>&nbsp;)&nbsp;</td>
 
434
          <td width="100%"><code> [signal]</code></td>
 
435
        </tr>
 
436
      </table>
 
437
</div>
 
438
<div class="memdoc">
 
439
 
 
440
<p>
 
441
Emit this when a <a class="el" href="classQCA_1_1SASLContext.html#f30c0aa6d5311f7d87bc33d0baa3bb75" title="Begins the session in client mode, starting with the authentication.">startClient()</a>, <a class="el" href="classQCA_1_1SASLContext.html#5b380093e78dbc54bd82643e86d125b4" title="Begins the session in server mode, starting with the authentication.">startServer()</a>, <a class="el" href="classQCA_1_1SASLContext.html#0611a515605fbd2128517222f223e4a7" title="Finishes server startup.">serverFirstStep()</a>, <a class="el" href="classQCA_1_1SASLContext.html#fb0de515d310b726b06565be8dc607da" title="Perform another step of the SASL authentication.">nextStep()</a>, <a class="el" href="classQCA_1_1SASLContext.html#677c83e57caf7a5369a1f2ccc259b66b" title="Attempt the most recent operation again.">tryAgain()</a>, or <a class="el" href="classQCA_1_1SASLContext.html#d993cc4c0961d2719313b54c5b790b8d" title="Performs one iteration of the SASL security layer processing.">update()</a> operation has completed. 
 
442
<p>
 
443
 
 
444
</div>
 
445
</div><p>
 
446
<a class="anchor" name="0611a515605fbd2128517222f223e4a7"></a><!-- doxytag: member="QCA::SASLContext::serverFirstStep" ref="0611a515605fbd2128517222f223e4a7" args="(const QString &amp;mech, const QByteArray *clientInit)=0" -->
 
447
<div class="memitem">
 
448
<div class="memproto">
 
449
      <table class="memname">
 
450
        <tr>
 
451
          <td class="memname">virtual void QCA::SASLContext::serverFirstStep           </td>
 
452
          <td>(</td>
 
453
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;&nbsp;</td>
 
454
          <td class="paramname"> <em>mech</em>, </td>
 
455
        </tr>
 
456
        <tr>
 
457
          <td class="paramkey"></td>
 
458
          <td></td>
 
459
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> *&nbsp;</td>
 
460
          <td class="paramname"> <em>clientInit</em></td><td>&nbsp;</td>
 
461
        </tr>
 
462
        <tr>
 
463
          <td></td>
 
464
          <td>)</td>
 
465
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
466
        </tr>
 
467
      </table>
 
468
</div>
 
469
<div class="memdoc">
 
470
 
 
471
<p>
 
472
Finishes server startup. 
 
473
<p>
 
474
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
475
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> and <a class="el" href="classQCA_1_1SASLContext.html#fa3457ed2e522d347a076909d77fb20c" title="Returns an authentication payload for to be transmitted over the network.">stepData()</a> will be valid. If <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> is Success, then the session is now in the connected state.<p>
 
476
<dl compact><dt><b>Parameters:</b></dt><dd>
 
477
  <table border="0" cellspacing="2" cellpadding="0">
 
478
    <tr><td valign="top"></td><td valign="top"><em>mech</em>&nbsp;</td><td>the mechanism to use </td></tr>
 
479
    <tr><td valign="top"></td><td valign="top"><em>clientInit</em>&nbsp;</td><td>initial data from the client, or 0 if there is no such data </td></tr>
 
480
  </table>
 
481
</dl>
 
482
 
 
483
</div>
 
484
</div><p>
 
485
<a class="anchor" name="cbdf40f72b60a96bdb3eca534a5cd6ff"></a><!-- doxytag: member="QCA::SASLContext::setClientParams" ref="cbdf40f72b60a96bdb3eca534a5cd6ff" args="(const QString *user, const QString *authzid, const SecureArray *pass, const QString *realm)=0" -->
 
486
<div class="memitem">
 
487
<div class="memproto">
 
488
      <table class="memname">
 
489
        <tr>
 
490
          <td class="memname">virtual void QCA::SASLContext::setClientParams           </td>
 
491
          <td>(</td>
 
492
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *&nbsp;</td>
 
493
          <td class="paramname"> <em>user</em>, </td>
 
494
        </tr>
 
495
        <tr>
 
496
          <td class="paramkey"></td>
 
497
          <td></td>
 
498
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *&nbsp;</td>
 
499
          <td class="paramname"> <em>authzid</em>, </td>
 
500
        </tr>
 
501
        <tr>
 
502
          <td class="paramkey"></td>
 
503
          <td></td>
 
504
          <td class="paramtype">const <a class="el" href="classQCA_1_1SecureArray.html">SecureArray</a> *&nbsp;</td>
 
505
          <td class="paramname"> <em>pass</em>, </td>
 
506
        </tr>
 
507
        <tr>
 
508
          <td class="paramkey"></td>
 
509
          <td></td>
 
510
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> *&nbsp;</td>
 
511
          <td class="paramname"> <em>realm</em></td><td>&nbsp;</td>
 
512
        </tr>
 
513
        <tr>
 
514
          <td></td>
 
515
          <td>)</td>
 
516
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
517
        </tr>
 
518
      </table>
 
519
</div>
 
520
<div class="memdoc">
 
521
 
 
522
<p>
 
523
Set some of the client parameters (pass 0 to not set a field). 
 
524
<p>
 
525
<dl compact><dt><b>Parameters:</b></dt><dd>
 
526
  <table border="0" cellspacing="2" cellpadding="0">
 
527
    <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>the user name </td></tr>
 
528
    <tr><td valign="top"></td><td valign="top"><em>authzid</em>&nbsp;</td><td>the authorization name / role </td></tr>
 
529
    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the password </td></tr>
 
530
    <tr><td valign="top"></td><td valign="top"><em>realm</em>&nbsp;</td><td>the realm to authenticate in </td></tr>
 
531
  </table>
 
532
</dl>
 
533
 
 
534
</div>
 
535
</div><p>
 
536
<a class="anchor" name="fb8ff63a9747affe909955ce3a097575"></a><!-- doxytag: member="QCA::SASLContext::setConstraints" ref="fb8ff63a9747affe909955ce3a097575" args="(SASL::AuthFlags f, int minSSF, int maxSSF)=0" -->
 
537
<div class="memitem">
 
538
<div class="memproto">
 
539
      <table class="memname">
 
540
        <tr>
 
541
          <td class="memname">virtual void QCA::SASLContext::setConstraints           </td>
 
542
          <td>(</td>
 
543
          <td class="paramtype"><a class="el" href="classQCA_1_1SASL.html#fadd5c4ed30e4d0ccaa789967aa12684">SASL::AuthFlags</a>&nbsp;</td>
 
544
          <td class="paramname"> <em>f</em>, </td>
 
545
        </tr>
 
546
        <tr>
 
547
          <td class="paramkey"></td>
 
548
          <td></td>
 
549
          <td class="paramtype">int&nbsp;</td>
 
550
          <td class="paramname"> <em>minSSF</em>, </td>
 
551
        </tr>
 
552
        <tr>
 
553
          <td class="paramkey"></td>
 
554
          <td></td>
 
555
          <td class="paramtype">int&nbsp;</td>
 
556
          <td class="paramname"> <em>maxSSF</em></td><td>&nbsp;</td>
 
557
        </tr>
 
558
        <tr>
 
559
          <td></td>
 
560
          <td>)</td>
 
561
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
562
        </tr>
 
563
      </table>
 
564
</div>
 
565
<div class="memdoc">
 
566
 
 
567
<p>
 
568
Set the constraints of the session using SSF values. 
 
569
<p>
 
570
This function will be called before <a class="el" href="classQCA_1_1SASLContext.html#f30c0aa6d5311f7d87bc33d0baa3bb75" title="Begins the session in client mode, starting with the authentication.">startClient()</a> or <a class="el" href="classQCA_1_1SASLContext.html#5b380093e78dbc54bd82643e86d125b4" title="Begins the session in server mode, starting with the authentication.">startServer()</a>.<p>
 
571
<dl compact><dt><b>Parameters:</b></dt><dd>
 
572
  <table border="0" cellspacing="2" cellpadding="0">
 
573
    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>the flags to use </td></tr>
 
574
    <tr><td valign="top"></td><td valign="top"><em>minSSF</em>&nbsp;</td><td>the minimum strength factor that is acceptable </td></tr>
 
575
    <tr><td valign="top"></td><td valign="top"><em>maxSSF</em>&nbsp;</td><td>the maximum strength factor that is acceptable </td></tr>
 
576
  </table>
 
577
</dl>
 
578
 
 
579
</div>
 
580
</div><p>
 
581
<a class="anchor" name="18073e693a56283a418492f074fdb844"></a><!-- doxytag: member="QCA::SASLContext::setup" ref="18073e693a56283a418492f074fdb844" args="(const QString &amp;service, const QString &amp;host, const HostPort *local, const HostPort *remote, const QString &amp;ext_id, int ext_ssf)=0" -->
 
582
<div class="memitem">
 
583
<div class="memproto">
 
584
      <table class="memname">
 
585
        <tr>
 
586
          <td class="memname">virtual void QCA::SASLContext::setup           </td>
 
587
          <td>(</td>
 
588
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;&nbsp;</td>
 
589
          <td class="paramname"> <em>service</em>, </td>
 
590
        </tr>
 
591
        <tr>
 
592
          <td class="paramkey"></td>
 
593
          <td></td>
 
594
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;&nbsp;</td>
 
595
          <td class="paramname"> <em>host</em>, </td>
 
596
        </tr>
 
597
        <tr>
 
598
          <td class="paramkey"></td>
 
599
          <td></td>
 
600
          <td class="paramtype">const <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html">HostPort</a> *&nbsp;</td>
 
601
          <td class="paramname"> <em>local</em>, </td>
 
602
        </tr>
 
603
        <tr>
 
604
          <td class="paramkey"></td>
 
605
          <td></td>
 
606
          <td class="paramtype">const <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html">HostPort</a> *&nbsp;</td>
 
607
          <td class="paramname"> <em>remote</em>, </td>
 
608
        </tr>
 
609
        <tr>
 
610
          <td class="paramkey"></td>
 
611
          <td></td>
 
612
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;&nbsp;</td>
 
613
          <td class="paramname"> <em>ext_id</em>, </td>
 
614
        </tr>
 
615
        <tr>
 
616
          <td class="paramkey"></td>
 
617
          <td></td>
 
618
          <td class="paramtype">int&nbsp;</td>
 
619
          <td class="paramname"> <em>ext_ssf</em></td><td>&nbsp;</td>
 
620
        </tr>
 
621
        <tr>
 
622
          <td></td>
 
623
          <td>)</td>
 
624
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
625
        </tr>
 
626
      </table>
 
627
</div>
 
628
<div class="memdoc">
 
629
 
 
630
<p>
 
631
Configure a new session. 
 
632
<p>
 
633
This function will be called before any other configuration functions.<p>
 
634
<dl compact><dt><b>Parameters:</b></dt><dd>
 
635
  <table border="0" cellspacing="2" cellpadding="0">
 
636
    <tr><td valign="top"></td><td valign="top"><em>service</em>&nbsp;</td><td>the name of the network service being provided by this application, which can be used by the <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> system for policy control. Examples: "imap", "xmpp" </td></tr>
 
637
    <tr><td valign="top"></td><td valign="top"><em>host</em>&nbsp;</td><td>the hostname that the application is interacting with or as </td></tr>
 
638
    <tr><td valign="top"></td><td valign="top"><em>local</em>&nbsp;</td><td>pointer to a <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html" title="Convenience class to hold an IP address and an associated port.">HostPort</a> representing the local end of a network socket, or 0 if this information is unknown or not available </td></tr>
 
639
    <tr><td valign="top"></td><td valign="top"><em>remote</em>&nbsp;</td><td>pointer to a <a class="el" href="classQCA_1_1SASLContext_1_1HostPort.html" title="Convenience class to hold an IP address and an associated port.">HostPort</a> representing the peer end of a network socket, or 0 if this information is unknown or not available </td></tr>
 
640
    <tr><td valign="top"></td><td valign="top"><em>ext_id</em>&nbsp;</td><td>the id to be used for <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> EXTERNAL (client only) </td></tr>
 
641
    <tr><td valign="top"></td><td valign="top"><em>ext_ssf</em>&nbsp;</td><td>the SSF of the external authentication channel (client only) </td></tr>
 
642
  </table>
 
643
</dl>
 
644
 
 
645
</div>
 
646
</div><p>
 
647
<a class="anchor" name="79f8eb35c8b1e0e8d0d3eb407901170e"></a><!-- doxytag: member="QCA::SASLContext::ssf" ref="79f8eb35c8b1e0e8d0d3eb407901170e" args="() const=0" -->
 
648
<div class="memitem">
 
649
<div class="memproto">
 
650
      <table class="memname">
 
651
        <tr>
 
652
          <td class="memname">virtual int QCA::SASLContext::ssf           </td>
 
653
          <td>(</td>
 
654
          <td class="paramname">          </td>
 
655
          <td>&nbsp;)&nbsp;</td>
 
656
          <td width="100%"> const<code> [pure virtual]</code></td>
 
657
        </tr>
 
658
      </table>
 
659
</div>
 
660
<div class="memdoc">
 
661
 
 
662
<p>
 
663
Returns the SSF of the active <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> session. 
 
664
<p>
 
665
This is only valid after authentication success. 
 
666
</div>
 
667
</div><p>
 
668
<a class="anchor" name="f30c0aa6d5311f7d87bc33d0baa3bb75"></a><!-- doxytag: member="QCA::SASLContext::startClient" ref="f30c0aa6d5311f7d87bc33d0baa3bb75" args="(const QStringList &amp;mechlist, bool allowClientSendFirst)=0" -->
 
669
<div class="memitem">
 
670
<div class="memproto">
 
671
      <table class="memname">
 
672
        <tr>
 
673
          <td class="memname">virtual void QCA::SASLContext::startClient           </td>
 
674
          <td>(</td>
 
675
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> &amp;&nbsp;</td>
 
676
          <td class="paramname"> <em>mechlist</em>, </td>
 
677
        </tr>
 
678
        <tr>
 
679
          <td class="paramkey"></td>
 
680
          <td></td>
 
681
          <td class="paramtype">bool&nbsp;</td>
 
682
          <td class="paramname"> <em>allowClientSendFirst</em></td><td>&nbsp;</td>
 
683
        </tr>
 
684
        <tr>
 
685
          <td></td>
 
686
          <td>)</td>
 
687
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
688
        </tr>
 
689
      </table>
 
690
</div>
 
691
<div class="memdoc">
 
692
 
 
693
<p>
 
694
Begins the session in client mode, starting with the authentication. 
 
695
<p>
 
696
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
697
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a>, <a class="el" href="classQCA_1_1SASLContext.html#4f28aa43d2edc9b5b2a3251b976fd182" title="Returns the mechanism selected.">mech()</a>, <a class="el" href="classQCA_1_1SASLContext.html#ba61844884f2831fcf5704d053e6cde1" title="Returns true if the client has initialization data.">haveClientInit()</a>, and <a class="el" href="classQCA_1_1SASLContext.html#fa3457ed2e522d347a076909d77fb20c" title="Returns an authentication payload for to be transmitted over the network.">stepData()</a> will be valid. If <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> is Success, then the session is now in the connected state.<p>
 
698
<dl compact><dt><b>Parameters:</b></dt><dd>
 
699
  <table border="0" cellspacing="2" cellpadding="0">
 
700
    <tr><td valign="top"></td><td valign="top"><em>mechlist</em>&nbsp;</td><td>the list of mechanisms </td></tr>
 
701
    <tr><td valign="top"></td><td valign="top"><em>allowClientSendFirst</em>&nbsp;</td><td>whether the client sends first (true) or the server sends first (false) </td></tr>
 
702
  </table>
 
703
</dl>
 
704
 
 
705
</div>
 
706
</div><p>
 
707
<a class="anchor" name="5b380093e78dbc54bd82643e86d125b4"></a><!-- doxytag: member="QCA::SASLContext::startServer" ref="5b380093e78dbc54bd82643e86d125b4" args="(const QString &amp;realm, bool disableServerSendLast)=0" -->
 
708
<div class="memitem">
 
709
<div class="memproto">
 
710
      <table class="memname">
 
711
        <tr>
 
712
          <td class="memname">virtual void QCA::SASLContext::startServer           </td>
 
713
          <td>(</td>
 
714
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;&nbsp;</td>
 
715
          <td class="paramname"> <em>realm</em>, </td>
 
716
        </tr>
 
717
        <tr>
 
718
          <td class="paramkey"></td>
 
719
          <td></td>
 
720
          <td class="paramtype">bool&nbsp;</td>
 
721
          <td class="paramname"> <em>disableServerSendLast</em></td><td>&nbsp;</td>
 
722
        </tr>
 
723
        <tr>
 
724
          <td></td>
 
725
          <td>)</td>
 
726
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
727
        </tr>
 
728
      </table>
 
729
</div>
 
730
<div class="memdoc">
 
731
 
 
732
<p>
 
733
Begins the session in server mode, starting with the authentication. 
 
734
<p>
 
735
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
736
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> and <a class="el" href="classQCA_1_1SASLContext.html#9cb9ff5e658107576183deb4269e2cde" title="Returns the mechanism list (server mode only).">mechlist()</a> will be valid. The <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> function will return Success or Error. If the result is Success, then <a class="el" href="classQCA_1_1SASLContext.html#0611a515605fbd2128517222f223e4a7" title="Finishes server startup.">serverFirstStep()</a> will be called next.<p>
 
737
<dl compact><dt><b>Parameters:</b></dt><dd>
 
738
  <table border="0" cellspacing="2" cellpadding="0">
 
739
    <tr><td valign="top"></td><td valign="top"><em>realm</em>&nbsp;</td><td>the realm to authenticate in </td></tr>
 
740
    <tr><td valign="top"></td><td valign="top"><em>disableServerSendLast</em>&nbsp;</td><td>whether the client sends first (true) or the server sends first (false) </td></tr>
 
741
  </table>
 
742
</dl>
 
743
 
 
744
</div>
 
745
</div><p>
 
746
<a class="anchor" name="fa3457ed2e522d347a076909d77fb20c"></a><!-- doxytag: member="QCA::SASLContext::stepData" ref="fa3457ed2e522d347a076909d77fb20c" args="() const=0" -->
 
747
<div class="memitem">
 
748
<div class="memproto">
 
749
      <table class="memname">
 
750
        <tr>
 
751
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> QCA::SASLContext::stepData           </td>
 
752
          <td>(</td>
 
753
          <td class="paramname">          </td>
 
754
          <td>&nbsp;)&nbsp;</td>
 
755
          <td width="100%"> const<code> [pure virtual]</code></td>
 
756
        </tr>
 
757
      </table>
 
758
</div>
 
759
<div class="memdoc">
 
760
 
 
761
<p>
 
762
Returns an authentication payload for to be transmitted over the network. 
 
763
<p>
 
764
 
 
765
</div>
 
766
</div><p>
 
767
<a class="anchor" name="c58192f6f75a2ad008e8cccfa964a415"></a><!-- doxytag: member="QCA::SASLContext::to_app" ref="c58192f6f75a2ad008e8cccfa964a415" args="()=0" -->
 
768
<div class="memitem">
 
769
<div class="memproto">
 
770
      <table class="memname">
 
771
        <tr>
 
772
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> QCA::SASLContext::to_app           </td>
 
773
          <td>(</td>
 
774
          <td class="paramname">          </td>
 
775
          <td>&nbsp;)&nbsp;</td>
 
776
          <td width="100%"><code> [pure virtual]</code></td>
 
777
        </tr>
 
778
      </table>
 
779
</div>
 
780
<div class="memdoc">
 
781
 
 
782
<p>
 
783
Returns data that is decoded from the network and should be processed by the application. 
 
784
<p>
 
785
 
 
786
</div>
 
787
</div><p>
 
788
<a class="anchor" name="0ab5bc6a36edc7364d4b4be955864de4"></a><!-- doxytag: member="QCA::SASLContext::to_net" ref="0ab5bc6a36edc7364d4b4be955864de4" args="()=0" -->
 
789
<div class="memitem">
 
790
<div class="memproto">
 
791
      <table class="memname">
 
792
        <tr>
 
793
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> QCA::SASLContext::to_net           </td>
 
794
          <td>(</td>
 
795
          <td class="paramname">          </td>
 
796
          <td>&nbsp;)&nbsp;</td>
 
797
          <td width="100%"><code> [pure virtual]</code></td>
 
798
        </tr>
 
799
      </table>
 
800
</div>
 
801
<div class="memdoc">
 
802
 
 
803
<p>
 
804
Returns data that should be sent across the network (for the security layer). 
 
805
<p>
 
806
 
 
807
</div>
 
808
</div><p>
 
809
<a class="anchor" name="677c83e57caf7a5369a1f2ccc259b66b"></a><!-- doxytag: member="QCA::SASLContext::tryAgain" ref="677c83e57caf7a5369a1f2ccc259b66b" args="()=0" -->
 
810
<div class="memitem">
 
811
<div class="memproto">
 
812
      <table class="memname">
 
813
        <tr>
 
814
          <td class="memname">virtual void QCA::SASLContext::tryAgain           </td>
 
815
          <td>(</td>
 
816
          <td class="paramname">          </td>
 
817
          <td>&nbsp;)&nbsp;</td>
 
818
          <td width="100%"><code> [pure virtual]</code></td>
 
819
        </tr>
 
820
      </table>
 
821
</div>
 
822
<div class="memdoc">
 
823
 
 
824
<p>
 
825
Attempt the most recent operation again. 
 
826
<p>
 
827
This is used if the <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> of an operation is Params or AuthCheck.<p>
 
828
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
829
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> and <a class="el" href="classQCA_1_1SASLContext.html#fa3457ed2e522d347a076909d77fb20c" title="Returns an authentication payload for to be transmitted over the network.">stepData()</a> will be valid. 
 
830
</div>
 
831
</div><p>
 
832
<a class="anchor" name="d993cc4c0961d2719313b54c5b790b8d"></a><!-- doxytag: member="QCA::SASLContext::update" ref="d993cc4c0961d2719313b54c5b790b8d" args="(const QByteArray &amp;from_net, const QByteArray &amp;from_app)=0" -->
 
833
<div class="memitem">
 
834
<div class="memproto">
 
835
      <table class="memname">
 
836
        <tr>
 
837
          <td class="memname">virtual void QCA::SASLContext::update           </td>
 
838
          <td>(</td>
 
839
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;&nbsp;</td>
 
840
          <td class="paramname"> <em>from_net</em>, </td>
 
841
        </tr>
 
842
        <tr>
 
843
          <td class="paramkey"></td>
 
844
          <td></td>
 
845
          <td class="paramtype">const <a class="elRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &amp;&nbsp;</td>
 
846
          <td class="paramname"> <em>from_app</em></td><td>&nbsp;</td>
 
847
        </tr>
 
848
        <tr>
 
849
          <td></td>
 
850
          <td>)</td>
 
851
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
 
852
        </tr>
 
853
      </table>
 
854
</div>
 
855
<div class="memdoc">
 
856
 
 
857
<p>
 
858
Performs one iteration of the <a class="el" href="classQCA_1_1SASL.html" title="Simple Authentication and Security Layer protocol implementation.">SASL</a> security layer processing. 
 
859
<p>
 
860
This function returns immediately, and completion is signaled with the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal.<p>
 
861
On completion, <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a>, <a class="el" href="classQCA_1_1SASLContext.html#0ab5bc6a36edc7364d4b4be955864de4" title="Returns data that should be sent across the network (for the security layer).">to_net()</a>, <a class="el" href="classQCA_1_1SASLContext.html#d9579fe898586bd0746e5ca4ac8cc7ec" title="Returns the number of bytes of plaintext data that is encoded inside of to_net()...">encoded()</a>, and <a class="el" href="classQCA_1_1SASLContext.html#c58192f6f75a2ad008e8cccfa964a415" title="Returns data that is decoded from the network and should be processed by the application...">to_app()</a> will be valid. The <a class="el" href="classQCA_1_1SASLContext.html#2152e510575047471636b0bb44174724" title="Returns the result code of an operation.">result()</a> function will return Success or Error.<p>
 
862
<dl compact><dt><b>Parameters:</b></dt><dd>
 
863
  <table border="0" cellspacing="2" cellpadding="0">
 
864
    <tr><td valign="top"></td><td valign="top"><em>from_net</em>&nbsp;</td><td>the data from the "other side" of the protocol </td></tr>
 
865
    <tr><td valign="top"></td><td valign="top"><em>from_app</em>&nbsp;</td><td>the data from the application of the protocol </td></tr>
 
866
  </table>
 
867
</dl>
 
868
 
 
869
</div>
 
870
</div><p>
 
871
<a class="anchor" name="9121e93703243e6384271cfa899b0ebf"></a><!-- doxytag: member="QCA::SASLContext::username" ref="9121e93703243e6384271cfa899b0ebf" args="() const=0" -->
 
872
<div class="memitem">
 
873
<div class="memproto">
 
874
      <table class="memname">
 
875
        <tr>
 
876
          <td class="memname">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> QCA::SASLContext::username           </td>
 
877
          <td>(</td>
 
878
          <td class="paramname">          </td>
 
879
          <td>&nbsp;)&nbsp;</td>
 
880
          <td width="100%"> const<code> [pure virtual]</code></td>
 
881
        </tr>
 
882
      </table>
 
883
</div>
 
884
<div class="memdoc">
 
885
 
 
886
<p>
 
887
Returns the username attempting to authenticate (server mode only). 
 
888
<p>
 
889
This is only valid after receiving the AuthCheck result code. 
 
890
</div>
 
891
</div><p>
 
892
<a class="anchor" name="956c04f947f323dd07cac0b0a6b79b49"></a><!-- doxytag: member="QCA::SASLContext::waitForResultsReady" ref="956c04f947f323dd07cac0b0a6b79b49" args="(int msecs)=0" -->
 
893
<div class="memitem">
 
894
<div class="memproto">
 
895
      <table class="memname">
 
896
        <tr>
 
897
          <td class="memname">virtual bool QCA::SASLContext::waitForResultsReady           </td>
 
898
          <td>(</td>
 
899
          <td class="paramtype">int&nbsp;</td>
 
900
          <td class="paramname"> <em>msecs</em>          </td>
 
901
          <td>&nbsp;)&nbsp;</td>
 
902
          <td width="100%"><code> [pure virtual]</code></td>
 
903
        </tr>
 
904
      </table>
 
905
</div>
 
906
<div class="memdoc">
 
907
 
 
908
<p>
 
909
Waits for a <a class="el" href="classQCA_1_1SASLContext.html#f30c0aa6d5311f7d87bc33d0baa3bb75" title="Begins the session in client mode, starting with the authentication.">startClient()</a>, <a class="el" href="classQCA_1_1SASLContext.html#5b380093e78dbc54bd82643e86d125b4" title="Begins the session in server mode, starting with the authentication.">startServer()</a>, <a class="el" href="classQCA_1_1SASLContext.html#0611a515605fbd2128517222f223e4a7" title="Finishes server startup.">serverFirstStep()</a>, <a class="el" href="classQCA_1_1SASLContext.html#fb0de515d310b726b06565be8dc607da" title="Perform another step of the SASL authentication.">nextStep()</a>, <a class="el" href="classQCA_1_1SASLContext.html#677c83e57caf7a5369a1f2ccc259b66b" title="Attempt the most recent operation again.">tryAgain()</a>, or <a class="el" href="classQCA_1_1SASLContext.html#d993cc4c0961d2719313b54c5b790b8d" title="Performs one iteration of the SASL security layer processing.">update()</a> operation to complete. 
 
910
<p>
 
911
In this case, the <a class="el" href="classQCA_1_1SASLContext.html#8eac6a0d9461fc77229a4f725bb97466" title="Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain()...">resultsReady()</a> signal is not emitted. Returns true if the operation completed or false if this function times out.<p>
 
912
This function is blocking.<p>
 
913
<dl compact><dt><b>Parameters:</b></dt><dd>
 
914
  <table border="0" cellspacing="2" cellpadding="0">
 
915
    <tr><td valign="top"></td><td valign="top"><em>msecs</em>&nbsp;</td><td>number of milliseconds to wait (-1 to wait forever) </td></tr>
 
916
  </table>
 
917
</dl>
 
918
 
 
919
</div>
 
920
</div><p>
 
921
<hr>The documentation for this class was generated from the following file:<ul>
 
922
<li><a class="el" href="qcaprovider_8h-source.html">qcaprovider.h</a></ul>
 
923
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 6 19:14:34 2007 for Qt Cryptographic Architecture by&nbsp;
 
924
<a href="http://www.doxygen.org/index.html">
 
925
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
 
926
</body>
 
927
</html>