← Back to branch summary

~exarkun/pyopenssl/trunk

« back to all changes in this revision

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

  • Committer: Jean-Paul Calderone
  • Date: 2011-09-02 15:43:50 UTC
  • mfrom: (156.1.5 release-0.13)
  • Revision ID: exarkun@twistedmatrix.com-20110902154350-rwick8zfl3dgyzva
Merge 0.13 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-128'><tt>SSLv2_METHOD</tt></a></b>
 
58
<dl><dt><b><a name='l2h-129'><tt>SSLv2_METHOD</tt></a></b>
59
59
<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>
 
60
<dt><b><a name='l2h-146'><tt>SSLv3_METHOD</tt></a></b><dd>
 
61
<dt><b><a name='l2h-147'><tt>SSLv23_METHOD</tt></a></b><dd>
 
62
<dt><b><a name='l2h-148'><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-129'><tt>VERIFY_NONE</tt></a></b>
 
68
<dl><dt><b><a name='l2h-130'><tt>VERIFY_NONE</tt></a></b>
69
69
<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>
 
70
<dt><b><a name='l2h-149'><tt>VERIFY_PEER</tt></a></b><dd>
 
71
<dt><b><a name='l2h-150'><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-130'><tt>FILETYPE_PEM</tt></a></b>
 
77
<dl><dt><b><a name='l2h-131'><tt>FILETYPE_PEM</tt></a></b>
78
78
<dd>
79
 
<dt><b><a name='l2h-147'><tt>FILETYPE_ASN1</tt></a></b><dd>
 
79
<dt><b><a name='l2h-151'><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-131'><tt>OP_SINGLE_DH_USE</tt></a></b>
 
85
<dl><dt><b><a name='l2h-132'><tt>OP_SINGLE_DH_USE</tt></a></b>
86
86
<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>
 
87
<dt><b><a name='l2h-152'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
 
88
<dt><b><a name='l2h-153'><tt>OP_NO_SSLv2</tt></a></b><dd>
 
89
<dt><b><a name='l2h-154'><tt>OP_NO_SSLv3</tt></a></b><dd>
 
90
<dt><b><a name='l2h-155'><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-132'><tt>ContextType</tt></a></b>
 
101
<dl><dt><b><a name='l2h-133'><tt>SSLEAY_VERSION</tt></a></b>
 
102
<dd>
 
103
<dt><b><a name='l2h-156'><tt>SSLEAY_CFLAGS</tt></a></b><dd>
 
104
<dt><b><a name='l2h-157'><tt>SSLEAY_BUILT_ON</tt></a></b><dd>
 
105
<dt><b><a name='l2h-158'><tt>SSLEAY_PLATFORM</tt></a></b><dd>
 
106
<dt><b><a name='l2h-159'><tt>SSLEAY_DIR</tt></a></b><dd>
 
107
Constants used with <tt class="method">SSLeay_version</tt> to specify what OpenSSL version
 
108
information to retrieve.  See the man page for the <tt class="function">SSLeay_version</tt> C
 
109
API for details.
 
110
</dl>
 
111
 
 
112
<P>
 
113
<dl><dt><b><a name='l2h-134'><tt>OPENSSL_VERSION_NUMBER</tt></a></b>
 
114
<dd>
 
115
An integer giving the version number of the OpenSSL library used to build this
 
116
version of pyOpenSSL.  See the man page for the <tt class="function">SSLeay_version</tt> C API
 
117
for details.
 
118
</dl>
 
119
 
 
120
<P>
 
121
<dl><dt><b><a name='l2h-135'><tt class='function'>SSLeay_version</tt></a></b>(<var>type</var>)
 
122
<dd>
 
123
Retrieve a string describing some aspect of the underlying OpenSSL version.  The
 
124
type passed in should be one of the <tt class="constant">SSLEAY_*</tt> constants defined in
 
125
this module.
 
126
</dl>
 
127
 
 
128
<P>
 
129
<dl><dt><b><a name='l2h-136'><tt>ContextType</tt></a></b>
102
130
<dd>
103
131
See <tt class="class">Context</tt>.
104
132
</dl>
105
133
 
106
134
<P>
107
 
<dl><dt><b>class <a name='l2h-133'><tt class='class'>Context</tt></a></b>(<var>method</var>)
 
135
<dl><dt><b>class <a name='l2h-137'><tt class='class'>Context</tt></a></b>(<var>method</var>)
108
136
<dd>
109
137
A class representing SSL contexts.  Contexts define the parameters of one or
110
138
more SSL connections.
115
143
</dl>
116
144
 
117
145
<P>
118
 
<dl><dt><b><a name='l2h-134'><tt>ConnectionType</tt></a></b>
 
