aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2015-02-07 16:59:14 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2015-02-07 16:59:14 -0600
commit4bb464995cae1b1f86d383fb668f9c5276b3d059 (patch)
treef2451f4d23dbe7e5b44095ab2301068a37df5da2 /docs
parentfb5ac9e4fde0051960d0d3235bff1de04fbf838e (diff)
downloadcryptography-4bb464995cae1b1f86d383fb668f9c5276b3d059.tar.gz
cryptography-4bb464995cae1b1f86d383fb668f9c5276b3d059.tar.bz2
cryptography-4bb464995cae1b1f86d383fb668f9c5276b3d059.zip
note that the OIDs listed are typically seen in x.509 names
Diffstat (limited to 'docs')
-rw-r--r--docs/x509.rst46
1 files changed, 29 insertions, 17 deletions
diff --git a/docs/x509.rst b/docs/x509.rst
index feca564d..26dd2a07 100644
--- a/docs/x509.rst
+++ b/docs/x509.rst
@@ -215,76 +215,88 @@ X.509 Certificate Object
Object Identifiers
~~~~~~~~~~~~~~~~~~
-X.509 name elements are identified by :class:`ObjectIdentifier` instances. The
-following common OIDs are available as constants.
+X.509 elements are frequently identified by :class:`ObjectIdentifier`
+instances. The following common OIDs are available as constants.
.. data:: OID_COMMON_NAME
Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
name would be encoded here for server certificates. :rfc:`2818` deprecates
this practice and names of that type should now be located in a
- SubjectAlternativeName extension.
+ SubjectAlternativeName extension. This OID is typically seen in X.509 names.
.. data:: OID_COUNTRY_NAME
- Corresponds to the dotted string ``"2.5.4.6"``.
+ Corresponds to the dotted string ``"2.5.4.6"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_LOCALITY_NAME
- Corresponds to the dotted string ``"2.5.4.7"``.
+ Corresponds to the dotted string ``"2.5.4.7"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_STATE_OR_PROVINCE_NAME
- Corresponds to the dotted string ``"2.5.4.8"``.
+ Corresponds to the dotted string ``"2.5.4.8"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_ORGANIZATION_NAME
- Corresponds to the dotted string ``"2.5.4.10"``.
+ Corresponds to the dotted string ``"2.5.4.10"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_ORGANIZATIONAL_UNIT_NAME
- Corresponds to the dotted string ``"2.5.4.11"``.
+ Corresponds to the dotted string ``"2.5.4.11"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_SERIAL_NUMBER
Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from the
serial number of the certificate itself (which can be obtained with
- :func:`Certificate.serial`).
+ :func:`Certificate.serial`). This OID is typically seen in X.509 names.
.. data:: OID_SURNAME
- Corresponds to the dotted string ``"2.5.4.4"``.
+ Corresponds to the dotted string ``"2.5.4.4"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_GIVEN_NAME
- Corresponds to the dotted string ``"2.5.4.42"``.
+ Corresponds to the dotted string ``"2.5.4.42"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_TITLE
- Corresponds to the dotted string ``"2.5.4.12"``.
+ Corresponds to the dotted string ``"2.5.4.12"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_GENERATION_QUALIFIER
- Corresponds to the dotted string ``"2.5.4.44"``.
+ Corresponds to the dotted string ``"2.5.4.44"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_DN_QUALIFIER
Corresponds to the dotted string ``"2.5.4.46"``. This specifies
disambiguating information to add to the relative distinguished name of an
- entry. See :rfc:`2256`.
+ entry. See :rfc:`2256`. This OID is typically seen in X.509 names.
.. data:: OID_PSEUDONYM
- Corresponds to the dotted string ``"2.5.4.65"``.
+ Corresponds to the dotted string ``"2.5.4.65"``. This OID is typically seen
+ in X.509 names.
.. data:: OID_DOMAIN_COMPONENT
Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
- holding one component of a domain name. See :rfc:`4519`.
+ holding one component of a domain name. See :rfc:`4519`. This OID is
+ typically seen in X.509 names.
.. data:: OID_EMAIL_ADDRESS
- Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``.
+ Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``. This OID is
+ typically seen in X.509 names.
Exceptions
~~~~~~~~~~