blob: ee734b1ed1035744e163a11c1cdc7a554f82dc21 [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
Mateusz Starzyk1aec6462021-02-08 15:34:42 +010012#if !defined(MBEDTLS_BIGNUM_C) || !defined(MBEDTLS_ENTROPY_C) || \
13 !defined(MBEDTLS_SSL_TLS_C) || !defined(MBEDTLS_SSL_CLI_C) || \
14 !defined(MBEDTLS_NET_C) || !defined(MBEDTLS_RSA_C) || \
15 !defined(MBEDTLS_PEM_PARSE_C) || !defined(MBEDTLS_CTR_DRBG_C) || \
16 !defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010017int main(void)
Paul Bakker5690efc2011-05-26 13:16:06 +000018{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020019 mbedtls_printf("MBEDTLS_BIGNUM_C and/or MBEDTLS_ENTROPY_C and/or "
Gilles Peskine449bd832023-01-11 14:50:10 +010020 "MBEDTLS_SSL_TLS_C and/or MBEDTLS_SSL_CLI_C and/or "
21 "MBEDTLS_NET_C and/or MBEDTLS_RSA_C and/or "
22 "MBEDTLS_CTR_DRBG_C and/or MBEDTLS_X509_CRT_PARSE_C "
23 "not defined.\n");
24 mbedtls_exit(0);
Paul Bakker5690efc2011-05-26 13:16:06 +000025}
26#else
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010027
Andres AG788aa4a2016-09-14 14:32:09 +010028#include "mbedtls/net_sockets.h"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010029#include "mbedtls/debug.h"
30#include "mbedtls/ssl.h"
31#include "mbedtls/entropy.h"
32#include "mbedtls/ctr_drbg.h"
33#include "mbedtls/error.h"
Mateusz Starzyk1aec6462021-02-08 15:34:42 +010034#include "test/certs.h"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010035
36#include <string.h>
37
Manuel Pégourié-Gonnardc0d74942015-06-23 12:30:57 +020038#define SERVER_PORT "4433"
Manuel Pégourié-Gonnard4b3e5ef2015-03-27 11:24:27 +010039#define SERVER_NAME "localhost"
40#define GET_REQUEST "GET / HTTP/1.0\r\n\r\n"
41
42#define DEBUG_LEVEL 1
43
Simon Butcher63cb97e2018-12-06 17:43:31 +000044
Gilles Peskine449bd832023-01-11 14:50:10 +010045static void my_debug(void *ctx, int level,
46 const char *file, int line,
47 const char *str)
Paul Bakker9a97c5d2013-09-15 17:07:33 +020048{
Paul Bakkerc73079a2014-04-25 16:34:30 +020049 ((void) level);
50
Gilles Peskine449bd832023-01-11 14:50:10 +010051 mbedtls_fprintf((FILE *) ctx, "%s:%04d: %s", file, line, str);
52 fflush((FILE *) ctx);
Paul Bakker9a97c5d2013-09-15 17:07:33 +020053}
54
Gilles Peskine449bd832023-01-11 14:50:10 +010055int main(void)
Paul Bakker5121ce52009-01-03 21:22:43 +000056{
Andres Amaya Garcia55172022018-04-29 20:53:53 +010057 int ret = 1, len;
58 int exit_code = MBEDTLS_EXIT_FAILURE;
Manuel Pégourié-Gonnard5db64322015-06-30 15:40:39 +020059 mbedtls_net_context server_fd;
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +020060 uint32_t flags;
Paul Bakker5121ce52009-01-03 21:22:43 +000061 unsigned char buf[1024];
Paul Bakkeref3f8c72013-06-24 13:01:08 +020062 const char *pers = "ssl_client1";
Paul Bakker508ad5a2011-12-04 17:09:26 +000063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064 mbedtls_entropy_context entropy;
65 mbedtls_ctr_drbg_context ctr_drbg;
66 mbedtls_ssl_context ssl;
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +020067 mbedtls_ssl_config conf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020068 mbedtls_x509_crt cacert;
Paul Bakker5121ce52009-01-03 21:22:43 +000069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010071 mbedtls_debug_set_threshold(DEBUG_LEVEL);
Paul Bakkerc73079a2014-04-25 16:34:30 +020072#endif
73
Przemek Stekiela0a1c1e2023-04-17 11:10:05 +020074 /*
75 * 0. Initialize the RNG and the session data
76 */
77 mbedtls_net_init(&server_fd);
78 mbedtls_ssl_init(&ssl);
79 mbedtls_ssl_config_init(&conf);
80 mbedtls_x509_crt_init(&cacert);
81 mbedtls_ctr_drbg_init(&ctr_drbg);
82 mbedtls_entropy_init(&entropy);
83
Przemek Stekiel89c636e2023-04-14 09:26:39 +020084#if defined(MBEDTLS_USE_PSA_CRYPTO)
85 psa_status_t status = psa_crypto_init();
86 if (status != PSA_SUCCESS) {
87 mbedtls_fprintf(stderr, "Failed to initialize PSA Crypto implementation: %d\n",
88 (int) status);
89 goto exit;
90 }
91#endif /* MBEDTLS_USE_PSA_CRYPTO */
92
Gilles Peskine449bd832023-01-11 14:50:10 +010093 mbedtls_printf("\n . Seeding the random number generator...");
94 fflush(stdout);
Paul Bakker508ad5a2011-12-04 17:09:26 +000095
Przemek Stekiela0a1c1e2023-04-17 11:10:05 +020096
Gilles Peskine449bd832023-01-11 14:50:10 +010097 if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy,
98 (const unsigned char *) pers,
99 strlen(pers))) != 0) {
100 mbedtls_printf(" failed\n ! mbedtls_ctr_drbg_seed returned %d\n", ret);
Paul Bakker508ad5a2011-12-04 17:09:26 +0000101 goto exit;
102 }
103
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 mbedtls_printf(" ok\n");
Paul Bakker508ad5a2011-12-04 17:09:26 +0000105
Paul Bakker5121ce52009-01-03 21:22:43 +0000106 /*
Paul Bakker75242c32012-11-17 00:03:46 +0100107 * 0. Initialize certificates
108 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 mbedtls_printf(" . Loading the CA root certificate ...");
110 fflush(stdout);
Paul Bakker75242c32012-11-17 00:03:46 +0100111
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 ret = mbedtls_x509_crt_parse(&cacert, (const unsigned char *) mbedtls_test_cas_pem,
113 mbedtls_test_cas_pem_len);
114 if (ret < 0) {
115 mbedtls_printf(" failed\n ! mbedtls_x509_crt_parse returned -0x%x\n\n",
116 (unsigned int) -ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100117 goto exit;
118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 mbedtls_printf(" ok (%d skipped)\n", ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100121
122 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000123 * 1. Start the connection
124 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 mbedtls_printf(" . Connecting to tcp/%s/%s...", SERVER_NAME, SERVER_PORT);
126 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 if ((ret = mbedtls_net_connect(&server_fd, SERVER_NAME,
129 SERVER_PORT, MBEDTLS_NET_PROTO_TCP)) != 0) {
130 mbedtls_printf(" failed\n ! mbedtls_net_connect returned %d\n\n", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +0000131 goto exit;
132 }
133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 mbedtls_printf(" ok\n");
Paul Bakker5121ce52009-01-03 21:22:43 +0000135
136 /*
137 * 2. Setup stuff
138 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 mbedtls_printf(" . Setting up the SSL/TLS structure...");
140 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000141
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if ((ret = mbedtls_ssl_config_defaults(&conf,
143 MBEDTLS_SSL_IS_CLIENT,
144 MBEDTLS_SSL_TRANSPORT_STREAM,
145 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
146 mbedtls_printf(" failed\n ! mbedtls_ssl_config_defaults returned %d\n\n", ret);
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200147 goto exit;
148 }
149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 mbedtls_printf(" ok\n");
Paul Bakker5121ce52009-01-03 21:22:43 +0000151
Manuel Pégourié-Gonnardfcf2fc22014-03-11 11:10:27 +0100152 /* OPTIONAL is not optimal for security,
153 * but makes interop easier in this simplified example */
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 mbedtls_ssl_conf_authmode(&conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
155 mbedtls_ssl_conf_ca_chain(&conf, &cacert, NULL);
156 mbedtls_ssl_conf_rng(&conf, mbedtls_ctr_drbg_random, &ctr_drbg);
157 mbedtls_ssl_conf_dbg(&conf, my_debug, stdout);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 if ((ret = mbedtls_ssl_setup(&ssl, &conf)) != 0) {
160 mbedtls_printf(" failed\n ! mbedtls_ssl_setup returned %d\n\n", ret);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200161 goto exit;
162 }
163
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 if ((ret = mbedtls_ssl_set_hostname(&ssl, SERVER_NAME)) != 0) {
165 mbedtls_printf(" failed\n ! mbedtls_ssl_set_hostname returned %d\n\n", ret);
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +0100166 goto exit;
167 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 mbedtls_ssl_set_bio(&ssl, &server_fd, mbedtls_net_send, mbedtls_net_recv, NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +0000170
Paul Bakker5121ce52009-01-03 21:22:43 +0000171 /*
Paul Bakker75242c32012-11-17 00:03:46 +0100172 * 4. Handshake
173 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 mbedtls_printf(" . Performing the SSL/TLS handshake...");
175 fflush(stdout);
Paul Bakker75242c32012-11-17 00:03:46 +0100176
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 while ((ret = mbedtls_ssl_handshake(&ssl)) != 0) {
178 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
179 mbedtls_printf(" failed\n ! mbedtls_ssl_handshake returned -0x%x\n\n",
180 (unsigned int) -ret);
Paul Bakker75242c32012-11-17 00:03:46 +0100181 goto exit;
182 }
183 }
184
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 mbedtls_printf(" ok\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100186
187 /*
188 * 5. Verify the server certificate
189 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 mbedtls_printf(" . Verifying peer X.509 certificate...");
Paul Bakker75242c32012-11-17 00:03:46 +0100191
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100192 /* In real life, we probably want to bail out when ret != 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 if ((flags = mbedtls_ssl_get_verify_result(&ssl)) != 0) {
Hanno Becker612a2f12020-10-09 09:19:39 +0100194#if !defined(MBEDTLS_X509_REMOVE_INFO)
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100195 char vrfy_buf[512];
Peter Kolbus9a969b62018-12-11 13:55:56 -0600196#endif
Manuel Pégourié-Gonnard89addc42015-04-20 10:56:18 +0100197
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 mbedtls_printf(" failed\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100199
Hanno Becker612a2f12020-10-09 09:19:39 +0100200#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 mbedtls_x509_crt_verify_info(vrfy_buf, sizeof(vrfy_buf), " ! ", flags);
Paul Bakker75242c32012-11-17 00:03:46 +0100202
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 mbedtls_printf("%s\n", vrfy_buf);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 } else {
206 mbedtls_printf(" ok\n");
Paul Bakker75242c32012-11-17 00:03:46 +0100207 }
Paul Bakker75242c32012-11-17 00:03:46 +0100208
209 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000210 * 3. Write the GET request
211 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 mbedtls_printf(" > Write to server:");
213 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000214
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 len = sprintf((char *) buf, GET_REQUEST);
Paul Bakker5121ce52009-01-03 21:22:43 +0000216
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 while ((ret = mbedtls_ssl_write(&ssl, buf, len)) <= 0) {
218 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
219 mbedtls_printf(" failed\n ! mbedtls_ssl_write returned %d\n\n", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +0000220 goto exit;
221 }
222 }
223
224 len = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 mbedtls_printf(" %d bytes written\n\n%s", len, (char *) buf);
Paul Bakker5121ce52009-01-03 21:22:43 +0000226
227 /*
228 * 7. Read the HTTP response
229 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_printf(" < Read from server:");
231 fflush(stdout);
Paul Bakker5121ce52009-01-03 21:22:43 +0000232
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 do {
234 len = sizeof(buf) - 1;
235 memset(buf, 0, sizeof(buf));
236 ret = mbedtls_ssl_read(&ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +0000237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 if (ret == MBEDTLS_ERR_SSL_WANT_READ || ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
Paul Bakker5121ce52009-01-03 21:22:43 +0000239 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000241
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
Paul Bakker5121ce52009-01-03 21:22:43 +0000243 break;
244 }
245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 if (ret < 0) {
247 mbedtls_printf("failed\n ! mbedtls_ssl_read returned %d\n\n", ret);
248 break;
249 }
250
251 if (ret == 0) {
252 mbedtls_printf("\n\nEOF\n\n");
Paul Bakker61da7522011-11-11 10:28:58 +0000253 break;
254 }
255
Paul Bakker5121ce52009-01-03 21:22:43 +0000256 len = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_printf(" %d bytes read\n\n%s", len, (char *) buf);
258 } while (1);
Paul Bakker5121ce52009-01-03 21:22:43 +0000259
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 mbedtls_ssl_close_notify(&ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +0000261
Andres Amaya Garcia55172022018-04-29 20:53:53 +0100262 exit_code = MBEDTLS_EXIT_SUCCESS;
263
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 Stekiel758aef62023-04-19 13:47:43 +0200280#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekiela8c560a2023-04-19 10:15:26 +0200281 mbedtls_psa_crypto_free();
Przemek Stekiel758aef62023-04-19 13:47:43 +0200282#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 mbedtls_exit(exit_code);
Paul Bakker5121ce52009-01-03 21:22:43 +0000285}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#endif /* MBEDTLS_BIGNUM_C && MBEDTLS_ENTROPY_C && MBEDTLS_SSL_TLS_C &&
287 MBEDTLS_SSL_CLI_C && MBEDTLS_NET_C && MBEDTLS_RSA_C &&
Mateusz Starzyk1aec6462021-02-08 15:34:42 +0100288 MBEDTLS_PEM_PARSE_C && MBEDTLS_CTR_DRBG_C && MBEDTLS_X509_CRT_PARSE_C */