146
<dl><dt><b><a name='l2h-138'><tt>ConnectionType</tt></a></b>
119
147
<dd>
120
148
See <tt class="class">Connection</tt>.
121
149
</dl>
122
150
 
123
151
<P>
124
 
<dl><dt><b>class <a name='l2h-135'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
 
152
<dl><dt><b>class <a name='l2h-139'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
125
153
<dd>
126
154
A class representing SSL connections.
127
155
 
128
156
<P>
129
157
<var>context</var> should be an instance of <tt class="class">Context</tt> and <var>socket</var>
130
158
should be a socket <A NAME="tex2html4"
131
 
  HREF="#foot1231"><SUP>3</SUP></A> object.  <var>socket</var> may be
 
159
  HREF="#foot1276"><SUP>3</SUP></A> object.  <var>socket</var> may be
132
160
<var>None</var>; in this case, the Connection is created with a memory BIO: see
133
161
the <tt class="method">bio_read</tt>, <tt class="method">bio_write</tt>, and <tt class="method">bio_shutdown</tt>
134
162
methods.
135
163
</dl>
136
164
 
137
165
<P>
138
 
<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>Error</tt></a></b>
 
166
<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>Error</tt></a></b>
139
167
<dd>
140
168
This exception is used as a base class for the other SSL-related
141
169
exceptions, but may also be raised directly.
149
177
</dl>
150
178
 
151
179
<P>
152
 
<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>ZeroReturnError</tt></a></b>
 
180
<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>ZeroReturnError</tt></a></b>
153
181
<dd>
154
182
This exception matches the error return code <code>SSL_ERROR_ZERO_RETURN</code>, and
155
183
is raised when the SSL Connection has been closed. In SSL 3.0 and TLS 1.0, this
163
191
</dl>
164
192
 
165
193
<P>
166
 
<dl><dt><b>exception <a name='l2h-138'><tt class='exception'>WantReadError</tt></a></b>
 
194
<dl><dt><b>exception <a name='l2h-142'><tt class='exception'>WantReadError</tt></a></b>
167
195
<dd>
168
196
The operation did not complete; the same I/O method should be called again
169
197
later, with the same arguments. Any I/O method can lead to this since new
180
208
</dl>
181
209
 
182
210
<P>
183
 
<dl><dt><b>exception <a name='l2h-139'><tt class='exception'>WantWriteError</tt></a></b>
 
211
<dl><dt><b>exception <a name='l2h-143'><tt class='exception'>WantWriteError</tt></a></b>
184
212
<dd>
185
213
See <tt class="exception">WantReadError</tt>.  The socket send buffer may be too full to
186
214
write more data.
187
215
</dl>
188
216
 
189
217
<P>
190
 
<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>WantX509LookupError</tt></a></b>
 
218
<dl><dt><b>exception <a name='l2h-144'><tt class='exception'>WantX509LookupError</tt></a></b>
191
219
<dd>
192
220
The operation did not complete because an application callback has asked to be
193
221
called again. The I/O method should be called again later, with the same
196
224
</dl>
197
225
 
198
226
<P>
199
 
<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>SysCallError</tt></a></b>
 
227
<dl><dt><b>exception <a name='l2h-145'><tt class='exception'>SysCallError</tt></a></b>
200
228
<dd>
201
229
The <tt class="exception">SysCallError</tt> occurs when there's an I/O error and OpenSSL's
202
230
error queue does not contain any information. This can mean two things: An
208
236
<P>
209
237
<BR><HR><H4>Footnotes</H4>
210
238
<DL>
211
 
<DT><A NAME="foot1231">... socket</A><A
 
239
<DT><A NAME="foot1276">... socket</A><A
212
240
 href="openssl-ssl.html#tex2html4"><SUP>3</SUP></A></DT>
213
241
<DD>Actually, all that is required is an object
214
242
that <i>behaves</i> like a socket, you could even use files, even though
221
249
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
222
250
 
223
251
<UL CLASS="ChildLinks">
224
 
<LI><A NAME="tex2html303"
 
252
<LI><A NAME="tex2html289"
225
253
  href="openssl-context.html">3.3.1 Context objects </A>
226
 
<LI><A NAME="tex2html304"
 
254
<LI><A NAME="tex2html290"
227
255
  href="openssl-connection.html">3.3.2 Connection objects </A>
228
256
</UL>
229
257
<!--End of Table of Child-Links-->
256
284
<b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL  </A>
257
285
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A>
258
286
<hr>
259
 
<span class="release-info">Release 0.12.</span>
 
287
<span class="release-info">Release 0.13.</span>
260
288
</DIV>
261
289
<!--End of Navigation Panel-->
262
290