aboutsummaryrefslogtreecommitdiffstats
path: root/docs/x509.rst
diff options
context:
space:
mode:
authorAndre Caron <andre.l.caron@gmail.com>2015-06-02 23:47:11 -0400
committerIan Cordasco <graffatcolmingov@gmail.com>2015-06-24 13:35:49 -0500
commitd259ee51abae5a35e34f16ad74bfb1c62aa433d7 (patch)
tree77e9eaf41e48381a00ddb44b59a9d9b398ff05d3 /docs/x509.rst
parent99d0f90ff256b540acb007458bbb07c467642368 (diff)
downloadcryptography-d259ee51abae5a35e34f16ad74bfb1c62aa433d7.tar.gz
cryptography-d259ee51abae5a35e34f16ad74bfb1c62aa433d7.tar.bz2
cryptography-d259ee51abae5a35e34f16ad74bfb1c62aa433d7.zip
Polishes builder documentation,
Diffstat (limited to 'docs/x509.rst')
-rw-r--r--docs/x509.rst33
1 files changed, 28 insertions, 5 deletions
diff --git a/docs/x509.rst b/docs/x509.rst
index f79f630c..a2a3ded7 100644
--- a/docs/x509.rst
+++ b/docs/x509.rst
@@ -473,14 +473,37 @@ X.509 CSR (Certificate Signing Request) Builder Object
.. class:: CertificateSigningRequestBuilder
- .. method:: __init__()
+ .. versionadded:: 1.0
- Creates an empty certificate signing request.
+ .. doctest::
- .. method:: set_version(version)
+ >>> from cryptography import x509
+ >>> from cryptography.hazmat.backends import default_backend
+ >>> from cryptography.hazmat.primitives import hashes
+ >>> from cryptography.hazmat.primitives.asymmetric import rsa
+ >>> private_key = rsa.generate_private_key(
+ ... public_exponent=65537,
+ ... key_size=2048,
+ ... backend=default_backend()
+ ... )
+ >>> builder = x509.CertificateSigningRequestBuilder()
+ >>> builder = builder.set_subject_name(x509.Name([
+ ... x509.NameAttribute(x509.OID_COMMON_NAME, 'cryptography.io'),
+ ... ]))
+ >>> buidlder = builder.add_extension(x509.Extension(
+ ... x509.OID_BASIC_CONSTRAINTS,
+ ... True,
+ ... x509.BasicConstraints(False, None),
+ ... ))
+ >>> request = builder.sign(
+ ... default_backend(), private_key, hashes.SHA1()
+ ... )
+ >>> isinstance(request, x509.CertificateSigningRequest)
+ True
- :param version: The :class:`Version` of the X.509 protocol.
- :returns: A new `CertificateSigningRequestBuilder`.
+ .. method:: __init__()
+
+ Creates an empty certificate signing request.
.. method:: set_subject_name(name)