Skip to content

crypto/tls: document the different ClientAuthTypes #34023

Description

@mholt

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.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues describing a change to documentation.FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions