HTTP and HTTPS example application for Mbed OS 5

Dependencies:   mbed-http

This application demonstrates how to make HTTP and HTTPS requests and parse the response from Mbed OS 5.

It consists of six example applications, which you can select in source/select-demo.h:

Response parsing is done through nodejs/http-parser.

Note: HTTPS requests do not work on targets with less than 128K of RAM due to the size of the TLS handshake. For more background see mbed-http.

To build

  1. If you're using WiFi, specify the credentials in mbed_app.json.
  2. Build the project in the online compiler or using Mbed CLI.
  3. Flash the project to your development board.
  4. Attach a serial monitor to your board to see the debug messages.

Defining the network interface

This application uses the on-board network interface for your board. If you use an external network interface (f.e. a WiFi module) you need to add the driver to this project. Then, open network-helper.h and specify which network driver to use.

More information is in the Mbed OS documentation under IP Networking.

Entropy (or lack thereof)

On all platforms that do not have the TRNG feature, the application is compiled without TLS entropy sources. This means that your code is inherently unsafe and should not be deployed to any production systems. To enable entropy, remove the MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES and MBEDTLS_TEST_NULL_ENTROPY macros from mbed_app.json.

Flash size

Default flash size for HTTPS is very large, as the application is loading the default Mbed TLS configuration. To use a more optimized version, you can disable unused cypher suites and other Mbed TLS features with a custom configuration file. Create a new configuration file, then add in mbed_app.json:

"MBEDTLS_CONFIG_FILE=\"mbedtls_config.h\""

to the macros array.

Running tests

You can run the integration tests from this project via Mbed CLI.

  1. In select-demo.h set the DEMO macro to DEMO_TESTS.
  2. Set your WiFi credentials in mbed_app.json.
  3. Then run the tests via:

$ mbed test -v -n mbed-http-tests-tests-*

Tested on

  • K64F with Ethernet.
  • NUCLEO_F411RE with ESP8266 (not working on Mbed OS 5.12+)
  • ODIN-W2 with WiFi.
  • K64F with Atmel 6LoWPAN shield.
  • DISCO-L475VG-IOT01A with WiFi (requires the wifi-ism43362 driver).
