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:
Wed Feb 15 21:57:31 2017 +0100
Revision:
0:85fdc69bc10c
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:85fdc69bc10c 1 http_parser.c is based on src/http/ngx_http_parse.c from NGINX copyright
Jan Jongboom 0:85fdc69bc10c 2 Igor Sysoev.
Jan Jongboom 0:85fdc69bc10c 3
Jan Jongboom 0:85fdc69bc10c 4 Additional changes are licensed under the same terms as NGINX and
Jan Jongboom 0:85fdc69bc10c 5 copyright Joyent, Inc. and other Node contributors. All rights reserved.
Jan Jongboom 0:85fdc69bc10c 6
Jan Jongboom 0:85fdc69bc10c 7 Permission is hereby granted, free of charge, to any person obtaining a copy
Jan Jongboom 0:85fdc69bc10c 8 of this software and associated documentation files (the "Software"), to
Jan Jongboom 0:85fdc69bc10c 9 deal in the Software without restriction, including without limitation the
Jan Jongboom 0:85fdc69bc10c 10 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
Jan Jongboom 0:85fdc69bc10c 11 sell copies of the Software, and to permit persons to whom the Software is
Jan Jongboom 0:85fdc69bc10c 12 furnished to do so, subject to the following conditions:
Jan Jongboom 0:85fdc69bc10c 13
Jan Jongboom 0:85fdc69bc10c 14 The above copyright notice and this permission notice shall be included in
Jan Jongboom 0:85fdc69bc10c 15 all copies or substantial portions of the Software.
Jan Jongboom 0:85fdc69bc10c 16
Jan Jongboom 0:85fdc69bc10c 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jan Jongboom 0:85fdc69bc10c 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jan Jongboom 0:85fdc69bc10c 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Jan Jongboom 0:85fdc69bc10c 20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jan Jongboom 0:85fdc69bc10c 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Jan Jongboom 0:85fdc69bc10c 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
Jan Jongboom 0:85fdc69bc10c 23 IN THE SOFTWARE.