From 3057765c38d498815b14fbc794066f5cc411be48 Mon Sep 17 00:00:00 2001 From: Johan Stokking Date: Wed, 6 Mar 2024 21:56:58 +0100 Subject: [PATCH] feat(websocket): Support DS peripheral for mutual TLS --- components/esp_websocket_client/esp_websocket_client.c | 10 ++++++++++ .../include/esp_websocket_client.h | 7 +++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/components/esp_websocket_client/esp_websocket_client.c b/components/esp_websocket_client/esp_websocket_client.c index 4095960383..e0e5ab94f0 100644 --- a/components/esp_websocket_client/esp_websocket_client.c +++ b/components/esp_websocket_client/esp_websocket_client.c @@ -93,6 +93,9 @@ typedef struct { size_t client_cert_len; const char *client_key; size_t client_key_len; +#if CONFIG_ESP_TLS_USE_DS_PERIPHERAL + void *client_ds_data; +#endif bool use_global_ca_store; bool skip_cert_common_name_check; const char *cert_common_name; @@ -528,6 +531,10 @@ static esp_err_t esp_websocket_client_create_transport(esp_websocket_client_hand } else { esp_transport_ssl_set_client_key_data_der(ssl, client->config->client_key, client->config->client_key_len); } +#if CONFIG_ESP_TLS_USE_DS_PERIPHERAL + } else if (client->config->client_ds_data) { + esp_transport_ssl_set_ds_data(ssl, client->config->client_ds_data); +#endif } if (client->config->crt_bundle_attach) { #ifdef CONFIG_MBEDTLS_CERTIFICATE_BUNDLE @@ -693,6 +700,9 @@ esp_websocket_client_handle_t esp_websocket_client_init(const esp_websocket_clie client->config->client_cert_len = config->client_cert_len; client->config->client_key = config->client_key; client->config->client_key_len = config->client_key_len; +#if CONFIG_ESP_TLS_USE_DS_PERIPHERAL + client->config->client_ds_data = config->client_ds_data; +#endif client->config->skip_cert_common_name_check = config->skip_cert_common_name_check; client->config->cert_common_name = config->cert_common_name; client->config->crt_bundle_attach = config->crt_bundle_attach; diff --git a/components/esp_websocket_client/include/esp_websocket_client.h b/components/esp_websocket_client/include/esp_websocket_client.h index 34f85ae327..5f8663406d 100644 --- a/components/esp_websocket_client/include/esp_websocket_client.h +++ b/components/esp_websocket_client/include/esp_websocket_client.h @@ -106,10 +106,13 @@ typedef struct { int buffer_size; /*!< Websocket buffer size */ const char *cert_pem; /*!< Pointer to certificate data in PEM or DER format for server verify (with SSL), default is NULL, not required to verify the server. PEM-format must have a terminating NULL-character. DER-format requires the length to be passed in cert_len. */ size_t cert_len; /*!< Length of the buffer pointed to by cert_pem. May be 0 for null-terminated pem */ - const char *client_cert; /*!< Pointer to certificate data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. If it is not NULL, also `client_key` has to be provided. PEM-format must have a terminating NULL-character. DER-format requires the length to be passed in client_cert_len. */ + const char *client_cert; /*!< Pointer to certificate data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. If it is not NULL, also `client_key` or `client_ds_data` (if supported) has to be provided. PEM-format must have a terminating NULL-character. DER-format requires the length to be passed in client_cert_len. */ size_t client_cert_len; /*!< Length of the buffer pointed to by client_cert. May be 0 for null-terminated pem */ - const char *client_key; /*!< Pointer to private key data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. If it is not NULL, also `client_cert` has to be provided. PEM-format must have a terminating NULL-character. DER-format requires the length to be passed in client_key_len */ + const char *client_key; /*!< Pointer to private key data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. If it is not NULL, also `client_cert` has to be provided and `client_ds_data` (if supported) gets ignored. PEM-format must have a terminating NULL-character. DER-format requires the length to be passed in client_key_len */ size_t client_key_len; /*!< Length of the buffer pointed to by client_key_pem. May be 0 for null-terminated pem */ +#if CONFIG_ESP_TLS_USE_DS_PERIPHERAL + void *client_ds_data; /*!< Pointer to the encrypted private key data for SSL mutual authentication using the DS peripheral, default is NULL, not required if mutual authentication is not needed. If it is not NULL, also `client_cert` has to be provided. It is ignored if `client_key` is provided */ +#endif esp_websocket_transport_t transport; /*!< Websocket transport type, see `esp_websocket_transport_t */ const char *subprotocol; /*!< Websocket subprotocol */ const char *user_agent; /*!< Websocket user-agent */