← Back to branch summary

~torsten/pyopenssl/bio-layer-support

« back to all changes in this revision

Viewing changes to doc/html/openssl-ssl.html

  • Committer: Jean-Paul Calderone
  • Date: 2011-04-11 23:26:11 UTC
  • mfrom: (143.1.6 release-0.12)
  • Revision ID: exarkun@divmod.com-20110411232611-z1xtswwjxqorzjrn
Merge 0.12 release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/openssl-ssl.html
55
55
Context, Connection.
56
56
 
57
57
<P>
58
 
<dl><dt><b><a name='l2h-124'><tt>SSLv2_METHOD</tt></a></b>
 
58
<dl><dt><b><a name='l2h-128'><tt>SSLv2_METHOD</tt></a></b>
59
59
<dd>
60
 
<dt><b><a name='l2h-138'><tt>SSLv3_METHOD</tt></a></b><dd>
61
 
<dt><b><a name='l2h-139'><tt>SSLv23_METHOD</tt></a></b><dd>
62
 
<dt><b><a name='l2h-140'><tt>TLSv1_METHOD</tt></a></b><dd>
 
60
<dt><b><a name='l2h-142'><tt>SSLv3_METHOD</tt></a></b><dd>
 
61
<dt><b><a name='l2h-143'><tt>SSLv23_METHOD</tt></a></b><dd>
 
62
<dt><b><a name='l2h-144'><tt>TLSv1_METHOD</tt></a></b><dd>
63
63
These constants represent the different SSL methods to use when creating a
64
64
context object.
65
65
</dl>
66
66
 
67
67
<P>
68
 
<dl><dt><b><a name='l2h-125'><tt>VERIFY_NONE</tt></a></b>
 
68
<dl><dt><b><a name='l2h-129'><tt>VERIFY_NONE</tt></a></b>
69
69
<dd>
70
 
<dt><b><a name='l2h-141'><tt>VERIFY_PEER</tt></a></b><dd>
71
 
<dt><b><a name='l2h-142'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd>
 
70
<dt><b><a name='l2h-145'><tt>VERIFY_PEER</tt></a></b><dd>
 
71
<dt><b><a name='l2h-146'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd>
72
72
These constants represent the verification mode used by the Context
73
73
object's <tt class="method">set_verify</tt> method.
74
74
</dl>
75
75
 
76
76
<P>
77
 
<dl><dt><b><a name='l2h-126'><tt>FILETYPE_PEM</tt></a></b>
 
77
<dl><dt><b><a name='l2h-130'><tt>FILETYPE_PEM</tt></a></b>
78
78
<dd>
79
 
<dt><b><a name='l2h-143'><tt>FILETYPE_ASN1</tt></a></b><dd>
 
79
<dt><b><a name='l2h-147'><tt>FILETYPE_ASN1</tt></a></b><dd>
80
80
File type constants used with the <tt class="method">use_certificate_file</tt> and
81
81
<tt class="method">use_privatekey_file</tt> methods of Context objects.
82
82
</dl>
83
83
 
84
84
<P>
85
 
<dl><dt><b><a name='l2h-127'><tt>OP_SINGLE_DH_USE</tt></a></b>
 
85
<dl><dt><b><a name='l2h-131'><tt>OP_SINGLE_DH_USE</tt></a></b>
86
86
<dd>
87
 
<dt><b><a name='l2h-144'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
88
 
<dt><b><a name='l2h-145'><tt>OP_NO_SSLv2</tt></a></b><dd>
89
 
<dt><b><a name='l2h-146'><tt>OP_NO_SSLv3</tt></a></b><dd>
90
 
<dt><b><a name='l2h-147'><tt>OP_NO_TLSv1</tt></a></b><dd>
 
87
<dt><b><a name='l2h-148'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
 
88
<dt><b><a name='l2h-149'><tt>OP_NO_SSLv2</tt></a></b><dd>
 
89
<dt><b><a name='l2h-150'><tt>OP_NO_SSLv3</tt></a></b><dd>
 
90
<dt><b><a name='l2h-151'><tt>OP_NO_TLSv1</tt></a></b><dd>
91
91
Constants used with <tt class="method">set_options</tt> of Context objects.
92
92
<tt class="constant">OP_SINGLE_DH_USE</tt> means to always create a new key when using ephemeral
93
93
Diffie-Hellman. <tt class="constant">OP_EPHEMERAL_RSA</tt> means to always use ephemeral RSA keys
98
98
</dl>
99
99
 
100
100
<P>
101
 
<dl><dt><b><a name='l2h-128'><tt>ContextType</tt></a></b>
 
101
<dl><dt><b><a name='l2h-132'><tt>ContextType</tt></a></b>
102
102
<dd>
103
103
See <tt class="class">Context</tt>.
104
104
</dl>
105
105
 
106
106
<P>
107
 
