auths.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  1. import re
  2. import uuid
  3. import time
  4. import datetime
  5. import logging
  6. from aiohttp import ClientSession
  7. from open_webui.models.auths import (
  8. AddUserForm,
  9. ApiKey,
  10. Auths,
  11. Token,
  12. LdapForm,
  13. SigninForm,
  14. SigninResponse,
  15. SignupForm,
  16. UpdatePasswordForm,
  17. UpdateProfileForm,
  18. UserResponse,
  19. )
  20. from open_webui.models.users import Users
  21. from open_webui.constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
  22. from open_webui.env import (
  23. WEBUI_AUTH,
  24. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  25. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  26. WEBUI_AUTH_COOKIE_SAME_SITE,
  27. WEBUI_AUTH_COOKIE_SECURE,
  28. SRC_LOG_LEVELS,
  29. )
  30. from fastapi import APIRouter, Depends, HTTPException, Request, status
  31. from fastapi.responses import RedirectResponse, Response
  32. from open_webui.config import (
  33. OPENID_PROVIDER_URL,
  34. ENABLE_OAUTH_SIGNUP,
  35. )
  36. from pydantic import BaseModel
  37. from open_webui.utils.misc import parse_duration, validate_email_format
  38. from open_webui.utils.auth import (
  39. create_api_key,
  40. create_token,
  41. get_admin_user,
  42. get_verified_user,
  43. get_current_user,
  44. get_password_hash,
  45. )
  46. from open_webui.utils.webhook import post_webhook
  47. from open_webui.utils.access_control import get_permissions
  48. from typing import Optional, List
  49. from ssl import CERT_REQUIRED, PROTOCOL_TLS
  50. from ldap3 import Server, Connection, NONE, Tls
  51. from ldap3.utils.conv import escape_filter_chars
  52. router = APIRouter()
  53. log = logging.getLogger(__name__)
  54. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  55. ############################
  56. # GetSessionUser
  57. ############################
  58. class SessionUserResponse(Token, UserResponse):
  59. expires_at: Optional[int] = None
  60. permissions: Optional[dict] = None
  61. @router.get("/", response_model=SessionUserResponse)
  62. async def get_session_user(
  63. request: Request, response: Response, user=Depends(get_current_user)
  64. ):
  65. expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
  66. expires_at = None
  67. if expires_delta:
  68. expires_at = int(time.time()) + int(expires_delta.total_seconds())
  69. token = create_token(
  70. data={"id": user.id},
  71. expires_delta=expires_delta,
  72. )
  73. datetime_expires_at = (
  74. datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
  75. if expires_at
  76. else None
  77. )
  78. # Set the cookie token
  79. response.set_cookie(
  80. key="token",
  81. value=token,
  82. expires=datetime_expires_at,
  83. httponly=True, # Ensures the cookie is not accessible via JavaScript
  84. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  85. secure=WEBUI_AUTH_COOKIE_SECURE,
  86. )
  87. user_permissions = get_permissions(
  88. user.id, request.app.state.config.USER_PERMISSIONS
  89. )
  90. return {
  91. "token": token,
  92. "token_type": "Bearer",
  93. "expires_at": expires_at,
  94. "id": user.id,
  95. "email": user.email,
  96. "name": user.name,
  97. "role": user.role,
  98. "profile_image_url": user.profile_image_url,
  99. "permissions": user_permissions,
  100. }
  101. ############################
  102. # Update Profile
  103. ############################
  104. @router.post("/update/profile", response_model=UserResponse)
  105. async def update_profile(
  106. form_data: UpdateProfileForm, session_user=Depends(get_verified_user)
  107. ):
  108. if session_user:
  109. user = Users.update_user_by_id(
  110. session_user.id,
  111. {"profile_image_url": form_data.profile_image_url, "name": form_data.name},
  112. )
  113. if user:
  114. return user
  115. else:
  116. raise HTTPException(400, detail=ERROR_MESSAGES.DEFAULT())
  117. else:
  118. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  119. ############################
  120. # Update Password
  121. ############################
  122. @router.post("/update/password", response_model=bool)
  123. async def update_password(
  124. form_data: UpdatePasswordForm, session_user=Depends(get_current_user)
  125. ):
  126. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
  127. raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
  128. if session_user:
  129. user = Auths.authenticate_user(session_user.email, form_data.password)
  130. if user:
  131. hashed = get_password_hash(form_data.new_password)
  132. return Auths.update_user_password_by_id(user.id, hashed)
  133. else:
  134. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_PASSWORD)
  135. else:
  136. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  137. ############################
  138. # LDAP Authentication
  139. ############################
  140. @router.post("/ldap", response_model=SessionUserResponse)
  141. async def ldap_auth(request: Request, response: Response, form_data: LdapForm):
  142. ENABLE_LDAP = request.app.state.config.ENABLE_LDAP
  143. LDAP_SERVER_LABEL = request.app.state.config.LDAP_SERVER_LABEL
  144. LDAP_SERVER_HOST = request.app.state.config.LDAP_SERVER_HOST
  145. LDAP_SERVER_PORT = request.app.state.config.LDAP_SERVER_PORT
  146. LDAP_ATTRIBUTE_FOR_MAIL = request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL
  147. LDAP_ATTRIBUTE_FOR_USERNAME = request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME
  148. LDAP_SEARCH_BASE = request.app.state.config.LDAP_SEARCH_BASE
  149. LDAP_SEARCH_FILTERS = request.app.state.config.LDAP_SEARCH_FILTERS
  150. LDAP_APP_DN = request.app.state.config.LDAP_APP_DN
  151. LDAP_APP_PASSWORD = request.app.state.config.LDAP_APP_PASSWORD
  152. LDAP_USE_TLS = request.app.state.config.LDAP_USE_TLS
  153. LDAP_CA_CERT_FILE = request.app.state.config.LDAP_CA_CERT_FILE
  154. LDAP_CIPHERS = (
  155. request.app.state.config.LDAP_CIPHERS
  156. if request.app.state.config.LDAP_CIPHERS
  157. else "ALL"
  158. )
  159. if not ENABLE_LDAP:
  160. raise HTTPException(400, detail="LDAP authentication is not enabled")
  161. try:
  162. tls = Tls(
  163. validate=CERT_REQUIRED,
  164. version=PROTOCOL_TLS,
  165. ca_certs_file=LDAP_CA_CERT_FILE,
  166. ciphers=LDAP_CIPHERS,
  167. )
  168. except Exception as e:
  169. log.error(f"An error occurred on TLS: {str(e)}")
  170. raise HTTPException(400, detail=str(e))
  171. try:
  172. server = Server(
  173. host=LDAP_SERVER_HOST,
  174. port=LDAP_SERVER_PORT,
  175. get_info=NONE,
  176. use_ssl=LDAP_USE_TLS,
  177. tls=tls,
  178. )
  179. connection_app = Connection(
  180. server,
  181. LDAP_APP_DN,
  182. LDAP_APP_PASSWORD,
  183. auto_bind="NONE",
  184. authentication="SIMPLE",
  185. )
  186. if not connection_app.bind():
  187. raise HTTPException(400, detail="Application account bind failed")
  188. search_success = connection_app.search(
  189. search_base=LDAP_SEARCH_BASE,
  190. search_filter=f"(&({LDAP_ATTRIBUTE_FOR_USERNAME}={escape_filter_chars(form_data.user.lower())}){LDAP_SEARCH_FILTERS})",
  191. attributes=[
  192. f"{LDAP_ATTRIBUTE_FOR_USERNAME}",
  193. f"{LDAP_ATTRIBUTE_FOR_MAIL}",
  194. "cn",
  195. ],
  196. )
  197. if not search_success:
  198. raise HTTPException(400, detail="User not found in the LDAP server")
  199. entry = connection_app.entries[0]
  200. username = str(entry[f"{LDAP_ATTRIBUTE_FOR_USERNAME}"]).lower()
  201. mail = str(entry[f"{LDAP_ATTRIBUTE_FOR_MAIL}"])
  202. if not mail or mail == "" or mail == "[]":
  203. raise HTTPException(400, f"User {form_data.user} does not have mail.")
  204. cn = str(entry["cn"])
  205. user_dn = entry.entry_dn
  206. if username == form_data.user.lower():
  207. connection_user = Connection(
  208. server,
  209. user_dn,
  210. form_data.password,
  211. auto_bind="NONE",
  212. authentication="SIMPLE",
  213. )
  214. if not connection_user.bind():
  215. raise HTTPException(400, f"Authentication failed for {form_data.user}")
  216. user = Users.get_user_by_email(mail)
  217. if not user:
  218. try:
  219. user_count = Users.get_num_users()
  220. role = (
  221. "admin"
  222. if user_count == 0
  223. else request.app.state.config.DEFAULT_USER_ROLE
  224. )
  225. user = Auths.insert_new_auth(
  226. email=mail, password=str(uuid.uuid4()), name=cn, role=role
  227. )
  228. if not user:
  229. raise HTTPException(
  230. 500, detail=ERROR_MESSAGES.CREATE_USER_ERROR
  231. )
  232. except HTTPException:
  233. raise
  234. except Exception as err:
  235. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  236. user = Auths.authenticate_user_by_trusted_header(mail)
  237. if user:
  238. token = create_token(
  239. data={"id": user.id},
  240. expires_delta=parse_duration(
  241. request.app.state.config.JWT_EXPIRES_IN
  242. ),
  243. )
  244. # Set the cookie token
  245. response.set_cookie(
  246. key="token",
  247. value=token,
  248. httponly=True, # Ensures the cookie is not accessible via JavaScript
  249. )
  250. user_permissions = get_permissions(
  251. user.id, request.app.state.config.USER_PERMISSIONS
  252. )
  253. return {
  254. "token": token,
  255. "token_type": "Bearer",
  256. "id": user.id,
  257. "email": user.email,
  258. "name": user.name,
  259. "role": user.role,
  260. "profile_image_url": user.profile_image_url,
  261. "permissions": user_permissions,
  262. }
  263. else:
  264. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  265. else:
  266. raise HTTPException(
  267. 400,
  268. f"User {form_data.user} does not match the record. Search result: {str(entry[f'{LDAP_ATTRIBUTE_FOR_USERNAME}'])}",
  269. )
  270. except Exception as e:
  271. raise HTTPException(400, detail=str(e))
  272. ############################
  273. # SignIn
  274. ############################
  275. @router.post("/signin", response_model=SessionUserResponse)
  276. async def signin(request: Request, response: Response, form_data: SigninForm):
  277. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
  278. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER not in request.headers:
  279. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)
  280. trusted_email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
  281. trusted_name = trusted_email
  282. if WEBUI_AUTH_TRUSTED_NAME_HEADER:
  283. trusted_name = request.headers.get(
  284. WEBUI_AUTH_TRUSTED_NAME_HEADER, trusted_email
  285. )
  286. if not Users.get_user_by_email(trusted_email.lower()):
  287. await signup(
  288. request,
  289. response,
  290. SignupForm(
  291. email=trusted_email, password=str(uuid.uuid4()), name=trusted_name
  292. ),
  293. )
  294. user = Auths.authenticate_user_by_trusted_header(trusted_email)
  295. elif WEBUI_AUTH == False:
  296. admin_email = "admin@localhost"
  297. admin_password = "admin"
  298. if Users.get_user_by_email(admin_email.lower()):
  299. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  300. else:
  301. if Users.get_num_users() != 0:
  302. raise HTTPException(400, detail=ERROR_MESSAGES.EXISTING_USERS)
  303. await signup(
  304. request,
  305. response,
  306. SignupForm(email=admin_email, password=admin_password, name="User"),
  307. )
  308. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  309. else:
  310. user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
  311. if user:
  312. expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
  313. expires_at = None
  314. if expires_delta:
  315. expires_at = int(time.time()) + int(expires_delta.total_seconds())
  316. token = create_token(
  317. data={"id": user.id},
  318. expires_delta=expires_delta,
  319. )
  320. datetime_expires_at = (
  321. datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
  322. if expires_at
  323. else None
  324. )
  325. # Set the cookie token
  326. response.set_cookie(
  327. key="token",
  328. value=token,
  329. expires=datetime_expires_at,
  330. httponly=True, # Ensures the cookie is not accessible via JavaScript
  331. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  332. secure=WEBUI_AUTH_COOKIE_SECURE,
  333. )
  334. user_permissions = get_permissions(
  335. user.id, request.app.state.config.USER_PERMISSIONS
  336. )
  337. return {
  338. "token": token,
  339. "token_type": "Bearer",
  340. "expires_at": expires_at,
  341. "id": user.id,
  342. "email": user.email,
  343. "name": user.name,
  344. "role": user.role,
  345. "profile_image_url": user.profile_image_url,
  346. "permissions": user_permissions,
  347. }
  348. else:
  349. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  350. ############################
  351. # SignUp
  352. ############################
  353. @router.post("/signup", response_model=SessionUserResponse)
  354. async def signup(request: Request, response: Response, form_data: SignupForm):
  355. if WEBUI_AUTH:
  356. if (
  357. not request.app.state.config.ENABLE_SIGNUP
  358. or not request.app.state.config.ENABLE_LOGIN_FORM
  359. ):
  360. raise HTTPException(
  361. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  362. )
  363. else:
  364. if Users.get_num_users() != 0:
  365. raise HTTPException(
  366. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  367. )
  368. user_count = Users.get_num_users()
  369. if not validate_email_format(form_data.email.lower()):
  370. raise HTTPException(
  371. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  372. )
  373. if Users.get_user_by_email(form_data.email.lower()):
  374. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  375. try:
  376. role = (
  377. "admin" if user_count == 0 else request.app.state.config.DEFAULT_USER_ROLE
  378. )
  379. if user_count == 0:
  380. # Disable signup after the first user is created
  381. request.app.state.config.ENABLE_SIGNUP = False
  382. hashed = get_password_hash(form_data.password)
  383. user = Auths.insert_new_auth(
  384. form_data.email.lower(),
  385. hashed,
  386. form_data.name,
  387. form_data.profile_image_url,
  388. role,
  389. )
  390. if user:
  391. expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
  392. expires_at = None
  393. if expires_delta:
  394. expires_at = int(time.time()) + int(expires_delta.total_seconds())
  395. token = create_token(
  396. data={"id": user.id},
  397. expires_delta=expires_delta,
  398. )
  399. datetime_expires_at = (
  400. datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
  401. if expires_at
  402. else None
  403. )
  404. # Set the cookie token
  405. response.set_cookie(
  406. key="token",
  407. value=token,
  408. expires=datetime_expires_at,
  409. httponly=True, # Ensures the cookie is not accessible via JavaScript
  410. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  411. secure=WEBUI_AUTH_COOKIE_SECURE,
  412. )
  413. if request.app.state.config.WEBHOOK_URL:
  414. post_webhook(
  415. request.app.state.WEBUI_NAME,
  416. request.app.state.config.WEBHOOK_URL,
  417. WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  418. {
  419. "action": "signup",
  420. "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  421. "user": user.model_dump_json(exclude_none=True),
  422. },
  423. )
  424. user_permissions = get_permissions(
  425. user.id, request.app.state.config.USER_PERMISSIONS
  426. )
  427. return {
  428. "token": token,
  429. "token_type": "Bearer",
  430. "expires_at": expires_at,
  431. "id": user.id,
  432. "email": user.email,
  433. "name": user.name,
  434. "role": user.role,
  435. "profile_image_url": user.profile_image_url,
  436. "permissions": user_permissions,
  437. }
  438. else:
  439. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  440. except Exception as err:
  441. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  442. @router.get("/signout")
  443. async def signout(request: Request, response: Response):
  444. response.delete_cookie("token")
  445. if ENABLE_OAUTH_SIGNUP.value:
  446. oauth_id_token = request.cookies.get("oauth_id_token")
  447. if oauth_id_token:
  448. try:
  449. async with ClientSession() as session:
  450. async with session.get(OPENID_PROVIDER_URL.value) as resp:
  451. if resp.status == 200:
  452. openid_data = await resp.json()
  453. logout_url = openid_data.get("end_session_endpoint")
  454. if logout_url:
  455. response.delete_cookie("oauth_id_token")
  456. return RedirectResponse(
  457. headers=response.headers,
  458. url=f"{logout_url}?id_token_hint={oauth_id_token}",
  459. )
  460. else:
  461. raise HTTPException(
  462. status_code=resp.status,
  463. detail="Failed to fetch OpenID configuration",
  464. )
  465. except Exception as e:
  466. raise HTTPException(status_code=500, detail=str(e))
  467. return {"status": True}
  468. ############################
  469. # AddUser
  470. ############################
  471. @router.post("/add", response_model=SigninResponse)
  472. async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
  473. if not validate_email_format(form_data.email.lower()):
  474. raise HTTPException(
  475. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  476. )
  477. if Users.get_user_by_email(form_data.email.lower()):
  478. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  479. try:
  480. hashed = get_password_hash(form_data.password)
  481. user = Auths.insert_new_auth(
  482. form_data.email.lower(),
  483. hashed,
  484. form_data.name,
  485. form_data.profile_image_url,
  486. form_data.role,
  487. )
  488. if user:
  489. token = create_token(data={"id": user.id})
  490. return {
  491. "token": token,
  492. "token_type": "Bearer",
  493. "id": user.id,
  494. "email": user.email,
  495. "name": user.name,
  496. "role": user.role,
  497. "profile_image_url": user.profile_image_url,
  498. }
  499. else:
  500. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  501. except Exception as err:
  502. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  503. ############################
  504. # GetAdminDetails
  505. ############################
  506. @router.get("/admin/details")
  507. async def get_admin_details(request: Request, user=Depends(get_current_user)):
  508. if request.app.state.config.SHOW_ADMIN_DETAILS:
  509. admin_email = request.app.state.config.ADMIN_EMAIL
  510. admin_name = None
  511. log.info(f"Admin details - Email: {admin_email}, Name: {admin_name}")
  512. if admin_email:
  513. admin = Users.get_user_by_email(admin_email)
  514. if admin:
  515. admin_name = admin.name
  516. else:
  517. admin = Users.get_first_user()
  518. if admin:
  519. admin_email = admin.email
  520. admin_name = admin.name
  521. return {
  522. "name": admin_name,
  523. "email": admin_email,
  524. }
  525. else:
  526. raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
  527. ############################
  528. # ToggleSignUp
  529. ############################
  530. @router.get("/admin/config")
  531. async def get_admin_config(request: Request, user=Depends(get_admin_user)):
  532. return {
  533. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  534. "WEBUI_URL": request.app.state.config.WEBUI_URL,
  535. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  536. "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
  537. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  538. "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
  539. "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
  540. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  541. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  542. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  543. "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
  544. }
  545. class AdminConfig(BaseModel):
  546. SHOW_ADMIN_DETAILS: bool
  547. WEBUI_URL: str
  548. ENABLE_SIGNUP: bool
  549. ENABLE_API_KEY: bool
  550. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS: bool
  551. API_KEY_ALLOWED_ENDPOINTS: str
  552. ENABLE_CHANNELS: bool
  553. DEFAULT_USER_ROLE: str
  554. JWT_EXPIRES_IN: str
  555. ENABLE_COMMUNITY_SHARING: bool
  556. ENABLE_MESSAGE_RATING: bool
  557. @router.post("/admin/config")
  558. async def update_admin_config(
  559. request: Request, form_data: AdminConfig, user=Depends(get_admin_user)
  560. ):
  561. request.app.state.config.SHOW_ADMIN_DETAILS = form_data.SHOW_ADMIN_DETAILS
  562. request.app.state.config.WEBUI_URL = form_data.WEBUI_URL
  563. request.app.state.config.ENABLE_SIGNUP = form_data.ENABLE_SIGNUP
  564. request.app.state.config.ENABLE_API_KEY = form_data.ENABLE_API_KEY
  565. request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  566. form_data.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  567. )
  568. request.app.state.config.API_KEY_ALLOWED_ENDPOINTS = (
  569. form_data.API_KEY_ALLOWED_ENDPOINTS
  570. )
  571. request.app.state.config.ENABLE_CHANNELS = form_data.ENABLE_CHANNELS
  572. if form_data.DEFAULT_USER_ROLE in ["pending", "user", "admin"]:
  573. request.app.state.config.DEFAULT_USER_ROLE = form_data.DEFAULT_USER_ROLE
  574. pattern = r"^(-1|0|(-?\d+(\.\d+)?)(ms|s|m|h|d|w))$"
  575. # Check if the input string matches the pattern
  576. if re.match(pattern, form_data.JWT_EXPIRES_IN):
  577. request.app.state.config.JWT_EXPIRES_IN = form_data.JWT_EXPIRES_IN
  578. request.app.state.config.ENABLE_COMMUNITY_SHARING = (
  579. form_data.ENABLE_COMMUNITY_SHARING
  580. )
  581. request.app.state.config.ENABLE_MESSAGE_RATING = form_data.ENABLE_MESSAGE_RATING
  582. return {
  583. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  584. "WEBUI_URL": request.app.state.config.WEBUI_URL,
  585. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  586. "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
  587. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  588. "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
  589. "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
  590. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  591. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  592. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  593. "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
  594. }
  595. class LdapServerConfig(BaseModel):
  596. label: str
  597. host: str
  598. port: Optional[int] = None
  599. attribute_for_mail: str = "mail"
  600. attribute_for_username: str = "uid"
  601. app_dn: str
  602. app_dn_password: str
  603. search_base: str
  604. search_filters: str = ""
  605. use_tls: bool = True
  606. certificate_path: Optional[str] = None
  607. ciphers: Optional[str] = "ALL"
  608. @router.get("/admin/config/ldap/server", response_model=LdapServerConfig)
  609. async def get_ldap_server(request: Request, user=Depends(get_admin_user)):
  610. return {
  611. "label": request.app.state.config.LDAP_SERVER_LABEL,
  612. "host": request.app.state.config.LDAP_SERVER_HOST,
  613. "port": request.app.state.config.LDAP_SERVER_PORT,
  614. "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
  615. "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
  616. "app_dn": request.app.state.config.LDAP_APP_DN,
  617. "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
  618. "search_base": request.app.state.config.LDAP_SEARCH_BASE,
  619. "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
  620. "use_tls": request.app.state.config.LDAP_USE_TLS,
  621. "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
  622. "ciphers": request.app.state.config.LDAP_CIPHERS,
  623. }
  624. @router.post("/admin/config/ldap/server")
  625. async def update_ldap_server(
  626. request: Request, form_data: LdapServerConfig, user=Depends(get_admin_user)
  627. ):
  628. required_fields = [
  629. "label",
  630. "host",
  631. "attribute_for_mail",
  632. "attribute_for_username",
  633. "app_dn",
  634. "app_dn_password",
  635. "search_base",
  636. ]
  637. for key in required_fields:
  638. value = getattr(form_data, key)
  639. if not value:
  640. raise HTTPException(400, detail=f"Required field {key} is empty")
  641. if form_data.use_tls and not form_data.certificate_path:
  642. raise HTTPException(
  643. 400, detail="TLS is enabled but certificate file path is missing"
  644. )
  645. request.app.state.config.LDAP_SERVER_LABEL = form_data.label
  646. request.app.state.config.LDAP_SERVER_HOST = form_data.host
  647. request.app.state.config.LDAP_SERVER_PORT = form_data.port
  648. request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = form_data.attribute_for_mail
  649. request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = (
  650. form_data.attribute_for_username
  651. )
  652. request.app.state.config.LDAP_APP_DN = form_data.app_dn
  653. request.app.state.config.LDAP_APP_PASSWORD = form_data.app_dn_password
  654. request.app.state.config.LDAP_SEARCH_BASE = form_data.search_base
  655. request.app.state.config.LDAP_SEARCH_FILTERS = form_data.search_filters
  656. request.app.state.config.LDAP_USE_TLS = form_data.use_tls
  657. request.app.state.config.LDAP_CA_CERT_FILE = form_data.certificate_path
  658. request.app.state.config.LDAP_CIPHERS = form_data.ciphers
  659. return {
  660. "label": request.app.state.config.LDAP_SERVER_LABEL,
  661. "host": request.app.state.config.LDAP_SERVER_HOST,
  662. "port": request.app.state.config.LDAP_SERVER_PORT,
  663. "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
  664. "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
  665. "app_dn": request.app.state.config.LDAP_APP_DN,
  666. "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
  667. "search_base": request.app.state.config.LDAP_SEARCH_BASE,
  668. "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
  669. "use_tls": request.app.state.config.LDAP_USE_TLS,
  670. "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
  671. "ciphers": request.app.state.config.LDAP_CIPHERS,
  672. }
  673. @router.get("/admin/config/ldap")
  674. async def get_ldap_config(request: Request, user=Depends(get_admin_user)):
  675. return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
  676. class LdapConfigForm(BaseModel):
  677. enable_ldap: Optional[bool] = None
  678. @router.post("/admin/config/ldap")
  679. async def update_ldap_config(
  680. request: Request, form_data: LdapConfigForm, user=Depends(get_admin_user)
  681. ):
  682. request.app.state.config.ENABLE_LDAP = form_data.enable_ldap
  683. return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
  684. ############################
  685. # API Key
  686. ############################
  687. # create api key
  688. @router.post("/api_key", response_model=ApiKey)
  689. async def generate_api_key(request: Request, user=Depends(get_current_user)):
  690. if not request.app.state.config.ENABLE_API_KEY:
  691. raise HTTPException(
  692. status.HTTP_403_FORBIDDEN,
  693. detail=ERROR_MESSAGES.API_KEY_CREATION_NOT_ALLOWED,
  694. )
  695. api_key = create_api_key()
  696. success = Users.update_user_api_key_by_id(user.id, api_key)
  697. if success:
  698. return {
  699. "api_key": api_key,
  700. }
  701. else:
  702. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_API_KEY_ERROR)
  703. # delete api key
  704. @router.delete("/api_key", response_model=bool)
  705. async def delete_api_key(user=Depends(get_current_user)):
  706. success = Users.update_user_api_key_by_id(user.id, None)
  707. return success
  708. # get api key
  709. @router.get("/api_key", response_model=ApiKey)
  710. async def get_api_key(user=Depends(get_current_user)):
  711. api_key = Users.get_user_api_key_by_id(user.id)
  712. if api_key:
  713. return {
  714. "api_key": api_key,
  715. }
  716. else:
  717. raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)