auths.py 12 KB

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