Layer: L7 Application ยท Build flags: PC_ENABLE_CSRF
What this example teaches
Cross-Site Request Forgery tricks a logged-in browser into making a state-changing request the user did not intend. With PC_ENABLE_CSRF, every POST/PUT/PATCH/DELETE must carry a valid X-CSRF-Token header or it gets 403; the safe methods GET/HEAD/OPTIONS are exempt. The token is stateless - HMAC-signed and self-validating against a secret seeded at begin() - so there is no server-side session storage.
Protection is global, not per-route. You write ordinary handlers; the library enforces the token check on unsafe methods automatically:
server.send(id, 200, "text/plain", "GET /csrf for a token, then POST /submit");
});
server.send(id, 200, "text/plain", "accepted");
});
@ HTTP_POST
Non-idempotent create / action.
@ HTTP_GET
Safe, idempotent read.
Fully-parsed HTTP/1.1 request.
The built-in GET /csrf endpoint issues a token (returned as JSON and set as the csrf cookie). A client fetches a token, then echoes it in the X-CSRF-Token header on each unsafe request.
Build and run
pio ci --board=esp32dev --project-option="framework=arduino" \
--project-option="build_flags=-DPC_ENABLE_CSRF=1" \
--lib="." examples/L7-Application/Csrf/Csrf.ino
curl -s http://<ip>/csrf # {"token":"..."}
curl -X POST http://<ip>/submit -H "X-CSRF-Token: <token>" # 200 accepted
curl -X POST http://<ip>/submit # 403 (missing token)
Annotated source
The complete sketch (Csrf.ino), reproduced verbatim with added explanatory comments:
#define PC_ENABLE_CSRF 1
static const char *SSID = "YOUR_SSID";
static const char *PASSWORD = "YOUR_PASSWORD";
void setup()
{
Serial.print("Connecting to WiFi");
{
delay(250);
Serial.print('.');
}
Serial.printf("IP: %u.%u.%u.%u\n", (unsigned)(ip & 0xFF), (unsigned)((ip >> 8) & 0xFF),
(unsigned)((ip >> 16) & 0xFF), (unsigned)((ip >> 24) & 0xFF));
server.
send(
id, 200,
"text/plain",
"GET /csrf for a token, then POST /submit");
});
}
void loop()
{
}
Single-port HTTP server with deterministic, zero-allocation execution.
void send(uint8_t slot_id, int code, const char *content_type, const char *payload)
Send an HTTP response with a body and close the connection.
int32_t begin(const WebServerConfig *cfg=nullptr)
Initialize all connection slots and open all registered listeners.
void on(const char *path, HttpMethod method, Handler callback)
Register a route handler.
void handle()
Drive the server - call every Arduino loop() iteration.
bool init_wifi_physical(const char *, const char *)
Connect to a WiFi access point.
uint32_t pc_net_egress_ip(void)
IPv4 (network byte order) of the current egress interface, or 0 if none.
bool wifi_ready()
True if the WiFi station link is up (associated + an IP is assigned).
Layer 1 (Physical) - link bring-up and live egress-interface reporting.
Layer 7 (Application) - public HTTP routing API.