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

crypto/tls: document the different ClientAuthTypes #34023

Closed
mholt opened this issue Sep 2, 2019 · 2 comments
Closed

crypto/tls: document the different ClientAuthTypes #34023

mholt opened this issue Sep 2, 2019 · 2 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@mholt
Copy link

mholt commented Sep 2, 2019

The ClientAuthType constants are specified here: https://golang.org/pkg/crypto/tls/#ClientAuthType

It's sort of intuitive what they mean, but strangely they are lacking any godocs, unlike the rest of the package. In fact, I think they're the only values that are not documented (other than the protocol version consts, which don't really need docs IMO).

Even tls.Config.ClientAuth only has this for its godoc:

// ClientAuth determines the server's policy for
// TLS Client Authentication. The default is NoClientCert.

which does not explain what the different policies actually do.

Anyway, I was wondering if some clarification could be added as to exactly what these do.

Thanks for considering!

(Apologies that I'm not using the issue template in this case, as this is a minor issue that involves only documentation.)

@katiehockman katiehockman changed the title crypto/tls: Document the different ClientAuthTypes crypto/tls: document the different ClientAuthTypes Sep 3, 2019
@katiehockman katiehockman added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Sep 3, 2019
@katiehockman
Copy link
Contributor

/cc @FiloSottile

@FiloSottile FiloSottile added this to the Backlog milestone Jun 24, 2020
@FiloSottile FiloSottile added the NeedsFix The path to resolution is known, but the work has not been done. label Jun 24, 2020
@gopherbot gopherbot removed the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Jun 24, 2020
@gopherbot
Copy link

Change https://golang.org/cl/264027 mentions this issue: crypto/tls: document the ClientAuthType consts

@golang golang locked and limited conversation to collaborators Oct 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

5 participants