109 commits

Author	SHA1	Message	Date
Winni Neessen	569e8fbc70	Fix typos in comments for better readability ... Corrected spelling errors in comments for "challenge" and "compatibility" to improve clarity. This ensures better understanding and adherence to the documented IETF draft standard.	2024-10-16 10:35:29 +02:00
Winni Neessen	3234c13277	Add tests for SetLogAuthData method ... Introduced TestClient_SetLogAuthData to verify the proper behavior of the SetLogAuthData method in both client and SMTP tests. This ensures that logAuthData is enabled or disabled as expected, increasing code reliability.	2024-10-15 20:02:24 +02:00
Winni Neessen	55a5d02fe0	Add support for configurable SMTP auth data logging ... Added the `logAuthData` flag to enable conditional logging of SMTP authentication data. Introduced the `SetLogAuthData` method for clients to toggle this flag. Adjusted existing logging logic to respect this new configuration.	2024-10-15 19:52:31 +02:00
Winni Neessen	7acfe8015d	Redact authentication logs ... Add a boolean flag `authIsActive` to manage redaction of sensitive authentication information in debug logs. When this flag is true, authentication details are replaced with `<auth redacted>`.	2024-10-12 20:53:58 +02:00
Winni Neessen	476130d6e3	Fumpt files to make golangci-lint happy	2024-10-05 11:43:50 +02:00
Winni Neessen	159c1bf850	Add tests for new tls and connection handling methods ... This commit introduces tests for various TLS-related methods such as GetTLSConnectionState, HasConnection, SetDSNMailReturnOption, SetDSNRcptNotifyOption, and UpdateDeadline. It also modifies the error handling logic in smtp.go to include new error types and improves the mutex handling in UpdateDeadline.	2024-10-05 10:55:25 +02:00
Winni Neessen	9163943684	Add isConnected flag to track active connection state ... Introduced the isConnected boolean flag in the Client struct to clearly indicate whether there is an active connection. Updated relevant methods to set this flag accordingly, ensuring consistent state management across the Client's lifecycle.	2024-10-05 10:15:43 +02:00
Winni Neessen	adcb8ac41d	Fix connection handling and improve thread-safety in SMTP client ... Reset connections to nil after Close, add RLock in HasConnection, and refine Close logic to handle already closed connections gracefully. Enhanced DialWithContext documentation and added tests for double-close scenarios to ensure robustness.	2024-10-04 23:15:01 +02:00
Winni Neessen	711ce2ac65	Add support for SCRAM-SHA-1-PLUS and SCRAM-SHA-256-PLUS ... Extended SMTP tests to include SCRAM-SHA-1-PLUS and SCRAM-SHA-256-PLUS authentication mechanisms. Adjusted the `startSMTPServer` function to accept a hashing function and modified the server logic to handle TLS channel binding.	2024-10-04 18:31:58 +02:00
Winni Neessen	4c8c0d855e	Handle read errors in SMTP authentication flow ... Add checks to handle errors when reading client messages. This ensures that an appropriate error message is sent back to the client if reading fails, improving the robustness of the SMTP authentication process.	2024-10-03 12:38:39 +02:00
Winni Neessen	03062c5183	Add SCRAM-SHA authentication tests for SMTP ... Introduce new unit tests to verify SCRAM-SHA-1 and SCRAM-SHA-256 authentication for the SMTP client. These tests cover both successful and failing authentication cases, and include a mock SMTP server to facilitate testing.	2024-10-03 12:32:06 +02:00
Winni Neessen	a8e89a1258	Add support for SCRAM-SHA authentication mechanisms ... Introduced new test cases for SCRAM-SHA-1, SCRAM-SHA-256, and their PLUS variants in `smtp_test.go`. Updated the authTest structure to include a `hasNonce` flag and implemented logic to handle nonce validation and success message processing.	2024-10-02 18:02:46 +02:00
Winni Neessen	e4dd62475a	Improve error handling in SCRAM-SHA-X-PLUS authentication ... Refactor error return to include more specific information and add a check for TLS connection state in SCRAM-SHA-X-PLUS authentication flow. This ensures clearer error messages and verifies essential prerequisites for secure authentication.	2024-10-02 18:02:34 +02:00
Winni Neessen	580981b158	Refactor error handling in SMTP authentication ... Centralized error definitions in `smtp/auth.go` and updated references in `auth_login.go` and `auth_plain.go`. This improves code maintainability and error consistency across the package.	2024-10-02 18:02:23 +02:00
Winni Neessen	9d70283af9	Reset response step in AUTH LOGIN initialization ... The addition of `a.respStep = 0` resets the response step counter at the beginning of the AUTH LOGIN process. This ensures that the state starts correctly and avoids potential issues related to residual values from previous authentications.	2024-10-02 13:09:55 +02:00
Winni Neessen	93752280aa	Update smtp_test.go to add more authentication test cases ... Enhanced the LoginAuth test coverage by adding new scenarios with different sequences and invalid cases. This ensures more robust validation and better handling of edge cases in authentication testing.	2024-10-02 12:54:32 +02:00
Winni Neessen	547f78dbee	Enhance SMTP LOGIN auth and add comprehensive tests ... Refactored SMTP LOGIN auth to improve compatibility with various server responses, consolidating error handling and response steps. Added extensive tests to verify successful and failed authentication across different server configurations.	2024-10-02 12:37:54 +02:00
Winni Neessen	f823112a4d	Refactor: consolidate ErrNonTLSConnection variable ... The variable ErrNonTLSConnection has been simplified from a multi-line declaration to a single-line declaration. This increases code readability and maintains consistency with Go conventions.	2024-10-01 20:32:41 +02:00
Winni Neessen	15b9ddf067	Refactor error handling for non-TLS SMTP connections ... Introduce a global error variable for non-TLS connections and update corresponding error handling across the codebase. This enhances readability and maintainability of the error management logic.	2024-10-01 17:23:29 +02:00
Winni Neessen	bcf7084982	Add detailed documentation comments for SCRAM methods ... Enhanced code readability and maintainability by adding comprehensive documentation comments to all methods and struct definitions in the `smtp/auth_scram.go` file. This improves clarity on the functionality and usage of the SCRAM (Salted Challenge Response Authentication Mechanism) methods and structures.	2024-10-01 16:39:13 +02:00
Winni Neessen	3013975c6a	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.	2024-10-01 15:27:31 +02:00
Winni Neessen	738f43e289	Add GetTLSConnectionState method to SMTP client ... Introduce a method to retrieve the TLS connection state of the client's current connection. This method checks if the connection uses TLS and is established, returning appropriate errors otherwise.	2024-10-01 11:05:42 +02:00
Winni Neessen	e8fc6cd78f	Add SCRAM-SHA support to SMTP authentication ... Introduced additional SMTP authentication mechanisms: SCRAM-SHA-1, SCRAM-SHA-1-PLUS, SCRAM-SHA-256, and SCRAM-SHA-256-PLUS. Added corresponding error messages for unsupported authentication types. This enhances security options for SMTP connections.	2024-10-01 11:04:01 +02:00
Winni Neessen	8791ce5a33	Fix deferred mutex unlock in TLSConnectionState ... Correct the sequence of mutex unlocking in TLSConnectionState to ensure the mutex is always released properly. This prevents potential deadlocks and ensures the function behaves as expected in a concurrent context.	2024-09-27 17:00:07 +02:00
Winni Neessen	6bd9a9c735	Refactor mutex usage for connection safety ... This commit revises locking mechanism usage around connection operations to avoid potential deadlocks and improve code clarity. Specifically, defer statements were removed and explicit unlocks were added to ensure that mutexes are properly released after critical sections. This change affects several methods, including `Close`, `cmd`, `TLSConnectionState`, `UpdateDeadline`, and newly introduced locking for concurrent data writes and reads in `dataCloser`.	2024-09-27 14:03:26 +02:00
Winni Neessen	fdb80ad9dd	Add mutex to Client for thread-safe operations ... This commit introduces a RWMutex to the Client struct in the smtp package to ensure thread-safe access to shared resources. Critical sections in methods like Close, StartTLS, and cmd are now protected with appropriate locking mechanisms. This change helps prevent potential race conditions, ensuring consistent and reliable behavior in concurrent environments.	2024-09-27 11:10:23 +02:00
Winni Neessen	371b950bc7	Refactor Client struct for better readability and organization ... Reordered and grouped fields in the Client struct for clarity. The reorganization separates logical groups of fields, making it easier to understand and maintain the code. This includes proper grouping of TLS parameters, DSN options, and debug settings.	2024-09-27 10:33:19 +02:00
Winni Neessen	3871b2be44	Lock client connections and update deadline handling ... Add mutex locking for client connections to ensure thread safety. Introduce `HasConnection` method to check active connections and `UpdateDeadline` method to handle timeout updates. Refactor connection handling in `checkConn` and `tls` methods accordingly.	2024-09-26 11:51:30 +02:00
Winni Neessen	fd115d5173	Remove typo from comment in smtp_ehlo_117.go ... Fixed a typo in the backward compatibility comment for Go 1.16/1.17 in smtp_ehlo_117.go. This ensures clarity and correctness in documentation.	2024-09-23 14:15:43 +02:00
李盼庚	647ff86b29	Support lowercase username and password challenge	2024-08-16 15:46:16 +08:00
Winni Neessen	071ad66035	Sync with upstream ... This PR syncs our smtp package with the upstream `net/smtp` changes introduced via bf91eb3a8b	2024-05-24 18:50:27 +02:00
Winni Neessen	07783d24e5	Update format string in Debugf method calls in tests ... The format string for the Debugf method calls within the smtp_test.go file have been updated. Previously, the format string was empty, but it has now been changed to "%s" to align with the standard formatting expectations, improving the correctness of the tests.	2024-04-06 17:13:45 +02:00
Winni Neessen	7a549242ae	Update Go version and clean up SMTP test suite ... The Go version has been updated to 1.22 in the .golangci.toml file for compatibility reasons. Additionally, unnecessary white space has been removed from the smtp/smtp_test.go file to maximize code efficiency and readability.	2024-02-08 16:51:25 +01:00
Winni Neessen	5dbb1e6dde	Refine function comments to include return type details ... This is a sync with the net/smtp upstream as committed here: 1d45a7ef56 (diff-4f6f6bdb9891d4dd271f9f31430420a2e44018fe4ee539576faf458bebb3cee4).	2024-01-10 11:05:34 +01:00
James Elliott	a73a914fb2	feat(smtp): auth login extension draft support ... This adds support for the auth login extension draft.	2024-01-07 13:34:33 +11:00
Winni Neessen	1c5c1e318c	#136: Refactor logging for clearer messaging direction ... The logging system in the smtp.go and log package has been refactored. A new custom log type `Log` was introduced, that includes the message direction, format and arguments. The `Logger` interface and the `Stdlog` implementation were modified to accept this new type. This change provides a clearer understanding of message direction inside logs, allowing for easier debugging and reduced complexity. This change does not affect features or disrupt user functionality. Additionally, it allows for custom implementations of the log.Logger interface to without being forced to use the C --> S/C <-- S direction logging.	2023-08-02 11:43:45 +02:00
Nicola Murino	61b9e59dd2	oauth2: add more test cases	2023-06-04 10:47:19 +02:00
Winni Neessen	438cfd60eb	Preparation for the v0.4.0 release: ... - Bump version in doc.go - Add sonarlint to .gitignore - Update README to reflect the changes and contributors - Fixed typos in auth_cram_md5_118.go, msg.go, msg_test.go, reader.go and smtp_ehlo_117.go	2023-05-31 09:34:45 +02:00
Nicola Murino	2a67b397c7	OAuth2: don't send the "*" command to cancel authentication ... XOAUTH2 does not follow the SMTP AUTH RFC	2023-05-29 18:21:24 +02:00
Nicola Murino	8673addaf0	OAuth2: remove variants ... Microsoft also accept the same protocol used for Google servers	2023-05-29 18:19:01 +02:00
Nicola Murino	6e4b348ccf	add Oauth2 support ... fixes #129	2023-05-28 14:31:04 +02:00
Winni Neessen	912797c782	#126: sync upstream changes to net/smtp ... Related: https://github.com/golang/go/issues/58141 Resolves #126	2023-04-12 09:54:26 +02:00
Winni Neessen	13d0add21c	#121: Remove defer from for loops ... Fixes #121. `defer` in for loops can possibly lead to leaks. The whole handling including the defer are now moved into anonymous functions outside the for loop and are called form the loop instead. This way the defer is handle when the inline function finishes	2023-03-15 18:42:25 +01:00
Winni Neessen	44dce70c46	#119 make golangci-lint happy again ... Since we are Go <1.20 compatible, we can't easily combine errors here. The suggested golangci-lint fix will not work neither, since the %w verb can't be used twice. Therefore, for now we will ignore the linting error Closes #119	2023-03-11 10:48:14 +01:00
Winni Neessen	6633591b51	Implement Logger interface ... As stated in https://github.com/wneessen/go-mail/pull/102#issuecomment-1411956040 it would be beneficial if, instead of forcing the Go stdlib logger on the user to provide a simple interface and use that for logging purposes. This PR implements this simple log.Logger interface as well as a standard logger that satisfies this interface. If no custom logger is provided, the Stdlog will be used (which makes use of the Go stdlib again). Accordingly, a `Client.WithLogger` and `Client.SetLogger` have been implemented. Same applies for the smtp counterparts.	2023-02-03 10:19:26 +01:00
Winni Neessen	63d8cef8ca	Refactor DSN handling from client.go to smtp.go ... This PR refactors the the DSN (RFC 1891) SMTP client handling, that was introduced in f4cdc61dd0. While most of the Client options stay the same, the whole workaround logic for the SMTP client has been removed and added as part of the SMTP client instead. This was we got rid of the Client's own `mail()`, `rcpt()`, `dsnRcpt()`, `dsnMail()` methods as well as the copies of the `cmd()` and `validateLine()` methods. The Client is now using the proper `Mail()` and `Rcpt()` methods of the SMTP client instead.	2023-01-18 10:30:06 +01:00
Winni Neessen	3922d3f195	Switched copyright header from me to "The go-mail Authors"	2023-01-15 16:14:19 +01:00
Winni Neessen	ccbab59207	Fix log direction string	2023-01-14 13:07:42 +01:00
Winni Neessen	e36511e90e	Fix tests to not log authentication data ... We don't want to expose SMTP authentication details in tests, therefore the tests have been adjusted a bit	2023-01-14 13:05:04 +01:00
Winni Neessen	34b432a985	Implement debug logging in SMTP client ... Resolves #101. Since we now have full control over the SMTP client we can also access the message input and output. This PR introduces a new debug logging feature. Via the `Client.WithDebugLog` the user can enable this feature. It will then make use of the new `smtp/Client.SetDebugLog` method. Once the flag is set to true, the SMTP client will start logging incoming and outgoing messages to os.Stderr. Log directions will be output accordingly	2023-01-14 12:47:51 +01:00
Winni Neessen	2950f222cf	Added backport comments as reference	2023-01-13 17:42:05 +01:00
Winni Neessen	8559e8c301	Re-introduce backwards compatibility with Go 1.17 and Go 1.18 ... The following changes make use of methods that are not available in Go 1.17/Go 1.18. To guarantee at least 4 versions of backwards compatibility, versioned copies of those changes have been back-ported: - 4d8db00641 (diff-4f6f6bdb9891d4dd271f9f31430420a2e44018fe4ee539576faf458bebb3cee4) - 58158e990f (diff-772fc9f5d0c86f26e35158fb3e7a71a4967d18b4ec23a5dbb60781ab0babf426)	2023-01-13 17:34:41 +01:00
Winni Neessen	7cb34856a3	Adjusting license headers and including original LICENSE file from the Go project into the smtp/ directory as suggested in https://github.com/wneessen/go-mail/issues/97#issuecomment-1381046444	2023-01-13 16:54:55 +01:00
Winni Neessen	820d1c25d8	Fork net/smpt into go-mail ... Implemented negative check for AuthLogin Auth method	2023-01-11 20:35:22 +01:00
Winni Neessen	df7bb9b742	Fork net/smpt into go-mail ... Fix open TODO in smtp_test.go and fork `testenv.SkipFlaky()` from `internal/testenv` to implement flaky test skipping for FBSD	2023-01-11 20:07:03 +01:00
Winni Neessen	8e807c2569	Fork net/smpt into go-mail ... Fixed open issues in smtp_test.go	2023-01-11 15:28:33 +01:00
Winni Neessen	1836f6c49d	Start fixing golangci-lint findings in test suite	2023-01-10 16:55:47 +01:00
Winni Neessen	a804e4a101	Fix license SPDX headers for forked net/smtp code ... - Also import the original BSD-3-Clause.txt license from the Go team into the LICENSES directory - Further on, license headers should hold "The go-mail Authors" instead of my name. Did this already for the MIT license.	2023-01-10 10:09:45 +01:00
Winni Neessen	0d6777ab39	Fork net/smpt into go-mail ... As part of #97 we are going to fork the official `net/smtp` package into go-mail to provide us with more flexibility. This commit fulfills the first big step of importing the package into smtp/. Also go-mail's own LoginAuth has been moved from auth/ into smtp/ to be consistent with the stdlib. There are still a couple of open issues (i. e. license adjustments and making golangci-lint happy) but so far all tests already work, which is a good start.	2023-01-10 00:38:42 +01:00