<dl><dt><b>class <a name='l2h-129'><tt class='class'>Context</tt></a></b>(<var>method</var>)
 
107
<dl><dt><b>class <a name='l2h-133'><tt class='class'>Context</tt></a></b>(<var>method</var>)
108
108
<dd>
109
109
A class representing SSL contexts.  Contexts define the parameters of one or
110
110
more SSL connections.
115
115
</dl>
116
116
 
117
117
<P>
118
 
<dl><dt><b><a name='l2h-130'><tt>ConnectionType</tt></a></b>
 
118
<dl><dt><b><a name='l2h-134'><tt>ConnectionType</tt></a></b>
119
119
<dd>
120
120
See <tt class="class">Connection</tt>.
121
121
</dl>
122
122
 
123
123
<P>
124
 
<dl><dt><b>class <a name='l2h-131'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
 
124
<dl><dt><b>class <a name='l2h-135'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
125
125
<dd>
126
126
A class representing SSL connections.
127
127
 
128
128
<P>
129
129
<var>context</var> should be an instance of <tt class="class">Context</tt> and <var>socket</var>
130
130
should be a socket <A NAME="tex2html4"
131
 
  HREF="#foot1208"><SUP>3</SUP></A> object.  <var>socket</var> may be
 
131
  HREF="#foot1231"><SUP>3</SUP></A> object.  <var>socket</var> may be
132
132
<var>None</var>; in this case, the Connection is created with a memory BIO: see
133
133
the <tt class="method">bio_read</tt>, <tt class="method">bio_write</tt>, and <tt class="method">bio_shutdown</tt>
134
134
methods.
135
135
</dl>
136
136
 
137
137
<P>
138
 
<dl><dt><b>exception <a name='l2h-132'><tt class='exception'>Error</tt></a></b>
 
138
<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>Error</tt></a></b>
139
139
<dd>
140
140
This exception is used as a base class for the other SSL-related
141
141
exceptions, but may also be raised directly.
149
149
</dl>
150
150
 
151
151
<P>
152
 
<dl><dt><b>exception <a name='l2h-133'><tt class='exception'>ZeroReturnError</tt></a></b>
 
152
<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>ZeroReturnError</tt></a></b>
153
153
<dd>
154
154
This exception matches the error return code <code>SSL_ERROR_ZERO_RETURN</code>, and
155
155
is raised when the SSL Connection has been closed. In SSL 3.0 and TLS 1.0, this
163
163
</dl>
164
164
 
165
165
<P>
166
 
<dl><dt><b>exception <a name='l2h-134'><tt class='exception'>WantReadError</tt></a></b>
 
166
<dl><dt><b>exception <a name='l2h-138'><tt class='exception'>WantReadError</tt></a></b>
167
167
<dd>
168
168
The operation did not complete; the same I/O method should be called again
169
169
later, with the same arguments. Any I/O method can lead to this since new
180
180
</dl>
181
181
 
182
182
<P>
183
 
<dl><dt><b>exception <a name='l2h-135'><tt class='exception'>WantWriteError</tt></a></b>
 
183
<dl><dt><b>exception <a name='l2h-139'><tt class='exception'>WantWriteError</tt></a></b>
184
184
<dd>
185
185
See <tt class="exception">WantReadError</tt>.  The socket send buffer may be too full to
186
186
write more data.
187
187
</dl>
188
188
 
189
189
<P>
190
 
<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>WantX509LookupError</tt></a></b>
 
190
<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>WantX509LookupError</tt></a></b>
191
191
<dd>
192
192
The operation did not complete because an application callback has asked to be
193
193
called again. The I/O method should be called again later, with the same
196
196
</dl>
197
197
 
198
198
<P>
199
 
<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>SysCallError</tt></a></b>
 
199
<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>SysCallError</tt></a></b>
200
200
<dd>
201
201
The <tt class="exception">SysCallError</tt> occurs when there's an I/O error and OpenSSL's
202
202
error queue does not contain any information. This can mean two things: An
208
208
<P>
209
209
<BR><HR><H4>Footnotes</H4>
210
210
<DL>
211
 
<DT><A NAME="foot1208">... socket</A><A
 
211
<DT><A NAME="foot1231">... socket</A><A
212
212
 href="openssl-ssl.html#tex2html4"><SUP>3</SUP></A></DT>
213
213
<DD>Actually, all that is required is an object
214
214
that <i>behaves</i> like a socket, you could even use files, even though
221
221
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
222
222
 
223
223
<UL CLASS="ChildLinks">
224
 
<LI><A NAME="tex2html289"
 
224
<LI><A NAME="tex2html303"
225
225
  href="openssl-context.html">3.3.1 Context objects </A>
226
 
<LI><A NAME="tex2html290"
 
226
<LI><A NAME="tex2html304"
227
227
  href="openssl-connection.html">3.3.2 Connection objects </A>
228
228
</UL>
229
229
<!--End of Table of Child-Links-->