Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-01-05 12:21:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fix use of dangling pointers in esp-idf MQTT backend (#4239)

Browse source 
fixes https://github.com/esphome/issues/issues/3406
This commit is contained in:
Adam Liddell 2023-01-11 03:31:04 +00:00 committed by GitHub
parent 86a8e1f4a6
commit 351ea04517
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 42 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
esphome/components/mqtt/mqtt_backend_idf.cpp
View file

@ -69,7 +69,7 @@ void MQTTBackendIDF::loop() {
} }
} }
void MQTTBackendIDF::mqtt_event_handler_(const esp_mqtt_event_t &event) { void MQTTBackendIDF::mqtt_event_handler_(const Event &event) {
ESP_LOGV(TAG, "Event dispatched from event loop event_id=%d", event.event_id); ESP_LOGV(TAG, "Event dispatched from event loop event_id=%d", event.event_id);
switch (event.event_id) { switch (event.event_id) {
case MQTT_EVENT_BEFORE_CONNECT: case MQTT_EVENT_BEFORE_CONNECT:
@ -104,28 +104,24 @@ void MQTTBackendIDF::mqtt_event_handler_(const esp_mqtt_event_t &event) {
break; break;
case MQTT_EVENT_DATA: { case MQTT_EVENT_DATA: {
static std::string topic; static std::string topic;
if (event.topic) { if (event.topic.length() > 0) {
// not 0 terminated - create a string from it topic = event.topic;
topic = std::string(event.topic, event.topic_len);
} }
ESP_LOGV(TAG, "MQTT_EVENT_DATA %s", topic.c_str()); ESP_LOGV(TAG, "MQTT_EVENT_DATA %s", topic.c_str());
auto data_len = event.data_len; this->on_message_.call(event.topic.length() > 0 ? topic.c_str() : nullptr, event.data.data(), event.data.size(),
if (data_len == 0)
data_len = strlen(event.data);
this->on_message_.call(event.topic ? const_cast<char *>(topic.c_str()) : nullptr, event.data, data_len,
event.current_data_offset, event.total_data_len); event.current_data_offset, event.total_data_len);
} break; } break;
case MQTT_EVENT_ERROR: case MQTT_EVENT_ERROR:
ESP_LOGE(TAG, "MQTT_EVENT_ERROR"); ESP_LOGE(TAG, "MQTT_EVENT_ERROR");
if (event.error_handle->error_type == MQTT_ERROR_TYPE_TCP_TRANSPORT) { if (event.error_handle.error_type == MQTT_ERROR_TYPE_TCP_TRANSPORT) {
ESP_LOGE(TAG, "Last error code reported from esp-tls: 0x%x", event.error_handle->esp_tls_last_esp_err); ESP_LOGE(TAG, "Last error code reported from esp-tls: 0x%x", event.error_handle.esp_tls_last_esp_err);
ESP_LOGE(TAG, "Last tls stack error number: 0x%x", event.error_handle->esp_tls_stack_err); ESP_LOGE(TAG, "Last tls stack error number: 0x%x", event.error_handle.esp_tls_stack_err);
ESP_LOGE(TAG, "Last captured errno : %d (%s)", event.error_handle->esp_transport_sock_errno, ESP_LOGE(TAG, "Last captured errno : %d (%s)", event.error_handle.esp_transport_sock_errno,
strerror(event.error_handle->esp_transport_sock_errno)); strerror(event.error_handle.esp_transport_sock_errno));
} else if (event.error_handle->error_type == MQTT_ERROR_TYPE_CONNECTION_REFUSED) { } else if (event.error_handle.error_type == MQTT_ERROR_TYPE_CONNECTION_REFUSED) {
ESP_LOGE(TAG, "Connection refused error: 0x%x", event.error_handle->connect_return_code); ESP_LOGE(TAG, "Connection refused error: 0x%x", event.error_handle.connect_return_code);
} else { } else {
ESP_LOGE(TAG, "Unknown error type: 0x%x", event.error_handle->error_type); ESP_LOGE(TAG, "Unknown error type: 0x%x", event.error_handle.error_type);
} }
break; break;
default: default:
@ -140,7 +136,7 @@ void MQTTBackendIDF::mqtt_event_handler(void *handler_args, esp_event_base_t bas
// queue event to decouple processing // queue event to decouple processing
if (instance) { if (instance) {
auto event = *static_cast<esp_mqtt_event_t *>(event_data); auto event = *static_cast<esp_mqtt_event_t *>(event_data);
instance->mqtt_events_.push(event); instance->mqtt_events_.push(Event(event));
} }
} }

31
esphome/components/mqtt/mqtt_backend_idf.h
View file

@ -12,6 +12,33 @@
namespace esphome { namespace esphome {
namespace mqtt { namespace mqtt {
struct Event {
esp_mqtt_event_id_t event_id;
std::vector<char> data;
int total_data_len;
int current_data_offset;
std::string topic;
int msg_id;
bool retain;
int qos;
bool dup;
esp_mqtt_error_codes_t error_handle;
// Construct from esp_mqtt_event_t
// Any pointer values that are unsafe to keep are converted to safe copies
Event(const esp_mqtt_event_t &event)
: event_id(event.event_id),
data(event.data, event.data + event.data_len),
total_data_len(event.total_data_len),
current_data_offset(event.current_data_offset),
topic(event.topic, event.topic_len),
msg_id(event.msg_id),
retain(event.retain),
qos(event.qos),
dup(event.dup),
error_handle(*event.error_handle) {}
};
class MQTTBackendIDF final : public MQTTBackend { class MQTTBackendIDF final : public MQTTBackend {
public: public:
static const size_t MQTT_BUFFER_SIZE = 4096; static const size_t MQTT_BUFFER_SIZE = 4096;
@ -99,7 +126,7 @@ class MQTTBackendIDF final : public MQTTBackend {
protected: protected:
bool initialize_(); bool initialize_();
void mqtt_event_handler_(const esp_mqtt_event_t &event); void mqtt_event_handler_(const Event &event);
static void mqtt_event_handler(void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data); static void mqtt_event_handler(void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data);
struct MqttClientDeleter { struct MqttClientDeleter {
@ -134,7 +161,7 @@ class MQTTBackendIDF final : public MQTTBackend {
CallbackManager<on_unsubscribe_callback_t> on_unsubscribe_; CallbackManager<on_unsubscribe_callback_t> on_unsubscribe_;
CallbackManager<on_message_callback_t> on_message_; CallbackManager<on_message_callback_t> on_message_;
CallbackManager<on_publish_user_callback_t> on_publish_; CallbackManager<on_publish_user_callback_t> on_publish_;
std::queue<esp_mqtt_event_t> mqtt_events_; std::queue<Event> mqtt_events_;
}; };
} // namespace mqtt } // namespace mqtt