Skip to content

Add caveats section in the doc of crypto - #3479

Closed
shigeki wants to merge 7 commits into
nodejs:masterfrom
shigeki:doc_crypto_caveats
Closed

Add caveats section in the doc of crypto #3479
shigeki wants to merge 7 commits into
nodejs:masterfrom
shigeki:doc_crypto_caveats

Conversation

@shigeki

Copy link
Copy Markdown
Contributor

This is originally from nodejs/node-v0.x-archive#25564.

This adds caveats section in the crypto api documentation to notify users of the risks of weak algorithms and small keys and revises examples to use safe ones.

Fix: #3406

Shigeki Ohtsuand others added 5 commits October 22, 2015 11:06
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
Comment threaddoc/api/crypto.markdown Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"... that are considered to be too weak for safe use."

@jasnell

Copy link
Copy Markdown
Member

Looks good in general but a few nits.

@shigeki

Copy link
Copy Markdown
ContributorAuthor

@jasnell Thanks. I revised the doc and add a commit.

@brendanashworthbrendanashworth added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Oct 22, 2015
Comment threaddoc/api/crypto.markdown Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"And the API also allows the use of ciphers and hashes with a" (replace to with the)

@jasnell

Copy link
Copy Markdown
Member

Thank you @shigeki ... just a few more I promise ;-). It's great that these recommendations are being updated!

@shigeki

Copy link
Copy Markdown
ContributorAuthor

@jasnell Thanks for reviewing. It is very helpful for me to correct my English. I appreciate that. The additional fix was made in db5b6e2. Commits will be squashed later.

@jasnell

Copy link
Copy Markdown
Member

LGTM! Thanks @shigeki !

@jasnell

Copy link
Copy Markdown
Member

@indutny ... any feedback before I land?

@jasnell

Copy link
Copy Markdown
Member

@indutny ... ping?

shigeki pushed a commit that referenced this pull request Nov 5, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell

Copy link
Copy Markdown
Member

Landed in 017fc5b

@jasnelljasnell closed this Nov 5, 2015
@Fishrock123Fishrock123 mentioned this pull request Nov 6, 2015
shigeki pushed a commit that referenced this pull request Nov 7, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
@Fishrock123Fishrock123 mentioned this pull request Nov 11, 2015
shigeki pushed a commit that referenced this pull request Nov 16, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins

Copy link
Copy Markdown
Contributor

landed in lts-v4.x-staging as 4a94c0a

shigeki pushed a commit that referenced this pull request Dec 4, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnelljasnell mentioned this pull request Dec 17, 2015
shigeki pushed a commit that referenced this pull request Dec 17, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
shigeki pushed a commit that referenced this pull request Dec 23, 2015
Add description of user responsibility in the choice of cypto
algorithms and its key length. Some of recommendations for the safer
use are also described.
PR-URL: #3479
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@shigeki@jasnell@MylesBorins@brendanashworth@thinred