sandbox / Mbed OS http-example

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).

source/mbed-http/http_response.h@1:3bff14db67c7, 2017-02-16 (annotated)

Committer:
Jan Jongboom
Date:
Thu Feb 16 11:13:40 2017 +0100
Revision:
1:3bff14db67c7
Add mbed-http

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 1:3bff14db67c7 1 #ifndef _MBED_HTTP_HTTP_RESPONSE
Jan Jongboom 1:3bff14db67c7 2 #define _MBED_HTTP_HTTP_RESPONSE
Jan Jongboom 1:3bff14db67c7 3 #include <string>
Jan Jongboom 1:3bff14db67c7 4 #include <vector>
Jan Jongboom 1:3bff14db67c7 5 #include "http_parser.h"
Jan Jongboom 1:3bff14db67c7 6
Jan Jongboom 1:3bff14db67c7 7 using namespace std;
Jan Jongboom 1:3bff14db67c7 8
Jan Jongboom 1:3bff14db67c7 9 class HttpResponse {
Jan Jongboom 1:3bff14db67c7 10 public:
Jan Jongboom 1:3bff14db67c7 11 HttpResponse() {
Jan Jongboom 1:3bff14db67c7 12 status_code = 0;
Jan Jongboom 1:3bff14db67c7 13 concat_header_field = false;
Jan Jongboom 1:3bff14db67c7 14 concat_header_value = false;
Jan Jongboom 1:3bff14db67c7 15 }
Jan Jongboom 1:3bff14db67c7 16
Jan Jongboom 1:3bff14db67c7 17 void set_status(int a_status_code, string a_status_message) {
Jan Jongboom 1:3bff14db67c7 18 status_code = a_status_code;
Jan Jongboom 1:3bff14db67c7 19 status_message = a_status_message;
Jan Jongboom 1:3bff14db67c7 20 }
Jan Jongboom 1:3bff14db67c7 21
Jan Jongboom 1:3bff14db67c7 22 int get_status_code() {
Jan Jongboom 1:3bff14db67c7 23 return status_code;
Jan Jongboom 1:3bff14db67c7 24 }
Jan Jongboom 1:3bff14db67c7 25
Jan Jongboom 1:3bff14db67c7 26 string get_status_message() {
Jan Jongboom 1:3bff14db67c7 27 return status_message;
Jan Jongboom 1:3bff14db67c7 28 }
Jan Jongboom 1:3bff14db67c7 29
Jan Jongboom 1:3bff14db67c7 30 void set_header_field(string field) {
Jan Jongboom 1:3bff14db67c7 31 concat_header_value = false;
Jan Jongboom 1:3bff14db67c7 32
Jan Jongboom 1:3bff14db67c7 33 // headers can be chunked
Jan Jongboom 1:3bff14db67c7 34 if (concat_header_field) {
Jan Jongboom 1:3bff14db67c7 35 header_fields[header_fields.size() - 1] = header_fields[header_fields.size() - 1] + field;
Jan Jongboom 1:3bff14db67c7 36 }
Jan Jongboom 1:3bff14db67c7 37 else {
Jan Jongboom 1:3bff14db67c7 38 header_fields.push_back(field);
Jan Jongboom 1:3bff14db67c7 39 }
Jan Jongboom 1:3bff14db67c7 40
Jan Jongboom 1:3bff14db67c7 41 concat_header_field = true;
Jan Jongboom 1:3bff14db67c7 42 }
Jan Jongboom 1:3bff14db67c7 43
Jan Jongboom 1:3bff14db67c7 44 void set_header_value(string value) {
Jan Jongboom 1:3bff14db67c7 45 concat_header_field = false;
Jan Jongboom 1:3bff14db67c7 46
Jan Jongboom 1:3bff14db67c7 47 // headers can be chunked
Jan Jongboom 1:3bff14db67c7 48 if (concat_header_value) {
Jan Jongboom 1:3bff14db67c7 49 header_values[header_values.size() - 1] = header_values[header_values.size() - 1] + value;
Jan Jongboom 1:3bff14db67c7 50 }
Jan Jongboom 1:3bff14db67c7 51 else {
Jan Jongboom 1:3bff14db67c7 52 header_values.push_back(value);
Jan Jongboom 1:3bff14db67c7 53 }
Jan Jongboom 1:3bff14db67c7 54
Jan Jongboom 1:3bff14db67c7 55 concat_header_value = true;
Jan Jongboom 1:3bff14db67c7 56 }
Jan Jongboom 1:3bff14db67c7 57
Jan Jongboom 1:3bff14db67c7 58 size_t get_headers_length() {
Jan Jongboom 1:3bff14db67c7 59 return header_fields.size();
Jan Jongboom 1:3bff14db67c7 60 }
Jan Jongboom 1:3bff14db67c7 61
Jan Jongboom 1:3bff14db67c7 62 vector<string> get_headers_fields() {
Jan Jongboom 1:3bff14db67c7 63 return header_fields;
Jan Jongboom 1:3bff14db67c7 64 }
Jan Jongboom 1:3bff14db67c7 65
Jan Jongboom 1:3bff14db67c7 66 vector<string> get_headers_values() {
Jan Jongboom 1:3bff14db67c7 67 return header_values;
Jan Jongboom 1:3bff14db67c7 68 }
Jan Jongboom 1:3bff14db67c7 69
Jan Jongboom 1:3bff14db67c7 70 void set_body(string v) {
Jan Jongboom 1:3bff14db67c7 71 body = body + v;
Jan Jongboom 1:3bff14db67c7 72 }
Jan Jongboom 1:3bff14db67c7 73
Jan Jongboom 1:3bff14db67c7 74 string get_body() {
Jan Jongboom 1:3bff14db67c7 75 return body;
Jan Jongboom 1:3bff14db67c7 76 }
Jan Jongboom 1:3bff14db67c7 77
Jan Jongboom 1:3bff14db67c7 78 private:
Jan Jongboom 1:3bff14db67c7 79 int status_code;
Jan Jongboom 1:3bff14db67c7 80 string status_message;
Jan Jongboom 1:3bff14db67c7 81
Jan Jongboom 1:3bff14db67c7 82 vector<string> header_fields;
Jan Jongboom 1:3bff14db67c7 83 vector<string> header_values;
Jan Jongboom 1:3bff14db67c7 84
Jan Jongboom 1:3bff14db67c7 85 bool concat_header_field;
Jan Jongboom 1:3bff14db67c7 86 bool concat_header_value;
Jan Jongboom 1:3bff14db67c7 87
Jan Jongboom 1:3bff14db67c7 88 string body;
Jan Jongboom 1:3bff14db67c7 89 };
Jan Jongboom 1:3bff14db67c7 90 #endif