From 73d649e089de328b5ff66e72a71f353588b24640 Mon Sep 17 00:00:00 2001 From: Mingjie Shen Date: Tue, 5 Mar 2024 18:13:28 -0500 Subject: [PATCH 1/4] ssl_mail_client: Fix unbounded write of sprintf() These calls to sprintf may overflow buf because opt.mail_from and opt.mail_to are controlled by users. Fix by replacing sprintf with snprintf. Signed-off-by: Mingjie Shen --- programs/ssl/ssl_mail_client.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/programs/ssl/ssl_mail_client.c b/programs/ssl/ssl_mail_client.c index febb881c80..f26a23ba4f 100644 --- a/programs/ssl/ssl_mail_client.c +++ b/programs/ssl/ssl_mail_client.c @@ -727,7 +727,7 @@ usage: mbedtls_printf(" > Write MAIL FROM to server:"); fflush(stdout); - len = sprintf((char *) buf, "MAIL FROM:<%s>\r\n", opt.mail_from); + len = snprintf((char *) buf, sizeof(buf), "MAIL FROM:<%s>\r\n", opt.mail_from); ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -739,7 +739,7 @@ usage: mbedtls_printf(" > Write RCPT TO to server:"); fflush(stdout); - len = sprintf((char *) buf, "RCPT TO:<%s>\r\n", opt.mail_to); + len = snprintf((char *) buf, sizeof(buf), "RCPT TO:<%s>\r\n", opt.mail_to); ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -763,11 +763,12 @@ usage: mbedtls_printf(" > Write content to server:"); fflush(stdout); - len = sprintf((char *) buf, "From: %s\r\nSubject: Mbed TLS Test mail\r\n\r\n" - "This is a simple test mail from the " - "Mbed TLS mail client example.\r\n" - "\r\n" - "Enjoy!", opt.mail_from); + len = snprintf((char *) buf, sizeof(buf), + "From: %s\r\nSubject: Mbed TLS Test mail\r\n\r\n" + "This is a simple test mail from the " + "Mbed TLS mail client example.\r\n" + "\r\n" + "Enjoy!", opt.mail_from); ret = write_ssl_data(&ssl, buf, len); len = sprintf((char *) buf, "\r\n.\r\n"); From 6f216e4a737043c6c4a3cf4123bbcfeb54d71ffa Mon Sep 17 00:00:00 2001 From: Mingjie Shen Date: Tue, 12 Mar 2024 16:00:28 -0400 Subject: [PATCH 2/4] ssl_mail_client: Replace snprintf with mbedtls_snprintf Signed-off-by: Mingjie Shen --- programs/ssl/ssl_mail_client.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/programs/ssl/ssl_mail_client.c b/programs/ssl/ssl_mail_client.c index f26a23ba4f..ccd9dc9345 100644 --- a/programs/ssl/ssl_mail_client.c +++ b/programs/ssl/ssl_mail_client.c @@ -727,7 +727,7 @@ usage: mbedtls_printf(" > Write MAIL FROM to server:"); fflush(stdout); - len = snprintf((char *) buf, sizeof(buf), "MAIL FROM:<%s>\r\n", opt.mail_from); + len = mbedtls_snprintf((char *) buf, sizeof(buf), "MAIL FROM:<%s>\r\n", opt.mail_from); ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -739,7 +739,7 @@ usage: mbedtls_printf(" > Write RCPT TO to server:"); fflush(stdout); - len = snprintf((char *) buf, sizeof(buf), "RCPT TO:<%s>\r\n", opt.mail_to); + len = mbedtls_snprintf((char *) buf, sizeof(buf), "RCPT TO:<%s>\r\n", opt.mail_to); ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -763,7 +763,7 @@ usage: mbedtls_printf(" > Write content to server:"); fflush(stdout); - len = snprintf((char *) buf, sizeof(buf), + len = mbedtls_snprintf((char *) buf, sizeof(buf), "From: %s\r\nSubject: Mbed TLS Test mail\r\n\r\n" "This is a simple test mail from the " "Mbed TLS mail client example.\r\n" From 623812887a8259621ff2e6163826255d02f8ca49 Mon Sep 17 00:00:00 2001 From: Mingjie Shen Date: Tue, 12 Mar 2024 16:23:41 -0400 Subject: [PATCH 3/4] ssl_mail_client: Check return value of mbedtls_snprintf The return value of snprintf() is the number of characters (excluding the null terminator) which would have been written to the buffer if enough space had been available. Thus, a return value of size or more means the output was truncated. Signed-off-by: Mingjie Shen --- programs/ssl/ssl_mail_client.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/programs/ssl/ssl_mail_client.c b/programs/ssl/ssl_mail_client.c index ccd9dc9345..01d69d7b91 100644 --- a/programs/ssl/ssl_mail_client.c +++ b/programs/ssl/ssl_mail_client.c @@ -728,6 +728,10 @@ usage: fflush(stdout); len = mbedtls_snprintf((char *) buf, sizeof(buf), "MAIL FROM:<%s>\r\n", opt.mail_from); + if (len < 0 || (size_t)len >= sizeof(buf)) { + mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); + goto exit; + } ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -740,6 +744,10 @@ usage: fflush(stdout); len = mbedtls_snprintf((char *) buf, sizeof(buf), "RCPT TO:<%s>\r\n", opt.mail_to); + if (len < 0 || (size_t)len >= sizeof(buf)) { + mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); + goto exit; + } ret = write_ssl_and_get_response(&ssl, buf, len); if (ret < 200 || ret > 299) { mbedtls_printf(" failed\n ! server responded with %d\n\n", ret); @@ -769,6 +777,10 @@ usage: "Mbed TLS mail client example.\r\n" "\r\n" "Enjoy!", opt.mail_from); + if (len < 0 || (size_t)len >= sizeof(buf)) { + mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); + goto exit; + } ret = write_ssl_data(&ssl, buf, len); len = sprintf((char *) buf, "\r\n.\r\n"); From 41995bec9a69ac90628dcb2f12c7b9d96abd480e Mon Sep 17 00:00:00 2001 From: Mingjie Shen Date: Mon, 18 Mar 2024 14:30:06 -0400 Subject: [PATCH 4/4] ssl_mail_client: Fix code style issue Signed-off-by: Mingjie Shen --- programs/ssl/ssl_mail_client.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/programs/ssl/ssl_mail_client.c b/programs/ssl/ssl_mail_client.c index 01d69d7b91..e3ed697fad 100644 --- a/programs/ssl/ssl_mail_client.c +++ b/programs/ssl/ssl_mail_client.c @@ -728,7 +728,7 @@ usage: fflush(stdout); len = mbedtls_snprintf((char *) buf, sizeof(buf), "MAIL FROM:<%s>\r\n", opt.mail_from); - if (len < 0 || (size_t)len >= sizeof(buf)) { + if (len < 0 || (size_t) len >= sizeof(buf)) { mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); goto exit; } @@ -744,7 +744,7 @@ usage: fflush(stdout); len = mbedtls_snprintf((char *) buf, sizeof(buf), "RCPT TO:<%s>\r\n", opt.mail_to); - if (len < 0 || (size_t)len >= sizeof(buf)) { + if (len < 0 || (size_t) len >= sizeof(buf)) { mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); goto exit; } @@ -772,12 +772,12 @@ usage: fflush(stdout); len = mbedtls_snprintf((char *) buf, sizeof(buf), - "From: %s\r\nSubject: Mbed TLS Test mail\r\n\r\n" - "This is a simple test mail from the " - "Mbed TLS mail client example.\r\n" - "\r\n" - "Enjoy!", opt.mail_from); - if (len < 0 || (size_t)len >= sizeof(buf)) { + "From: %s\r\nSubject: Mbed TLS Test mail\r\n\r\n" + "This is a simple test mail from the " + "Mbed TLS mail client example.\r\n" + "\r\n" + "Enjoy!", opt.mail_from); + if (len < 0 || (size_t) len >= sizeof(buf)) { mbedtls_printf(" failed\n ! mbedtls_snprintf encountered error or truncated output\n\n"); goto exit; }