From: Russ Cox <rsc@golang.org>
Date: Thu, 3 Oct 2013 01:40:01 +0000 (-0400)
Subject: crypto/tls: document ConnectionState fields
X-Git-Tag: go1.2rc2~85
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=95d85d90d8db0e90db5621035d35f02d41da959b;p=gostls13.git

crypto/tls: document ConnectionState fields

Fixes #6456.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/14289043
---

diff --git a/src/pkg/crypto/tls/common.go b/src/pkg/crypto/tls/common.go
index a9b25545df..d2e8fab092 100644
--- a/src/pkg/crypto/tls/common.go
+++ b/src/pkg/crypto/tls/common.go
@@ -136,20 +136,14 @@ var supportedSignatureAlgorithms = []signatureAndHash{
 
 // ConnectionState records basic TLS details about the connection.
 type ConnectionState struct {
-	HandshakeComplete          bool
-	DidResume                  bool
-	CipherSuite                uint16
-	NegotiatedProtocol         string
-	NegotiatedProtocolIsMutual bool
-
-	// ServerName contains the server name indicated by the client, if any.
-	// (Only valid for server connections.)
-	ServerName string
-
-	// the certificate chain that was presented by the other side
-	PeerCertificates []*x509.Certificate
-	// the verified certificate chains built from PeerCertificates.
-	VerifiedChains [][]*x509.Certificate
+	HandshakeComplete          bool                  // TLS handshake is complete
+	DidResume                  bool                  // connection resumes a previous TLS connection
+	CipherSuite                uint16                // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
+	NegotiatedProtocol         string                // negotiated next protocol (from Config.NextProtos)
+	NegotiatedProtocolIsMutual bool                  // negotiated protocol was advertised by server
+	ServerName                 string                // server name requested by client, if any (server side only)
+	PeerCertificates           []*x509.Certificate   // certificate chain presented by remote peer
+	VerifiedChains             [][]*x509.Certificate // verified chains built from PeerCertificates
 }
 
 // ClientAuthType declares the policy the server will follow for