ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::web_server_base Namespace Reference

Namespaces

namespace  internal
 

Data Structures

class  CaptiveDNS
 
class  DNSServer
 
class  WebServerBase
 

Functions

 ESPHOME_LOG_TAG (TAG, "web_server_base.dns")
 
struct esphome::web_server_base::DNSHeader __attribute__ ((packed))
 
bool is_origin_allowed (const char *origin, size_t origin_len, const char *host, size_t host_len, const char *const *allowed)
 Decide whether a browser request from the given Origin may reach a handler.
 
 if (origin_len==0) return true
 
 if (host_len==SIZE_MAX) host_len=0
 
return is_origin_allowed (origin, origin_len, host, host_len, allowed)
 
 if (origin==nullptr) return true
 
return is_origin_allowed (origin->value().c_str(), origin->value().length(), host !=nullptr ? host->value().c_str() :nullptr, host !=nullptr ? host->value().length() :0, allowed)
 

Variables

WebServerBase * global_web_server_base = nullptr
 
static bool const char *const * allowed
 
const size_t origin_len = request->get_header_to("Origin", origin)
 
char host [MAX_ORIGIN_LENGTH+1] = request->getHeader("Host")
 
size_t host_len = request->get_header_to("Host", host)
 
const AsyncWebHeader * origin = request->getHeader("Origin")
 

Function Documentation

◆ __attribute__()

struct esphome::web_server_base::DNSAnswer esphome::web_server_base::__attribute__ ( (packed) )

◆ ESPHOME_LOG_TAG()

esphome::web_server_base::ESPHOME_LOG_TAG ( TAG ,
"web_server_base.dns"  )

◆ if() [1/3]

esphome::web_server_base::if ( host_len = =SIZE_MAX)
pure virtual

◆ if() [2/3]

esphome::web_server_base::if ( origin = =nullptr)

◆ if() [3/3]

esphome::web_server_base::if ( origin_len = =0)

◆ is_origin_allowed() [1/3]

bool esphome::web_server_base::is_origin_allowed ( const char * origin,
size_t origin_len,
const char * host,
size_t host_len,
const char *const * allowed )

Decide whether a browser request from the given Origin may reach a handler.

A request without an Origin (origin_len == 0) is not a cross-origin browser request and is allowed. A same-origin request, whose Origin authority (the part after "scheme://") equals the Host header, is allowed. Any other origin must exactly equal an entry of the nullptr-terminated allowed table (nullptr when none is configured). A configured "*" never reaches this table: codegen turns it into USE_WEBSERVER_ALLOW_ANY_ORIGIN, which skips the check entirely.

Parameters
hostHost header value; host_len == 0 when absent or unreadable.

Definition at line 9 of file origin.cpp.

◆ is_origin_allowed() [2/3]

return esphome::web_server_base::is_origin_allowed ( origin ,
origin_len ,
host ,
host_len ,
allowed  )

◆ is_origin_allowed() [3/3]

return esphome::web_server_base::is_origin_allowed ( origin-> value).c_str(,
origin-> value).length(,
host ! = nullptr ? host->value().c_str() :nullptr,
host ! = nullptr ? host->value().length() :0,
allowed  )

Variable Documentation

◆ allowed

bool const char* const* esphome::web_server_base::allowed
Initial value:
{
#ifdef USE_ESP32
char origin[MAX_ORIGIN_LENGTH + 1]
const AsyncWebHeader * origin

Definition at line 16 of file web_server_base.cpp.

◆ global_web_server_base

WebServerBase * esphome::web_server_base::global_web_server_base = nullptr

Definition at line 11 of file web_server_base.cpp.

◆ host

const AsyncWebHeader * esphome::web_server_base::host = request->getHeader("Host")

Definition at line 26 of file web_server_base.cpp.

◆ host_len

size_t esphome::web_server_base::host_len = request->get_header_to("Host", host)

Definition at line 27 of file web_server_base.cpp.

◆ origin

const AsyncWebHeader* esphome::web_server_base::origin = request->getHeader("Origin")

Definition at line 33 of file web_server_base.cpp.

◆ origin_len

const size_t esphome::web_server_base::origin_len = request->get_header_to("Origin", origin)

Definition at line 20 of file web_server_base.cpp.