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

KDF documentation updates. #9905

Closed
wants to merge 5 commits into from
Closed

KDF documentation updates. #9905

wants to merge 5 commits into from

Conversation

@paulidale
Copy link
Contributor

paulidale commented Sep 15, 2019

Remove references to the control functions and replace them with the set param function.
Remove references to the new by ID function and use the new by name instead.

  • documentation is added or updated
  • tests are added or updated
Copy link
Member

levitte left a comment

There's a big difference between the API reference and pages describing different algorithm implementations accessible through that API. It seems, though, that this difference got confused along the way, and the reviewer was a bit blurry eyed...

doc/man7/EVP_KDF-HKDF.pod Outdated Show resolved Hide resolved
doc/man7/EVP_KDF-PBKDF2.pod Outdated Show resolved Hide resolved
doc/man7/EVP_KDF-SCRYPT.pod Outdated Show resolved Hide resolved
doc/man7/EVP_KDF-SS.pod Show resolved Hide resolved
doc/man7/EVP_KDF-SSHKDF.pod Show resolved Hide resolved
doc/man7/EVP_KDF-TLS1_PRF.pod Outdated Show resolved Hide resolved
doc/man7/EVP_KDF-X942.pod Show resolved Hide resolved
doc/man7/EVP_KDF-X963.pod Outdated Show resolved Hide resolved
@paulidale paulidale force-pushed the paulidale:kdf-docs branch from 5090ba5 to 4c21e93 Sep 16, 2019
@paulidale

This comment has been minimized.

Copy link
Contributor Author

paulidale commented Sep 16, 2019

All fixed. Also picked up an inconsistency in the PARAMETERS section naming which I've also addressed.

@paulidale

This comment has been minimized.

Copy link
Contributor Author

paulidale commented Sep 17, 2019

Ping?

Copy link
Member

levitte left a comment

Nit

doc/man7/EVP_KDF-HKDF.pod Outdated Show resolved Hide resolved
paulidale added 2 commits Sep 15, 2019
The EVP_KDF_ctrl function doesn't exist anymore and have been replaced by
EVP_KDF_CTX_set_params.

The EVP_KDF_new_id function doesn't exist either and EVP_KDF_new should be
used instead.
Remove reference to EVP_KDF_ctrl_str and replace it with EVP_KDF_CTX_set_params.

Add missing links, and specify two extra KDFs.
@paulidale paulidale force-pushed the paulidale:kdf-docs branch from 4c21e93 to b9651ba Sep 18, 2019
Copy link
Member

levitte left a comment

Another nit that I didn't see earlier

doc/man7/EVP_KDF-HKDF.pod Outdated Show resolved Hide resolved
@paulidale paulidale force-pushed the paulidale:kdf-docs branch from b9651ba to e3ff9ed Sep 18, 2019
levitte pushed a commit that referenced this pull request Sep 18, 2019
The EVP_KDF_ctrl function doesn't exist anymore and have been replaced by
EVP_KDF_CTX_set_params.

The EVP_KDF_new_id function doesn't exist either and EVP_KDF_new should be
used instead.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9905)
levitte pushed a commit that referenced this pull request Sep 18, 2019
Remove reference to EVP_KDF_ctrl_str and replace it with EVP_KDF_CTX_set_params.

Add missing links, and specify two extra KDFs.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9905)
levitte pushed a commit that referenced this pull request Sep 18, 2019
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9905)
levitte pushed a commit that referenced this pull request Sep 18, 2019
…ency.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9905)
levitte pushed a commit that referenced this pull request Sep 18, 2019
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9905)
@paulidale

This comment has been minimized.

Copy link
Contributor Author

paulidale commented Sep 18, 2019

Merged, thanks for the feedback.

@paulidale paulidale closed this Sep 18, 2019
@paulidale paulidale deleted the paulidale:kdf-docs branch Sep 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.