Refactor backend configuration and authentication
- Add comprehensive documentation for backend development - Improve client IP detection with utility functions and tests - Update auth router with better error handling - Refactor config module with environment-based settings Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -6,13 +6,16 @@ Only trusts these headers when the request comes from a known trusted proxy.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import ipaddress
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from fastapi import Request
|
||||
|
||||
|
||||
def get_client_ip(request: Request, trusted_proxies: list[str] | None = None) -> str:
|
||||
def get_client_ip(
|
||||
request: Request, trusted_proxies: str | list[str] | None = None
|
||||
) -> str:
|
||||
"""Extract the client IP address from a request.
|
||||
|
||||
When the request comes from a trusted proxy, reads the real IP from
|
||||
@@ -20,12 +23,12 @@ def get_client_ip(request: Request, trusted_proxies: list[str] | None = None) ->
|
||||
connection source (request.client.host).
|
||||
|
||||
X-Forwarded-For can be spoofed by the client, so we only trust it if
|
||||
the request comes from a known proxy IP.
|
||||
the request comes from a known proxy IP or CIDR range.
|
||||
|
||||
Args:
|
||||
request: The incoming FastAPI request.
|
||||
trusted_proxies: Optional list of trusted proxy IP addresses. If None,
|
||||
only uses request.client.host.
|
||||
trusted_proxies: Optional list of trusted proxy IP addresses or CIDR ranges,
|
||||
or a comma-separated string. If None, only uses request.client.host.
|
||||
|
||||
Returns:
|
||||
The best-guess client IP address suitable for rate limiting.
|
||||
@@ -34,10 +37,23 @@ def get_client_ip(request: Request, trusted_proxies: list[str] | None = None) ->
|
||||
return "0.0.0.0"
|
||||
|
||||
immediate_ip = request.client.host
|
||||
trusted_proxies = trusted_proxies or []
|
||||
|
||||
# If the immediate connection is not from a trusted proxy, use it directly.
|
||||
if immediate_ip not in trusted_proxies:
|
||||
# Normalize trusted_proxies to a list
|
||||
if isinstance(trusted_proxies, str):
|
||||
trusted_proxies = [
|
||||
proxy.strip()
|
||||
for proxy in trusted_proxies.split(",")
|
||||
if proxy.strip()
|
||||
]
|
||||
elif trusted_proxies is None:
|
||||
trusted_proxies = []
|
||||
|
||||
# If no trusted proxies are configured, use immediate IP directly
|
||||
if not trusted_proxies:
|
||||
return immediate_ip
|
||||
|
||||
# Check if the immediate connection is from a trusted proxy
|
||||
if not _is_trusted_proxy(immediate_ip, trusted_proxies):
|
||||
return immediate_ip
|
||||
|
||||
# Proxy is trusted, check for forwarded headers.
|
||||
@@ -57,3 +73,41 @@ def get_client_ip(request: Request, trusted_proxies: list[str] | None = None) ->
|
||||
|
||||
# No forwarded headers found, use immediate connection
|
||||
return immediate_ip
|
||||
|
||||
|
||||
def _is_trusted_proxy(ip: str, trusted_proxies: list[str]) -> bool:
|
||||
"""Check if an IP is in the list of trusted proxies.
|
||||
|
||||
Supports both single IP addresses and CIDR ranges.
|
||||
|
||||
Args:
|
||||
ip: The IP address to check.
|
||||
trusted_proxies: List of trusted proxy IP addresses or CIDR ranges.
|
||||
|
||||
Returns:
|
||||
True if the IP is trusted, False otherwise.
|
||||
"""
|
||||
try:
|
||||
ip_obj = ipaddress.ip_address(ip)
|
||||
except ValueError:
|
||||
# Invalid IP format
|
||||
return False
|
||||
|
||||
for proxy in trusted_proxies:
|
||||
try:
|
||||
# Try to parse as a CIDR network
|
||||
network = ipaddress.ip_network(proxy, strict=False)
|
||||
if ip_obj in network:
|
||||
return True
|
||||
except ValueError:
|
||||
try:
|
||||
# Fall back to single IP address
|
||||
proxy_ip = ipaddress.ip_address(proxy)
|
||||
if ip_obj == proxy_ip:
|
||||
return True
|
||||
except ValueError:
|
||||
# Invalid proxy format, skip it
|
||||
continue
|
||||
|
||||
return False
|
||||
|
||||
|
||||
Reference in New Issue
Block a user