From 912d3fbc84d72ea112e3a64494e9de69a105b0c3 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Thu, 29 Jan 2015 11:19:22 -0600 Subject: add attribute and objectidentifier classes for x509 name --- docs/x509.rst | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) (limited to 'docs') 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 -- cgit v1.2.3