diff options
| author | Matěj Cepl <mcepl@cepl.eu> | 2017-10-05 14:53:20 +0200 |
|---|---|---|
| committer | Matěj Cepl <mcepl@cepl.eu> | 2018-02-08 17:48:51 +0100 |
| commit | 9d79ac666605211107c099e530823792a4c4ecea (patch) | |
| tree | a48c3eefd834b3ee30247f3dad7fea91e95ff4ee /doc/html/M2Crypto.SSL.html | |
| parent | 8956b5e0dc469482a2350b4cac920870badd64a4 (diff) | |
| download | m2crypto-9d79ac666605211107c099e530823792a4c4ecea.tar.gz | |
Update docs
Diffstat (limited to 'doc/html/M2Crypto.SSL.html')
| -rw-r--r-- | doc/html/M2Crypto.SSL.html | 616 |
1 files changed, 308 insertions, 308 deletions
diff --git a/doc/html/M2Crypto.SSL.html b/doc/html/M2Crypto.SSL.html index 1c1eb09..63d1f24 100644 --- a/doc/html/M2Crypto.SSL.html +++ b/doc/html/M2Crypto.SSL.html @@ -1,149 +1,136 @@ - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>SSL Package — M2Crypto documentation</title> - - <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <title>SSL Package — M2Crypto documentation</title> + <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', + URL_ROOT: './', VERSION: '', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> - <link rel="top" title="M2Crypto documentation" href="index.html" /> - <link rel="up" title="M2Crypto Package" href="M2Crypto.html" /> - <link rel="prev" title="PGP Package" href="M2Crypto.PGP.html" /> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="prev" title="M2Crypto Package" href="M2Crypto.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + </head> <body> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="M2Crypto.PGP.html" title="PGP Package" - accesskey="P">previous</a> |</li> - <li><a href="index.html">M2Crypto documentation</a> »</li> - <li><a href="M2Crypto.html" accesskey="U">M2Crypto Package</a> »</li> - </ul> - </div> + <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> - <div class="body"> + <div class="body" role="main"> <div class="section" id="ssl-package"> <h1>SSL Package<a class="headerlink" href="#ssl-package" title="Permalink to this headline">¶</a></h1> <div class="section" id="id1"> -<h2><tt class="xref py py-mod docutils literal"><span class="pre">SSL</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> +<h2><code class="xref py py-mod docutils literal"><span class="pre">SSL</span></code> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> <span class="target" id="module-M2Crypto.SSL"></span><dl class="exception"> <dt id="M2Crypto.SSL.SSLError"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.</tt><tt class="descname">SSLError</tt><a class="reference internal" href="_modules/M2Crypto/SSL.html#SSLError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLError" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.</code><code class="descname">SSLError</code><a class="reference internal" href="_modules/M2Crypto/SSL.html#SSLError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLError" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p> </dd></dl> <dl class="exception"> <dt id="M2Crypto.SSL.SSLTimeoutError"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.</tt><tt class="descname">SSLTimeoutError</tt><a class="reference internal" href="_modules/M2Crypto/SSL.html#SSLTimeoutError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLTimeoutError" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.SSLError" title="M2Crypto.SSL.SSLError"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLError</span></tt></a>, <tt class="xref py py-class docutils literal"><span class="pre">socket.timeout</span></tt></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.</code><code class="descname">SSLTimeoutError</code><a class="reference internal" href="_modules/M2Crypto/SSL.html#SSLTimeoutError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLTimeoutError" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.SSLError" title="M2Crypto.SSL.SSLError"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLError</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">socket.timeout</span></code></p> </dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.Checker"> -<span id="checker-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">Checker</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.Checker" title="Permalink to this headline">¶</a></h2> +<span id="checker-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">Checker</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.Checker" title="Permalink to this headline">¶</a></h2> <p>SSL peer certificate checking routines</p> <p>Copyright (c) 2004-2007 Open Source Applications Foundation. All rights reserved.</p> <p>Copyright 2008 Heikki Toivonen. All rights reserved.</p> <dl class="exception"> <dt id="M2Crypto.SSL.Checker.SSLVerificationError"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.Checker.</tt><tt class="descname">SSLVerificationError</tt><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#SSLVerificationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.Checker.</code><code class="descname">SSLVerificationError</code><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#SSLVerificationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p> </dd></dl> <dl class="exception"> <dt id="M2Crypto.SSL.Checker.NoCertificate"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.Checker.</tt><tt class="descname">NoCertificate</tt><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#NoCertificate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.NoCertificate" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></tt></a></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.Checker.</code><code class="descname">NoCertificate</code><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#NoCertificate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.NoCertificate" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></code></a></p> </dd></dl> <dl class="exception"> <dt id="M2Crypto.SSL.Checker.WrongCertificate"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.Checker.</tt><tt class="descname">WrongCertificate</tt><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#WrongCertificate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.WrongCertificate" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></tt></a></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.Checker.</code><code class="descname">WrongCertificate</code><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#WrongCertificate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.WrongCertificate" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></code></a></p> </dd></dl> <dl class="exception"> <dt id="M2Crypto.SSL.Checker.WrongHost"> -<em class="property">exception </em><tt class="descclassname">M2Crypto.SSL.Checker.</tt><tt class="descname">WrongHost</tt><big>(</big><em>expectedHost</em>, <em>actualHost</em>, <em>fieldName='commonName'</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#WrongHost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.WrongHost" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></tt></a></p> +<em class="property">exception </em><code class="descclassname">M2Crypto.SSL.Checker.</code><code class="descname">WrongHost</code><span class="sig-paren">(</span><em>expectedHost</em>, <em>actualHost</em>, <em>fieldName='commonName'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#WrongHost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.WrongHost" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#M2Crypto.SSL.Checker.SSLVerificationError" title="M2Crypto.SSL.Checker.SSLVerificationError"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.Checker.SSLVerificationError</span></code></a></p> </dd></dl> <dl class="class"> <dt id="M2Crypto.SSL.Checker.Checker"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Checker.</tt><tt class="descname">Checker</tt><big>(</big><em>host=None</em>, <em>peerCertHash=None</em>, <em>peerCertDigest='sha1'</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#Checker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.Checker" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Checker.</code><code class="descname">Checker</code><span class="sig-paren">(</span><em>host=None</em>, <em>peerCertHash=None</em>, <em>peerCertDigest='sha1'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Checker.html#Checker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Checker.Checker" title="Permalink to this definition">¶</a></dt> <dd><dl class="attribute"> <dt id="M2Crypto.SSL.Checker.Checker.numericIpMatch"> -<tt class="descname">numericIpMatch</tt><em class="property"> = <_sre.SRE_Pattern object at 0x1fe7dd0></em><a class="headerlink" href="#M2Crypto.SSL.Checker.Checker.numericIpMatch" title="Permalink to this definition">¶</a></dt> +<code class="descname">numericIpMatch</code><em class="property"> = <_sre.SRE_Pattern object></em><a class="headerlink" href="#M2Crypto.SSL.Checker.Checker.numericIpMatch" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.Cipher"> -<span id="cipher-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">Cipher</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.Cipher" title="Permalink to this headline">¶</a></h2> +<span id="cipher-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">Cipher</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.Cipher" title="Permalink to this headline">¶</a></h2> <p>SSL Ciphers</p> <p>Copyright (c) 1999-2003 Ng Pheng Siong. All rights reserved.</p> <dl class="class"> <dt id="M2Crypto.SSL.Cipher.Cipher"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Cipher.</tt><tt class="descname">Cipher</tt><big>(</big><em>cipher</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Cipher.</code><code class="descname">Cipher</code><span class="sig-paren">(</span><em>cipher</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="M2Crypto.SSL.Cipher.Cipher.name"> -<tt class="descname">name</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher.name" title="Permalink to this definition">¶</a></dt> +<code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher.name" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Cipher.Cipher.version"> -<tt class="descname">version</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher.version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher.version" title="Permalink to this definition">¶</a></dt> +<code class="descname">version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher.version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher.version" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="class"> <dt id="M2Crypto.SSL.Cipher.Cipher_Stack"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Cipher.</tt><tt class="descname">Cipher_Stack</tt><big>(</big><em>stack</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher_Stack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher_Stack" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Cipher.</code><code class="descname">Cipher_Stack</code><span class="sig-paren">(</span><em>stack</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Cipher.html#Cipher_Stack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Cipher.Cipher_Stack" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.Connection"> -<span id="connection-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">Connection</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.Connection" title="Permalink to this headline">¶</a></h2> +<span id="connection-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">Connection</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.Connection" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="M2Crypto.SSL.Connection.Connection"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Connection.</tt><tt class="descname">Connection</tt><big>(</big><em>ctx</em>, <em>sock=None</em>, <em>family=2</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Connection.</code><code class="descname">Connection</code><span class="sig-paren">(</span><em>ctx</em>, <em>sock=None</em>, <em>family=2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection" title="Permalink to this definition">¶</a></dt> <dd><p>An SSL connection.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.accept"> -<tt class="descname">accept</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.accept" title="Permalink to this definition">¶</a></dt> +<code class="descname">accept</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.accept" title="Permalink to this definition">¶</a></dt> <dd><p>Accept an SSL connection.</p> <p>The return value is a pair (ssl, addr) where ssl is a new SSL connection object and addr is the address bound to the other end @@ -164,7 +151,7 @@ optional ints.</td> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.accept_ssl"> -<tt class="descname">accept_ssl</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.accept_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.accept_ssl" title="Permalink to this definition">¶</a></dt> +<code class="descname">accept_ssl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.accept_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.accept_ssl" title="Permalink to this definition">¶</a></dt> <dd><p>Waits for a TLS/SSL client to initiate the TLS/SSL handshake.</p> <p>The communication channel must already have been set and assigned to the ssl by setting an underlying BIO.</p> @@ -195,12 +182,12 @@ out the reason.</dd> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.bind"> -<tt class="descname">bind</tt><big>(</big><em>addr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.bind" title="Permalink to this definition">¶</a></dt> +<code class="descname">bind</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.bind" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.clear"> -<tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.clear" title="Permalink to this definition">¶</a></dt> +<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.clear" title="Permalink to this definition">¶</a></dt> <dd><p>If there were errors in this connection, call clear() rather than close() to end it, so that bad sessions will be cleared from cache.</p> @@ -208,23 +195,23 @@ from cache.</p> <dl class="attribute"> <dt id="M2Crypto.SSL.Connection.Connection.clientPostConnectionCheck"> -<tt class="descname">clientPostConnectionCheck</tt><em class="property"> = <M2Crypto.SSL.Checker.Checker instance at 0x2057cf8></em><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.clientPostConnectionCheck" title="Permalink to this definition">¶</a></dt> +<code class="descname">clientPostConnectionCheck</code><em class="property"> = <M2Crypto.SSL.Checker.Checker instance></em><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.clientPostConnectionCheck" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.close"> -<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.close" title="Permalink to this definition">¶</a></dt> +<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.close" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.connect"> -<tt class="descname">connect</tt><big>(</big><em>addr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.connect" title="Permalink to this definition">¶</a></dt> +<code class="descname">connect</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.connect" title="Permalink to this definition">¶</a></dt> <dd><p>Overloading socket.connect()</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> – addresses have various depending on their type</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> – addresses have various depending on their type</td> </tr> </tbody> </table> @@ -233,30 +220,30 @@ from cache.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.connect_ssl"> -<tt class="descname">connect_ssl</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.connect_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.connect_ssl" title="Permalink to this definition">¶</a></dt> +<code class="descname">connect_ssl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.connect_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.connect_ssl" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.fileno"> -<tt class="descname">fileno</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.fileno"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.fileno" title="Permalink to this definition">¶</a></dt> +<code class="descname">fileno</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.fileno"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.fileno" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_cipher"> -<tt class="descname">get_cipher</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_cipher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_cipher" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_cipher</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_cipher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_cipher" title="Permalink to this definition">¶</a></dt> <dd><p>Return an M2Crypto.SSL.Cipher object for this connection; if the connection has not been initialised with a cipher suite, return None.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_cipher_list"> -<tt class="descname">get_cipher_list</tt><big>(</big><em>idx=0</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_cipher_list" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_cipher_list</code><span class="sig-paren">(</span><em>idx=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_cipher_list" title="Permalink to this definition">¶</a></dt> <dd><p>Return the cipher suites for this connection as a string object.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_ciphers"> -<tt class="descname">get_ciphers</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_ciphers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_ciphers" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_ciphers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_ciphers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_ciphers" title="Permalink to this definition">¶</a></dt> <dd><p>Return an M2Crypto.SSL.Cipher_Stack object for this connection; if the connection has not been initialised with cipher suites, return None.</p> @@ -264,32 +251,32 @@ cipher suites, return None.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_context"> -<tt class="descname">get_context</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_context" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the SSL.Context object associated with this connection.</p> +<code class="descname">get_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_context" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the Context object associated with this connection.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_default_session_timeout"> -<tt class="descname">get_default_session_timeout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_default_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_default_session_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_default_session_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_default_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_default_session_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_peer_cert"> -<tt class="descname">get_peer_cert</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_peer_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_peer_cert" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_peer_cert</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_peer_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_peer_cert" title="Permalink to this definition">¶</a></dt> <dd><p>Return the peer certificate.</p> <p>If the peer did not provide a certificate, return None.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_peer_cert_chain"> -<tt class="descname">get_peer_cert_chain</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_peer_cert_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_peer_cert_chain" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_peer_cert_chain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_peer_cert_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_peer_cert_chain" title="Permalink to this definition">¶</a></dt> <dd><p>Return the peer certificate chain; if the peer did not provide a certificate chain, return None.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">The returned chain will be valid only for as long as the +<tr class="field-odd field"><th class="field-name">Warning:</th><td class="field-body">The returned chain will be valid only for as long as the connection object is alive. Once the connection object gets freed, the chain will be freed as well.</td> </tr> @@ -299,28 +286,28 @@ gets freed, the chain will be freed as well.</td> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_session"> -<tt class="descname">get_session</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_session" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_session</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_session" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_shutdown"> -<tt class="descname">get_shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_shutdown" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_shutdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_shutdown" title="Permalink to this definition">¶</a></dt> <dd><p>Get the current shutdown mode of the Connection.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_socket_read_timeout"> -<tt class="descname">get_socket_read_timeout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_socket_read_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_socket_read_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_socket_read_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_socket_read_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_socket_read_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_socket_write_timeout"> -<tt class="descname">get_socket_write_timeout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_socket_write_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_socket_write_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_socket_write_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_socket_write_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_socket_write_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_state"> -<tt class="descname">get_state</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_state" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_state" title="Permalink to this definition">¶</a></dt> <dd><p>Return the SSL state of this connection.</p> <p>During its use, an SSL objects passes several states. The state is internally maintained. Querying the state information is not @@ -340,31 +327,31 @@ object ssl.</td> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_verify_depth"> -<tt class="descname">get_verify_depth</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_depth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_depth" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_verify_depth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_depth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_depth" title="Permalink to this definition">¶</a></dt> <dd><p>Return the peer certificate verification depth.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_verify_mode"> -<tt class="descname">get_verify_mode</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_mode" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_verify_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_mode" title="Permalink to this definition">¶</a></dt> <dd><p>Return the peer certificate verification mode.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_verify_result"> -<tt class="descname">get_verify_result</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_result" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_verify_result</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_verify_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_verify_result" title="Permalink to this definition">¶</a></dt> <dd><p>Return the peer certificate verification result.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.get_version"> -<tt class="descname">get_version</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_version" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.get_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.get_version" title="Permalink to this definition">¶</a></dt> <dd><p>Return the TLS/SSL protocol version for this connection.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.getpeername"> -<tt class="descname">getpeername</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getpeername"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getpeername" title="Permalink to this definition">¶</a></dt> +<code class="descname">getpeername</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getpeername"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getpeername" title="Permalink to this definition">¶</a></dt> <dd><p>Return the remote address to which the socket is connected.</p> <p>This is useful to find out the port number of a remote IPv4/v6 socket, for instance. @@ -381,24 +368,24 @@ On some systems this function is not supported.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.getsockname"> -<tt class="descname">getsockname</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getsockname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getsockname" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the socket’s own address.</p> +<code class="descname">getsockname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getsockname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getsockname" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the socket’s own address.</p> <p>This is useful to find out the port number of an IPv4/v6 socket, for instance. (The format of the address returned depends -on the address family – see above.)</p> -<p>:return:socket’s address as addr type</p> +on the address family – see above.)</p> +<p>:return:socket’s address as addr type</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.getsockopt"> -<tt class="descname">getsockopt</tt><big>(</big><em>level</em>, <em>optname</em>, <em>buflen=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getsockopt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getsockopt" title="Permalink to this definition">¶</a></dt> +<code class="descname">getsockopt</code><span class="sig-paren">(</span><em>level</em>, <em>optname</em>, <em>buflen=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.getsockopt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.getsockopt" title="Permalink to this definition">¶</a></dt> <dd><p>Get the value of the given socket option.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>level</strong> – level at which the option resides. +<li><strong>level</strong> – level at which the option resides. To manipulate options at the sockets API level, level is specified as socket.SOL_SOCKET. To manipulate options at any other level the protocol number of the appropriate @@ -406,11 +393,11 @@ protocol controlling the option is supplied. For example, to indicate that an option is to be interpreted by the TCP protocol, level should be set to the protocol number of socket.SOL_TCP; see getprotoent(3).</li> -<li><strong>optname</strong> – The value of the given socket option is +<li><strong>optname</strong> – The value of the given socket option is described in the Unix man page getsockopt(2)). The needed symbolic constants (SO_* etc.) are defined in the socket module.</li> -<li><strong>buflen</strong> – If it is absent, an integer option is assumed +<li><strong>buflen</strong> – If it is absent, an integer option is assumed and its integer value is returned by the function. If buflen is present, it specifies the maximum length of the buffer used to receive the option in, and this buffer is @@ -430,70 +417,83 @@ C structures encoded as byte strings).</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.listen"> -<tt class="descname">listen</tt><big>(</big><em>qlen=5</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.listen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.listen" title="Permalink to this definition">¶</a></dt> +<code class="descname">listen</code><span class="sig-paren">(</span><em>qlen=5</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.listen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.listen" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.m2_bio_free"> -<tt class="descname">m2_bio_free</tt><big>(</big><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.m2_bio_free" title="Permalink to this definition">¶</a></dt> +<code class="descname">m2_bio_free</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.m2_bio_free" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.m2_ssl_free"> -<tt class="descname">m2_ssl_free</tt><big>(</big><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.m2_ssl_free" title="Permalink to this definition">¶</a></dt> +<code class="descname">m2_ssl_free</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.m2_ssl_free" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.makefile"> -<tt class="descname">makefile</tt><big>(</big><em>mode='rb'</em>, <em>bufsize=-1</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.makefile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.makefile" title="Permalink to this definition">¶</a></dt> +<code class="descname">makefile</code><span class="sig-paren">(</span><em>mode='rb'</em>, <em>bufsize=-1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.makefile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.makefile" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.pending"> -<tt class="descname">pending</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.pending"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.pending" title="Permalink to this definition">¶</a></dt> +<code class="descname">pending</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.pending"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.pending" title="Permalink to this definition">¶</a></dt> <dd><p>Return the numbers of octets that can be read from the connection.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.read"> -<tt class="descname">read</tt><big>(</big><em>size=1024</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.read" title="Permalink to this definition">¶</a></dt> +<code class="descname">read</code><span class="sig-paren">(</span><em>size=1024</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.read" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.recv"> -<tt class="descname">recv</tt><big>(</big><em>size=1024</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.recv" title="Permalink to this definition">¶</a></dt> +<code class="descname">recv</code><span class="sig-paren">(</span><em>size=1024</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.recv" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> +<dt id="M2Crypto.SSL.Connection.Connection.recv_into"> +<code class="descname">recv_into</code><span class="sig-paren">(</span><em>buff</em>, <em>nbytes=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.recv_into"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.recv_into" title="Permalink to this definition">¶</a></dt> +<dd><p>A version of recv() that stores its data into a buffer rather +than creating a new string. Receive up to buffersize bytes from +the socket. If buffersize is not specified (or 0), receive up +to the size available in the given buffer.</p> +<p>@param buffer: a buffer for the received bytes +@param nbytes: maximum number of bytes to read +@return: number of bytes added</p> +<p>See recv() for documentation about the flags.</p> +</dd></dl> + +<dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.renegotiate"> -<tt class="descname">renegotiate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.renegotiate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.renegotiate" title="Permalink to this definition">¶</a></dt> -<dd><p>Renegotiate this connection’s SSL parameters.</p> +<code class="descname">renegotiate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.renegotiate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.renegotiate" title="Permalink to this definition">¶</a></dt> +<dd><p>Renegotiate this connection’s SSL parameters.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.send"> -<tt class="descname">send</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.send" title="Permalink to this definition">¶</a></dt> +<code class="descname">send</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.send" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.sendall"> -<tt class="descname">sendall</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.sendall" title="Permalink to this definition">¶</a></dt> +<code class="descname">sendall</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.sendall" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.serverPostConnectionCheck"> -<tt class="descname">serverPostConnectionCheck</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.serverPostConnectionCheck" title="Permalink to this definition">¶</a></dt> +<code class="descname">serverPostConnectionCheck</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.serverPostConnectionCheck" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_accept_state"> -<tt class="descname">set_accept_state</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_accept_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_accept_state" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_accept_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_accept_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_accept_state" title="Permalink to this definition">¶</a></dt> <dd><p>Sets Connection to work in the server mode.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_bio"> -<tt class="descname">set_bio</tt><big>(</big><em>readbio</em>, <em>writebio</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_bio"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_bio" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_bio</code><span class="sig-paren">(</span><em>readbio</em>, <em>writebio</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_bio"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_bio" title="Permalink to this definition">¶</a></dt> <dd><p>Explicitly set read and write bios</p> <p>Connects the BIOs for the read and write operations of the TLS/SSL (encrypted) side of ssl.</p> @@ -508,8 +508,8 @@ different).</p> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> -<li><strong>readbio</strong> – BIO for reading</li> -<li><strong>writebio</strong> – BIO for writing.</li> +<li><strong>readbio</strong> – BIO for reading</li> +<li><strong>writebio</strong> – BIO for writing.</li> </ul> </td> </tr> @@ -519,13 +519,13 @@ different).</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_cipher_list"> -<tt class="descname">set_cipher_list</tt><big>(</big><em>cipher_list</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_cipher_list" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_cipher_list</code><span class="sig-paren">(</span><em>cipher_list</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_cipher_list" title="Permalink to this definition">¶</a></dt> <dd><p>Set the cipher suites for this connection.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_context"> -<tt class="descname">set_client_CA_list_from_context</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_client_CA_list_from_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_context" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_client_CA_list_from_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_client_CA_list_from_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_context" title="Permalink to this definition">¶</a></dt> <dd><p>Set the acceptable client CA list. If the client returns a certificate, it must have been issued by one of the CAs listed in context.</p> @@ -534,7 +534,7 @@ one of the CAs listed in context.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_file"> -<tt class="descname">set_client_CA_list_from_file</tt><big>(</big><em>cafile</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_client_CA_list_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_file" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_client_CA_list_from_file</code><span class="sig-paren">(</span><em>cafile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_client_CA_list_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_client_CA_list_from_file" title="Permalink to this definition">¶</a></dt> <dd><p>Set the acceptable client CA list.</p> <p>If the client returns a certificate, it must have been issued by one of the CAs listed in cafile.</p> @@ -543,7 +543,7 @@ one of the CAs listed in cafile.</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – Filename from which to load the CA list.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – Filename from which to load the CA list.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> <dt>0 A failure while manipulating the STACK_OF(X509_NAME)</dt> @@ -560,40 +560,40 @@ out the reason.</dd> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_connect_state"> -<tt class="descname">set_connect_state</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_connect_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_connect_state" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_connect_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_connect_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_connect_state" title="Permalink to this definition">¶</a></dt> <dd><p>Sets Connection to work in the client mode.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_post_connection_check_callback"> -<tt class="descname">set_post_connection_check_callback</tt><big>(</big><em>postConnectionCheck</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_post_connection_check_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_post_connection_check_callback" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_post_connection_check_callback</code><span class="sig-paren">(</span><em>postConnectionCheck</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_post_connection_check_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_post_connection_check_callback" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_session"> -<tt class="descname">set_session</tt><big>(</big><em>session</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_session" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_session</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_session" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_session_id_ctx"> -<tt class="descname">set_session_id_ctx</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_session_id_ctx"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_session_id_ctx" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_session_id_ctx</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_session_id_ctx"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_session_id_ctx" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_shutdown"> -<tt class="descname">set_shutdown</tt><big>(</big><em>mode</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_shutdown" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_shutdown</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_shutdown" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the shutdown state of the Connection to mode.</p> <p>The shutdown state of an ssl connection is a bitmask of (use m2.SSL_* constants):</p> <p>0 No shutdown setting, yet.</p> <dl class="docutils"> <dt>SSL_SENT_SHUTDOWN</dt> -<dd>A “close notify” shutdown alert was sent to the peer, the +<dd>A “close notify” shutdown alert was sent to the peer, the connection is being considered closed and the session is closed and correct.</dd> <dt>SSL_RECEIVED_SHUTDOWN</dt> <dd>A shutdown alert was received form the peer, either a normal -“close notify” or a fatal error.</dd> +“close notify” or a fatal error.</dd> </dl> <p>SSL_SENT_SHUTDOWN and SSL_RECEIVED_SHUTDOWN can be set at the same time.</p> @@ -601,7 +601,7 @@ same time.</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – set the mode bitmask.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – set the mode bitmask.</td> </tr> </tbody> </table> @@ -609,24 +609,24 @@ same time.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_socket_read_timeout"> -<tt class="descname">set_socket_read_timeout</tt><big>(</big><em>timeo</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_socket_read_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_socket_read_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_socket_read_timeout</code><span class="sig-paren">(</span><em>timeo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_socket_read_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_socket_read_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_socket_write_timeout"> -<tt class="descname">set_socket_write_timeout</tt><big>(</big><em>timeo</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_socket_write_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_socket_write_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_socket_write_timeout</code><span class="sig-paren">(</span><em>timeo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_socket_write_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_socket_write_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_ssl_close_flag"> -<tt class="descname">set_ssl_close_flag</tt><big>(</big><em>flag</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_ssl_close_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_ssl_close_flag" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_ssl_close_flag</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_ssl_close_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_ssl_close_flag" title="Permalink to this definition">¶</a></dt> <dd><p>By default, SSL struct will be freed in __del__. Call with m2.bio_close to override this default.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flag</strong> – either m2.bio_close or m2.bio_noclose</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flag</strong> – either m2.bio_close or m2.bio_noclose</td> </tr> </tbody> </table> @@ -634,19 +634,19 @@ m2.bio_close to override this default.</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.set_tlsext_host_name"> -<tt class="descname">set_tlsext_host_name</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_tlsext_host_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_tlsext_host_name" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_tlsext_host_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.set_tlsext_host_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.set_tlsext_host_name" title="Permalink to this definition">¶</a></dt> <dd><p>Set the requested hostname for the SNI (Server Name Indication) extension.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.setblocking"> -<tt class="descname">setblocking</tt><big>(</big><em>mode</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setblocking"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setblocking" title="Permalink to this definition">¶</a></dt> -<dd><p>Set this connection’s underlying socket to _mode_.</p> +<code class="descname">setblocking</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setblocking"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setblocking" title="Permalink to this definition">¶</a></dt> +<dd><p>Set this connection’s underlying socket to _mode_.</p> <p>Set blocking or non-blocking mode of the socket: if flag is 0, the socket is set to non-blocking, else to blocking mode. Initially all sockets are in blocking mode. In non-blocking mode, -if a recv() call doesn’t find any data, or if a send() call can’t +if a recv() call doesn’t find any data, or if a send() call can’t immediately dispose of the data, a error exception is raised; in blocking mode, the calls block until they can proceed. s.setblocking(0) is equivalent to s.settimeout(0.0); @@ -655,7 +655,7 @@ s.setblocking(1) is equivalent to s.settimeout(None).</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – new mode to be set</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – new mode to be set</td> </tr> </tbody> </table> @@ -663,16 +663,16 @@ s.setblocking(1) is equivalent to s.settimeout(None).</p> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.setsockopt"> -<tt class="descname">setsockopt</tt><big>(</big><em>level</em>, <em>optname</em>, <em>value=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setsockopt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setsockopt" title="Permalink to this definition">¶</a></dt> +<code class="descname">setsockopt</code><span class="sig-paren">(</span><em>level</em>, <em>optname</em>, <em>value=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setsockopt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setsockopt" title="Permalink to this definition">¶</a></dt> <dd><p>Set the value of the given socket option.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>level</strong> – same as with getsockopt() above</li> -<li><strong>optname</strong> – same as with getsockopt() above</li> -<li><strong>value</strong> – an integer or a string representing a buffer. In +<li><strong>level</strong> – same as with getsockopt() above</li> +<li><strong>optname</strong> – same as with getsockopt() above</li> +<li><strong>value</strong> – an integer or a string representing a buffer. In the latter case it is up to the caller to ensure that the string contains the proper bits (see the optional built-in module struct for a way to @@ -689,63 +689,63 @@ encode C structures as strings).</li> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.settimeout"> -<tt class="descname">settimeout</tt><big>(</big><em>timeout</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.settimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.settimeout" title="Permalink to this definition">¶</a></dt> -<dd><p>Set this connection’s underlying socket’s timeout to _timeout_.</p> +<code class="descname">settimeout</code><span class="sig-paren">(</span><em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.settimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.settimeout" title="Permalink to this definition">¶</a></dt> +<dd><p>Set this connection’s underlying socket’s timeout to _timeout_.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.setup_addr"> -<tt class="descname">setup_addr</tt><big>(</big><em>addr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setup_addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setup_addr" title="Permalink to this definition">¶</a></dt> +<code class="descname">setup_addr</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setup_addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setup_addr" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.setup_ssl"> -<tt class="descname">setup_ssl</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setup_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setup_ssl" title="Permalink to this definition">¶</a></dt> +<code class="descname">setup_ssl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.setup_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.setup_ssl" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.shutdown"> -<tt class="descname">shutdown</tt><big>(</big><em>how</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.shutdown" title="Permalink to this definition">¶</a></dt> +<code class="descname">shutdown</code><span class="sig-paren">(</span><em>how</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.shutdown" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.ssl_get_error"> -<tt class="descname">ssl_get_error</tt><big>(</big><em>ret</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.ssl_get_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.ssl_get_error" title="Permalink to this definition">¶</a></dt> +<code class="descname">ssl_get_error</code><span class="sig-paren">(</span><em>ret</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.ssl_get_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.ssl_get_error" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.verify_ok"> -<tt class="descname">verify_ok</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.verify_ok"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.verify_ok" title="Permalink to this definition">¶</a></dt> +<code class="descname">verify_ok</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.verify_ok"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.verify_ok" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Connection.Connection.write"> -<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.write" title="Permalink to this definition">¶</a></dt> +<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Connection.html#Connection.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Connection.Connection.write" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.Context"> -<span id="context-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">Context</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.Context" title="Permalink to this headline">¶</a></h2> +<span id="context-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">Context</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.Context" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="M2Crypto.SSL.Context.ctxmap"> -<tt class="descclassname">M2Crypto.SSL.Context.</tt><tt class="descname">ctxmap</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#ctxmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.ctxmap" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.Context.</code><code class="descname">ctxmap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#ctxmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.ctxmap" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="class"> <dt id="M2Crypto.SSL.Context.Context"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Context.</tt><tt class="descname">Context</tt><big>(</big><em>protocol='tls'</em>, <em>weak_crypto=None</em>, <em>post_connection_check=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context" title="Permalink to this definition">¶</a></dt> -<dd><p>‘Context’ for SSL connections.</p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Context.</code><code class="descname">Context</code><span class="sig-paren">(</span><em>protocol='tls'</em>, <em>weak_crypto=None</em>, <em>post_connection_check=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context" title="Permalink to this definition">¶</a></dt> +<dd><p>‘Context’ for SSL connections.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.add_session"> -<tt class="descname">add_session</tt><big>(</big><em>session</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.add_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.add_session" title="Permalink to this definition">¶</a></dt> +<code class="descname">add_session</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.add_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.add_session" title="Permalink to this definition">¶</a></dt> <dd><p>Add the session to the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session</strong> – the session to be added.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session</strong> – the session to be added.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> <dt>0 The operation failed. It was tried to add the same</dt> @@ -760,26 +760,26 @@ encode C structures as strings).</li> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.close"> -<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.close" title="Permalink to this definition">¶</a></dt> +<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.close" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_allow_unknown_ca"> -<tt class="descname">get_allow_unknown_ca</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> -<dd><p>Get the context’s setting that accepts/rejects a peer -certificate if the certificate’s CA is unknown.</p> +<code class="descname">get_allow_unknown_ca</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> +<dd><p>Get the context’s setting that accepts/rejects a peer +certificate if the certificate’s CA is unknown.</p> <p>FIXME 2Bconverted to bool</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_cert_store"> -<tt class="descname">get_cert_store</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_cert_store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_cert_store" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_cert_store</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_cert_store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_cert_store" title="Permalink to this definition">¶</a></dt> <dd><p>Get the certificate store associated with this context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">The store is NOT refcounted, and as such can not be relied +<tr class="field-odd field"><th class="field-name">Warning:</th><td class="field-body">The store is NOT refcounted, and as such can not be relied to be valid once the context goes away or is changed.</td> </tr> </tbody> @@ -788,7 +788,7 @@ to be valid once the context goes away or is changed.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_session_cache_mode"> -<tt class="descname">get_session_cache_mode</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_session_cache_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_session_cache_mode" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_session_cache_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_session_cache_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_session_cache_mode" title="Permalink to this definition">¶</a></dt> <dd><p>Gets the current session caching.</p> <p>The mode is set to m2.SSL_SESS_CACHE_* constants.</p> <table class="docutils field-list" frame="void" rules="none"> @@ -803,7 +803,7 @@ to be valid once the context goes away or is changed.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_session_timeout"> -<tt class="descname">get_session_timeout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_session_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_session_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_session_timeout" title="Permalink to this definition">¶</a></dt> <dd><p>Get current session timeout.</p> <p>Whenever a new session is created, it is assigned a maximum lifetime. This lifetime is specified by storing the creation @@ -835,29 +835,29 @@ seconds.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_verify_depth"> -<tt class="descname">get_verify_depth</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_verify_depth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_verify_depth" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_verify_depth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_verify_depth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_verify_depth" title="Permalink to this definition">¶</a></dt> <dd><p>Returns the verification mode currently set in the SSL Context.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.get_verify_mode"> -<tt class="descname">get_verify_mode</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_verify_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_verify_mode" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_verify_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.get_verify_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.get_verify_mode" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_cert"> -<tt class="descname">load_cert</tt><big>(</big><em>certfile</em>, <em>keyfile=None</em>, <em>callback=<function passphrase_callback at 0x1faa848></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_cert" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_cert</code><span class="sig-paren">(</span><em>certfile</em>, <em>keyfile=None</em>, <em>callback=<function passphrase_callback></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_cert" title="Permalink to this definition">¶</a></dt> <dd><p>Load certificate and private key into the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> -<li><strong>certfile</strong> – File that contains the PEM-encoded certificate.</li> -<li><strong>keyfile</strong> – File that contains the PEM-encoded private key. +<li><strong>certfile</strong> – File that contains the PEM-encoded certificate.</li> +<li><strong>keyfile</strong> – File that contains the PEM-encoded private key. Default value of None indicates that the private key -is to be found in ‘certfile’.</li> -<li><strong>callback</strong> – Callable object to be invoked if the private key is +is to be found in ‘certfile’.</li> +<li><strong>callback</strong> – Callable object to be invoked if the private key is passphrase-protected. Default callback provides a simple terminal-style input for the passphrase.</li> </ul> @@ -869,19 +869,19 @@ simple terminal-style input for the passphrase.</li> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_cert_chain"> -<tt class="descname">load_cert_chain</tt><big>(</big><em>certchainfile</em>, <em>keyfile=None</em>, <em>callback=<function passphrase_callback at 0x1faa848></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_cert_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_cert_chain" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_cert_chain</code><span class="sig-paren">(</span><em>certchainfile</em>, <em>keyfile=None</em>, <em>callback=<function passphrase_callback></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_cert_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_cert_chain" title="Permalink to this definition">¶</a></dt> <dd><p>Load certificate chain and private key into the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> -<li><strong>certchainfile</strong> – File object containing the PEM-encoded +<li><strong>certchainfile</strong> – File object containing the PEM-encoded certificate chain.</li> -<li><strong>keyfile</strong> – File object containing the PEM-encoded private +<li><strong>keyfile</strong> – File object containing the PEM-encoded private key. Default value of None indicates that the -private key is to be found in ‘certchainfile’.</li> -<li><strong>callback</strong> – Callable object to be invoked if the private key +private key is to be found in ‘certchainfile’.</li> +<li><strong>callback</strong> – Callable object to be invoked if the private key is passphrase-protected. Default callback provides a simple terminal-style input for the passphrase.</li> @@ -894,14 +894,14 @@ passphrase.</li> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_client_CA"> -<tt class="descname">load_client_CA</tt><big>(</big><em>cafile</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_client_CA" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_client_CA</code><span class="sig-paren">(</span><em>cafile</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_client_CA" title="Permalink to this definition">¶</a></dt> <dd><p>Load CA certs into the context. These CA certs are sent to the peer during <em>SSLv3 certificate request</em>.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA certificates concatenated together.</td> </tr> </tbody> @@ -910,14 +910,14 @@ certificates concatenated together.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_client_ca"> -<tt class="descname">load_client_ca</tt><big>(</big><em>cafile</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_client_ca" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_client_ca</code><span class="sig-paren">(</span><em>cafile</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_client_ca" title="Permalink to this definition">¶</a></dt> <dd><p>Load CA certs into the context. These CA certs are sent to the peer during <em>SSLv3 certificate request</em>.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA certificates concatenated together.</td> </tr> </tbody> @@ -926,18 +926,18 @@ certificates concatenated together.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_verify_info"> -<tt class="descname">load_verify_info</tt><big>(</big><em>cafile=None</em>, <em>capath=None</em><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_verify_info" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_verify_info</code><span class="sig-paren">(</span><em>cafile=None</em>, <em>capath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_verify_info" title="Permalink to this definition">¶</a></dt> <dd><p>Load CA certs into the context.</p> -<p>These CA certs are used during verification of the peer’s +<p>These CA certs are used during verification of the peer’s certificate.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>cafile</strong> – File containing one or more PEM-encoded CA +<li><strong>cafile</strong> – File containing one or more PEM-encoded CA certificates concatenated together.</li> -<li><strong>capath</strong> – Directory containing PEM-encoded CA certificates +<li><strong>capath</strong> – Directory containing PEM-encoded CA certificates (one certificate per file).</li> </ul> </td> @@ -958,18 +958,18 @@ Check the error stack to find out the reason.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.load_verify_locations"> -<tt class="descname">load_verify_locations</tt><big>(</big><em>cafile=None</em>, <em>capath=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_verify_locations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_verify_locations" title="Permalink to this definition">¶</a></dt> +<code class="descname">load_verify_locations</code><span class="sig-paren">(</span><em>cafile=None</em>, <em>capath=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.load_verify_locations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.load_verify_locations" title="Permalink to this definition">¶</a></dt> <dd><p>Load CA certs into the context.</p> -<p>These CA certs are used during verification of the peer’s +<p>These CA certs are used during verification of the peer’s certificate.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> -<li><strong>cafile</strong> – File containing one or more PEM-encoded CA +<li><strong>cafile</strong> – File containing one or more PEM-encoded CA certificates concatenated together.</li> -<li><strong>capath</strong> – Directory containing PEM-encoded CA certificates +<li><strong>capath</strong> – Directory containing PEM-encoded CA certificates (one certificate per file).</li> </ul> </td> @@ -990,18 +990,18 @@ Check the error stack to find out the reason.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.m2_ssl_ctx_free"> -<tt class="descname">m2_ssl_ctx_free</tt><big>(</big><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Context.Context.m2_ssl_ctx_free" title="Permalink to this definition">¶</a></dt> +<code class="descname">m2_ssl_ctx_free</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Context.Context.m2_ssl_ctx_free" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.remove_session"> -<tt class="descname">remove_session</tt><big>(</big><em>session</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.remove_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.remove_session" title="Permalink to this definition">¶</a></dt> +<code class="descname">remove_session</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.remove_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.remove_session" title="Permalink to this definition">¶</a></dt> <dd><p>Remove the session from the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session</strong> – the session to be removed.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session</strong> – the session to be removed.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> <dt>0 The operation failed. The session was not found in</dt> @@ -1016,14 +1016,14 @@ Check the error stack to find out the reason.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_allow_unknown_ca"> -<tt class="descname">set_allow_unknown_ca</tt><big>(</big><em>ok</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_allow_unknown_ca</code><span class="sig-paren">(</span><em>ok</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> <dd><p>Set the context to accept/reject a peer certificate if the -certificate’s CA is unknown.</p> +certificate’s CA is unknown.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ok</strong> – True to accept, False to reject.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ok</strong> – True to accept, False to reject.</td> </tr> </tbody> </table> @@ -1031,13 +1031,13 @@ certificate’s CA is unknown.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_cipher_list"> -<tt class="descname">set_cipher_list</tt><big>(</big><em>cipher_list</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_cipher_list" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_cipher_list</code><span class="sig-paren">(</span><em>cipher_list</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_cipher_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_cipher_list" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the list of available ciphers.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cipher_list</strong> – The format of the string is described in +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cipher_list</strong> – The format of the string is described in ciphers(1).</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">1 if any cipher could be selected and 0 on complete @@ -1049,14 +1049,14 @@ failure.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_client_CA_list_from_file"> -<tt class="descname">set_client_CA_list_from_file</tt><big>(</big><em>cafile</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_client_CA_list_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_client_CA_list_from_file" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_client_CA_list_from_file</code><span class="sig-paren">(</span><em>cafile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_client_CA_list_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_client_CA_list_from_file" title="Permalink to this definition">¶</a></dt> <dd><p>Load CA certs into the context. These CA certs are sent to the peer during <em>SSLv3 certificate request</em>.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cafile</strong> – File object containing one or more PEM-encoded CA certificates concatenated together.</td> </tr> </tbody> @@ -1065,14 +1065,14 @@ certificates concatenated together.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_default_verify_paths"> -<tt class="descname">set_default_verify_paths</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_default_verify_paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_default_verify_paths" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_default_verify_paths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_default_verify_paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_default_verify_paths" title="Permalink to this definition">¶</a></dt> <dd><p>Specifies that the default locations from which CA certs are loaded should be used.</p> <p>There is one default directory and one default file. The default -CA certificates directory is called “certs” in the default +CA certificates directory is called “certs” in the default OpenSSL directory. Alternatively the SSL_CERT_DIR environment variable can be defined to override this location. The default -CA certificates file is called “cert.pem” in the default OpenSSL +CA certificates file is called “cert.pem” in the default OpenSSL directory. Alternatively the SSL_CERT_FILE environment variable can be defined to override this location.</p> <dl class="docutils"> @@ -1086,7 +1086,7 @@ can be defined to override this location.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_info_callback"> -<tt class="descname">set_info_callback</tt><big>(</big><em>callback=<function ssl_info_callback at 0x202cf50></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_info_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_info_callback" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_info_callback</code><span class="sig-paren">(</span><em>callback=<function ssl_info_callback></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_info_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_info_callback" title="Permalink to this definition">¶</a></dt> <dd><p>Set a callback function to get state information.</p> <p>It can be used to get state information about the SSL connections that are created from this context.</p> @@ -1094,7 +1094,7 @@ connections that are created from this context.</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – Callback function. The default prints +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – Callback function. The default prints information to stderr.</td> </tr> </tbody> @@ -1103,7 +1103,7 @@ information to stderr.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_options"> -<tt class="descname">set_options</tt><big>(</big><em>op</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_options" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_options</code><span class="sig-paren">(</span><em>op</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_options" title="Permalink to this definition">¶</a></dt> <dd><p>Adds the options set via bitmask in options to the Context.</p> <p>!!! Options already set before are not cleared!</p> <p>The behaviour of the SSL library can be changed by setting @@ -1122,7 +1122,7 @@ affect the settings.</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>op</strong> – bitmask of additional options specified in +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>op</strong> – bitmask of additional options specified in SSL_CTX_set_options(3) manpage.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the new options bitmask after adding options.</td> @@ -1133,14 +1133,14 @@ SSL_CTX_set_options(3) manpage.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_session_cache_mode"> -<tt class="descname">set_session_cache_mode</tt><big>(</big><em>mode</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_cache_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_cache_mode" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_session_cache_mode</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_cache_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_cache_mode" title="Permalink to this definition">¶</a></dt> <dd><p>Enables/disables session caching.</p> <p>The mode is set by using m2.SSL_SESS_CACHE_* constants.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – new mode value.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> – new mode value.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the previously set cache mode value.</td> </tr> @@ -1150,13 +1150,13 @@ SSL_CTX_set_options(3) manpage.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_session_id_ctx"> -<tt class="descname">set_session_id_ctx</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_id_ctx"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_id_ctx" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_session_id_ctx</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_id_ctx"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_id_ctx" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the session id for the SSL.Context w/in a session can be reused.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – Sessions are generated within a certain context. When +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – Sessions are generated within a certain context. When exporting/importing sessions with i2d_SSL_SESSION/d2i_SSL_SESSION it would be possible, to re-import a session generated from another context @@ -1175,7 +1175,7 @@ and/or service name.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_session_timeout"> -<tt class="descname">set_session_timeout</tt><big>(</big><em>timeout</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_session_timeout</code><span class="sig-paren">(</span><em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_session_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_session_timeout" title="Permalink to this definition">¶</a></dt> <dd><p>Set new session timeout.</p> <p>See self.get_session_timeout() for explanation of the session timeouts.</p> @@ -1183,7 +1183,7 @@ timeouts.</p> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> – new timeout value.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> – new timeout value.</td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the previously set timeout value.</td> </tr> @@ -1193,13 +1193,13 @@ timeouts.</p> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_tmp_dh"> -<tt class="descname">set_tmp_dh</tt><big>(</big><em>dhpfile</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_dh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_dh" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_tmp_dh</code><span class="sig-paren">(</span><em>dhpfile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_dh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_dh" title="Permalink to this definition">¶</a></dt> <dd><p>Load ephemeral DH parameters into the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dhpfile</strong> – Filename of the file containing the PEM-encoded +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dhpfile</strong> – Filename of the file containing the PEM-encoded DH parameters.</td> </tr> </tbody> @@ -1208,13 +1208,13 @@ DH parameters.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_tmp_dh_callback"> -<tt class="descname">set_tmp_dh_callback</tt><big>(</big><em>callback=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_dh_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_dh_callback" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_tmp_dh_callback</code><span class="sig-paren">(</span><em>callback=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_dh_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_dh_callback" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the callback function for SSL.Context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – Callable to be used when a DH parameters are required.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – Callable to be used when a DH parameters are required.</td> </tr> </tbody> </table> @@ -1222,13 +1222,13 @@ DH parameters.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_tmp_rsa"> -<tt class="descname">set_tmp_rsa</tt><big>(</big><em>rsa</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_rsa"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_rsa" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_tmp_rsa</code><span class="sig-paren">(</span><em>rsa</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_rsa"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_rsa" title="Permalink to this definition">¶</a></dt> <dd><p>Load ephemeral RSA key into the context.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rsa</strong> – RSA.RSA instance.</td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rsa</strong> – RSA.RSA instance.</td> </tr> </tbody> </table> @@ -1236,14 +1236,14 @@ DH parameters.</td> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_tmp_rsa_callback"> -<tt class="descname">set_tmp_rsa_callback</tt><big>(</big><em>callback=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_rsa_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_rsa_callback" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_tmp_rsa_callback</code><span class="sig-paren">(</span><em>callback=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_tmp_rsa_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_tmp_rsa_callback" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the callback function to be used when a temporary/ephemeral RSA key is required.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Context.Context.set_verify"> -<tt class="descname">set_verify</tt><big>(</big><em>mode</em>, <em>depth</em>, <em>callback=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_verify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_verify" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_verify</code><span class="sig-paren">(</span><em>mode</em>, <em>depth</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Context.html#Context.set_verify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Context.Context.set_verify" title="Permalink to this definition">¶</a></dt> <dd><p>Set verify options. Most applications will need to call this method with the right options to make a secure SSL connection.</p> <table class="docutils field-list" frame="void" rules="none"> @@ -1251,12 +1251,12 @@ method with the right options to make a secure SSL connection.</p> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> -<li><strong>mode</strong> – The verification mode to use. Typically at least +<li><strong>mode</strong> – The verification mode to use. Typically at least SSL.verify_peer is used. Clients would also typically add SSL.verify_fail_if_no_peer_cert.</li> -<li><strong>depth</strong> – The maximum allowed depth of the certificate chain +<li><strong>depth</strong> – The maximum allowed depth of the certificate chain returned by the peer.</li> -<li><strong>callback</strong> – Callable that can be used to specify custom +<li><strong>callback</strong> – Callable that can be used to specify custom verification checks.</li> </ul> </td> @@ -1269,98 +1269,98 @@ verification checks.</li> <dl class="function"> <dt id="M2Crypto.SSL.Context.map"> -<tt class="descclassname">M2Crypto.SSL.Context.</tt><tt class="descname">map</tt><big>(</big><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Context.map" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.Context.</code><code class="descname">map</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Context.map" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.SSLServer"> -<span id="sslserver-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">SSLServer</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.SSLServer" title="Permalink to this headline">¶</a></h2> +<span id="sslserver-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">SSLServer</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.SSLServer" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="M2Crypto.SSL.SSLServer.SSLServer"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.SSLServer.</tt><tt class="descname">SSLServer</tt><big>(</big><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">SocketServer.TCPServer</span></tt></p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.SSLServer.</code><code class="descname">SSLServer</code><span class="sig-paren">(</span><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">SocketServer.TCPServer</span></code></p> <dl class="method"> <dt id="M2Crypto.SSL.SSLServer.SSLServer.handle_error"> -<tt class="descname">handle_error</tt><big>(</big><em>request</em>, <em>client_address</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer.handle_error" title="Permalink to this definition">¶</a></dt> +<code class="descname">handle_error</code><span class="sig-paren">(</span><em>request</em>, <em>client_address</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer.handle_error" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.SSLServer.SSLServer.handle_request"> -<tt class="descname">handle_request</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer.handle_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer.handle_request" title="Permalink to this definition">¶</a></dt> +<code class="descname">handle_request</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#SSLServer.handle_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.SSLServer.handle_request" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="class"> <dt id="M2Crypto.SSL.SSLServer.ForkingSSLServer"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.SSLServer.</tt><tt class="descname">ForkingSSLServer</tt><big>(</big><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#ForkingSSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.ForkingSSLServer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">SocketServer.ForkingMixIn</span></tt>, <a class="reference internal" href="#M2Crypto.SSL.SSLServer.SSLServer" title="M2Crypto.SSL.SSLServer.SSLServer"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLServer.SSLServer</span></tt></a></p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.SSLServer.</code><code class="descname">ForkingSSLServer</code><span class="sig-paren">(</span><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#ForkingSSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.ForkingSSLServer" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">SocketServer.ForkingMixIn</span></code>, <a class="reference internal" href="#M2Crypto.SSL.SSLServer.SSLServer" title="M2Crypto.SSL.SSLServer.SSLServer"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLServer.SSLServer</span></code></a></p> </dd></dl> <dl class="class"> <dt id="M2Crypto.SSL.SSLServer.ThreadingSSLServer"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.SSLServer.</tt><tt class="descname">ThreadingSSLServer</tt><big>(</big><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#ThreadingSSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.ThreadingSSLServer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">SocketServer.ThreadingMixIn</span></tt>, <a class="reference internal" href="#M2Crypto.SSL.SSLServer.SSLServer" title="M2Crypto.SSL.SSLServer.SSLServer"><tt class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLServer.SSLServer</span></tt></a></p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.SSLServer.</code><code class="descname">ThreadingSSLServer</code><span class="sig-paren">(</span><em>server_address</em>, <em>RequestHandlerClass</em>, <em>ssl_context</em>, <em>bind_and_activate=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/SSLServer.html#ThreadingSSLServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.SSLServer.ThreadingSSLServer" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">SocketServer.ThreadingMixIn</span></code>, <a class="reference internal" href="#M2Crypto.SSL.SSLServer.SSLServer" title="M2Crypto.SSL.SSLServer.SSLServer"><code class="xref py py-class docutils literal"><span class="pre">M2Crypto.SSL.SSLServer.SSLServer</span></code></a></p> </dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.Session"> -<span id="session-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">Session</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.Session" title="Permalink to this headline">¶</a></h2> +<span id="session-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">Session</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.Session" title="Permalink to this headline">¶</a></h2> <p>SSL Session</p> <p>Copyright (c) 1999-2003 Ng Pheng Siong. All rights reserved.</p> <dl class="class"> <dt id="M2Crypto.SSL.Session.Session"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.Session.</tt><tt class="descname">Session</tt><big>(</big><em>session</em>, <em>_pyfree=0</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.Session.</code><code class="descname">Session</code><span class="sig-paren">(</span><em>session</em>, <em>_pyfree=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="M2Crypto.SSL.Session.Session.as_der"> -<tt class="descname">as_der</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.as_der"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.as_der" title="Permalink to this definition">¶</a></dt> +<code class="descname">as_der</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.as_der"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.as_der" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.as_text"> -<tt class="descname">as_text</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.as_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.as_text" title="Permalink to this definition">¶</a></dt> +<code class="descname">as_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.as_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.as_text" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.get_time"> -<tt class="descname">get_time</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.get_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.get_time" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.get_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.get_time" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.get_timeout"> -<tt class="descname">get_timeout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.get_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.get_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">get_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.get_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.get_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.m2_ssl_session_free"> -<tt class="descname">m2_ssl_session_free</tt><big>(</big><big>)</big><a class="headerlink" href="#M2Crypto.SSL.Session.Session.m2_ssl_session_free" title="Permalink to this definition">¶</a></dt> +<code class="descname">m2_ssl_session_free</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#M2Crypto.SSL.Session.Session.m2_ssl_session_free" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.set_time"> -<tt class="descname">set_time</tt><big>(</big><em>t</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.set_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.set_time" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_time</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.set_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.set_time" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.set_timeout"> -<tt class="descname">set_timeout</tt><big>(</big><em>t</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.set_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.set_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descname">set_timeout</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.set_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.set_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.Session.Session.write_bio"> -<tt class="descname">write_bio</tt><big>(</big><em>bio</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.write_bio"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.write_bio" title="Permalink to this definition">¶</a></dt> +<code class="descname">write_bio</code><span class="sig-paren">(</span><em>bio</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#Session.write_bio"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.Session.write_bio" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.Session.load_session"> -<tt class="descclassname">M2Crypto.SSL.Session.</tt><tt class="descname">load_session</tt><big>(</big><em>pemfile</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#load_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.load_session" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.Session.</code><code class="descname">load_session</code><span class="sig-paren">(</span><em>pemfile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/Session.html#load_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.Session.load_session" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.TwistedProtocolWrapper"> -<span id="twistedprotocolwrapper-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">TwistedProtocolWrapper</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.TwistedProtocolWrapper" title="Permalink to this headline">¶</a></h2> +<span id="twistedprotocolwrapper-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">TwistedProtocolWrapper</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.TwistedProtocolWrapper" title="Permalink to this headline">¶</a></h2> <p>Make Twisted use M2Crypto for SSL</p> <p>Copyright (c) 2004-2007 Open Source Applications Foundation. All rights reserved.</p> @@ -1369,14 +1369,14 @@ BEEN FINISHED. THE FURTHER WORK WILL BE DONE WHEN THE STATUS OF TWISTED IN THE PYTHON 3 (AND ASYNCIO) WORLD WILL BE CLEAR.</p> <dl class="function"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.connectSSL"> -<tt class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</tt><tt class="descname">connectSSL</tt><big>(</big><em>host</em>, <em>port</em>, <em>factory</em>, <em>contextFactory</em>, <em>timeout=30</em>, <em>bindAddress=None</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object at 0x4996190></em>, <em>postConnectionCheck=<M2Crypto.SSL.Checker.Checker instance at 0x3f0bc68></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#connectSSL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.connectSSL" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</code><code class="descname">connectSSL</code><span class="sig-paren">(</span><em>host</em>, <em>port</em>, <em>factory</em>, <em>contextFactory</em>, <em>timeout=30</em>, <em>bindAddress=None</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object></em>, <em>postConnectionCheck=<M2Crypto.SSL.Checker.Checker instance></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#connectSSL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.connectSSL" title="Permalink to this definition">¶</a></dt> <dd><p>A convenience function to start an SSL/TLS connection using Twisted.</p> <p>See IReactorSSL interface in Twisted.</p> </dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.connectTCP"> -<tt class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</tt><tt class="descname">connectTCP</tt><big>(</big><em>host</em>, <em>port</em>, <em>factory</em>, <em>timeout=30</em>, <em>bindAddress=None</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object at 0x4996190></em>, <em>postConnectionCheck=<M2Crypto.SSL.Checker.Checker instance at 0x3f0b3f8></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#connectTCP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.connectTCP" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</code><code class="descname">connectTCP</code><span class="sig-paren">(</span><em>host</em>, <em>port</em>, <em>factory</em>, <em>timeout=30</em>, <em>bindAddress=None</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object></em>, <em>postConnectionCheck=<M2Crypto.SSL.Checker.Checker instance></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#connectTCP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.connectTCP" title="Permalink to this definition">¶</a></dt> <dd><p>A convenience function to start a TCP connection using Twisted.</p> <p>NOTE: You must call startTLS(ctx) to go into SSL/TLS mode.</p> <p>See IReactorTCP interface in Twisted.</p> @@ -1384,14 +1384,14 @@ IN THE PYTHON 3 (AND ASYNCIO) WORLD WILL BE CLEAR.</p> <dl class="function"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.listenSSL"> -<tt class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</tt><tt class="descname">listenSSL</tt><big>(</big><em>port</em>, <em>factory</em>, <em>contextFactory</em>, <em>backlog=5</em>, <em>interface=''</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object at 0x4996190></em>, <em>postConnectionCheck=<function _alwaysSucceedsPostConnectionCheck at 0x49948c0></em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#listenSSL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.listenSSL" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</code><code class="descname">listenSSL</code><span class="sig-paren">(</span><em>port</em>, <em>factory</em>, <em>contextFactory</em>, <em>backlog=5</em>, <em>interface=''</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object></em>, <em>postConnectionCheck=<function _alwaysSucceedsPostConnectionCheck></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#listenSSL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.listenSSL" title="Permalink to this definition">¶</a></dt> <dd><p>A convenience function to listen for SSL/TLS connections using Twisted.</p> <p>See IReactorSSL interface in Twisted.</p> </dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.listenTCP"> -<tt class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</tt><tt class="descname">listenTCP</tt><big>(</big><em>port</em>, <em>factory</em>, <em>backlog=5</em>, <em>interface=''</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object at 0x4996190></em>, <em>postConnectionCheck=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#listenTCP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.listenTCP" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</code><code class="descname">listenTCP</code><span class="sig-paren">(</span><em>port</em>, <em>factory</em>, <em>backlog=5</em>, <em>interface=''</em>, <em>reactor=<twisted.internet.epollreactor.EPollReactor object></em>, <em>postConnectionCheck=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#listenTCP"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.listenTCP" title="Permalink to this definition">¶</a></dt> <dd><p>A convenience function to listen for TCP connections using Twisted.</p> <p>NOTE: You must call startTLS(ctx) to go into SSL/TLS mode.</p> <p>See IReactorTCP interface in Twisted.</p> @@ -1399,106 +1399,106 @@ IN THE PYTHON 3 (AND ASYNCIO) WORLD WILL BE CLEAR.</p> <dl class="class"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</tt><tt class="descname">TLSProtocolWrapper</tt><big>(</big><em>factory</em>, <em>wrappedProtocol</em>, <em>startPassThrough</em>, <em>client</em>, <em>contextFactory</em>, <em>postConnectionCheck</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">twisted.protocols.policies.ProtocolWrapper</span></tt></p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.TwistedProtocolWrapper.</code><code class="descname">TLSProtocolWrapper</code><span class="sig-paren">(</span><em>factory</em>, <em>wrappedProtocol</em>, <em>startPassThrough</em>, <em>client</em>, <em>contextFactory</em>, <em>postConnectionCheck</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">twisted.protocols.policies.ProtocolWrapper</span></code></p> <p>A SSL/TLS protocol wrapper to be used with Twisted. Typically you would not use this class directly. Use connectTCP, connectSSL, listenTCP, listenSSL functions defined above, which will hook in this class.</p> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.clear"> -<tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.clear" title="Permalink to this definition">¶</a></dt> +<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.clear" title="Permalink to this definition">¶</a></dt> <dd><p>Clear this instance, after which it is ready for reuse.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionLost"> -<tt class="descname">connectionLost</tt><big>(</big><em>reason</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.connectionLost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionLost" title="Permalink to this definition">¶</a></dt> +<code class="descname">connectionLost</code><span class="sig-paren">(</span><em>reason</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.connectionLost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionLost" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionMade"> -<tt class="descname">connectionMade</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.connectionMade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionMade" title="Permalink to this definition">¶</a></dt> +<code class="descname">connectionMade</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.connectionMade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.connectionMade" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.dataReceived"> -<tt class="descname">dataReceived</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.dataReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.dataReceived" title="Permalink to this definition">¶</a></dt> +<code class="descname">dataReceived</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.dataReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.dataReceived" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.loseConnection"> -<tt class="descname">loseConnection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.loseConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.loseConnection" title="Permalink to this definition">¶</a></dt> +<code class="descname">loseConnection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.loseConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.loseConnection" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.startTLS"> -<tt class="descname">startTLS</tt><big>(</big><em>ctx</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.startTLS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.startTLS" title="Permalink to this definition">¶</a></dt> +<code class="descname">startTLS</code><span class="sig-paren">(</span><em>ctx</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.startTLS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.startTLS" title="Permalink to this definition">¶</a></dt> <dd><p>Start SSL/TLS. If this is not called, this instance just passes data through untouched.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.write"> -<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.write" title="Permalink to this definition">¶</a></dt> +<code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.write" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.writeSequence"> -<tt class="descname">writeSequence</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.writeSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.writeSequence" title="Permalink to this definition">¶</a></dt> +<code class="descname">writeSequence</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/TwistedProtocolWrapper.html#TLSProtocolWrapper.writeSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.TwistedProtocolWrapper.TLSProtocolWrapper.writeSequence" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.cb"> -<span id="cb-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">cb</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.cb" title="Permalink to this headline">¶</a></h2> +<span id="cb-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">cb</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.cb" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="M2Crypto.SSL.cb.ssl_verify_callback_stub"> -<tt class="descclassname">M2Crypto.SSL.cb.</tt><tt class="descname">ssl_verify_callback_stub</tt><big>(</big><em>ssl_ctx_ptr</em>, <em>x509_ptr</em>, <em>errnum</em>, <em>errdepth</em>, <em>ok</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback_stub" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.cb.</code><code class="descname">ssl_verify_callback_stub</code><span class="sig-paren">(</span><em>ssl_ctx_ptr</em>, <em>x509_ptr</em>, <em>errnum</em>, <em>errdepth</em>, <em>ok</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback_stub" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.cb.ssl_verify_callback"> -<tt class="descclassname">M2Crypto.SSL.cb.</tt><tt class="descname">ssl_verify_callback</tt><big>(</big><em>ssl_ctx_ptr</em>, <em>x509_ptr</em>, <em>errnum</em>, <em>errdepth</em>, <em>ok</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.cb.</code><code class="descname">ssl_verify_callback</code><span class="sig-paren">(</span><em>ssl_ctx_ptr</em>, <em>x509_ptr</em>, <em>errnum</em>, <em>errdepth</em>, <em>ok</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.cb.ssl_verify_callback_allow_unknown_ca"> -<tt class="descclassname">M2Crypto.SSL.cb.</tt><tt class="descname">ssl_verify_callback_allow_unknown_ca</tt><big>(</big><em>ok</em>, <em>store</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.cb.</code><code class="descname">ssl_verify_callback_allow_unknown_ca</code><span class="sig-paren">(</span><em>ok</em>, <em>store</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_verify_callback_allow_unknown_ca"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_verify_callback_allow_unknown_ca" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.cb.ssl_info_callback"> -<tt class="descclassname">M2Crypto.SSL.cb.</tt><tt class="descname">ssl_info_callback</tt><big>(</big><em>where</em>, <em>ret</em>, <em>ssl_ptr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_info_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_info_callback" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.cb.</code><code class="descname">ssl_info_callback</code><span class="sig-paren">(</span><em>where</em>, <em>ret</em>, <em>ssl_ptr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/cb.html#ssl_info_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.cb.ssl_info_callback" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> <div class="section" id="module-M2Crypto.SSL.ssl_dispatcher"> -<span id="ssl-dispatcher-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ssl_dispatcher</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.ssl_dispatcher" title="Permalink to this headline">¶</a></h2> +<span id="ssl-dispatcher-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">ssl_dispatcher</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.ssl_dispatcher" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.ssl_dispatcher.</tt><tt class="descname">ssl_dispatcher</tt><big>(</big><em>sock=None</em>, <em>map=None</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">asyncore.dispatcher</span></tt></p> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.ssl_dispatcher.</code><code class="descname">ssl_dispatcher</code><span class="sig-paren">(</span><em>sock=None</em>, <em>map=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">asyncore.dispatcher</span></code></p> <dl class="method"> <dt id="M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.connect"> -<tt class="descname">connect</tt><big>(</big><em>addr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.connect" title="Permalink to this definition">¶</a></dt> +<code class="descname">connect</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.connect" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.create_socket"> -<tt class="descname">create_socket</tt><big>(</big><em>ssl_context</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.create_socket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.create_socket" title="Permalink to this definition">¶</a></dt> +<code class="descname">create_socket</code><span class="sig-paren">(</span><em>ssl_context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.create_socket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.create_socket" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.recv"> -<tt class="descname">recv</tt><big>(</big><em>buffer_size=4096</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.recv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.recv" title="Permalink to this definition">¶</a></dt> +<code class="descname">recv</code><span class="sig-paren">(</span><em>buffer_size=4096</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.recv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.recv" title="Permalink to this definition">¶</a></dt> <dd><p>Receive data over SSL.</p> </dd></dl> <dl class="method"> <dt id="M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.send"> -<tt class="descname">send</tt><big>(</big><em>buffer</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.send" title="Permalink to this definition">¶</a></dt> +<code class="descname">send</code><span class="sig-paren">(</span><em>buffer</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/ssl_dispatcher.html#ssl_dispatcher.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.ssl_dispatcher.ssl_dispatcher.send" title="Permalink to this definition">¶</a></dt> <dd><p>Send data over SSL.</p> </dd></dl> @@ -1506,28 +1506,28 @@ through untouched.</p> </div> <div class="section" id="module-M2Crypto.SSL.timeout"> -<span id="timeout-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">timeout</span></tt> Module<a class="headerlink" href="#module-M2Crypto.SSL.timeout" title="Permalink to this headline">¶</a></h2> +<span id="timeout-module"></span><h2><code class="xref py py-mod docutils literal"><span class="pre">timeout</span></code> Module<a class="headerlink" href="#module-M2Crypto.SSL.timeout" title="Permalink to this headline">¶</a></h2> <p>Support for SSL socket timeouts.</p> <p>Copyright (c) 1999-2003 Ng Pheng Siong. All rights reserved.</p> <p>Copyright 2008 Heikki Toivonen. All rights reserved.</p> <dl class="class"> <dt id="M2Crypto.SSL.timeout.timeout"> -<em class="property">class </em><tt class="descclassname">M2Crypto.SSL.timeout.</tt><tt class="descname">timeout</tt><big>(</big><em>sec=600</em>, <em>microsec=0</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.timeout" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descclassname">M2Crypto.SSL.timeout.</code><code class="descname">timeout</code><span class="sig-paren">(</span><em>sec=600</em>, <em>microsec=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.timeout" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="M2Crypto.SSL.timeout.timeout.pack"> -<tt class="descname">pack</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#timeout.pack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.timeout.pack" title="Permalink to this definition">¶</a></dt> +<code class="descname">pack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#timeout.pack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.timeout.pack" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.timeout.struct_to_timeout"> -<tt class="descclassname">M2Crypto.SSL.timeout.</tt><tt class="descname">struct_to_timeout</tt><big>(</big><em>binstr</em><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#struct_to_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.struct_to_timeout" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.timeout.</code><code class="descname">struct_to_timeout</code><span class="sig-paren">(</span><em>binstr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#struct_to_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.struct_to_timeout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="M2Crypto.SSL.timeout.struct_size"> -<tt class="descclassname">M2Crypto.SSL.timeout.</tt><tt class="descname">struct_size</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#struct_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.struct_size" title="Permalink to this definition">¶</a></dt> +<code class="descclassname">M2Crypto.SSL.timeout.</code><code class="descname">struct_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/M2Crypto/SSL/timeout.html#struct_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#M2Crypto.SSL.timeout.struct_size" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </div> @@ -1537,70 +1537,70 @@ through untouched.</p> </div> </div> </div> - <div class="sphinxsidebar"> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">SSL Package</a><ul> -<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">SSL</span></tt> Package</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.Checker"><tt class="docutils literal"><span class="pre">Checker</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.Cipher"><tt class="docutils literal"><span class="pre">Cipher</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.Connection"><tt class="docutils literal"><span class="pre">Connection</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.Context"><tt class="docutils literal"><span class="pre">Context</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.SSLServer"><tt class="docutils literal"><span class="pre">SSLServer</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.Session"><tt class="docutils literal"><span class="pre">Session</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.TwistedProtocolWrapper"><tt class="docutils literal"><span class="pre">TwistedProtocolWrapper</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.cb"><tt class="docutils literal"><span class="pre">cb</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.ssl_dispatcher"><tt class="docutils literal"><span class="pre">ssl_dispatcher</span></tt> Module</a></li> -<li><a class="reference internal" href="#module-M2Crypto.SSL.timeout"><tt class="docutils literal"><span class="pre">timeout</span></tt> Module</a></li> +<li><a class="reference internal" href="#id1"><code class="docutils literal"><span class="pre">SSL</span></code> Package</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.Checker"><code class="docutils literal"><span class="pre">Checker</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.Cipher"><code class="docutils literal"><span class="pre">Cipher</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.Connection"><code class="docutils literal"><span class="pre">Connection</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.Context"><code class="docutils literal"><span class="pre">Context</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.SSLServer"><code class="docutils literal"><span class="pre">SSLServer</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.Session"><code class="docutils literal"><span class="pre">Session</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.TwistedProtocolWrapper"><code class="docutils literal"><span class="pre">TwistedProtocolWrapper</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.cb"><code class="docutils literal"><span class="pre">cb</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.ssl_dispatcher"><code class="docutils literal"><span class="pre">ssl_dispatcher</span></code> Module</a></li> +<li><a class="reference internal" href="#module-M2Crypto.SSL.timeout"><code class="docutils literal"><span class="pre">timeout</span></code> Module</a></li> </ul> </li> </ul> - - <h4>Previous topic</h4> - <p class="topless"><a href="M2Crypto.PGP.html" - title="previous chapter">PGP Package</a></p> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="_sources/M2Crypto.SSL.txt" - rel="nofollow">Show Source</a></li> - </ul> -<div id="searchbox" style="display: none"> +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + <li><a href="M2Crypto.html">M2Crypto Package</a><ul> + <li>Previous: <a href="M2Crypto.html" title="previous chapter">M2Crypto Package</a></li> + </ul></li> + </ul></li> +</ul> +</div> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/M2Crypto.SSL.rst.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> - <input type="text" name="q" /> - <input type="submit" value="Go" /> + <div><input type="text" name="q" /></div> + <div><input type="submit" value="Go" /></div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> - <p class="searchtip" style="font-size: 90%"> - Enter search terms or a module, class or function name. - </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="M2Crypto.PGP.html" title="PGP Package" - >previous</a> |</li> - <li><a href="index.html">M2Crypto documentation</a> »</li> - <li><a href="M2Crypto.html" >M2Crypto Package</a> »</li> - </ul> - </div> <div class="footer"> - © Copyright 2017, Matej Cepl <mcepl@cepl.eu>. - Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. + ©2017, Matej Cepl <mcepl@cepl.eu>. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.4</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a> + + | + <a href="_sources/M2Crypto.SSL.rst.txt" + rel="nofollow">Page source</a> </div> + + + + </body> </html>
\ No newline at end of file |
