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: add docs detailing the sequence before/after Read()/Write() during TLS handshake #36128

Open
martindg opened this issue Dec 13, 2019 · 1 comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone

Comments

@martindg
Copy link

martindg commented Dec 13, 2019

What version of Go are you using (go version)?

$ go version
go version go1.13.5 linux/amd64

Does this issue reproduce with the latest release?

Yes.

What did you expect to see?

Documentation (e.g. for Listen()) telling that actual TLS handshake would only occur after Read(), Write() or explicit call to Handshake() as described here:

// explicitly: the first Read or Write will call it automatically.

What did you see instead?

Explicit information only in the Handshake() documentation:

// explicitly: the first Read or Write will call it automatically.

@toothrot toothrot changed the title crypto/tls Documentation lacking info on the TLS handshake before Read()/Write() crypto/tls: Documentation lacking info on the TLS handshake before Read()/Write() Dec 13, 2019
@toothrot toothrot added this to the Backlog milestone Dec 13, 2019
@toothrot toothrot added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Dec 13, 2019
@toothrot
Copy link
Contributor

toothrot commented Dec 13, 2019

/cc @FiloSottile @katiehockman

@odeke-em odeke-em changed the title crypto/tls: Documentation lacking info on the TLS handshake before Read()/Write() crypto/tls: add docs detailing the sequence before/after Read()/Write() during TLS handshake Dec 14, 2019
@FiloSottile FiloSottile self-assigned this Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Development

No branches or pull requests

4 participants