Comment URL-décoder les paramètres de query et empêcher le path traversal sur ESP32 esp_http_server

Quand votre API HTTP ESP32 prend un chemin de fichier en paramètre de query (?path=config.json), vous devez le URL-décoder et rejeter les tentatives de traversal avant de toucher le filesystem. Sinon ?path=../x ou ?path=%2e%2e%2f peuvent s’échapper de votre montage LittleFS.

Décodeur URL

Les query strings encodent les octets spéciaux en %XX et les espaces en +. Un décodeur minimal :

HTTPHandlersFiles.cpp
std::string url_decode(const std::string &in) {
    std::string out;
    out.reserve(in.size());
    for (size_t i = 0; i < in.size(); ++i) {
        char c = in[i];
        if (c == '%' && i + 2 < in.size()) {
            char hex[3] = { in[i+1], in[i+2], '\0' };
            char decoded = static_cast<char>(strtol(hex, NULL, 16));
            out.push_back(decoded);
            i += 2;
        } else if (c == '+') {
            out.push_back(' ');
        } else {
            out.push_back(c);
        }
    }
    return out;
}

Sanitizer de chemin

Décodez d’abord, puis assainissez — décoder après l’assainissement rate %2e%2e%2f (../). Retirez les restes de query/fragment, forcez le chemin à être relatif au point de montage, et rejetez tout .. :

HTTPHandlersFiles.cpp
bool sanitize_path(const std::string &in, std::string &out) {
    std::string dec = url_decode(in);
    size_t qpos = dec.find('?');
    if (qpos != std::string::npos) dec = dec.substr(0, qpos);
    size_t hpos = dec.find('#');
    if (hpos != std::string::npos) dec = dec.substr(0, hpos);
    size_t start = 0;
    while (start < dec.size() && dec[start] == '/') start++;  // force relative
    out = dec.substr(start);
    if (out.find("..") != std::string::npos) return false;
    return true;
}

Utilisez-le dans chaque handler qui touche le filesystem :

usage.cpp
std::string rel = parser.GetParameter("path");
if (!sanitize_path(rel, rel) || rel.empty()) {
    httpd_resp_set_status(req, "400 Bad Request");
    httpd_resp_sendstr(req, "{\"error\": \"Invalid path\"}");
    return ESP_OK;
}
std::string fullpath = std::string(LittleFSManager::mountPoint()) + "/" + rel;

Notes

  • Rejeter toute sous-chaîne .. est plus strict que nécessaire (foo..bar est rejeté aussi), mais sur une API embarquée la simplicité l’emporte sur la correction des cas limites.
  • Gardez une denylist pour les fichiers système (p. ex. nodes.json) afin qu’un chemin même valide ne puisse pas supprimer l’état géré par le firmware.
  • Pour le parsing de query lui-même, httpd_req_get_url_query_str + httpd_query_key_value ou un petit wrapper QueryURLParser marche très bien.

Articles liés


Consultez les articles similaires par catégorie : ESP32 C/C++