diff options
| author | Jean-Paul Calderone <exarkun@divmod.com> | 2011-04-07 15:41:56 -0400 |
|---|---|---|
| committer | Jean-Paul Calderone <exarkun@divmod.com> | 2011-04-07 15:41:56 -0400 |
| commit | 78caacceb1018f28d1aaa622a33329109cab8ae3 (patch) | |
| tree | 47fb52508ca37e0815b61d418f2eca811ba9bb47 /doc/html | |
| parent | 64dc3bbcfe65356b2edbe74f82c44436fd996680 (diff) | |
| download | pyopenssl-78caacceb1018f28d1aaa622a33329109cab8ae3.tar.gz | |
Regenerate documentation
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/building.html | 4 | ||||
| -rw-r--r-- | doc/html/contents.html | 24 | ||||
| -rw-r--r-- | doc/html/crl.html | 22 | ||||
| -rw-r--r-- | doc/html/index.html | 42 | ||||
| -rw-r--r-- | doc/html/internals.html | 6 | ||||
| -rw-r--r-- | doc/html/intro.html | 4 | ||||
| -rw-r--r-- | doc/html/openssl-509ext.html | 20 | ||||
| -rw-r--r-- | doc/html/openssl-connection.html | 78 | ||||
| -rw-r--r-- | doc/html/openssl-context.html | 54 | ||||
| -rw-r--r-- | doc/html/openssl-crypto.html | 40 | ||||
| -rw-r--r-- | doc/html/openssl-netscape-spki.html | 26 | ||||
| -rw-r--r-- | doc/html/openssl-pkcs12.html | 34 | ||||
| -rw-r--r-- | doc/html/openssl-pkcs7.html | 26 | ||||
| -rw-r--r-- | doc/html/openssl-pkey.html | 22 | ||||
| -rw-r--r-- | doc/html/openssl-rand.html | 30 | ||||
| -rw-r--r-- | doc/html/openssl-ssl.html | 56 | ||||
| -rw-r--r-- | doc/html/openssl-x509.html | 87 | ||||
| -rw-r--r-- | doc/html/openssl-x509name.html | 36 | ||||
| -rw-r--r-- | doc/html/openssl-x509req.html | 30 | ||||
| -rw-r--r-- | doc/html/openssl-x509store.html | 18 | ||||
| -rw-r--r-- | doc/html/openssl.html | 36 | ||||
| -rw-r--r-- | doc/html/pyOpenSSL.how | 2 | ||||
| -rw-r--r-- | doc/html/pyOpenSSL.html | 42 | ||||
| -rw-r--r-- | doc/html/revoked.html | 26 |
24 files changed, 398 insertions, 367 deletions
diff --git a/doc/html/building.html b/doc/html/building.html index 534002b..fe4686a 100644 --- a/doc/html/building.html +++ b/doc/html/building.html @@ -62,9 +62,9 @@ I have tested this on Debian Linux systems (woody and sid), Solaris 2.6 and <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL CLASS="ChildLinks"> -<LI><A NAME="tex2html79" - href="building-unix.html">2.1 Building the Module on a Unix System </A> <LI><A NAME="tex2html80" + href="building-unix.html">2.1 Building the Module on a Unix System </A> +<LI><A NAME="tex2html81" href="building-windows.html">2.2 Building the Module on a Windows System </A> </UL> <!--End of Table of Child-Links--> diff --git a/doc/html/contents.html b/doc/html/contents.html index ee61942..965f9ab 100644 --- a/doc/html/contents.html +++ b/doc/html/contents.html @@ -46,36 +46,36 @@ Contents</A> <!--Table of Contents--> <UL CLASS="TofC"> -<LI><A NAME="tex2html45" - href="intro.html">1 Introduction </A> <LI><A NAME="tex2html46" + href="intro.html">1 Introduction </A> +<LI><A NAME="tex2html47" href="building.html">2 Building and Installing </A> <UL> -<LI><A NAME="tex2html47" - href="building-unix.html">2.1 Building the Module on a Unix System </A> <LI><A NAME="tex2html48" + href="building-unix.html">2.1 Building the Module on a Unix System </A> +<LI><A NAME="tex2html49" href="building-windows.html">2.2 Building the Module on a Windows System </A> </UL> <BR> -<LI><A NAME="tex2html49" +<LI><A NAME="tex2html50" href="openssl.html">3 OpenSSL -- Python interface to OpenSSL </A> <UL> -<LI><A NAME="tex2html50" - href="openssl-crypto.html">3.1 crypto -- Generic cryptographic module </A> <LI><A NAME="tex2html51" - href="openssl-rand.html">3.2 rand -- An interface to the OpenSSL pseudo random number generator </A> + href="openssl-crypto.html">3.1 crypto -- Generic cryptographic module </A> <LI><A NAME="tex2html52" + href="openssl-rand.html">3.2 rand -- An interface to the OpenSSL pseudo random number generator </A> +<LI><A NAME="tex2html53" href="openssl-ssl.html">3.3 SSL -- An interface to the SSL-specific parts of OpenSSL </A> </UL> <BR> -<LI><A NAME="tex2html53" +<LI><A NAME="tex2html54" href="internals.html">4 Internals </A> <UL> -<LI><A NAME="tex2html54" - href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html55" - href="callbacks.html">4.2 Callbacks </A> + href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html56" + href="callbacks.html">4.2 Callbacks </A> +<LI><A NAME="tex2html57" href="socket-methods.html">4.3 Acessing Socket Methods </A> </UL></UL> <!--End of Table of Contents--> diff --git a/doc/html/crl.html b/doc/html/crl.html index c75aaf8..0035672 100644 --- a/doc/html/crl.html +++ b/doc/html/crl.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.10 CRL objects </title> -<META NAME="description" CONTENT="3.1.10 CRL objects "> +<title>3.1.11 CRL objects </title> +<META NAME="description" CONTENT="3.1.11 CRL objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,36 +36,36 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="revoked.html">3.1.11 Revoked objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="revoked.html">3.1.12 Revoked objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION0004110000000000000000"> </A> +<H3><A NAME="SECTION0004111000000000000000"> </A> <BR> -3.1.10 CRL objects +3.1.11 CRL objects </H3> <P> CRL objects have the following methods: <P> -<dl><dt><b><a name='l2h-102'><tt class='method'>add_revoked</tt></a></b>(<var>revoked</var>) +<dl><dt><b><a name='l2h-106'><tt class='method'>add_revoked</tt></a></b>(<var>revoked</var>) <dd> Add a Revoked object to the CRL, by value not reference. </dl> <P> -<dl><dt><b><a name='l2h-103'><tt class='method'>export</tt></a></b>(<var>cert, key</var><big>[</big><var>, type=FILETYPE_PEM</var><big>]</big><big>[</big><var>, days=100</var><big>]</big>) +<dl><dt><b><a name='l2h-107'><tt class='method'>export</tt></a></b>(<var>cert, key</var><big>[</big><var>, type=FILETYPE_PEM</var><big>]</big><big>[</big><var>, days=100</var><big>]</big>) <dd> Use <var>cert</var> and <var>key</var> to sign the CRL and return the CRL as a string. <var>days</var> is the number of days before the next CRL is due. </dl> <P> -<dl><dt><b><a name='l2h-104'><tt class='method'>get_revoked</tt></a></b>() +<dl><dt><b><a name='l2h-108'><tt class='method'>get_revoked</tt></a></b>() <dd> Return a tuple of Revoked objects, by value not reference. </dl> @@ -96,9 +96,9 @@ Return a tuple of Revoked objects, by value not reference. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="revoked.html">3.1.11 Revoked objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="revoked.html">3.1.12 Revoked objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/index.html b/doc/html/index.html index 4eab092..1f9e3f2 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -87,52 +87,54 @@ calling a corresponding function in the OpenSSL library. href="openssl-crypto.html">3.1 <tt class="module">crypto</tt> -- Generic cryptographic module </A> <UL> <LI><A NAME="tex2html15" - href="openssl-x509.html">3.1.1 X509 objects </A> + href="openssl-x509ext.html">3.1.1 X509Extension objects </A> <LI><A NAME="tex2html16" - href="openssl-x509name.html">3.1.2 X509Name objects </A> + href="openssl-x509.html">3.1.2 X509 objects </A> <LI><A NAME="tex2html17" - href="openssl-x509req.html">3.1.3 X509Req objects </A> + href="openssl-x509name.html">3.1.3 X509Name objects </A> <LI><A NAME="tex2html18" - href="openssl-x509store.html">3.1.4 X509Store objects </A> + href="openssl-x509req.html">3.1.4 X509Req objects </A> <LI><A NAME="tex2html19" - href="openssl-pkey.html">3.1.5 PKey objects </A> + href="openssl-x509store.html">3.1.5 X509Store objects </A> <LI><A NAME="tex2html20" - href="openssl-pkcs7.html">3.1.6 PKCS7 objects </A> + href="openssl-pkey.html">3.1.6 PKey objects </A> <LI><A NAME="tex2html21" - href="openssl-pkcs12.html">3.1.7 PKCS12 objects </A> + href="openssl-pkcs7.html">3.1.7 PKCS7 objects </A> <LI><A NAME="tex2html22" - href="openssl-509ext.html">3.1.8 X509Extension objects </A> + href="openssl-pkcs12.html">3.1.8 PKCS12 objects </A> <LI><A NAME="tex2html23" - href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects </A> + href="openssl-509ext.html">3.1.9 X509Extension objects </A> <LI><A NAME="tex2html24" - href="crl.html">3.1.10 CRL objects </A> + href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects </A> <LI><A NAME="tex2html25" - href="revoked.html">3.1.11 Revoked objects </A> -</UL> + href="crl.html">3.1.11 CRL objects </A> <LI><A NAME="tex2html26" - href="openssl-rand.html">3.2 <tt class="module">rand</tt> -- An interface to the OpenSSL pseudo random number generator </A> + href="revoked.html">3.1.12 Revoked objects </A> +</UL> <LI><A NAME="tex2html27" + href="openssl-rand.html">3.2 <tt class="module">rand</tt> -- An interface to the OpenSSL pseudo random number generator </A> +<LI><A NAME="tex2html28" href="openssl-ssl.html">3.3 <tt class="module">SSL</tt> -- An interface to the SSL-specific parts of OpenSSL </A> <UL> -<LI><A NAME="tex2html28" - href="openssl-context.html">3.3.1 Context objects </A> <LI><A NAME="tex2html29" + href="openssl-context.html">3.3.1 Context objects </A> +<LI><A NAME="tex2html30" href="openssl-connection.html">3.3.2 Connection objects </A> </UL> </UL> <BR> -<LI><A NAME="tex2html30" +<LI><A NAME="tex2html31" href="internals.html">4 Internals </A> <UL> -<LI><A NAME="tex2html31" - href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html32" - href="callbacks.html">4.2 Callbacks </A> + href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html33" + href="callbacks.html">4.2 Callbacks </A> +<LI><A NAME="tex2html34" href="socket-methods.html">4.3 Acessing Socket Methods </A> </UL> <BR> -<LI><A NAME="tex2html34" +<LI><A NAME="tex2html35" href="about.html">About this document ...</A> </UL> <!--End of Table of Child-Links--> diff --git a/doc/html/internals.html b/doc/html/internals.html index b6f70c0..da7461a 100644 --- a/doc/html/internals.html +++ b/doc/html/internals.html @@ -59,11 +59,11 @@ accessing socket methods. This is what this chapter is about. <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL CLASS="ChildLinks"> -<LI><A NAME="tex2html322" +<LI><A NAME="tex2html336" href="exceptions.html">4.1 Exceptions </A> -<LI><A NAME="tex2html323" +<LI><A NAME="tex2html337" href="callbacks.html">4.2 Callbacks </A> -<LI><A NAME="tex2html324" +<LI><A NAME="tex2html338" href="socket-methods.html">4.3 Acessing Socket Methods </A> </UL> <!--End of Table of Child-Links--> diff --git a/doc/html/intro.html b/doc/html/intro.html index 442abb1..8997552 100644 --- a/doc/html/intro.html +++ b/doc/html/intro.html @@ -55,7 +55,7 @@ was begun) was severely limited. Other OpenSSL wrappers for Python at the time were also limited, though in different ways. Unfortunately, Python's standard library SSL support has remained weak, although other packages (such as M2Crypto<A NAME="tex2html1" - HREF="#foot1178"><SUP>1</SUP></A>) + HREF="#foot1200"><SUP>1</SUP></A>) have made great advances and now equal or exceed pyOpenSSL's functionality. <P> @@ -67,7 +67,7 @@ and advance. <P> <BR><HR><H4>Footnotes</H4> <DL> -<DT><A NAME="foot1178">... +<DT><A NAME="foot1200">... M2Crypto</A><A href="intro.html#tex2html1"><SUP>1</SUP></A></DT> <DD>See <a class="url" href="http://chandlerproject.org/Projects/MeTooCrypto">http://chandlerproject.org/Projects/MeTooCrypto</a> diff --git a/doc/html/openssl-509ext.html b/doc/html/openssl-509ext.html index f6a3237..84bc8fc 100644 --- a/doc/html/openssl-509ext.html +++ b/doc/html/openssl-509ext.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.8 X509Extension objects </title> -<META NAME="description" CONTENT="3.1.8 X509Extension objects "> +<title>3.1.9 X509Extension objects </title> +<META NAME="description" CONTENT="3.1.9 X509Extension objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,29 +36,29 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.7 PKCS12 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.8 PKCS12 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000418000000000000000"> </A> +<H3><A NAME="SECTION000419000000000000000"> </A> <BR> -3.1.8 X509Extension objects +3.1.9 X509Extension objects </H3> <P> X509Extension objects have several methods: <P> -<dl><dt><b><a name='l2h-95'><tt class='method'>get_critical</tt></a></b>() +<dl><dt><b><a name='l2h-99'><tt class='method'>get_critical</tt></a></b>() <dd> Return the critical field of the extension object. </dl> <P> -<dl><dt><b><a name='l2h-96'><tt class='method'>get_short_name</tt></a></b>() +<dl><dt><b><a name='l2h-100'><tt class='method'>get_short_name</tt></a></b>() <dd> Return the short type name of the extension object. </dl> @@ -89,9 +89,9 @@ Return the short type name of the extension object. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.7 PKCS12 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.8 PKCS12 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-connection.html b/doc/html/openssl-connection.html index 7ff7b6a..d3eaf71 100644 --- a/doc/html/openssl-connection.html +++ b/doc/html/openssl-connection.html @@ -51,7 +51,7 @@ Connection objects have the following methods: <P> -<dl><dt><b><a name='l2h-175'><tt class='method'>accept</tt></a></b>() +<dl><dt><b><a name='l2h-179'><tt class='method'>accept</tt></a></b>() <dd> Call the <tt class="method">accept</tt> method of the underlying socket and set up SSL on the returned socket, using the Context object supplied to this Connection object at @@ -61,20 +61,20 @@ socket's <tt class="method">accept</tt>. </dl> <P> -<dl><dt><b><a name='l2h-176'><tt class='method'>bind</tt></a></b>(<var>address</var>) +<dl><dt><b><a name='l2h-180'><tt class='method'>bind</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">bind</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-177'><tt class='method'>close</tt></a></b>() +<dl><dt><b><a name='l2h-181'><tt class='method'>close</tt></a></b>() <dd> Call the <tt class="method">close</tt> method of the underlying socket. Note: If you want correct SSL closure, you need to call the <tt class="method">shutdown</tt> method first. </dl> <P> -<dl><dt><b><a name='l2h-178'><tt class='method'>connect</tt></a></b>(<var>address</var>) +<dl><dt><b><a name='l2h-182'><tt class='method'>connect</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">connect</tt> method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at @@ -82,7 +82,7 @@ creation. </dl> <P> -<dl><dt><b><a name='l2h-179'><tt class='method'>connect_ex</tt></a></b>(<var>address</var>) +<dl><dt><b><a name='l2h-183'><tt class='method'>connect_ex</tt></a></b>(<var>address</var>) <dd> Call the <tt class="method">connect_ex</tt> method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at @@ -91,7 +91,7 @@ return 0, SSL won't be initialized. </dl> <P> -<dl><dt><b><a name='l2h-180'><tt class='method'>do_handshake</tt></a></b>() +<dl><dt><b><a name='l2h-184'><tt class='method'>do_handshake</tt></a></b>() <dd> Perform an SSL handshake (usually called after <tt class="method">renegotiate</tt> or one of <tt class="method">set_accept_state</tt> or <tt class="method">set_accept_state</tt>). This can raise the @@ -99,25 +99,25 @@ same exceptions as <tt class="method">send</tt> and <tt class="method">recv</tt> </dl> <P> -<dl><dt><b><a name='l2h-181'><tt class='method'>fileno</tt></a></b>() +<dl><dt><b><a name='l2h-185'><tt class='method'>fileno</tt></a></b>() <dd> Retrieve the file descriptor number for the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-182'><tt class='method'>listen</tt></a></b>(<var>backlog</var>) +<dl><dt><b><a name='l2h-186'><tt class='method'>listen</tt></a></b>(<var>backlog</var>) <dd> Call the <tt class="method">listen</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-183'><tt class='method'>get_app_data</tt></a></b>() +<dl><dt><b><a name='l2h-187'><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-184'><tt class='method'>get_cipher_list</tt></a></b>() +<dl><dt><b><a name='l2h-188'><tt class='method'>get_cipher_list</tt></a></b>() <dd> Retrieve the list of ciphers used by the Connection object. WARNING: This API has changed. It used to take an optional parameter and just return a string, @@ -125,7 +125,7 @@ but not it returns the entire list in one go. </dl> <P> -<dl><dt><b><a name='l2h-185'><tt class='method'>get_client_ca_list</tt></a></b>() +<dl><dt><b><a name='l2h-189'><tt class='method'>get_client_ca_list</tt></a></b>() <dd> Retrieve the list of preferred client certificate issuers sent by the server as <tt class="class">OpenSSL.crypto.X509Name</tt> objects. @@ -146,44 +146,44 @@ by this <tt class="class">Connection</tt>'s <tt class="class">Context</tt>. </dl> <P> -<dl><dt><b><a name='l2h-186'><tt class='method'>get_context</tt></a></b>() +<dl><dt><b><a name='l2h-190'><tt class='method'>get_context</tt></a></b>() <dd> Retrieve the Context object associated with this Connection. </dl> <P> -<dl><dt><b><a name='l2h-187'><tt class='method'>get_peer_certificate</tt></a></b>() +<dl><dt><b><a name='l2h-191'><tt class='method'>get_peer_certificate</tt></a></b>() <dd> Retrieve the other side's certificate (if any) </dl> <P> -<dl><dt><b><a name='l2h-188'><tt class='method'>getpeername</tt></a></b>() +<dl><dt><b><a name='l2h-192'><tt class='method'>getpeername</tt></a></b>() <dd> Call the <tt class="method">getpeername</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-189'><tt class='method'>getsockname</tt></a></b>() +<dl><dt><b><a name='l2h-193'><tt class='method'>getsockname</tt></a></b>() <dd> Call the <tt class="method">getsockname</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-190'><tt class='method'>getsockopt</tt></a></b>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>) +<dl><dt><b><a name='l2h-194'><tt class='method'>getsockopt</tt></a></b>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>) <dd> Call the <tt class="method">getsockopt</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-191'><tt class='method'>pending</tt></a></b>() +<dl><dt><b><a name='l2h-195'><tt class='method'>pending</tt></a></b>() <dd> Retrieve the number of bytes that can be safely read from the SSL buffer (<i>not</i> the underlying transport buffer). </dl> <P> -<dl><dt><b><a name='l2h-192'><tt class='method'>recv</tt></a></b>(<var>bufsize</var>) +<dl><dt><b><a name='l2h-196'><tt class='method'>recv</tt></a></b>(<var>bufsize</var>) <dd> Receive data from the Connection. The return value is a string representing the data received. The maximum amount of data to be received at once, is specified @@ -191,7 +191,7 @@ by <var>bufsize</var>. </dl> <P> -<dl><dt><b><a name='l2h-193'><tt class='method'>bio_write</tt></a></b>(<var>bytes</var>) +<dl><dt><b><a name='l2h-197'><tt class='method'>bio_write</tt></a></b>(<var>bytes</var>) <dd> If the Connection was created with a memory BIO, this method can be used to add bytes to the read end of that memory BIO. The Connection can then read the @@ -199,20 +199,20 @@ bytes (for example, in response to a call to <tt class="method">recv</tt>). </dl> <P> -<dl><dt><b><a name='l2h-194'><tt class='method'>renegotiate</tt></a></b>() +<dl><dt><b><a name='l2h-198'><tt class='method'>renegotiate</tt></a></b>() <dd> Renegotiate the SSL session. Call this if you wish to change cipher suites or anything like that. </dl> <P> -<dl><dt><b><a name='l2h-195'><tt class='method'>send</tt></a></b>(<var>string</var>) +<dl><dt><b><a name='l2h-199'><tt class='method'>send</tt></a></b>(<var>string</var>) <dd> Send the <var>string</var> data to the Connection. </dl> <P> -<dl><dt><b><a name='l2h-196'><tt class='method'>bio_read</tt></a></b>(<var>bufsize</var>) +<dl><dt><b><a name='l2h-200'><tt class='method'>bio_read</tt></a></b>(<var>bufsize</var>) <dd> If the Connection was created with a memory BIO, this method can be used to read bytes from the write end of that memory BIO. Many Connection methods will @@ -221,7 +221,7 @@ up and the Connection will be able to take no further actions. </dl> <P> -<dl><dt><b><a name='l2h-197'><tt class='method'>sendall</tt></a></b>(<var>string</var>) +<dl><dt><b><a name='l2h-201'><tt class='method'>sendall</tt></a></b>(<var>string</var>) <dd> Send all of the <var>string</var> data to the Connection. This calls <tt class="method">send</tt> repeatedly until all data is sent. If an error occurs, it's impossible to tell @@ -229,40 +229,40 @@ how much data has been sent. </dl> <P> -<dl><dt><b><a name='l2h-198'><tt class='method'>set_accept_state</tt></a></b>() +<dl><dt><b><a name='l2h-202'><tt class='method'>set_accept_state</tt></a></b>() <dd> Set the connection to work in server mode. The handshake will be handled automatically by read/write. </dl> <P> -<dl><dt><b><a name='l2h-199'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) +<dl><dt><b><a name='l2h-203'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) <dd> Associate <var>data</var> with this Connection 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-200'><tt class='method'>set_connect_state</tt></a></b>() +<dl><dt><b><a name='l2h-204'><tt class='method'>set_connect_state</tt></a></b>() <dd> Set the connection to work in client mode. The handshake will be handled automatically by read/write. </dl> <P> -<dl><dt><b><a name='l2h-201'><tt class='method'>setblocking</tt></a></b>(<var>flag</var>) +<dl><dt><b><a name='l2h-205'><tt class='method'>setblocking</tt></a></b>(<var>flag</var>) <dd> Call the <tt class="method">setblocking</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-202'><tt class='method'>setsockopt</tt></a></b>(<var>level, optname, value</var>) +<dl><dt><b><a name='l2h-206'><tt class='method'>setsockopt</tt></a></b>(<var>level, optname, value</var>) <dd> Call the <tt class="method">setsockopt</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-203'><tt class='method'>shutdown</tt></a></b>() +<dl><dt><b><a name='l2h-207'><tt class='method'>shutdown</tt></a></b>() <dd> Send the shutdown message to the Connection. Returns true if the shutdown message exchange is completed and false otherwise (in which case you call @@ -271,27 +271,27 @@ readable/writeable. </dl> <P> -<dl><dt><b><a name='l2h-204'><tt class='method'>get_shutdown</tt></a></b>() +<dl><dt><b><a name='l2h-208'><tt class='method'>get_shutdown</tt></a></b>() <dd> Get the shutdown state of the Connection. Returns a bitvector of either or both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>. </dl> <P> -<dl><dt><b><a name='l2h-205'><tt class='method'>set_shutdown</tt></a></b>(<var>state</var>) +<dl><dt><b><a name='l2h-209'><tt class='method'>set_shutdown</tt></a></b>(<var>state</var>) <dd> Set the shutdown state of the Connection. <var>state</var> is a bitvector of either or both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>. </dl> <P> -<dl><dt><b><a name='l2h-206'><tt class='method'>sock_shutdown</tt></a></b>(<var>how</var>) +<dl><dt><b><a name='l2h-210'><tt class='method'>sock_shutdown</tt></a></b>(<var>how</var>) <dd> Call the <tt class="method">shutdown</tt> method of the underlying socket. </dl> <P> -<dl><dt><b><a name='l2h-207'><tt class='method'>bio_shutdown</tt></a></b>() +<dl><dt><b><a name='l2h-211'><tt class='method'>bio_shutdown</tt></a></b>() <dd> If the Connection was created with a memory BIO, this method can be used to indicate that ``end of file'' has been reached on the read end of that memory @@ -299,38 +299,38 @@ BIO. </dl> <P> -<dl><dt><b><a name='l2h-208'><tt class='method'>state_string</tt></a></b>() +<dl><dt><b><a name='l2h-212'><tt class='method'>state_string</tt></a></b>() <dd> Retrieve a verbose string detailing the state of the Connection. </dl> <P> -<dl><dt><b><a name='l2h-209'><tt class='method'>client_random</tt></a></b>() +<dl><dt><b><a name='l2h-213'><tt class='method'>client_random</tt></a></b>() <dd> Retrieve the random value used with the client hello message. </dl> <P> -<dl><dt><b><a name='l2h-210'><tt class='method'>server_random</tt></a></b>() +<dl><dt><b><a name='l2h-214'><tt class='method'>server_random</tt></a></b>() <dd> Retrieve the random value used with the server hello message. </dl> <P> -<dl><dt><b><a name='l2h-211'><tt class='method'>master_key</tt></a></b>() +<dl><dt><b><a name='l2h-215'><tt class='method'>master_key</tt></a></b>() <dd> Retrieve the value of the master key for this session. </dl> <P> -<dl><dt><b><a name='l2h-212'><tt class='method'>want_read</tt></a></b>() +<dl><dt><b><a name='l2h-216'><tt class='method'>want_read</tt></a></b>() <dd> Checks if more data has to be read from the transport layer to complete an operation. </dl> <P> -<dl><dt><b><a name='l2h-213'><tt class='method'>want_write</tt></a></b>() +<dl><dt><b><a name='l2h-217'><tt class='method'>want_write</tt></a></b>() <dd> Checks if there is data to write to the transport layer to complete an operation. diff --git a/doc/html/openssl-context.html b/doc/html/openssl-context.html index 7c9ab4c..2e61749 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-148'><tt class='method'>check_privatekey</tt></a></b>() +<dl><dt><b><a name='l2h-152'><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-149'><tt class='method'>get_app_data</tt></a></b>() +<dl><dt><b><a name='l2h-153'><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-150'><tt class='method'>get_cert_store</tt></a></b>() +<dl><dt><b><a name='l2h-154'><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-151'><tt class='method'>get_timeout</tt></a></b>() +<dl><dt><b><a name='l2h-155'><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-152'><tt class='method'>get_verify_depth</tt></a></b>() +<dl><dt><b><a name='l2h-156'><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-153'><tt class='method'>get_verify_mode</tt></a></b>() +<dl><dt><b><a name='l2h-157'><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-154'><tt class='method'>load_client_ca</tt></a></b>(<var>pemfile</var>) +<dl><dt><b><a name='l2h-158'><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-155'><tt class='method'>set_client_ca_list</tt></a></b>(<var>certificate_authorities</var>) +<dl><dt><b><a name='l2h-159'><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-156'><tt class='method'>add_client_ca</tt></a></b>(<var>certificate_authority</var>) +<dl><dt><b><a name='l2h-160'><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-157'><tt class='method'>load_verify_locations</tt></a></b>(<var>pemfile, capath</var>) +<dl><dt><b><a name='l2h-161'><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-158'><tt class='method'>set_default_verify_paths</tt></a></b>() +<dl><dt><b><a name='l2h-162'><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-159'><tt class='method'>load_tmp_dh</tt></a></b>(<var>dhfile</var>) +<dl><dt><b><a name='l2h-163'><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-160'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>) +<dl><dt><b><a name='l2h-164'><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-161'><tt class='method'>set_cipher_list</tt></a></b>(<var>ciphers</var>) +<dl><dt><b><a name='l2h-165'><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-162'><tt class='method'>set_info_callback</tt></a></b>(<var>callback</var>) +<dl><dt><b><a name='l2h-166'><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-163'><tt class='method'>set_options</tt></a></b>(<var>options</var>) +<dl><dt><b><a name='l2h-167'><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-164'><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-168'><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-165'><tt class='method'>set_session_id</tt></a></b>(<var>name</var>) +<dl><dt><b><a name='l2h-169'><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-166'><tt class='method'>set_timeout</tt></a></b>(<var>timeout</var>) +<dl><dt><b><a name='l2h-170'><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-167'><tt class='method'>set_verify</tt></a></b>(<var>mode, callback</var>) +<dl><dt><b><a name='l2h-171'><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-168'><tt class='method'>set_verify_depth</tt></a></b>(<var>depth</var>) +<dl><dt><b><a name='l2h-172'><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-169'><tt class='method'>use_certificate</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-173'><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-170'><tt class='method'>add_extra_chain_cert</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-174'><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-171'><tt class='method'>use_certificate_chain_file</tt></a></b>(<var>file</var>) +<dl><dt><b><a name='l2h-175'><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-172'><tt class='method'>use_privatekey</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-176'><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-173'><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-177'><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-174'><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-178'><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 diff --git a/doc/html/openssl-crypto.html b/doc/html/openssl-crypto.html index 18f8cf4..29bce72 100644 --- a/doc/html/openssl-crypto.html +++ b/doc/html/openssl-crypto.html @@ -10,7 +10,7 @@ <LINK REL="next" href="openssl-rand.html"> <LINK REL="previous" href="openssl.html"> <LINK REL="up" href="openssl.html"> -<LINK REL="next" href="openssl-x509.html"> +<LINK REL="next" href="openssl-x509ext.html"> </head> <body> <DIV CLASS="navigation"> @@ -22,7 +22,7 @@ <td><A href="openssl.html"><img src="up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> -<td><A href="openssl-x509.html"><img src="next.gif" +<td><A href="openssl-x509ext.html"><img src="next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python OpenSSL Manual</td> @@ -38,7 +38,7 @@ </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509.html">3.1.1 X509 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> @@ -240,7 +240,7 @@ pass phrase. <dl><dt><b><a name='l2h-32'><tt class='function'>load_crl</tt></a></b>(<var>type, buffer</var>) <dd> Load Certificate Revocation List (CRL) data from a string <var>buffer</var>. -<var>buffer</var> encoded with the type <var>type</var>. The type <var>type</var> +<var>buffer</var> encoded with the type <var>type</var>. The type <var>type</var> must either <tt class="constant">FILETYPE_PEM</tt> or <tt class="constant">FILETYPE_ASN1</tt>). </dl> @@ -298,28 +298,30 @@ message digest type of the signature, for example <code>``sha1''</code>. <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL CLASS="ChildLinks"> -<LI><A NAME="tex2html139" - href="openssl-x509.html">3.1.1 X509 objects </A> -<LI><A NAME="tex2html140" - href="openssl-x509name.html">3.1.2 X509Name objects </A> <LI><A NAME="tex2html141" - href="openssl-x509req.html">3.1.3 X509Req objects </A> + href="openssl-x509ext.html">3.1.1 X509Extension objects </A> <LI><A NAME="tex2html142" - href="openssl-x509store.html">3.1.4 X509Store objects </A> + href="openssl-x509.html">3.1.2 X509 objects </A> <LI><A NAME="tex2html143" - href="openssl-pkey.html">3.1.5 PKey objects </A> + href="openssl-x509name.html">3.1.3 X509Name objects </A> <LI><A NAME="tex2html144" - href="openssl-pkcs7.html">3.1.6 PKCS7 objects </A> + href="openssl-x509req.html">3.1.4 X509Req objects </A> <LI><A NAME="tex2html145" - href="openssl-pkcs12.html">3.1.7 PKCS12 objects </A> + href="openssl-x509store.html">3.1.5 X509Store objects </A> <LI><A NAME="tex2html146" - href="openssl-509ext.html">3.1.8 X509Extension objects </A> + href="openssl-pkey.html">3.1.6 PKey objects </A> <LI><A NAME="tex2html147" - href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects </A> + href="openssl-pkcs7.html">3.1.7 PKCS7 objects </A> <LI><A NAME="tex2html148" - href="crl.html">3.1.10 CRL objects </A> + href="openssl-pkcs12.html">3.1.8 PKCS12 objects </A> <LI><A NAME="tex2html149" - href="revoked.html">3.1.11 Revoked objects </A> + href="openssl-509ext.html">3.1.9 X509Extension objects </A> +<LI><A NAME="tex2html150" + href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects </A> +<LI><A NAME="tex2html151" + href="crl.html">3.1.11 CRL objects </A> +<LI><A NAME="tex2html152" + href="revoked.html">3.1.12 Revoked objects </A> </UL> <!--End of Table of Child-Links--> @@ -333,7 +335,7 @@ message digest type of the signature, for example <code>``sha1''</code>. <td><A href="openssl.html"><img src="up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> -<td><A href="openssl-x509.html"><img src="next.gif" +<td><A href="openssl-x509ext.html"><img src="next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python OpenSSL Manual</td> @@ -349,7 +351,7 @@ message digest type of the signature, for example <code>``sha1''</code>. </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509.html">3.1.1 X509 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-netscape-spki.html b/doc/html/openssl-netscape-spki.html index 50e125e..b12cb40 100644 --- a/doc/html/openssl-netscape-spki.html +++ b/doc/html/openssl-netscape-spki.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.9 NetscapeSPKI objects </title> -<META NAME="description" CONTENT="3.1.9 NetscapeSPKI objects "> +<title>3.1.10 NetscapeSPKI objects </title> +<META NAME="description" CONTENT="3.1.10 NetscapeSPKI objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,41 +36,41 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-509ext.html">3.1.8 X509Extension objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-509ext.html">3.1.9 X509Extension objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="crl.html">3.1.10 CRL objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="crl.html">3.1.11 CRL objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000419000000000000000"> </A> +<H3><A NAME="SECTION0004110000000000000000"> </A> <BR> -3.1.9 NetscapeSPKI objects +3.1.10 NetscapeSPKI objects </H3> <P> NetscapeSPKI objects have the following methods: <P> -<dl><dt><b><a name='l2h-97'><tt class='method'>b64_encode</tt></a></b>() +<dl><dt><b><a name='l2h-101'><tt class='method'>b64_encode</tt></a></b>() <dd> Return a base64-encoded string representation of the object. </dl> <P> -<dl><dt><b><a name='l2h-98'><tt class='method'>get_pubkey</tt></a></b>() +<dl><dt><b><a name='l2h-102'><tt class='method'>get_pubkey</tt></a></b>() <dd> Return the public key of object. </dl> <P> -<dl><dt><b><a name='l2h-99'><tt class='method'>set_pubkey</tt></a></b>(<var>key</var>) +<dl><dt><b><a name='l2h-103'><tt class='method'>set_pubkey</tt></a></b>(<var>key</var>) <dd> Set the public key of the object to <var>key</var>. </dl> <P> -<dl><dt><b><a name='l2h-100'><tt class='method'>sign</tt></a></b>(<var>key, digest_name</var>) +<dl><dt><b><a name='l2h-104'><tt class='method'>sign</tt></a></b>(<var>key, digest_name</var>) <dd> Sign the NetscapeSPKI object using the given <var>key</var> and <var>digest_name</var>. <var>digest_name</var> must be a string describing a digest @@ -79,7 +79,7 @@ example, <tt class="constant">"md5"</tt> or <tt class="constant">"sha1"</tt>. </dl> <P> -<dl><dt><b><a name='l2h-101'><tt class='method'>verify</tt></a></b>(<var>key</var>) +<dl><dt><b><a name='l2h-105'><tt class='method'>verify</tt></a></b>(<var>key</var>) <dd> Verify the NetscapeSPKI object using the given <var>key</var>. </dl> @@ -110,9 +110,9 @@ Verify the NetscapeSPKI object using the given <var>key</var>. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-509ext.html">3.1.8 X509Extension objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-509ext.html">3.1.9 X509Extension objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="crl.html">3.1.10 CRL objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="crl.html">3.1.11 CRL objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-pkcs12.html b/doc/html/openssl-pkcs12.html index 30dd509..0eaa845 100644 --- a/doc/html/openssl-pkcs12.html +++ b/doc/html/openssl-pkcs12.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.7 PKCS12 objects </title> -<META NAME="description" CONTENT="3.1.7 PKCS12 objects "> +<title>3.1.8 PKCS12 objects </title> +<META NAME="description" CONTENT="3.1.8 PKCS12 objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,23 +36,23 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.6 PKCS7 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.7 PKCS7 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-509ext.html">3.1.8 X509Extension objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-509ext.html">3.1.9 X509Extension objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000417000000000000000"> </A> +<H3><A NAME="SECTION000418000000000000000"> </A> <BR> -3.1.7 PKCS12 objects +3.1.8 PKCS12 objects </H3> <P> PKCS12 objects have the following methods: <P> -<dl><dt><b><a name='l2h-86'><tt class='method'>export</tt></a></b>(<big>[</big><var>passphrase=None</var><big>]</big><big>[</big><var>, iter=2048</var><big>]</big><big>[</big><var>, maciter=1</var><big>]</big>) +<dl><dt><b><a name='l2h-90'><tt class='method'>export</tt></a></b>(<big>[</big><var>passphrase=None</var><big>]</big><big>[</big><var>, iter=2048</var><big>]</big><big>[</big><var>, maciter=1</var><big>]</big>) <dd> Returns a PKCS12 object as a string. @@ -64,32 +64,32 @@ See also the man page for the C function <tt class="function">PKCS12_create</tt> </dl> <P> -<dl><dt><b><a name='l2h-87'><tt class='method'>get_ca_certificates</tt></a></b>() +<dl><dt><b><a name='l2h-91'><tt class='method'>get_ca_certificates</tt></a></b>() <dd> Return CA certificates within the PKCS12 object as a tuple. Returns <tt class="constant">None</tt> if no CA certificates are present. </dl> <P> -<dl><dt><b><a name='l2h-88'><tt class='method'>get_certificate</tt></a></b>() +<dl><dt><b><a name='l2h-92'><tt class='method'>get_certificate</tt></a></b>() <dd> Return certificate portion of the PKCS12 structure. </dl> <P> -<dl><dt><b><a name='l2h-89'><tt class='method'>get_friendlyname</tt></a></b>() +<dl><dt><b><a name='l2h-93'><tt class='method'>get_friendlyname</tt></a></b>() <dd> Return friendlyName portion of the PKCS12 structure. </dl> <P> -<dl><dt><b><a name='l2h-90'><tt class='method'>get_privatekey</tt></a></b>() +<dl><dt><b><a name='l2h-94'><tt class='method'>get_privatekey</tt></a></b>() <dd> Return private key portion of the PKCS12 structure </dl> <P> -<dl><dt><b><a name='l2h-91'><tt class='method'>set_ca_certificates</tt></a></b>(<var>cacerts</var>) +<dl><dt><b><a name='l2h-95'><tt class='method'>set_ca_certificates</tt></a></b>(<var>cacerts</var>) <dd> Replace or set the CA certificates within the PKCS12 object with the sequence <var>cacerts</var>. @@ -98,19 +98,19 @@ Set <var>cacerts</var> to <tt class="constant">None</tt> to remove all CA certif </dl> <P> -<dl><dt><b><a name='l2h-92'><tt class='method'>set_certificate</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-96'><tt class='method'>set_certificate</tt></a></b>(<var>cert</var>) <dd> Replace or set the certificate portion of the PKCS12 structure. </dl> <P> -<dl><dt><b><a name='l2h-93'><tt class='method'>set_friendlyname</tt></a></b>(<var>name</var>) +<dl><dt><b><a name='l2h-97'><tt class='method'>set_friendlyname</tt></a></b>(<var>name</var>) <dd> Replace or set the friendlyName portion of the PKCS12 structure. </dl> <P> -<dl><dt><b><a name='l2h-94'><tt class='method'>set_privatekey</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-98'><tt class='method'>set_privatekey</tt></a></b>(<var>pkey</var>) <dd> Replace or set private key portion of the PKCS12 structure </dl> @@ -141,9 +141,9 @@ Replace or set private key portion of the PKCS12 structure border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.6 PKCS7 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.7 PKCS7 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-509ext.html">3.1.8 X509Extension objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-509ext.html">3.1.9 X509Extension objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-pkcs7.html b/doc/html/openssl-pkcs7.html index 2fd08e4..3c8ca89 100644 --- a/doc/html/openssl-pkcs7.html +++ b/doc/html/openssl-pkcs7.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.6 PKCS7 objects </title> -<META NAME="description" CONTENT="3.1.6 PKCS7 objects "> +<title>3.1.7 PKCS7 objects </title> +<META NAME="description" CONTENT="3.1.7 PKCS7 objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,47 +36,47 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkey.html">3.1.5 PKey objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkey.html">3.1.6 PKey objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.7 PKCS12 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.8 PKCS12 objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000416000000000000000"> </A> +<H3><A NAME="SECTION000417000000000000000"> </A> <BR> -3.1.6 PKCS7 objects +3.1.7 PKCS7 objects </H3> <P> PKCS7 objects have the following methods: <P> -<dl><dt><b><a name='l2h-81'><tt class='method'>type_is_signed</tt></a></b>() +<dl><dt><b><a name='l2h-85'><tt class='method'>type_is_signed</tt></a></b>() <dd> FIXME </dl> <P> -<dl><dt><b><a name='l2h-82'><tt class='method'>type_is_enveloped</tt></a></b>() +<dl><dt><b><a name='l2h-86'><tt class='method'>type_is_enveloped</tt></a></b>() <dd> FIXME </dl> <P> -<dl><dt><b><a name='l2h-83'><tt class='method'>type_is_signedAndEnveloped</tt></a></b>() +<dl><dt><b><a name='l2h-87'><tt class='method'>type_is_signedAndEnveloped</tt></a></b>() <dd> FIXME </dl> <P> -<dl><dt><b><a name='l2h-84'><tt class='method'>type_is_data</tt></a></b>() +<dl><dt><b><a name='l2h-88'><tt class='method'>type_is_data</tt></a></b>() <dd> FIXME </dl> <P> -<dl><dt><b><a name='l2h-85'><tt class='method'>get_type_name</tt></a></b>() +<dl><dt><b><a name='l2h-89'><tt class='method'>get_type_name</tt></a></b>() <dd> Get the type name of the PKCS7. </dl> @@ -107,9 +107,9 @@ Get the type name of the PKCS7. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkey.html">3.1.5 PKey objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-pkey.html">3.1.6 PKey objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.7 PKCS12 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs12.html">3.1.8 PKCS12 objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-pkey.html b/doc/html/openssl-pkey.html index 5693f0e..c4b356b 100644 --- a/doc/html/openssl-pkey.html +++ b/doc/html/openssl-pkey.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.5 PKey objects </title> -<META NAME="description" CONTENT="3.1.5 PKey objects "> +<title>3.1.6 PKey objects </title> +<META NAME="description" CONTENT="3.1.6 PKey objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,36 +36,36 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509store.html">3.1.4 X509Store objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509store.html">3.1.5 X509Store objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.6 PKCS7 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.7 PKCS7 objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000415000000000000000"> </A> +<H3><A NAME="SECTION000416000000000000000"> </A> <BR> -3.1.5 PKey objects +3.1.6 PKey objects </H3> <P> The PKey object has the following methods: <P> -<dl><dt><b><a name='l2h-78'><tt class='method'>bits</tt></a></b>() +<dl><dt><b><a name='l2h-82'><tt class='method'>bits</tt></a></b>() <dd> Return the number of bits of the key. </dl> <P> -<dl><dt><b><a name='l2h-79'><tt class='method'>generate_key</tt></a></b>(<var>type, bits</var>) +<dl><dt><b><a name='l2h-83'><tt class='method'>generate_key</tt></a></b>(<var>type, bits</var>) <dd> Generate a public/private key pair of the type <var>type</var> (one of <tt class="constant">TYPE_RSA</tt> and <tt class="constant">TYPE_DSA</tt>) with the size <var>bits</var>. </dl> <P> -<dl><dt><b><a name='l2h-80'><tt class='method'>type</tt></a></b>() +<dl><dt><b><a name='l2h-84'><tt class='method'>type</tt></a></b>() <dd> Return the type of the key. </dl> @@ -96,9 +96,9 @@ Return the type of the key. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509store.html">3.1.4 X509Store objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509store.html">3.1.5 X509Store objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.6 PKCS7 objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkcs7.html">3.1.7 PKCS7 objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-rand.html b/doc/html/openssl-rand.html index 229e445..e4b7dc8 100644 --- a/doc/html/openssl-rand.html +++ b/doc/html/openssl-rand.html @@ -36,7 +36,7 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="revoked.html">3.1.11 Revoked objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="revoked.html">3.1.12 Revoked objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> <b class="navlabel">Next:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A> <br><hr> @@ -56,16 +56,16 @@ This module handles the OpenSSL pseudo random number generator (PRNG) and declares the following: <P> -<dl><dt><b><a name='l2h-113'><tt class='function'>add</tt></a></b>(<var>string, entropy</var>) +<dl><dt><b><a name='l2h-117'><tt class='function'>add</tt></a></b>(<var>string, entropy</var>) <dd> Mix bytes from <var>string</var> into the PRNG state. The <var>entropy</var> argument is (the lower bound of) an estimate of how much randomness is contained in -<var>string</var>, measured in bytes. For more information, see e.g. <a class="rfc" name="rfcref-2269" +<var>string</var>, measured in bytes. For more information, see e.g. <a class="rfc" name="rfcref-2324" href="http://www.ietf.org/rfc/rfc1750.txt">RFC 1750</a>. </dl> <P> -<dl><dt><b><a name='l2h-114'><tt class='function'>bytes</tt></a></b>(<var>num_bytes</var>) +<dl><dt><b><a name='l2h-118'><tt class='function'>bytes</tt></a></b>(<var>num_bytes</var>) <dd> Get some random bytes from the PRNG as a string. @@ -74,7 +74,7 @@ This is a wrapper for the C function <tt class="function">RAND_bytes</tt>. </dl> <P> -<dl><dt><b><a name='l2h-115'><tt class='function'>cleanup</tt></a></b>() +<dl><dt><b><a name='l2h-119'><tt class='function'>cleanup</tt></a></b>() <dd> Erase the memory used by the PRNG. @@ -83,50 +83,50 @@ This is a wrapper for the C function <tt class="function">RAND_cleanup</tt>. </dl> <P> -<dl><dt><b><a name='l2h-116'><tt class='function'>egd</tt></a></b>(<var>path</var><big>[</big><var>, bytes</var><big>]</big>) +<dl><dt><b><a name='l2h-120'><tt class='function'>egd</tt></a></b>(<var>path</var><big>[</big><var>, bytes</var><big>]</big>) <dd> Query the Entropy Gathering Daemon<A NAME="tex2html2" - HREF="#foot1204"><SUP>2</SUP></A> on socket <var>path</var> for <var>bytes</var> + HREF="#foot1227"><SUP>2</SUP></A> on socket <var>path</var> for <var>bytes</var> bytes of random data and and uses <tt class="function">add</tt> to seed the PRNG. The default value of <var>bytes</var> is 255. </dl> <P> -<dl><dt><b><a name='l2h-117'><tt class='function'>load_file</tt></a></b>(<var>path</var><big>[</big><var>, bytes</var><big>]</big>) +<dl><dt><b><a name='l2h-121'><tt class='function'>load_file</tt></a></b>(<var>path</var><big>[</big><var>, bytes</var><big>]</big>) <dd> Read <var>bytes</var> bytes (or all of it, if <var>bytes</var> is negative) of data from the file <var>path</var> to seed the PRNG. The default value of <var>bytes</var> is -1. </dl> <P> -<dl><dt><b><a name='l2h-118'><tt class='function'>screen</tt></a></b>() +<dl><dt><b><a name='l2h-122'><tt class='function'>screen</tt></a></b>() <dd> Add the current contents of the screen to the PRNG state. Availability: Windows. </dl> <P> -<dl><dt><b><a name='l2h-119'><tt class='function'>seed</tt></a></b>(<var>string</var>) +<dl><dt><b><a name='l2h-123'><tt class='function'>seed</tt></a></b>(<var>string</var>) <dd> This is equivalent to calling <tt class="function">add</tt> with <var>entropy</var> as the length of the string. </dl> <P> -<dl><dt><b><a name='l2h-120'><tt class='function'>status</tt></a></b>() +<dl><dt><b><a name='l2h-124'><tt class='function'>status</tt></a></b>() <dd> Returns true if the PRNG has been seeded with enough data, and false otherwise. </dl> <P> -<dl><dt><b><a name='l2h-121'><tt class='function'>write_file</tt></a></b>(<var>path</var>) +<dl><dt><b><a name='l2h-125'><tt class='function'>write_file</tt></a></b>(<var>path</var>) <dd> Write a number of random bytes (currently 1024) to the file <var>path</var>. This file can then be used with <tt class="function">load_file</tt> to seed the PRNG again. </dl> <P> -<dl><dt><b>exception <a name='l2h-122'><tt class='exception'>Error</tt></a></b> +<dl><dt><b>exception <a name='l2h-126'><tt class='exception'>Error</tt></a></b> <dd> If the current RAND method supports any errors, this is raised when needed. The default method does not raise this when the entropy pool is depleted. @@ -142,7 +142,7 @@ for more information. <P> <BR><HR><H4>Footnotes</H4> <DL> -<DT><A NAME="foot1204">... Daemon</A><A +<DT><A NAME="foot1227">... Daemon</A><A href="openssl-rand.html#tex2html2"><SUP>2</SUP></A></DT> <DD>See <a class="url" href="http://www.lothar.com/tech/crypto/">http://www.lothar.com/tech/crypto/</a> @@ -173,7 +173,7 @@ for more information. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="revoked.html">3.1.11 Revoked objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="revoked.html">3.1.12 Revoked objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl.html">3 OpenSSL </A> <b class="navlabel">Next:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A> <hr> diff --git a/doc/html/openssl-ssl.html b/doc/html/openssl-ssl.html index 4afcef2..58d8f58 100644 --- a/doc/html/openssl-ssl.html +++ b/doc/html/openssl-ssl.html @@ -55,39 +55,39 @@ This module handles things specific to SSL. There are two objects defined: Context, Connection. <P> -<dl><dt><b><a name='l2h-124'><tt>SSLv2_METHOD</tt></a></b> +<dl><dt><b><a name='l2h-128'><tt>SSLv2_METHOD</tt></a></b> <dd> -<dt><b><a name='l2h-138'><tt>SSLv3_METHOD</tt></a></b><dd> -<dt><b><a name='l2h-139'><tt>SSLv23_METHOD</tt></a></b><dd> -<dt><b><a name='l2h-140'><tt>TLSv1_METHOD</tt></a></b><dd> +<dt><b><a name='l2h-142'><tt>SSLv3_METHOD</tt></a></b><dd> +<dt><b><a name='l2h-143'><tt>SSLv23_METHOD</tt></a></b><dd> +<dt><b><a name='l2h-144'><tt>TLSv1_METHOD</tt></a></b><dd> These constants represent the different SSL methods to use when creating a context object. </dl> <P> -<dl><dt><b><a name='l2h-125'><tt>VERIFY_NONE</tt></a></b> +<dl><dt><b><a name='l2h-129'><tt>VERIFY_NONE</tt></a></b> <dd> -<dt><b><a name='l2h-141'><tt>VERIFY_PEER</tt></a></b><dd> -<dt><b><a name='l2h-142'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd> +<dt><b><a name='l2h-145'><tt>VERIFY_PEER</tt></a></b><dd> +<dt><b><a name='l2h-146'><tt>VERIFY_FAIL_IF_NO_PEER_CERT</tt></a></b><dd> These constants represent the verification mode used by the Context object's <tt class="method">set_verify</tt> method. </dl> <P> -<dl><dt><b><a name='l2h-126'><tt>FILETYPE_PEM</tt></a></b> +<dl><dt><b><a name='l2h-130'><tt>FILETYPE_PEM</tt></a></b> <dd> -<dt><b><a name='l2h-143'><tt>FILETYPE_ASN1</tt></a></b><dd> +<dt><b><a name='l2h-147'><tt>FILETYPE_ASN1</tt></a></b><dd> File type constants used with the <tt class="method">use_certificate_file</tt> and <tt class="method">use_privatekey_file</tt> methods of Context objects. </dl> <P> -<dl><dt><b><a name='l2h-127'><tt>OP_SINGLE_DH_USE</tt></a></b> +<dl><dt><b><a name='l2h-131'><tt>OP_SINGLE_DH_USE</tt></a></b> <dd> -<dt><b><a name='l2h-144'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd> -<dt><b><a name='l2h-145'><tt>OP_NO_SSLv2</tt></a></b><dd> -<dt><b><a name='l2h-146'><tt>OP_NO_SSLv3</tt></a></b><dd> -<dt><b><a name='l2h-147'><tt>OP_NO_TLSv1</tt></a></b><dd> +<dt><b><a name='l2h-148'><tt>OP_EPHEMERAL_RSA</tt></a></b><dd> +<dt><b><a name='l2h-149'><tt>OP_NO_SSLv2</tt></a></b><dd> +<dt><b><a name='l2h-150'><tt>OP_NO_SSLv3</tt></a></b><dd> +<dt><b><a name='l2h-151'><tt>OP_NO_TLSv1</tt></a></b><dd> Constants used with <tt class="method">set_options</tt> of Context objects. <tt class="constant">OP_SINGLE_DH_USE</tt> means to always create a new key when using ephemeral Diffie-Hellman. <tt class="constant">OP_EPHEMERAL_RSA</tt> means to always use ephemeral RSA keys @@ -98,13 +98,13 @@ handshake, but don't want to use SSLv2. </dl> <P> -<dl><dt><b><a name='l2h-128'><tt>ContextType</tt></a></b> +<dl><dt><b><a name='l2h-132'><tt>ContextType</tt></a></b> <dd> See <tt class="class">Context</tt>. </dl> <P> -<dl><dt><b>class <a name='l2h-129'><tt class='class'>Context</tt></a></b>(<var>method</var>) +<dl><dt><b>class <a name='l2h-133'><tt class='class'>Context</tt></a></b>(<var>method</var>) <dd> A class representing SSL contexts. Contexts define the parameters of one or more SSL connections. @@ -115,27 +115,27 @@ more SSL connections. </dl> <P> -<dl><dt><b><a name='l2h-130'><tt>ConnectionType</tt></a></b> +<dl><dt><b><a name='l2h-134'><tt>ConnectionType</tt></a></b> <dd> See <tt class="class">Connection</tt>. </dl> <P> -<dl><dt><b>class <a name='l2h-131'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>) +<dl><dt><b>class <a name='l2h-135'><tt class='class'>Connection</tt></a></b>(<var>context, socket</var>) <dd> A class representing SSL connections. <P> <var>context</var> should be an instance of <tt class="class">Context</tt> and <var>socket</var> should be a socket <A NAME="tex2html4" - HREF="#foot1208"><SUP>3</SUP></A> object. <var>socket</var> may be + HREF="#foot1231"><SUP>3</SUP></A> object. <var>socket</var> may be <var>None</var>; in this case, the Connection is created with a memory BIO: see the <tt class="method">bio_read</tt>, <tt class="method">bio_write</tt>, and <tt class="method">bio_shutdown</tt> methods. </dl> <P> -<dl><dt><b>exception <a name='l2h-132'><tt class='exception'>Error</tt></a></b> +<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>Error</tt></a></b> <dd> This exception is used as a base class for the other SSL-related exceptions, but may also be raised directly. @@ -149,7 +149,7 @@ for more information. </dl> <P> -<dl><dt><b>exception <a name='l2h-133'><tt class='exception'>ZeroReturnError</tt></a></b> +<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>ZeroReturnError</tt></a></b> <dd> This exception matches the error return code <code>SSL_ERROR_ZERO_RETURN</code>, and is raised when the SSL Connection has been closed. In SSL 3.0 and TLS 1.0, this @@ -163,7 +163,7 @@ It may seem a little strange that this is an exception, but it does match an </dl> <P> -<dl><dt><b>exception <a name='l2h-134'><tt class='exception'>WantReadError</tt></a></b> +<dl><dt><b>exception <a name='l2h-138'><tt class='exception'>WantReadError</tt></a></b> <dd> The operation did not complete; the same I/O method should be called again later, with the same arguments. Any I/O method can lead to this since new @@ -180,14 +180,14 @@ probably want to <tt class="method">select()</tt> on the socket before trying ag </dl> <P> -<dl><dt><b>exception <a name='l2h-135'><tt class='exception'>WantWriteError</tt></a></b> +<dl><dt><b>exception <a name='l2h-139'><tt class='exception'>WantWriteError</tt></a></b> <dd> See <tt class="exception">WantReadError</tt>. The socket send buffer may be too full to write more data. </dl> <P> -<dl><dt><b>exception <a name='l2h-136'><tt class='exception'>WantX509LookupError</tt></a></b> +<dl><dt><b>exception <a name='l2h-140'><tt class='exception'>WantX509LookupError</tt></a></b> <dd> The operation did not complete because an application callback has asked to be called again. The I/O method should be called again later, with the same @@ -196,7 +196,7 @@ callbacks in this version. </dl> <P> -<dl><dt><b>exception <a name='l2h-137'><tt class='exception'>SysCallError</tt></a></b> +<dl><dt><b>exception <a name='l2h-141'><tt class='exception'>SysCallError</tt></a></b> <dd> The <tt class="exception">SysCallError</tt> occurs when there's an I/O error and OpenSSL's error queue does not contain any information. This can mean two things: An @@ -208,7 +208,7 @@ The parameter to the exception is always a pair <code>(<var>errnum</var>, <P> <BR><HR><H4>Footnotes</H4> <DL> -<DT><A NAME="foot1208">... socket</A><A +<DT><A NAME="foot1231">... socket</A><A href="openssl-ssl.html#tex2html4"><SUP>3</SUP></A></DT> <DD>Actually, all that is required is an object that <i>behaves</i> like a socket, you could even use files, even though @@ -221,9 +221,9 @@ it'd be tricky to get the handshakes right! <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL CLASS="ChildLinks"> -<LI><A NAME="tex2html289" +<LI><A NAME="tex2html303" href="openssl-context.html">3.3.1 Context objects </A> -<LI><A NAME="tex2html290" +<LI><A NAME="tex2html304" href="openssl-connection.html">3.3.2 Connection objects </A> </UL> <!--End of Table of Child-Links--> diff --git a/doc/html/openssl-x509.html b/doc/html/openssl-x509.html index c138766..757c957 100644 --- a/doc/html/openssl-x509.html +++ b/doc/html/openssl-x509.html @@ -1,14 +1,14 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.1 X509 objects </title> -<META NAME="description" CONTENT="3.1.1 X509 objects "> +<title>3.1.2 X509 objects </title> +<META NAME="description" CONTENT="3.1.2 X509 objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <link rel="STYLESHEET" href="pyOpenSSL.css"> <LINK REL="next" href="openssl-x509name.html"> -<LINK REL="previous" href="openssl-crypto.html"> +<LINK REL="previous" href="openssl-x509ext.html"> <LINK REL="up" href="openssl-crypto.html"> <LINK REL="next" href="openssl-x509name.html"> </head> @@ -16,7 +16,7 @@ <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> -<td><A href="openssl-crypto.html"><img src="previous.gif" +<td><A href="openssl-x509ext.html"><img src="previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="openssl-crypto.html"><img src="up.gif" @@ -36,53 +36,53 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000411000000000000000"> </A> +<H3><A NAME="SECTION000412000000000000000"> </A> <BR> -3.1.1 X509 objects +3.1.2 X509 objects </H3> <P> X509 objects have the following methods: <P> -<dl><dt><b><a name='l2h-39'><tt class='method'>get_issuer</tt></a></b>() +<dl><dt><b><a name='l2h-41'><tt class='method'>get_issuer</tt></a></b>() <dd> Return an X509Name object representing the issuer of the certificate. </dl> <P> -<dl><dt><b><a name='l2h-40'><tt class='method'>get_pubkey</tt></a></b>() +<dl><dt><b><a name='l2h-42'><tt class='method'>get_pubkey</tt></a></b>() <dd> Return a PKey object representing the public key of the certificate. </dl> <P> -<dl><dt><b><a name='l2h-41'><tt class='method'>get_serial_number</tt></a></b>() +<dl><dt><b><a name='l2h-43'><tt class='method'>get_serial_number</tt></a></b>() <dd> Return the certificate serial number. </dl> <P> -<dl><dt><b><a name='l2h-42'><tt class='method'>get_subject</tt></a></b>() +<dl><dt><b><a name='l2h-44'><tt class='method'>get_subject</tt></a></b>() <dd> Return an X509Name object representing the subject of the certificate. </dl> <P> -<dl><dt><b><a name='l2h-43'><tt class='method'>get_version</tt></a></b>() +<dl><dt><b><a name='l2h-45'><tt class='method'>get_version</tt></a></b>() <dd> Return the certificate version. </dl> <P> -<dl><dt><b><a name='l2h-44'><tt class='method'>get_notBefore</tt></a></b>() +<dl><dt><b><a name='l2h-46'><tt class='method'>get_notBefore</tt></a></b>() <dd> Return a string giving the time before which the certificate is not valid. The string is formatted as an ASN1 GENERALIZEDTIME: @@ -95,7 +95,7 @@ If no value exists for this field, <code>None</code> is returned. </dl> <P> -<dl><dt><b><a name='l2h-45'><tt class='method'>get_notAfter</tt></a></b>() +<dl><dt><b><a name='l2h-47'><tt class='method'>get_notAfter</tt></a></b>() <dd> Return a string giving the time after which the certificate is not valid. The string is formatted as an ASN1 GENERALIZEDTIME: @@ -108,7 +108,7 @@ If no value exists for this field, <code>None</code> is returned. </dl> <P> -<dl><dt><b><a name='l2h-46'><tt class='method'>set_notBefore</tt></a></b>(<var>when</var>) +<dl><dt><b><a name='l2h-48'><tt class='method'>set_notBefore</tt></a></b>(<var>when</var>) <dd> Change the time before which the certificate is not valid. <var>when</var> is a string formatted as an ASN1 GENERALIZEDTIME: @@ -120,7 +120,7 @@ string formatted as an ASN1 GENERALIZEDTIME: </dl> <P> -<dl><dt><b><a name='l2h-47'><tt class='method'>set_notAfter</tt></a></b>(<var>when</var>) +<dl><dt><b><a name='l2h-49'><tt class='method'>set_notAfter</tt></a></b>(<var>when</var>) <dd> Change the time after which the certificate is not valid. <var>when</var> is a string formatted as an ASN1 GENERALIZEDTIME: @@ -132,69 +132,69 @@ string formatted as an ASN1 GENERALIZEDTIME: </dl> <P> -<dl><dt><b><a name='l2h-48'><tt class='method'>gmtime_adj_notBefore</tt></a></b>(<var>time</var>) +<dl><dt><b><a name='l2h-50'><tt class='method'>gmtime_adj_notBefore</tt></a></b>(<var>time</var>) <dd> Adjust the timestamp (in GMT) when the certificate starts being valid. </dl> <P> -<dl><dt><b><a name='l2h-49'><tt class='method'>gmtime_adj_notAfter</tt></a></b>(<var>time</var>) +<dl><dt><b><a name='l2h-51'><tt class='method'>gmtime_adj_notAfter</tt></a></b>(<var>time</var>) <dd> Adjust the timestamp (in GMT) when the certificate stops being valid. </dl> <P> -<dl><dt><b><a name='l2h-50'><tt class='method'>has_expired</tt></a></b>() +<dl><dt><b><a name='l2h-52'><tt class='method'>has_expired</tt></a></b>() <dd> Checks the certificate's time stamp against current time. Returns true if the certificate has expired and false otherwise. </dl> <P> -<dl><dt><b><a name='l2h-51'><tt class='method'>set_issuer</tt></a></b>(<var>issuer</var>) +<dl><dt><b><a name='l2h-53'><tt class='method'>set_issuer</tt></a></b>(<var>issuer</var>) <dd> Set the issuer of the certificate to <var>issuer</var>. </dl> <P> -<dl><dt><b><a name='l2h-52'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-54'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>) <dd> Set the public key of the certificate to <var>pkey</var>. </dl> <P> -<dl><dt><b><a name='l2h-53'><tt class='method'>set_serial_number</tt></a></b>(<var>serialno</var>) +<dl><dt><b><a name='l2h-55'><tt class='method'>set_serial_number</tt></a></b>(<var>serialno</var>) <dd> Set the serial number of the certificate to <var>serialno</var>. </dl> <P> -<dl><dt><b><a name='l2h-54'><tt class='method'>set_subject</tt></a></b>(<var>subject</var>) +<dl><dt><b><a name='l2h-56'><tt class='method'>set_subject</tt></a></b>(<var>subject</var>) <dd> Set the subject of the certificate to <var>subject</var>. </dl> <P> -<dl><dt><b><a name='l2h-55'><tt class='method'>set_version</tt></a></b>(<var>version</var>) +<dl><dt><b><a name='l2h-57'><tt class='method'>set_version</tt></a></b>(<var>version</var>) <dd> Set the certificate version to <var>version</var>. </dl> <P> -<dl><dt><b><a name='l2h-56'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>) +<dl><dt><b><a name='l2h-58'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>) <dd> Sign the certificate, using the key <var>pkey</var> and the message digest algorithm identified by the string <var>digest</var>. </dl> <P> -<dl><dt><b><a name='l2h-57'><tt class='method'>subject_name_hash</tt></a></b>() +<dl><dt><b><a name='l2h-59'><tt class='method'>subject_name_hash</tt></a></b>() <dd> Return the hash of the certificate subject. </dl> <P> -<dl><dt><b><a name='l2h-58'><tt class='method'>digest</tt></a></b>(<var>digest_name</var>) +<dl><dt><b><a name='l2h-60'><tt class='method'>digest</tt></a></b>(<var>digest_name</var>) <dd> Return a digest of the certificate, using the <var>digest_name</var> method. <var>digest_name</var> must be a string describing a digest algorithm supported @@ -203,18 +203,41 @@ by OpenSSL (by EVP_get_digestbyname, specifically). For example, </dl> <P> -<dl><dt><b><a name='l2h-59'><tt class='method'>add_extensions</tt></a></b>(<var>extensions</var>) +<dl><dt><b><a name='l2h-61'><tt class='method'>add_extensions</tt></a></b>(<var>extensions</var>) <dd> Add the extensions in the sequence <var>extensions</var> to the certificate. </dl> <P> +<dl><dt><b><a name='l2h-62'><tt class='method'>get_extension_count</tt></a></b>() +<dd> +Return the number of extensions on this certificate. + +<span class='versionnote'>New in version 0.12.</span> + +</dl> + +<P> +<dl><dt><b><a name='l2h-63'><tt class='method'>get_extension</tt></a></b>(<var>index</var>) +<dd> +Retrieve the extension on this certificate at the given index. + +<P> +Extensions on a certificate are kept in order. The index parameter selects +which extension will be returned. The returned object will be an X509Extension +instance. + +<span class='versionnote'>New in version 0.12.</span> + +</dl> + +<P> <DIV CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> -<td><A href="openssl-crypto.html"><img src="previous.gif" +<td><A href="openssl-x509ext.html"><img src="previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="openssl-crypto.html"><img src="up.gif" @@ -234,9 +257,9 @@ Add the extensions in the sequence <var>extensions</var> to the certificate. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-x509name.html b/doc/html/openssl-x509name.html index 17960ca..d4b6a90 100644 --- a/doc/html/openssl-x509name.html +++ b/doc/html/openssl-x509name.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.2 X509Name objects </title> -<META NAME="description" CONTENT="3.1.2 X509Name objects "> +<title>3.1.3 X509Name objects </title> +<META NAME="description" CONTENT="3.1.3 X509Name objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,36 +36,36 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509.html">3.1.1 X509 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509.html">3.1.2 X509 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509req.html">3.1.3 X509Req objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509req.html">3.1.4 X509Req objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000412000000000000000"> </A> +<H3><A NAME="SECTION000413000000000000000"> </A> <BR> -3.1.2 X509Name objects +3.1.3 X509Name objects </H3> <P> X509Name objects have the following methods: <P> -<dl><dt><b><a name='l2h-60'><tt class='method'>hash</tt></a></b>() +<dl><dt><b><a name='l2h-64'><tt class='method'>hash</tt></a></b>() <dd> Return an integer giving the first four bytes of the MD5 digest of the DER representation of the name. </dl> <P> -<dl><dt><b><a name='l2h-61'><tt class='method'>der</tt></a></b>() +<dl><dt><b><a name='l2h-65'><tt class='method'>der</tt></a></b>() <dd> Return a string giving the DER representation of the name. </dl> <P> -<dl><dt><b><a name='l2h-62'><tt class='method'>get_components</tt></a></b>() +<dl><dt><b><a name='l2h-66'><tt class='method'>get_components</tt></a></b>() <dd> Return a list of two-tuples of strings giving the components of the name. </dl> @@ -74,49 +74,49 @@ Return a list of two-tuples of strings giving the components of the name. X509Name objects have the following members: <P> -<dl><dt><b><a name='l2h-63'><tt class='member'>countryName</tt></a></b> +<dl><dt><b><a name='l2h-67'><tt class='member'>countryName</tt></a></b> <dd> The country of the entity. <code>C</code> may be used as an alias for <code>countryName</code>. </dl> <P> -<dl><dt><b><a name='l2h-64'><tt class='member'>stateOrProvinceName</tt></a></b> +<dl><dt><b><a name='l2h-68'><tt class='member'>stateOrProvinceName</tt></a></b> <dd> The state or province of the entity. <code>ST</code> may be used as an alias for <code>stateOrProvinceName</code>· </dl> <P> -<dl><dt><b><a name='l2h-65'><tt class='member'>localityName</tt></a></b> +<dl><dt><b><a name='l2h-69'><tt class='member'>localityName</tt></a></b> <dd> The locality of the entity. <code>L</code> may be used as an alias for <code>localityName</code>. </dl> <P> -<dl><dt><b><a name='l2h-66'><tt class='member'>organizationName</tt></a></b> +<dl><dt><b><a name='l2h-70'><tt class='member'>organizationName</tt></a></b> <dd> The organization name of the entity. <code>O</code> may be used as an alias for <code>organizationName</code>. </dl> <P> -<dl><dt><b><a name='l2h-67'><tt class='member'>organizationalUnitName</tt></a></b> +<dl><dt><b><a name='l2h-71'><tt class='member'>organizationalUnitName</tt></a></b> <dd> The organizational unit of the entity. <code>OU</code> may be used as an alias for <code>organizationalUnitName</code>. </dl> <P> -<dl><dt><b><a name='l2h-68'><tt class='member'>commonName</tt></a></b> +<dl><dt><b><a name='l2h-72'><tt class='member'>commonName</tt></a></b> <dd> The common name of the entity. <code>CN</code> may be used as an alias for <code>commonName</code>. </dl> <P> -<dl><dt><b><a name='l2h-69'><tt class='member'>emailAddress</tt></a></b> +<dl><dt><b><a name='l2h-73'><tt class='member'>emailAddress</tt></a></b> <dd> The e-mail address of the entity. </dl> @@ -147,9 +147,9 @@ The e-mail address of the entity. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509.html">3.1.1 X509 objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509.html">3.1.2 X509 objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509req.html">3.1.3 X509Req objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509req.html">3.1.4 X509Req objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-x509req.html b/doc/html/openssl-x509req.html index 31561b5..7be9326 100644 --- a/doc/html/openssl-x509req.html +++ b/doc/html/openssl-x509req.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.3 X509Req objects </title> -<META NAME="description" CONTENT="3.1.3 X509Req objects "> +<title>3.1.4 X509Req objects </title> +<META NAME="description" CONTENT="3.1.4 X509Req objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,61 +36,61 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509store.html">3.1.4 X509Store objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509store.html">3.1.5 X509Store objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000413000000000000000"> </A> +<H3><A NAME="SECTION000414000000000000000"> </A> <BR> -3.1.3 X509Req objects +3.1.4 X509Req objects </H3> <P> X509Req objects have the following methods: <P> -<dl><dt><b><a name='l2h-70'><tt class='method'>get_pubkey</tt></a></b>() +<dl><dt><b><a name='l2h-74'><tt class='method'>get_pubkey</tt></a></b>() <dd> Return a PKey object representing the public key of the certificate request. </dl> <P> -<dl><dt><b><a name='l2h-71'><tt class='method'>get_subject</tt></a></b>() +<dl><dt><b><a name='l2h-75'><tt class='method'>get_subject</tt></a></b>() <dd> Return an X509Name object representing the subject of the certificate. </dl> <P> -<dl><dt><b><a name='l2h-72'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-76'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>) <dd> Set the public key of the certificate request to <var>pkey</var>. </dl> <P> -<dl><dt><b><a name='l2h-73'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>) +<dl><dt><b><a name='l2h-77'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>) <dd> Sign the certificate request, using the key <var>pkey</var> and the message digest algorithm identified by the string <var>digest</var>. </dl> <P> -<dl><dt><b><a name='l2h-74'><tt class='method'>verify</tt></a></b>(<var>pkey</var>) +<dl><dt><b><a name='l2h-78'><tt class='method'>verify</tt></a></b>(<var>pkey</var>) <dd> Verify a certificate request using the public key <var>pkey</var>. </dl> <P> -<dl><dt><b><a name='l2h-75'><tt class='method'>set_version</tt></a></b>(<var>version</var>) +<dl><dt><b><a name='l2h-79'><tt class='method'>set_version</tt></a></b>(<var>version</var>) <dd> Set the version (RFC 2459, 4.1.2.1) of the certificate request to <var>version</var>. </dl> <P> -<dl><dt><b><a name='l2h-76'><tt class='method'>get_version</tt></a></b>() +<dl><dt><b><a name='l2h-80'><tt class='method'>get_version</tt></a></b>() <dd> Get the version (RFC 2459, 4.1.2.1) of the certificate request. </dl> @@ -121,9 +121,9 @@ Get the version (RFC 2459, 4.1.2.1) of the certificate request. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509store.html">3.1.4 X509Store objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509store.html">3.1.5 X509Store objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl-x509store.html b/doc/html/openssl-x509store.html index 9c6c290..4c2d9b2 100644 --- a/doc/html/openssl-x509store.html +++ b/doc/html/openssl-x509store.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.4 X509Store objects </title> -<META NAME="description" CONTENT="3.1.4 X509Store objects "> +<title>3.1.5 X509Store objects </title> +<META NAME="description" CONTENT="3.1.5 X509Store objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -36,23 +36,23 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509req.html">3.1.3 X509Req objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509req.html">3.1.4 X509Req objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkey.html">3.1.5 PKey objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkey.html">3.1.6 PKey objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION000414000000000000000"> </A> +<H3><A NAME="SECTION000415000000000000000"> </A> <BR> -3.1.4 X509Store objects +3.1.5 X509Store objects </H3> <P> The X509Store object has currently just one method: <P> -<dl><dt><b><a name='l2h-77'><tt class='method'>add_cert</tt></a></b>(<var>cert</var>) +<dl><dt><b><a name='l2h-81'><tt class='method'>add_cert</tt></a></b>(<var>cert</var>) <dd> Add the certificate <var>cert</var> to the certificate store. </dl> @@ -83,9 +83,9 @@ Add the certificate <var>cert</var> to the certificate store. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509req.html">3.1.3 X509Req objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509req.html">3.1.4 X509Req objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> -<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkey.html">3.1.5 PKey objects</A> +<b class="navlabel">Next:</b> <a class="sectref" href="openssl-pkey.html">3.1.6 PKey objects</A> <hr> <span class="release-info">Release 0.11.</span> </DIV> diff --git a/doc/html/openssl.html b/doc/html/openssl.html index e47b130..ce75c61 100644 --- a/doc/html/openssl.html +++ b/doc/html/openssl.html @@ -80,41 +80,43 @@ An interface to the SSL-specific parts of OpenSSL. <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL CLASS="ChildLinks"> -<LI><A NAME="tex2html112" +<LI><A NAME="tex2html113" href="openssl-crypto.html">3.1 <tt class="module">crypto</tt> -- Generic cryptographic module </A> <UL> -<LI><A NAME="tex2html113" - href="openssl-x509.html">3.1.1 X509 objects </A> <LI><A NAME="tex2html114" - href="openssl-x509name.html">3.1.2 X509Name objects </A> + href="openssl-x509ext.html">3.1.1 X509Extension objects </A> <LI><A NAME="tex2html115" - href="openssl-x509req.html">3.1.3 X509Req objects </A> + href="openssl-x509.html">3.1.2 X509 objects </A> <LI><A NAME="tex2html116" - href="openssl-x509store.html">3.1.4 X509Store objects </A> + href="openssl-x509name.html">3.1.3 X509Name objects </A> <LI><A NAME="tex2html117" - href="openssl-pkey.html">3.1.5 PKey objects </A> + href="openssl-x509req.html">3.1.4 X509Req objects </A> <LI><A NAME="tex2html118" - href="openssl-pkcs7.html">3.1.6 PKCS7 objects </A> + href="openssl-x509store.html">3.1.5 X509Store objects </A> <LI><A NAME="tex2html119" - href="openssl-pkcs12.html">3.1.7 PKCS12 objects </A> + href="openssl-pkey.html">3.1.6 PKey objects </A> <LI><A NAME="tex2html120" - href="openssl-509ext.html">3.1.8 X509Extension objects </A> + href="openssl-pkcs7.html">3.1.7 PKCS7 objects </A> <LI><A NAME="tex2html121" - href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects </A> + href="openssl-pkcs12.html">3.1.8 PKCS12 objects </A> <LI><A NAME="tex2html122" - href="crl.html">3.1.10 CRL objects </A> + href="openssl-509ext.html">3.1.9 X509Extension objects </A> <LI><A NAME="tex2html123" - href="revoked.html">3.1.11 Revoked objects </A> + href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects </A> +<LI><A NAME="tex2html124" + href="crl.html">3.1.11 CRL objects </A> +<LI><A NAME="tex2html125" + href="revoked.html">3.1.12 Revoked objects </A> </UL> <BR> -<LI><A NAME="tex2html124" +<LI><A NAME="tex2html126" href="openssl-rand.html">3.2 <tt class="module">rand</tt> -- An interface to the OpenSSL pseudo random number generator </A> -<LI><A NAME="tex2html125" +<LI><A NAME="tex2html127" href="openssl-ssl.html">3.3 <tt class="module">SSL</tt> -- An interface to the SSL-specific parts of OpenSSL </A> <UL> -<LI><A NAME="tex2html126" +<LI><A NAME="tex2html128" href="openssl-context.html">3.3.1 Context objects </A> -<LI><A NAME="tex2html127" +<LI><A NAME="tex2html129" href="openssl-connection.html">3.3.2 Connection objects </A> </UL></UL> <!--End of Table of Child-Links--> diff --git a/doc/html/pyOpenSSL.how b/doc/html/pyOpenSSL.how index 1d37fe6..979b545 100644 --- a/doc/html/pyOpenSSL.how +++ b/doc/html/pyOpenSSL.how @@ -1 +1 @@ -+++ perl /home/exarkun/Projects/pyOpenSSL/branches/release-0.11/doc/tools/node2label.pl *.html ++++ perl /home/exarkun/Projects/pyOpenSSL/branches/release-0.12/doc/tools/node2label.pl *.html diff --git a/doc/html/pyOpenSSL.html b/doc/html/pyOpenSSL.html index 4eab092..1f9e3f2 100644 --- a/doc/html/pyOpenSSL.html +++ b/doc/html/pyOpenSSL.html @@ -87,52 +87,54 @@ calling a corresponding function in the OpenSSL library. href="openssl-crypto.html">3.1 <tt class="module">crypto</tt> -- Generic cryptographic module </A> <UL> <LI><A NAME="tex2html15" - href="openssl-x509.html">3.1.1 X509 objects </A> + href="openssl-x509ext.html">3.1.1 X509Extension objects </A> <LI><A NAME="tex2html16" - href="openssl-x509name.html">3.1.2 X509Name objects </A> + href="openssl-x509.html">3.1.2 X509 objects </A> <LI><A NAME="tex2html17" - href="openssl-x509req.html">3.1.3 X509Req objects </A> + href="openssl-x509name.html">3.1.3 X509Name objects </A> <LI><A NAME="tex2html18" - href="openssl-x509store.html">3.1.4 X509Store objects </A> + href="openssl-x509req.html">3.1.4 X509Req objects </A> <LI><A NAME="tex2html19" - href="openssl-pkey.html">3.1.5 PKey objects </A> + href="openssl-x509store.html">3.1.5 X509Store objects </A> <LI><A NAME="tex2html20" - href="openssl-pkcs7.html">3.1.6 PKCS7 objects </A> + href="openssl-pkey.html">3.1.6 PKey objects </A> <LI><A NAME="tex2html21" - href="openssl-pkcs12.html">3.1.7 PKCS12 objects </A> + href="openssl-pkcs7.html">3.1.7 PKCS7 objects </A> <LI><A NAME="tex2html22" - href="openssl-509ext.html">3.1.8 X509Extension objects </A> + href="openssl-pkcs12.html">3.1.8 PKCS12 objects </A> <LI><A NAME="tex2html23" - href="openssl-netscape-spki.html">3.1.9 NetscapeSPKI objects </A> + href="openssl-509ext.html">3.1.9 X509Extension objects </A> <LI><A NAME="tex2html24" - href="crl.html">3.1.10 CRL objects </A> + href="openssl-netscape-spki.html">3.1.10 NetscapeSPKI objects </A> <LI><A NAME="tex2html25" - href="revoked.html">3.1.11 Revoked objects </A> -</UL> + href="crl.html">3.1.11 CRL objects </A> <LI><A NAME="tex2html26" - href="openssl-rand.html">3.2 <tt class="module">rand</tt> -- An interface to the OpenSSL pseudo random number generator </A> + href="revoked.html">3.1.12 Revoked objects </A> +</UL> <LI><A NAME="tex2html27" + href="openssl-rand.html">3.2 <tt class="module">rand</tt> -- An interface to the OpenSSL pseudo random number generator </A> +<LI><A NAME="tex2html28" href="openssl-ssl.html">3.3 <tt class="module">SSL</tt> -- An interface to the SSL-specific parts of OpenSSL </A> <UL> -<LI><A NAME="tex2html28" - href="openssl-context.html">3.3.1 Context objects </A> <LI><A NAME="tex2html29" + href="openssl-context.html">3.3.1 Context objects </A> +<LI><A NAME="tex2html30" href="openssl-connection.html">3.3.2 Connection objects </A> </UL> </UL> <BR> -<LI><A NAME="tex2html30" +<LI><A NAME="tex2html31" href="internals.html">4 Internals </A> <UL> -<LI><A NAME="tex2html31" - href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html32" - href="callbacks.html">4.2 Callbacks </A> + href="exceptions.html">4.1 Exceptions </A> <LI><A NAME="tex2html33" + href="callbacks.html">4.2 Callbacks </A> +<LI><A NAME="tex2html34" href="socket-methods.html">4.3 Acessing Socket Methods </A> </UL> <BR> -<LI><A NAME="tex2html34" +<LI><A NAME="tex2html35" href="about.html">About this document ...</A> </UL> <!--End of Table of Child-Links--> diff --git a/doc/html/revoked.html b/doc/html/revoked.html index 0a7d547..a665948 100644 --- a/doc/html/revoked.html +++ b/doc/html/revoked.html @@ -1,8 +1,8 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<title>3.1.11 Revoked objects </title> -<META NAME="description" CONTENT="3.1.11 Revoked objects "> +<title>3.1.12 Revoked objects </title> +<META NAME="description" CONTENT="3.1.12 Revoked objects "> <META NAME="keywords" CONTENT="pyOpenSSL"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> @@ -35,49 +35,49 @@ border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="crl.html">3.1.10 CRL objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="crl.html">3.1.11 CRL objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> <b class="navlabel">Next:</b> <a class="sectref" href="openssl-rand.html">3.2 rand </A> <br><hr> </DIV> <!--End of Navigation Panel--> -<H3><A NAME="SECTION0004111000000000000000"> </A> +<H3><A NAME="SECTION0004112000000000000000"> </A> <BR> -3.1.11 Revoked objects +3.1.12 Revoked objects </H3> <P> Revoked objects have the following methods: <P> -<dl><dt><b><a name='l2h-105'><tt class='method'>all_reasons</tt></a></b>() +<dl><dt><b><a name='l2h-109'><tt class='method'>all_reasons</tt></a></b>() <dd> Return a list of all supported reasons. </dl> <P> -<dl><dt><b><a name='l2h-106'><tt class='method'>get_reason</tt></a></b>() +<dl><dt><b><a name='l2h-110'><tt class='method'>get_reason</tt></a></b>() <dd> Return the revocation reason as a str. Can be None, which differs from "Unspecified". </dl> <P> -<dl><dt><b><a name='l2h-107'><tt class='method'>get_rev_date</tt></a></b>() +<dl><dt><b><a name='l2h-111'><tt class='method'>get_rev_date</tt></a></b>() <dd> Return the revocation date as a str. The string is formatted as an ASN1 GENERALIZEDTIME. </dl> <P> -<dl><dt><b><a name='l2h-108'><tt class='method'>get_serial</tt></a></b>() +<dl><dt><b><a name='l2h-112'><tt class='method'>get_serial</tt></a></b>() <dd> Return a str containing a hex number of the serial of the revoked certificate. </dl> <P> -<dl><dt><b><a name='l2h-109'><tt class='method'>set_reason</tt></a></b>(<var>reason</var>) +<dl><dt><b><a name='l2h-113'><tt class='method'>set_reason</tt></a></b>(<var>reason</var>) <dd> Set the revocation reason. <var>reason</var> must be None or a string, but the values are limited. @@ -85,14 +85,14 @@ Spaces and case are ignored. See <tt class="method">all_reasons</tt>. </dl> <P> -<dl><dt><b><a name='l2h-110'><tt class='method'>set_rev_date</tt></a></b>(<var>date</var>) +<dl><dt><b><a name='l2h-114'><tt class='method'>set_rev_date</tt></a></b>(<var>date</var>) <dd> Set the revocation date. The string is formatted as an ASN1 GENERALIZEDTIME. </dl> <P> -<dl><dt><b><a name='l2h-111'><tt class='method'>set_serial</tt></a></b>(<var>serial</var>) +<dl><dt><b><a name='l2h-115'><tt class='method'>set_serial</tt></a></b>(<var>serial</var>) <dd> <var>serial</var> is a string containing a hex number of the serial of the revoked certificate. </dl> @@ -123,7 +123,7 @@ The string is formatted as an ASN1 GENERALIZEDTIME. border="0" height="32" alt="" width="32"></td> </tr></table> -<b class="navlabel">Previous:</b> <a class="sectref" href="crl.html">3.1.10 CRL objects</A> +<b class="navlabel">Previous:</b> <a class="sectref" href="crl.html">3.1.11 CRL objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto </A> <b class="navlabel">Next:</b> <a class="sectref" href="openssl-rand.html">3.2 rand </A> <hr> |