Skip to content

doc: document key encryption options - #23632

Closed
tniessen wants to merge 4 commits into
nodejs:masterfrom
tniessen:doc-document-keygen-encryption
Closed

doc: document key encryption options#23632
tniessen wants to merge 4 commits into
nodejs:masterfrom
tniessen:doc-document-keygen-encryption

Conversation

@tniessen

Copy link
Copy Markdown
Member

There is very little documentation on the supported encryption options. This should be enough for most use cases.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-botnodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Oct 12, 2018
Comment threaddoc/api/crypto.md Outdated
@thefourtheye

Copy link
Copy Markdown
Contributor

/ping @nodejs/crypto

Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/crypto.md Outdated
@bnoordhuis

Copy link
Copy Markdown
Member

@tniessen Do you plan to follow up? This looks good to go once you incorporate the review feedback.

@tniessen
tniessenforce-pushed the doc-document-keygen-encryption branch from 061ba26 to a94f159CompareNovember 19, 2018 20:24
@tniessen

Copy link
Copy Markdown
MemberAuthor

@nodejs/crypto @nodejs/documentation PTAL.

Comment threaddoc/api/crypto.md Outdated

@sam-githubsam-github left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Text is informative, and LGTM. I leave it to you to decide to address (or not) the comment on duplicate docs.

Comment threaddoc/api/crypto.md Outdated
@tniessen
tniessenforce-pushed the doc-document-keygen-encryption branch from a94f159 to 464b674CompareJanuary 4, 2019 14:28
@tniessen

Copy link
Copy Markdown
MemberAuthor

Thanks for reviewing and sorry about the long delay, I figured it made sense to wait until the key object API had been finalized. That also took care of the duplication you were worried about, @sam-github. I didn't change the text itself, I just moved it to keyObject.export.

Comment threaddoc/api/crypto.md Outdated
@tniessentniessen changed the title doc: document key pair generation encryptiondoc: document key encryption optionsJan 5, 2019
@tniessen

Copy link
Copy Markdown
MemberAuthor

Landed in 345d3f3, thanks for reviewing!

@tniessentniessen closed this Jan 5, 2019
addaleax pushed a commit that referenced this pull request Jan 5, 2019
PR-URL: #23632
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
PR-URL: nodejs#23632
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@BridgeARBridgeAR mentioned this pull request Jan 16, 2019
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
PR-URL: nodejs#23632
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Jan 24, 2019
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.

7 participants

@tniessen@nodejs-github-bot@thefourtheye@bnoordhuis@sam-github@mscdex@Trott