Chapter 2. API Reference
API Reference
Header File
• components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.h
Functions
esp_err_t esp_crt_bundle_attach(void *conf)
Attach and enable use of a bundle for certificate verification.
Attach and enable use of a bundle for certificate verification through a verification callback. If no specific bundle
has been set through esp_crt_bundle_set() it will default to the bundle defined in menuconfig and embedded in
the binary.
Return
• ESP_OK if adding certificates was successful.
• Other if an error occured or an action must be taken by the calling process.
Parameters
• [in] conf: The config struct for the SSL connection.
void esp_crt_bundle_detach(mbedtls_ssl_config *conf)
Disable and dealloc the certification bundle.
Removes the certificate verification callback and deallocates used resources
Parameters
• [in] conf: The config struct for the SSL connection.
void esp_crt_bundle_set(const uint8_t *x509_bundle)
Set the default certificate bundle used for verification.
Overrides the default certificate bundle. In most use cases the bundle should be set through menuconfig. The
bundle needs to be sorted by subject name since binary search is used to find certificates.
Parameters
• [in] x509_bundle: A pointer to the certificate bundle.
Code examples for this API section are provided in the protocols directory of ESP-IDF examples.
2.3.15 IP Network Layer
Documentation for IP Network Layer protocols (below the Application Protocol layer) are provided in Networking
APIs.
2.4 Provisioning API
2.4.1 Protocol Communication
Overview
Protocol Communication (protocomm) component manages secure sessions and provides framework for multiple
transports. The application can also use protocomm layer directly to have application specific extensions for the
provisioning (or non-provisioning) use cases.
Following features are available for provisioning :
• Communication security at application level -
– protocomm_security0 (no security)
– protocomm_security1 (curve25519 key exchange + AES-CTR encryption)
• Proof-of-possession (support with protocomm_security1 only)
Espressif Systems 664
Submit Document Feedback
Release v4.4