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

Update openssl command to list digest algos in docs #20385

Closed
RichAyotte opened this issue Apr 28, 2018 · 3 comments
Closed

Update openssl command to list digest algos in docs #20385

RichAyotte opened this issue Apr 28, 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. openssl Issues and PRs related to the OpenSSL dependency.

Comments

@RichAyotte
Copy link

Documentation update in https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options

The algorithm is dependent on the available algorithms supported by the version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc. On recent releases of OpenSSL, openssl list-message-digest-algorithms will display the available digest algorithms.

Replace the openssl command

openssl list-message-digest-algorithms

with

openssl list -digest-algorithms

Tested with:

$ openssl version
OpenSSL 1.1.0h  27 Mar 2018
@addaleax
Copy link
Member

I think we might want to list both? I don’t think we can assume that the global openssl CLI for a user will match Node’s openssl version.

@addaleax addaleax added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. openssl Issues and PRs related to the OpenSSL dependency. good first issue Issues that are suitable for first-time contributors. labels Apr 28, 2018
@shobhitchittora
Copy link
Contributor

shobhitchittora commented Apr 29, 2018

Hey I'd like to make a PR for this. I hope the following text for the doc works -

The algorithm is dependent on the available algorithms supported by the version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc. On recent releases of OpenSSL, openssl list digest-algorithms ( openssl list-message-digest-algorithms for older versions of OpenSSL ) will display the available digest algorithms.

@RichAyotte Shouldn't the new command be - (note the missing '-' before digest)

openssl list digest-algorithms

@RichAyotte
Copy link
Author

@shobhitchittora the dash is required.

MylesBorins pushed a commit that referenced this issue May 4, 2018
PR-URL: #20400
Fixes: #20385
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
addaleax pushed a commit that referenced this issue May 6, 2018
PR-URL: #20502
Refs: #20385
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
MylesBorins pushed a commit that referenced this issue May 8, 2018
PR-URL: #20502
Refs: #20385
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
MylesBorins pushed a commit that referenced this issue May 8, 2018
PR-URL: #20400
Fixes: #20385
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
MylesBorins pushed a commit that referenced this issue May 8, 2018
PR-URL: #20502
Refs: #20385
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
MylesBorins pushed a commit that referenced this issue May 9, 2018
PR-URL: #20502
Refs: #20385
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
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. openssl Issues and PRs related to the OpenSSL dependency.
Projects
None yet
Development

No branches or pull requests

3 participants