oauth.py 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374
  1. import base64
  2. import hashlib
  3. import logging
  4. import mimetypes
  5. import sys
  6. import urllib
  7. import uuid
  8. import json
  9. from datetime import datetime, timedelta
  10. import re
  11. import fnmatch
  12. import time
  13. import secrets
  14. from cryptography.fernet import Fernet
  15. import aiohttp
  16. from authlib.integrations.starlette_client import OAuth
  17. from authlib.oidc.core import UserInfo
  18. from fastapi import (
  19. HTTPException,
  20. status,
  21. )
  22. from starlette.responses import RedirectResponse
  23. from typing import Optional
  24. from open_webui.models.auths import Auths
  25. from open_webui.models.oauth_sessions import OAuthSessions
  26. from open_webui.models.users import Users
  27. from open_webui.models.groups import Groups, GroupModel, GroupUpdateForm, GroupForm
  28. from open_webui.config import (
  29. DEFAULT_USER_ROLE,
  30. ENABLE_OAUTH_SIGNUP,
  31. OAUTH_MERGE_ACCOUNTS_BY_EMAIL,
  32. OAUTH_PROVIDERS,
  33. ENABLE_OAUTH_ROLE_MANAGEMENT,
  34. ENABLE_OAUTH_GROUP_MANAGEMENT,
  35. ENABLE_OAUTH_GROUP_CREATION,
  36. OAUTH_BLOCKED_GROUPS,
  37. OAUTH_ROLES_CLAIM,
  38. OAUTH_SUB_CLAIM,
  39. OAUTH_GROUPS_CLAIM,
  40. OAUTH_EMAIL_CLAIM,
  41. OAUTH_PICTURE_CLAIM,
  42. OAUTH_USERNAME_CLAIM,
  43. OAUTH_ALLOWED_ROLES,
  44. OAUTH_ADMIN_ROLES,
  45. OAUTH_ALLOWED_DOMAINS,
  46. OAUTH_UPDATE_PICTURE_ON_LOGIN,
  47. WEBHOOK_URL,
  48. JWT_EXPIRES_IN,
  49. AppConfig,
  50. )
  51. from open_webui.constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
  52. from open_webui.env import (
  53. AIOHTTP_CLIENT_SESSION_SSL,
  54. WEBUI_NAME,
  55. WEBUI_AUTH_COOKIE_SAME_SITE,
  56. WEBUI_AUTH_COOKIE_SECURE,
  57. ENABLE_OAUTH_ID_TOKEN_COOKIE,
  58. ENABLE_OAUTH_EMAIL_FALLBACK,
  59. OAUTH_CLIENT_INFO_ENCRYPTION_KEY,
  60. )
  61. from open_webui.utils.misc import parse_duration
  62. from open_webui.utils.auth import get_password_hash, create_token
  63. from open_webui.utils.webhook import post_webhook
  64. from mcp.shared.auth import (
  65. OAuthClientMetadata,
  66. OAuthMetadata,
  67. )
  68. class OAuthClientInformationFull(OAuthClientMetadata):
  69. issuer: Optional[str] = None # URL of the OAuth server that issued this client
  70. client_id: str
  71. client_secret: str | None = None
  72. client_id_issued_at: int | None = None
  73. client_secret_expires_at: int | None = None
  74. server_metadata: Optional[OAuthMetadata] = None # Fetched from the OAuth server
  75. from open_webui.env import SRC_LOG_LEVELS, GLOBAL_LOG_LEVEL
  76. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  77. log = logging.getLogger(__name__)
  78. log.setLevel(SRC_LOG_LEVELS["OAUTH"])
  79. auth_manager_config = AppConfig()
  80. auth_manager_config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  81. auth_manager_config.ENABLE_OAUTH_SIGNUP = ENABLE_OAUTH_SIGNUP
  82. auth_manager_config.OAUTH_MERGE_ACCOUNTS_BY_EMAIL = OAUTH_MERGE_ACCOUNTS_BY_EMAIL
  83. auth_manager_config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  84. auth_manager_config.ENABLE_OAUTH_GROUP_MANAGEMENT = ENABLE_OAUTH_GROUP_MANAGEMENT
  85. auth_manager_config.ENABLE_OAUTH_GROUP_CREATION = ENABLE_OAUTH_GROUP_CREATION
  86. auth_manager_config.OAUTH_BLOCKED_GROUPS = OAUTH_BLOCKED_GROUPS
  87. auth_manager_config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  88. auth_manager_config.OAUTH_SUB_CLAIM = OAUTH_SUB_CLAIM
  89. auth_manager_config.OAUTH_GROUPS_CLAIM = OAUTH_GROUPS_CLAIM
  90. auth_manager_config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  91. auth_manager_config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  92. auth_manager_config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  93. auth_manager_config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  94. auth_manager_config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  95. auth_manager_config.OAUTH_ALLOWED_DOMAINS = OAUTH_ALLOWED_DOMAINS
  96. auth_manager_config.WEBHOOK_URL = WEBHOOK_URL
  97. auth_manager_config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  98. auth_manager_config.OAUTH_UPDATE_PICTURE_ON_LOGIN = OAUTH_UPDATE_PICTURE_ON_LOGIN
  99. FERNET = None
  100. if len(OAUTH_CLIENT_INFO_ENCRYPTION_KEY) != 44:
  101. key_bytes = hashlib.sha256(OAUTH_CLIENT_INFO_ENCRYPTION_KEY.encode()).digest()
  102. OAUTH_CLIENT_INFO_ENCRYPTION_KEY = base64.urlsafe_b64encode(key_bytes)
  103. else:
  104. OAUTH_CLIENT_INFO_ENCRYPTION_KEY = OAUTH_CLIENT_INFO_ENCRYPTION_KEY.encode()
  105. try:
  106. FERNET = Fernet(OAUTH_CLIENT_INFO_ENCRYPTION_KEY)
  107. except Exception as e:
  108. log.error(f"Error initializing Fernet with provided key: {e}")
  109. raise
  110. def encrypt_data(data) -> str:
  111. """Encrypt data for storage"""
  112. try:
  113. data_json = json.dumps(data)
  114. encrypted = FERNET.encrypt(data_json.encode()).decode()
  115. return encrypted
  116. except Exception as e:
  117. log.error(f"Error encrypting data: {e}")
  118. raise
  119. def decrypt_data(data: str):
  120. """Decrypt data from storage"""
  121. try:
  122. decrypted = FERNET.decrypt(data.encode()).decode()
  123. return json.loads(decrypted)
  124. except Exception as e:
  125. log.error(f"Error decrypting data: {e}")
  126. raise
  127. def is_in_blocked_groups(group_name: str, groups: list) -> bool:
  128. """
  129. Check if a group name matches any blocked pattern.
  130. Supports exact matches, shell-style wildcards (*, ?), and regex patterns.
  131. Args:
  132. group_name: The group name to check
  133. groups: List of patterns to match against
  134. Returns:
  135. True if the group is blocked, False otherwise
  136. """
  137. if not groups:
  138. return False
  139. for group_pattern in groups:
  140. if not group_pattern: # Skip empty patterns
  141. continue
  142. # Exact match
  143. if group_name == group_pattern:
  144. return True
  145. # Try as regex pattern first if it contains regex-specific characters
  146. if any(
  147. char in group_pattern
  148. for char in ["^", "$", "[", "]", "(", ")", "{", "}", "+", "\\", "|"]
  149. ):
  150. try:
  151. # Use the original pattern as-is for regex matching
  152. if re.search(group_pattern, group_name):
  153. return True
  154. except re.error:
  155. # If regex is invalid, fall through to wildcard check
  156. pass
  157. # Shell-style wildcard match (supports * and ?)
  158. if "*" in group_pattern or "?" in group_pattern:
  159. if fnmatch.fnmatch(group_name, group_pattern):
  160. return True
  161. return False
  162. def get_parsed_and_base_url(server_url) -> tuple[urllib.parse.ParseResult, str]:
  163. parsed = urllib.parse.urlparse(server_url)
  164. base_url = f"{parsed.scheme}://{parsed.netloc}"
  165. return parsed, base_url
  166. def get_discovery_urls(server_url) -> list[str]:
  167. parsed, base_url = get_parsed_and_base_url(server_url)
  168. urls = [
  169. urllib.parse.urljoin(base_url, "/.well-known/oauth-authorization-server"),
  170. urllib.parse.urljoin(base_url, "/.well-known/openid-configuration"),
  171. ]
  172. if parsed.path and parsed.path != "/":
  173. urls.append(
  174. urllib.parse.urljoin(
  175. base_url,
  176. f"/.well-known/oauth-authorization-server{parsed.path.rstrip('/')}",
  177. )
  178. )
  179. urls.append(
  180. urllib.parse.urljoin(
  181. base_url, f"/.well-known/openid-configuration{parsed.path.rstrip('/')}"
  182. )
  183. )
  184. return urls
  185. # TODO: Some OAuth providers require Initial Access Tokens (IATs) for dynamic client registration.
  186. # This is not currently supported.
  187. async def get_oauth_client_info_with_dynamic_client_registration(
  188. request,
  189. client_id: str,
  190. oauth_server_url: str,
  191. oauth_server_key: Optional[str] = None,
  192. ) -> OAuthClientInformationFull:
  193. try:
  194. oauth_server_metadata = None
  195. oauth_server_metadata_url = None
  196. redirect_base_url = (
  197. str(request.app.state.config.WEBUI_URL or request.base_url)
  198. ).rstrip("/")
  199. oauth_client_metadata = OAuthClientMetadata(
  200. client_name="Open WebUI",
  201. redirect_uris=[f"{redirect_base_url}/oauth/clients/{client_id}/callback"],
  202. grant_types=["authorization_code", "refresh_token"],
  203. response_types=["code"],
  204. token_endpoint_auth_method="client_secret_post",
  205. )
  206. # Attempt to fetch OAuth server metadata to get registration endpoint & scopes
  207. discovery_urls = get_discovery_urls(oauth_server_url)
  208. for url in discovery_urls:
  209. async with aiohttp.ClientSession() as session:
  210. async with session.get(
  211. url, ssl=AIOHTTP_CLIENT_SESSION_SSL
  212. ) as oauth_server_metadata_response:
  213. if oauth_server_metadata_response.status == 200:
  214. try:
  215. oauth_server_metadata = OAuthMetadata.model_validate(
  216. await oauth_server_metadata_response.json()
  217. )
  218. oauth_server_metadata_url = url
  219. if (
  220. oauth_client_metadata.scope is None
  221. and oauth_server_metadata.scopes_supported is not None
  222. ):
  223. oauth_client_metadata.scope = " ".join(
  224. oauth_server_metadata.scopes_supported
  225. )
  226. break
  227. except Exception as e:
  228. log.error(f"Error parsing OAuth metadata from {url}: {e}")
  229. continue
  230. registration_url = None
  231. if oauth_server_metadata and oauth_server_metadata.registration_endpoint:
  232. registration_url = str(oauth_server_metadata.registration_endpoint)
  233. else:
  234. _, base_url = get_parsed_and_base_url(oauth_server_url)
  235. registration_url = urllib.parse.urljoin(base_url, "/register")
  236. registration_data = oauth_client_metadata.model_dump(
  237. exclude_none=True,
  238. mode="json",
  239. by_alias=True,
  240. )
  241. # Perform dynamic client registration and return client info
  242. async with aiohttp.ClientSession() as session:
  243. async with session.post(
  244. registration_url, json=registration_data, ssl=AIOHTTP_CLIENT_SESSION_SSL
  245. ) as oauth_client_registration_response:
  246. try:
  247. registration_response_json = (
  248. await oauth_client_registration_response.json()
  249. )
  250. oauth_client_info = OAuthClientInformationFull.model_validate(
  251. {
  252. **registration_response_json,
  253. **{"issuer": oauth_server_metadata_url},
  254. **{"server_metadata": oauth_server_metadata},
  255. }
  256. )
  257. log.info(
  258. f"Dynamic client registration successful at {registration_url}, client_id: {oauth_client_info.client_id}"
  259. )
  260. return oauth_client_info
  261. except Exception as e:
  262. error_text = None
  263. try:
  264. error_text = await oauth_client_registration_response.text()
  265. log.error(
  266. f"Dynamic client registration failed at {registration_url}: {oauth_client_registration_response.status} - {error_text}"
  267. )
  268. except Exception as e:
  269. pass
  270. log.error(f"Error parsing client registration response: {e}")
  271. raise Exception(
  272. f"Dynamic client registration failed: {error_text}"
  273. if error_text
  274. else "Error parsing client registration response"
  275. )
  276. raise Exception("Dynamic client registration failed")
  277. except Exception as e:
  278. log.error(f"Exception during dynamic client registration: {e}")
  279. raise e
  280. class OAuthClientManager:
  281. def __init__(self, app):
  282. self.oauth = OAuth()
  283. self.app = app
  284. self.clients = {}
  285. def add_client(self, client_id, oauth_client_info: OAuthClientInformationFull):
  286. kwargs = {
  287. "name": client_id,
  288. "client_id": oauth_client_info.client_id,
  289. "client_secret": oauth_client_info.client_secret,
  290. "client_kwargs": (
  291. {"scope": oauth_client_info.scope} if oauth_client_info.scope else {}
  292. ),
  293. "server_metadata_url": (
  294. oauth_client_info.issuer if oauth_client_info.issuer else None
  295. ),
  296. }
  297. if (
  298. oauth_client_info.server_metadata
  299. and oauth_client_info.server_metadata.code_challenge_methods_supported
  300. ):
  301. if (
  302. isinstance(
  303. oauth_client_info.server_metadata.code_challenge_methods_supported,
  304. list,
  305. )
  306. and "S256"
  307. in oauth_client_info.server_metadata.code_challenge_methods_supported
  308. ):
  309. kwargs["code_challenge_method"] = "S256"
  310. self.clients[client_id] = {
  311. "client": self.oauth.register(**kwargs),
  312. "client_info": oauth_client_info,
  313. }
  314. return self.clients[client_id]
  315. def remove_client(self, client_id):
  316. if client_id in self.clients:
  317. del self.clients[client_id]
  318. log.info(f"Removed OAuth client {client_id}")
  319. return True
  320. def get_client(self, client_id):
  321. client = self.clients.get(client_id)
  322. return client["client"] if client else None
  323. def get_client_info(self, client_id):
  324. client = self.clients.get(client_id)
  325. return client["client_info"] if client else None
  326. def get_server_metadata_url(self, client_id):
  327. if client_id in self.clients:
  328. client = self.clients[client_id]
  329. return (
  330. client._server_metadata_url
  331. if hasattr(client, "_server_metadata_url")
  332. else None
  333. )
  334. return None
  335. async def get_oauth_token(
  336. self, user_id: str, client_id: str, force_refresh: bool = False
  337. ):
  338. """
  339. Get a valid OAuth token for the user, automatically refreshing if needed.
  340. Args:
  341. user_id: The user ID
  342. client_id: The OAuth client ID (provider)
  343. force_refresh: Force token refresh even if current token appears valid
  344. Returns:
  345. dict: OAuth token data with access_token, or None if no valid token available
  346. """
  347. try:
  348. # Get the OAuth session
  349. session = OAuthSessions.get_session_by_provider_and_user_id(
  350. client_id, user_id
  351. )
  352. if not session:
  353. log.warning(
  354. f"No OAuth session found for user {user_id}, client_id {client_id}"
  355. )
  356. return None
  357. if force_refresh or datetime.now() + timedelta(
  358. minutes=5
  359. ) >= datetime.fromtimestamp(session.expires_at):
  360. log.debug(
  361. f"Token refresh needed for user {user_id}, client_id {session.provider}"
  362. )
  363. refreshed_token = await self._refresh_token(session)
  364. if refreshed_token:
  365. return refreshed_token
  366. else:
  367. log.warning(
  368. f"Token refresh failed for user {user_id}, client_id {session.provider}, deleting session {session.id}"
  369. )
  370. OAuthSessions.delete_session_by_id(session.id)
  371. return None
  372. return session.token
  373. except Exception as e:
  374. log.error(f"Error getting OAuth token for user {user_id}: {e}")
  375. return None
  376. async def _refresh_token(self, session) -> dict:
  377. """
  378. Refresh an OAuth token if needed, with concurrency protection.
  379. Args:
  380. session: The OAuth session object
  381. Returns:
  382. dict: Refreshed token data, or None if refresh failed
  383. """
  384. try:
  385. # Perform the actual refresh
  386. refreshed_token = await self._perform_token_refresh(session)
  387. if refreshed_token:
  388. # Update the session with new token data
  389. session = OAuthSessions.update_session_by_id(
  390. session.id, refreshed_token
  391. )
  392. log.info(f"Successfully refreshed token for session {session.id}")
  393. return session.token
  394. else:
  395. log.error(f"Failed to refresh token for session {session.id}")
  396. return None
  397. except Exception as e:
  398. log.error(f"Error refreshing token for session {session.id}: {e}")
  399. return None
  400. async def _perform_token_refresh(self, session) -> dict:
  401. """
  402. Perform the actual OAuth token refresh.
  403. Args:
  404. session: The OAuth session object
  405. Returns:
  406. dict: New token data, or None if refresh failed
  407. """
  408. client_id = session.provider
  409. token_data = session.token
  410. if not token_data.get("refresh_token"):
  411. log.warning(f"No refresh token available for session {session.id}")
  412. return None
  413. try:
  414. client = self.get_client(client_id)
  415. if not client:
  416. log.error(f"No OAuth client found for provider {client_id}")
  417. return None
  418. token_endpoint = None
  419. async with aiohttp.ClientSession(trust_env=True) as session_http:
  420. async with session_http.get(
  421. self.get_server_metadata_url(client_id)
  422. ) as r:
  423. if r.status == 200:
  424. openid_data = await r.json()
  425. token_endpoint = openid_data.get("token_endpoint")
  426. else:
  427. log.error(
  428. f"Failed to fetch OpenID configuration for client_id {client_id}"
  429. )
  430. if not token_endpoint:
  431. log.error(f"No token endpoint found for client_id {client_id}")
  432. return None
  433. # Prepare refresh request
  434. refresh_data = {
  435. "grant_type": "refresh_token",
  436. "refresh_token": token_data["refresh_token"],
  437. "client_id": client.client_id,
  438. }
  439. if hasattr(client, "client_secret") and client.client_secret:
  440. refresh_data["client_secret"] = client.client_secret
  441. # Make refresh request
  442. async with aiohttp.ClientSession(trust_env=True) as session_http:
  443. async with session_http.post(
  444. token_endpoint,
  445. data=refresh_data,
  446. headers={"Content-Type": "application/x-www-form-urlencoded"},
  447. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  448. ) as r:
  449. if r.status == 200:
  450. new_token_data = await r.json()
  451. # Merge with existing token data (preserve refresh_token if not provided)
  452. if "refresh_token" not in new_token_data:
  453. new_token_data["refresh_token"] = token_data[
  454. "refresh_token"
  455. ]
  456. # Add timestamp for tracking
  457. new_token_data["issued_at"] = datetime.now().timestamp()
  458. # Calculate expires_at if we have expires_in
  459. if (
  460. "expires_in" in new_token_data
  461. and "expires_at" not in new_token_data
  462. ):
  463. new_token_data["expires_at"] = int(
  464. datetime.now().timestamp()
  465. + new_token_data["expires_in"]
  466. )
  467. log.debug(f"Token refresh successful for client_id {client_id}")
  468. return new_token_data
  469. else:
  470. error_text = await r.text()
  471. log.error(
  472. f"Token refresh failed for client_id {client_id}: {r.status} - {error_text}"
  473. )
  474. return None
  475. except Exception as e:
  476. log.error(f"Exception during token refresh for client_id {client_id}: {e}")
  477. return None
  478. async def handle_authorize(self, request, client_id: str) -> RedirectResponse:
  479. client = self.get_client(client_id)
  480. if client is None:
  481. raise HTTPException(404)
  482. client_info = self.get_client_info(client_id)
  483. if client_info is None:
  484. raise HTTPException(404)
  485. redirect_uri = (
  486. client_info.redirect_uris[0] if client_info.redirect_uris else None
  487. )
  488. return await client.authorize_redirect(request, str(redirect_uri))
  489. async def handle_callback(self, request, client_id: str, user_id: str, response):
  490. client = self.get_client(client_id)
  491. if client is None:
  492. raise HTTPException(404)
  493. error_message = None
  494. try:
  495. client_info = self.get_client_info(client_id)
  496. token_params = {}
  497. if (
  498. client_info
  499. and hasattr(client_info, "client_id")
  500. and hasattr(client_info, "client_secret")
  501. ):
  502. token_params["client_id"] = client_info.client_id
  503. token_params["client_secret"] = client_info.client_secret
  504. token = await client.authorize_access_token(request, **token_params)
  505. if token:
  506. try:
  507. # Add timestamp for tracking
  508. token["issued_at"] = datetime.now().timestamp()
  509. # Calculate expires_at if we have expires_in
  510. if "expires_in" in token and "expires_at" not in token:
  511. token["expires_at"] = (
  512. datetime.now().timestamp() + token["expires_in"]
  513. )
  514. # Clean up any existing sessions for this user/client_id first
  515. sessions = OAuthSessions.get_sessions_by_user_id(user_id)
  516. for session in sessions:
  517. if session.provider == client_id:
  518. OAuthSessions.delete_session_by_id(session.id)
  519. session = OAuthSessions.create_session(
  520. user_id=user_id,
  521. provider=client_id,
  522. token=token,
  523. )
  524. log.info(
  525. f"Stored OAuth session server-side for user {user_id}, client_id {client_id}"
  526. )
  527. except Exception as e:
  528. error_message = "Failed to store OAuth session server-side"
  529. log.error(f"Failed to store OAuth session server-side: {e}")
  530. else:
  531. error_message = "Failed to obtain OAuth token"
  532. log.warning(error_message)
  533. except Exception as e:
  534. error_message = "OAuth callback error"
  535. log.warning(f"OAuth callback error: {e}")
  536. redirect_url = (
  537. str(request.app.state.config.WEBUI_URL or request.base_url)
  538. ).rstrip("/")
  539. if error_message:
  540. log.debug(error_message)
  541. redirect_url = f"{redirect_url}/?error={error_message}"
  542. return RedirectResponse(url=redirect_url, headers=response.headers)
  543. response = RedirectResponse(url=redirect_url, headers=response.headers)
  544. return response
  545. class OAuthManager:
  546. def __init__(self, app):
  547. self.oauth = OAuth()
  548. self.app = app
  549. self._clients = {}
  550. for name, provider_config in OAUTH_PROVIDERS.items():
  551. if "register" not in provider_config:
  552. log.error(f"OAuth provider {name} missing register function")
  553. continue
  554. client = provider_config["register"](self.oauth)
  555. self._clients[name] = client
  556. def get_client(self, provider_name):
  557. if provider_name not in self._clients:
  558. self._clients[provider_name] = self.oauth.create_client(provider_name)
  559. return self._clients[provider_name]
  560. def get_server_metadata_url(self, provider_name):
  561. if provider_name in self._clients:
  562. client = self._clients[provider_name]
  563. return (
  564. client._server_metadata_url
  565. if hasattr(client, "_server_metadata_url")
  566. else None
  567. )
  568. return None
  569. async def get_oauth_token(
  570. self, user_id: str, session_id: str, force_refresh: bool = False
  571. ):
  572. """
  573. Get a valid OAuth token for the user, automatically refreshing if needed.
  574. Args:
  575. user_id: The user ID
  576. provider: Optional provider name. If None, gets the most recent session.
  577. force_refresh: Force token refresh even if current token appears valid
  578. Returns:
  579. dict: OAuth token data with access_token, or None if no valid token available
  580. """
  581. try:
  582. # Get the OAuth session
  583. session = OAuthSessions.get_session_by_id_and_user_id(session_id, user_id)
  584. if not session:
  585. log.warning(
  586. f"No OAuth session found for user {user_id}, session {session_id}"
  587. )
  588. return None
  589. if force_refresh or datetime.now() + timedelta(
  590. minutes=5
  591. ) >= datetime.fromtimestamp(session.expires_at):
  592. log.debug(
  593. f"Token refresh needed for user {user_id}, provider {session.provider}"
  594. )
  595. refreshed_token = await self._refresh_token(session)
  596. if refreshed_token:
  597. return refreshed_token
  598. else:
  599. log.warning(
  600. f"Token refresh failed for user {user_id}, provider {session.provider}, deleting session {session.id}"
  601. )
  602. OAuthSessions.delete_session_by_id(session.id)
  603. return None
  604. return session.token
  605. except Exception as e:
  606. log.error(f"Error getting OAuth token for user {user_id}: {e}")
  607. return None
  608. async def _refresh_token(self, session) -> dict:
  609. """
  610. Refresh an OAuth token if needed, with concurrency protection.
  611. Args:
  612. session: The OAuth session object
  613. Returns:
  614. dict: Refreshed token data, or None if refresh failed
  615. """
  616. try:
  617. # Perform the actual refresh
  618. refreshed_token = await self._perform_token_refresh(session)
  619. if refreshed_token:
  620. # Update the session with new token data
  621. session = OAuthSessions.update_session_by_id(
  622. session.id, refreshed_token
  623. )
  624. log.info(f"Successfully refreshed token for session {session.id}")
  625. return session.token
  626. else:
  627. log.error(f"Failed to refresh token for session {session.id}")
  628. return None
  629. except Exception as e:
  630. log.error(f"Error refreshing token for session {session.id}: {e}")
  631. return None
  632. async def _perform_token_refresh(self, session) -> dict:
  633. """
  634. Perform the actual OAuth token refresh.
  635. Args:
  636. session: The OAuth session object
  637. Returns:
  638. dict: New token data, or None if refresh failed
  639. """
  640. provider = session.provider
  641. token_data = session.token
  642. if not token_data.get("refresh_token"):
  643. log.warning(f"No refresh token available for session {session.id}")
  644. return None
  645. try:
  646. client = self.get_client(provider)
  647. if not client:
  648. log.error(f"No OAuth client found for provider {provider}")
  649. return None
  650. server_metadata_url = self.get_server_metadata_url(provider)
  651. token_endpoint = None
  652. async with aiohttp.ClientSession(trust_env=True) as session_http:
  653. async with session_http.get(server_metadata_url) as r:
  654. if r.status == 200:
  655. openid_data = await r.json()
  656. token_endpoint = openid_data.get("token_endpoint")
  657. else:
  658. log.error(
  659. f"Failed to fetch OpenID configuration for provider {provider}"
  660. )
  661. if not token_endpoint:
  662. log.error(f"No token endpoint found for provider {provider}")
  663. return None
  664. # Prepare refresh request
  665. refresh_data = {
  666. "grant_type": "refresh_token",
  667. "refresh_token": token_data["refresh_token"],
  668. "client_id": client.client_id,
  669. }
  670. # Add client_secret if available (some providers require it)
  671. if hasattr(client, "client_secret") and client.client_secret:
  672. refresh_data["client_secret"] = client.client_secret
  673. # Make refresh request
  674. async with aiohttp.ClientSession(trust_env=True) as session_http:
  675. async with session_http.post(
  676. token_endpoint,
  677. data=refresh_data,
  678. headers={"Content-Type": "application/x-www-form-urlencoded"},
  679. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  680. ) as r:
  681. if r.status == 200:
  682. new_token_data = await r.json()
  683. # Merge with existing token data (preserve refresh_token if not provided)
  684. if "refresh_token" not in new_token_data:
  685. new_token_data["refresh_token"] = token_data[
  686. "refresh_token"
  687. ]
  688. # Add timestamp for tracking
  689. new_token_data["issued_at"] = datetime.now().timestamp()
  690. # Calculate expires_at if we have expires_in
  691. if (
  692. "expires_in" in new_token_data
  693. and "expires_at" not in new_token_data
  694. ):
  695. new_token_data["expires_at"] = int(
  696. datetime.now().timestamp()
  697. + new_token_data["expires_in"]
  698. )
  699. log.debug(f"Token refresh successful for provider {provider}")
  700. return new_token_data
  701. else:
  702. error_text = await r.text()
  703. log.error(
  704. f"Token refresh failed for provider {provider}: {r.status} - {error_text}"
  705. )
  706. return None
  707. except Exception as e:
  708. log.error(f"Exception during token refresh for provider {provider}: {e}")
  709. return None
  710. def get_user_role(self, user, user_data):
  711. user_count = Users.get_num_users()
  712. if user and user_count == 1:
  713. # If the user is the only user, assign the role "admin" - actually repairs role for single user on login
  714. log.debug("Assigning the only user the admin role")
  715. return "admin"
  716. if not user and user_count == 0:
  717. # If there are no users, assign the role "admin", as the first user will be an admin
  718. log.debug("Assigning the first user the admin role")
  719. return "admin"
  720. if auth_manager_config.ENABLE_OAUTH_ROLE_MANAGEMENT:
  721. log.debug("Running OAUTH Role management")
  722. oauth_claim = auth_manager_config.OAUTH_ROLES_CLAIM
  723. oauth_allowed_roles = auth_manager_config.OAUTH_ALLOWED_ROLES
  724. oauth_admin_roles = auth_manager_config.OAUTH_ADMIN_ROLES
  725. oauth_roles = []
  726. # Default/fallback role if no matching roles are found
  727. role = auth_manager_config.DEFAULT_USER_ROLE
  728. # Next block extracts the roles from the user data, accepting nested claims of any depth
  729. if oauth_claim and oauth_allowed_roles and oauth_admin_roles:
  730. claim_data = user_data
  731. nested_claims = oauth_claim.split(".")
  732. for nested_claim in nested_claims:
  733. claim_data = claim_data.get(nested_claim, {})
  734. oauth_roles = []
  735. if isinstance(claim_data, list):
  736. oauth_roles = claim_data
  737. if isinstance(claim_data, str) or isinstance(claim_data, int):
  738. oauth_roles = [str(claim_data)]
  739. log.debug(f"Oauth Roles claim: {oauth_claim}")
  740. log.debug(f"User roles from oauth: {oauth_roles}")
  741. log.debug(f"Accepted user roles: {oauth_allowed_roles}")
  742. log.debug(f"Accepted admin roles: {oauth_admin_roles}")
  743. # If any roles are found, check if they match the allowed or admin roles
  744. if oauth_roles:
  745. # If role management is enabled, and matching roles are provided, use the roles
  746. for allowed_role in oauth_allowed_roles:
  747. # If the user has any of the allowed roles, assign the role "user"
  748. if allowed_role in oauth_roles:
  749. log.debug("Assigned user the user role")
  750. role = "user"
  751. break
  752. for admin_role in oauth_admin_roles:
  753. # If the user has any of the admin roles, assign the role "admin"
  754. if admin_role in oauth_roles:
  755. log.debug("Assigned user the admin role")
  756. role = "admin"
  757. break
  758. else:
  759. if not user:
  760. # If role management is disabled, use the default role for new users
  761. role = auth_manager_config.DEFAULT_USER_ROLE
  762. else:
  763. # If role management is disabled, use the existing role for existing users
  764. role = user.role
  765. return role
  766. def update_user_groups(self, user, user_data, default_permissions):
  767. log.debug("Running OAUTH Group management")
  768. oauth_claim = auth_manager_config.OAUTH_GROUPS_CLAIM
  769. try:
  770. blocked_groups = json.loads(auth_manager_config.OAUTH_BLOCKED_GROUPS)
  771. except Exception as e:
  772. log.exception(f"Error loading OAUTH_BLOCKED_GROUPS: {e}")
  773. blocked_groups = []
  774. user_oauth_groups = []
  775. # Nested claim search for groups claim
  776. if oauth_claim:
  777. claim_data = user_data
  778. nested_claims = oauth_claim.split(".")
  779. for nested_claim in nested_claims:
  780. claim_data = claim_data.get(nested_claim, {})
  781. if isinstance(claim_data, list):
  782. user_oauth_groups = claim_data
  783. elif isinstance(claim_data, str):
  784. user_oauth_groups = [claim_data]
  785. else:
  786. user_oauth_groups = []
  787. user_current_groups: list[GroupModel] = Groups.get_groups_by_member_id(user.id)
  788. all_available_groups: list[GroupModel] = Groups.get_groups()
  789. # Create groups if they don't exist and creation is enabled
  790. if auth_manager_config.ENABLE_OAUTH_GROUP_CREATION:
  791. log.debug("Checking for missing groups to create...")
  792. all_group_names = {g.name for g in all_available_groups}
  793. groups_created = False
  794. # Determine creator ID: Prefer admin, fallback to current user if no admin exists
  795. admin_user = Users.get_super_admin_user()
  796. creator_id = admin_user.id if admin_user else user.id
  797. log.debug(f"Using creator ID {creator_id} for potential group creation.")
  798. for group_name in user_oauth_groups:
  799. if group_name not in all_group_names:
  800. log.info(
  801. f"Group '{group_name}' not found via OAuth claim. Creating group..."
  802. )
  803. try:
  804. new_group_form = GroupForm(
  805. name=group_name,
  806. description=f"Group '{group_name}' created automatically via OAuth.",
  807. permissions=default_permissions, # Use default permissions from function args
  808. user_ids=[], # Start with no users, user will be added later by subsequent logic
  809. )
  810. # Use determined creator ID (admin or fallback to current user)
  811. created_group = Groups.insert_new_group(
  812. creator_id, new_group_form
  813. )
  814. if created_group:
  815. log.info(
  816. f"Successfully created group '{group_name}' with ID {created_group.id} using creator ID {creator_id}"
  817. )
  818. groups_created = True
  819. # Add to local set to prevent duplicate creation attempts in this run
  820. all_group_names.add(group_name)
  821. else:
  822. log.error(
  823. f"Failed to create group '{group_name}' via OAuth."
  824. )
  825. except Exception as e:
  826. log.error(f"Error creating group '{group_name}' via OAuth: {e}")
  827. # Refresh the list of all available groups if any were created
  828. if groups_created:
  829. all_available_groups = Groups.get_groups()
  830. log.debug("Refreshed list of all available groups after creation.")
  831. log.debug(f"Oauth Groups claim: {oauth_claim}")
  832. log.debug(f"User oauth groups: {user_oauth_groups}")
  833. log.debug(f"User's current groups: {[g.name for g in user_current_groups]}")
  834. log.debug(
  835. f"All groups available in OpenWebUI: {[g.name for g in all_available_groups]}"
  836. )
  837. # Remove groups that user is no longer a part of
  838. for group_model in user_current_groups:
  839. if (
  840. user_oauth_groups
  841. and group_model.name not in user_oauth_groups
  842. and not is_in_blocked_groups(group_model.name, blocked_groups)
  843. ):
  844. # Remove group from user
  845. log.debug(
  846. f"Removing user from group {group_model.name} as it is no longer in their oauth groups"
  847. )
  848. user_ids = group_model.user_ids
  849. user_ids = [i for i in user_ids if i != user.id]
  850. # In case a group is created, but perms are never assigned to the group by hitting "save"
  851. group_permissions = group_model.permissions
  852. if not group_permissions:
  853. group_permissions = default_permissions
  854. update_form = GroupUpdateForm(
  855. name=group_model.name,
  856. description=group_model.description,
  857. permissions=group_permissions,
  858. user_ids=user_ids,
  859. )
  860. Groups.update_group_by_id(
  861. id=group_model.id, form_data=update_form, overwrite=False
  862. )
  863. # Add user to new groups
  864. for group_model in all_available_groups:
  865. if (
  866. user_oauth_groups
  867. and group_model.name in user_oauth_groups
  868. and not any(gm.name == group_model.name for gm in user_current_groups)
  869. and not is_in_blocked_groups(group_model.name, blocked_groups)
  870. ):
  871. # Add user to group
  872. log.debug(
  873. f"Adding user to group {group_model.name} as it was found in their oauth groups"
  874. )
  875. user_ids = group_model.user_ids
  876. user_ids.append(user.id)
  877. # In case a group is created, but perms are never assigned to the group by hitting "save"
  878. group_permissions = group_model.permissions
  879. if not group_permissions:
  880. group_permissions = default_permissions
  881. update_form = GroupUpdateForm(
  882. name=group_model.name,
  883. description=group_model.description,
  884. permissions=group_permissions,
  885. user_ids=user_ids,
  886. )
  887. Groups.update_group_by_id(
  888. id=group_model.id, form_data=update_form, overwrite=False
  889. )
  890. async def _process_picture_url(
  891. self, picture_url: str, access_token: str = None
  892. ) -> str:
  893. """Process a picture URL and return a base64 encoded data URL.
  894. Args:
  895. picture_url: The URL of the picture to process
  896. access_token: Optional OAuth access token for authenticated requests
  897. Returns:
  898. A data URL containing the base64 encoded picture, or "/user.png" if processing fails
  899. """
  900. if not picture_url:
  901. return "/user.png"
  902. try:
  903. get_kwargs = {}
  904. if access_token:
  905. get_kwargs["headers"] = {
  906. "Authorization": f"Bearer {access_token}",
  907. }
  908. async with aiohttp.ClientSession(trust_env=True) as session:
  909. async with session.get(
  910. picture_url, **get_kwargs, ssl=AIOHTTP_CLIENT_SESSION_SSL
  911. ) as resp:
  912. if resp.ok:
  913. picture = await resp.read()
  914. base64_encoded_picture = base64.b64encode(picture).decode(
  915. "utf-8"
  916. )
  917. guessed_mime_type = mimetypes.guess_type(picture_url)[0]
  918. if guessed_mime_type is None:
  919. guessed_mime_type = "image/jpeg"
  920. return (
  921. f"data:{guessed_mime_type};base64,{base64_encoded_picture}"
  922. )
  923. else:
  924. log.warning(
  925. f"Failed to fetch profile picture from {picture_url}"
  926. )
  927. return "/user.png"
  928. except Exception as e:
  929. log.error(f"Error processing profile picture '{picture_url}': {e}")
  930. return "/user.png"
  931. async def handle_login(self, request, provider):
  932. if provider not in OAUTH_PROVIDERS:
  933. raise HTTPException(404)
  934. # If the provider has a custom redirect URL, use that, otherwise automatically generate one
  935. redirect_uri = OAUTH_PROVIDERS[provider].get("redirect_uri") or request.url_for(
  936. "oauth_login_callback", provider=provider
  937. )
  938. client = self.get_client(provider)
  939. if client is None:
  940. raise HTTPException(404)
  941. return await client.authorize_redirect(request, redirect_uri)
  942. async def handle_callback(self, request, provider, response):
  943. if provider not in OAUTH_PROVIDERS:
  944. raise HTTPException(404)
  945. error_message = None
  946. try:
  947. client = self.get_client(provider)
  948. try:
  949. token = await client.authorize_access_token(request)
  950. except Exception as e:
  951. log.warning(f"OAuth callback error: {e}")
  952. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  953. # Try to get userinfo from the token first, some providers include it there
  954. user_data: UserInfo = token.get("userinfo")
  955. if (
  956. (not user_data)
  957. or (auth_manager_config.OAUTH_EMAIL_CLAIM not in user_data)
  958. or (auth_manager_config.OAUTH_USERNAME_CLAIM not in user_data)
  959. ):
  960. user_data: UserInfo = await client.userinfo(token=token)
  961. if (
  962. provider == "feishu"
  963. and isinstance(user_data, dict)
  964. and "data" in user_data
  965. ):
  966. user_data = user_data["data"]
  967. if not user_data:
  968. log.warning(f"OAuth callback failed, user data is missing: {token}")
  969. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  970. # Extract the "sub" claim, using custom claim if configured
  971. if auth_manager_config.OAUTH_SUB_CLAIM:
  972. sub = user_data.get(auth_manager_config.OAUTH_SUB_CLAIM)
  973. else:
  974. # Fallback to the default sub claim if not configured
  975. sub = user_data.get(OAUTH_PROVIDERS[provider].get("sub_claim", "sub"))
  976. if not sub:
  977. log.warning(f"OAuth callback failed, sub is missing: {user_data}")
  978. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  979. provider_sub = f"{provider}@{sub}"
  980. # Email extraction
  981. email_claim = auth_manager_config.OAUTH_EMAIL_CLAIM
  982. email = user_data.get(email_claim, "")
  983. # We currently mandate that email addresses are provided
  984. if not email:
  985. # If the provider is GitHub,and public email is not provided, we can use the access token to fetch the user's email
  986. if provider == "github":
  987. try:
  988. access_token = token.get("access_token")
  989. headers = {"Authorization": f"Bearer {access_token}"}
  990. async with aiohttp.ClientSession(trust_env=True) as session:
  991. async with session.get(
  992. "https://api.github.com/user/emails",
  993. headers=headers,
  994. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  995. ) as resp:
  996. if resp.ok:
  997. emails = await resp.json()
  998. # use the primary email as the user's email
  999. primary_email = next(
  1000. (
  1001. e["email"]
  1002. for e in emails
  1003. if e.get("primary")
  1004. ),
  1005. None,
  1006. )
  1007. if primary_email:
  1008. email = primary_email
  1009. else:
  1010. log.warning(
  1011. "No primary email found in GitHub response"
  1012. )
  1013. raise HTTPException(
  1014. 400, detail=ERROR_MESSAGES.INVALID_CRED
  1015. )
  1016. else:
  1017. log.warning("Failed to fetch GitHub email")
  1018. raise HTTPException(
  1019. 400, detail=ERROR_MESSAGES.INVALID_CRED
  1020. )
  1021. except Exception as e:
  1022. log.warning(f"Error fetching GitHub email: {e}")
  1023. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1024. elif ENABLE_OAUTH_EMAIL_FALLBACK:
  1025. email = f"{provider_sub}.local"
  1026. else:
  1027. log.warning(f"OAuth callback failed, email is missing: {user_data}")
  1028. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1029. email = email.lower()
  1030. # If allowed domains are configured, check if the email domain is in the list
  1031. if (
  1032. "*" not in auth_manager_config.OAUTH_ALLOWED_DOMAINS
  1033. and email.split("@")[-1]
  1034. not in auth_manager_config.OAUTH_ALLOWED_DOMAINS
  1035. ):
  1036. log.warning(
  1037. f"OAuth callback failed, e-mail domain is not in the list of allowed domains: {user_data}"
  1038. )
  1039. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1040. # Check if the user exists
  1041. user = Users.get_user_by_oauth_sub(provider_sub)
  1042. if not user:
  1043. # If the user does not exist, check if merging is enabled
  1044. if auth_manager_config.OAUTH_MERGE_ACCOUNTS_BY_EMAIL:
  1045. # Check if the user exists by email
  1046. user = Users.get_user_by_email(email)
  1047. if user:
  1048. # Update the user with the new oauth sub
  1049. Users.update_user_oauth_sub_by_id(user.id, provider_sub)
  1050. if user:
  1051. determined_role = self.get_user_role(user, user_data)
  1052. if user.role != determined_role:
  1053. Users.update_user_role_by_id(user.id, determined_role)
  1054. # Update profile picture if enabled and different from current
  1055. if auth_manager_config.OAUTH_UPDATE_PICTURE_ON_LOGIN:
  1056. picture_claim = auth_manager_config.OAUTH_PICTURE_CLAIM
  1057. if picture_claim:
  1058. new_picture_url = user_data.get(
  1059. picture_claim,
  1060. OAUTH_PROVIDERS[provider].get("picture_url", ""),
  1061. )
  1062. processed_picture_url = await self._process_picture_url(
  1063. new_picture_url, token.get("access_token")
  1064. )
  1065. if processed_picture_url != user.profile_image_url:
  1066. Users.update_user_profile_image_url_by_id(
  1067. user.id, processed_picture_url
  1068. )
  1069. log.debug(f"Updated profile picture for user {user.email}")
  1070. else:
  1071. # If the user does not exist, check if signups are enabled
  1072. if auth_manager_config.ENABLE_OAUTH_SIGNUP:
  1073. # Check if an existing user with the same email already exists
  1074. existing_user = Users.get_user_by_email(email)
  1075. if existing_user:
  1076. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  1077. picture_claim = auth_manager_config.OAUTH_PICTURE_CLAIM
  1078. if picture_claim:
  1079. picture_url = user_data.get(
  1080. picture_claim,
  1081. OAUTH_PROVIDERS[provider].get("picture_url", ""),
  1082. )
  1083. picture_url = await self._process_picture_url(
  1084. picture_url, token.get("access_token")
  1085. )
  1086. else:
  1087. picture_url = "/user.png"
  1088. username_claim = auth_manager_config.OAUTH_USERNAME_CLAIM
  1089. name = user_data.get(username_claim)
  1090. if not name:
  1091. log.warning("Username claim is missing, using email as name")
  1092. name = email
  1093. user = Auths.insert_new_auth(
  1094. email=email,
  1095. password=get_password_hash(
  1096. str(uuid.uuid4())
  1097. ), # Random password, not used
  1098. name=name,
  1099. profile_image_url=picture_url,
  1100. role=self.get_user_role(None, user_data),
  1101. oauth_sub=provider_sub,
  1102. )
  1103. if auth_manager_config.WEBHOOK_URL:
  1104. await post_webhook(
  1105. WEBUI_NAME,
  1106. auth_manager_config.WEBHOOK_URL,
  1107. WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  1108. {
  1109. "action": "signup",
  1110. "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  1111. "user": user.model_dump_json(exclude_none=True),
  1112. },
  1113. )
  1114. else:
  1115. raise HTTPException(
  1116. status.HTTP_403_FORBIDDEN,
  1117. detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
  1118. )
  1119. jwt_token = create_token(
  1120. data={"id": user.id},
  1121. expires_delta=parse_duration(auth_manager_config.JWT_EXPIRES_IN),
  1122. )
  1123. if (
  1124. auth_manager_config.ENABLE_OAUTH_GROUP_MANAGEMENT
  1125. and user.role != "admin"
  1126. ):
  1127. self.update_user_groups(
  1128. user=user,
  1129. user_data=user_data,
  1130. default_permissions=request.app.state.config.USER_PERMISSIONS,
  1131. )
  1132. except Exception as e:
  1133. log.error(f"Error during OAuth process: {e}")
  1134. error_message = (
  1135. e.detail
  1136. if isinstance(e, HTTPException) and e.detail
  1137. else ERROR_MESSAGES.DEFAULT("Error during OAuth process")
  1138. )
  1139. redirect_base_url = (
  1140. str(request.app.state.config.WEBUI_URL or request.base_url)
  1141. ).rstrip("/")
  1142. redirect_url = f"{redirect_base_url}/auth"
  1143. if error_message:
  1144. redirect_url = f"{redirect_url}?error={error_message}"
  1145. return RedirectResponse(url=redirect_url, headers=response.headers)
  1146. response = RedirectResponse(url=redirect_url, headers=response.headers)
  1147. # Set the cookie token
  1148. # Redirect back to the frontend with the JWT token
  1149. response.set_cookie(
  1150. key="token",
  1151. value=jwt_token,
  1152. httponly=False, # Required for frontend access
  1153. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  1154. secure=WEBUI_AUTH_COOKIE_SECURE,
  1155. )
  1156. # Legacy cookies for compatibility with older frontend versions
  1157. if ENABLE_OAUTH_ID_TOKEN_COOKIE:
  1158. response.set_cookie(
  1159. key="oauth_id_token",
  1160. value=token.get("id_token"),
  1161. httponly=True,
  1162. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  1163. secure=WEBUI_AUTH_COOKIE_SECURE,
  1164. )
  1165. try:
  1166. # Add timestamp for tracking
  1167. token["issued_at"] = datetime.now().timestamp()
  1168. # Calculate expires_at if we have expires_in
  1169. if "expires_in" in token and "expires_at" not in token:
  1170. token["expires_at"] = datetime.now().timestamp() + token["expires_in"]
  1171. # Clean up any existing sessions for this user/provider first
  1172. sessions = OAuthSessions.get_sessions_by_user_id(user.id)
  1173. for session in sessions:
  1174. if session.provider == provider:
  1175. OAuthSessions.delete_session_by_id(session.id)
  1176. session = OAuthSessions.create_session(
  1177. user_id=user.id,
  1178. provider=provider,
  1179. token=token,
  1180. )
  1181. response.set_cookie(
  1182. key="oauth_session_id",
  1183. value=session.id,
  1184. httponly=True,
  1185. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  1186. secure=WEBUI_AUTH_COOKIE_SECURE,
  1187. )
  1188. log.info(
  1189. f"Stored OAuth session server-side for user {user.id}, provider {provider}"
  1190. )
  1191. except Exception as e:
  1192. log.error(f"Failed to store OAuth session server-side: {e}")
  1193. return response