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:
Fri Jan 04 13:32:26 2019 +0100
Revision:
35:4b847971db1b
Parent:
31:66704f6f17c5
Update to Mbed OS 5.11

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