diff options
| author | Stephen Holsapple <sholsapp@gmail.com> | 2015-06-09 22:51:43 -0700 |
|---|---|---|
| committer | Stephen Holsapple <sholsapp@gmail.com> | 2015-06-10 08:10:05 -0700 |
| commit | 8ad4a1979b6594af3d33d478cbe96821beffaeee (patch) | |
| tree | 6b90fb14a6538096d148883b1edd067fe058190d /doc | |
| parent | e3f4bbb30082fc3f9bc9243b82d35df18c11f885 (diff) | |
| download | pyopenssl-git-8ad4a1979b6594af3d33d478cbe96821beffaeee.tar.gz | |
Clean up X509StoreContext documentation
This change cleans up the X509StoreContext and X509StoreContextError
documentation to be more aligned with the other documentation.
Tested using ``tox -e docs``.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/crypto.rst | 27 |
1 files changed, 7 insertions, 20 deletions
diff --git a/doc/api/crypto.rst b/doc/api/crypto.rst index 101f3bd..189f440 100644 --- a/doc/api/crypto.rst +++ b/doc/api/crypto.rst @@ -175,34 +175,21 @@ X509Store objects .. autoclass:: X509Store :members: +.. _openssl-x509storecontexterror: + 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. +.. autoclass:: X509StoreContextError + :members: -Details about the verification error are given in the exception's -``args`` attribute. +.. _openssl-x509storecontext: 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 - +.. autoclass:: X509StoreContext + :members: .. _openssl-pkey: |