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 #if DEMO == DEMO_HTTP_SOCKET_REUSE
Jan Jongboom 12:4c226ca06191 4
Jan Jongboom 12:4c226ca06191 5 #include "mbed.h"
Jan Jongboom 30:4825e4f38844 6 #include "network-helper.h"
Jan Jongboom 12:4c226ca06191 7 #include "http_request.h"
Jan Jongboom 12:4c226ca06191 8
Jan Jongboom 12:4c226ca06191 9 void dump_response(HttpResponse* res) {
Jan Jongboom 12:4c226ca06191 10 printf("Status: %d - %s\n", res->get_status_code(), res->get_status_message().c_str());
Jan Jongboom 12:4c226ca06191 11
Jan Jongboom 12:4c226ca06191 12 printf("Headers:\n");
Jan Jongboom 12:4c226ca06191 13 for (size_t ix = 0; ix < res->get_headers_length(); ix++) {
Jan Jongboom 12:4c226ca06191 14 printf("\t%s: %s\n", res->get_headers_fields()[ix]->c_str(), res->get_headers_values()[ix]->c_str());
Jan Jongboom 12:4c226ca06191 15 }
Jan Jongboom 12:4c226ca06191 16 printf("\nBody (%d bytes):\n\n%s\n", res->get_body_length(), res->get_body_as_string().c_str());
Jan Jongboom 12:4c226ca06191 17 }
Jan Jongboom 12:4c226ca06191 18
Jan Jongboom 12:4c226ca06191 19 int main() {
Jan Jongboom 30:4825e4f38844 20 NetworkInterface* network = connect_to_default_network_interface();
Jan Jongboom 12:4c226ca06191 21 if (!network) {
Jan Jongboom 30:4825e4f38844 22 printf("Cannot connect to the network, see serial output\n");
Jan Jongboom 12:4c226ca06191 23 return 1;
Jan Jongboom 12:4c226ca06191 24 }
Jan Jongboom 12:4c226ca06191 25
Jan Jongboom 12:4c226ca06191 26 // Create a TCP socket
Jan Jongboom 12:4c226ca06191 27 printf("\n----- Setting up TCP connection -----\n");
Jan Jongboom 12:4c226ca06191 28
Jan Jongboom 12:4c226ca06191 29 TCPSocket* socket = new TCPSocket();
Jan Jongboom 12:4c226ca06191 30 nsapi_error_t open_result = socket->open(network);
Jan Jongboom 12:4c226ca06191 31 if (open_result != 0) {
Jan Jongboom 12:4c226ca06191 32 printf("Opening TCPSocket failed... %d\n", open_result);
Jan Jongboom 12:4c226ca06191 33 return 1;
Jan Jongboom 12:4c226ca06191 34 }
Jan Jongboom 12:4c226ca06191 35
Jan Jongboom 12:4c226ca06191 36 nsapi_error_t connect_result = socket->connect("httpbin.org", 80);
Jan Jongboom 12:4c226ca06191 37 if (connect_result != 0) {
Jan Jongboom 12:4c226ca06191 38 printf("Connecting over TCPSocket failed... %d\n", connect_result);
Jan Jongboom 12:4c226ca06191 39 return 1;
Jan Jongboom 12:4c226ca06191 40 }
Jan Jongboom 12:4c226ca06191 41
Jan Jongboom 12:4c226ca06191 42 printf("Connected over TCP to httpbin.org:80\n");
Jan Jongboom 12:4c226ca06191 43
Jan Jongboom 12:4c226ca06191 44 // Do a GET request to httpbin.org
Jan Jongboom 12:4c226ca06191 45 {
Jan Jongboom 12:4c226ca06191 46 HttpRequest* get_req = new HttpRequest(socket, HTTP_GET, "http://httpbin.org/status/418");
Jan Jongboom 12:4c226ca06191 47
Jan Jongboom 12:4c226ca06191 48 // By default the body is automatically parsed and stored in a string, this is memory heavy.
Jan Jongboom 12:4c226ca06191 49 // To receive chunked response, pass in a callback as third parameter to 'send'.
Jan Jongboom 12:4c226ca06191 50 HttpResponse* get_res = get_req->send();
Jan Jongboom 12:4c226ca06191 51 if (!get_res) {
Jan Jongboom 12:4c226ca06191 52 printf("HttpRequest failed (error code %d)\n", get_req->get_error());
Jan Jongboom 12:4c226ca06191 53 return 1;
Jan Jongboom 12:4c226ca06191 54 }
Jan Jongboom 12:4c226ca06191 55
Jan Jongboom 12:4c226ca06191 56 printf("\n----- HTTP GET response -----\n");
Jan Jongboom 12:4c226ca06191 57 dump_response(get_res);
Jan Jongboom 12:4c226ca06191 58
Jan Jongboom 12:4c226ca06191 59 delete get_req;
Jan Jongboom 12:4c226ca06191 60 }
Jan Jongboom 12:4c226ca06191 61
Jan Jongboom 12:4c226ca06191 62 // POST request to httpbin.org
Jan Jongboom 12:4c226ca06191 63 {
Jan Jongboom 12:4c226ca06191 64 HttpRequest* post_req = new HttpRequest(socket, HTTP_POST, "http://httpbin.org/post");
Jan Jongboom 12:4c226ca06191 65 post_req->set_header("Content-Type", "application/json");
Jan Jongboom 12:4c226ca06191 66
Jan Jongboom 12:4c226ca06191 67 const char body[] = "{\"hello\":\"world\"}";
Jan Jongboom 12:4c226ca06191 68
Jan Jongboom 12:4c226ca06191 69 HttpResponse* post_res = post_req->send(body, strlen(body));
Jan Jongboom 12:4c226ca06191 70 if (!post_res) {
Jan Jongboom 12:4c226ca06191 71 printf("HttpRequest failed (error code %d)\n", post_req->get_error());
Jan Jongboom 12:4c226ca06191 72 return 1;
Jan Jongboom 12:4c226ca06191 73 }
Jan Jongboom 12:4c226ca06191 74
Jan Jongboom 12:4c226ca06191 75 printf("\n----- HTTP POST response -----\n");
Jan Jongboom 12:4c226ca06191 76 dump_response(post_res);
Jan Jongboom 12:4c226ca06191 77
Jan Jongboom 12:4c226ca06191 78 delete post_req;
Jan Jongboom 12:4c226ca06191 79 }
Jan Jongboom 12:4c226ca06191 80
Jan Jongboom 31:66704f6f17c5 81 socket->close();
Jan Jongboom 12:4c226ca06191 82 delete socket;
Jan Jongboom 12:4c226ca06191 83
Jan Jongboom 28:9bccd981a393 84 wait(osWaitForever);
Jan Jongboom 12:4c226ca06191 85 }
Jan Jongboom 12:4c226ca06191 86
Jan Jongboom 12:4c226ca06191 87 #endif