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 Mar 27 11:57:33 2018 +0200
Revision:
29:5ad8f931e4ff
Parent:
23:6a9d776c9794
Child:
30:4825e4f38844
Move serial baud rate config into mbed_app.json

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:85fdc69bc10c 1 {
Jan Jongboom 0:85fdc69bc10c 2 "config": {
Jan Jongboom 2:4b4ac59ff9b0 3 "network-interface": {
Jan Jongboom 22:1b8c2a81c85d 4 "help": "options are ETHERNET, WIFI_ESP8266, WIFI_IDW0XX1, WIFI_ODIN, WIFI_RTW, MESH_LOWPAN_ND, MESH_THREAD, CELLULAR_ONBOARD",
Jan Jongboom 0:85fdc69bc10c 5 "value": "ETHERNET"
Jan Jongboom 0:85fdc69bc10c 6 },
Jan Jongboom 0:85fdc69bc10c 7 "mesh_radio_type": {
Jan Jongboom 22:1b8c2a81c85d 8 "help": "options are ATMEL, MCR20, SPIRIT1, EFR32",
Jan Jongboom 0:85fdc69bc10c 9 "value": "ATMEL"
Jan Jongboom 0:85fdc69bc10c 10 },
Jan Jongboom 22:1b8c2a81c85d 11 "wifi-ssid": {
Jan Jongboom 22:1b8c2a81c85d 12 "value": "\"SSID\""
Jan Jongboom 22:1b8c2a81c85d 13 },
Jan Jongboom 22:1b8c2a81c85d 14 "wifi-password": {
Jan Jongboom 22:1b8c2a81c85d 15 "value": "\"Password\""
Jan Jongboom 22:1b8c2a81c85d 16 },
Jan Jongboom 22:1b8c2a81c85d 17 "cellular-apn": {
Jan Jongboom 22:1b8c2a81c85d 18 "help": "Please provide the APN string for your SIM if it is not already included in APN_db.h.",
Jan Jongboom 22:1b8c2a81c85d 19 "value": "\"my_sims_apn\""
Jan Jongboom 22:1b8c2a81c85d 20 },
Jan Jongboom 22:1b8c2a81c85d 21 "cellular-username": {
Jan Jongboom 22:1b8c2a81c85d 22 "help": "May or may not be required for your APN, please consult your SIM provider.",
Jan Jongboom 22:1b8c2a81c85d 23 "value": "\"my_sim_apns_username\""
Jan Jongboom 22:1b8c2a81c85d 24 },
Jan Jongboom 22:1b8c2a81c85d 25 "cellular-password": {
Jan Jongboom 22:1b8c2a81c85d 26 "help": "May or may not be required for your APN, please consult your SIM provider.",
Jan Jongboom 22:1b8c2a81c85d 27 "value": "\"my_sim_apns_password\""
Jan Jongboom 22:1b8c2a81c85d 28 },
Jan Jongboom 22:1b8c2a81c85d 29 "cellular-sim-pin": {
Jan Jongboom 22:1b8c2a81c85d 30 "help": "Please provide the PIN for your SIM (as a four digit string) if your SIM is normally locked",
Jan Jongboom 22:1b8c2a81c85d 31 "value": "\"1234\""
Jan Jongboom 22:1b8c2a81c85d 32 },
Jan Jongboom 0:85fdc69bc10c 33 "esp8266-tx": {
Jan Jongboom 0:85fdc69bc10c 34 "help": "Pin used as TX (connects to ESP8266 RX)",
Jan Jongboom 0:85fdc69bc10c 35 "value": "D1"
Jan Jongboom 0:85fdc69bc10c 36 },
Jan Jongboom 0:85fdc69bc10c 37 "esp8266-rx": {
Jan Jongboom 0:85fdc69bc10c 38 "help": "Pin used as RX (connects to ESP8266 TX)",
Jan Jongboom 0:85fdc69bc10c 39 "value": "D0"
Jan Jongboom 0:85fdc69bc10c 40 },
Jan Jongboom 0:85fdc69bc10c 41 "esp8266-debug": {
Jan Jongboom 0:85fdc69bc10c 42 "value": false
Jan Jongboom 23:6a9d776c9794 43 },
Jan Jongboom 23:6a9d776c9794 44
Jan Jongboom 23:6a9d776c9794 45 "main-stack-size": {
Jan Jongboom 23:6a9d776c9794 46 "value": 8192
Jan Jongboom 0:85fdc69bc10c 47 }
Jan Jongboom 0:85fdc69bc10c 48 },
Jan Jongboom 16:1374b4c35897 49 "macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_entropy_config.h\"",
Jan Jongboom 17:97b1dd566b07 50 "MBEDTLS_TEST_NULL_ENTROPY", "MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES" ],
Jan Jongboom 0:85fdc69bc10c 51 "target_overrides": {
Jan Jongboom 0:85fdc69bc10c 52 "*": {
Jan Jongboom 29:5ad8f931e4ff 53 "platform.stdio-baud-rate": 115200,
Jan Jongboom 29:5ad8f931e4ff 54 "platform.stdio-convert-newlines": true,
Jan Jongboom 0:85fdc69bc10c 55 "target.features_add": ["NANOSTACK", "LOWPAN_ROUTER", "COMMON_PAL"],
Jan Jongboom 0:85fdc69bc10c 56 "mbed-mesh-api.6lowpan-nd-channel-page": 0,
Jan Jongboom 0:85fdc69bc10c 57 "mbed-mesh-api.6lowpan-nd-channel": 12,
Jan Jongboom 2:4b4ac59ff9b0 58 "mbed-trace.enable": 0,
Jan Jongboom 5:42f713b19337 59 "mbed-http.http-buffer-size": 2048
Jan Jongboom 0:85fdc69bc10c 60 },
Jan Jongboom 0:85fdc69bc10c 61 "HEXIWEAR": {
Jan Jongboom 0:85fdc69bc10c 62 "esp8266-tx": "PTD3",
Jan Jongboom 0:85fdc69bc10c 63 "esp8266-rx": "PTD2"
Jan Jongboom 0:85fdc69bc10c 64 },
Jan Jongboom 0:85fdc69bc10c 65 "NUCLEO_F401RE": {
Jan Jongboom 0:85fdc69bc10c 66 "esp8266-tx": "D8",
Jan Jongboom 0:85fdc69bc10c 67 "esp8266-rx": "D2"
Jan Jongboom 0:85fdc69bc10c 68 },
Jan Jongboom 0:85fdc69bc10c 69 "NUCLEO_F411RE": {
Jan Jongboom 0:85fdc69bc10c 70 "esp8266-tx": "D8",
Jan Jongboom 0:85fdc69bc10c 71 "esp8266-rx": "D2"
Jan Jongboom 0:85fdc69bc10c 72 }
Jan Jongboom 0:85fdc69bc10c 73 }
Jan Jongboom 0:85fdc69bc10c 74 }