From 3013975c6af6122a915dc360a16eec90bdc498ac Mon Sep 17 00:00:00 2001
From: Winni Neessen <wn@neessen.net>
Date: Tue, 1 Oct 2024 15:27:31 +0200
Subject: [PATCH] Rename and refactor SCRAM authentication methods

Updated method names to more accurately reflect their authentication mechanisms (SCRAM-SHA-1, SCRAM-SHA-1-PLUS, SCRAM-SHA-256, SCRAM-SHA-256-PLUS). Revised corresponding comments to improve clarity and maintain consistency.
---
 smtp/auth_scram.go | 53 +++++++++++++++++++++++++++-------------------
 1 file changed, 31 insertions(+), 22 deletions(-)

diff --git a/smtp/auth_scram.go b/smtp/auth_scram.go
index 2b7f814..14308fa 100644
--- a/smtp/auth_scram.go
+++ b/smtp/auth_scram.go
@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: Copyright (c) 2023 The go-mail Authors
+// SPDX-FileCopyrightText: Copyright (c) 2024 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 
@@ -33,26 +33,8 @@ type scramAuth struct {
 	bindData                                    []byte
 }
 
-func ScramSHA256Auth(username, password string) Auth {
-	return &scramAuth{
-		username:  username,
-		password:  password,
-		algorithm: "SCRAM-SHA-256",
-		h:         sha256.New,
-	}
-}
-
-func ScramSHA256PlusAuth(username, password string, tlsConnState *tls.ConnectionState) Auth {
-	return &scramAuth{
-		username:     username,
-		password:     password,
-		algorithm:    "SCRAM-SHA-256-PLUS",
-		h:            sha256.New,
-		isPlus:       true,
-		tlsConnState: tlsConnState,
-	}
-}
-
+// ScramSHA1Auth creates and returns a new SCRAM-SHA-1 authentication mechanism with the given
+// username and password.
 func ScramSHA1Auth(username, password string) Auth {
 	return &scramAuth{
 		username:  username,
@@ -62,6 +44,19 @@ func ScramSHA1Auth(username, password string) Auth {
 	}
 }
 
+// ScramSHA256Auth creates and returns a new SCRAM-SHA-256 authentication mechanism with the given
+// username and password.
+func ScramSHA256Auth(username, password string) Auth {
+	return &scramAuth{
+		username:  username,
+		password:  password,
+		algorithm: "SCRAM-SHA-256",
+		h:         sha256.New,
+	}
+}
+
+// ScramSHA1PlusAuth returns an Auth instance configured for SCRAM-SHA-1-PLUS authentication with
+// the provided username, password, and TLS connection state.
 func ScramSHA1PlusAuth(username, password string, tlsConnState *tls.ConnectionState) Auth {
 	return &scramAuth{
 		username:     username,
@@ -73,11 +68,25 @@ func ScramSHA1PlusAuth(username, password string, tlsConnState *tls.ConnectionSt
 	}
 }
 
+// ScramSHA256PlusAuth returns an Auth instance configured for SCRAM-SHA-256-PLUS authentication with
+// the provided username, password, and TLS connection state.
+func ScramSHA256PlusAuth(username, password string, tlsConnState *tls.ConnectionState) Auth {
+	return &scramAuth{
+		username:     username,
+		password:     password,
+		algorithm:    "SCRAM-SHA-256-PLUS",
+		h:            sha256.New,
+		isPlus:       true,
+		tlsConnState: tlsConnState,
+	}
+}
+
+// Start initializes the SCRAM authentication process and returns the selected algorithm, nil data, and no error.
 func (a *scramAuth) Start(_ *ServerInfo) (string, []byte, error) {
-	fmt.Printf("algo: %s\n", a.algorithm)
 	return a.algorithm, nil, nil
 }
 
+// Next processes the server's challenge and returns the client's response for SCRAM authentication.
 func (a *scramAuth) Next(fromServer []byte, more bool) ([]byte, error) {
 	if more {
 		if len(fromServer) == 0 {