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:
Mon Sep 04 17:01:11 2017 +0100
Revision:
17:97b1dd566b07
Parent:
11:72c089200302
Child:
19:fbf5b033149a
Enable entropy sources for ODIN-W2; add note on memory usage

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:85fdc69bc10c 1 # mbed-os-example-http(s)
Jan Jongboom 0:85fdc69bc10c 2
Jan Jongboom 0:85fdc69bc10c 3 This application demonstrates how to make HTTP and HTTPS requests and parse the response from mbed OS 5.
Jan Jongboom 0:85fdc69bc10c 4
Jan Jongboom 11:72c089200302 5 It consists of four demo's, which you can select in ``source/select-demo.h``.
Jan Jongboom 0:85fdc69bc10c 6
Jan Jongboom 11:72c089200302 7 * HTTP demo:
Jan Jongboom 4:27fd8efb5bab 8 * Does a GET request to http://httpbin.org/status/418.
Jan Jongboom 4:27fd8efb5bab 9 * Does a POST request to http://httpbin.org/post.
Jan Jongboom 11:72c089200302 10 * HTTPS demo:
Jan Jongboom 4:27fd8efb5bab 11 * Does a GET request to https://developer.mbed.org/media/uploads/mbed_official/hello.txt.
Jan Jongboom 4:27fd8efb5bab 12 * Does a POST request to https://httpbin.org/post.
Jan Jongboom 11:72c089200302 13 * HTTP demo with socket re-use.
Jan Jongboom 11:72c089200302 14 * HTTPS demo with socket re-use.
Jan Jongboom 0:85fdc69bc10c 15
Jan Jongboom 0:85fdc69bc10c 16 Response parsing is done through [nodejs/http-parser](https://github.com/nodejs/http-parser).
Jan Jongboom 0:85fdc69bc10c 17
Jan Jongboom 17:97b1dd566b07 18 **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](https://developer.mbed.org/teams/sandbox/code/mbed-http).
Jan Jongboom 17:97b1dd566b07 19
Jan Jongboom 0:85fdc69bc10c 20 ## To build
Jan Jongboom 0:85fdc69bc10c 21
Jan Jongboom 0:85fdc69bc10c 22 1. Open ``mbed_app.json`` and change the `network-interface` option to your connectivity method ([more info](https://github.com/ARMmbed/easy-connect)).
Jan Jongboom 0:85fdc69bc10c 23 2. Build the project in the online compiler or using mbed CLI.
Jan Jongboom 0:85fdc69bc10c 24 3. Flash the project to your development board.
Jan Jongboom 0:85fdc69bc10c 25 4. Attach a serial monitor to your board to see the debug messages.
Jan Jongboom 0:85fdc69bc10c 26
Jan Jongboom 0:85fdc69bc10c 27 ## Entropy (or lack thereof)
Jan Jongboom 0:85fdc69bc10c 28
Jan Jongboom 17:97b1dd566b07 29 On all platforms **except** the FRDM-K64F, FRDM-K22F and EVK-ODIN-W2, 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.
Jan Jongboom 0:85fdc69bc10c 30
Jan Jongboom 0:85fdc69bc10c 31 ## Tested on
Jan Jongboom 0:85fdc69bc10c 32
Jan Jongboom 0:85fdc69bc10c 33 * K64F with Ethernet.
Jan Jongboom 0:85fdc69bc10c 34 * NUCLEO_F411RE with ESP8266.
Jan Jongboom 17:97b1dd566b07 35 * ODIN-W2 with WiFi.