Add doc

relay/auth/allow_all.go

@@ -1,6 +1,7 @@
 package auth
 
 // AllowAllAuth is a Validator that allows all connections.
+// Used this for testing purposes only.
 type AllowAllAuth struct {
 }
 

relay/auth/doc.go

@@ -0,0 +1,26 @@
+/*
+Package auth manages the authentication process with the relay server.
+
+Key Components:
+
+Validator: The Validator interface defines the Validate method. Any type that provides this method can be used as a
+Validator.
+
+Methods:
+
+Validate(any): This method is defined in the Validator interface and is used to validate the authentication.
+
+Usage:
+
+To create a new AllowAllAuth validator, simply instantiate it:
+
+	validator := &auth.AllowAllAuth{}
+
+To validate the authentication, use the Validate method:
+
+	err := validator.Validate(any)
+
+This package provides a simple and effective way to manage authentication with the relay server, ensuring that the
+peers are authenticated properly.
+*/
+package auth

relay/auth/hmac/doc.go

@@ -0,0 +1,8 @@
+/*
+This package uses a similar HMAC method for authentication with the TURN server. The Management server provides the
+tokens for the peers. The peers manage these tokens in the token store. The token store is a simple thread safe store
+that keeps the tokens in memory. These tokens are used to authenticate the peers with the Relay server in the hello
+message.
+*/
+
+package hmac

relay/auth/hmac/token.go

@@ -43,6 +43,7 @@ type TimedHMAC struct {
 	timeToLive time.Duration
 }
 
+// NewTimedHMAC creates a new TimedHMAC instance
 func NewTimedHMAC(secret string, timeToLive time.Duration) *TimedHMAC {
 	return &TimedHMAC{
 		secret:     secret,
@@ -50,7 +51,8 @@ func NewTimedHMAC(secret string, timeToLive time.Duration) *TimedHMAC {
 	}
 }
 
-// GenerateToken generates new time-based secret token - basically Payload is a unix timestamp and Signature is a HMAC hash of a timestamp with a preshared TURN secret
+// GenerateToken generates new time-based secret token - basically Payload is a unix timestamp and Signature is a HMAC
+// hash of a timestamp with a preshared TURN secret
 func (m *TimedHMAC) GenerateToken() (*Token, error) {
 	timeAuth := time.Now().Add(m.timeToLive).Unix()
 	timeStamp := fmt.Sprint(timeAuth)
@@ -66,6 +68,7 @@ func (m *TimedHMAC) GenerateToken() (*Token, error) {
 	}, nil
 }
 
+// Validate checks if the token is valid
 func (m *TimedHMAC) Validate(token Token) error {
 	expectedMAC, err := m.generate(token.Payload)
 	if err != nil {

relay/auth/validator.go

@@ -1,5 +1,6 @@
 package auth
 
+// Validator is an interface that defines the Validate method.
 type Validator interface {
 	Validate(any) error
 }