diff options
author | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2015-03-15 16:32:13 -0400 |
---|---|---|
committer | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2015-03-15 16:32:13 -0400 |
commit | 15111f26d4594a078a017e7fee5b92651c77b2b5 (patch) | |
tree | ed474b4d39bc0ed87cfc40a33861b8427db0c578 /doc/api/crypto.rst | |
parent | 85ce662560419a34cf0fbfb60836e1602a693586 (diff) | |
parent | 876b2ac5929fd9edcf7c03d1f28ee5334bce60ea (diff) | |
download | pyopenssl-remove-rationale.tar.gz |
merge masterremove-rationale
Diffstat (limited to 'doc/api/crypto.rst')
-rw-r--r-- | doc/api/crypto.rst | 42 |
1 files changed, 41 insertions, 1 deletions
diff --git a/doc/api/crypto.rst b/doc/api/crypto.rst index b360e89..f378e84 100644 --- a/doc/api/crypto.rst +++ b/doc/api/crypto.rst @@ -42,7 +42,17 @@ .. py:data:: X509StoreType - A Python type object representing the X509Store object type. + See :py:class:`X509Store` + + +.. py:data X509Store + + A class representing the X.509 store. + + +.. py:data:: X509StoreContext + + A class representing the X.509 store context. .. py:data:: PKeyType @@ -526,6 +536,36 @@ The X509Store object has currently just one method: Add the certificate *cert* to the certificate store. +X509StoreContextError objects +----------------------------- + +The X509StoreContextError is an exception raised from +`X509StoreContext.verify_certificate` in circumstances where a certificate +cannot be verified in a provided context. + +The certificate for which the verification error was detected is given by the +``certificate`` attribute of the exception instance as a :class:`X509` +instance. + +Details about the verification error are given in the exception's ``args`` attribute. + + +X509StoreContext objects +------------------------ + +The X509StoreContext object is used for verifying a certificate against a set +of trusted certificates. + + +.. py:method:: X509StoreContext.verify_certificate() + + Verify a certificate in the context of this initialized `X509StoreContext`. + On error, raises `X509StoreContextError`, otherwise does nothing. + + .. versionadded:: 0.15 + + + .. _openssl-pkey: PKey objects |