esp_tls.rst 938 B

123456789101112131415161718192021222324
  1. ESP-TLS
  2. =======
  3. Overview
  4. --------
  5. The ESP-TLS component provides a simplified API interface for accessing the commonly used TLS functionality.
  6. It supports common scenarios like CA certification validation, SNI, ALPN negotiation, non-blocking connection among others.
  7. All the configuration can be specified in the esp_tls_cfg_t data structure. Once done, TLS communication can be conducted using the following APIs:
  8. * esp_tls_conn_new(): for opening a new TLS connection
  9. * esp_tls_conn_read/write(): for reading/writing from the connection
  10. * esp_tls_conn_delete(): for freeing up the connection
  11. Any application layer protocol like HTTP1, HTTP2 etc can be executed on top of this layer.
  12. Application Example
  13. -------------------
  14. Simple HTTPS example that uses ESP-TLS to establish a secure socket connection: :example:`protocols/https_request`.
  15. API Reference
  16. -------------
  17. .. include:: /_build/inc/esp_tls.inc