Committer:
Jan Jongboom
Date:
Tue Mar 27 11:57:33 2018 +0200
Revision:
29:5ad8f931e4ff
Parent:
28:9bccd981a393
Child:
30:4825e4f38844
Move serial baud rate config into mbed_app.json

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 12:4c226ca06191 1 #include "select-demo.h"
Jan Jongboom 12:4c226ca06191 2
Jan Jongboom 12:4c226ca06191 3 /**
Jan Jongboom 12:4c226ca06191 4 * This demo shows how to re-use sockets, so the TLS handshake only has to happen once
Jan Jongboom 12:4c226ca06191 5 */
Jan Jongboom 12:4c226ca06191 6
Jan Jongboom 12:4c226ca06191 7 #if DEMO == DEMO_HTTPS_SOCKET_REUSE
Jan Jongboom 12:4c226ca06191 8
Jan Jongboom 12:4c226ca06191 9 #include "mbed.h"
Jan Jongboom 12:4c226ca06191 10 #include "easy-connect.h"
Jan Jongboom 12:4c226ca06191 11 #include "https_request.h"
Jan Jongboom 12:4c226ca06191 12
Jan Jongboom 12:4c226ca06191 13 /* List of trusted root CA certificates
Jan Jongboom 12:4c226ca06191 14 * currently one: Let's Encrypt, the CA for httpbin.org
Jan Jongboom 12:4c226ca06191 15 *
Jan Jongboom 12:4c226ca06191 16 * To add more root certificates, just concatenate them.
Jan Jongboom 12:4c226ca06191 17 */
Jan Jongboom 12:4c226ca06191 18 const char SSL_CA_PEM[] = "-----BEGIN CERTIFICATE-----\n"
Jan Jongboom 12:4c226ca06191 19 "MIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/\n"
Jan Jongboom 12:4c226ca06191 20 "MSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT\n"
Jan Jongboom 12:4c226ca06191 21 "DkRTVCBSb290IENBIFgzMB4XDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0Nlow\n"
Jan Jongboom 12:4c226ca06191 22 "SjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxldCdzIEVuY3J5cHQxIzAhBgNVBAMT\n"
Jan Jongboom 12:4c226ca06191 23 "GkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkqhkiG9w0BAQEFAAOC\n"
Jan Jongboom 12:4c226ca06191 24 "AQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4S0EF\n"
Jan Jongboom 12:4c226ca06191 25 "q6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8\n"
Jan Jongboom 12:4c226ca06191 26 "SMx+yk13EiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0\n"
Jan Jongboom 12:4c226ca06191 27 "Z8h/pZq4UmEUEz9l6YKHy9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWA\n"
Jan Jongboom 12:4c226ca06191 28 "a6xK8xuQSXgvopZPKiAlKQTGdMDQMc2PMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj\n"
Jan Jongboom 12:4c226ca06191 29 "/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQABo4IBfTCCAXkwEgYDVR0T\n"
Jan Jongboom 12:4c226ca06191 30 "AQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEEczBxMDIG\n"
Jan Jongboom 12:4c226ca06191 31 "CCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNv\n"
Jan Jongboom 12:4c226ca06191 32 "bTA7BggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9k\n"
Jan Jongboom 12:4c226ca06191 33 "c3Ryb290Y2F4My5wN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAw\n"
Jan Jongboom 12:4c226ca06191 34 "VAYDVR0gBE0wSzAIBgZngQwBAgEwPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcC\n"
Jan Jongboom 12:4c226ca06191 35 "ARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNyeXB0Lm9yZzA8BgNVHR8ENTAz\n"
Jan Jongboom 12:4c226ca06191 36 "MDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9PVENBWDNDUkwu\n"
Jan Jongboom 12:4c226ca06191 37 "Y3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\n"
Jan Jongboom 12:4c226ca06191 38 "AAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJo\n"
Jan Jongboom 12:4c226ca06191 39 "uM2VcGfl96S8TihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/\n"
Jan Jongboom 12:4c226ca06191 40 "wApIvJSwtmVi4MFU5aMqrSDE6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwu\n"
Jan Jongboom 12:4c226ca06191 41 "X4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPMTZ+sOPAveyxindmjkW8lGy+QsRlG\n"
Jan Jongboom 12:4c226ca06191 42 "PfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M+X+Q7UNKEkROb3N6\n"
Jan Jongboom 12:4c226ca06191 43 "KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n"
Jan Jongboom 12:4c226ca06191 44 "-----END CERTIFICATE-----\n";
Jan Jongboom 12:4c226ca06191 45
Jan Jongboom 12:4c226ca06191 46 void dump_response(HttpResponse* res) {
Jan Jongboom 12:4c226ca06191 47 mbedtls_printf("Status: %d - %s\n", res->get_status_code(), res->get_status_message().c_str());
Jan Jongboom 12:4c226ca06191 48
Jan Jongboom 12:4c226ca06191 49 mbedtls_printf("Headers:\n");
Jan Jongboom 12:4c226ca06191 50 for (size_t ix = 0; ix < res->get_headers_length(); ix++) {
Jan Jongboom 12:4c226ca06191 51 mbedtls_printf("\t%s: %s\n", res->get_headers_fields()[ix]->c_str(), res->get_headers_values()[ix]->c_str());
Jan Jongboom 12:4c226ca06191 52 }
Jan Jongboom 12:4c226ca06191 53 mbedtls_printf("\nBody (%d bytes):\n\n%s\n", res->get_body_length(), res->get_body_as_string().c_str());
Jan Jongboom 12:4c226ca06191 54 }
Jan Jongboom 12:4c226ca06191 55
Jan Jongboom 25:a8be9f3a530c 56 int main() {
Jan Jongboom 12:4c226ca06191 57 NetworkInterface* network = easy_connect(true);
Jan Jongboom 12:4c226ca06191 58 if (!network) {
Jan Jongboom 25:a8be9f3a530c 59 return 1;
Jan Jongboom 12:4c226ca06191 60 }
Jan Jongboom 12:4c226ca06191 61
Jan Jongboom 12:4c226ca06191 62 // Create a TLS socket (which holds a TCPSocket)
Jan Jongboom 12:4c226ca06191 63 printf("\n----- Setting up TLS connection -----\n");
Jan Jongboom 12:4c226ca06191 64
Jan Jongboom 12:4c226ca06191 65 TLSSocket* socket = new TLSSocket(network, "httpbin.org", 443, SSL_CA_PEM);
Jan Jongboom 12:4c226ca06191 66 socket->set_debug(true);
Jan Jongboom 12:4c226ca06191 67 if (socket->connect() != 0) {
Jan Jongboom 12:4c226ca06191 68 printf("TLS Connect failed %d\n", socket->error());
Jan Jongboom 25:a8be9f3a530c 69 return 1;
Jan Jongboom 12:4c226ca06191 70 }
Jan Jongboom 12:4c226ca06191 71
Jan Jongboom 12:4c226ca06191 72 // GET request to httpbin.org
Jan Jongboom 12:4c226ca06191 73 {
Jan Jongboom 12:4c226ca06191 74 HttpsRequest* get_req = new HttpsRequest(socket, HTTP_GET, "https://httpbin.org/status/418");
Jan Jongboom 12:4c226ca06191 75 get_req->set_debug(true);
Jan Jongboom 12:4c226ca06191 76
Jan Jongboom 12:4c226ca06191 77 HttpResponse* get_res = get_req->send();
Jan Jongboom 12:4c226ca06191 78 if (!get_res) {
Jan Jongboom 12:4c226ca06191 79 printf("HttpRequest failed (error code %d)\n", get_req->get_error());
Jan Jongboom 25:a8be9f3a530c 80 return 1;
Jan Jongboom 12:4c226ca06191 81 }
Jan Jongboom 12:4c226ca06191 82 printf("\n----- HTTPS GET response -----\n");
Jan Jongboom 12:4c226ca06191 83 dump_response(get_res);
Jan Jongboom 12:4c226ca06191 84
Jan Jongboom 12:4c226ca06191 85 delete get_req;
Jan Jongboom 12:4c226ca06191 86 }
Jan Jongboom 12:4c226ca06191 87
Jan Jongboom 12:4c226ca06191 88 // POST request to httpbin.org
Jan Jongboom 12:4c226ca06191 89 {
Jan Jongboom 12:4c226ca06191 90 HttpsRequest* post_req = new HttpsRequest(socket, HTTP_POST, "https://httpbin.org/post");
Jan Jongboom 12:4c226ca06191 91 post_req->set_debug(true);
Jan Jongboom 12:4c226ca06191 92 post_req->set_header("Content-Type", "application/json");
Jan Jongboom 12:4c226ca06191 93
Jan Jongboom 12:4c226ca06191 94 const char body[] = "{\"hello\":\"world\"}";
Jan Jongboom 12:4c226ca06191 95
Jan Jongboom 12:4c226ca06191 96 HttpResponse* post_res = post_req->send(body, strlen(body));
Jan Jongboom 12:4c226ca06191 97 if (!post_res) {
Jan Jongboom 12:4c226ca06191 98 printf("HttpRequest failed (error code %d)\n", post_req->get_error());
Jan Jongboom 25:a8be9f3a530c 99 return 1;
Jan Jongboom 12:4c226ca06191 100 }
Jan Jongboom 12:4c226ca06191 101
Jan Jongboom 12:4c226ca06191 102 printf("\n----- HTTPS POST response -----\n");
Jan Jongboom 12:4c226ca06191 103 dump_response(post_res);
Jan Jongboom 12:4c226ca06191 104
Jan Jongboom 12:4c226ca06191 105 delete post_req;
Jan Jongboom 12:4c226ca06191 106 }
Jan Jongboom 12:4c226ca06191 107
Jan Jongboom 12:4c226ca06191 108 delete socket;
Jan Jongboom 12:4c226ca06191 109
Jan Jongboom 28:9bccd981a393 110 wait(osWaitForever);
Jan Jongboom 16:1374b4c35897 111 }
Jan Jongboom 16:1374b4c35897 112
Jan Jongboom 12:4c226ca06191 113 #endif