-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmiddleware_enhanced.py
More file actions
756 lines (628 loc) · 24.2 KB
/
Copy pathmiddleware_enhanced.py
File metadata and controls
756 lines (628 loc) · 24.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
"""Enhanced Cloudflare Access authentication middleware with JWT, whitelist, and sessions.
This module provides comprehensive FastAPI middleware that combines:
- JWT token validation for security
- Email whitelist with domain and tier support
- Session management with cookies
- Development mode for local testing
Key Features:
- Secure JWT validation using Cloudflare certificates
- Email whitelist with @domain.com pattern support
- User tiers (admin/full/limited) for access control
- In-memory session management with cookies
- Development mode with mock users
- Comprehensive logging and error handling
Dependencies:
- fastapi: For Request/Response handling
- starlette: For middleware base classes
- src.cloudflare_auth.validators: For JWT validation
- src.cloudflare_auth.whitelist: For email validation
- src.cloudflare_auth.sessions: For session management
Called by:
- FastAPI middleware stack during request processing
Example:
from fastapi import FastAPI
from cloudflare_auth import setup_cloudflare_auth_enhanced
app = FastAPI()
setup_cloudflare_auth_enhanced(
app,
whitelist=["user@example.com", "@company.com"],
admin_emails=["admin@company.com"]
)
"""
import logging
from collections.abc import Callable
from typing import Any
from fastapi import HTTPException, Request, Response, status
from starlette.middleware.base import BaseHTTPMiddleware
from cloudflare_auth.config import CloudflareSettings, get_cloudflare_settings
from cloudflare_auth.csrf import CSRFProtection
from cloudflare_auth.models import CloudflareUser
from cloudflare_auth.rate_limiter import InMemoryRateLimiter
from cloudflare_auth.sessions import SimpleSessionManager
from cloudflare_auth.utils import (
get_client_ip,
sanitize_email,
sanitize_ip,
sanitize_path,
)
from cloudflare_auth.validators import CloudflareJWTValidator
from cloudflare_auth.whitelist import EmailWhitelistValidator, UserTier
logger = logging.getLogger(__name__)
class CloudflareAuthMiddlewareEnhanced(BaseHTTPMiddleware):
"""Enhanced Cloudflare Access middleware with JWT, whitelist, and sessions.
This middleware provides complete authentication with:
- JWT token validation (secure)
- Email whitelist authorization
- User tier assignment
- Session management
- Development mode support
Example:
middleware = CloudflareAuthMiddlewareEnhanced(
app=app,
whitelist_validator=validator,
session_manager=session_manager,
excluded_paths=["/health", "/docs"],
enable_sessions=True
)
"""
def __init__(
self,
app: Any,
settings: CloudflareSettings | None = None,
validator: CloudflareJWTValidator | None = None,
whitelist_validator: EmailWhitelistValidator | None = None,
session_manager: SimpleSessionManager | None = None,
excluded_paths: list[str] | None = None,
enable_sessions: bool = True,
require_auth: bool = True,
enable_rate_limiting: bool = True,
rate_limit_attempts: int = 5,
rate_limit_window: int = 60,
) -> None:
"""Initialize enhanced authentication middleware.
Args:
app: ASGI application
settings: Cloudflare configuration settings
validator: JWT token validator
whitelist_validator: Email whitelist validator (required)
session_manager: Session manager instance
excluded_paths: Paths to exclude from authentication
enable_sessions: Whether to use session cookies
require_auth: Whether authentication is required
enable_rate_limiting: Whether to enable rate limiting (default: True)
rate_limit_attempts: Max authentication attempts per window (default: 5)
rate_limit_window: Rate limit window in seconds (default: 60)
"""
super().__init__(app)
self.settings = settings or get_cloudflare_settings()
self.jwt_validator = validator or CloudflareJWTValidator(self.settings)
self.whitelist_validator = whitelist_validator
self.session_manager = session_manager or SimpleSessionManager()
self.excluded_paths = excluded_paths or []
self.enable_sessions = enable_sessions
self.require_auth = require_auth
# Rate limiting
self.enable_rate_limiting = enable_rate_limiting
if enable_rate_limiting:
self.rate_limiter = InMemoryRateLimiter(
max_attempts=rate_limit_attempts,
window_seconds=rate_limit_window,
)
else:
self.rate_limiter = None
# CSRF protection for sessions
if enable_sessions:
self.csrf_protection = CSRFProtection()
else:
self.csrf_protection = None
# Validate configuration
if (
self.settings.cloudflare_enabled
and require_auth
and not whitelist_validator
):
logger.warning(
"No whitelist validator provided - all authenticated users will be allowed"
)
logger.info(
"Initialized enhanced Cloudflare auth middleware "
"(JWT enabled=%s, sessions=%s, whitelist=%s, rate_limiting=%s)",
self.settings.cloudflare_enabled,
self.enable_sessions,
whitelist_validator is not None,
self.enable_rate_limiting,
)
def _is_path_excluded(self, path: str) -> bool:
"""Check if a path should bypass authentication.
Args:
path: Request path to check
Returns:
True if path is excluded from auth
"""
return any(
path == excluded or path.startswith(excluded.rstrip("/") + "/")
for excluded in self.excluded_paths
)
async def dispatch(
self,
request: Request,
call_next: Callable,
) -> Response:
"""Process request with enhanced authentication.
Authentication flow:
1. Check if path is excluded
2. Check for existing valid session
3. Validate JWT token from Cloudflare
4. Check email whitelist
5. Determine user tier and privileges
6. Create/update session
7. Inject user into request.state
Args:
request: Incoming request
call_next: Next middleware/endpoint
Returns:
Response from application
"""
# Skip authentication for excluded paths
if self._is_path_excluded(request.url.path):
logger.debug("Path excluded from auth: %s", request.url.path)
return await call_next(request)
# Handle development mode (no Cloudflare)
if not self.settings.cloudflare_enabled:
logger.debug("Cloudflare authentication disabled (dev mode)")
if not self.require_auth:
request.state.user = None
return await call_next(request)
# Authenticate the request
try:
user = await self._authenticate_request(request)
request.state.user = user
response = await call_next(request)
# Set session cookie if needed
if (
self.enable_sessions
and user
and user.session_id
and user.session_id != request.cookies.get("session_id")
):
self._set_session_cookie(response, user.session_id)
return response
except HTTPException:
raise
except Exception as e:
logger.exception("Unexpected error during authentication")
if self.require_auth:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail="Authentication service error",
) from e
request.state.user = None
return await call_next(request)
def _check_rate_limit(self, request: Request) -> None:
"""Check rate limit and raise HTTPException if exceeded."""
if not (self.enable_rate_limiting and self.rate_limiter):
return
client_ip = get_client_ip(request)
if self.rate_limiter.is_allowed(client_ip):
return
retry_after = self.rate_limiter.get_retry_after(client_ip)
logger.warning(
"Rate limit exceeded for IP: %s (path: %s)",
sanitize_ip(client_ip),
sanitize_path(request.url.path),
)
raise HTTPException(
status_code=status.HTTP_429_TOO_MANY_REQUESTS,
detail="Too many authentication attempts. Please try again later.",
headers={"Retry-After": str(retry_after)},
)
def _authenticate_from_session(self, request: Request) -> CloudflareUser | None:
"""Attempt to authenticate from existing session."""
if not self.enable_sessions:
return None
session_id = request.cookies.get("session_id")
if not session_id:
return None
session = self.session_manager.get_session(session_id)
if not session:
return None
user = self._user_from_session(session, session_id)
logger.debug("Authenticated from session: %s", user.email)
return user
def _handle_missing_token(self, request: Request) -> None:
"""Handle missing JWT token - raise if auth required."""
if not self.require_auth:
return
self._record_failed_attempt(request)
if self.settings.log_auth_failures:
logger.warning(
"Missing JWT header: %s (path: %s, ip: %s)",
self.settings.jwt_header_name,
sanitize_path(request.url.path),
sanitize_ip(get_client_ip(request)),
)
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Missing authentication token",
headers={"WWW-Authenticate": "Bearer"},
)
def _validate_token_size(self, jwt_token: str, request: Request) -> bool:
"""Validate JWT token size. Returns True if valid."""
if len(jwt_token) <= 8192:
return True
logger.warning(
"JWT token too large: %d bytes (path: %s, ip: %s)",
len(jwt_token),
sanitize_path(request.url.path),
sanitize_ip(get_client_ip(request)),
)
if self.require_auth:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="JWT token too large",
)
return False
def _record_failed_attempt(self, request: Request) -> None:
"""Record a failed authentication attempt for rate limiting."""
if self.enable_rate_limiting and self.rate_limiter:
self.rate_limiter.record_attempt(get_client_ip(request))
def _handle_jwt_validation_error(self, error: ValueError, request: Request) -> None:
"""Handle JWT validation errors."""
self._record_failed_attempt(request)
if self.settings.log_auth_failures:
logger.warning(
"JWT validation failed: %s (path: %s, ip: %s)",
str(error),
sanitize_path(request.url.path),
sanitize_ip(get_client_ip(request)),
)
if self.require_auth:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid authentication token",
headers={"WWW-Authenticate": "Bearer"},
) from error
def _check_whitelist(self, email: str) -> UserTier:
"""Check whitelist authorization and return user tier."""
if not self.whitelist_validator:
return UserTier.FULL
if not self.whitelist_validator.is_authorized(email):
logger.warning(
"Unauthorized email attempted access: %s",
sanitize_email(email),
)
if self.require_auth:
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail=f"Email {email} not authorized",
)
msg = "Email not authorized"
raise ValueError(msg)
try:
return self.whitelist_validator.get_user_tier(email)
except ValueError:
return UserTier.LIMITED
def _create_session_if_enabled(
self, claims: Any, user_tier: UserTier, request: Request
) -> str | None:
"""Create session if sessions are enabled."""
if not self.enable_sessions:
return None
return self.session_manager.create_session(
email=claims.email,
is_admin=user_tier.has_admin_privileges,
user_tier=user_tier.value,
cf_context={
"cf_ray": request.headers.get("cf-ray"),
"cf_country": request.headers.get("cf-ipcountry"),
},
)
async def _authenticate_request(self, request: Request) -> CloudflareUser | None:
"""Authenticate request using JWT and whitelist.
Args:
request: Incoming request
Returns:
CloudflareUser object if authenticated, None if optional
Raises:
HTTPException: If authentication fails and is required
"""
self._check_rate_limit(request)
# Check for existing session first
session_user = self._authenticate_from_session(request)
if session_user:
return session_user
# Extract JWT token
jwt_token = request.headers.get(self.settings.jwt_header_name)
if not jwt_token:
self._handle_missing_token(request)
return None
if not self._validate_token_size(jwt_token, request):
return None
# Validate JWT token
try:
claims = self.jwt_validator.validate_token(jwt_token)
except ValueError as e:
self._handle_jwt_validation_error(e, request)
return None
# Check whitelist and get tier
try:
user_tier = self._check_whitelist(claims.email)
except ValueError:
return None
# Create session if enabled
session_id = self._create_session_if_enabled(claims, user_tier, request)
# Create user object
user = CloudflareUser.from_jwt_claims(
claims=claims,
user_tier=user_tier,
is_admin=user_tier.has_admin_privileges,
session_id=session_id,
)
logger.info(
"User authenticated: %s (tier: %s, admin: %s)",
sanitize_email(user.email),
user_tier.value,
user.is_admin,
)
return user
def _user_from_session(
self, session: dict[str, Any], session_id: str
) -> CloudflareUser:
"""Recreate CloudflareUser from session data.
Args:
session: Session data dictionary
session_id: Session identifier
Returns:
CloudflareUser instance
"""
from cloudflare_auth.models import CloudflareJWTClaims
# Create minimal claims for session-based auth
issuer = self.settings.issuer or "session-auth"
claims = CloudflareJWTClaims(
email=session["email"],
iss=issuer,
aud=[self.settings.cloudflare_audience_tag],
sub=session.get("email", ""),
iat=int(session["created_at"].timestamp()),
exp=int(session["last_accessed"].timestamp())
+ self.session_manager.session_timeout,
)
tier = UserTier.from_string(session.get("user_tier", "limited"))
return CloudflareUser.from_jwt_claims(
claims=claims,
user_tier=tier,
is_admin=session.get("is_admin", False),
session_id=session_id,
)
def _set_session_cookie(self, response: Response, session_id: str) -> None:
"""Set session cookie and CSRF token in response.
Uses security settings from configuration for proper cookie attributes.
Args:
response: Response to modify
session_id: Session ID to set
"""
# Prepare cookie kwargs from settings
# Get cookie configuration
max_age = self.session_manager.session_timeout
path = self.settings.cookie_path
secure = self.settings.cookie_secure
samesite = self.settings.cookie_samesite
domain = self.settings.cookie_domain
# Set session cookie (httponly for security)
response.set_cookie(
key="session_id",
value=session_id,
httponly=True,
max_age=max_age,
path=path,
secure=secure,
samesite=samesite,
domain=domain,
)
# Set CSRF token cookie (NOT httponly, needs to be readable by JS)
if self.csrf_protection:
csrf_token = self.csrf_protection.generate_token(session_id)
response.set_cookie(
key="csrf_token",
value=csrf_token,
httponly=False, # Must be readable by JavaScript
max_age=max_age,
path=path,
secure=secure,
samesite=samesite,
domain=domain,
)
def setup_cloudflare_auth_enhanced(
app: Any,
whitelist: list[str] | None = None,
admin_emails: list[str] | None = None,
full_users: list[str] | None = None,
limited_users: list[str] | None = None,
excluded_paths: list[str] | None = None,
enable_sessions: bool = True,
require_auth: bool = True,
session_timeout: int = 3600,
settings: CloudflareSettings | None = None,
) -> None:
"""Setup enhanced Cloudflare authentication with all features.
This is the recommended setup function that provides:
- JWT validation for security
- Email whitelist authorization
- User tier management
- Session support
- Development mode
Args:
app: FastAPI application
whitelist: List of allowed emails/domains (e.g., ["user@example.com", "@company.com"])
admin_emails: List of admin emails
full_users: List of full-tier users
limited_users: List of limited-tier users
excluded_paths: Paths to exclude from auth
enable_sessions: Whether to use session cookies
require_auth: Whether authentication is required
session_timeout: Session timeout in seconds
settings: Optional CloudflareSettings instance
Returns:
None - middleware is added directly to the app
Example:
app = FastAPI()
setup_cloudflare_auth_enhanced(
app,
whitelist=["user@example.com", "@company.com"],
admin_emails=["admin@company.com"],
full_users=["@company.com"],
excluded_paths=["/health", "/docs"],
enable_sessions=True
)
"""
settings = settings or get_cloudflare_settings()
# Create whitelist validator if whitelist provided
whitelist_validator = None
if whitelist:
whitelist_validator = EmailWhitelistValidator(
whitelist=whitelist,
admin_emails=admin_emails or [],
full_users=full_users or [],
limited_users=limited_users or [],
)
# Log whitelist stats
stats = whitelist_validator.get_whitelist_stats()
logger.info(
"Whitelist configured: %d entries, %d domains, %d admins",
stats["total_entries"],
len(stats["domains"]),
stats["admin_emails"],
)
# Check for warnings
warnings = whitelist_validator.validate_whitelist_config()
for warning in warnings:
logger.warning("Whitelist config: %s", warning)
# Create session manager
session_manager = None
if enable_sessions:
session_manager = SimpleSessionManager(session_timeout=session_timeout)
# Create JWT validator
jwt_validator = CloudflareJWTValidator(settings)
# Default excluded paths
default_excluded = [
"/health",
"/healthz",
"/ready",
"/metrics",
"/docs",
"/redoc",
"/openapi.json",
]
all_excluded = list(set(default_excluded + (excluded_paths or [])))
# Add middleware
app.add_middleware(
CloudflareAuthMiddlewareEnhanced,
settings=settings,
validator=jwt_validator,
whitelist_validator=whitelist_validator,
session_manager=session_manager,
excluded_paths=all_excluded,
enable_sessions=enable_sessions,
require_auth=require_auth,
)
logger.info(
"Enhanced Cloudflare authentication configured "
"(whitelist=%s, sessions=%s, excluded_paths=%d)",
whitelist_validator is not None,
enable_sessions,
len(all_excluded),
)
# FastAPI dependencies
def get_current_user(request: Request) -> CloudflareUser:
"""FastAPI dependency to get current authenticated user.
Args:
request: FastAPI request
Returns:
CloudflareUser object
Raises:
HTTPException: If user is not authenticated
Example:
@app.get("/me")
async def get_me(user: CloudflareUser = Depends(get_current_user)):
return {"email": user.email}
"""
user = getattr(request.state, "user", None)
if not user:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
return user
def get_current_user_optional(request: Request) -> CloudflareUser | None:
"""FastAPI dependency for optional authentication.
Args:
request: FastAPI request
Returns:
CloudflareUser or None
Example:
@app.get("/info")
async def info(user: CloudflareUser | None = Depends(get_current_user_optional)):
if user:
return {"message": f"Hello {user.email}"}
return {"message": "Hello anonymous"}
"""
return getattr(request.state, "user", None)
def require_admin(request: Request) -> CloudflareUser:
"""FastAPI dependency requiring admin privileges.
Args:
request: FastAPI request
Returns:
CloudflareUser object
Raises:
HTTPException: If not authenticated or not admin
Example:
@app.get("/admin")
async def admin_panel(user: CloudflareUser = Depends(require_admin)):
return {"message": "Admin panel"}
"""
user = get_current_user(request)
if not user.is_admin:
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Admin privileges required",
)
return user
def require_tier(minimum_tier: UserTier) -> Callable:
"""Create a dependency that requires a minimum user tier.
Args:
minimum_tier: Minimum required tier
Returns:
Dependency function
Example:
require_full = require_tier(UserTier.FULL)
@app.get("/premium")
async def premium(user: CloudflareUser = Depends(require_full)):
return {"message": "Premium content"}
"""
def dependency(request: Request) -> CloudflareUser:
"""Validate that the current user meets minimum_tier.
Resolved as a FastAPI dependency by require_tier. The user is loaded
from request state via get_current_user; tiers are ordered
LIMITED < FULL < ADMIN.
Args:
request: Incoming FastAPI/Starlette request.
Returns:
The authenticated CloudflareUser object.
Raises:
HTTPException: 403 if the user's tier is below minimum_tier; 401
(via get_current_user) if the request is unauthenticated.
"""
user = get_current_user(request)
tier_order = {
UserTier.LIMITED: 0,
UserTier.FULL: 1,
UserTier.ADMIN: 2,
}
if tier_order[user.user_tier] < tier_order[minimum_tier]:
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail=f"Minimum tier {minimum_tier.value} required",
)
return user
return dependency