auths.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  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. if (
  221. request.app.state.USER_COUNT
  222. and user_count >= request.app.state.USER_COUNT
  223. ):
  224. raise HTTPException(
  225. status.HTTP_403_FORBIDDEN,
  226. detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
  227. )
  228. role = (
  229. "admin"
  230. if user_count == 0
  231. else request.app.state.config.DEFAULT_USER_ROLE
  232. )
  233. user = Auths.insert_new_auth(
  234. email=mail, password=str(uuid.uuid4()), name=cn, role=role
  235. )
  236. if not user:
  237. raise HTTPException(
  238. 500, detail=ERROR_MESSAGES.CREATE_USER_ERROR
  239. )
  240. except HTTPException:
  241. raise
  242. except Exception as err:
  243. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  244. user = Auths.authenticate_user_by_trusted_header(mail)
  245. if user:
  246. token = create_token(
  247. data={"id": user.id},
  248. expires_delta=parse_duration(
  249. request.app.state.config.JWT_EXPIRES_IN
  250. ),
  251. )
  252. # Set the cookie token
  253. response.set_cookie(
  254. key="token",
  255. value=token,
  256. httponly=True, # Ensures the cookie is not accessible via JavaScript
  257. )
  258. user_permissions = get_permissions(
  259. user.id, request.app.state.config.USER_PERMISSIONS
  260. )
  261. return {
  262. "token": token,
  263. "token_type": "Bearer",
  264. "id": user.id,
  265. "email": user.email,
  266. "name": user.name,
  267. "role": user.role,
  268. "profile_image_url": user.profile_image_url,
  269. "permissions": user_permissions,
  270. }
  271. else:
  272. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  273. else:
  274. raise HTTPException(
  275. 400,
  276. f"User {form_data.user} does not match the record. Search result: {str(entry[f'{LDAP_ATTRIBUTE_FOR_USERNAME}'])}",
  277. )
  278. except Exception as e:
  279. raise HTTPException(400, detail=str(e))
  280. ############################
  281. # SignIn
  282. ############################
  283. @router.post("/signin", response_model=SessionUserResponse)
  284. async def signin(request: Request, response: Response, form_data: SigninForm):
  285. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
  286. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER not in request.headers:
  287. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)
  288. trusted_email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
  289. trusted_name = trusted_email
  290. if WEBUI_AUTH_TRUSTED_NAME_HEADER:
  291. trusted_name = request.headers.get(
  292. WEBUI_AUTH_TRUSTED_NAME_HEADER, trusted_email
  293. )
  294. if not Users.get_user_by_email(trusted_email.lower()):
  295. await signup(
  296. request,
  297. response,
  298. SignupForm(
  299. email=trusted_email, password=str(uuid.uuid4()), name=trusted_name
  300. ),
  301. )
  302. user = Auths.authenticate_user_by_trusted_header(trusted_email)
  303. elif WEBUI_AUTH == False:
  304. admin_email = "admin@localhost"
  305. admin_password = "admin"
  306. if Users.get_user_by_email(admin_email.lower()):
  307. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  308. else:
  309. if Users.get_num_users() != 0:
  310. raise HTTPException(400, detail=ERROR_MESSAGES.EXISTING_USERS)
  311. await signup(
  312. request,
  313. response,
  314. SignupForm(email=admin_email, password=admin_password, name="User"),
  315. )
  316. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  317. else:
  318. user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
  319. if user:
  320. expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
  321. expires_at = None
  322. if expires_delta:
  323. expires_at = int(time.time()) + int(expires_delta.total_seconds())
  324. token = create_token(
  325. data={"id": user.id},
  326. expires_delta=expires_delta,
  327. )
  328. datetime_expires_at = (
  329. datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
  330. if expires_at
  331. else None
  332. )
  333. # Set the cookie token
  334. response.set_cookie(
  335. key="token",
  336. value=token,
  337. expires=datetime_expires_at,
  338. httponly=True, # Ensures the cookie is not accessible via JavaScript
  339. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  340. secure=WEBUI_AUTH_COOKIE_SECURE,
  341. )
  342. user_permissions = get_permissions(
  343. user.id, request.app.state.config.USER_PERMISSIONS
  344. )
  345. return {
  346. "token": token,
  347. "token_type": "Bearer",
  348. "expires_at": expires_at,
  349. "id": user.id,
  350. "email": user.email,
  351. "name": user.name,
  352. "role": user.role,
  353. "profile_image_url": user.profile_image_url,
  354. "permissions": user_permissions,
  355. }
  356. else:
  357. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  358. ############################
  359. # SignUp
  360. ############################
  361. @router.post("/signup", response_model=SessionUserResponse)
  362. async def signup(request: Request, response: Response, form_data: SignupForm):
  363. if WEBUI_AUTH:
  364. if (
  365. not request.app.state.config.ENABLE_SIGNUP
  366. or not request.app.state.config.ENABLE_LOGIN_FORM
  367. ):
  368. raise HTTPException(
  369. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  370. )
  371. else:
  372. if Users.get_num_users() != 0:
  373. raise HTTPException(
  374. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  375. )
  376. user_count = Users.get_num_users()
  377. if request.app.state.USER_COUNT and user_count >= request.app.state.USER_COUNT:
  378. raise HTTPException(
  379. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  380. )
  381. if not validate_email_format(form_data.email.lower()):
  382. raise HTTPException(
  383. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  384. )
  385. if Users.get_user_by_email(form_data.email.lower()):
  386. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  387. try:
  388. role = (
  389. "admin" if user_count == 0 else request.app.state.config.DEFAULT_USER_ROLE
  390. )
  391. if user_count == 0:
  392. # Disable signup after the first user is created
  393. request.app.state.config.ENABLE_SIGNUP = False
  394. hashed = get_password_hash(form_data.password)
  395. user = Auths.insert_new_auth(
  396. form_data.email.lower(),
  397. hashed,
  398. form_data.name,
  399. form_data.profile_image_url,
  400. role,
  401. )
  402. if user:
  403. expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
  404. expires_at = None
  405. if expires_delta:
  406. expires_at = int(time.time()) + int(expires_delta.total_seconds())
  407. token = create_token(
  408. data={"id": user.id},
  409. expires_delta=expires_delta,
  410. )
  411. datetime_expires_at = (
  412. datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
  413. if expires_at
  414. else None
  415. )
  416. # Set the cookie token
  417. response.set_cookie(
  418. key="token",
  419. value=token,
  420. expires=datetime_expires_at,
  421. httponly=True, # Ensures the cookie is not accessible via JavaScript
  422. samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
  423. secure=WEBUI_AUTH_COOKIE_SECURE,
  424. )
  425. if request.app.state.config.WEBHOOK_URL:
  426. post_webhook(
  427. request.app.state.WEBUI_NAME,
  428. request.app.state.config.WEBHOOK_URL,
  429. WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  430. {
  431. "action": "signup",
  432. "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  433. "user": user.model_dump_json(exclude_none=True),
  434. },
  435. )
  436. user_permissions = get_permissions(
  437. user.id, request.app.state.config.USER_PERMISSIONS
  438. )
  439. return {
  440. "token": token,
  441. "token_type": "Bearer",
  442. "expires_at": expires_at,
  443. "id": user.id,
  444. "email": user.email,
  445. "name": user.name,
  446. "role": user.role,
  447. "profile_image_url": user.profile_image_url,
  448. "permissions": user_permissions,
  449. }
  450. else:
  451. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  452. except Exception as err:
  453. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  454. @router.get("/signout")
  455. async def signout(request: Request, response: Response):
  456. response.delete_cookie("token")
  457. if ENABLE_OAUTH_SIGNUP.value:
  458. oauth_id_token = request.cookies.get("oauth_id_token")
  459. if oauth_id_token:
  460. try:
  461. async with ClientSession() as session:
  462. async with session.get(OPENID_PROVIDER_URL.value) as resp:
  463. if resp.status == 200:
  464. openid_data = await resp.json()
  465. logout_url = openid_data.get("end_session_endpoint")
  466. if logout_url:
  467. response.delete_cookie("oauth_id_token")
  468. return RedirectResponse(
  469. headers=response.headers,
  470. url=f"{logout_url}?id_token_hint={oauth_id_token}"
  471. )
  472. else:
  473. raise HTTPException(
  474. status_code=resp.status,
  475. detail="Failed to fetch OpenID configuration",
  476. )
  477. except Exception as e:
  478. raise HTTPException(status_code=500, detail=str(e))
  479. return {"status": True}
  480. ############################
  481. # AddUser
  482. ############################
  483. @router.post("/add", response_model=SigninResponse)
  484. async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
  485. if not validate_email_format(form_data.email.lower()):
  486. raise HTTPException(
  487. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  488. )
  489. if Users.get_user_by_email(form_data.email.lower()):
  490. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  491. try:
  492. hashed = get_password_hash(form_data.password)
  493. user = Auths.insert_new_auth(
  494. form_data.email.lower(),
  495. hashed,
  496. form_data.name,
  497. form_data.profile_image_url,
  498. form_data.role,
  499. )
  500. if user:
  501. token = create_token(data={"id": user.id})
  502. return {
  503. "token": token,
  504. "token_type": "Bearer",
  505. "id": user.id,
  506. "email": user.email,
  507. "name": user.name,
  508. "role": user.role,
  509. "profile_image_url": user.profile_image_url,
  510. }
  511. else:
  512. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  513. except Exception as err:
  514. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  515. ############################
  516. # GetAdminDetails
  517. ############################
  518. @router.get("/admin/details")
  519. async def get_admin_details(request: Request, user=Depends(get_current_user)):
  520. if request.app.state.config.SHOW_ADMIN_DETAILS:
  521. admin_email = request.app.state.config.ADMIN_EMAIL
  522. admin_name = None
  523. print(admin_email, admin_name)
  524. if admin_email:
  525. admin = Users.get_user_by_email(admin_email)
  526. if admin:
  527. admin_name = admin.name
  528. else:
  529. admin = Users.get_first_user()
  530. if admin:
  531. admin_email = admin.email
  532. admin_name = admin.name
  533. return {
  534. "name": admin_name,
  535. "email": admin_email,
  536. }
  537. else:
  538. raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
  539. ############################
  540. # ToggleSignUp
  541. ############################
  542. @router.get("/admin/config")
  543. async def get_admin_config(request: Request, user=Depends(get_admin_user)):
  544. return {
  545. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  546. "WEBUI_URL": request.app.state.config.WEBUI_URL,
  547. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  548. "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
  549. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  550. "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
  551. "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
  552. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  553. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  554. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  555. "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
  556. }
  557. class AdminConfig(BaseModel):
  558. SHOW_ADMIN_DETAILS: bool
  559. WEBUI_URL: str
  560. ENABLE_SIGNUP: bool
  561. ENABLE_API_KEY: bool
  562. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS: bool
  563. API_KEY_ALLOWED_ENDPOINTS: str
  564. ENABLE_CHANNELS: bool
  565. DEFAULT_USER_ROLE: str
  566. JWT_EXPIRES_IN: str
  567. ENABLE_COMMUNITY_SHARING: bool
  568. ENABLE_MESSAGE_RATING: bool
  569. @router.post("/admin/config")
  570. async def update_admin_config(
  571. request: Request, form_data: AdminConfig, user=Depends(get_admin_user)
  572. ):
  573. request.app.state.config.SHOW_ADMIN_DETAILS = form_data.SHOW_ADMIN_DETAILS
  574. request.app.state.config.WEBUI_URL = form_data.WEBUI_URL
  575. request.app.state.config.ENABLE_SIGNUP = form_data.ENABLE_SIGNUP
  576. request.app.state.config.ENABLE_API_KEY = form_data.ENABLE_API_KEY
  577. request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  578. form_data.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  579. )
  580. request.app.state.config.API_KEY_ALLOWED_ENDPOINTS = (
  581. form_data.API_KEY_ALLOWED_ENDPOINTS
  582. )
  583. request.app.state.config.ENABLE_CHANNELS = form_data.ENABLE_CHANNELS
  584. if form_data.DEFAULT_USER_ROLE in ["pending", "user", "admin"]:
  585. request.app.state.config.DEFAULT_USER_ROLE = form_data.DEFAULT_USER_ROLE
  586. pattern = r"^(-1|0|(-?\d+(\.\d+)?)(ms|s|m|h|d|w))$"
  587. # Check if the input string matches the pattern
  588. if re.match(pattern, form_data.JWT_EXPIRES_IN):
  589. request.app.state.config.JWT_EXPIRES_IN = form_data.JWT_EXPIRES_IN
  590. request.app.state.config.ENABLE_COMMUNITY_SHARING = (
  591. form_data.ENABLE_COMMUNITY_SHARING
  592. )
  593. request.app.state.config.ENABLE_MESSAGE_RATING = form_data.ENABLE_MESSAGE_RATING
  594. return {
  595. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  596. "WEBUI_URL": request.app.state.config.WEBUI_URL,
  597. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  598. "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
  599. "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  600. "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
  601. "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
  602. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  603. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  604. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  605. "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
  606. }
  607. class LdapServerConfig(BaseModel):
  608. label: str
  609. host: str
  610. port: Optional[int] = None
  611. attribute_for_mail: str = "mail"
  612. attribute_for_username: str = "uid"
  613. app_dn: str
  614. app_dn_password: str
  615. search_base: str
  616. search_filters: str = ""
  617. use_tls: bool = True
  618. certificate_path: Optional[str] = None
  619. ciphers: Optional[str] = "ALL"
  620. @router.get("/admin/config/ldap/server", response_model=LdapServerConfig)
  621. async def get_ldap_server(request: Request, user=Depends(get_admin_user)):
  622. return {
  623. "label": request.app.state.config.LDAP_SERVER_LABEL,
  624. "host": request.app.state.config.LDAP_SERVER_HOST,
  625. "port": request.app.state.config.LDAP_SERVER_PORT,
  626. "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
  627. "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
  628. "app_dn": request.app.state.config.LDAP_APP_DN,
  629. "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
  630. "search_base": request.app.state.config.LDAP_SEARCH_BASE,
  631. "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
  632. "use_tls": request.app.state.config.LDAP_USE_TLS,
  633. "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
  634. "ciphers": request.app.state.config.LDAP_CIPHERS,
  635. }
  636. @router.post("/admin/config/ldap/server")
  637. async def update_ldap_server(
  638. request: Request, form_data: LdapServerConfig, user=Depends(get_admin_user)
  639. ):
  640. required_fields = [
  641. "label",
  642. "host",
  643. "attribute_for_mail",
  644. "attribute_for_username",
  645. "app_dn",
  646. "app_dn_password",
  647. "search_base",
  648. ]
  649. for key in required_fields:
  650. value = getattr(form_data, key)
  651. if not value:
  652. raise HTTPException(400, detail=f"Required field {key} is empty")
  653. if form_data.use_tls and not form_data.certificate_path:
  654. raise HTTPException(
  655. 400, detail="TLS is enabled but certificate file path is missing"
  656. )
  657. request.app.state.config.LDAP_SERVER_LABEL = form_data.label
  658. request.app.state.config.LDAP_SERVER_HOST = form_data.host
  659. request.app.state.config.LDAP_SERVER_PORT = form_data.port
  660. request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = form_data.attribute_for_mail
  661. request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = (
  662. form_data.attribute_for_username
  663. )
  664. request.app.state.config.LDAP_APP_DN = form_data.app_dn
  665. request.app.state.config.LDAP_APP_PASSWORD = form_data.app_dn_password
  666. request.app.state.config.LDAP_SEARCH_BASE = form_data.search_base
  667. request.app.state.config.LDAP_SEARCH_FILTERS = form_data.search_filters
  668. request.app.state.config.LDAP_USE_TLS = form_data.use_tls
  669. request.app.state.config.LDAP_CA_CERT_FILE = form_data.certificate_path
  670. request.app.state.config.LDAP_CIPHERS = form_data.ciphers
  671. return {
  672. "label": request.app.state.config.LDAP_SERVER_LABEL,
  673. "host": request.app.state.config.LDAP_SERVER_HOST,
  674. "port": request.app.state.config.LDAP_SERVER_PORT,
  675. "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
  676. "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
  677. "app_dn": request.app.state.config.LDAP_APP_DN,
  678. "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
  679. "search_base": request.app.state.config.LDAP_SEARCH_BASE,
  680. "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
  681. "use_tls": request.app.state.config.LDAP_USE_TLS,
  682. "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
  683. "ciphers": request.app.state.config.LDAP_CIPHERS,
  684. }
  685. @router.get("/admin/config/ldap")
  686. async def get_ldap_config(request: Request, user=Depends(get_admin_user)):
  687. return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
  688. class LdapConfigForm(BaseModel):
  689. enable_ldap: Optional[bool] = None
  690. @router.post("/admin/config/ldap")
  691. async def update_ldap_config(
  692. request: Request, form_data: LdapConfigForm, user=Depends(get_admin_user)
  693. ):
  694. request.app.state.config.ENABLE_LDAP = form_data.enable_ldap
  695. return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
  696. ############################
  697. # API Key
  698. ############################
  699. # create api key
  700. @router.post("/api_key", response_model=ApiKey)
  701. async def generate_api_key(request: Request, user=Depends(get_current_user)):
  702. if not request.app.state.config.ENABLE_API_KEY:
  703. raise HTTPException(
  704. status.HTTP_403_FORBIDDEN,
  705. detail=ERROR_MESSAGES.API_KEY_CREATION_NOT_ALLOWED,
  706. )
  707. api_key = create_api_key()
  708. success = Users.update_user_api_key_by_id(user.id, api_key)
  709. if success:
  710. return {
  711. "api_key": api_key,
  712. }
  713. else:
  714. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_API_KEY_ERROR)
  715. # delete api key
  716. @router.delete("/api_key", response_model=bool)
  717. async def delete_api_key(user=Depends(get_current_user)):
  718. success = Users.update_user_api_key_by_id(user.id, None)
  719. return success
  720. # get api key
  721. @router.get("/api_key", response_model=ApiKey)
  722. async def get_api_key(user=Depends(get_current_user)):
  723. api_key = Users.get_user_api_key_by_id(user.id)
  724. if api_key:
  725. return {
  726. "api_key": api_key,
  727. }
  728. else:
  729. raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)