summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandrei kulakov <andrei.avk@gmail.com>2021-08-13 10:58:55 (GMT)
committerGitHub <noreply@github.com>2021-08-13 10:58:55 (GMT)
commite43b9bbc31c22a0d97dc4fc420300e40c2d74166 (patch)
treeef3b8bfd6c95ad1bd6989e8e06f8e396dde442b0
parentdd8eb303b90d63e1f56684bedadca6674bb74a29 (diff)
downloadcpython-e43b9bbc31c22a0d97dc4fc420300e40c2d74166.zip
cpython-e43b9bbc31c22a0d97dc4fc420300e40c2d74166.tar.gz
cpython-e43b9bbc31c22a0d97dc4fc420300e40c2d74166.tar.bz2
bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
-rw-r--r--Doc/library/base64.rst15
-rw-r--r--Doc/library/security_warnings.rst2
-rw-r--r--Misc/NEWS.d/next/Documentation/2021-08-09-19-58-45.bpo-36700.WPNW5f.rst3
3 files changed, 16 insertions, 4 deletions
diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst
index 2f24bb6..f91547b 100644
--- a/Doc/library/base64.rst
+++ b/Doc/library/base64.rst
@@ -2,7 +2,7 @@
===============================================================
.. module:: base64
- :synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings;
+ :synopsis: RFC 4648: Base16, Base32, Base64 Data Encodings;
Base85 and Ascii85
**Source code:** :source:`Lib/base64.py`
@@ -16,10 +16,10 @@
This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data.
It provides encoding and decoding functions for the encodings specified in
-:rfc:`3548`, which defines the Base16, Base32, and Base64 algorithms,
+:rfc:`4648`, which defines the Base16, Base32, and Base64 algorithms,
and for the de-facto standard Ascii85 and Base85 encodings.
-The :rfc:`3548` encodings are suitable for encoding binary data so that it can
+The :rfc:`4648` encodings are suitable for encoding binary data so that it can be
safely sent by email, used as parts of URLs, or included as part of an HTTP
POST request. The encoding algorithm is not the same as the
:program:`uuencode` program.
@@ -28,7 +28,7 @@ There are two interfaces provided by this module. The modern interface
supports encoding :term:`bytes-like objects <bytes-like object>` to ASCII
:class:`bytes`, and decoding :term:`bytes-like objects <bytes-like object>` or
strings containing ASCII to :class:`bytes`. Both base-64 alphabets
-defined in :rfc:`3548` (normal, and URL- and filesystem-safe) are supported.
+defined in :rfc:`4648` (normal, and URL- and filesystem-safe) are supported.
The legacy interface does not support decoding from strings, but it does
provide functions for encoding and decoding to and from :term:`file objects
@@ -287,6 +287,13 @@ An example usage of the module:
>>> data
b'data to be encoded'
+.. _base64-security:
+
+Security Considerations
+-----------------------
+
+A new security considerations section was added to :rfc:`4648` (section 12); it's
+recommended to review the security section for any code deployed to production.
.. seealso::
diff --git a/Doc/library/security_warnings.rst b/Doc/library/security_warnings.rst
index 61fd4e6..26b015c 100644
--- a/Doc/library/security_warnings.rst
+++ b/Doc/library/security_warnings.rst
@@ -7,6 +7,8 @@ Security Considerations
The following modules have specific security considerations:
+* :mod:`base64`: :ref:`base64 security considerations <base64-security>` in
+ :rfc:`4648`
* :mod:`cgi`: :ref:`CGI security considerations <cgi-security>`
* :mod:`hashlib`: :ref:`all constructors take a "usedforsecurity" keyword-only
argument disabling known insecure and blocked algorithms
diff --git a/Misc/NEWS.d/next/Documentation/2021-08-09-19-58-45.bpo-36700.WPNW5f.rst b/Misc/NEWS.d/next/Documentation/2021-08-09-19-58-45.bpo-36700.WPNW5f.rst
new file mode 100644
index 0000000..5bc1e23
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-08-09-19-58-45.bpo-36700.WPNW5f.rst
@@ -0,0 +1,3 @@
+:mod:`base64` RFC references were updated to point to :rfc:`4648`; a section
+was added to point users to the new "security considerations" section of the
+RFC.