Skip to content

Commit 42cb760

Browse files
mathieucarboumathieucarbou
committed
Fixed Header parsing
- Now obey the spec - Uses a static parse method - Support move semantic
1 parent 029b057 commit 42cb760

5 files changed

Lines changed: 96 additions & 39 deletions

File tree

‎examples/HeaderManipulation/HeaderManipulation.ino‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,31 @@ void setup() {
7979
)
8080
.addMiddleware(&headerFree);
8181

82+
// curl -v http://192.168.4.1/
83+
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
84+
AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", "Hello, world!");
85+
response->addHeader(AsyncWebHeader::parse("X-Test-1: value1").value());
86+
response->addHeader(AsyncWebHeader::parse("X-Test-2:value2").value());
87+
response->addHeader(AsyncWebHeader::parse("X-Test-3:").value());
88+
response->addHeader(AsyncWebHeader::parse("X-Test-4: ").value());
89+
response->addHeader(AsyncWebHeader::parse("").value_or(AsyncWebHeader("X-Test-5", "cannot be empty")));
90+
response->addHeader(AsyncWebHeader::parse(":").value_or(AsyncWebHeader("X-Test-6", "cannot be empty")));
91+
request->send(response);
92+
/**
93+
< HTTP/1.1 200 OK
94+
< connection: close
95+
< X-Test-1: value1
96+
< X-Test-2: value2
97+
< X-Test-3:
98+
< X-Test-4:
99+
< X-Test-5: cannot be empty
100+
< X-Test-6: cannot be empty
101+
< accept-ranges: none
102+
< content-length: 13
103+
< content-type: text/plain
104+
*/
105+
});
106+
82107
server.begin();
83108
}
84109

‎src/AsyncWebHeader.cpp‎

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,29 @@
33

44
#include <ESPAsyncWebServer.h>
55

