81 commits

Author	SHA1	Message	Date
Winni Neessen	92ab51b13d	Add comprehensive tests for scramAuth error handling ... Introduce new test cases to validate the error handling of the scramAuth methods. These tests cover scenarios such as invalid characters in usernames, empty inputs, and edge cases like broken rand.Reader.	2024-11-09 00:06:33 +01:00
Winni Neessen	c6d416f142	Fix typo in the tls-unique channel binding comment ... Corrected "crypto/tl" to "crypto/tls" in the comment for better clarity and accuracy. This typo fix ensures that the code comments correctly reference the relevant Go package.	2024-11-08 23:05:31 +01:00
Winni Neessen	a1efa1a1ca	Remove redundant empty string check in SCRAM normalization ... The existing check for an empty normalized string is unnecessary because the OpaqueString profile in precis already throws an error if an empty string is returned: https://cs.opensource.google/go/x/text/+/master:secure/precis/profiles.go;l=66	2024-11-08 22:44:10 +01:00
Winni Neessen	d6f256c29e	Fix typo in error message in normalizeString function ... Corrected the spelling of "failed" in the error handling branch of the normalizeString function within smtp/auth_scram.go. This change addresses a minor typographical error to ensure the error message is clear and accurate.	2024-11-08 22:30:46 +01:00
Winni Neessen	d4c6cb506c	Add SCRAM authentication tests to smtp package ... Added comprehensive unit tests for SCRAM-SHA-1, SCRAM-SHA-256, and their PLUS variants. Implemented a test server to simulate various SCRAM authentication scenarios and validate both success and failure cases.	2024-11-08 16:53:09 +01:00
Winni Neessen	c656226fd3	Add XOAuth2 authentication tests to SMTP package ... Introduces two tests for XOAuth2 authentication in the SMTP package. The first test ensures successful authentication with valid credentials, while the second test verifies that authentication fails with incorrect settings.	2024-11-08 15:51:17 +01:00
Winni Neessen	1af17f14e1	Add cleanup to close client connections in tests ... This commit enhances the cleanup process in the SMTP tests by adding t.Cleanup to close client connections. Additionally, it rewrites the TestXOAuth2 function to include more detailed sub-tests, enhancing test granularity and readability.	2024-11-08 15:11:47 +01:00
Winni Neessen	b03fbb4ae8	Add test server for SMTP authentication ... Added a simple SMTP test server with basic features like PLAIN, LOGIN, and NOENC authentication. It can start, handle connections, and simulate authentication success or failure. Included support for TLS with a generated localhost certificate.	2024-11-07 22:42:23 +01:00
Winni Neessen	4221d48644	Update login authentication test cases in smtp_test.go ... Renamed the test functions and improved the test structure for login authentication checks. Added subtests to provide clear descriptions and enhance error checking.	2024-11-07 21:31:24 +01:00
Winni Neessen	410343496c	Refactor and expand TestLoginAuth ... Rename and uncomment TestLoginAuth with more test cases, ensuring coverage for successful and failed authentication scenarios, including checks for unencrypted logins and server response errors. This improves test robustness and coverage.	2024-11-07 21:14:52 +01:00
Winni Neessen	2391010e3a	Rename parameter for consistency in auth functions ... Updated the parameter name `allowUnEnc` to `allowUnenc` in both `LoginAuth` and `PlainAuth` functions to maintain consistent naming conventions. This change improves code readability and follows standard naming practices.	2024-11-07 20:58:20 +01:00
Winni Neessen	3cfd20576d	Rename and expand TestPlainAuth_noEnc with additional checks ... Refactor the test function `TestPlainAuth_noEnc` to include subtests for better organization and add more comprehensive error handling. This improves clarity and robustness by verifying various authentication scenarios and expected outcomes.	2024-11-03 16:13:54 +01:00
Winni Neessen	99c4378107	Refactor and streamline authentication tests ... Improved the structure and readability of the authentication tests by using subtests for each scenario, ensuring better isolation and clearer failure reporting. Removed unnecessary imports and redundant code, reducing complexity and enhancing maintainability.	2024-11-01 19:22:28 +01:00
Winni Neessen	8353b4b255	Follow upstream for HELO during Quit bug ... I reported the bug I fixed in 74fa3f6f62 to Go upstream. They fixed simpler by just ignoring the error (See: https://go.dev/cl/622476). We follow this patch accordingly. The upstream test has been adopted as well.	2024-10-25 09:33:45 +02:00
Winni Neessen	563ccbab4a	Fix typo in comment within Quit function ... Corrected grammar in a comment to enhance code readability and maintain consistency. This change does not affect the functionality of the `Quit` method.	2024-10-23 22:26:08 +02:00
Winni Neessen	74fa3f6f62	Fix Quit handling when initial HELO fails ... Ensure QUIT command can be sent even if initial HELO fails. Added a check to skip retrying HELO if it already failed, allowing for proper closing of the connection. This prevents potential hangs or errors during connection termination.	2024-10-23 21:54:06 +02:00
Winni Neessen	df1a141368	Handle client close errors in SMTP tests ... Update defer statements to log errors if client fails to close in smtp_test.go. Additionally, add a return statement to avoid further errors after a failed SendMail operation.	2024-10-22 16:02:43 +02:00
Winni Neessen	e2ed5b747a	Add tests for PlainAuth and LoginAuth without encryption ... Introduced new test functions TestAuthPlainNoEnc and TestAuthLoginNoEnc in smtp_test.go to verify behaviors of PlainAuth and LoginAuth without TLS encryption. These tests ensure that authentication mechanisms handle non-encrypted and diverse server configurations correctly.	2024-10-22 15:50:18 +02:00
Winni Neessen	2bd950469a	Add 'skipTLS' parameter to auth functions in tests ... Updated PlainAuth and LoginAuth calls in smtp_test.go and example_test.go to include a 'skipTLS' boolean parameter. This ensures consistent function signatures throughout the test cases and examples.	2024-10-22 15:44:40 +02:00
Winni Neessen	3c29f68cc1	Add support for unsecured SMTP LOGIN auth ... Implemented an option to allow SMTP LOGIN authentication over unencrypted channels by introducing a new `SMTPAuthLoginNoEnc` type. Updated relevant functions and tests to handle the new parameter for unsecured authentication.	2024-10-22 15:38:51 +02:00
Winni Neessen	f5531eae14	Add support for PLAIN authentication without encryption ... Implemented a new SMTPAuthPlainNoEnc option to allow PLAIN authentication over unencrypted connections. Refactored the PlainAuth function to accept an additional allowUnencryptedAuth parameter. Updated relevant tests to cover the new authentication method.	2024-10-22 15:30:15 +02:00
Winni Neessen	f120485c98	Correct typo in comment ... Fix a typo in smtp_test.go's comment from "challanges" to "challenges" to improve readability and accuracy of documentation. This change does not affect the code's functionality.	2024-10-16 10:37:13 +02:00
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