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 Oct 30 11:07:10 2018 +0800
Branch:
mbed-os-5.10
Revision:
31:66704f6f17c5
Parent:
30:4825e4f38844
Child:
34:7da6cfc032fc
Update to new mbed-http, which uses TLSSocket

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 31:66704f6f17c5 1 #define MBED_CONF_MBED_TRACE_ENABLE 1
Jan Jongboom 31:66704f6f17c5 2
Jan Jongboom 0:85fdc69bc10c 3 #include "select-demo.h"
Jan Jongboom 0:85fdc69bc10c 4
Jan Jongboom 0:85fdc69bc10c 5 #if DEMO == DEMO_HTTPS
Jan Jongboom 0:85fdc69bc10c 6
Jan Jongboom 0:85fdc69bc10c 7 #include "mbed.h"
Jan Jongboom 31:66704f6f17c5 8 #include "mbed_trace.h"
Jan Jongboom 0:85fdc69bc10c 9 #include "https_request.h"
Jan Jongboom 30:4825e4f38844 10 #include "network-helper.h"
Jan Jongboom 0:85fdc69bc10c 11
Jan Jongboom 0:85fdc69bc10c 12 /* List of trusted root CA certificates
Jan Jongboom 30:4825e4f38844 13 * currently two: GlobalSign, the CA for os.mbed.com and Let's Encrypt, the CA for httpbin.org
Jan Jongboom 0:85fdc69bc10c 14 *
Jan Jongboom 10:e79a808ebbe8 15 * To add more root certificates, just concatenate them.
Jan Jongboom 0:85fdc69bc10c 16 */
Jan Jongboom 0:85fdc69bc10c 17 const char SSL_CA_PEM[] = "-----BEGIN CERTIFICATE-----\n"
Jan Jongboom 0:85fdc69bc10c 18 "MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG\n"
Jan Jongboom 0:85fdc69bc10c 19 "A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv\n"
Jan Jongboom 0:85fdc69bc10c 20 "b3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAw\n"
Jan Jongboom 0:85fdc69bc10c 21 "MDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9i\n"
Jan Jongboom 0:85fdc69bc10c 22 "YWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYDVQQDExJHbG9iYWxT\n"
Jan Jongboom 0:85fdc69bc10c 23 "aWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDaDuaZ\n"
Jan Jongboom 0:85fdc69bc10c 24 "jc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavp\n"
Jan Jongboom 0:85fdc69bc10c 25 "xy0Sy6scTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp\n"
Jan Jongboom 0:85fdc69bc10c 26 "1Wrjsok6Vjk4bwY8iGlbKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdG\n"
Jan Jongboom 0:85fdc69bc10c 27 "snUOhugZitVtbNV4FpWi6cgKOOvyJBNPc1STE4U6G7weNLWLBYy5d4ux2x8gkasJ\n"
Jan Jongboom 0:85fdc69bc10c 28 "U26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrXgzT/LCrBbBlDSgeF59N8\n"
Jan Jongboom 0:85fdc69bc10c 29 "9iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8E\n"
Jan Jongboom 0:85fdc69bc10c 30 "BTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0B\n"
Jan Jongboom 0:85fdc69bc10c 31 "AQUFAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOz\n"
Jan Jongboom 0:85fdc69bc10c 32 "yj1hTdNGCbM+w6DjY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE\n"
Jan Jongboom 0:85fdc69bc10c 33 "38NflNUVyRRBnMRddWQVDf9VMOyGj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymP\n"
Jan Jongboom 0:85fdc69bc10c 34 "AbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhHhm4qxFYxldBniYUr+WymXUad\n"
Jan Jongboom 0:85fdc69bc10c 35 "DKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveCX4XSQRjbgbME\n"
Jan Jongboom 0:85fdc69bc10c 36 "HMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n"
Jan Jongboom 4:27fd8efb5bab 37 "-----END CERTIFICATE-----\n"
Jan Jongboom 4:27fd8efb5bab 38 "-----BEGIN CERTIFICATE-----\n"
Jan Jongboom 10:e79a808ebbe8 39 "MIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/\n"
Jan Jongboom 10:e79a808ebbe8 40 "MSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT\n"
Jan Jongboom 10:e79a808ebbe8 41 "DkRTVCBSb290IENBIFgzMB4XDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0Nlow\n"
Jan Jongboom 10:e79a808ebbe8 42 "SjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxldCdzIEVuY3J5cHQxIzAhBgNVBAMT\n"
Jan Jongboom 10:e79a808ebbe8 43 "GkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkqhkiG9w0BAQEFAAOC\n"
Jan Jongboom 10:e79a808ebbe8 44 "AQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4S0EF\n"
Jan Jongboom 10:e79a808ebbe8 45 "q6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8\n"
Jan Jongboom 10:e79a808ebbe8 46 "SMx+yk13EiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0\n"
Jan Jongboom 10:e79a808ebbe8 47 "Z8h/pZq4UmEUEz9l6YKHy9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWA\n"
Jan Jongboom 10:e79a808ebbe8 48 "a6xK8xuQSXgvopZPKiAlKQTGdMDQMc2PMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj\n"
Jan Jongboom 10:e79a808ebbe8 49 "/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQABo4IBfTCCAXkwEgYDVR0T\n"
Jan Jongboom 10:e79a808ebbe8 50 "AQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEEczBxMDIG\n"
Jan Jongboom 10:e79a808ebbe8 51 "CCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNv\n"
Jan Jongboom 10:e79a808ebbe8 52 "bTA7BggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9k\n"
Jan Jongboom 10:e79a808ebbe8 53 "c3Ryb290Y2F4My5wN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAw\n"
Jan Jongboom 10:e79a808ebbe8 54 "VAYDVR0gBE0wSzAIBgZngQwBAgEwPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcC\n"
Jan Jongboom 10:e79a808ebbe8 55 "ARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNyeXB0Lm9yZzA8BgNVHR8ENTAz\n"
Jan Jongboom 10:e79a808ebbe8 56 "MDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9PVENBWDNDUkwu\n"
Jan Jongboom 10:e79a808ebbe8 57 "Y3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\n"
Jan Jongboom 10:e79a808ebbe8 58 "AAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJo\n"
Jan Jongboom 10:e79a808ebbe8 59 "uM2VcGfl96S8TihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/\n"
Jan Jongboom 10:e79a808ebbe8 60 "wApIvJSwtmVi4MFU5aMqrSDE6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwu\n"
Jan Jongboom 10:e79a808ebbe8 61 "X4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPMTZ+sOPAveyxindmjkW8lGy+QsRlG\n"
Jan Jongboom 10:e79a808ebbe8 62 "PfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M+X+Q7UNKEkROb3N6\n"
Jan Jongboom 10:e79a808ebbe8 63 "KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n"
Jan Jongboom 0:85fdc69bc10c 64 "-----END CERTIFICATE-----\n";
Jan Jongboom 0:85fdc69bc10c 65
Jan Jongboom 0:85fdc69bc10c 66 void dump_response(HttpResponse* res) {
Jan Jongboom 31:66704f6f17c5 67 printf("Status: %d - %s\n", res->get_status_code(), res->get_status_message().c_str());
Jan Jongboom 0:85fdc69bc10c 68
Jan Jongboom 31:66704f6f17c5 69 printf("Headers:\n");
Jan Jongboom 0:85fdc69bc10c 70 for (size_t ix = 0; ix < res->get_headers_length(); ix++) {
Jan Jongboom 31:66704f6f17c5 71 printf("\t%s: %s\n", res->get_headers_fields()[ix]->c_str(), res->get_headers_values()[ix]->c_str());
Jan Jongboom 0:85fdc69bc10c 72 }
Jan Jongboom 31:66704f6f17c5 73 printf("\nBody (%lu bytes):\n\n%s\n", res->get_body_length(), res->get_body_as_string().c_str());
Jan Jongboom 0:85fdc69bc10c 74 }
Jan Jongboom 0:85fdc69bc10c 75
Jan Jongboom 0:85fdc69bc10c 76 int main() {
Jan Jongboom 30:4825e4f38844 77 NetworkInterface* network = connect_to_default_network_interface();
Jan Jongboom 0:85fdc69bc10c 78 if (!network) {
Jan Jongboom 30:4825e4f38844 79 printf("Cannot connect to the network, see serial output\n");
Jan Jongboom 0:85fdc69bc10c 80 return 1;
Jan Jongboom 0:85fdc69bc10c 81 }
Jan Jongboom 0:85fdc69bc10c 82
Jan Jongboom 31:66704f6f17c5 83 mbed_trace_init();
Jan Jongboom 31:66704f6f17c5 84
Jan Jongboom 30:4825e4f38844 85 // GET request to os.mbed.com
Jan Jongboom 5:42f713b19337 86 {
Jan Jongboom 5:42f713b19337 87 printf("\n----- HTTPS GET request -----\n");
Jan Jongboom 4:27fd8efb5bab 88
Jan Jongboom 25:a8be9f3a530c 89 HttpsRequest* get_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_GET, "https://os.mbed.com/media/uploads/mbed_official/hello.txt");
Jan Jongboom 4:27fd8efb5bab 90
Jan Jongboom 5:42f713b19337 91 HttpResponse* get_res = get_req->send();
Jan Jongboom 5:42f713b19337 92 if (!get_res) {
Jan Jongboom 5:42f713b19337 93 printf("HttpRequest failed (error code %d)\n", get_req->get_error());
Jan Jongboom 31:66704f6f17c5 94 return 1;
Jan Jongboom 5:42f713b19337 95 }
Jan Jongboom 5:42f713b19337 96 printf("\n----- HTTPS GET response -----\n");
Jan Jongboom 5:42f713b19337 97 dump_response(get_res);
Jan Jongboom 5:42f713b19337 98
Jan Jongboom 5:42f713b19337 99 delete get_req;
Jan Jongboom 0:85fdc69bc10c 100 }
Jan Jongboom 4:27fd8efb5bab 101
Jan Jongboom 4:27fd8efb5bab 102 // POST request to httpbin.org
Jan Jongboom 5:42f713b19337 103 {
Jan Jongboom 5:42f713b19337 104 printf("\n----- HTTPS POST request -----\n");
Jan Jongboom 4:27fd8efb5bab 105
Jan Jongboom 5:42f713b19337 106 HttpsRequest* post_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_POST, "https://httpbin.org/post");
Jan Jongboom 5:42f713b19337 107 post_req->set_header("Content-Type", "application/json");
Jan Jongboom 0:85fdc69bc10c 108
Jan Jongboom 5:42f713b19337 109 const char body[] = "{\"hello\":\"world\"}";
Jan Jongboom 4:27fd8efb5bab 110
Jan Jongboom 5:42f713b19337 111 HttpResponse* post_res = post_req->send(body, strlen(body));
Jan Jongboom 5:42f713b19337 112 if (!post_res) {
Jan Jongboom 5:42f713b19337 113 printf("HttpRequest failed (error code %d)\n", post_req->get_error());
Jan Jongboom 5:42f713b19337 114 return 1;
Jan Jongboom 5:42f713b19337 115 }
Jan Jongboom 5:42f713b19337 116
Jan Jongboom 5:42f713b19337 117 printf("\n----- HTTPS POST response -----\n");
Jan Jongboom 5:42f713b19337 118 dump_response(post_res);
Jan Jongboom 5:42f713b19337 119
Jan Jongboom 5:42f713b19337 120 delete post_req;
Jan Jongboom 4:27fd8efb5bab 121 }
Jan Jongboom 4:27fd8efb5bab 122
Jan Jongboom 28:9bccd981a393 123 wait(osWaitForever);
Jan Jongboom 0:85fdc69bc10c 124 }
Jan Jongboom 0:85fdc69bc10c 125
Jan Jongboom 0:85fdc69bc10c 126 #endif