24static const char *
const TAG =
"esphome.ota";
25static constexpr uint16_t OTA_BLOCK_SIZE = 8192;
26static constexpr size_t OTA_BUFFER_SIZE = 1024;
27static constexpr uint32_t OTA_SOCKET_TIMEOUT_HANDSHAKE = 20000;
28static constexpr uint32_t OTA_SOCKET_TIMEOUT_DATA = 90000;
38 int err = this->
server_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable,
sizeof(
int));
43 err = this->
server_->setblocking(
false);
76 "Over-The-Air updates:\n"
80#ifdef USE_OTA_PASSWORD
82 ESP_LOGCONFIG(TAG,
" Password configured");
97static const uint8_t FEATURE_SUPPORTS_COMPRESSION = 0x01;
98static const uint8_t FEATURE_SUPPORTS_SHA256_AUTH = 0x02;
107 if (this->
client_ ==
nullptr) {
116 int err = this->
client_->setsockopt(IPPROTO_TCP, TCP_NODELAY, &enable,
sizeof(
int));
122 err = this->
client_->setblocking(
false);
137 ESP_LOGW(TAG,
"Handshake timeout");
145 if (!this->
try_read_(5, LOG_STR(
"read magic"))) {
150 static const uint8_t MAGIC_BYTES[5] = {0x6C, 0x26, 0xF7, 0x5C, 0x45};
152 ESP_LOGW(TAG,
"Magic bytes mismatch! 0x%02X-0x%02X-0x%02X-0x%02X-0x%02X", this->
handshake_buf_[0],
167 if (!this->
try_write_(2, LOG_STR(
"ack magic"))) {
178 if (!this->
try_read_(1, LOG_STR(
"read feature"))) {
185 ((this->
ota_features_ & FEATURE_SUPPORTS_COMPRESSION) != 0 && this->
backend_->supports_compression())
193 if (!this->
try_write_(1, LOG_STR(
"ack feature"))) {
196#ifdef USE_OTA_PASSWORD
209#ifdef USE_OTA_PASSWORD
247 bool update_started =
false;
249 uint32_t last_progress = 0;
250 uint8_t buf[OTA_BUFFER_SIZE];
251 char *sbuf =
reinterpret_cast<char *
>(buf);
253#if USE_OTA_VERSION == 2
254 size_t size_acknowledged = 0;
265 ota_size = (
static_cast<size_t>(buf[0]) << 24) | (
static_cast<size_t>(buf[1]) << 16) |
266 (
static_cast<size_t>(buf[2]) << 8) | buf[3];
267 ESP_LOGV(TAG,
"Size is %u bytes", ota_size);
275#ifdef USE_OTA_STATE_LISTENER
280 error_code = this->
backend_->begin(ota_size);
283 update_started =
true;
294 ESP_LOGV(TAG,
"Update: Binary MD5 is %s", sbuf);
295 this->
backend_->set_update_md5(sbuf);
300 while (total < ota_size) {
302 size_t remaining = ota_size - total;
303 size_t requested = remaining < OTA_BUFFER_SIZE ? remaining : OTA_BUFFER_SIZE;
310 ESP_LOGW(TAG,
"Read err %d", errno);
312 }
else if (read == 0) {
313 ESP_LOGW(TAG,
"Remote closed");
317 error_code = this->
backend_->write(buf, read);
319 ESP_LOGW(TAG,
"Flash write err %d", error_code);
323#if USE_OTA_VERSION == 2
324 while (size_acknowledged + OTA_BLOCK_SIZE <= total || (total == ota_size && size_acknowledged < ota_size)) {
326 size_acknowledged += OTA_BLOCK_SIZE;
331 if (now - last_progress > 1000) {
333 float percentage = (total * 100.0f) / ota_size;
334 ESP_LOGD(TAG,
"Progress: %0.1f%%", percentage);
335#ifdef USE_OTA_STATE_LISTENER
348 ESP_LOGW(TAG,
"End update err %d", error_code);
363 ESP_LOGI(TAG,
"Update complete");
365#ifdef USE_OTA_STATE_LISTENER
372 this->
write_byte_(
static_cast<uint8_t
>(error_code));
375 if (this->
backend_ !=
nullptr && update_started) {
382#ifdef USE_OTA_STATE_LISTENER
388 uint32_t start =
millis();
390 while (
len - at > 0) {
392 if (now - start > OTA_SOCKET_TIMEOUT_DATA) {
393 ESP_LOGW(TAG,
"Timeout reading %zu bytes",
len);
400 ESP_LOGW(TAG,
"Read err %zu bytes, errno %d",
len, errno);
403 }
else if (read == 0) {
404 ESP_LOGW(TAG,
"Remote closed");
415 uint32_t start =
millis();
417 while (
len - at > 0) {
419 if (now - start > OTA_SOCKET_TIMEOUT_DATA) {
420 ESP_LOGW(TAG,
"Timeout writing %zu bytes",
len);
427 ESP_LOGW(TAG,
"Write err %zu bytes, errno %d",
len, errno);
443 ESP_LOGW(TAG,
"Socket %s: errno %d", LOG_STR_ARG(msg), errno);
449 char peername[socket::SOCKADDR_STR_LEN];
450 this->
client_->getpeername_to(peername);
451 ESP_LOGD(TAG,
"Starting %s from %s", LOG_STR_ARG(phase), peername);
455 ESP_LOGW(TAG,
"Remote closed at %s", LOG_STR_ARG(during));
492 this->handshake_buf_pos_ += read;
494 return this->handshake_buf_pos_ >= to_read;
506 this->handshake_buf_pos_ += written;
508 return this->handshake_buf_pos_ >= to_write;
519#ifdef USE_OTA_PASSWORD
529#ifdef USE_OTA_PASSWORD
533 bool client_supports_sha256 = (this->
ota_features_ & FEATURE_SUPPORTS_SHA256_AUTH) != 0;
536 if (!client_supports_sha256) {
570 const size_t hex_size = hasher.
get_size() * 2;
571 const size_t nonce_len = hasher.
get_size() / 4;
572 const size_t auth_buf_size = 1 + 3 * hex_size;
573 this->
auth_buf_ = std::make_unique<uint8_t[]>(auth_buf_size);
576 char *buf =
reinterpret_cast<char *
>(this->
auth_buf_.get() + 1);
577 if (!
random_bytes(
reinterpret_cast<uint8_t *
>(buf), nonce_len)) {
584 hasher.
add(buf, nonce_len);
589 ESP_LOGV(TAG,
"Auth: Nonce is %.*s", hex_size, buf);
594 const size_t to_write = 1 + hex_size;
602 this->auth_buf_pos_ += written;
605 if (this->auth_buf_pos_ < to_write) {
610 this->auth_buf_pos_ = 0;
616 const size_t to_read = hex_size * 2;
620 size_t cnonce_offset = 1 + hex_size;
628 this->auth_buf_pos_ += read;
631 if (this->auth_buf_pos_ < to_read) {
636 const char *nonce =
reinterpret_cast<char *
>(this->
auth_buf_.get() + 1);
637 const char *cnonce = nonce + hex_size;
638 const char *response = cnonce + hex_size;
645 hasher.
add(this->
password_.c_str(), this->password_.length());
646 hasher.
add(nonce, hex_size * 2);
649 ESP_LOGV(TAG,
"Auth: CNonce is %.*s", hex_size, cnonce);
650#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
653 ESP_LOGV(TAG,
"Auth: Result is %.*s", hex_size, computed_hash);
655 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)
SHA256 hash implementation.
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.