Symbols

Files

Summary Syntax Examples References Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFcredentials_t::authentication

credentials_t::authentication field

Client authentication Fields related to client authentication by broker For mutual authentication using TLS, user could select certificate and key, secure element or digital signature peripheral if available. Client authentication

Syntax

Show:

Summary

Declaration

from mqtt_client.h:287

struct authentication_t { const char *password; const char *certificate; size_t certificate_len; const char *key; size_t key_len; const char *key_password; int key_password_len; bool use_secure_element; void *ds_data; } authentication;

Examples

credentials_t::authentication is referenced by 2 libraries and example projects:

mqtt5 sample

ssl_mutual_auth sample

References

from 0/2 examples

Code

Location

Referrer

} authentication; /*!< Client authentication */

mqtt_client.h:301

ESP_MEM_CHECK(TAG, esp_mqtt_set_if_config(config->credentials.authentication.password, &client->mqtt_state.connection.information.password), goto _mqtt_set_config_failed);

mqtt_client.c:441

esp_mqtt_set_config()

client->config->clientcert_buf = config->credentials.authentication.certificate;

mqtt_client.c:567

esp_mqtt_set_config()

client->config->clientcert_bytes = config->credentials.authentication.certificate_len;

mqtt_client.c:568

esp_mqtt_set_config()

client->config->clientkey_buf = config->credentials.authentication.key;

mqtt_client.c:569

esp_mqtt_set_config()

client->config->clientkey_bytes = config->credentials.authentication.key_len;

mqtt_client.c:570

esp_mqtt_set_config()

client->config->use_secure_element = config->credentials.authentication.use_secure_element;

mqtt_client.c:573

esp_mqtt_set_config()

client->config->ds_data = config->credentials.authentication.ds_data;

mqtt_client.c:574

esp_mqtt_set_config()

if (config->credentials.authentication.key_password && config->credentials.authentication.key_password_len) {

mqtt_client.c:576

esp_mqtt_set_config()

client->config->clientkey_password_len = config->credentials.authentication.key_password_len;

mqtt_client.c:577

esp_mqtt_set_config()

memcpy(client->config->clientkey_password, config->credentials.authentication.key_password, client->config->clientkey_password_len);

mqtt_client.c:580

esp_mqtt_set_config()

Call Tree

from 0/2 examples

All items filtered out

Data Use

from 0/2 examples

credentials_t::authentication is read by 1 function:

credentials_t::authentication

esp_mqtt_set_config()

Class Tree

from 0/2 examples

All items filtered out

Override Tree

from 0/2 examples

All items filtered out

Implementations

from 0/2 examples

All items filtered out

Instances

from 0/2 examples

Lifecycle

from 0/2 examples

All items filtered out