Add package comment and comments for exported variables and functions…

… in sni package.
sibalma · Sep 4, 2023 · 57b547a · 57b547a
1 parent a94bcc1
commit 57b547a
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/go.mod b/go.mod
@@ -58,7 +58,7 @@ require (
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/srwiley/oksvg v0.0.0-20220731023508-a61f04f16b76 // indirect
 	github.com/srwiley/rasterx v0.0.0-20210519020934-456a8d69b780 // indirect
-	github.com/stretchr/testify v1.8.3 // indirect
+	github.com/stretchr/testify v1.8.4 // indirect
 	github.com/subosito/gotenv v1.4.2 // indirect
 	github.com/tevino/abool v1.2.0 // indirect
 	github.com/v2pro/plz v0.0.0-20221028024117-e5f9aec5b631 // indirect

diff --git a/go.sum b/go.sum
@@ -358,6 +358,8 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
 github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/subosito/gotenv v1.4.2 h1:X1TuBLAMDFbaTAChgCBLu3DU3UPyELpnF2jjJ2cz/S8=
 github.com/subosito/gotenv v1.4.2/go.mod h1:ayKnFf/c6rvx/2iiLrJUk1e6plDbT3edrFNGqEflhK0=

diff --git a/sni/http.go b/sni/http.go
@@ -1,3 +1,5 @@
+// Package sni provides functionality for parsing the first HTTP request on a connection
+// and returning metadata for virtual host muxing.
 package sni
 
 import (

diff --git a/sni/tls.go b/sni/tls.go
@@ -1,3 +1,4 @@
+// Package sni provides functionality for handling Server Name Indication (SNI) in TLS connections.
 package sni
 
 import (
@@ -24,7 +25,7 @@ const (
 
 // TLS extension numbers
 var (
-	extensionServerName      uint16 = 0
+	extensionServerName      uint16
 	extensionStatusRequest   uint16 = 5
 	extensionSupportedCurves uint16 = 10
 	extensionSupportedPoints uint16 = 11
@@ -202,11 +203,14 @@ func ReadClientHello(rd io.Reader) (*ClientHelloMsg, error) {
 	return msg, nil
 }
 
+// ClientHelloMsg represents a TLS ClientHello message. It contains various fields
+// that store information about the client's hello message during a TLS handshake.
 type ClientHelloMsg struct {
+	// Raw contains the raw bytes of the ClientHello message.
 	Raw                []byte
 	Versions           uint16
 	Random             []byte
-	SessionId          []byte
+	SessionID          []byte
 	CipherSuites       []uint16
 	CompressionMethods []uint8
 	NextProtoNeg       bool
@@ -225,12 +229,12 @@ func (m *ClientHelloMsg) unmarshal(data []byte) bool {
 	m.Raw = data
 	m.Versions = uint16(data[4])<<8 | uint16(data[5])
 	m.Random = data[6:38]
-	sessionIdLen := int(data[38])
-	if sessionIdLen > 32 || len(data) < 39+sessionIdLen {
+	sessionIDLen := int(data[38])
+	if sessionIDLen > 32 || len(data) < 39+sessionIDLen {
 		return false
 	}
-	m.SessionId = data[39 : 39+sessionIdLen]
-	data = data[39+sessionIdLen:]
+	m.SessionID = data[39 : 39+sessionIDLen]
+	data = data[39+sessionIDLen:]
 	if len(data) < 2 {
 		return false
 	}