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: improve Sign/Verify examples and docs #25452

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
5 participants
@sam-github
Copy link
Member

sam-github commented Jan 11, 2019

  • Use complete examples that can be pasted and run as-is
  • Move note about algorithm to the functions it applies to
  • Uncapitalize inconsistence use of "Class"
  • Use both EC and RSA keys in the examples
  • Note that hash and digest are two names for the same algorithms
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
@nodejs-github-bot

This comment has been minimized.

Copy link

nodejs-github-bot commented Jan 11, 2019

@sam-github sadly an error occured when I tried to trigger a build :(

@vsemozhetbyt
Copy link
Member

vsemozhetbyt left a comment

Doc format LGTM.

Show resolved Hide resolved doc/api/crypto.md Outdated
Show resolved Hide resolved doc/api/crypto.md Outdated
Show resolved Hide resolved doc/api/crypto.md Outdated
Show resolved Hide resolved doc/api/crypto.md Outdated
algorithm, such as 'RSA-SHA256', instead of a digest algorithm. This will use
the corresponding digest algorithm. This does not work for all signature
algorithms, such as 'ecdsa-with-SHA256', so it is best to always use digest
algorithm names.

This comment has been minimized.

@tniessen

tniessen Jan 11, 2019

Member

I would probably express this in an even stronger way, as far as I know, this is specific to OpenSSL.

This comment has been minimized.

@sam-github

sam-github Jan 14, 2019

Member

I'm just moving the existing text closer to the API it refers to, I don't want to rework too much unless its got a serious problem. In this case, we never build with anything other than OpenSSL, so doesn't all the docs apply to OpenSSL? I'll add some specific text if you suggest, but I'm not sure what else to say, myself.

Show resolved Hide resolved doc/api/crypto.md Outdated

@sam-github sam-github force-pushed the sam-github:improve-sign-verify-docs branch from f5266d7 to 49e4faf Jan 14, 2019

doc: improve Sign/Verify examples and docs
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms

@sam-github sam-github force-pushed the sam-github:improve-sign-verify-docs branch from 49e4faf to 97b1132 Jan 14, 2019

@sam-github

This comment has been minimized.

@sam-github

This comment has been minimized.

Copy link
Member

sam-github commented Jan 14, 2019

Landed in 273d7dd

@sam-github sam-github closed this Jan 14, 2019

@sam-github sam-github deleted the sam-github:improve-sign-verify-docs branch Jan 14, 2019

sam-github added a commit that referenced this pull request Jan 14, 2019

doc: improve Sign/Verify examples and docs
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms

PR-URL: #25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax added a commit that referenced this pull request Jan 15, 2019

doc: improve Sign/Verify examples and docs
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms

PR-URL: #25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>

@BridgeAR BridgeAR referenced this pull request Jan 16, 2019

Merged

v11.7.0 proposal #25537

BridgeAR added a commit to BridgeAR/node that referenced this pull request Jan 16, 2019

doc: improve Sign/Verify examples and docs
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms

PR-URL: nodejs#25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
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