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

doc: document key encryption options #23632

Closed

Conversation

tniessen
Copy link
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 nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Oct 12, 2018
doc/api/crypto.md Outdated Show resolved Hide resolved
@thefourtheye
Copy link
Contributor

/ping @nodejs/crypto

doc/api/crypto.md Outdated Show resolved Hide resolved
doc/api/crypto.md Outdated Show resolved Hide resolved
@bnoordhuis
Copy link
Member

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

@tniessen tniessen force-pushed the doc-document-keygen-encryption branch from 061ba26 to a94f159 Compare November 19, 2018 20:24
@tniessen
Copy link
Member Author

@nodejs/crypto @nodejs/documentation PTAL.

doc/api/crypto.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sam-github sam-github left a comment

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.

doc/api/crypto.md Outdated Show resolved Hide resolved
@tniessen tniessen force-pushed the doc-document-keygen-encryption branch from a94f159 to 464b674 Compare January 4, 2019 14:28
@tniessen
Copy link
Member Author

tniessen commented Jan 4, 2019

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.

doc/api/crypto.md Outdated Show resolved Hide resolved
@tniessen tniessen changed the title doc: document key pair generation encryption doc: document key encryption options Jan 5, 2019
@tniessen
Copy link
Member Author

tniessen commented Jan 5, 2019

Landed in 345d3f3, thanks for reviewing!

@tniessen tniessen closed this Jan 5, 2019
pull bot pushed a commit to zys-contrib/node that referenced this pull request Jan 5, 2019
PR-URL: nodejs#23632
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
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>
@BridgeAR BridgeAR 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>
@MylesBorins MylesBorins mentioned this pull request Jan 24, 2019
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants