From 9f59dca90b34638cb36c21cbcf1914066442b123 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Mon, 28 Sep 2015 13:09:07 +1000 Subject: [PATCH] Update README regarding mbedTLS --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 5b8f64f..a202dbd 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ Current status is alpha quality, actively developed. AP STATION mode (ie wifi cl * `include` contains header files from Espressif RTOS SDK, relating to the binary libraries & Xtensa core. * `core` contains source & headers for low-level ESP8266 functions & peripherals. `core/include/esp` contains useful headers for peripheral access, etc. Minimal to no FreeRTOS dependencies. * `extras` is a directory that contains optional components that can be added to your project. Most 'extras' components will have a corresponding example in the `examples` directory. Extras include: + - mbedtls - [mbedTLS](https://tls.mbed.org/) is a TLS/SSL library providing up to date secure connectivity and encryption support. - i2c - software i2c driver ([upstream project](https://github.com/kanflo/esp-open-rtos-driver-i2c)) - rboot-ota - OTA support (over-the-air updates) including a TFTP server for receiving updates ([for rboot by @raburton](http://richard.burtons.org/2015/05/18/rboot-a-new-boot-loader-for-esp8266/)) - bmp180 driver for digital pressure sensor ([upstream project](https://github.com/Angus71/esp-open-rtos-driver-bmp180)) @@ -88,6 +89,8 @@ Binary libraries (inside the `lib` dir) are all supplied by Espressif as part of As part of the esp-open-rtos build process, all binary SDK symbols are prefixed with `sdk_`. This makes it easier to differentiate binary & open source code, and also prevents namespace conflicts. +Espressif's RTOS SDK provided a "libssl" based on axTLS. This has been replaced with the more up to date mbedTLS library (see below). + Some binary libraries appear to contain unattributed open source code: * libnet80211.a & libwpa.a appear to be based on FreeBSD net80211/wpa, or forks of them. ([See this issue](https://github.com/SuperHouse/esp-open-rtos/issues/4)). @@ -103,6 +106,8 @@ Some binary libraries appear to contain unattributed open source code: * Newlib is covered by several copyrights and licenses, as per the files in the `libc` directory. +* [mbedTLS](https://tls.mbed.org/) is provided under the Apache 2.0 license as described in the file extras/mbedtls/mbedtls/apache-2.0.txt. mbedTLS is Copyright (C) ARM Limited. + Components under `extras/` may contain different licenses, please see those directories for details. ## Contributions