summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRick Dean <rick@fdd.com>2009-07-24 23:57:27 -0500
committerRick Dean <rick@fdd.com>2009-07-24 23:57:27 -0500
commit536ba0209b62de936e3d8ffd8c6d8dc9adfa33b1 (patch)
treef53a0454809f05064ee96fe9f912ef5606588bbf /doc
parentb19c694890b98fee428fcabda01c9b15e2079f12 (diff)
downloadpyopenssl-536ba0209b62de936e3d8ffd8c6d8dc9adfa33b1.tar.gz
Add support for CRL and Revoked objects.
Diffstat (limited to 'doc')
-rw-r--r--doc/pyOpenSSL.tex53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/pyOpenSSL.tex b/doc/pyOpenSSL.tex
index bd83d6d..d43ad96 100644
--- a/doc/pyOpenSSL.tex
+++ b/doc/pyOpenSSL.tex
@@ -207,6 +207,14 @@ representing a NetscapeSPKI object, as returned by the \method{b64_encode}
method.
\end{classdesc}
+\begin{classdesc}{CRL}{}
+A class representing Certifcate Revocation List objects.
+\end{classdesc}
+
+\begin{classdesc}{Revoked}{}
+A class representing Revocation objects of CRL.
+\end{classdesc}
+
\begin{datadesc}{FILETYPE_PEM}
\dataline{FILETYPE_ASN1}
File type constants.
@@ -259,6 +267,12 @@ the type \var{type} (must be one of \constant{FILETYPE_PEM} and
pass phrase.
\end{funcdesc}
+\begin{funcdesc}{load_crl}{type, buffer}
+Load Certificate Revocation List (CRL) data from a string \var{buffer}.
+\var{buffer} encoded with the type \var{type}. The type \var{type}
+must either \constant{FILETYPE_PEM} or \constant{FILETYPE_ASN1}).
+\end{funcdesc}
+
\begin{funcdesc}{load_pkcs7_data}{type, buffer}
Load pkcs7 data from the string \var{buffer} encoded with the type \var{type}.
\end{funcdesc}
@@ -579,6 +593,45 @@ example, \constant{"md5"} or \constant{"sha1"}.
Verify the NetscapeSPKI object using the given \var{key}.
\end{methoddesc}
+\subsubsection{CRL objects \label{crl}}
+
+CRL objects have the following methods:
+
+\begin{methoddesc}[CRL]{add_revoked}{revoked}
+Add a Revoked object to the CRL, by value not reference.
+\end{methoddesc}
+
+\begin{methoddesc}[CRL]{export}{cert, key\optional{, type=FILETYPE_PEM}\optional{, days=100}}
+Use \var{cert} and \var{key} to sign the CRL and return the CRL as a string.
+\var{days} is the number of days before the next CRL is due.
+\end{methoddesc}
+
+\begin{methoddesc}[CRL]{get_revoked}{}
+Return a tuple of Revoked objects, by value not reference.
+\end{methoddesc}
+
+\subsubsection{Revoked objects \label{revoked}}
+
+Revoked objects have the following methods:
+
+\begin{methoddesc}[Revoked]{get_rev_date}{}
+Return the revocation date as a str.
+The string is formatted as an ASN1 GENERALIZEDTIME.
+\end{methoddesc}
+
+\begin{methoddesc}[Revoked]{get_serial}{}
+Return a str containing a hex number of the serial of the revoked certificate.
+\end{methoddesc}
+
+\begin{methoddesc}[Revoked]{set_rev_date}{date}
+Set the revocation date.
+The string is formatted as an ASN1 GENERALIZEDTIME.
+\end{methoddesc}
+
+\begin{methoddesc}[Revoked]{set_serial}{serial}
+\var{serial} is a string containing a hex number of the serial of the revoked certificate.
+\end{methoddesc}
+
% % % rand module