Skip to content

Commit

Permalink
bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700)
Browse files Browse the repository at this point in the history
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit e43b9bb)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
  • Loading branch information
miss-islington and akulakov committed Aug 13, 2021
1 parent d412848 commit 16f73c8
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
15 changes: 11 additions & 4 deletions Doc/library/base64.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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::

Expand Down
2 changes: 2 additions & 0 deletions Doc/library/security_warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 16f73c8

Please sign in to comment.