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:
Thu Feb 16 11:48:57 2017 +0100
Revision:
2:4b4ac59ff9b0
Parent:
0:85fdc69bc10c
Child:
4:27fd8efb5bab
Move mbed-http into a separate library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:85fdc69bc10c 1 /*
Jan Jongboom 0:85fdc69bc10c 2 * Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
Jan Jongboom 0:85fdc69bc10c 3 * SPDX-License-Identifier: Apache-2.0
Jan Jongboom 0:85fdc69bc10c 4 *
Jan Jongboom 0:85fdc69bc10c 5 * Licensed under the Apache License, Version 2.0 (the "License"); you may
Jan Jongboom 0:85fdc69bc10c 6 * not use this file except in compliance with the License.
Jan Jongboom 0:85fdc69bc10c 7 * You may obtain a copy of the License at
Jan Jongboom 0:85fdc69bc10c 8 *
Jan Jongboom 0:85fdc69bc10c 9 * http://www.apache.org/licenses/LICENSE-2.0
Jan Jongboom 0:85fdc69bc10c 10 *
Jan Jongboom 0:85fdc69bc10c 11 * Unless required by applicable law or agreed to in writing, software
Jan Jongboom 0:85fdc69bc10c 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
Jan Jongboom 0:85fdc69bc10c 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Jan Jongboom 0:85fdc69bc10c 14 * See the License for the specific language governing permissions and
Jan Jongboom 0:85fdc69bc10c 15 * limitations under the License.
Jan Jongboom 0:85fdc69bc10c 16 *
Jan Jongboom 0:85fdc69bc10c 17 * This file is part of mbed TLS (https://tls.mbed.org)
Jan Jongboom 0:85fdc69bc10c 18 */
Jan Jongboom 0:85fdc69bc10c 19
Jan Jongboom 0:85fdc69bc10c 20 #include "select-demo.h"
Jan Jongboom 0:85fdc69bc10c 21
Jan Jongboom 0:85fdc69bc10c 22 /* Enable entropy for K64F and K22F. This means entropy is disabled for all other targets. */
Jan Jongboom 0:85fdc69bc10c 23 /* Do **NOT** deploy this code in production on other targets! */
Jan Jongboom 0:85fdc69bc10c 24 /* See https://tls.mbed.org/kb/how-to/add-entropy-sources-to-entropy-pool */
Jan Jongboom 0:85fdc69bc10c 25 #if defined(TARGET_K64F) || defined(TARGET_K22F)
Jan Jongboom 0:85fdc69bc10c 26 #undef MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Jan Jongboom 0:85fdc69bc10c 27 #undef MBEDTLS_TEST_NULL_ENTROPY
Jan Jongboom 0:85fdc69bc10c 28 #endif
Jan Jongboom 0:85fdc69bc10c 29
Jan Jongboom 2:4b4ac59ff9b0 30 #if DEMO == DEMO_HTTPS
Jan Jongboom 2:4b4ac59ff9b0 31
Jan Jongboom 0:85fdc69bc10c 32 #if !defined(MBEDTLS_ENTROPY_HARDWARE_ALT) && \
Jan Jongboom 0:85fdc69bc10c 33 !defined(MBEDTLS_ENTROPY_NV_SEED) && !defined(MBEDTLS_TEST_NULL_ENTROPY)
Jan Jongboom 0:85fdc69bc10c 34 #error "This hardware does not have an entropy source."
Jan Jongboom 0:85fdc69bc10c 35 #endif /* !MBEDTLS_ENTROPY_HARDWARE_ALT && !MBEDTLS_ENTROPY_NV_SEED &&
Jan Jongboom 0:85fdc69bc10c 36 * !MBEDTLS_TEST_NULL_ENTROPY */
Jan Jongboom 0:85fdc69bc10c 37
Jan Jongboom 0:85fdc69bc10c 38 #if !defined(MBEDTLS_SHA1_C)
Jan Jongboom 0:85fdc69bc10c 39 #define MBEDTLS_SHA1_C
Jan Jongboom 0:85fdc69bc10c 40 #endif /* !MBEDTLS_SHA1_C */
Jan Jongboom 0:85fdc69bc10c 41
Jan Jongboom 0:85fdc69bc10c 42 /*
Jan Jongboom 0:85fdc69bc10c 43 * This value is sufficient for handling 2048 bit RSA keys.
Jan Jongboom 0:85fdc69bc10c 44 *
Jan Jongboom 0:85fdc69bc10c 45 * Set this value higher to enable handling larger keys, but be aware that this
Jan Jongboom 0:85fdc69bc10c 46 * will increase the stack usage.
Jan Jongboom 0:85fdc69bc10c 47 */
Jan Jongboom 0:85fdc69bc10c 48 #define MBEDTLS_MPI_MAX_SIZE 256
Jan Jongboom 0:85fdc69bc10c 49
Jan Jongboom 0:85fdc69bc10c 50 #define MBEDTLS_MPI_WINDOW_SIZE 1
Jan Jongboom 0:85fdc69bc10c 51
Jan Jongboom 0:85fdc69bc10c 52 #endif