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

DOCS: Improve documentation of the EVP_PKEY type #13629

Closed
wants to merge 4 commits into from

Conversation

levitte
Copy link
Member

@levitte levitte commented Dec 7, 2020

This type was previously described in a note, which is hard to find
unless you already know where to look.

This change makes the description more prominent, and allows indexing
by adding it in the NAMES section.

The EVP_PKEY description is altered to conceptually allow an EVP_PKEY
to contain a private key without a corresponding public key. This is
related to an OTC vote:

https://mta.openssl.org/pipermail/openssl-project/2020-December/002474.html

The description of EVP_PKEY for MAC purposes is amended to fit.

@levitte levitte added branch: master Merge to master branch approval: review pending This pull request needs review by a committer labels Dec 7, 2020
@levitte
Copy link
Member Author

levitte commented Dec 7, 2020

This PR is only about changing the documentation of EVP_PKEY itself. Diverse implementation changes, which is also part of what was voted on, should happen in separate PR(s?).

@t8m
Copy link
Member

t8m commented Dec 8, 2020

doc-nits failure seems relevant

@levitte
Copy link
Member Author

levitte commented Dec 8, 2020

doc-nits failure seems relevant

Fixed

@levitte
Copy link
Member Author

levitte commented Dec 8, 2020

doc-nits failure seems relevant

I missed a detail. NOW it should be fixed

This type was previously described in a note, which is hard to find
unless you already know where to look.

This change makes the description more prominent, and allows indexing
by adding it in the NAMES section.

The EVP_PKEY description is altered to conceptually allow an EVP_PKEY
to contain a private key without a corresponding public key.  This is
related to an OTC vote:

https://mta.openssl.org/pipermail/openssl-project/2020-December/002474.html

The description of EVP_PKEY for MAC purposes is amended to fit.
@levitte
Copy link
Member Author

levitte commented Dec 9, 2020

CIs are happy

@levitte
Copy link
Member Author

levitte commented Dec 11, 2020

Ping?

Copy link
Member

@beldmit beldmit left a comment

Choose a reason for hiding this comment

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

LGTM

@beldmit beldmit added approval: done This pull request has the required number of approvals and removed approval: review pending This pull request needs review by a committer labels Dec 11, 2020
@openssl-machine openssl-machine removed the approval: done This pull request has the required number of approvals label Dec 12, 2020
@openssl-machine
Copy link
Collaborator

This pull request is ready to merge

@openssl-machine openssl-machine added the approval: ready to merge The 24 hour grace period has passed, ready to merge label Dec 12, 2020
@levitte
Copy link
Member Author

levitte commented Dec 12, 2020

Merged

68e9125 DOCS: Improve documentation of the EVP_PKEY type

@levitte levitte closed this Dec 12, 2020
@levitte levitte deleted the describe-EVP_PKEY branch December 12, 2020 23:25
openssl-machine pushed a commit that referenced this pull request Dec 12, 2020
This type was previously described in a note, which is hard to find
unless you already know where to look.

This change makes the description more prominent, and allows indexing
by adding it in the NAMES section.

The EVP_PKEY description is altered to conceptually allow an EVP_PKEY
to contain a private key without a corresponding public key.  This is
related to an OTC vote:

https://mta.openssl.org/pipermail/openssl-project/2020-December/002474.html

The description of EVP_PKEY for MAC purposes is amended to fit.

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from #13629)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approval: ready to merge The 24 hour grace period has passed, ready to merge branch: master Merge to master branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants