23static const char *
const TAG =
"esphome.ota";
24static constexpr uint16_t OTA_BLOCK_SIZE = 8192;
25static constexpr size_t OTA_BUFFER_SIZE = 1024;
26static constexpr uint32_t OTA_SOCKET_TIMEOUT_HANDSHAKE = 20000;
27static constexpr uint32_t OTA_SOCKET_TIMEOUT_DATA = 90000;
37 int err = this->
server_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable,
sizeof(
int));
42 err = this->
server_->setblocking(
false);
75 "Over-The-Air updates:\n"
79#ifdef USE_OTA_PASSWORD
81 ESP_LOGCONFIG(TAG,
" Password configured");
96static const uint8_t FEATURE_SUPPORTS_COMPRESSION = 0x01;
97static const uint8_t FEATURE_SUPPORTS_SHA256_AUTH = 0x02;
106 if (this->
client_ ==
nullptr) {
115 int err = this->
client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable,
sizeof(
int));
121 err = this->
client_->setblocking(
false);
136 ESP_LOGW(TAG,
"Handshake timeout");
144 if (!this->
try_read_(5, LOG_STR(
"read magic"))) {
149 static const uint8_t MAGIC_BYTES[5] = {0x6C, 0x26, 0xF7, 0x5C, 0x45};
151 ESP_LOGW(TAG,
"Magic bytes mismatch! 0x%02X-0x%02X-0x%02X-0x%02X-0x%02X", this->
handshake_buf_[0],
166 if (!this->
try_write_(2, LOG_STR(
"ack magic"))) {
177 if (!this->
try_read_(1, LOG_STR(
"read feature"))) {
184 ((this->
ota_features_ & FEATURE_SUPPORTS_COMPRESSION) != 0 && this->
backend_->supports_compression())
192 if (!this->
try_write_(1, LOG_STR(
"ack feature"))) {
195#ifdef USE_OTA_PASSWORD
208#ifdef USE_OTA_PASSWORD
246 bool update_started =
false;
248 uint32_t last_progress = 0;
249 uint8_t buf[OTA_BUFFER_SIZE];
250 char *sbuf =
reinterpret_cast<char *
>(buf);
252#if USE_OTA_VERSION == 2
253 size_t size_acknowledged = 0;
264 ota_size = (
static_cast<size_t>(buf[0]) << 24) | (
static_cast<size_t>(buf[1]) << 16) |
265 (
static_cast<size_t>(buf[2]) << 8) | buf[3];
266 ESP_LOGV(TAG,
"Size is %u bytes", ota_size);
274#ifdef USE_OTA_STATE_LISTENER
279 error_code = this->
backend_->begin(ota_size);
282 update_started =
true;
293 ESP_LOGV(TAG,
"Update: Binary MD5 is %s", sbuf);
294 this->
backend_->set_update_md5(sbuf);
299 while (total < ota_size) {
301 size_t remaining = ota_size - total;
302 size_t requested = remaining < OTA_BUFFER_SIZE ? remaining : OTA_BUFFER_SIZE;
309 ESP_LOGW(TAG,
"Read err %d", errno);
311 }
else if (read == 0) {
312 ESP_LOGW(TAG,
"Remote closed");
316 error_code = this->
backend_->write(buf, read);
318 ESP_LOGW(TAG,
"Flash write err %d", error_code);
322#if USE_OTA_VERSION == 2
323 while (size_acknowledged + OTA_BLOCK_SIZE <= total || (total == ota_size && size_acknowledged < ota_size)) {
325 size_acknowledged += OTA_BLOCK_SIZE;
330 if (now - last_progress > 1000) {
332 float percentage = (total * 100.0f) / ota_size;
333 ESP_LOGD(TAG,
"Progress: %0.1f%%", percentage);
334#ifdef USE_OTA_STATE_LISTENER
347 ESP_LOGW(TAG,
"End update err %d", error_code);
362 ESP_LOGI(TAG,
"Update complete");
364#ifdef USE_OTA_STATE_LISTENER
371 this->
write_byte_(
static_cast<uint8_t
>(error_code));
374 if (this->
backend_ !=
nullptr && update_started) {
379#ifdef USE_OTA_STATE_LISTENER
385 uint32_t start =
millis();
387 while (
len - at > 0) {
389 if (now - start > OTA_SOCKET_TIMEOUT_DATA) {
390 ESP_LOGW(TAG,
"Timeout reading %d bytes",
len);
397 ESP_LOGW(TAG,
"Read err %d bytes, errno %d",
len, errno);
400 }
else if (read == 0) {
401 ESP_LOGW(TAG,
"Remote closed");
412 uint32_t start =
millis();
414 while (
len - at > 0) {
416 if (now - start > OTA_SOCKET_TIMEOUT_DATA) {
417 ESP_LOGW(TAG,
"Timeout writing %d bytes",
len);
424 ESP_LOGW(TAG,
"Write err %d bytes, errno %d",
len, errno);
440 ESP_LOGW(TAG,
"Socket %s: errno %d", LOG_STR_ARG(msg), errno);
446 ESP_LOGD(TAG,
"Starting %s from %s", LOG_STR_ARG(phase), this->
client_->getpeername().c_str());
450 ESP_LOGW(TAG,
"Remote closed at %s", LOG_STR_ARG(during));
487 this->handshake_buf_pos_ += read;
489 return this->handshake_buf_pos_ >= to_read;
501 this->handshake_buf_pos_ += written;
503 return this->handshake_buf_pos_ >= to_write;
514#ifdef USE_OTA_PASSWORD
524#ifdef USE_OTA_PASSWORD
528 bool client_supports_sha256 = (this->
ota_features_ & FEATURE_SUPPORTS_SHA256_AUTH) != 0;
531 if (!client_supports_sha256) {
565 const size_t hex_size = hasher.
get_size() * 2;
566 const size_t nonce_len = hasher.
get_size() / 4;
567 const size_t auth_buf_size = 1 + 3 * hex_size;
568 this->
auth_buf_ = std::make_unique<uint8_t[]>(auth_buf_size);
571 char *buf =
reinterpret_cast<char *
>(this->
auth_buf_.get() + 1);
572 if (!
random_bytes(
reinterpret_cast<uint8_t *
>(buf), nonce_len)) {
579 hasher.
add(buf, nonce_len);
584 ESP_LOGV(TAG,
"Auth: Nonce is %.*s", hex_size, buf);
589 const size_t to_write = 1 + hex_size;
597 this->auth_buf_pos_ += written;
600 if (this->auth_buf_pos_ < to_write) {
605 this->auth_buf_pos_ = 0;
611 const size_t to_read = hex_size * 2;
615 size_t cnonce_offset = 1 + hex_size;
623 this->auth_buf_pos_ += read;
626 if (this->auth_buf_pos_ < to_read) {
631 const char *nonce =
reinterpret_cast<char *
>(this->
auth_buf_.get() + 1);
632 const char *cnonce = nonce + hex_size;
633 const char *response = cnonce + hex_size;
640 hasher.
add(this->
password_.c_str(), this->password_.length());
641 hasher.
add(nonce, hex_size * 2);
644 ESP_LOGV(TAG,
"Auth: CNonce is %.*s", hex_size, cnonce);
645#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
648 ESP_LOGV(TAG,
"Auth: Result is %.*s", hex_size, computed_hash);
650 ESP_LOGV(TAG,
"Auth: Response is %.*s", hex_size, response);
void feed_wdt(uint32_t time=0)
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
virtual void mark_failed()
Mark this component as failed.
void status_momentary_error(const char *name, uint32_t length=5000)
Set error status flag and automatically clear it after a timeout.
void status_set_warning(const char *message=nullptr)
void status_clear_warning()
bool would_block_(int error_code) const
std::unique_ptr< ota::OTABackend > backend_
uint8_t handshake_buf_pos_
uint16_t get_port() const
static constexpr size_t SHA256_HEX_SIZE
void yield_and_feed_watchdog_()
bool writeall_(const uint8_t *buf, size_t len)
bool try_read_(size_t to_read, const LogString *desc)
bool try_write_(size_t to_write, const LogString *desc)
void dump_config() override
std::unique_ptr< uint8_t[]> auth_buf_
bool handle_write_error_(ssize_t written, const LogString *desc)
uint8_t handshake_buf_[5]
void log_auth_warning_(const LogString *msg)
uint32_t client_connect_time_
float get_setup_priority() const override
void send_error_and_cleanup_(ota::OTAResponseTypes error)
bool handle_read_error_(ssize_t read, const LogString *desc)
void log_read_error_(const LogString *what)
bool readall_(uint8_t *buf, size_t len)
void set_port(uint16_t port)
Manually set the port OTA should listen on.
bool write_byte_(uint8_t byte)
std::unique_ptr< socket::Socket > server_
void transition_ota_state_(OTAState next_state)
void cleanup_connection_()
void log_remote_closed_(const LogString *during)
std::unique_ptr< socket::Socket > client_
void log_start_(const LogString *phase)
void log_socket_error_(const LogString *msg)
void get_hex(char *output)
Retrieve the hash as hex characters. Output buffer must hold get_size() * 2 + 1 bytes.
bool equals_hex(const char *expected)
Compare the hash against a provided hex-encoded hash.
void notify_state_(OTAState state, float progress, uint8_t error)
void calculate() override
size_t get_size() const override
Get the size of the hash in bytes (32 for SHA256)
void add(const uint8_t *data, size_t len) override
const char * get_use_address()
Get the active network hostname.
std::unique_ptr< ota::OTABackend > make_ota_backend()
@ OTA_RESPONSE_UPDATE_PREPARE_OK
@ OTA_RESPONSE_SUPPORTS_COMPRESSION
@ OTA_RESPONSE_BIN_MD5_OK
@ OTA_RESPONSE_UPDATE_END_OK
@ OTA_RESPONSE_RECEIVE_OK
@ OTA_RESPONSE_ERROR_AUTH_INVALID
@ OTA_RESPONSE_ERROR_UNKNOWN
@ OTA_RESPONSE_REQUEST_SHA256_AUTH
@ OTA_RESPONSE_ERROR_MAGIC
const float AFTER_WIFI
For components that should be initialized after WiFi is connected.
std::unique_ptr< Socket > socket_ip_loop_monitored(int type, int protocol)
socklen_t set_sockaddr_any(struct sockaddr *addr, socklen_t addrlen, uint16_t port)
Set a sockaddr to the any address and specified port for the IP version used by socket_ip().
Providing packet encoding functions for exchanging data with a remote host.
bool random_bytes(uint8_t *data, size_t len)
Generate len number of random bytes.
void IRAM_ATTR HOT delay(uint32_t ms)
uint32_t IRAM_ATTR HOT millis()
Application App
Global storage of Application pointer - only one Application can exist.