Skip to content

Added documentation describing the dklen is expected in bytes for the… - #106624

Merged
serhiy-storchaka merged 4 commits into
python:mainfrom
thiezn:main
May 22, 2024
Merged

Added documentation describing the dklen is expected in bytes for the…#106624
serhiy-storchaka merged 4 commits into
python:mainfrom
thiezn:main

Conversation

@thiezn

@thieznthiezn commented Jul 11, 2023

Copy link
Copy Markdown
Contributor

Update hashlib.pbkdf2_hmac docs that dklen is in bytes

The hashlib.pbkfdf2_hmac documentation states that you can pass on the length of the derived key. It is however ambiguous if it's meant to be passed on as bytes or bits.

The CPython implementation relies on the OpenSSL C library. Looking at the OpenSSL source code, the function is expected to be in bytes.

Although this might be obvious to most people, some other language libraries handle this in bits.

Ps. This is my first pull request to cPython. I hope I'm not missing anything?


📚 Documentation preview 📚: https://cpython-previews--106624.org.readthedocs.build/

@thiezn
thiezn requested a review from tiran as a code ownerJuly 11, 2023 13:08
@bedevere-botbedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 11, 2023
@ghost

ghost commented Jul 11, 2023

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a similar case in the documentation for scrypt() few lines below. Please add "in bytes" there too.

@thiezn
thiezn requested a review from gpshead as a code ownerMay 22, 2024 07:12
@thiezn

Copy link
Copy Markdown
ContributorAuthor

Updated dklen documentation for scrypt() to include 'in bytes'

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@miss-islington-app

Copy link
Copy Markdown

Thanks @thiezn for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2024
…thonGH-106624)
(cherry picked from commit 5adf78f)
Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2024
…thonGH-106624)
(cherry picked from commit 5adf78f)
Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
@bedevere-app

Copy link
Copy Markdown

GH-119383 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label May 22, 2024
@bedevere-app

Copy link
Copy Markdown

GH-119384 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label May 22, 2024
serhiy-storchaka pushed a commit that referenced this pull request May 22, 2024
…ons (GH-106624) (GH-119384)
(cherry picked from commit 5adf78f)
Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
serhiy-storchaka pushed a commit that referenced this pull request May 22, 2024
…ons (GH-106624) (GH-119383)
(cherry picked from commit 5adf78f)
Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@thiezn@serhiy-storchaka@bedevere-bot@m-mortimer