aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2015-01-29 11:19:22 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2015-01-29 11:21:35 -0600
commit912d3fbc84d72ea112e3a64494e9de69a105b0c3 (patch)
treec4b4b0ead5d75cfe2f978694cf49575ac1b5ef17 /docs
parentefec065b905a404887fa9c55c2276f3b47ed140b (diff)
downloadcryptography-912d3fbc84d72ea112e3a64494e9de69a105b0c3.tar.gz
cryptography-912d3fbc84d72ea112e3a64494e9de69a105b0c3.tar.bz2
cryptography-912d3fbc84d72ea112e3a64494e9de69a105b0c3.zip
add attribute and objectidentifier classes for x509 name
Diffstat (limited to 'docs')
-rw-r--r--docs/x509.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/x509.rst b/docs/x509.rst
index 26b91873..525b869b 100644
--- a/docs/x509.rst
+++ b/docs/x509.rst
@@ -181,6 +181,71 @@ X.509 Certificate Object
For version 3 X.509 certificates.
+.. class:: Attribute
+
+ .. versionadded:: 0.8
+
+ .. attribute:: oid
+
+ :type: :class:`ObjectIdentifier`
+
+ The attribute OID.
+
+ .. attribute:: value
+
+ :type: :class:`str`
+
+ The value of the attribute.
+
+.. class:: ObjectIdentifier
+
+ .. versionadded:: 0.8
+
+ .. attribute:: value
+
+ :type: :class:`str`
+
+ The dotted string value of the OID (e.g. "2.5.4.3")
+
+Object Identifiers
+~~~~~~~~~~~~~~~~~~
+
+X.509 name elements are identified by :class:`ObjectIdentifier` instances. The
+following common OIDs are available as constants.
+
+.. data:: OID_COMMON_NAME
+
+.. data:: OID_COUNTRY_NAME
+
+.. data:: OID_LOCALITY_NAME
+
+.. data:: OID_STATE_OR_PROVINCE_NAME
+
+.. data:: OID_ORGANIZATION_NAME
+
+.. data:: OID_ORGANIZATIONAL_UNIT_NAME
+
+.. data:: OID_SERIAL_NUMBER
+
+.. data:: OID_SURNAME
+
+.. data:: OID_GIVEN_NAME
+
+.. data:: OID_TITLE
+
+.. data:: OID_GENERATION_QUALIFIER
+
+.. data:: OID_DN_QUALIFIER
+
+.. data:: OID_PSEUDONYM
+
+.. data:: OID_DOMAIN_COMPONENT
+
+.. data:: OID_EMAIL_ADDRESS
+
+Exceptions
+~~~~~~~~~~
+
.. class:: InvalidVersion
This is raised when an X.509 certificate has an invalid version number.
@@ -191,6 +256,12 @@ X.509 Certificate Object
Returns the raw version that was parsed from the certificate.
+.. class:: UnknownAttribute
+
+ This is raised when an X.509 certificate has an unknown attribute in a
+ distinguished name.
+
+
.. _`public key infrastructure`: https://en.wikipedia.org/wiki/Public_key_infrastructure
.. _`TLS`: https://en.wikipedia.org/wiki/Transport_Layer_Security