auths.py 29 KB

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