diff options
Diffstat (limited to 'doc/html/openssl-context.html')
| -rw-r--r-- | doc/html/openssl-context.html | 67 |
1 files changed, 39 insertions, 28 deletions
diff --git a/doc/html/openssl-context.html b/doc/html/openssl-context.html index c42e56f..9e37cae 100644 --- a/doc/html/openssl-context.html +++ b/doc/html/openssl-context.html @@ -52,7 +52,7 @@ Context objects have the following methods: <P> -<dl><dt><b><a name='l2h-152'><tt class='method'>check_privatekey</tt></a></b>() +<dl><dt><b><a name='l2h-160'><tt class='method'>check_privatekey</tt></a></b>() <dd> Check if the private key (loaded with <tt class="method">use_privatekey<big>[</big>_file<big>]</big></tt>) matches the certificate (loaded with <tt class="method">use_certificate<big>[</big>_file<big>]</big></tt>). @@ -60,13 +60,13 @@ Returns <code>None</code> if they match, raises <tt class="exception">Error</tt> </dl> <P> -<dl><dt><b><a name='l2h-153'><tt class='method'>get_app_data</tt></a></b>() +<dl><dt><b><a name='l2h-161'><tt class='method'>get_app_data</tt></a></b>() <dd> Retrieve application data as set by <tt class="method">set_app_data</tt>. </dl> <P> -<dl><dt><b><a name='l2h-154'><tt class='method'>get_cert_store</tt></a></b>() +<dl><dt><b><a name='l2h-162'><tt class='method'>get_cert_store</tt></a></b>() <dd> Retrieve the certificate store (a X509Store object) that the context uses. This can be used to add "trusted" certificates without using the. @@ -74,34 +74,34 @@ This can be used to add "trusted" certificates without using the. </dl> <P> -<dl><dt><b><a name='l2h-155'><tt class='method'>get_timeout</tt></a></b>() +<dl><dt><b><a name='l2h-163'><tt class='method'>get_timeout</tt></a></b>() <dd> Retrieve session timeout, as set by <tt class="method">set_timeout</tt>. The default is 300 seconds. </dl> <P> -<dl><dt><b><a name='l2h-156'><tt class='method'>get_verify_depth</tt></a></b>() +<dl><dt><b><a name='l2h-164'><tt class='method'>get_verify_depth</tt></a></b>() <dd> Retrieve the Context object's verify depth, as set by <tt class="method">set_verify_depth</tt>. </dl> <P> -<dl><dt><b><a name='l2h-157'><tt class='method'>get_verify_mode</tt></a></b>() +<dl><dt><b><a name='l2h-165'><tt class='method'>get_verify_mode</tt></a></b>() <dd> Retrieve the Context object's verify mode, as set by <tt class="method">set_verify</tt>. </dl> <P> -<dl><dt><b><a name='l2h-158'><tt class='method'>load_client_ca</tt></a></b>(<var>pemfile</var>) +<dl><dt><b><a name='l2h-166'><tt class='method'>load_client_ca</tt></a></b>(<var>pemfile</var>) <dd> Read a file with PEM-formatted certificates that will be sent to the client when requesting a client certificate. </dl> <P> -<dl><dt><b><a name='l2h-159'><tt class='method'>set_client_ca_list</tt></a></b>(<var>certificate_authorities</var>) +<dl><dt><b><a name='l2h-167'><tt class='method'>set_client_ca_list</tt></a></b>(<var>certificate_authorities</var>) <dd> Replace the current list of preferred certificate signers that would be sent to the client when requesting a client certificate with the @@ -114,7 +114,7 @@ sent to the client when requesting a client certificate with the </dl> <P> -<dl><dt><b><a name='l2h-160'><tt class='method'>add_client_ca</tt></a></b>(<var>certificate_authority</var>) +<dl><dt><b><a name='l2h-168'><tt class='method'>add_client_ca</tt></a></b>(<var>certificate_authority</var>) <dd> Extract a <tt class="class">OpenSSL.crypto.X509Name</tt> from the <var>certificate_authority</var> <tt class="class">OpenSSL.crypto.X509</tt> certificate and add it to the list of preferred @@ -127,7 +127,7 @@ certificate signers sent to the client when requesting a client certificate. </dl> <P> -<dl><dt><b><a name='l2h-161'><tt class='method'>load_verify_locations</tt></a></b>(<var>pemfile, capath</var>) +<dl><dt><b><a name='l2h-169'><tt class='method'>load_verify_locations</tt></a></b>(<var>pemfile, capath</var>) <dd> Specify where CA certificates for verification purposes are located. These are trusted certificates. Note that the certificates have to be in PEM @@ -137,34 +137,34 @@ format. If capath is passed, it must be a directory prepared using the </dl> <P> -<dl><dt><b><a name='l2h-162'><tt class='method'>set_default_verify_paths</tt></a></b>() +<dl><dt><b><a name='l2h-170'><tt class='method'>set_default_verify_paths</tt></a></b>() <dd> Specify that the platform provided CA certificates are to be used for verification purposes. This method may not work properly on OS X. </dl> <P> -<dl><dt><b><a name='l2h-163'><tt class='method'>load_tmp_dh</tt></a></b>(<var>dhfile</var>) +<dl><dt><b><a name='l2h-171'><tt class='method'>load_tmp_dh</tt></a></b>(<var>dhfile</var>) <dd> Load parameters for Ephemeral Diffie-Hellman from <var>dhfile</var>. </dl> <P> -<dl><dt><b><a name='l2h-164'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) +<dl><dt><b><a name='l2h-172'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) <dd> Associate <var>data</var> with this Context object. <var>data</var> can be retrieved later using the <tt class="method">get_app_data</tt> method. </dl> <P> -<dl><dt><b><a name='l2h-165'><tt class='method'>set_cipher_list</tt></a></b>(<var>ciphers</var>) +<dl><dt><b><a name='l2h-173'><tt class='method'>set_cipher_list</tt></a></b>(<var>ciphers</var>) <dd> Set the list of ciphers to be used in this context. See the OpenSSL manual for more information (e.g. ciphers(1)) </dl> <P> -<dl><dt><b><a name='l2h-166'><tt class='method'>set_info_callback</tt></a></b>(<var>callback</var>) +<dl><dt><b><a name='l2h-174'><tt class='method'>set_info_callback</tt></a></b>(<var>callback</var>) <dd> Set the information callback to <var>callback</var>. This function will be called from time to time during SSL handshakes. @@ -175,14 +175,14 @@ function call. </dl> <P> -<dl><dt><b><a name='l2h-167'><tt class='method'>set_options</tt></a></b>(<var>options</var>) +<dl><dt><b><a name='l2h-175'><tt class='method'>set_options</tt></a></b>(<var>options</var>) <dd> Add SSL options. Options you have set before are not cleared! This method should be used with the <tt class="constant">OP_*</tt> constants. </dl> <P> -<dl><dt><b><a name='l2h-168'><tt class='method'>set_passwd_cb</tt></a></b>(<var>callback</var><big>[</big><var>, userdata</var><big>]</big>) +<dl><dt><b><a name='l2h-176'><tt class='method'>set_passwd_cb</tt></a></b>(<var>callback</var><big>[</big><var>, userdata</var><big>]</big>) <dd> Set the passphrase callback to <var>callback</var>. This function will be called when a private key with a passphrase is loaded. <var>callback</var> must accept @@ -196,7 +196,7 @@ verify that the two values supplied are equal. Third, the value given as the </dl> <P> -<dl><dt><b><a name='l2h-169'><tt class='method'>set_session_id</tt></a></b>(<var>name</var>) +<dl><dt><b><a name='l2h-177'><tt class='method'>set_session_id</tt></a></b>(<var>name</var>) <dd> Set the context <var>name</var> within which a session can be reused for this Context object. This is needed when doing session resumption, because there is @@ -205,7 +205,7 @@ no way for a stored session to know which Context object it is associated with. </dl> <P> -<dl><dt><b><a name='l2h-170'><tt class='method'>set_timeout</tt></a></b>(<var>timeout</var>) +<dl><dt><b><a name='l2h-178'><tt class='method'>set_timeout</tt></a></b>(<var>timeout</var>) <dd> Set the timeout for newly created sessions for this Context object to <var>timeout</var>. <var>timeout</var> must be given in (whole) seconds. The default @@ -214,7 +214,7 @@ SSL_CTX_set_timeout(3)). </dl> <P> -<dl><dt><b><a name='l2h-171'><tt class='method'>set_verify</tt></a></b>(<var>mode, callback</var>) +<dl><dt><b><a name='l2h-179'><tt class='method'>set_verify</tt></a></b>(<var>mode, callback</var>) <dd> Set the verification flags for this Context object to <var>mode</var> and specify that <var>callback</var> should be used for verification callbacks. <var>mode</var> @@ -229,39 +229,39 @@ and false otherwise. </dl> <P> -<dl><dt><b><a name='l2h-172'><tt class='method'>set_verify_depth</tt></a></b>(<var>depth</var>) +<dl><dt><b><a name='l2h-180'><tt class='method'>set_verify_depth</tt></a></b>(<var>depth</var>) <dd> Set the maximum depth for the certificate chain verification that shall be allowed for this Context object. </dl> <P> -<dl><dt><b><a name='l2h-173'><tt class='method'>use_certificate</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-181'><tt class='method'>use_certificate</tt></a></b>(<var>cert</var>) <dd> Use the certificate <var>cert</var> which has to be a X509 object. </dl> <P> -<dl><dt><b><a name='l2h-174'><tt class='method'>add_extra_chain_cert</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-182'><tt class='method'>add_extra_chain_cert</tt></a></b>(<var>cert</var>) <dd> Adds the certificate <var>cert</var>, which has to be a X509 object, to the certificate chain presented together with the certificate. </dl> <P> -<dl><dt><b><a name='l2h-175'><tt class='method'>use_certificate_chain_file</tt></a></b>(<var>file</var>) +<dl><dt><b><a name='l2h-183'><tt class='method'>use_certificate_chain_file</tt></a></b>(<var>file</var>) <dd> Load a certificate chain from <var>file</var> which must be PEM encoded. </dl> <P> -<dl><dt><b><a name='l2h-176'><tt class='method'>use_privatekey</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-184'><tt class='method'>use_privatekey</tt></a></b>(<var>pkey</var>) <dd> Use the private key <var>pkey</var> which has to be a PKey object. </dl> <P> -<dl><dt><b><a name='l2h-177'><tt class='method'>use_certificate_file</tt></a></b>(<var>file</var><big>[</big><var>, format</var><big>]</big>) +<dl><dt><b><a name='l2h-185'><tt class='method'>use_certificate_file</tt></a></b>(<var>file</var><big>[</big><var>, format</var><big>]</big>) <dd> Load the first certificate found in <var>file</var>. The certificate must be in the format specified by <var>format</var>, which is either <tt class="constant">FILETYPE_PEM</tt> or @@ -269,7 +269,7 @@ format specified by <var>format</var>, which is either <tt class="constant">FILE </dl> <P> -<dl><dt><b><a name='l2h-178'><tt class='method'>use_privatekey_file</tt></a></b>(<var>file</var><big>[</big><var>, format</var><big>]</big>) +<dl><dt><b><a name='l2h-186'><tt class='method'>use_privatekey_file</tt></a></b>(<var>file</var><big>[</big><var>, format</var><big>]</big>) <dd> Load the first private key found in <var>file</var>. The private key must be in the format specified by <var>format</var>, which is either <tt class="constant">FILETYPE_PEM</tt> or @@ -277,6 +277,17 @@ format specified by <var>format</var>, which is either <tt class="constant">FILE </dl> <P> +<dl><dt><b><a name='l2h-187'><tt class='method'>set_tlsext_servername_callback</tt></a></b>(<var>callback</var>) +<dd> +Specify a one-argument callable to use as the TLS extension server name +callback. When a connection using the server name extension is made using this +context, the callback will be invoked with the <code>Connection</code> instance. + +<span class='versionnote'>New in version 0.13.</span> + +</dl> + +<P> <DIV CLASS="navigation"> <p><hr> @@ -306,7 +317,7 @@ format specified by <var>format</var>, which is either <tt class="constant">FILE <b class="navlabel">Up:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A> <b class="navlabel">Next:</b> <a class="sectref" href="openssl-connection.html">3.3.2 Connection objects</A> <hr> -<span class="release-info">Release 0.12.</span> +<span class="release-info">Release 0.13.</span> </DIV> <!--End of Navigation Panel--> |