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.

Sign up for GitHub

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

doc: crypto sign.sign() signature description missing options #22813

Closed
mscdex opened this issue Sep 12, 2018 · 3 comments
Closed

doc: crypto sign.sign() signature description missing options #22813

mscdex opened this issue Sep 12, 2018 · 3 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 Sep 12, 2018

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

Relevant link

sign.sign() currently only lists key and passphrase in the signature description, but the general function description also includes padding and saltLength as additional options.
@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 Sep 12, 2018
@darshanjayadev
Copy link

Yes, as described in sign.sign() - the required parameter privateKey is either a <string> or <object>. If it is an <object> , it must contain one or more of these properties - key , passphrase , padding and saltLength.

Can I move forward to add the missing padding and saltLength options to signature description?

@mbj36 mbj36 mentioned this issue Sep 12, 2018
Closed
2 tasks
@nadaa
Copy link

nadaa commented Sep 12, 2018

Hi,
I will work on this?
Thanks

@siddhant1
Copy link
Contributor

Any open task to pick up on this one?

@targos targos closed this as completed in cb3d6d5 Sep 17, 2018
targos pushed a commit that referenced this issue Sep 18, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
b1473c7 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
targos pushed a commit that referenced this issue Sep 19, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
dfef9a9 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
targos pushed a commit that referenced this issue Sep 20, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
0873d0a 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: add missing options for crypto sign.sign()
4 participants
@mscdex @nadaa @darshanjayadev @siddhant1