config.py 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. from functools import lru_cache
  2. from ipaddress import ip_address, ip_network
  3. from typing import Annotated, Literal
  4. from pydantic import AliasChoices, BeforeValidator, Field, model_validator
  5. from pydantic_settings import BaseSettings, SettingsConfigDict
  6. DEVELOPMENT_JWT_SECRET = "development-only-change-me-32-bytes"
  7. def _split_csv(value: object) -> list[str]:
  8. if isinstance(value, str):
  9. return [item.strip() for item in value.split(",") if item.strip()]
  10. return list(value or [])
  11. CsvList = Annotated[list[str], BeforeValidator(_split_csv)]
  12. class Settings(BaseSettings):
  13. model_config = SettingsConfigDict(env_file=".env", extra="ignore", case_sensitive=False)
  14. ENVIRONMENT: str = "development"
  15. DEBUG_AUTH: bool = False
  16. DATABASE_URL: str = "sqlite:///./dev.db"
  17. AUTH_PROXY_HEADER: str = "X-Remote-User"
  18. TRUSTED_PROXY_IPS: CsvList = Field(default_factory=lambda: ["127.0.0.1", "::1"])
  19. JWT_SECRET: str = DEVELOPMENT_JWT_SECRET
  20. JWT_ISSUER: str = "gcepic"
  21. JWT_AUDIENCE: str = "gcepic-web"
  22. JWT_IDLE_MINUTES: int = 30
  23. JWT_ABSOLUTE_HOURS: int = 8
  24. JWT_RENEW_BEFORE_MINUTES: int = 5
  25. COOKIE_SECURE: bool = False
  26. SESSION_COOKIE_NAME: str = "gcepic_session"
  27. LOGIN_CSRF_COOKIE_NAME: str = "gcepic_login_csrf"
  28. LDAP_URL: str | None = None
  29. LDAP_BASE_DN: str | None = None
  30. LDAP_BIND_DN: str | None = Field(
  31. default=None,
  32. validation_alias=AliasChoices("LDAP_BIND_DN", "LDAP_USER_DN"),
  33. )
  34. LDAP_BIND_PASSWORD: str | None = None
  35. LDAP_UPN_SUFFIX: str | None = None
  36. LDAP_START_TLS: bool = False
  37. LOCAL_STORAGE: str | None = None
  38. UPLOAD_MAX_FILE_SIZE_MB: int = Field(default=50, gt=0)
  39. LOG_LEVEL: Annotated[Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], BeforeValidator(lambda value: str(value).upper())] = 'INFO'
  40. LOG_DIR: str = 'logs'
  41. LOG_TO_FILE: bool = True
  42. LOG_TO_CONSOLE: bool = True
  43. LOG_RETENTION_DAYS: int = Field(default=30, ge=1)
  44. LOG_SQL_STATEMENT: bool = True
  45. @model_validator(mode="after")
  46. def validate_security_settings(self) -> "Settings":
  47. if self.DEBUG_AUTH and self.ENVIRONMENT.lower() not in {"development", "debug", "test"}:
  48. raise ValueError("DEBUG_AUTH is only allowed in development, debug or test")
  49. if self.ENVIRONMENT.lower() == "production":
  50. if len(self.JWT_SECRET.encode("utf-8")) < 32 or self.JWT_SECRET == DEVELOPMENT_JWT_SECRET:
  51. raise ValueError("A unique JWT_SECRET with at least 32 bytes is required in production")
  52. if not self.COOKIE_SECURE:
  53. raise ValueError("COOKIE_SECURE must be enabled in production")
  54. if self.JWT_IDLE_MINUTES <= 0 or self.JWT_ABSOLUTE_HOURS <= 0:
  55. raise ValueError("JWT session lifetimes must be positive")
  56. return self
  57. @property
  58. def debug_auth_enabled(self) -> bool:
  59. return self.DEBUG_AUTH and self.ENVIRONMENT.lower() in {"development", "debug", "test"}
  60. def is_trusted_proxy(self, host: str | None) -> bool:
  61. if not host:
  62. return False
  63. try:
  64. address = ip_address(host)
  65. except ValueError:
  66. return host in self.TRUSTED_PROXY_IPS and self.ENVIRONMENT.lower() != "production"
  67. for entry in self.TRUSTED_PROXY_IPS:
  68. try:
  69. if address in ip_network(entry, strict=False):
  70. return True
  71. except ValueError:
  72. continue
  73. return False
  74. @lru_cache
  75. def get_settings() -> Settings:
  76. return Settings()
  77. settings = get_settings()