auths.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. import logging
  2. from fastapi import Request, UploadFile, File
  3. from fastapi import Depends, HTTPException, status
  4. from fastapi.responses import Response
  5. from fastapi import APIRouter
  6. from pydantic import BaseModel
  7. import re
  8. import uuid
  9. import csv
  10. from apps.webui.models.auths import (
  11. SigninForm,
  12. SignupForm,
  13. AddUserForm,
  14. UpdateProfileForm,
  15. UpdatePasswordForm,
  16. UserResponse,
  17. SigninResponse,
  18. Auths,
  19. ApiKey,
  20. )
  21. from apps.webui.models.users import Users
  22. from utils.utils import (
  23. get_password_hash,
  24. get_current_user,
  25. get_admin_user,
  26. create_token,
  27. create_api_key,
  28. )
  29. from utils.misc import parse_duration, validate_email_format
  30. from utils.webhook import post_webhook
  31. from constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
  32. from config import (
  33. WEBUI_AUTH,
  34. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  35. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  36. )
  37. router = APIRouter()
  38. ############################
  39. # GetSessionUser
  40. ############################
  41. @router.get("/", response_model=UserResponse)
  42. async def get_session_user(
  43. request: Request, response: Response, user=Depends(get_current_user)
  44. ):
  45. token = create_token(
  46. data={"id": user.id},
  47. expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
  48. )
  49. # Set the cookie token
  50. response.set_cookie(
  51. key="token",
  52. value=token,
  53. httponly=True, # Ensures the cookie is not accessible via JavaScript
  54. )
  55. return {
  56. "id": user.id,
  57. "email": user.email,
  58. "name": user.name,
  59. "role": user.role,
  60. "profile_image_url": user.profile_image_url,
  61. }
  62. ############################
  63. # Update Profile
  64. ############################
  65. @router.post("/update/profile", response_model=UserResponse)
  66. async def update_profile(
  67. form_data: UpdateProfileForm, session_user=Depends(get_current_user)
  68. ):
  69. if session_user:
  70. user = Users.update_user_by_id(
  71. session_user.id,
  72. {"profile_image_url": form_data.profile_image_url, "name": form_data.name},
  73. )
  74. if user:
  75. return user
  76. else:
  77. raise HTTPException(400, detail=ERROR_MESSAGES.DEFAULT())
  78. else:
  79. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  80. ############################
  81. # Update Password
  82. ############################
  83. @router.post("/update/password", response_model=bool)
  84. async def update_password(
  85. form_data: UpdatePasswordForm, session_user=Depends(get_current_user)
  86. ):
  87. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
  88. raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
  89. if session_user:
  90. user = Auths.authenticate_user(session_user.email, form_data.password)
  91. if user:
  92. hashed = get_password_hash(form_data.new_password)
  93. return Auths.update_user_password_by_id(user.id, hashed)
  94. else:
  95. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_PASSWORD)
  96. else:
  97. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  98. ############################
  99. # SignIn
  100. ############################
  101. @router.post("/signin", response_model=SigninResponse)
  102. async def signin(request: Request, response: Response, form_data: SigninForm):
  103. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
  104. if WEBUI_AUTH_TRUSTED_EMAIL_HEADER not in request.headers:
  105. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)
  106. trusted_email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
  107. trusted_name = trusted_email
  108. if WEBUI_AUTH_TRUSTED_NAME_HEADER:
  109. trusted_name = request.headers.get(
  110. WEBUI_AUTH_TRUSTED_NAME_HEADER, trusted_email
  111. )
  112. if not Users.get_user_by_email(trusted_email.lower()):
  113. await signup(
  114. request,
  115. SignupForm(
  116. email=trusted_email, password=str(uuid.uuid4()), name=trusted_name
  117. ),
  118. )
  119. user = Auths.authenticate_user_by_trusted_header(trusted_email)
  120. elif WEBUI_AUTH == False:
  121. admin_email = "admin@localhost"
  122. admin_password = "admin"
  123. if Users.get_user_by_email(admin_email.lower()):
  124. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  125. else:
  126. if Users.get_num_users() != 0:
  127. raise HTTPException(400, detail=ERROR_MESSAGES.EXISTING_USERS)
  128. await signup(
  129. request,
  130. SignupForm(email=admin_email, password=admin_password, name="User"),
  131. )
  132. user = Auths.authenticate_user(admin_email.lower(), admin_password)
  133. else:
  134. user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
  135. if user:
  136. token = create_token(
  137. data={"id": user.id},
  138. expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
  139. )
  140. # Set the cookie token
  141. response.set_cookie(
  142. key="token",
  143. value=token,
  144. httponly=True, # Ensures the cookie is not accessible via JavaScript
  145. )
  146. return {
  147. "token": token,
  148. "token_type": "Bearer",
  149. "id": user.id,
  150. "email": user.email,
  151. "name": user.name,
  152. "role": user.role,
  153. "profile_image_url": user.profile_image_url,
  154. }
  155. else:
  156. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  157. ############################
  158. # SignUp
  159. ############################
  160. @router.post("/signup", response_model=SigninResponse)
  161. async def signup(request: Request, response: Response, form_data: SignupForm):
  162. if not request.app.state.config.ENABLE_SIGNUP and WEBUI_AUTH:
  163. raise HTTPException(
  164. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  165. )
  166. if not validate_email_format(form_data.email.lower()):
  167. raise HTTPException(
  168. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  169. )
  170. if Users.get_user_by_email(form_data.email.lower()):
  171. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  172. try:
  173. role = (
  174. "admin"
  175. if Users.get_num_users() == 0
  176. else request.app.state.config.DEFAULT_USER_ROLE
  177. )
  178. hashed = get_password_hash(form_data.password)
  179. user = Auths.insert_new_auth(
  180. form_data.email.lower(),
  181. hashed,
  182. form_data.name,
  183. form_data.profile_image_url,
  184. role,
  185. )
  186. if user:
  187. token = create_token(
  188. data={"id": user.id},
  189. expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
  190. )
  191. # response.set_cookie(key='token', value=token, httponly=True)
  192. # Set the cookie token
  193. response.set_cookie(
  194. key="token",
  195. value=token,
  196. httponly=True, # Ensures the cookie is not accessible via JavaScript
  197. )
  198. if request.app.state.config.WEBHOOK_URL:
  199. post_webhook(
  200. request.app.state.config.WEBHOOK_URL,
  201. WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  202. {
  203. "action": "signup",
  204. "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  205. "user": user.model_dump_json(exclude_none=True),
  206. },
  207. )
  208. return {
  209. "token": token,
  210. "token_type": "Bearer",
  211. "id": user.id,
  212. "email": user.email,
  213. "name": user.name,
  214. "role": user.role,
  215. "profile_image_url": user.profile_image_url,
  216. }
  217. else:
  218. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  219. except Exception as err:
  220. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  221. ############################
  222. # AddUser
  223. ############################
  224. @router.post("/add", response_model=SigninResponse)
  225. async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
  226. if not validate_email_format(form_data.email.lower()):
  227. raise HTTPException(
  228. status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
  229. )
  230. if Users.get_user_by_email(form_data.email.lower()):
  231. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  232. try:
  233. print(form_data)
  234. hashed = get_password_hash(form_data.password)
  235. user = Auths.insert_new_auth(
  236. form_data.email.lower(),
  237. hashed,
  238. form_data.name,
  239. form_data.profile_image_url,
  240. form_data.role,
  241. )
  242. if user:
  243. token = create_token(data={"id": user.id})
  244. return {
  245. "token": token,
  246. "token_type": "Bearer",
  247. "id": user.id,
  248. "email": user.email,
  249. "name": user.name,
  250. "role": user.role,
  251. "profile_image_url": user.profile_image_url,
  252. }
  253. else:
  254. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
  255. except Exception as err:
  256. raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
  257. ############################
  258. # GetAdminDetails
  259. ############################
  260. @router.get("/admin/details")
  261. async def get_admin_details(request: Request, user=Depends(get_current_user)):
  262. if request.app.state.config.SHOW_ADMIN_DETAILS:
  263. admin_email = request.app.state.config.ADMIN_EMAIL
  264. admin_name = None
  265. print(admin_email, admin_name)
  266. if admin_email:
  267. admin = Users.get_user_by_email(admin_email)
  268. if admin:
  269. admin_name = admin.name
  270. else:
  271. admin = Users.get_first_user()
  272. if admin:
  273. admin_email = admin.email
  274. admin_name = admin.name
  275. return {
  276. "name": admin_name,
  277. "email": admin_email,
  278. }
  279. else:
  280. raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
  281. ############################
  282. # ToggleSignUp
  283. ############################
  284. @router.get("/admin/config")
  285. async def get_admin_config(request: Request, user=Depends(get_admin_user)):
  286. return {
  287. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  288. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  289. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  290. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  291. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  292. }
  293. class AdminConfig(BaseModel):
  294. SHOW_ADMIN_DETAILS: bool
  295. ENABLE_SIGNUP: bool
  296. DEFAULT_USER_ROLE: str
  297. JWT_EXPIRES_IN: str
  298. ENABLE_COMMUNITY_SHARING: bool
  299. @router.post("/admin/config")
  300. async def update_admin_config(
  301. request: Request, form_data: AdminConfig, user=Depends(get_admin_user)
  302. ):
  303. request.app.state.config.SHOW_ADMIN_DETAILS = form_data.SHOW_ADMIN_DETAILS
  304. request.app.state.config.ENABLE_SIGNUP = form_data.ENABLE_SIGNUP
  305. if form_data.DEFAULT_USER_ROLE in ["pending", "user", "admin"]:
  306. request.app.state.config.DEFAULT_USER_ROLE = form_data.DEFAULT_USER_ROLE
  307. pattern = r"^(-1|0|(-?\d+(\.\d+)?)(ms|s|m|h|d|w))$"
  308. # Check if the input string matches the pattern
  309. if re.match(pattern, form_data.JWT_EXPIRES_IN):
  310. request.app.state.config.JWT_EXPIRES_IN = form_data.JWT_EXPIRES_IN
  311. request.app.state.config.ENABLE_COMMUNITY_SHARING = (
  312. form_data.ENABLE_COMMUNITY_SHARING
  313. )
  314. return {
  315. "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
  316. "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
  317. "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
  318. "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
  319. "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
  320. }
  321. ############################
  322. # API Key
  323. ############################
  324. # create api key
  325. @router.post("/api_key", response_model=ApiKey)
  326. async def create_api_key_(user=Depends(get_current_user)):
  327. api_key = create_api_key()
  328. success = Users.update_user_api_key_by_id(user.id, api_key)
  329. if success:
  330. return {
  331. "api_key": api_key,
  332. }
  333. else:
  334. raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_API_KEY_ERROR)
  335. # delete api key
  336. @router.delete("/api_key", response_model=bool)
  337. async def delete_api_key(user=Depends(get_current_user)):
  338. success = Users.update_user_api_key_by_id(user.id, None)
  339. return success
  340. # get api key
  341. @router.get("/api_key", response_model=ApiKey)
  342. async def get_api_key(user=Depends(get_current_user)):
  343. api_key = Users.get_user_api_key_by_id(user.id)
  344. if api_key:
  345. return {
  346. "api_key": api_key,
  347. }
  348. else:
  349. raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)