Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

base64 has old references that should be updated #80881

Closed
paulehoffman mannequin opened this issue Apr 22, 2019 · 8 comments
Closed

base64 has old references that should be updated #80881

paulehoffman mannequin opened this issue Apr 22, 2019 · 8 comments
Labels
docs Documentation in the Doc dir

Comments

@paulehoffman
Copy link
Mannequin

paulehoffman mannequin commented Apr 22, 2019

BPO 36700
Nosy @ambv, @serhiy-storchaka, @pganssle, @miss-islington, @akulakov
PRs
  • bpo-36700: Updated obsolete references for RFC 3548 to RFC 4648 #2336
  • bpo-36700: updated RFC references #27700
  • [3.10] bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700) #27759
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2021-08-13.11:22:47.831>
created_at = <Date 2019-04-22.18:33:12.726>
labels = ['docs']
title = 'base64 has old references that should be updated'
updated_at = <Date 2021-08-13.11:22:47.830>
user = 'https://bugs.python.org/paulehoffman'

    bugs.python.org fields:

    activity = <Date 2021-08-13.11:22:47.830>
actor = 'lukasz.langa'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-08-13.11:22:47.831>
closer = 'lukasz.langa'
components = ['Documentation']
creation = <Date 2019-04-22.18:33:12.726>
creator = 'paulehoffman'
dependencies = []
files = []
hgrepos = []
issue_num = 36700
keywords = ['patch']
message_count = 8.0
messages = ['340668', '340739', '340740', '340742', '375140', '399522', '399527', '399528']
nosy_count = 7.0
nosy_names = ['docs@python', 'lukasz.langa', 'serhiy.storchaka', 'paulehoffman', 'p-ganssle', 'miss-islington', 'andrei.avk']
pr_nums = ['2336', '27700', '27759']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue36700'
versions = []
    @paulehoffman
    Copy link
    Mannequin Author

    paulehoffman mannequin commented Apr 22, 2019

    The documentation for base64 library has an RFC that is obsolete.

    @paulehoffman paulehoffman mannequin assigned docspython Apr 22, 2019
    @paulehoffman paulehoffman mannequin added the docs Documentation in the Doc dir label Apr 22, 2019
    @serhiy-storchaka
    Copy link
    Member

    base64 supports RFC 3548, but not RFC 4648.

    =====================================================================
    13. Changes Since RFC 3548

    Added the "base32 extended hex alphabet", needed to preserve sort
    order of encoded data.

    Referenced IMAP for the special Base64 encoding used there.

    Fixed the example copied from RFC 2440.

    Added security consideration about providing a signature for
    cryptoanalysis.

    Added test vectors.

    Fixed typos.
    =====================================================================

    To support RFC 4648 we need to add support for base 32 encoding with extended hex alphabet (see 16995). Check also that RFC 4648 test vectors are used in the module tests.

    @serhiy-storchaka
    Copy link
    Member

    See bpo-16995.

    @paulehoffman
    Copy link
    Mannequin Author

    paulehoffman mannequin commented Apr 23, 2019

    We can update the references without supporting every mode given in the new document. It is common for people to support RFC X without supporting every possible option of RFC X.

    Having said that, I think adding extended hex makes good sense, if possible.

    @pganssle
    Copy link
    Member

    Now that issue bpo-16995 is resolved, I think we can move forward with updating the text.

    @ambv
    Copy link
    Contributor

    ambv commented Aug 13, 2021

    New changeset e43b9bb by andrei kulakov in branch 'main':
    bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700)
    e43b9bb

    @miss-islington
    Copy link
    Contributor

    New changeset 16f73c8 by Miss Islington (bot) in branch '3.10':
    bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700)
    16f73c8

    @ambv
    Copy link
    Contributor

    ambv commented Aug 13, 2021

    Thanks for reporting, Paul, and Andrei for the patch! ✨ 🍰 ✨

    @ambv ambv closed this as completed Aug 13, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @ambv @pganssle @serhiy-storchaka @miss-islington