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

password and salt parameter allows both string and buffer, but the doc only says string #14800

Closed
zhanzhenzhen opened this issue Aug 13, 2017 · 4 comments
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. wip Issues and PRs that are still a work in progress.

Comments

@zhanzhenzhen
Copy link
Contributor

For crypto.pbkdf2Sync and crypto.pbkdf2, the password and salt parameter allows both string and buffer, but the doc only says string.

@benjamingr
Copy link
Member

I think this is explicit and for backwards compatibility. See https://github.com/nodejs/node/blob/master/lib/crypto.js#L57-L68

@zhanzhenzhen
Copy link
Contributor Author

But, can the document be more accurate?

@vsemozhetbyt vsemozhetbyt added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Aug 13, 2017
@refack refack added the wip Issues and PRs that are still a work in progress. label Aug 13, 2017
@refack
Copy link
Contributor

refack commented Aug 13, 2017

Did a pass on the crypto docs - #14805
One other issue identified - #14804 ( @zhanzhenzhen if you're up to it, you are welcome to help with documenting options. Our CONTRIBUTING guide is not too bad. )

@refack refack self-assigned this Aug 13, 2017
@apapirovski
Copy link
Contributor

As far as I can tell the docs have been updated and improved to include this information. Closing but @refack feel free to reopen if I'm wrong here.

@refack refack removed their assignment Oct 12, 2018
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. wip Issues and PRs that are still a work in progress.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants