class-email-delivery.php — Admin and Site Enhancements (ASE) 8.6.2

admin-site-enhancements / classes / class-email-delivery.php

admin-site-enhancements / classes Last commit date

class-email-delivery.php

399 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	use WP_Error;
6	use ASENHA\EmailDelivery\Email_Log_Table;
7	/**
8	* Class for Email Delivery module
9	*
10	* @since 6.9.5
11	*/
12	class Email_Delivery {
13	const SMTP_PASSWORD_PREFIX = 'asenha_encrypted::smtp_password::v1::';
14
15	const SMTP_PASSWORD_STATUS_EMPTY = 'empty';
16
17	const SMTP_PASSWORD_STATUS_LEGACY_PLAINTEXT = 'legacy_plaintext';
18
19	const SMTP_PASSWORD_STATUS_ENCRYPTED_VALID = 'encrypted_valid';
20
21	const SMTP_PASSWORD_STATUS_ENCRYPTED_INVALID = 'encrypted_invalid';
22
23	private $log_entry_id;
24
25	/**
26	* Derive a stable encryption key for the stored SMTP password.
27	*
28	* @since 8.4.3
29	*
30	* @return string
31	*/
32	private function get_smtp_password_encryption_key() {
33	return hash( 'sha256', \wp_salt( 'auth' ) . \wp_salt( 'secure_auth' ) . 'asenha_smtp_password', true );
34	}
35
36	/**
37	* Check whether the current environment can encrypt/decrypt the SMTP password.
38	*
39	* @since 8.4.3
40	*
41	* @return bool
42	*/
43	private function can_handle_smtp_password_encryption() {
44	return function_exists( 'openssl_encrypt' ) && function_exists( 'openssl_decrypt' ) && function_exists( 'openssl_cipher_iv_length' ) && function_exists( 'random_bytes' );
45	}
46
47	/**
48	* Check whether the stored SMTP password value is encrypted.
49	*
50	* @since 8.4.3
51	*
52	* @param string $stored_password Stored option value.
53	* @return bool
54	*/
55	public function is_smtp_password_encrypted( $stored_password ) {
56	return is_string( $stored_password ) && 0 === strpos( $stored_password, self::SMTP_PASSWORD_PREFIX );
57	}
58
59	/**
60	* Encrypt SMTP password for storage in options.
61	*
62	* @since 8.4.3
63	*
64	* @param string $password SMTP password.
65	* @return string Encrypted payload or empty string on failure.
66	*/
67	public function encrypt_smtp_password( $password ) {
68	if ( '' === $password ) {
69	return '';
70	}
71	if ( !$this->can_handle_smtp_password_encryption() ) {
72	return '';
73	}
74	$cipher = 'AES-256-CBC';
75	$key = $this->get_smtp_password_encryption_key();
76	$iv_len = openssl_cipher_iv_length( $cipher );
77	if ( false === $iv_len ) {
78	return '';
79	}
80	try {
81	$iv = random_bytes( $iv_len );
82	} catch ( \Exception $exception ) {
83	return '';
84	}
85	$ciphertext_raw = openssl_encrypt(
86	$password,
87	$cipher,
88	$key,
89	OPENSSL_RAW_DATA,
90	$iv
91	);
92	if ( false === $ciphertext_raw ) {
93	return '';
94	}
95	$hmac = hash_hmac(
96	'sha256',
97	$ciphertext_raw,
98	$key,
99	true
100	);
101	return self::SMTP_PASSWORD_PREFIX . base64_encode( $iv . $hmac . $ciphertext_raw );
102	}
103
104	/**
105	* Decrypt stored SMTP password.
106	*
107	* @since 8.4.3
108	*
109	* @param string $stored_password Stored option value.
110	* @return string\|false
111	*/
112	public function decrypt_smtp_password( $stored_password ) {
113	if ( !$this->is_smtp_password_encrypted( $stored_password ) ) {
114	return false;
115	}
116	if ( !$this->can_handle_smtp_password_encryption() ) {
117	return false;
118	}
119	$payload = substr( $stored_password, strlen( self::SMTP_PASSWORD_PREFIX ) );
120	$decoded = base64_decode( $payload, true );
121	if ( false === $decoded ) {
122	return false;
123	}
124	$cipher = 'AES-256-CBC';
125	$key = $this->get_smtp_password_encryption_key();
126	$iv_len = openssl_cipher_iv_length( $cipher );
127	if ( false === $iv_len \|\| strlen( $decoded ) <= $iv_len + 32 ) {
128	return false;
129	}
130	$iv = substr( $decoded, 0, $iv_len );
131	$stored_hmac = substr( $decoded, $iv_len, 32 );
132	$ciphertext_raw = substr( $decoded, $iv_len + 32 );
133	$calc_hmac = hash_hmac(
134	'sha256',
135	$ciphertext_raw,
136	$key,
137	true
138	);
139	if ( !hash_equals( $stored_hmac, $calc_hmac ) ) {
140	return false;
141	}
142	return openssl_decrypt(
143	$ciphertext_raw,
144	$cipher,
145	$key,
146	OPENSSL_RAW_DATA,
147	$iv
148	);
149	}
150
151	/**
152	* Get the current storage status of the SMTP password.
153	*
154	* @since 8.4.3
155	*
156	* @param string\|null $stored_password Stored option value.
157	* @return string
158	*/
159	public function get_smtp_password_status( $stored_password = null ) {
160	if ( null === $stored_password ) {
161	$options = get_option( ASENHA_SLUG_U, array() );
162	$stored_password = ( isset( $options['smtp_password'] ) ? $options['smtp_password'] : '' );
163	}
164	if ( empty( $stored_password ) ) {
165	return self::SMTP_PASSWORD_STATUS_EMPTY;
166	}
167	if ( $this->is_smtp_password_encrypted( $stored_password ) ) {
168	return ( false !== $this->decrypt_smtp_password( $stored_password ) ? self::SMTP_PASSWORD_STATUS_ENCRYPTED_VALID : self::SMTP_PASSWORD_STATUS_ENCRYPTED_INVALID );
169	}
170	return self::SMTP_PASSWORD_STATUS_LEGACY_PLAINTEXT;
171	}
172
173	/**
174	* Resolve SMTP password for runtime delivery use.
175	*
176	* Legacy plaintext remains supported as a migration fallback until the
177	* settings are re-saved and rewritten to the encrypted format.
178	*
179	* @since 8.4.3
180	*
181	* @param string\|null $stored_password Stored option value.
182	* @return string
183	*/
184	public function get_smtp_password_for_runtime( $stored_password = null ) {
185	if ( null === $stored_password ) {
186	$options = get_option( ASENHA_SLUG_U, array() );
187	$stored_password = ( isset( $options['smtp_password'] ) ? $options['smtp_password'] : '' );
188	}
189	switch ( $this->get_smtp_password_status( $stored_password ) ) {
190	case self::SMTP_PASSWORD_STATUS_ENCRYPTED_VALID:
191	$decrypted_password = $this->decrypt_smtp_password( $stored_password );
192	return ( false !== $decrypted_password ? $decrypted_password : '' );
193	case self::SMTP_PASSWORD_STATUS_LEGACY_PLAINTEXT:
194	return (string) $stored_password;
195	default:
196	return '';
197	}
198	}
199
200	/**
201	* Get message shown when the stored SMTP password can no longer be used.
202	*
203	* @since 8.4.3
204	*
205	* @return string
206	*/
207	public function get_smtp_password_reentry_message() {
208	return __( 'The stored SMTP password can no longer be decrypted. Please enter it again and save changes.', 'admin-site-enhancements' );
209	}
210
211	/**
212	* Send emails using external SMTP service
213	*
214	* @since 4.6.0
215	*/
216	public function deliver_email_via_smtp( $phpmailer ) {
217	$options = get_option( ASENHA_SLUG_U, array() );
218	$smtp_host = $options['smtp_host'];
219	$smtp_port = $options['smtp_port'];
220	$smtp_security = $options['smtp_security'];
221	$smtp_authentication = ( isset( $options['smtp_authentication'] ) ? $options['smtp_authentication'] : 'enable' );
222	$smtp_username = $options['smtp_username'];
223	$smtp_password = ( isset( $options['smtp_password'] ) ? $options['smtp_password'] : '' );
224	$smtp_default_from_name = $options['smtp_default_from_name'];
225	$smtp_default_from_email = $options['smtp_default_from_email'];
226	$smtp_force_from = $options['smtp_force_from'];
227	$smtp_bypass_ssl_verification = $options['smtp_bypass_ssl_verification'];
228	$smtp_debug = $options['smtp_debug'];
229	// Do nothing if host or password is empty
230	// if ( empty( $smtp_host ) \|\| empty( $smtp_password ) ) {
231	// return;
232	// }
233	// Maybe override FROM email and/or name if the sender is "WordPress <wordpress@sitedomain.com>", the default from WordPress core and not yet overridden by another plugin.
234	$from_name = $phpmailer->FromName;
235	$from_email_beginning = substr( $phpmailer->From, 0, 9 );
236	// Get the first 9 characters of the current FROM email
237	if ( $smtp_force_from ) {
238	$phpmailer->FromName = $smtp_default_from_name;
239	$phpmailer->From = $smtp_default_from_email;
240	// WP 6.9: set SMTP envelope (MAIL FROM) using PHPMailer::Sender only.
241	// PHPMailer maintainers treat envelope bounce handling as Sender, not a separate ReturnPath property;
242	// receiving MTAs derive Return-Path from the envelope sender.
243	// Ref: https://make.wordpress.org/core/2025/11/18/more-reliable-email-in-wordpress-6-9/
244	$phpmailer->Sender = $smtp_default_from_email;
245	} else {
246	if ( 'WordPress' === $from_name && !empty( $smtp_default_from_name ) ) {
247	$phpmailer->FromName = $smtp_default_from_name;
248	}
249	if ( 'wordpress' === $from_email_beginning && !empty( $smtp_default_from_email ) ) {
250	$phpmailer->From = $smtp_default_from_email;
251	// WP 6.9: set SMTP envelope (MAIL FROM) using PHPMailer::Sender only.
252	// PHPMailer maintainers treat envelope bounce handling as Sender, not a separate ReturnPath property;
253	// receiving MTAs derive Return-Path from the envelope sender.
254	// Ref: https://make.wordpress.org/core/2025/11/18/more-reliable-email-in-wordpress-6-9/
255	$phpmailer->Sender = $smtp_default_from_email;
256	}
257	}
258	$smtp_password = $this->get_smtp_password_for_runtime( $smtp_password );
259	// Only attempt to send via SMTP if all the required info is present. Otherwise, use default PHP Mailer settings as set by wp_mail()
260	if ( !empty( $smtp_host ) && !empty( $smtp_port ) && !empty( $smtp_security ) ) {
261	// Send using SMTP
262	$phpmailer->isSMTP();
263	// phpcs:ignore
264	if ( 'enable' == $smtp_authentication ) {
265	$phpmailer->SMTPAuth = true;
266	// phpcs:ignore
267	} else {
268	$phpmailer->SMTPAuth = false;
269	// phpcs:ignore
270	}
271	// Set some other defaults
272	// $phpmailer->CharSet = 'utf-8'; // phpcs:ignore
273	$phpmailer->XMailer = 'Admin and Site Enhancements v' . ASENHA_VERSION . ' - a WordPress plugin';
274	// phpcs:ignore
275	$phpmailer->Host = $smtp_host;
276	// phpcs:ignore
277	$phpmailer->Port = $smtp_port;
278	// phpcs:ignore
279	$phpmailer->SMTPSecure = $smtp_security;
280	// phpcs:ignore
281	if ( 'enable' == $smtp_authentication ) {
282	$phpmailer->Username = trim( $smtp_username );
283	// phpcs:ignore
284	$phpmailer->Password = trim( $smtp_password );
285	// phpcs:ignore
286	}
287	}
288	// If verification of SSL certificate is bypassed
289	// Reference: https://www.php.net/manual/en/context.ssl.php & https://stackoverflow.com/a/30803024
290	if ( $smtp_bypass_ssl_verification ) {
291	$phpmailer->SMTPOptions = [
292	'ssl' => [
293	'verify_peer' => false,
294	'verify_peer_name' => false,
295	'allow_self_signed' => true,
296	],
297	];
298	}
299	// If debug mode is enabled, send debug info (SMTP::DEBUG_CONNECTION) to WordPress debug.log file set in wp-config.php
300	// Reference: https://github.com/PHPMailer/PHPMailer/wiki/SMTP-Debugging
301	if ( $smtp_debug ) {
302	$phpmailer->SMTPDebug = 4;
303	//phpcs:ignore
304	$phpmailer->Debugoutput = 'error_log';
305	//phpcs:ignore
306	}
307	}
308
309	/**
310	* Send a test email and use SMTP host if defined in settings
311	*
312	* @since 5.3.0
313	*/
314	public function send_test_email() {
315	if ( isset( $_REQUEST['email_to'] ) && isset( $_REQUEST['nonce'] ) && current_user_can( 'manage_options' ) ) {
316	if ( wp_verify_nonce( sanitize_text_field( $_REQUEST['nonce'] ), 'send-test-email-nonce_' . get_current_user_id() ) ) {
317	$options = get_option( ASENHA_SLUG_U, array() );
318	$smtp_host = ( isset( $options['smtp_host'] ) ? $options['smtp_host'] : '' );
319	$smtp_port = ( isset( $options['smtp_port'] ) ? $options['smtp_port'] : '' );
320	$smtp_security = ( isset( $options['smtp_security'] ) ? $options['smtp_security'] : '' );
321	$smtp_authentication = ( isset( $options['smtp_authentication'] ) ? $options['smtp_authentication'] : 'enable' );
322	$smtp_password = ( isset( $options['smtp_password'] ) ? $options['smtp_password'] : '' );
323	$smtp_password_status = $this->get_smtp_password_status( $smtp_password );
324	$smtp_is_configured = !empty( $smtp_host ) && !empty( $smtp_port ) && !empty( $smtp_security );
325	if ( $smtp_is_configured && 'enable' === $smtp_authentication && self::SMTP_PASSWORD_STATUS_ENCRYPTED_INVALID === $smtp_password_status ) {
326	wp_send_json( array(
327	'status' => 'failed',
328	'message' => $this->get_smtp_password_reentry_message(),
329	) );
330	}
331	$content = array(
332	array(
333	'title' => 'Hey... are you getting this?',
334	'body' => '<p><strong>Looks like you did!</strong></p>',
335	),
336	array(
337	'title' => 'There\'s a message for you...',
338	'body' => '<p><strong>Here it is:</strong></p>',
339	),
340	array(
341	'title' => 'Is it working?',
342	'body' => '<p><strong>Yes, it\'s working!</strong></p>',
343	),
344	array(
345	'title' => 'Hope you\'re getting this...',
346	'body' => '<p><strong>Looks like this was sent out just fine and you got it.</strong></p>',
347	),
348	array(
349	'title' => 'Testing delivery configuration...',
350	'body' => '<p><strong>Everything looks good!</strong></p>',
351	),
352	array(
353	'title' => 'Testing email delivery',
354	'body' => '<p><strong>Looks good!</strong></p>',
355	),
356	array(
357	'title' => 'Config is looking good',
358	'body' => '<p><strong>Seems like everything has been set up properly!</strong></p>',
359	),
360	array(
361	'title' => 'All set up',
362	'body' => '<p><strong>Your configuration is working properly.</strong></p>',
363	),
364	array(
365	'title' => 'Good to go',
366	'body' => '<p><strong>Config is working great.</strong></p>',
367	),
368	array(
369	'title' => 'Good job',
370	'body' => '<p><strong>Everything is set.</strong></p>',
371	)
372	);
373	$random_number = rand( 0, count( $content ) - 1 );
374	$to = sanitize_email( wp_unslash( $_REQUEST['email_to'] ) );
375	$title = $content[$random_number]['title'];
376	$body = $content[$random_number]['body'] . '<p>This message was sent from <a href="' . get_bloginfo( 'url' ) . '">' . get_bloginfo( 'url' ) . '</a> on ' . wp_date( 'F j, Y' ) . ' at ' . wp_date( 'H:i:s' ) . ' via ASE.</p>';
377	$headers = array('Content-Type: text/html; charset=UTF-8');
378	$success = wp_mail(
379	$to,
380	$title,
381	$body,
382	$headers
383	);
384	if ( $success ) {
385	$response = array(
386	'status' => 'success',
387	);
388	} else {
389	$response = array(
390	'status' => 'failed',
391	);
392	}
393	wp_send_json( $response );
394	}
395	}
396	}
397
398	}
399