## Summary * **What is the goal of this PR?** Fix KOReader sync failing on HTTPS servers due to TLS out-of-memory on ESP32-C3 * **What changes are included?** - Replace `WiFiClientSecure`/`HTTPClient` with `esp_http_client` (ESP-IDF native API) for all KOSync HTTP requests - Use 2KB TLS buffers instead of the default 16KB — KOSync payloads are tiny JSON (<1KB), so this is more than sufficient - Use `esp_crt_bundle_attach` for proper TLS certificate verification (replaces `setInsecure()`) - Strip trailing slashes from server URL to prevent double-slash in API paths (e.g. `https://server.com//users/auth`) - Add `lastHttpCode` static field for diagnostics - Add free heap logging to help debug memory issues ### Problem The ESP32-C3 has ~46KB free heap after WiFi is initialized. `WiFiClientSecure` allocates 16KB for TLS RX + 16KB for TLS TX = 32KB just for the TLS buffers, leaving almost no room for the actual TLS handshake (which needs additional dynamic allocations). This causes KOReader sync to: 1. Fail silently with network errors on HTTPS servers (including the default `sync.koreader.rocks`) 2. Occasionally crash with heap exhaustion ### Solution `esp_http_client` (the ESP-IDF native HTTP client) allows configuring `buffer_size` and `buffer_size_tx` independently. Setting both to 2KB (total 4KB) leaves plenty of heap for the TLS handshake while still being sufficient for KOSync's small JSON payloads. This also fixes the `setInsecure()` anti-pattern — `esp_crt_bundle_attach` provides proper certificate verification using the ESP-IDF's built-in CA bundle, so credentials and reading history are no longer sent over unverified TLS connections. ### Files changed | File | Change | |------|--------| | `lib/KOReaderSync/KOReaderSyncClient.cpp` | Replace WiFiClientSecure/HTTPClient with esp_http_client; add ResponseBuffer, base64 encoder, createClient helper | | `lib/KOReaderSync/KOReaderSyncClient.h` | Add `lastHttpCode` static field | | `lib/KOReaderSync/KOReaderCredentialStore.cpp` | Strip trailing slashes from base URL | ## Additional Context Tested on a CrossPoint X4 (ESP32-C3 with 4MB flash). Before this change, KOSync auth to `sync.koreader.rocks` (HTTPS) would fail ~80% of the time. After: works reliably. The `base64Encode` helper is needed because `esp_http_client` doesn't have a built-in `setAuthorization()` method like `HTTPClient` does. This is used for the HTTP Basic Auth header required by Calibre-Web-Automated KOSync servers. Fixes #581 --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**PARTIALLY**_ AI assisted with the esp_http_client migration pattern and base64 encoder. The root cause analysis (TLS buffer OOM) and solution design were manual. --------- Co-authored-by: trilwu <trilwu@users.noreply.github.com> Co-authored-by: Justin Mitchell <justin@jmitch.com>
240 lines
7.8 KiB
C++
240 lines
7.8 KiB
C++
#include "KOReaderSyncClient.h"
|
|
|
|
#include <ArduinoJson.h>
|
|
#include <Logging.h>
|
|
#include <base64.h>
|
|
#include <esp_crt_bundle.h>
|
|
#include <esp_http_client.h>
|
|
|
|
#include <ctime>
|
|
|
|
#include "KOReaderCredentialStore.h"
|
|
|
|
int KOReaderSyncClient::lastHttpCode = 0;
|
|
|
|
namespace {
|
|
// Device identifier for CrossPoint reader
|
|
constexpr char DEVICE_NAME[] = "CrossPoint";
|
|
constexpr char DEVICE_ID[] = "crosspoint-reader";
|
|
|
|
// Small TLS buffers to fit in ESP32-C3's limited heap (~46KB free after WiFi).
|
|
// KOSync payloads are tiny JSON (<1KB), so 2KB buffers are sufficient.
|
|
// Default 16KB buffers cause OOM during TLS handshake.
|
|
constexpr int HTTP_BUF_SIZE = 2048;
|
|
|
|
// Response buffer for reading HTTP body
|
|
struct ResponseBuffer {
|
|
char* data = nullptr;
|
|
int len = 0;
|
|
int capacity = 0;
|
|
|
|
~ResponseBuffer() { free(data); }
|
|
|
|
bool ensure(int size) {
|
|
if (size <= capacity) return true;
|
|
char* newData = (char*)realloc(data, size);
|
|
if (!newData) return false;
|
|
data = newData;
|
|
capacity = size;
|
|
return true;
|
|
}
|
|
};
|
|
|
|
// HTTP event handler to collect response body
|
|
esp_err_t httpEventHandler(esp_http_client_event_t* evt) {
|
|
auto* buf = static_cast<ResponseBuffer*>(evt->user_data);
|
|
if (evt->event_id == HTTP_EVENT_ON_DATA && buf) {
|
|
if (buf->ensure(buf->len + evt->data_len + 1)) {
|
|
memcpy(buf->data + buf->len, evt->data, evt->data_len);
|
|
buf->len += evt->data_len;
|
|
buf->data[buf->len] = '\0';
|
|
} else {
|
|
LOG_ERR("KOSync", "Response buffer allocation failed (%d bytes)", evt->data_len);
|
|
}
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
// Create configured esp_http_client with small TLS buffers
|
|
esp_http_client_handle_t createClient(const char* url, ResponseBuffer* buf,
|
|
esp_http_client_method_t method = HTTP_METHOD_GET) {
|
|
esp_http_client_config_t config = {};
|
|
config.url = url;
|
|
config.event_handler = httpEventHandler;
|
|
config.user_data = buf;
|
|
config.method = method;
|
|
config.timeout_ms = 15000;
|
|
config.buffer_size = HTTP_BUF_SIZE;
|
|
config.buffer_size_tx = HTTP_BUF_SIZE;
|
|
config.crt_bundle_attach = esp_crt_bundle_attach;
|
|
|
|
esp_http_client_handle_t client = esp_http_client_init(&config);
|
|
if (!client) return nullptr;
|
|
|
|
// KOSync auth headers
|
|
if (esp_http_client_set_header(client, "Accept", "application/vnd.koreader.v1+json") != ESP_OK ||
|
|
esp_http_client_set_header(client, "x-auth-user", KOREADER_STORE.getUsername().c_str()) != ESP_OK ||
|
|
esp_http_client_set_header(client, "x-auth-key", KOREADER_STORE.getMd5Password().c_str()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set auth headers");
|
|
esp_http_client_cleanup(client);
|
|
return nullptr;
|
|
}
|
|
|
|
// HTTP Basic Auth for Calibre-Web-Automated compatibility
|
|
std::string credentials = KOREADER_STORE.getUsername() + ":" + KOREADER_STORE.getPassword();
|
|
String encoded = base64::encode(reinterpret_cast<const uint8_t*>(credentials.data()), credentials.size());
|
|
std::string authHeader = "Basic " + std::string(encoded.c_str());
|
|
if (esp_http_client_set_header(client, "Authorization", authHeader.c_str()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set Authorization header");
|
|
esp_http_client_cleanup(client);
|
|
return nullptr;
|
|
}
|
|
|
|
return client;
|
|
}
|
|
} // namespace
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::authenticate() {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/users/auth";
|
|
LOG_DBG("KOSync", "Authenticating: %s (heap: %u)", url.c_str(), (unsigned)ESP.getFreeHeap());
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Auth response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
if (httpCode == 200) return OK;
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::getProgress(const std::string& documentHash,
|
|
KOReaderProgress& outProgress) {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/syncs/progress/" + documentHash;
|
|
LOG_DBG("KOSync", "Getting progress: %s (heap: %u)", url.c_str(), (unsigned)ESP.getFreeHeap());
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Get progress response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
|
|
if (httpCode == 200 && buf.data) {
|
|
JsonDocument doc;
|
|
const DeserializationError error = deserializeJson(doc, buf.data);
|
|
|
|
if (error) {
|
|
LOG_ERR("KOSync", "JSON parse failed: %s", error.c_str());
|
|
return JSON_ERROR;
|
|
}
|
|
|
|
outProgress.document = documentHash;
|
|
outProgress.progress = doc["progress"].as<std::string>();
|
|
outProgress.percentage = doc["percentage"].as<float>();
|
|
outProgress.device = doc["device"].as<std::string>();
|
|
outProgress.deviceId = doc["device_id"].as<std::string>();
|
|
outProgress.timestamp = doc["timestamp"].as<int64_t>();
|
|
|
|
LOG_DBG("KOSync", "Got progress: %.2f%% at %s", outProgress.percentage * 100, outProgress.progress.c_str());
|
|
return OK;
|
|
}
|
|
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
if (httpCode == 404) return NOT_FOUND;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
KOReaderSyncClient::Error KOReaderSyncClient::updateProgress(const KOReaderProgress& progress) {
|
|
lastHttpCode = 0;
|
|
if (!KOREADER_STORE.hasCredentials()) {
|
|
LOG_DBG("KOSync", "No credentials configured");
|
|
return NO_CREDENTIALS;
|
|
}
|
|
|
|
std::string url = KOREADER_STORE.getBaseUrl() + "/syncs/progress";
|
|
LOG_DBG("KOSync", "Updating progress: %s (heap: %u)", url.c_str(), (unsigned)ESP.getFreeHeap());
|
|
|
|
// Build JSON body
|
|
JsonDocument doc;
|
|
doc["document"] = progress.document;
|
|
doc["progress"] = progress.progress;
|
|
doc["percentage"] = progress.percentage;
|
|
doc["device"] = DEVICE_NAME;
|
|
doc["device_id"] = DEVICE_ID;
|
|
|
|
std::string body;
|
|
serializeJson(doc, body);
|
|
|
|
LOG_DBG("KOSync", "Request body: %s", body.c_str());
|
|
|
|
ResponseBuffer buf;
|
|
esp_http_client_handle_t client = createClient(url.c_str(), &buf, HTTP_METHOD_PUT);
|
|
if (!client) return NETWORK_ERROR;
|
|
|
|
if (esp_http_client_set_header(client, "Content-Type", "application/json") != ESP_OK ||
|
|
esp_http_client_set_post_field(client, body.c_str(), body.length()) != ESP_OK) {
|
|
LOG_ERR("KOSync", "Failed to set request body");
|
|
esp_http_client_cleanup(client);
|
|
return NETWORK_ERROR;
|
|
}
|
|
|
|
esp_err_t err = esp_http_client_perform(client);
|
|
const int httpCode = esp_http_client_get_status_code(client);
|
|
lastHttpCode = httpCode;
|
|
esp_http_client_cleanup(client);
|
|
|
|
LOG_DBG("KOSync", "Update progress response: %d (err: %d)", httpCode, err);
|
|
|
|
if (err != ESP_OK) return NETWORK_ERROR;
|
|
if (httpCode == 200 || httpCode == 202) return OK;
|
|
if (httpCode == 401) return AUTH_FAILED;
|
|
return SERVER_ERROR;
|
|
}
|
|
|
|
const char* KOReaderSyncClient::errorString(Error error) {
|
|
switch (error) {
|
|
case OK:
|
|
return "Success";
|
|
case NO_CREDENTIALS:
|
|
return "No credentials configured";
|
|
case NETWORK_ERROR:
|
|
return "Network error";
|
|
case AUTH_FAILED:
|
|
return "Authentication failed";
|
|
case SERVER_ERROR:
|
|
return "Server error (try again later)";
|
|
case JSON_ERROR:
|
|
return "JSON parse error";
|
|
case NOT_FOUND:
|
|
return "No progress found";
|
|
default:
|
|
return "Unknown error";
|
|
}
|
|
}
|