summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJean-Paul Calderone <exarkun@twistedmatrix.com>2015-03-22 19:42:31 -0400
committerJean-Paul Calderone <exarkun@twistedmatrix.com>2015-03-22 19:42:31 -0400
commit2f0f395cefa8306185ee023a79cee2c492cd1303 (patch)
tree380ffc86b394aa743d04492a1821837d31c5c2c8 /doc
parent09540d7878e300d4ff7672b3c069de09c6dd186e (diff)
parent08807c9bf66e4a45c0ede3f2acec9be3184196ee (diff)
downloadpyopenssl-2f0f395cefa8306185ee023a79cee2c492cd1303.tar.gz
Merge remote-tracking branch 'pyca/master' into npn
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.rst44
-rw-r--r--doc/api/ssl.rst8
2 files changed, 50 insertions, 2 deletions
diff --git a/doc/api/crypto.rst b/doc/api/crypto.rst
index b360e89..ee261c5 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
@@ -257,7 +267,7 @@ X509 objects have the following methods:
Return the signature algorithm used in the certificate. If the algorithm is
undefined, raise :py:data:`ValueError`.
- ..versionadded:: 0.13
+ .. versionadded:: 0.13
.. py:method:: X509.get_subject()
@@ -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
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index 4b57ac5..e6a0775 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -641,6 +641,14 @@ Connection objects have the following methods:
by *bufsize*.
+.. py:method:: Connection.recv_into(buffer[, nbytes[, flags]])
+
+ Receive data from the Connection and copy it directly into the provided
+ buffer. The return value is the number of bytes read from the connection.
+ The maximum amount of data to be received at once is specified by *nbytes*.
+ *flags* is accepted for compatibility with ``socket.recv_into`` but its
+ value is ignored.
+
.. py:method:: Connection.bio_write(bytes)
If the Connection was created with a memory BIO, this method can be used to add