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

doc: bad crypto.verify() dsaEncoding description #37454

Closed
1 task
mscdex opened this issue Feb 20, 2021 · 4 comments
Closed
1 task

doc: bad crypto.verify() dsaEncoding description #37454

mscdex opened this issue Feb 20, 2021 · 4 comments
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@mscdex
Copy link
Contributor

mscdex commented Feb 20, 2021

📗 API Reference Docs Problem

  • Version: master
  • Platform: n/a
  • Subsystem: doc, crypto

Location

crypto.verify()

Affected URL(s):

Description

The description of dsaEncoding uses the term "generated signature" which is a bit confusing when the function is actually verifying an existing signature and may be a copy-paste error from crypto.sign().


  • I would like to work on this issue and
    submit a pull request.
@mscdex mscdex added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. labels Feb 20, 2021
@mscdex mscdex changed the title doc: doc: bad crypto.verify() dsaEncoding description Feb 20, 2021
@yagipy
Copy link
Contributor

yagipy commented Feb 20, 2021

I would like to work on this issue

@kaznovac
Copy link
Contributor

@HiroyukiYagihashi sorry i've already created a pr for this, you are welcome to review it

@khampret
Copy link

What this issues?

@jasnell jasnell closed this as completed in 4947ce5 Mar 9, 2021
@vishalvikal
Copy link

Hello there,
Recently I build node locally on my setup. I also want to contribute to this project please any body tell me about this issue. What can I do with javaScript modules.

danielleadams pushed a commit that referenced this issue Mar 16, 2021
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue May 27, 2021
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue May 30, 2021
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this issue Jun 11, 2021
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants