aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2015-08-06 07:16:19 -0400
committerAlex Gaynor <alex.gaynor@gmail.com>2015-08-06 07:16:19 -0400
commit304d9386d4a6e92325a0952b356f30e34562b446 (patch)
treebbfdcf0429104d004efd4ed4f47710ed96076384 /docs/hazmat/backends
parentcaace6089919ba1392488be6c43d43ce6ca35cb0 (diff)
parent0d62a07548163126585e426bed6c45e4e574edb1 (diff)
downloadcryptography-304d9386d4a6e92325a0952b356f30e34562b446.tar.gz
cryptography-304d9386d4a6e92325a0952b356f30e34562b446.tar.bz2
cryptography-304d9386d4a6e92325a0952b356f30e34562b446.zip
Merge pull request #2216 from reaperhulk/for-shame-sigmavirus
add missing sign_x509_certificate X509Backend interface docs
Diffstat (limited to 'docs/hazmat/backends')
-rw-r--r--docs/hazmat/backends/interfaces.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index fb3786c3..b6b59764 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -550,6 +550,26 @@ A specific ``backend`` may provide one or more of these interfaces.
:returns: A new object with the
:class:`~cryptography.x509.CertificateSigningRequest` interface.
+ .. method:: sign_x509_certificate(builder, private_key, algorithm)
+
+ .. versionadded:: 1.0
+
+ :param builder: An instance of
+ :class:`~cryptography.x509.CertificateBuilder`.
+
+ :param private_key: The
+ :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`,
+ :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey` or
+ :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
+ that will be used to sign the certificate.
+
+ :param algorithm: The
+ :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
+ that will be used to generate the certificate signature.
+
+ :returns: A new object with the
+ :class:`~cryptography.x509.Certificate` interface.
+
.. class:: DHBackend