6-
AsyncWebHeader::AsyncWebHeader(const String &data) {
6+
std::optional<AsyncWebHeader> AsyncWebHeader::parse(const char *data) {
7+
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers
8+
// In HTTP/1.X, a header is a case-insensitive name followed by a colon, then optional whitespace which will be ignored, and finally by its value
79
if (!data) {
8-
return;
10+
return std::nullopt; // nullptr
911
}
10-
int index = data.indexOf(':');
11-
if (index < 0) {
12-
return;
12+
if (data[0] == '\0') {
13+
return std::nullopt; // empty string
1314
}
14-
if (data.indexOf('\r') >= 0 || data.indexOf('\n') >= 0) {
15-
// Note: do not log as info, warn or error because this could flood the logs without being able to filter this out
16-
#ifdef ESP32
17-
log_v("Invalid character in HTTP header");
18-
#endif
19-
return; // Invalid header format
15+
if (strchr(data, '\n') || strchr(data, '\r')) {
16+
return std::nullopt; // Invalid header format
2017
}
21-
_name = data.substring(0, index);
22-
_value = data.substring(index + 2);
23-
}
24-
25-
String AsyncWebHeader::toString() const {
26-
String str;
27-
if (str.reserve(_name.length() + _value.length() + 2)) {
28-
str.concat(_name);
29-
str.concat((char)0x3a);
30-
str.concat((char)0x20);
31-
str.concat(_value);
32-
str.concat(asyncsrv::T_rn);
33-
} else {
34-
#ifdef ESP32
35-
log_e("Failed to allocate");
36-
#endif
18+
char *colon = strchr(data, ':');
19+
if (!colon) {
20+
return std::nullopt; // separator not found
21+
}
22+
if (colon == data) {
23+
return std::nullopt; // Header name cannot be empty
24+
}
25+
char *startOfValue = colon + 1; // Skip the colon
26+
// skip one optional whitespace after the colon
27+
if (*startOfValue == ' ') {
28+
startOfValue++;
3729
}
38-
return str;
30+
return AsyncWebHeader(String(data, colon - data), String(startOfValue));
3931
}

‎src/ESPAsyncWebServer.h‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
#include <deque>
1313
#include <functional>
1414
#include <list>
15+
#include <optional>
1516
#include <unordered_map>
1617
#include <vector>
1718

@@ -136,9 +137,15 @@ class AsyncWebHeader {
136137

137138
public:
138139
AsyncWebHeader(const AsyncWebHeader &) = default;
140+
AsyncWebHeader(AsyncWebHeader &&) = default;
139141
AsyncWebHeader(const char *name, const char *value) : _name(name), _value(value) {}
140142
AsyncWebHeader(const String &name, const String &value) : _name(name), _value(value) {}
141-
AsyncWebHeader(const String &data);
143+
144+
#ifndef ESP8266
145+
[[deprecated("Use AsyncWebHeader::parse(data) instead")]]
146+
#endif
147+
AsyncWebHeader(const String &data)
148+
: AsyncWebHeader(parse(data).value_or(AsyncWebHeader(emptyString, emptyString))) {};
142149

143150
AsyncWebHeader &operator=(const AsyncWebHeader &) = default;
144151

@@ -148,7 +155,13 @@ class AsyncWebHeader {
148155
const String &value() const {
149156
return _value;
150157
}
158+
151159
String toString() const;
160+
161+
static std::optional<AsyncWebHeader> parse(const String &data) {
162+
return parse(data.c_str());
163+
}
164+
static std::optional<AsyncWebHeader> parse(const char *data);
152165
};
153166

154167
/*
@@ -293,8 +306,9 @@ class AsyncWebServerRequest {
293306
RequestedConnectionType requestedConnType() const {
294307
return _reqconntype;
295308
}
296-
bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED)
297-
const;
309+
bool isExpectedRequestedConnType(
310+
RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED
311+
) const;
298312
bool isWebSocketUpgrade() const {
299313
return _method == HTTP_GET && isExpectedRequestedConnType(RCT_WS);
300314
}
@@ -482,7 +496,8 @@ class AsyncWebServerRequest {
482496
return beginResponse(code, contentType.c_str(), content, len, callback);
483497
}
484498
#ifndef ESP8266
485-
[[deprecated("Replaced by beginResponse(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)"
499+
[[deprecated(
500+
"Replaced by beginResponse(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)"
486501
)]]
487502
#endif
488503
AsyncWebServerResponse *beginResponse_P(int code, const String &contentType, PGM_P content, AwsTemplateProcessor callback = nullptr);
@@ -1038,6 +1053,10 @@ class AsyncWebServerResponse {
10381053
setContentType(type.c_str());
10391054
}
10401055
void setContentType(const char *type);
1056+
bool addHeader(AsyncWebHeader &&header, bool replaceExisting = true);
1057+
bool addHeader(const AsyncWebHeader &header, bool replaceExisting = true) {
1058+
return addHeader(header.name(), header.value(), replaceExisting);
1059+
}
10411060
bool addHeader(const char *name, const char *value, bool replaceExisting = true);
10421061
bool addHeader(const String &name, const String &value, bool replaceExisting = true) {
10431062
return addHeader(name.c_str(), value.c_str(), replaceExisting);

‎src/WebRequest.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -341,10 +341,10 @@ bool AsyncWebServerRequest::_parseReqHead() {
341341
}
342342

343343
bool AsyncWebServerRequest::_parseReqHeader() {
344-
int index = _temp.indexOf(':');
345-
if (index) {
346-
String name(_temp.substring(0, index));
347-
String value(_temp.substring(index + 2));
344+
std::optional<AsyncWebHeader> header = AsyncWebHeader::parse(_temp);
345+
if (header) {
346+
const String &name = header.value().name();
347+
const String &value = header.value().value();
348348
if (name.equalsIgnoreCase(T_Host)) {
349349
_host = value;
350350
} else if (name.equalsIgnoreCase(T_Content_Type)) {
@@ -392,7 +392,7 @@ bool AsyncWebServerRequest::_parseReqHeader() {
392392
_reqconntype = RCT_EVENT;
393393
}
394394
}
395-
_headers.emplace_back(name, value);
395+
_headers.emplace_back(std::move(header.value()));
396396
}
397397
#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) || defined(LIBRETINY)
398398
// Ancient PRI core does not have String::clear() method 8-()

‎src/WebResponses.cpp‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,27 @@ bool AsyncWebServerResponse::headerMustBePresentOnce(const String &name) {
134134
return false;
135135
}
136136

137+
bool AsyncWebServerResponse::addHeader(AsyncWebHeader &&header, bool replaceExisting) {
138+
for (auto i = _headers.begin(); i != _headers.end(); ++i) {
139+
if (i->name().equalsIgnoreCase(header.name())) {
140+
// header already set
141+
if (replaceExisting) {
142+
// remove, break and add the new one
143+
_headers.erase(i);
144+
break;
145+
} else if (headerMustBePresentOnce(i->name())) { // we can have only one header with that name
146+
// do not update
147+
return false;
148+
} else {
149+
break; // accept multiple headers with the same name
150+
}
151+
}
152+
}
153+
// header was not found found, or existing one was removed
154+
_headers.emplace_back(std::move(header));
155+
return true;
156+
}
157+
137158
bool AsyncWebServerResponse::addHeader(const char *name, const char *value, bool replaceExisting) {
138159
for (auto i = _headers.begin(); i != _headers.end(); ++i) {
139160
if (i->name().equalsIgnoreCase(name)) {
@@ -503,8 +524,8 @@ size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t *data, size
503524
// Now we've read 'len' bytes, either from cache or from file
504525
// Search for template placeholders
505526
uint8_t *pTemplateStart = data;
506-
while ((pTemplateStart < &data[len]) && (pTemplateStart = (uint8_t *)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1))
507-
) { // data[0] ... data[len - 1]
527+
while ((pTemplateStart < &data[len])
528+
&& (pTemplateStart = (uint8_t *)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1))) { // data[0] ... data[len - 1]
508529
uint8_t *pTemplateEnd =
509530
(pTemplateStart < &data[len - 1]) ? (uint8_t *)memchr(pTemplateStart + 1, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart) : nullptr;
510531
// temporary buffer to hold parameter name

0 commit comments

Comments
 (0)