Regenerate documentation for 0.10 release
diff --git a/doc/html/openssl-ssl.html b/doc/html/openssl-ssl.html
index 7d12f84..2f376ba 100644
--- a/doc/html/openssl-ssl.html
+++ b/doc/html/openssl-ssl.html
@@ -16,17 +16,17 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="openssl-rand.html"><img src="previous.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="openssl.html"><img src="up.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="openssl-context.html"><img src="next.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Python OpenSSL Manual</td>
<td><A href="contents.html"><img src="contents.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Contents" width="32"></A></td>
<td><img src="blank.gif"
border="0" height="32"
@@ -41,6 +41,7 @@
<br><hr>
</DIV>
<!--End of Navigation Panel-->
+
<H2><A NAME="SECTION000430000000000000000"> </A>
<BR>
3.3 <tt class="module">SSL</tt> -- An interface to the SSL-specific parts of OpenSSL
@@ -54,39 +55,39 @@
Context, Connection.
<P>
-<dl><dt><b><a name='l2h-100'><tt>SSLv2_METHOD</tt></a></b>
+<dl><dt><b><a name='l2h-109'><tt>SSLv2_METHOD</tt></a></b>
<dd>
-<dt><b><a name='l2h-114'><tt>SSLv3_METHOD</tt></a></b><dd>
-<dt><b><a name='l2h-115'><tt>SSLv23_METHOD</tt></a></b><dd>
-<dt><b><a name='l2h-116'><tt>TLSv1_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-123'><tt>SSLv3_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-124'><tt>SSLv23_METHOD</tt></a></b><dd>
+<dt><b><a name='l2h-125'><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-101'><tt>VERIFY_NONE</tt></a></b>
+<dl><dt><b><a name='l2h-110'><tt>VERIFY_NONE</tt></a></b>
<dd>
-<dt><b><a name='l2h-117'><tt>VERIFY_PEER</tt></a></b><dd>
-<dt><b><a name='l2h-118'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd>
+<dt><b><a name='l2h-126'><tt>VERIFY_PEER</tt></a></b><dd>
+<dt><b><a name='l2h-127'><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-102'><tt>FILETYPE_PEM</tt></a></b>
+<dl><dt><b><a name='l2h-111'><tt>FILETYPE_PEM</tt></a></b>
<dd>
-<dt><b><a name='l2h-119'><tt>FILETYPE_ASN1</tt></a></b><dd>
+<dt><b><a name='l2h-128'><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-103'><tt>OP_SINGLE_DH_USE</tt></a></b>
+<dl><dt><b><a name='l2h-112'><tt>OP_SINGLE_DH_USE</tt></a></b>
<dd>
-<dt><b><a name='l2h-120'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
-<dt><b><a name='l2h-121'><tt>OP_NO_SSLv2</tt></a></b><dd>
-<dt><b><a name='l2h-122'><tt>OP_NO_SSLv3</tt></a></b><dd>
-<dt><b><a name='l2h-123'><tt>OP_NO_TLSv1</tt></a></b><dd>
+<dt><b><a name='l2h-129'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd>
+<dt><b><a name='l2h-130'><tt>OP_NO_SSLv2</tt></a></b><dd>
+<dt><b><a name='l2h-131'><tt>OP_NO_SSLv3</tt></a></b><dd>
+<dt><b><a name='l2h-132'><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
@@ -97,35 +98,44 @@
</dl>
<P>
-<dl><dt><b><a name='l2h-104'><tt>ContextType</tt></a></b>
+<dl><dt><b><a name='l2h-113'><tt>ContextType</tt></a></b>
<dd>
-A Python type object representing the Context object type.
+See <tt class="class">Context</tt>.
</dl>
<P>
-<dl><dt><b><a name='l2h-105'><tt class='function'>Context</tt></a></b>(<var>method</var>)
+<dl><dt><b>class <a name='l2h-114'><tt class='class'>Context</tt></a></b>(<var>method</var>)
<dd>
-Factory function that creates a new Context object given an SSL method. The
-method should be <tt class="constant">SSLv2_METHOD</tt>, <tt class="constant">SSLv3_METHOD</tt>,
+A class representing SSL contexts. Contexts define the parameters of one or
+more SSL connections.
+
+<P>
+<var>method</var> should be <tt class="constant">SSLv2_METHOD</tt>, <tt class="constant">SSLv3_METHOD</tt>,
<tt class="constant">SSLv23_METHOD</tt> or <tt class="constant">TLSv1_METHOD</tt>.
</dl>
<P>
-<dl><dt><b><a name='l2h-106'><tt>ConnectionType</tt></a></b>
+<dl><dt><b><a name='l2h-115'><tt>ConnectionType</tt></a></b>
<dd>
-A Python type object representing the Connection object type.
+See <tt class="class">Connection</tt>.
</dl>
<P>
-<dl><dt><b><a name='l2h-107'><tt class='function'>Connection</tt></a></b>(<var>context, socket</var>)
+<dl><dt><b>class <a name='l2h-116'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>)
<dd>
-Factory fucnction that creates a new Connection object given an SSL context and
-a socket <A NAME="tex2html4"
- HREF="#foot975"><SUP>3</SUP></A> object.
+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="#foot1112"><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-108'><tt class='exception'>Error</tt></a></b>
+<dl><dt><b>exception <a name='l2h-117'><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.
@@ -139,7 +149,7 @@
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-109'><tt class='exception'>ZeroReturnError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-118'><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
@@ -153,21 +163,31 @@
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-110'><tt class='exception'>WantReadError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-119'><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
handshakes can occur at any time.
+
+<P>
+The wanted read is for <i>dirty</i> data sent over the network, not the
+<i>clean</i> data inside the tunnel. For a socket based SSL connection,
+<i>read</i> means data coming at us over the network. Until that read
+succeeds, the attempted <tt class="method">OpenSSL.SSL.Connection.recv</tt>,
+<tt class="method">OpenSSL.SSL.Connection.send</tt>, or
+<tt class="method">OpenSSL.SSL.Connection.do_handshake</tt> is prevented or incomplete. You
+probably want to <tt class="method">select()</tt> on the socket before trying again.
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-111'><tt class='exception'>WantWriteError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-120'><tt class='exception'>WantWriteError</tt></a></b>
<dd>
-See <tt class="exception">WantReadError</tt>.
+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-112'><tt class='exception'>WantX509LookupError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-121'><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
@@ -176,7 +196,7 @@
</dl>
<P>
-<dl><dt><b>exception <a name='l2h-113'><tt class='exception'>SysCallError</tt></a></b>
+<dl><dt><b>exception <a name='l2h-122'><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
@@ -188,16 +208,15 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot975">... socket</A><A
+<DT><A NAME="foot1112">... 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 it'd be
-tricky to get the handshakes right!
+<DD>Actually, all that is required is an object
+that <i>behaves</i> like a socket, you could even use files, even though
+it'd be tricky to get the handshakes right!
</DD>
</DL>
<p><hr>
-
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
@@ -214,17 +233,17 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="openssl-rand.html"><img src="previous.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="openssl.html"><img src="up.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="openssl-context.html"><img src="next.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Python OpenSSL Manual</td>
<td><A href="contents.html"><img src="contents.gif"
-border="0" height="32"
+ border="0" height="32"
alt="Contents" width="32"></A></td>
<td><img src="blank.gif"
border="0" height="32"
@@ -237,7 +256,7 @@
<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.9.</span>
+<span class="release-info">Release 0.10.</span>
</DIV>
<!--End of Navigation Panel-->