Merge branch 'doc/update_openssl_docs' into 'master'

docs: Migrated OpenSSL APIs from components/openssl/* to the API reference

Closes IDF-2541

See merge request espressif/esp-idf!12515
This commit is contained in:
Krzysztof Budzynski
2021-03-26 11:49:57 +00:00
4 changed files with 60 additions and 55 deletions

View File

@@ -8,6 +8,7 @@ Application Protocols
ASIO <asio>
ESP-MQTT <mqtt>
ESP-TLS <esp_tls>
OpenSSL APIs <openssl_apis>
HTTP Client <esp_http_client>
HTTP Server <esp_http_server>
HTTPS Server <esp_https_server>

View File

@@ -1,7 +1,7 @@
OpenSSL-APIs
------------
This directory does not contain OpenSSL itself, but the code here can be used as a wrapper for applications using the OpenSSL API.
The code of this API (located in :component:`openssl` directory), does not contain OpenSSL itself but is intended as a wrapper for applications using the OpenSSL API.
It uses mbedTLS to do the actual work, so anyone compiling openssl code needs the mbedtls library and header file.
OpenSSL APIs not mentioned in this article are not open to public for the time,
@@ -20,6 +20,8 @@ Chapter Introduction
Chapter 1. SSL Context Method Create
====================================
.. highlight:: none
1.1 const SSL_METHOD* ``SSLv3_client_method`` (void)
Arguments::
@@ -195,7 +197,7 @@ Chapter 1. SSL Context Method Create
create the target SSL context method
Example :
Example::
void example(void)
{
@@ -252,7 +254,7 @@ Chapter 1. SSL Context Method Create
}
Chapter 2. SSL Context Fucntion
Chapter 2. SSL Context Function
===============================
@@ -363,7 +365,7 @@ Chapter 2. SSL Context Fucntion
Chapter 3. SSL Fucntion
Chapter 3. SSL Function
=======================

View File

@@ -7,6 +7,7 @@
mDNS <mdns>
ESP-TLS <esp_tls>
OpenSSL APIs <openssl_apis>
HTTP Client <esp_http_client>
Websocket Client <esp_websocket_client>
HTTP 服务器 <esp_http_server>

View File

@@ -0,0 +1 @@
.. include:: ../../../en/api-reference/protocols/openssl_apis.rst