Skip to content

crypto/x509: Reference SubjectPublicKeyInfo in MarshalPKIXPublicKey #35313

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.

Sign up for GitHub

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

Jump to bottom
Closed
jsha opened this issue Nov 1, 2019 · 2 comments
Closed

crypto/x509: Reference SubjectPublicKeyInfo in MarshalPKIXPublicKey #35313

jsha opened this issue Nov 1, 2019 · 2 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.15

Comments

@jsha
Copy link

jsha commented Nov 1, 2019

The godoc for MarshalPKIXPublicKey and ParsePKIXPublicKey say, e.g. "ParsePKIXPublicKey parses a public key in PKIX, ASN.1 DER form." However, PKIX (RFC 5280), does not define a "public key" type. Instead, it defines a SubjectPublicKeyInfo type, which is what these methods are using. The docs should reference the more specific type name, and link straight to the RFC 5280 documentation for clarity.

As an aside, the ParseECPrivateKey docs incorrectly say "ParseECPrivateKey parses an EC public key".

If the Go team agrees this is a positive change, I'm happy to send a change.
@FiloSottile FiloSottile added Documentation Issues describing a change to documentation. help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Nov 5, 2019
@FiloSottile FiloSottile added this to the Go1.14 milestone Nov 5, 2019
@FiloSottile
Copy link
Contributor

Thanks, please do send a CL and add me as a reviewer.

@ianlancetaylor ianlancetaylor modified the milestones: Go1.14, Backlog Dec 5, 2019
@FiloSottile FiloSottile modified the milestones: Backlog, Go1.15 Mar 31, 2020
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/228778 mentions this issue: crypto/x509: clarify MarshalPKIXPublicKey and ParsePKIXPublicKey docs

@golang golang locked and limited conversation to collaborators Apr 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.15
Development

No branches or pull requests
5 participants
@jsha @FiloSottile @ianlancetaylor @gopherbot @katiehockman