aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2019-01-18 15:19:34 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2019-01-18 15:19:34 -0600
commite5463ccb335149da72e455473af920b1dea453cf (patch)
treefbcdccf6c52f3577c6cfb2c6de2a6288f896c27e /docs
parentbef31146c3b12443fafdd1ef1a6a3c4519c60661 (diff)
downloadcryptography-e5463ccb335149da72e455473af920b1dea453cf.tar.gz
cryptography-e5463ccb335149da72e455473af920b1dea453cf.tar.bz2
cryptography-e5463ccb335149da72e455473af920b1dea453cf.zip
consistently linky RFC in the docs (#4716)
* consistently linky RFC in the docs * oops
Diffstat (limited to 'docs')
-rw-r--r--docs/development/custom-vectors/arc4.rst4
-rw-r--r--docs/development/custom-vectors/hkdf.rst2
-rw-r--r--docs/development/test-vectors.rst2
-rw-r--r--docs/x509/reference.rst9
4 files changed, 8 insertions, 9 deletions
diff --git a/docs/development/custom-vectors/arc4.rst b/docs/development/custom-vectors/arc4.rst
index ed8cd548..5b1b65d5 100644
--- a/docs/development/custom-vectors/arc4.rst
+++ b/docs/development/custom-vectors/arc4.rst
@@ -2,14 +2,14 @@ ARC4 vector creation
====================
This page documents the code that was used to generate the ARC4 test
-vectors for key lengths not available in RFC 6229. All the vectors
+vectors for key lengths not available in :rfc:`6229`. All the vectors
were generated using OpenSSL and verified with Go.
Creation
--------
``cryptography`` was modified to support ARC4 key lengths not listed
-in RFC 6229. Then the following Python script was run to generate the
+in :rfc:`6229`. Then the following Python script was run to generate the
vector files.
.. literalinclude:: /development/custom-vectors/arc4/generate_arc4.py
diff --git a/docs/development/custom-vectors/hkdf.rst b/docs/development/custom-vectors/hkdf.rst
index 0e1a729a..6d7e8618 100644
--- a/docs/development/custom-vectors/hkdf.rst
+++ b/docs/development/custom-vectors/hkdf.rst
@@ -2,7 +2,7 @@ HKDF vector creation
====================
This page documents the code that was used to generate a longer
-HKDF test vector (1200 bytes) than is available in RFC 5869. All
+HKDF test vector (1200 bytes) than is available in :rfc:`5869`. All
the vectors were generated using OpenSSL and verified with Go.
Creation
diff --git a/docs/development/test-vectors.rst b/docs/development/test-vectors.rst
index 6d4d3d1f..df1ecfa2 100644
--- a/docs/development/test-vectors.rst
+++ b/docs/development/test-vectors.rst
@@ -154,7 +154,7 @@ Key exchange
Diffie-Hellman parameters and key respectively. The keys were
generated using OpenSSL following `DHKE`_ guide. When creating the
parameters we added the `-pkeyopt dh_rfc5114:2` option to use
- RFC5114 2048 bit DH parameters with 224 bit subgroup.
+ :rfc:`5114` 2048 bit DH parameters with 224 bit subgroup.
``vectors/cryptography_vectors/asymmetric/DH/dhkey_rfc5114_2.txt`` contains
all parameter in text.
``vectors/cryptography_vectors/asymmetric/DH/dhp_rfc5114_2.der``,
diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst
index 6b2f74cf..b2278d57 100644
--- a/docs/x509/reference.rst
+++ b/docs/x509/reference.rst
@@ -1250,7 +1250,7 @@ X.509 CSR (Certificate Signing Request) Builder Object
.. versionadded:: 2.5
- :return str: Format the given name as a `RFC 4514`_ Distinguished Name
+ :return str: Format the given name as a :rfc:`4514` Distinguished Name
string, for example ``CN=mydomain.com,O=My Org,C=US``.
@@ -1291,7 +1291,7 @@ X.509 CSR (Certificate Signing Request) Builder Object
.. versionadded:: 2.5
- :return str: Format the given attribute as a `RFC 4514`_ Distinguished
+ :return str: Format the given attribute as a :rfc:`4514` Distinguished
Name string.
@@ -1314,7 +1314,7 @@ X.509 CSR (Certificate Signing Request) Builder Object
.. versionadded:: 2.5
- :return str: Format the given RDN set as a `RFC 4514`_ Distinguished
+ :return str: Format the given RDN set as a :rfc:`4514` Distinguished
Name string.
@@ -1331,7 +1331,6 @@ X.509 CSR (Certificate Signing Request) Builder Object
The dotted string value of the OID (e.g. ``"2.5.4.3"``)
-.. _`RFC 4514`: https://tools.ietf.org/html/rfc4514
.. _general_name_classes:
@@ -2794,7 +2793,7 @@ instances. The following common OIDs are available as constants.
Corresponds to the dotted string ``"1.2.840.113549.1.1.10"``. This is
signed by an RSA key using the Probabilistic Signature Scheme (PSS)
- padding from RFC 4055. The hash function and padding are defined by
+ padding from :rfc:`4055`. The hash function and padding are defined by
signature algorithm parameters.
.. attribute:: ECDSA_WITH_SHA1