| 9 |
**Dependencies:** Database class, Session classes, Utility classes (##Ut##), Diagnostics class (##Diag##) |
| 10 |
|
| 11 |
---- |
| 12 |
|
| 13 |
=== Class Properties === |
| 14 |
|
| 15 |
==== Public Properties ==== |
| 16 |
|
| 17 |
#| |
| 18 |
*| Property | Type | Description |* |
| 19 |
|| ##$tls_session## | bool | Indicates if the current session uses HTTPS/TLS encryption || |
| 20 |
|| ##$request_uri## | string | Normalized REQUEST_URI (e.g., 'PageOfNoReturn/show?a=1') || |
| 21 |
|| ##$ip## | string | Client's real IP address (accounts for proxies) || |
| 22 |
|| ##$sess## | Session | Reference to the Session object || |
| 23 |
|| ##$method## | string | Current HTTP method/request type || |
| 24 |
|| ==== Private Properties ==== || |
| 25 |
|| Property | Type | Description || |
| 26 |
|| ---------- | ------ | ------------- || |
| 27 |
|| ##$db## | object | Database connection reference || |
| 28 |
|| ##$tls_mark## | string | Cookie name for TLS session marking || |
| 29 |
|| ##$page## | string | Current page name being processed || |
| 30 |
|| ##$hash## | string | SHA1 hash of the page name || |
| 31 |
|| ##$query## | string | Encoded query string || |
| 32 |
|| ##$lang## | string | Current language code || |
| 33 |
|| ##$file## | string | Cache file path || |
| 34 |
|| ##$caching## | int | Flag indicating if page should be cached (0 or 1) || |
| 35 |
|| ---- || |
| 36 |
|| === Constructor === || |
| 37 |
|| %%php |
| 53 |
%% || |
| 54 |
|| ---- || |
| 55 |
|| === Core Methods === || |
| 56 |
|| ==== Session Management ==== || |
| 57 |
|| ===== ##session($route): void## ===== || |
| 58 |
|| Initializes the session handler (file-based or database-based). || |
| 59 |
|| **Parameters:** || |
| 60 |
|| - ##$route## (int) - Routing flag: || |
| 61 |
|| - Bit 2 (##$route & 2##): Enable static mode for files/freecap (disables replay prevention and ID regeneration) || |
| 62 |
|| **Features:** || |
| 63 |
|| - Selects storage backend (file or database) || |
| 64 |
|| - Configures cookie settings (security, path, httponly) || |
| 65 |
|| - Binds IP and TLS validation || |
| 66 |
|| - Recovers diagnostic logs from previous session || |
| 67 |
|| **Example:** || |
| 68 |
|| %%php |
| 143 |
%% || |
| 144 |
|| ---- || |
| 145 |
|| ==== IP Address Detection ==== || |
| 146 |
|| ===== ##real_ip(): string## (Private) ===== || |
| 147 |
|| Detects client's real IP address accounting for proxies. || |
| 148 |
|| **Proxy Headers Checked (in order):** || |
| 149 |
|| 1. ##HTTP_X_CLUSTER_CLIENT_IP## || |
| 150 |
|| 2. ##HTTP_X_FORWARDED_FOR## (or custom header) || |
| 151 |
|| 3. ##HTTP_CLIENT_IP## || |
| 152 |
|| 4. ##HTTP_X_REMOTE_ADDR## || |
| 153 |
|| 5. ##REMOTE_ADDR## (fallback) || |
| 154 |
|| **Features:** || |
| 155 |
|| - Filters out private/reserved IP ranges || |
| 156 |
|| - Respects configured reverse proxy addresses || |
| 157 |
|| - Returns ##'0.0.0.0'## as fallback || |
| 158 |
|| **Configuration in Database:** || |
| 159 |
|| - ##reverse_proxy_addresses## - Comma/space-separated proxy IPs || |
| 160 |
|| - ##reverse_proxy_header## - Custom header name (default: ##X-Forwarded-For##) || |
| 161 |
|| **Example:** || |
| 162 |
|| %%php |
| 164 |
%% || |
| 165 |
|| ---- || |
| 166 |
|| ==== HTTPS Detection ==== || |
| 167 |
|| ===== ##tls_session(): bool## (Private) ===== || |
| 168 |
|| Detects if current connection uses HTTPS/TLS. || |
| 169 |
|| **Checks (any being true = HTTPS):** || |
| 170 |
|| - ##$_SERVER['HTTPS']## is 'on' || |
| 171 |
|| - ##$_SERVER['SERVER_PORT']## is 443 || |
| 172 |
|| - ##$_SERVER['HTTP_X_FORWARDED_PROTO']## is 'https' || |
| 173 |
|| - ##$_SERVER['HTTP_X_FORWARDED_SSL']## is 'on' || |
| 174 |
|| - ##$_SERVER['HTTP_X_FORWARDED_PORT']## is 443 || |
| 175 |
|| ---- || |
| 176 |
|| ==== Security Headers ==== || |
| 177 |
|| ===== ##http_security_headers(): void## ===== || |
| 178 |
|| Sets security-related HTTP headers. || |
| 179 |
|| **Headers Set:** || |
| 180 |
|| Header | Purpose | Config Key || |
| 181 |
|| -------- | --------- | ------------ || |
| 182 |
|| Content-Security-Policy | XSS/injection protection | ##csp## || |
| 183 |
|| Permissions-Policy | Control browser features | ##permissions_policy## || |
| 184 |
|| Referrer-Policy | Control referrer information | ##referrer_policy## || |
| 185 |
|| Strict-Transport-Security | Force HTTPS | Auto (TLS only) || |
| 186 |
|| X-Frame-Options | Clickjacking protection | Hardcoded: ##SAMEORIGIN## || |
| 187 |
|| X-Content-Type-Options | MIME sniffing prevention | Hardcoded: ##nosniff## || |
| 188 |
|| **CSP Configuration Options:** || |
| 189 |
|| - ##0## - Disabled || |
| 190 |
|| - ##1## - Default policy (from ##csp.conf##) || |
| 191 |
|| - ##2## - Custom policy (from ##csp_custom.conf##) || |
| 192 |
|| **Example:** || |
| 193 |
|| %%php |
| 285 |
%% || |
| 286 |
|| **Returns:** || |
| 287 |
|| - Language code (e.g., 'en', 'en-US', 'de') || |
| 288 |
|| ---- || |
| 289 |
|| ===== ##available_languages($subset = true): array## ===== || |
| 290 |
|| Returns list of available language translations. || |
| 291 |
|| **Parameters:** || |
| 292 |
|| - ##$subset## (bool, default: TRUE) || |
| 293 |
|| - ##TRUE##: Only allowed languages || |
| 294 |
|| - ##FALSE##: All available languages || |
| 295 |
|| **Features:** || |
| 296 |
|| - Scans ##LANG_DIR## for language files || |
| 297 |
|| - Filters by ##allowed_languages## config if set || |
| 298 |
|| - Caches result in session || |
| 299 |
|| - System language always included || |
| 300 |
|| **Returns:** || |
| 301 |
|| - Associative array: ##['en' => 'en', 'de' => 'de', ...]## || |
| 302 |
|| **Example:** || |
| 303 |
|| %%php |
| 306 |
%% || |
| 307 |
|| ---- || |
| 308 |
|| ==== File Serving ==== || |
| 309 |
|| ===== ##sendfile($path, $filename = null, $age = null): void## ===== || |
| 310 |
|| Serves files with proper HTTP headers and caching. || |
| 311 |
|| **Parameters:** || |
| 312 |
|| - ##$path## (string) - File path (or HTTP_XXX constant for error pages) || |
| 313 |
|| - ##$filename## (string, optional) - Custom download filename || |
| 314 |
|| - ##$age## (int, optional) - Cache age in days || |
| 315 |
|| **Features:** || |
| 316 |
|| - HTTP range request support (partial file downloads) || |
| 317 |
|| - ETag and Last-Modified conditional requests || |
| 318 |
|| - Proper MIME type detection || |
| 319 |
|| - Content-Security-Policy for special file types || |
| 320 |
|| - Streaming for large files || |
| 321 |
|| - GZip compression for text files || |
| 322 |
|| **Special Paths:** || |
| 323 |
|| %%php |
| 340 |
%% || |
| 341 |
|| ---- || |
| 342 |
|| ===== ##mime_types(): array## (Private) ===== || |
| 343 |
|| Loads and caches MIME types from configuration. || |
| 344 |
|| **Features:** || |
| 345 |
|| - Reads from ##config/mime.types## || |
| 346 |
|| - Caches to ##cache/config/mime.types## || |
| 347 |
|| - Reloads if config is updated || |
| 348 |
|| ---- || |
| 349 |
|| ==== Compression ==== || |
| 350 |
|| ===== ##gzip(): void## ===== || |
| 351 |
|| Compresses HTTP response with gzip/x-gzip. || |
| 352 |
|| **Features:** || |
| 353 |
|| - Manually implements gzip (not relying on zlib.output_compression) || |
| 354 |
|| - Produces correct ##Content-Length## header || |
| 355 |
|| - Only compresses if: || |
| 356 |
|| - 860 bytes < content < 1 MB || |
| 357 |
|| - Client accepts compression || |
| 358 |
|| - Headers not already sent || |
| 359 |
|| **Example:** || |
| 360 |
|| %%php |
| 373 |
%% || |
| 374 |
|| ---- || |
| 375 |
|| ===== ##request_uri(): string## (Private) ===== || |
| 376 |
|| Extracts and normalizes REQUEST_URI from server. || |
| 377 |
|| **Normalization:** || |
| 378 |
|| - Removes base URL prefix || |
| 379 |
|| - Removes spaces || |
| 380 |
|| - Collapses multiple slashes || |
| 381 |
|| - Removes ##..## path traversal attempts || |
| 382 |
|| - Removes leading/trailing slashes || |
| 383 |
|| ---- || |
| 384 |
|| ===== ##cut_prefix($prefix, $path): string## (Private) ===== || |
| 385 |
|| Removes prefix from path (case-insensitive). || |
| 386 |
|| ---- || |
| 387 |
|| ===== ##get_header_conf($file_name): string## (Private) ===== || |
| 388 |
|| Loads security header configuration from files. || |
| 389 |
|| **Files Supported:** || |
| 390 |
|| - ##csp.conf## / ##csp_custom.conf## || |
| 391 |
|| - ##permissions_policy.conf## / ##permissions_policy_custom.conf## || |
| 392 |
|| ---- || |
| 393 |
|| === Configuration Dependencies === || |
| 394 |
|| The class relies on these database configuration settings: || |
| 395 |
|| Setting | Type | Purpose || |
| 396 |
|| --------- | ------ | --------- || |
| 397 |
|| ##base_url## | string | Wiki's base URL || |
| 398 |
|| ##tls## | bool | Enable HTTPS enforcement || |
| 399 |
|| ##cache## | bool | Enable page caching || |
| 400 |
|| ##cache_ttl## | int | Cache lifetime in seconds || |
| 401 |
|| ##session_store## | int | 1=File, 0=Database || |
| 402 |
|| ##system_seed_hash## | string | Session encryption seed || |
| 403 |
|| ##cookie_prefix## | string | Session cookie prefix || |
| 404 |
|| ##cookie_path## | string | Cookie path || |
| 405 |
|| ##allow_persistent_cookie## | bool | Allow persistent login || |
| 406 |
|| ##session_length## | int | Session lifetime in seconds || |
| 407 |
|| ##reverse_proxy_addresses## | string | Comma/space-separated proxy IPs || |
| 408 |
|| ##reverse_proxy_header## | string | Custom X-Forwarded header || |
| 409 |
|| ##language## | string | Default language code || |
| 410 |
|| ##multilanguage## | bool | Enable language negotiation || |
| 411 |
|| ##allowed_languages## | string | Comma/space-separated allowed langs || |
| 412 |
|| ##enable_security_headers## | bool | Send security headers || |
| 413 |
|| ##csp## | int | CSP setting (0/1/2) || |
| 414 |
|| ##permissions_policy## | int | Permissions-Policy setting (0/1/2) || |
| 415 |
|| ##referrer_policy## | int | Referrer-Policy setting (0-8) || |
| 416 |
|| ---- || |
| 417 |
|| === Constants Used === || |
| 418 |
|| Constant | Type | Purpose || |
| 419 |
|| ---------- | ------ | --------- || |
| 420 |
|| ##IN_WACKO## | bool | Security check (exit if not defined) || |
| 421 |
|| ##CHMOD_SAFE## | int | File permissions for cache files || |
| 422 |
|| ##CHMOD_FILE## | int | File permissions for config cache || |
| 423 |
|| ##CACHE_PAGE_DIR## | string | Page cache directory || |
| 424 |
|| ##CACHE_SESSION_DIR## | string | Session cache directory || |
| 425 |
|| ##CACHE_CONFIG_DIR## | string | Config cache directory || |
| 426 |
|| ##CONFIG_DIR## | string | Configuration directory || |
| 427 |
|| ##LANG_DIR## | string | Language files directory || |
| 428 |
|| ##DAYSECS## | int | Seconds in a day (86400) || |
| 429 |
|| ##HTTP_404## | string | Path to 404 error page || |
| 430 |
|| ##HTTP_403## | string | Path to 403 error page || |
| 431 |
|# |
| 432 |
|
| 433 |
---- |
| 434 |
|
| 435 |
=== Workflow Examples === |
| 436 |
|
| 437 |
==== Example 1: Handling a GET Request ==== |
| 438 |
|
| 439 |
%%php |
| 486 |
```%% |
| 487 |
|
| 488 |
---- |
| 489 |
|
| 490 |
## Security Considerations=== Security Considerations === |
| 491 |
|
| 492 |
### 1. **IP Address Spoofing**==== 1. **IP Address Spoofing** ==== |
| 493 |
- Validates IPs against private ranges |
| 494 |
- Filters proxy-provided IPs appropriately |
| 495 |
- Configurable reverse proxy trust |
| 496 |
|
| 497 |
### 2. **Session Security**==== 2. **Session Security** ==== |
| 498 |
- Binds sessions to IP address |
| 499 |
- Binds sessions to TLS status |
| 500 |
- Supports both file and database storage |
| 501 |
- HttpOnly cookies by default |
| 502 |
|
| 503 |
### 3. **TLS Enforcement**==== 3. **TLS Enforcement** ==== |
| 504 |
- Automatic HTTPS upgrade when configured |
| 505 |
- Marks TLS sessions to prevent downgrade attacks |
| 506 |
- HSTS header support |
| 507 |
|
| 508 |
### 4. **Content Security**==== 4. **Content Security** ==== |
| 509 |
- CSP headers to prevent XSS |
| 510 |
- X-Frame-Options to prevent clickjacking |
| 511 |
- X-Content-Type-Options to prevent MIME sniffing |
| 512 |
- Referrer-Policy control |
| 513 |
- Permissions-Policy for browser features |
| 514 |
|
| 515 |
### 5. **File Serving**==== 5. **File Serving** ==== |
| 516 |
- Validates file existence and readability |
| 517 |
- Prevents directory traversal via `realpath()` - Prevents directory traversal via ##realpath()## |
| 518 |
- Rejects symbolic links |
| 519 |
- Special CSP for SVG and PDF files |
| 520 |
|
| 521 |
### 6. **Cache Security**==== 6. **Cache Security** ==== |
| 522 |
- Cached only for anonymous users |
| 523 |
- Disabled for sensitive operations (edit, watch) |
| 524 |
- Only GET requests cached |
| 525 |
|
| 526 |
---- |
| 527 |
|
| 528 |
## Performance Optimization=== Performance Optimization === |
| 529 |
|
| 530 |
### 1. **Page Caching**==== 1. **Page Caching** ==== |
| 531 |
- Stores full HTML output |
| 532 |
- TTL-based expiration |
| 533 |
- Language and method-aware caching |
| 534 |
- Conditional request support (304 Not Modified) |
| 535 |
|
| 536 |
### 2. **MIME Type Caching**==== 2. **MIME Type Caching** ==== |
| 537 |
- Loads MIME types once and caches |
| 538 |
- Regenerates only when config changes |
| 539 |
|
| 540 |
### 3. **Session Options**==== 3. **Session Options** ==== |
| 541 |
- File-based sessions for simple deployments |
| 542 |
- Database sessions for distributed systems |
| 543 |
|
| 544 |
### 4. **Compression**==== 4. **Compression** ==== |
| 545 |
- Manual gzip implementation |
| 546 |
- Proper Content-Length generation |
| 547 |
- Only compresses appropriate sizes |
| 548 |
|
| 549 |
---- |
| 550 |
|
| 551 |
## Debugging=== Debugging === |
| 561 |
%% |
| 562 |
|
| 563 |
---- |
| 564 |
|
| 565 |
=== Related Classes === |
| 566 |
- **Session Classes** (##SessionFileStore##, ##SessionDbalStore##) - Session management backends |
| 567 |
- **Database Class** - Configuration and cache metadata storage |
| 568 |
- **Ut Utility Class** - String/path utilities |
| 569 |
- **Diag Class** - Diagnostic logging |
| 570 |
|
| 571 |
---- |
| 572 |
|
| 573 |
=== Version History === |
| 574 |
- Supports PHP 8.0+ (uses match expressions, union types) |
| 575 |
- Follows RFC 9110 for HTTP header handling |
| 576 |
- Modern cookie security practices |
| 577 |
|
| 578 |
---- |
| 579 |
|
| 580 |
=== Conclusion === |
| 581 |
|
| 582 |
The ##Http## class is the central request/response handler in WackoWiki, managing everything from session initialization to security headers to file serving. Understanding this class is essential for: |
| 583 |
- Extending WackoWiki with custom request handlers |
| 584 |
- Implementing custom session logic |
| 585 |
- Adding new security policies |
| 586 |
- Optimizing cache strategies |
| 587 |
- Debugging HTTP-related issues |