auth.py 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714
  1. import re
  2. from typing import Literal
  3. from pydantic import BaseModel, Field, field_validator, model_validator
  4. from backend.app.schemas.not_null import IgnoresNullForRequiredColumns
  5. def _validate_password_complexity(v: str) -> str:
  6. """Enforce minimum password complexity (M-C).
  7. Requires at least one uppercase letter, one lowercase letter, one digit,
  8. and one special character in addition to the min_length=8 Field constraint.
  9. """
  10. if not re.search(r"[A-Z]", v):
  11. raise ValueError("Password must contain at least one uppercase letter")
  12. if not re.search(r"[a-z]", v):
  13. raise ValueError("Password must contain at least one lowercase letter")
  14. if not re.search(r"\d", v):
  15. raise ValueError("Password must contain at least one digit")
  16. if not re.search(r"[^A-Za-z0-9]", v):
  17. raise ValueError("Password must contain at least one special character")
  18. return v
  19. class GroupBrief(BaseModel):
  20. """Brief group info for embedding in user responses."""
  21. id: int
  22. name: str
  23. class Config:
  24. from_attributes = True
  25. class LoginRequest(BaseModel):
  26. username: str = Field(..., max_length=150)
  27. password: str = Field(..., max_length=256)
  28. class LoginResponse(BaseModel):
  29. access_token: str | None = None
  30. token_type: str = "bearer"
  31. user: "UserResponse | None" = None
  32. # Set when 2FA is required; the frontend must call /auth/2fa/verify
  33. requires_2fa: bool = False
  34. pre_auth_token: str | None = None
  35. two_fa_methods: list[str] = []
  36. class UserCreate(BaseModel):
  37. username: str = Field(..., max_length=150)
  38. password: str | None = Field(default=None, max_length=256) # M-NEW-4: cap before pbkdf2
  39. email: str | None = Field(default=None, max_length=254) # L-NEW-5: RFC 5321 max
  40. role: str = "user"
  41. group_ids: list[int] | None = None
  42. @field_validator("password")
  43. @classmethod
  44. def validate_password(cls, v: str | None) -> str | None:
  45. if v is not None:
  46. _validate_password_complexity(v)
  47. return v
  48. class UserUpdate(IgnoresNullForRequiredColumns):
  49. __orm_table__ = "users"
  50. username: str | None = Field(default=None, max_length=150)
  51. password: str | None = Field(default=None, max_length=256) # M-NEW-4: cap before pbkdf2
  52. email: str | None = Field(default=None, max_length=254) # L-NEW-5: RFC 5321 max
  53. role: str | None = None
  54. is_active: bool | None = None
  55. group_ids: list[int] | None = None
  56. @field_validator("password")
  57. @classmethod
  58. def validate_password(cls, v: str | None) -> str | None:
  59. if v is not None:
  60. _validate_password_complexity(v)
  61. return v
  62. class UserResponse(BaseModel):
  63. id: int
  64. username: str
  65. email: str | None = None
  66. role: str # Deprecated, kept for backward compatibility
  67. is_active: bool
  68. is_admin: bool # Computed from role and group membership
  69. auth_source: str = "local" # "local" or "ldap"
  70. groups: list[GroupBrief] = []
  71. permissions: list[str] = [] # All permissions from groups
  72. created_at: str
  73. class Config:
  74. from_attributes = True
  75. class UserSlim(BaseModel):
  76. """Just enough to resolve a user id to a display name (#1894).
  77. Deliberately narrower than ``UserResponse``: no email, role, auth source,
  78. group membership or permission set. Adding a field here widens what every
  79. ``can_read_status`` API key can read about every account, so treat this
  80. shape as the contract rather than a starting point.
  81. """
  82. id: int
  83. username: str
  84. class Config:
  85. from_attributes = True
  86. class LDAPSearchResultResponse(BaseModel):
  87. """One match from GET /auth/ldap/search — surfaced in the admin UI."""
  88. username: str
  89. email: str | None = None
  90. display_name: str | None = None
  91. dn: str
  92. already_provisioned: bool = False # True if this username already exists as a BamBuddy user
  93. class LDAPProvisionRequest(BaseModel):
  94. """Body for POST /auth/ldap/provision. Username is re-resolved via the
  95. service-account bind, so the request only carries the directory username
  96. the admin picked from the search results."""
  97. username: str = Field(..., max_length=150)
  98. class ChangePasswordRequest(BaseModel):
  99. current_password: str = Field(..., max_length=256) # M-NEW-3: cap before pbkdf2
  100. new_password: str = Field(..., min_length=8, max_length=256)
  101. @field_validator("new_password")
  102. @classmethod
  103. def validate_new_password(cls, v: str) -> str:
  104. return _validate_password_complexity(v)
  105. class SetupRequest(BaseModel):
  106. auth_enabled: bool
  107. admin_username: str | None = Field(default=None, max_length=150)
  108. admin_password: str | None = Field(default=None, max_length=256)
  109. # Password complexity is NOT validated at the schema layer. When re-enabling auth
  110. # with an existing admin user (or when LDAP is the auth backend), the frontend
  111. # still sends whatever is in the password field but the route ignores it.
  112. # Enforcing complexity here would reject those legitimate flows. The route body
  113. # applies the check only when a brand-new local admin is actually being created.
  114. class SetupResponse(BaseModel):
  115. auth_enabled: bool
  116. admin_created: bool | None = None
  117. class ForgotPasswordRequest(BaseModel):
  118. email: str = Field(..., max_length=254) # L-NEW-1: RFC 5321 max; caps memory/CPU before lookup
  119. class ForgotPasswordConfirmRequest(BaseModel):
  120. token: str = Field(..., max_length=128)
  121. new_password: str = Field(..., min_length=8, max_length=256)
  122. @field_validator("new_password")
  123. @classmethod
  124. def validate_new_password(cls, v: str) -> str:
  125. return _validate_password_complexity(v)
  126. class ForgotPasswordResponse(BaseModel):
  127. message: str
  128. class ResetPasswordRequest(BaseModel):
  129. user_id: int
  130. class ResetPasswordResponse(BaseModel):
  131. message: str
  132. class SMTPSettings(BaseModel):
  133. smtp_host: str
  134. smtp_port: int
  135. smtp_username: str | None = None # Optional when auth is disabled
  136. smtp_password: str | None = None # Optional for read operations or when auth is disabled
  137. smtp_security: str = "starttls" # 'starttls', 'ssl', 'none'
  138. smtp_auth_enabled: bool = True
  139. smtp_from_email: str
  140. smtp_from_name: str = "BamBuddy"
  141. # Deprecated field for backward compatibility
  142. smtp_use_tls: bool | None = None
  143. class TestSMTPRequest(BaseModel):
  144. test_recipient: str
  145. class TestSMTPResponse(BaseModel):
  146. success: bool
  147. message: str
  148. # ---------------------------------------------------------------------------
  149. # 2FA / MFA schemas
  150. # ---------------------------------------------------------------------------
  151. class TwoFAStatusResponse(BaseModel):
  152. totp_enabled: bool
  153. email_otp_enabled: bool
  154. backup_codes_remaining: int
  155. class TOTPSetupResponse(BaseModel):
  156. """Returned when a user initiates TOTP setup. The frontend should display
  157. the QR code image (base64 PNG) and ask the user to scan it, then call
  158. /auth/2fa/totp/enable with a valid code to confirm."""
  159. secret: str # base32 secret (shown as fallback text)
  160. qr_code_b64: str # base64-encoded PNG of the QR code
  161. issuer: str
  162. class TOTPSetupRequest(BaseModel):
  163. """Optional body for POST /auth/2fa/totp/setup.
  164. Only required when re-initialising setup while an active TOTP record exists.
  165. Provide the current TOTP code (from the existing authenticator app) to
  166. confirm intent — mirrors the verification requirement in disable_totp.
  167. """
  168. code: str | None = Field(default=None, max_length=8) # L-NEW-2: bound before pyotp
  169. class TOTPEnableRequest(BaseModel):
  170. code: str # 6-digit TOTP code from the authenticator app
  171. @field_validator("code")
  172. @classmethod
  173. def validate_code(cls, v: str) -> str:
  174. v = v.strip()
  175. if not v.isdigit() or len(v) != 6:
  176. raise ValueError("TOTP code must be exactly 6 digits")
  177. return v
  178. class TOTPEnableResponse(BaseModel):
  179. message: str
  180. backup_codes: list[str] # plain-text codes shown once; user must save them
  181. class TOTPDisableRequest(BaseModel):
  182. """Requires a valid TOTP code OR a backup code to disable TOTP."""
  183. code: str = Field(..., max_length=128)
  184. class BackupCodesResponse(BaseModel):
  185. backup_codes: list[str]
  186. message: str
  187. class EmailOTPEnableRequest(BaseModel):
  188. """No body required — email is taken from the authenticated user's profile."""
  189. pass
  190. class TwoFAVerifyRequest(BaseModel):
  191. pre_auth_token: str = Field(..., max_length=128)
  192. # TOTP/email codes are 6 digits; backup codes are 8 uppercase alphanumeric chars.
  193. # max_length=8 prevents excessively long inputs from reaching pbkdf2/pyotp.
  194. code: str = Field(..., min_length=6, max_length=8)
  195. method: Literal["totp", "email", "backup"] = "totp"
  196. @field_validator("code")
  197. @classmethod
  198. def validate_code_format(cls, v: str) -> str:
  199. v = v.strip()
  200. if not re.match(r"^[A-Za-z0-9]{6,8}$", v):
  201. raise ValueError("Code must be 6–8 alphanumeric characters")
  202. return v.upper() # normalise backup codes to uppercase
  203. class TwoFAVerifyResponse(BaseModel):
  204. access_token: str
  205. token_type: str = "bearer"
  206. user: "UserResponse"
  207. class EmailOTPSendRequest(BaseModel):
  208. pre_auth_token: str = Field(..., max_length=128)
  209. class EmailOTPEnableConfirmRequest(BaseModel):
  210. """Body for the second step of email OTP enable: verify the proof-of-possession code."""
  211. setup_token: str = Field(..., max_length=128)
  212. # L-NEW-3: email OTP setup codes are always exactly 6 digits; reject anything else.
  213. code: str = Field(..., min_length=6, max_length=6)
  214. @field_validator("code")
  215. @classmethod
  216. def validate_code_digits(cls, v: str) -> str:
  217. v = v.strip()
  218. if not v.isdigit() or len(v) != 6:
  219. raise ValueError("Email OTP setup code must be exactly 6 digits")
  220. return v
  221. class EmailOTPDisableRequest(BaseModel):
  222. """Requires the account password to disable email OTP."""
  223. password: str = Field(..., max_length=256)
  224. class AdminDisable2FARequest(BaseModel):
  225. """Admin must supply their own password as re-auth before disabling 2FA for another user.
  226. OIDC/LDAP-only admins (no local password_hash) are exempt from this check.
  227. """
  228. admin_password: str | None = Field(default=None, max_length=256)
  229. # ---------------------------------------------------------------------------
  230. # OIDC schemas
  231. # ---------------------------------------------------------------------------
  232. AUTO_LINK_REQUIREMENTS_ERROR = (
  233. "auto_link_existing_accounts requires require_email_verified=True when email_claim='email'"
  234. )
  235. def _validate_email_claim_name(v: str) -> str:
  236. # Accepts only alphanumeric/underscore/hyphen claim names starting with a letter —
  237. # prevents log injection and limits the attack surface of operator-supplied claim names.
  238. if not re.fullmatch(r"[a-zA-Z][a-zA-Z0-9_\-]{0,63}", v):
  239. raise ValueError("Invalid claim name")
  240. return v
  241. def _validate_group_claim_name(v: str) -> str:
  242. """#3107 — like _validate_email_claim_name, but also allows one slash.
  243. Auth0 (and Auth0-compatible providers) only expose custom claims under a
  244. non-reserved namespace, e.g. ``https://example.com/roles`` or ``app/roles``,
  245. so the email-claim charset would refuse every valid Auth0 group claim.
  246. The slash is structurally safe here: the value never reaches a URL, a
  247. path or SQL — it is only a JWT claim lookup key inside ``claims.get`` —
  248. so the wider charset does not widen any injection surface. The 64-char
  249. cap and the "starts with a letter" rule are kept. The full-URL form of
  250. an Auth0 namespace exceeds 64 chars, but that is Auth0's documented
  251. short-namespace territory; the limit matches email_claim and keeps the
  252. column bound meaningful.
  253. """
  254. if not re.fullmatch(r"[a-zA-Z][a-zA-Z0-9_\-/]{0,63}", v):
  255. raise ValueError("Invalid claim name")
  256. return v
  257. def _validate_group_mapping(v: dict[str, str]) -> dict[str, str]:
  258. """#3107 — normalise and bound an IdP-group -> Bambuddy-group mapping.
  259. Values must reference Bambuddy group names; existence is checked against
  260. the database in the route handlers (same split as default_group_id), since
  261. the schema layer has no session. Keys are left as-is apart from stripping:
  262. IdP group values are opaque strings (DNs, UUIDs, names) and must match the
  263. claim byte-for-byte, so any normalisation beyond whitespace would silently
  264. break the lookup.
  265. Keys colliding case-insensitively are rejected: the sync matches the IdP
  266. side case-insensitively, so {"Admins": "Administrators", "admins":
  267. "Viewers"} would silently collapse to whichever entry the dict happens to
  268. keep last — a member of "Admins" could end up in Viewers. Rejecting the
  269. pair at save time (here, so the env path gets the same answer) turns an
  270. undiagnosable runtime behaviour into a form error. Two keys differing only
  271. by case and mapping to the SAME group are pointless but harmless, and are
  272. rejected too for the same reason: they read as a mistake.
  273. """
  274. if not isinstance(v, dict):
  275. raise ValueError("group_mapping must be a JSON object")
  276. if len(v) > 100:
  277. raise ValueError("group_mapping must have at most 100 entries")
  278. cleaned: dict[str, str] = {}
  279. seen_ci: dict[str, str] = {}
  280. for key, value in v.items():
  281. if not isinstance(key, str) or not key.strip():
  282. raise ValueError("group_mapping keys must be non-empty strings")
  283. if not isinstance(value, str) or not value.strip():
  284. raise ValueError("group_mapping values must be non-empty group names")
  285. k = key.strip()
  286. ci = k.lower()
  287. if ci in seen_ci:
  288. raise ValueError(
  289. f"group_mapping has two IdP groups differing only by case: "
  290. f"'{seen_ci[ci]}' and '{k}' — the sync matches case-insensitively, "
  291. f"so both cannot be honored"
  292. )
  293. seen_ci[ci] = k
  294. cleaned[k] = value.strip()
  295. return cleaned
  296. def _validate_icon_url(v: str | None) -> str | None:
  297. """Reject non-HTTPS icon URLs and SSRF-unsafe hosts.
  298. Delegates to the runtime SSRF guard ``assert_safe_public_https_url``
  299. so the Pydantic layer enforces the same allowlist as the fetcher —
  300. no policy drift between schema validation and SSRF check. Without
  301. this delegation the validator covered only ``is_private | is_loopback
  302. | is_link_local`` while the runtime additionally rejected numeric-
  303. encoded IPs, cloud-metadata endpoints, multicast, unspecified, and
  304. IPv4-mapped IPv6.
  305. Lazy-imported because ``_oidc_helpers`` lives under ``api/routes/``
  306. and schemas avoid top-level imports from that layer (matches the
  307. existing pattern in ``_validate_issuer_url`` which lazy-imports
  308. ``ipaddress``).
  309. """
  310. if v is None:
  311. return v
  312. if not v.startswith("https://"):
  313. # Surface the same wording the runtime guard would use, but pre-
  314. # checked here so the user-facing error doesn't depend on the
  315. # runtime call path.
  316. raise ValueError("icon_url must start with https://")
  317. from backend.app.api.routes._oidc_helpers import assert_safe_public_https_url
  318. try:
  319. assert_safe_public_https_url(v)
  320. except ValueError as exc:
  321. raise ValueError(f"icon_url: {exc}") from exc
  322. return v
  323. def _validate_issuer_url(v: str | None) -> str | None:
  324. """Reject non-HTTPS issuer URLs and SSRF-unsafe hosts.
  325. An OIDC provider must be reachable over TLS on the public internet, so
  326. this uses the public-internet policy: private, loopback and link-local
  327. addresses are all rejected.
  328. Delegates to the runtime guard ``assert_safe_public_https_url`` for the
  329. same reason ``_validate_icon_url`` does — no policy drift between the
  330. schema layer and the fetcher. The hand-rolled version this replaced
  331. checked only ``is_private | is_loopback | is_link_local``, which left
  332. numeric-encoded IPs (``https://2130706433/``), IPv4-mapped IPv6
  333. (``https://[::ffff:127.0.0.1]/``), multicast and unspecified addresses
  334. able to express a target the policy meant to forbid. The guard's
  335. docstring already claimed the two were consistent; now they are.
  336. Lazy-imported because ``_oidc_helpers`` lives under ``api/routes/`` and
  337. schemas avoid top-level imports from that layer.
  338. """
  339. if v is None:
  340. return v
  341. if not v.startswith("https://"):
  342. raise ValueError("issuer_url must start with https://")
  343. from backend.app.api.routes._oidc_helpers import assert_safe_public_https_url
  344. try:
  345. assert_safe_public_https_url(v)
  346. except ValueError as exc:
  347. # The guard's messages say "icon URL" — rewrite for this field so the
  348. # user sees the setting they actually submitted.
  349. detail = str(exc).replace("icon URL", "issuer_url")
  350. raise ValueError(detail) from exc
  351. return v
  352. def _validate_scopes(v: str | None) -> str | None:
  353. """Nit5: Require that the 'openid' scope is present.
  354. The OpenID Connect spec mandates the 'openid' scope; without it the
  355. response is plain OAuth2, not OIDC, and claims like sub/email are not
  356. guaranteed.
  357. """
  358. if v is None:
  359. return v
  360. scope_list = v.split()
  361. if "openid" not in scope_list:
  362. raise ValueError("scopes must include 'openid'")
  363. return v
  364. class OIDCProviderCreate(BaseModel):
  365. name: str = Field(..., max_length=100) # L-NEW-4
  366. issuer_url: str
  367. client_id: str = Field(..., max_length=256) # L-NEW-4
  368. client_secret: str = Field(..., max_length=512) # L-NEW-4: Fernet input bounded
  369. scopes: str = Field(default="openid email profile", max_length=256) # L-NEW-4
  370. is_enabled: bool = True
  371. auto_create_users: bool = False
  372. auto_link_existing_accounts: bool = False # M-2: conservative default, opt-in only
  373. email_claim: str = Field(default="email", max_length=64)
  374. require_email_verified: bool = True
  375. # #3107 — group sync config. group_mapping empty (default) = no sync.
  376. group_claim: str = Field(default="groups", max_length=64)
  377. group_mapping: dict[str, str] = Field(default_factory=dict)
  378. icon_url: str | None = None
  379. default_group_id: int | None = None
  380. is_autologin: bool = False # #1589 — at most one provider may carry this
  381. @field_validator("issuer_url")
  382. @classmethod
  383. def validate_issuer_url(cls, v: str) -> str:
  384. result = _validate_issuer_url(v)
  385. if result is None:
  386. raise ValueError("issuer_url is required")
  387. return result
  388. @field_validator("scopes")
  389. @classmethod
  390. def validate_scopes(cls, v: str) -> str:
  391. result = _validate_scopes(v)
  392. if result is None:
  393. raise ValueError("scopes is required")
  394. return result
  395. @field_validator("email_claim")
  396. @classmethod
  397. def validate_email_claim(cls, v: str) -> str:
  398. return _validate_email_claim_name(v)
  399. @field_validator("group_claim")
  400. @classmethod
  401. def validate_group_claim(cls, v: str) -> str:
  402. # Namespaced claims allowed here (Auth0 et al) — see _validate_group_claim_name.
  403. return _validate_group_claim_name(v)
  404. @field_validator("group_mapping")
  405. @classmethod
  406. def validate_group_mapping(cls, v: dict[str, str]) -> dict[str, str]:
  407. return _validate_group_mapping(v)
  408. @field_validator("icon_url")
  409. @classmethod
  410. def validate_icon_url(cls, v: str | None) -> str | None:
  411. return _validate_icon_url(v)
  412. # SEC-1: auto_link with email_claim='email' requires require_email_verified=True.
  413. # Fall B (require_email_verified=False + email_claim='email') accepts absent email_verified → account-takeover risk.
  414. # Fall C (custom claim != 'email') is safe: no email_verified gate on that path regardless of require_email_verified.
  415. @model_validator(mode="after")
  416. def check_auto_link_requires_verified(self) -> "OIDCProviderCreate":
  417. if self.auto_link_existing_accounts and self.email_claim == "email" and not self.require_email_verified:
  418. raise ValueError(AUTO_LINK_REQUIREMENTS_ERROR)
  419. return self
  420. class OIDCProviderUpdate(IgnoresNullForRequiredColumns):
  421. __orm_table__ = "oidc_providers"
  422. name: str | None = Field(default=None, max_length=100)
  423. issuer_url: str | None = None
  424. @field_validator("issuer_url")
  425. @classmethod
  426. def validate_issuer_url(cls, v: str | None) -> str | None:
  427. return _validate_issuer_url(v)
  428. client_id: str | None = Field(default=None, max_length=256)
  429. client_secret: str | None = Field(default=None, max_length=512)
  430. scopes: str | None = Field(default=None, max_length=256)
  431. is_enabled: bool | None = None
  432. auto_create_users: bool | None = None
  433. auto_link_existing_accounts: bool | None = None
  434. email_claim: str | None = Field(default=None, max_length=64)
  435. require_email_verified: bool | None = None
  436. # #3107 — group sync config. None = leave unchanged, same as every other
  437. # optional field here; an explicit {} clears the mapping and disables sync.
  438. group_claim: str | None = Field(default=None, max_length=64)
  439. group_mapping: dict[str, str] | None = None
  440. icon_url: str | None = None
  441. default_group_id: int | None = None
  442. is_autologin: bool | None = None # #1589
  443. @field_validator("scopes")
  444. @classmethod
  445. def validate_scopes(cls, v: str | None) -> str | None:
  446. return _validate_scopes(v)
  447. @field_validator("email_claim")
  448. @classmethod
  449. def validate_email_claim(cls, v: str | None) -> str | None:
  450. if v is None:
  451. return None
  452. return _validate_email_claim_name(v)
  453. @field_validator("group_claim")
  454. @classmethod
  455. def validate_group_claim(cls, v: str | None) -> str | None:
  456. if v is None:
  457. return None
  458. return _validate_group_claim_name(v)
  459. @field_validator("group_mapping")
  460. @classmethod
  461. def validate_group_mapping(cls, v: dict[str, str] | None) -> dict[str, str] | None:
  462. if v is None:
  463. return None
  464. return _validate_group_mapping(v)
  465. @field_validator("icon_url")
  466. @classmethod
  467. def validate_icon_url(cls, v: str | None) -> str | None:
  468. return _validate_icon_url(v)
  469. # SEC-1 (schema-level): blocks only when auto_link=True + email_claim='email' + require_email_verified=False
  470. # arrive in the same request. email_claim=None means the request leaves it unchanged (still 'email' by default),
  471. # so that is also treated as 'email'. Partial updates spanning two requests are caught by the
  472. # Combined-State-Guard in the route handler after the setattr loop.
  473. @model_validator(mode="after")
  474. def check_auto_link_requires_verified(self) -> "OIDCProviderUpdate":
  475. if (
  476. self.auto_link_existing_accounts is True
  477. and self.require_email_verified is False
  478. and (self.email_claim is None or self.email_claim == "email")
  479. ):
  480. raise ValueError(AUTO_LINK_REQUIREMENTS_ERROR)
  481. return self
  482. class OIDCProviderResponse(BaseModel):
  483. id: int
  484. name: str
  485. issuer_url: str
  486. client_id: str
  487. scopes: str
  488. is_enabled: bool
  489. auto_create_users: bool
  490. auto_link_existing_accounts: bool = False
  491. email_claim: str = "email"
  492. require_email_verified: bool = True
  493. # #3107 — group sync config, echoed back so the settings UI can render it.
  494. group_claim: str = "groups"
  495. group_mapping: dict[str, str] = {}
  496. icon_url: str | None = None
  497. default_group_id: int | None = None
  498. is_autologin: bool = False # #1589
  499. # #2593 — the UI renders this provider read-only; without the flag it would
  500. # offer editable fields whose writes the API then refuses with 409.
  501. is_env_managed: bool = False
  502. # Set explicitly in the route handler from `icon_content_type is not None`
  503. # rather than `@computed_field` (project policy) or `icon_data is not None`
  504. # (would trigger an async lazy-load on the deferred BLOB column).
  505. # Required (no default) so Pydantic fails loudly if any code path skips
  506. # `_build_provider_response` and tries `model_validate(provider)` directly.
  507. has_icon: bool
  508. class Config:
  509. from_attributes = True
  510. class OIDCProviderPublicResponse(BaseModel):
  511. """#3107 — what the unauthenticated login page is allowed to see.
  512. GET /oidc/providers is public so the login page can render the SSO
  513. buttons, and it needs exactly four fields: id + name for the button,
  514. has_icon for the avatar, is_autologin for the redirect-on-mount (#1589).
  515. The full OIDCProviderResponse carries group_claim / group_mapping —
  516. which IdP group name maps to which Bambuddy group, including
  517. Administrators — and leaking that to anonymous visitors would tell
  518. anyone who can reach the login page exactly which IdP group to aim for.
  519. """
  520. id: int
  521. name: str
  522. has_icon: bool
  523. is_autologin: bool = False
  524. class Config:
  525. from_attributes = True
  526. class OIDCAuthorizeResponse(BaseModel):
  527. auth_url: str
  528. class OIDCExchangeRequest(BaseModel):
  529. oidc_token: str = Field(..., max_length=128)
  530. class OIDCLinkResponse(BaseModel):
  531. id: int
  532. provider_id: int
  533. provider_name: str
  534. provider_email: str | None = None
  535. created_at: str
  536. class EncryptionRowCounts(BaseModel):
  537. oidc_providers: int
  538. user_totp: int
  539. class EncryptionStatusResponse(BaseModel):
  540. key_configured: bool
  541. key_source: Literal["env", "file", "generated", "none"]
  542. legacy_plaintext_rows: EncryptionRowCounts
  543. encrypted_rows: EncryptionRowCounts
  544. # B4: filled by the endpoint after a sample-decrypt of one encrypted row,
  545. # so a wrong-key state (where key_configured=True but rows decrypt to junk)
  546. # is detected, not just the no-key case.
  547. decryption_broken: bool = False
  548. # B2: number of rows skipped during the last legacy re-encryption migration.
  549. # Filled from backend.app.core.database.get_migration_error_count().
  550. migration_error_count: int = 0