auth.py 25 KB

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