summaryrefslogtreecommitdiff
path: root/doc/html/openssl-ssl.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/openssl-ssl.html')
-rw-r--r--doc/html/openssl-ssl.html86
1 files changed, 57 insertions, 29 deletions
diff --git a/doc/html/openssl-ssl.html b/doc/html/openssl-ssl.html
index a607e41..bd0c5b7 100644
--- a/doc/html/openssl-ssl.html
+++ b/doc/html/openssl-ssl.html
@@ -55,39 +55,39 @@ This module handles things specific to SSL. There are two objects defined:
Context, Connection.
<P>
-<dl><dt><b><a name='l2h-128'><tt>SSLv2_METHOD</tt></a></b>
+<dl><dt><b><a name='l2h-129'><tt>SSLv2_METHOD</tt></a></b>
<dd>
-<dt><b><a name='l2h-142'><tt>SSLv3_METHOD</tt></a></b><dd>
-<dt><b><a name='l2h-143'><tt>SSLv23_METHOD</tt></a></b><dd>
-<dt><b><a name='l2h-144'><tt>TLSv1_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-146'><tt>SSLv3_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-147'><tt>SSLv23_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-148'><tt>TLSv1_METHOD</tt></a></b><dd>
These constants represent the different SSL methods to use when creating a
context object.
</dl>
<P>
-<dl><dt><b><a name='l2h-129'><tt>VERIFY_NONE</tt></a></b>
+<dl><dt><b><a name='l2h-130'><tt>VERIFY_NONE</tt></a></b>
<dd>
-<dt><b><a name='l2h-145'><tt>VERIFY_PEER</tt></a></b><dd>
-<dt><b><a name='l2h-146'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd>
+<dt><b><a name='l2h-149'><tt>VERIFY_PEER</tt></a></b><dd>
+<dt><b><a name='l2h-150'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd>
These constants represent the verification mode used by the Context
object's <tt class="method">set_verify</tt> method.
</dl>
<P>
-<dl><dt><b><a name='l2h-130'><tt>FILETYPE_PEM</tt></a></b>
+<dl><dt><b><a name='l2h-131'><tt>FILETYPE_PEM</tt></a></b>
<dd>
-<dt><b><a name='l2h-147'><tt>FILETYPE_ASN1</tt></a></b><dd>
+<dt><b><a name='l2h-151'><tt>FILETYPE_ASN1</tt></a></b><dd>
File type constants used with the <tt class="method">use_certificate_file</tt> and
<tt class="method">use_privatekey_file</tt> methods of Context objects.
</dl>
<P>
-<dl><dt><b><a name='l2h-131'><tt>OP_SINGLE_DH_USE</tt></a></b>
+<dl><dt><b><a name='l2h-132'><tt>OP_SINGLE_DH_USE</tt></a></b>
<dd>
-<dt><b><a name='l2h-148'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
-<dt><b><a name='l2h-149'><tt>OP_NO_SSLv2</tt></a></b><dd>
-<dt><b><a name='l2h-150'><tt>OP_NO_SSLv3</tt></a></b><dd>
-<dt><b><a name='l2h-151'><tt>OP_NO_TLSv1</tt></a></b><dd>
+<dt><b><a name='l2h-152'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
+<dt><b><a name='l2h-153'><tt>OP_NO_SSLv2</tt></a></b><dd>
+<dt><b><a name='l2h-154'><tt>OP_NO_SSLv3</tt></a></b><dd>
+<dt><b><a name='l2h-155'><tt>OP_NO_TLSv1</tt></a></b><dd>
Constants used with <tt class="method">set_options</tt> of Context objects.
<tt class="constant">OP_SINGLE_DH_USE</tt> means to always create a new key when using ephemeral
Diffie-Hellman. <tt class="constant">OP_EPHEMERAL_RSA</tt> means to always use ephemeral RSA keys
@@ -98,13 +98,41 @@ handshake, but don't want to use SSLv2.
</dl>
<P>
-<dl><dt><b><a name='l2h-132'><tt>ContextType</tt></a></b>
+<dl><dt><b><a name='l2h-133'><tt>SSLEAY_VERSION</tt></a></b>
+<dd>
+<dt><b><a name='l2h-156'><tt>SSLEAY_CFLAGS</tt></a></b><dd>
+<dt><b><a name='l2h-157'><tt>SSLEAY_BUILT_ON</tt></a></b><dd>
+<dt><b><a name='l2h-158'><tt>SSLEAY_PLATFORM</tt></a></b><dd>
+<dt><b><a name='l2h-159'><tt>SSLEAY_DIR</tt></a></b><dd>
+Constants used with <tt class="method">SSLeay_version</tt> to specify what OpenSSL version
+information to retrieve. See the man page for the <tt class="function">SSLeay_version</tt> C
+API for details.
+</dl>
+
+<P>
+<dl><dt><b><a name='l2h-134'><tt>OPENSSL_VERSION_NUMBER</tt></a></b>
+<dd>
+An integer giving the version number of the OpenSSL library used to build this
+version of pyOpenSSL. See the man page for the <tt class="function">SSLeay_version</tt> C API
+for details.
+</dl>
+
+<P>
+<dl><dt><b><a name='l2h-135'><tt class='function'>SSLeay_version</tt></a></b>(<var>type</var>)
+<dd>
+Retrieve a string describing some aspect of the underlying OpenSSL version. The
+type passed in should be one of the <tt class="constant">SSLEAY_*</tt> constants defined in
+this module.
+</dl>
+
+<P>
+<dl><dt><b><a name='l2h-136'><tt>ContextType</tt></a></b>
<dd>
See <tt class="class">Context</tt>.
</dl>
<P>
-<dl><dt><b>class <a name='l2h-133'><tt class='class'>Context</tt></a></b>(<var>method</var>)
+<dl><dt><b>class <a name='l2h-137'><tt class='class'>Context</tt></a></b>(<var>method</var>)
<dd>
A class representing SSL contexts. Contexts define the parameters of one or
more SSL connections.
@@ -115,27 +143,27 @@ more SSL connections.
</dl>
<P>
-<dl><dt><b><a name='l2h-134'><tt>ConnectionType</tt></a></b>
+<dl><dt><b><a name='l2h-138'><tt>ConnectionType</tt></a></b>
<dd>
See <tt class="class">Connection</tt>.
</dl>
<P>
-<dl><dt><b>class <a name='l2h-135'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
+<dl><dt><b>class <a name='l2h-139'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
<dd>
A class representing SSL connections.
<P>
<var>context</var> should be an instance of <tt class="class">Context</tt> and <var>socket</var>
should be a socket <A NAME="tex2html4"
- HREF="#foot1231"><SUP>3</SUP></A> object. <var>socket</var> may be
+ HREF="#foot1276"><SUP>3</SUP></A> object. <var>socket</var> may be
<var>None</var>; in this case, the Connection is created with a memory BIO: see
the <tt class="method">bio_read</tt>, <tt class="method">bio_write</tt>, and <tt class="method">bio_shutdown</tt>
methods.
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>Error</tt></a></b>
+<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>Error</tt></a></b>
<dd>
This exception is used as a base class for the other SSL-related
exceptions, but may also be raised directly.
@@ -149,7 +177,7 @@ for more information.
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>ZeroReturnError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>ZeroReturnError</tt></a></b>
<dd>
This exception matches the error return code <code>SSL_ERROR_ZERO_RETURN</code>, and
is raised when the SSL Connection has been closed. In SSL 3.0 and TLS 1.0, this
@@ -163,7 +191,7 @@ It may seem a little strange that this is an exception, but it does match an
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-138'><tt class='exception'>WantReadError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-142'><tt class='exception'>WantReadError</tt></a></b>
<dd>
The operation did not complete; the same I/O method should be called again
later, with the same arguments. Any I/O method can lead to this since new
@@ -180,14 +208,14 @@ probably want to <tt class="method">select()</tt> on the socket before trying ag
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-139'><tt class='exception'>WantWriteError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-143'><tt class='exception'>WantWriteError</tt></a></b>
<dd>
See <tt class="exception">WantReadError</tt>. The socket send buffer may be too full to
write more data.
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>WantX509LookupError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-144'><tt class='exception'>WantX509LookupError</tt></a></b>
<dd>
The operation did not complete because an application callback has asked to be
called again. The I/O method should be called again later, with the same
@@ -196,7 +224,7 @@ callbacks in this version.
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>SysCallError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-145'><tt class='exception'>SysCallError</tt></a></b>
<dd>
The <tt class="exception">SysCallError</tt> occurs when there's an I/O error and OpenSSL's
error queue does not contain any information. This can mean two things: An
@@ -208,7 +236,7 @@ The parameter to the exception is always a pair <code>(<var>errnum</var>,
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot1231">... socket</A><A
+<DT><A NAME="foot1276">... socket</A><A
href="openssl-ssl.html#tex2html4"><SUP>3</SUP></A></DT>
<DD>Actually, all that is required is an object
that <i>behaves</i> like a socket, you could even use files, even though
@@ -221,9 +249,9 @@ it'd be tricky to get the handshakes right!
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL CLASS="ChildLinks">
-<LI><A NAME="tex2html303"
+<LI><A NAME="tex2html289"
href="openssl-context.html">3.3.1 Context objects </A>
-<LI><A NAME="tex2html304"
+<LI><A NAME="tex2html290"
href="openssl-connection.html">3.3.2 Connection objects </A>
</UL>
<!--End of Table of Child-Links-->
@@ -256,7 +284,7 @@ it'd be tricky to get the handshakes right!
<b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A>
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A>
<hr>
-<span class="release-info">Release 0.12.</span>
+<span class="release-info">Release 0.13.</span>
</DIV>
<!--End of Navigation Panel-->