blob: a6ab8587b4b0a988deb768db23c2901d8e128311 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
2 * SSL client demonstration program
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7
Bence Szépkútic662b362021-05-27 11:25:03 +02008#include "mbedtls/build_info.h"
Paul Bakker5121ce52009-01-03 21:22:43 +00009
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000010#include "mbedtls/platform.h"
Rich Evansf90016a2015-01-19 14:26:37 +000011
Gilles Peskine7985d452024-09-04 16:06:10 +020012#if !defined(MBEDTLS_ENTROPY_C) || !defined(MBEDTLS_CTR_DRBG_C) || \
13 !defined(MBEDTLS_NET_C) || !defined(MBEDTLS_SSL_CLI_C) || \
14 !defined(MBEDTLS_PEM_PARSE_C) || !defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010015int main(void)
Paul Bakker5690efc2011-05-26 13:16:06 +000016{
Gilles Peskine7985d452024-09-04 16:06:10 +020017 mbedtls_printf("MBEDTLS_ENTROPY_C and/or MBEDTLS_CTR_DRBG_C and/or "
18 "MBEDTLS_NET_C and/or MBEDTLS_SSL_CLI_C and/or "
19 "MBEDTLS_PEM_PARSE_C and/or MBEDTLS_X509_CRT_PARSE_C "
Gilles Peskine449bd832023-01-11 14:50:10 +010020 "not defined.\n");
21 mbedtls_exit(0);
Paul Bakker5690efc2011-05-26 13:16:06 +000022}
23#else
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010024
Andres AG788aa4a2016-09-14 14:32:09 +010025#include "mbedtls/net_sockets.h"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010026#include "mbedtls/debug.h"
27#include "mbedtls/ssl.h"
28#include "mbedtls/entropy.h"
29#include "mbedtls/ctr_drbg.h"
30#include "mbedtls/error.h"
Mateusz Starzyk1aec6462021-02-08 15:34:42 +010031#include "test/certs.h"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010032
33#include <string.h>
34
Manuel Pégourié-Gonnardc0d74942015-06-23 12:30:57 +020035#define SERVER_PORT "4433"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010036#define SERVER_NAME "localhost"
37#define GET_REQUEST "GET / HTTP/1.0\r\n\r\n"
38
39#define DEBUG_LEVEL 1
40
Simon Butcher63cb97e2018-12-06 17:43:31 +000041
Gilles Peskine449bd832023-01-11 14:50:10 +010042static void my_debug(void *ctx, int level,
43 const char *file, int line,
44 const char *str)
Paul Bakker9a97c5d2013-09-15 17:07:33 +020045{
Paul Bakkerc73079a2014-04-25 16:34:30 +020046 ((void) level);
47
Gilles Peskine449bd832023-01-11 14:50:10 +010048 mbedtls_fprintf((FILE *) ctx, "%s:%04d: %s", file, line, str);
49 fflush((FILE *) ctx);
Paul Bakker9a97c5d2013-09-15 17:07:33 +020050}
51
Gilles Peskine449bd832023-01-11 14:50:10 +010052int main(void)
Paul Bakker5121ce52009-01-03 21:22:43 +000053{
Andres Amaya Garcia55172022018-04-29 20:53:53 +010054 int ret = 1, len;
55 int exit_code = MBEDTLS_EXIT_FAILURE;
Manuel Pégourié-Gonnard5db64322015-06-30 15:40:39 +020056 mbedtls_net_context server_fd;
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +020057 uint32_t flags;
Paul Bakker5121ce52009-01-03 21:22:43 +000058 unsigned char buf[1024];
Paul Bakkeref3f8c72013-06-24 13:01:08 +020059 const char *pers = "ssl_client1";
Paul Bakker508ad5a2011-12-04 17:09:26 +000060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061 mbedtls_entropy_context entropy;
62 mbedtls_ctr_drbg_context ctr_drbg;
63 mbedtls_ssl_context ssl;
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +020064 mbedtls_ssl_config conf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065 mbedtls_x509_crt cacert;
Paul Bakker5121ce52009-01-03 21:22:43 +000066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010068 mbedtls_debug_set_threshold(DEBUG_LEVEL);
Paul Bakkerc73079a2014-04-25 16:34:30 +020069#endif
70
Przemek Stekiela0a1c1e2023-04-17 11:10:05 +020071 /*
72 * 0. Initialize the RNG and the session data
73 */
74 mbedtls_net_init(&server_fd);
75 mbedtls_ssl_init(&ssl);
76 mbedtls_ssl_config_init(&conf);
77 mbedtls_x509_crt_init(&cacert);
78 mbedtls_ctr_drbg_init(&ctr_drbg);
79 mbedtls_entropy_init(&entropy);
80
Przemek Stekiel89c636e2023-04-14 09:26:39 +020081 psa_status_t status = psa_crypto_init();
82 if (status != PSA_SUCCESS) {
83 mbedtls_fprintf(stderr, "Failed to initialize PSA Crypto implementation: %d\n",
84 (int) status);
85 goto exit;
86 }
Przemek Stekiel89c636e2023-04-14 09:26:39 +020087
Gilles Peskine449bd832023-01-11 14:50:10 +010088 mbedtls_printf("\n . Seeding the random number generator...");
89 fflush(stdout);
Paul Bakker508ad5a2011-12-04 17:09:26 +000090
Przemek Stekiela0a1c1e2023-04-17 11:10:05 +020091
Gilles Peskine449bd832023-01-11 14:50:10 +010092 if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy,
93 (const unsigned char *) pers,
94 strlen(pers))) != 0) {
95 mbedtls_printf(" failed\n ! mbedtls_ctr_drbg_seed returned %d\n", ret);
Paul Bakker508ad5a2011-12-04 17:09:26 +000096 goto exit;
97 }
98
Gilles Peskine449bd832023-01-11 14:50:10 +010099 mbedtls_printf(" ok\n");
Paul Bakker508ad5a2011-12-04 17:09:26 +0000100
Paul Bakker5121ce52009-01-03 21:22:43 +0000101 /*
Paul Bakker75242c32012-11-17 00:03:46 +0100102 * 0. Initialize certificates
103 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 mbedtls_printf(" . Loading the CA root certificate ...");
105 fflush(stdout);
Paul Bakker75242c32012-11-17 00:03:46 +0100106
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 ret = mbedtls_x509_crt_parse(&cacert, (const unsigned char *) mbedtls_test_cas_pem,
108 mbedtls_test_cas_pem_len);
109 if (ret < 0) {
110 mbedtls_printf(" failed\n ! mbedtls_x509_crt_parse returned -0x%x\n\n",
111 (unsigned int) -ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100112 goto exit;
113 }
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 mbedtls_printf(" ok (%d skipped)\n", ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100116
117 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 * 1. Start the connection
119 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 mbedtls_printf(" . Connecting to tcp/%s/%s...", SERVER_NAME, SERVER_PORT);
121 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000122
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 if ((ret = mbedtls_net_connect(&server_fd, SERVER_NAME,
124 SERVER_PORT, MBEDTLS_NET_PROTO_TCP)) != 0) {
125 mbedtls_printf(" failed\n ! mbedtls_net_connect returned %d\n\n", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +0000126 goto exit;
127 }
128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 mbedtls_printf(" ok\n");
Paul Bakker5121ce52009-01-03 21:22:43 +0000130
131 /*
132 * 2. Setup stuff
133 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 mbedtls_printf(" . Setting up the SSL/TLS structure...");
135 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000136
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 if ((ret = mbedtls_ssl_config_defaults(&conf,
138 MBEDTLS_SSL_IS_CLIENT,
139 MBEDTLS_SSL_TRANSPORT_STREAM,
140 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
141 mbedtls_printf(" failed\n ! mbedtls_ssl_config_defaults returned %d\n\n", ret);
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200142 goto exit;
143 }
144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 mbedtls_printf(" ok\n");
Paul Bakker5121ce52009-01-03 21:22:43 +0000146
Manuel Pégourié-Gonnardfcf2fc22014-03-11 11:10:27 +0100147 /* OPTIONAL is not optimal for security,
148 * but makes interop easier in this simplified example */
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 mbedtls_ssl_conf_authmode(&conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
150 mbedtls_ssl_conf_ca_chain(&conf, &cacert, NULL);
151 mbedtls_ssl_conf_rng(&conf, mbedtls_ctr_drbg_random, &ctr_drbg);
152 mbedtls_ssl_conf_dbg(&conf, my_debug, stdout);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200153
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 if ((ret = mbedtls_ssl_setup(&ssl, &conf)) != 0) {
155 mbedtls_printf(" failed\n ! mbedtls_ssl_setup returned %d\n\n", ret);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200156 goto exit;
157 }
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 if ((ret = mbedtls_ssl_set_hostname(&ssl, SERVER_NAME)) != 0) {
160 mbedtls_printf(" failed\n ! mbedtls_ssl_set_hostname returned %d\n\n", ret);
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +0100161 goto exit;
162 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000163
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 mbedtls_ssl_set_bio(&ssl, &server_fd, mbedtls_net_send, mbedtls_net_recv, NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +0000165
Paul Bakker5121ce52009-01-03 21:22:43 +0000166 /*
Paul Bakker75242c32012-11-17 00:03:46 +0100167 * 4. Handshake
168 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 mbedtls_printf(" . Performing the SSL/TLS handshake...");
170 fflush(stdout);
Paul Bakker75242c32012-11-17 00:03:46 +0100171
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 while ((ret = mbedtls_ssl_handshake(&ssl)) != 0) {
173 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
174 mbedtls_printf(" failed\n ! mbedtls_ssl_handshake returned -0x%x\n\n",
175 (unsigned int) -ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100176 goto exit;
177 }
178 }
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 mbedtls_printf(" ok\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100181
182 /*
183 * 5. Verify the server certificate
184 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 mbedtls_printf(" . Verifying peer X.509 certificate...");
Paul Bakker75242c32012-11-17 00:03:46 +0100186
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100187 /* In real life, we probably want to bail out when ret != 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 if ((flags = mbedtls_ssl_get_verify_result(&ssl)) != 0) {
Hanno Becker612a2f12020-10-09 09:19:39 +0100189#if !defined(MBEDTLS_X509_REMOVE_INFO)
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100190 char vrfy_buf[512];
Peter Kolbus9a969b62018-12-11 13:55:56 -0600191#endif
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 mbedtls_printf(" failed\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100194
Hanno Becker612a2f12020-10-09 09:19:39 +0100195#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 mbedtls_x509_crt_verify_info(vrfy_buf, sizeof(vrfy_buf), " ! ", flags);
Paul Bakker75242c32012-11-17 00:03:46 +0100197
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 mbedtls_printf("%s\n", vrfy_buf);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600199#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 } else {
201 mbedtls_printf(" ok\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100202 }
Paul Bakker75242c32012-11-17 00:03:46 +0100203
204 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000205 * 3. Write the GET request
206 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 mbedtls_printf(" > Write to server:");
208 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000209
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 len = sprintf((char *) buf, GET_REQUEST);
Paul Bakker5121ce52009-01-03 21:22:43 +0000211
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 while ((ret = mbedtls_ssl_write(&ssl, buf, len)) <= 0) {
213 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
214 mbedtls_printf(" failed\n ! mbedtls_ssl_write returned %d\n\n", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +0000215 goto exit;
216 }
217 }
218
219 len = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100220 mbedtls_printf(" %d bytes written\n\n%s", len, (char *) buf);
Paul Bakker5121ce52009-01-03 21:22:43 +0000221
222 /*
223 * 7. Read the HTTP response
224 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 mbedtls_printf(" < Read from server:");
226 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 do {
229 len = sizeof(buf) - 1;
230 memset(buf, 0, sizeof(buf));
231 ret = mbedtls_ssl_read(&ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +0000232
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
Paul Bakker5121ce52009-01-03 21:22:43 +0000234 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000236
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
Gilles Peskine6959f532024-08-27 12:17:22 +0200238 mbedtls_printf("The return value %d from mbedtls_ssl_read() means that the server\n"
239 "closed the connection first. We're ok with that.\n",
240 MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY);
Paul Bakker5121ce52009-01-03 21:22:43 +0000241 break;
242 }
243
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (ret < 0) {
245 mbedtls_printf("failed\n ! mbedtls_ssl_read returned %d\n\n", ret);
246 break;
247 }
248
249 if (ret == 0) {
250 mbedtls_printf("\n\nEOF\n\n");
Paul Bakker61da7522011-11-11 10:28:58 +0000251 break;
252 }
253
Paul Bakker5121ce52009-01-03 21:22:43 +0000254 len = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 mbedtls_printf(" %d bytes read\n\n%s", len, (char *) buf);
256 } while (1);
Paul Bakker5121ce52009-01-03 21:22:43 +0000257
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 mbedtls_ssl_close_notify(&ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +0000259
Gilles Peskine6959f532024-08-27 12:17:22 +0200260 if (ret == 0 || ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
261 exit_code = MBEDTLS_EXIT_SUCCESS;
262 }
Andres Amaya Garcia55172022018-04-29 20:53:53 +0100263
Paul Bakker5121ce52009-01-03 21:22:43 +0000264exit:
265
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266#ifdef MBEDTLS_ERROR_C
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (exit_code != MBEDTLS_EXIT_SUCCESS) {
Paul Bakkera3d195c2011-11-27 21:07:34 +0000268 char error_buf[100];
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_strerror(ret, error_buf, 100);
270 mbedtls_printf("Last error was: %d - %s\n\n", ret, error_buf);
Paul Bakkera3d195c2011-11-27 21:07:34 +0000271 }
272#endif
273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 mbedtls_net_free(&server_fd);
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 mbedtls_x509_crt_free(&cacert);
276 mbedtls_ssl_free(&ssl);
277 mbedtls_ssl_config_free(&conf);
278 mbedtls_ctr_drbg_free(&ctr_drbg);
279 mbedtls_entropy_free(&entropy);
Przemek Stekiela8c560a2023-04-19 10:15:26 +0200280 mbedtls_psa_crypto_free();
Paul Bakker5121ce52009-01-03 21:22:43 +0000281
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 mbedtls_exit(exit_code);
Paul Bakker5121ce52009-01-03 21:22:43 +0000283}
Gilles Peskine7985d452024-09-04 16:06:10 +0200284
285#endif /* configuration allows running this program */