123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050 |
- import re
- import uuid
- import time
- import datetime
- import logging
- from aiohttp import ClientSession
- from open_webui.models.auths import (
- AddUserForm,
- ApiKey,
- Auths,
- Token,
- LdapForm,
- SigninForm,
- SigninResponse,
- SignupForm,
- UpdatePasswordForm,
- UpdateProfileForm,
- UserResponse,
- )
- from open_webui.models.users import Users
- from open_webui.models.groups import Groups
- from open_webui.constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
- from open_webui.env import (
- WEBUI_AUTH,
- WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
- WEBUI_AUTH_TRUSTED_NAME_HEADER,
- WEBUI_AUTH_TRUSTED_GROUPS_HEADER,
- WEBUI_AUTH_COOKIE_SAME_SITE,
- WEBUI_AUTH_COOKIE_SECURE,
- WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
- SRC_LOG_LEVELS,
- )
- from fastapi import APIRouter, Depends, HTTPException, Request, status
- from fastapi.responses import RedirectResponse, Response, JSONResponse
- from open_webui.config import OPENID_PROVIDER_URL, ENABLE_OAUTH_SIGNUP, ENABLE_LDAP
- from pydantic import BaseModel
- from open_webui.utils.misc import parse_duration, validate_email_format
- from open_webui.utils.auth import (
- decode_token,
- create_api_key,
- create_token,
- get_admin_user,
- get_verified_user,
- get_current_user,
- get_password_hash,
- get_http_authorization_cred,
- )
- from open_webui.utils.webhook import post_webhook
- from open_webui.utils.access_control import get_permissions
- from typing import Optional, List
- from ssl import CERT_NONE, CERT_REQUIRED, PROTOCOL_TLS
- from ldap3 import Server, Connection, NONE, Tls
- from ldap3.utils.conv import escape_filter_chars
- router = APIRouter()
- log = logging.getLogger(__name__)
- log.setLevel(SRC_LOG_LEVELS["MAIN"])
- ############################
- # GetSessionUser
- ############################
- class SessionUserResponse(Token, UserResponse):
- expires_at: Optional[int] = None
- permissions: Optional[dict] = None
- @router.get("/", response_model=SessionUserResponse)
- async def get_session_user(
- request: Request, response: Response, user=Depends(get_current_user)
- ):
- auth_header = request.headers.get("Authorization")
- auth_token = get_http_authorization_cred(auth_header)
- token = auth_token.credentials
- data = decode_token(token)
- expires_at = None
- if data:
- expires_at = data.get("exp")
- if (expires_at is not None) and int(time.time()) > expires_at:
- raise HTTPException(
- status_code=status.HTTP_401_UNAUTHORIZED,
- detail=ERROR_MESSAGES.INVALID_TOKEN,
- )
- # Set the cookie token
- response.set_cookie(
- key="token",
- value=token,
- expires=(
- datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
- if expires_at
- else None
- ),
- httponly=True, # Ensures the cookie is not accessible via JavaScript
- samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
- secure=WEBUI_AUTH_COOKIE_SECURE,
- )
- user_permissions = get_permissions(
- user.id, request.app.state.config.USER_PERMISSIONS
- )
- return {
- "token": token,
- "token_type": "Bearer",
- "expires_at": expires_at,
- "id": user.id,
- "email": user.email,
- "name": user.name,
- "role": user.role,
- "profile_image_url": user.profile_image_url,
- "permissions": user_permissions,
- }
- ############################
- # Update Profile
- ############################
- @router.post("/update/profile", response_model=UserResponse)
- async def update_profile(
- form_data: UpdateProfileForm, session_user=Depends(get_verified_user)
- ):
- if session_user:
- user = Users.update_user_by_id(
- session_user.id,
- {"profile_image_url": form_data.profile_image_url, "name": form_data.name},
- )
- if user:
- return user
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.DEFAULT())
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
- ############################
- # Update Password
- ############################
- @router.post("/update/password", response_model=bool)
- async def update_password(
- form_data: UpdatePasswordForm, session_user=Depends(get_current_user)
- ):
- if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
- raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
- if session_user:
- user = Auths.authenticate_user(session_user.email, form_data.password)
- if user:
- hashed = get_password_hash(form_data.new_password)
- return Auths.update_user_password_by_id(user.id, hashed)
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_PASSWORD)
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
- ############################
- # LDAP Authentication
- ############################
- @router.post("/ldap", response_model=SessionUserResponse)
- async def ldap_auth(request: Request, response: Response, form_data: LdapForm):
- ENABLE_LDAP = request.app.state.config.ENABLE_LDAP
- LDAP_SERVER_LABEL = request.app.state.config.LDAP_SERVER_LABEL
- LDAP_SERVER_HOST = request.app.state.config.LDAP_SERVER_HOST
- LDAP_SERVER_PORT = request.app.state.config.LDAP_SERVER_PORT
- LDAP_ATTRIBUTE_FOR_MAIL = request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL
- LDAP_ATTRIBUTE_FOR_USERNAME = request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME
- LDAP_SEARCH_BASE = request.app.state.config.LDAP_SEARCH_BASE
- LDAP_SEARCH_FILTERS = request.app.state.config.LDAP_SEARCH_FILTERS
- LDAP_APP_DN = request.app.state.config.LDAP_APP_DN
- LDAP_APP_PASSWORD = request.app.state.config.LDAP_APP_PASSWORD
- LDAP_USE_TLS = request.app.state.config.LDAP_USE_TLS
- LDAP_CA_CERT_FILE = request.app.state.config.LDAP_CA_CERT_FILE
- LDAP_VALIDATE_CERT = (
- CERT_REQUIRED if request.app.state.config.LDAP_VALIDATE_CERT else CERT_NONE
- )
- LDAP_CIPHERS = (
- request.app.state.config.LDAP_CIPHERS
- if request.app.state.config.LDAP_CIPHERS
- else "ALL"
- )
- if not ENABLE_LDAP:
- raise HTTPException(400, detail="LDAP authentication is not enabled")
- try:
- tls = Tls(
- validate=LDAP_VALIDATE_CERT,
- version=PROTOCOL_TLS,
- ca_certs_file=LDAP_CA_CERT_FILE,
- ciphers=LDAP_CIPHERS,
- )
- except Exception as e:
- log.error(f"TLS configuration error: {str(e)}")
- raise HTTPException(400, detail="Failed to configure TLS for LDAP connection.")
- try:
- server = Server(
- host=LDAP_SERVER_HOST,
- port=LDAP_SERVER_PORT,
- get_info=NONE,
- use_ssl=LDAP_USE_TLS,
- tls=tls,
- )
- connection_app = Connection(
- server,
- LDAP_APP_DN,
- LDAP_APP_PASSWORD,
- auto_bind="NONE",
- authentication="SIMPLE" if LDAP_APP_DN else "ANONYMOUS",
- )
- if not connection_app.bind():
- raise HTTPException(400, detail="Application account bind failed")
- ENABLE_LDAP_GROUP_MANAGEMENT = (
- request.app.state.config.ENABLE_LDAP_GROUP_MANAGEMENT
- )
- ENABLE_LDAP_GROUP_CREATION = request.app.state.config.ENABLE_LDAP_GROUP_CREATION
- LDAP_ATTRIBUTE_FOR_GROUPS = request.app.state.config.LDAP_ATTRIBUTE_FOR_GROUPS
- search_attributes = [
- f"{LDAP_ATTRIBUTE_FOR_USERNAME}",
- f"{LDAP_ATTRIBUTE_FOR_MAIL}",
- "cn",
- ]
- if ENABLE_LDAP_GROUP_MANAGEMENT:
- search_attributes.append(f"{LDAP_ATTRIBUTE_FOR_GROUPS}")
- log.info(
- f"LDAP Group Management enabled. Adding {LDAP_ATTRIBUTE_FOR_GROUPS} to search attributes"
- )
- log.info(f"LDAP search attributes: {search_attributes}")
- search_success = connection_app.search(
- search_base=LDAP_SEARCH_BASE,
- search_filter=f"(&({LDAP_ATTRIBUTE_FOR_USERNAME}={escape_filter_chars(form_data.user.lower())}){LDAP_SEARCH_FILTERS})",
- attributes=search_attributes,
- )
- if not search_success or not connection_app.entries:
- raise HTTPException(400, detail="User not found in the LDAP server")
- entry = connection_app.entries[0]
- username = str(entry[f"{LDAP_ATTRIBUTE_FOR_USERNAME}"]).lower()
- email = entry[
- f"{LDAP_ATTRIBUTE_FOR_MAIL}"
- ].value # retrieve the Attribute value
- if not email:
- raise HTTPException(400, "User does not have a valid email address.")
- elif isinstance(email, str):
- email = email.lower()
- elif isinstance(email, list):
- email = email[0].lower()
- else:
- email = str(email).lower()
- cn = str(entry["cn"])
- user_dn = entry.entry_dn
- user_groups = []
- if ENABLE_LDAP_GROUP_MANAGEMENT and LDAP_ATTRIBUTE_FOR_GROUPS in entry:
- group_dns = entry[LDAP_ATTRIBUTE_FOR_GROUPS]
- log.info(f"LDAP raw group DNs for user {username}: {group_dns}")
- if group_dns:
- log.info(f"LDAP group_dns original: {group_dns}")
- log.info(f"LDAP group_dns type: {type(group_dns)}")
- log.info(f"LDAP group_dns length: {len(group_dns)}")
- if hasattr(group_dns, "value"):
- group_dns = group_dns.value
- log.info(f"Extracted .value property: {group_dns}")
- elif hasattr(group_dns, "__iter__") and not isinstance(
- group_dns, (str, bytes)
- ):
- group_dns = list(group_dns)
- log.info(f"Converted to list: {group_dns}")
- if isinstance(group_dns, list):
- group_dns = [str(item) for item in group_dns]
- else:
- group_dns = [str(group_dns)]
- log.info(
- f"LDAP group_dns after processing - type: {type(group_dns)}, length: {len(group_dns)}"
- )
- for group_idx, group_dn in enumerate(group_dns):
- group_dn = str(group_dn)
- log.info(f"Processing group DN #{group_idx + 1}: {group_dn}")
- try:
- group_cn = None
- for item in group_dn.split(","):
- item = item.strip()
- if item.upper().startswith("CN="):
- group_cn = item[3:]
- break
- if group_cn:
- user_groups.append(group_cn)
- else:
- log.warning(
- f"Could not extract CN from group DN: {group_dn}"
- )
- except Exception as e:
- log.warning(
- f"Failed to extract group name from DN {group_dn}: {e}"
- )
- log.info(
- f"LDAP groups for user {username}: {user_groups} (total: {len(user_groups)})"
- )
- else:
- log.info(f"No groups found for user {username}")
- elif ENABLE_LDAP_GROUP_MANAGEMENT:
- log.warning(
- f"LDAP Group Management enabled but {LDAP_ATTRIBUTE_FOR_GROUPS} attribute not found in user entry"
- )
- if username == form_data.user.lower():
- connection_user = Connection(
- server,
- user_dn,
- form_data.password,
- auto_bind="NONE",
- authentication="SIMPLE",
- )
- if not connection_user.bind():
- raise HTTPException(400, "Authentication failed.")
- user = Users.get_user_by_email(email)
- if not user:
- try:
- user_count = Users.get_num_users()
- role = (
- "admin"
- if user_count == 0
- else request.app.state.config.DEFAULT_USER_ROLE
- )
- user = Auths.insert_new_auth(
- email=email,
- password=str(uuid.uuid4()),
- name=cn,
- role=role,
- )
- if not user:
- raise HTTPException(
- 500, detail=ERROR_MESSAGES.CREATE_USER_ERROR
- )
- except HTTPException:
- raise
- except Exception as err:
- log.error(f"LDAP user creation error: {str(err)}")
- raise HTTPException(
- 500, detail="Internal error occurred during LDAP user creation."
- )
- user = Auths.authenticate_user_by_email(email)
- if user:
- expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
- expires_at = None
- if expires_delta:
- expires_at = int(time.time()) + int(expires_delta.total_seconds())
- token = create_token(
- data={"id": user.id},
- expires_delta=expires_delta,
- )
- # Set the cookie token
- response.set_cookie(
- key="token",
- value=token,
- expires=(
- datetime.datetime.fromtimestamp(
- expires_at, datetime.timezone.utc
- )
- if expires_at
- else None
- ),
- httponly=True, # Ensures the cookie is not accessible via JavaScript
- samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
- secure=WEBUI_AUTH_COOKIE_SECURE,
- )
- user_permissions = get_permissions(
- user.id, request.app.state.config.USER_PERMISSIONS
- )
- if (
- user.role != "admin"
- and ENABLE_LDAP_GROUP_MANAGEMENT
- and user_groups
- ):
- if ENABLE_LDAP_GROUP_CREATION:
- Groups.create_groups_by_group_names(user.id, user_groups)
- try:
- Groups.sync_groups_by_group_names(user.id, user_groups)
- log.info(
- f"Successfully synced groups for user {user.id}: {user_groups}"
- )
- except Exception as e:
- log.error(f"Failed to sync groups for user {user.id}: {e}")
- return {
- "token": token,
- "token_type": "Bearer",
- "expires_at": expires_at,
- "id": user.id,
- "email": user.email,
- "name": user.name,
- "role": user.role,
- "profile_image_url": user.profile_image_url,
- "permissions": user_permissions,
- }
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
- else:
- raise HTTPException(400, "User record mismatch.")
- except Exception as e:
- log.error(f"LDAP authentication error: {str(e)}")
- raise HTTPException(400, detail="LDAP authentication failed.")
- ############################
- # SignIn
- ############################
- @router.post("/signin", response_model=SessionUserResponse)
- async def signin(request: Request, response: Response, form_data: SigninForm):
- if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
- if WEBUI_AUTH_TRUSTED_EMAIL_HEADER not in request.headers:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)
- email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
- name = email
- if WEBUI_AUTH_TRUSTED_NAME_HEADER:
- name = request.headers.get(WEBUI_AUTH_TRUSTED_NAME_HEADER, email)
- if not Users.get_user_by_email(email.lower()):
- await signup(
- request,
- response,
- SignupForm(email=email, password=str(uuid.uuid4()), name=name),
- )
- user = Auths.authenticate_user_by_email(email)
- if WEBUI_AUTH_TRUSTED_GROUPS_HEADER and user and user.role != "admin":
- group_names = request.headers.get(
- WEBUI_AUTH_TRUSTED_GROUPS_HEADER, ""
- ).split(",")
- group_names = [name.strip() for name in group_names if name.strip()]
- if group_names:
- Groups.sync_groups_by_group_names(user.id, group_names)
- elif WEBUI_AUTH == False:
- admin_email = "admin@localhost"
- admin_password = "admin"
- if Users.get_user_by_email(admin_email.lower()):
- user = Auths.authenticate_user(admin_email.lower(), admin_password)
- else:
- if Users.get_num_users() != 0:
- raise HTTPException(400, detail=ERROR_MESSAGES.EXISTING_USERS)
- await signup(
- request,
- response,
- SignupForm(email=admin_email, password=admin_password, name="User"),
- )
- user = Auths.authenticate_user(admin_email.lower(), admin_password)
- else:
- user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
- if user:
- expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
- expires_at = None
- if expires_delta:
- expires_at = int(time.time()) + int(expires_delta.total_seconds())
- token = create_token(
- data={"id": user.id},
- expires_delta=expires_delta,
- )
- datetime_expires_at = (
- datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
- if expires_at
- else None
- )
- # Set the cookie token
- response.set_cookie(
- key="token",
- value=token,
- expires=datetime_expires_at,
- httponly=True, # Ensures the cookie is not accessible via JavaScript
- samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
- secure=WEBUI_AUTH_COOKIE_SECURE,
- )
- user_permissions = get_permissions(
- user.id, request.app.state.config.USER_PERMISSIONS
- )
- return {
- "token": token,
- "token_type": "Bearer",
- "expires_at": expires_at,
- "id": user.id,
- "email": user.email,
- "name": user.name,
- "role": user.role,
- "profile_image_url": user.profile_image_url,
- "permissions": user_permissions,
- }
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
- ############################
- # SignUp
- ############################
- @router.post("/signup", response_model=SessionUserResponse)
- async def signup(request: Request, response: Response, form_data: SignupForm):
- if WEBUI_AUTH:
- if (
- not request.app.state.config.ENABLE_SIGNUP
- or not request.app.state.config.ENABLE_LOGIN_FORM
- ):
- raise HTTPException(
- status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
- )
- else:
- if Users.get_num_users() != 0:
- raise HTTPException(
- status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
- )
- user_count = Users.get_num_users()
- if not validate_email_format(form_data.email.lower()):
- raise HTTPException(
- status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
- )
- if Users.get_user_by_email(form_data.email.lower()):
- raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
- try:
- role = (
- "admin" if user_count == 0 else request.app.state.config.DEFAULT_USER_ROLE
- )
- # The password passed to bcrypt must be 72 bytes or fewer. If it is longer, it will be truncated before hashing.
- if len(form_data.password.encode("utf-8")) > 72:
- raise HTTPException(
- status.HTTP_400_BAD_REQUEST,
- detail=ERROR_MESSAGES.PASSWORD_TOO_LONG,
- )
- hashed = get_password_hash(form_data.password)
- user = Auths.insert_new_auth(
- form_data.email.lower(),
- hashed,
- form_data.name,
- form_data.profile_image_url,
- role,
- )
- if user:
- expires_delta = parse_duration(request.app.state.config.JWT_EXPIRES_IN)
- expires_at = None
- if expires_delta:
- expires_at = int(time.time()) + int(expires_delta.total_seconds())
- token = create_token(
- data={"id": user.id},
- expires_delta=expires_delta,
- )
- datetime_expires_at = (
- datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
- if expires_at
- else None
- )
- # Set the cookie token
- response.set_cookie(
- key="token",
- value=token,
- expires=datetime_expires_at,
- httponly=True, # Ensures the cookie is not accessible via JavaScript
- samesite=WEBUI_AUTH_COOKIE_SAME_SITE,
- secure=WEBUI_AUTH_COOKIE_SECURE,
- )
- if request.app.state.config.WEBHOOK_URL:
- post_webhook(
- request.app.state.WEBUI_NAME,
- request.app.state.config.WEBHOOK_URL,
- WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
- {
- "action": "signup",
- "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
- "user": user.model_dump_json(exclude_none=True),
- },
- )
- user_permissions = get_permissions(
- user.id, request.app.state.config.USER_PERMISSIONS
- )
- if user_count == 0:
- # Disable signup after the first user is created
- request.app.state.config.ENABLE_SIGNUP = False
- return {
- "token": token,
- "token_type": "Bearer",
- "expires_at": expires_at,
- "id": user.id,
- "email": user.email,
- "name": user.name,
- "role": user.role,
- "profile_image_url": user.profile_image_url,
- "permissions": user_permissions,
- }
- else:
- raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
- except Exception as err:
- log.error(f"Signup error: {str(err)}")
- raise HTTPException(500, detail="An internal error occurred during signup.")
- @router.get("/signout")
- async def signout(request: Request, response: Response):
- response.delete_cookie("token")
- if ENABLE_OAUTH_SIGNUP.value:
- oauth_id_token = request.cookies.get("oauth_id_token")
- if oauth_id_token:
- try:
- async with ClientSession() as session:
- async with session.get(OPENID_PROVIDER_URL.value) as resp:
- if resp.status == 200:
- openid_data = await resp.json()
- logout_url = openid_data.get("end_session_endpoint")
- if logout_url:
- response.delete_cookie("oauth_id_token")
- return JSONResponse(
- status_code=200,
- content={
- "status": True,
- "redirect_url": f"{logout_url}?id_token_hint={oauth_id_token}",
- },
- headers=response.headers,
- )
- else:
- raise HTTPException(
- status_code=resp.status,
- detail="Failed to fetch OpenID configuration",
- )
- except Exception as e:
- log.error(f"OpenID signout error: {str(e)}")
- raise HTTPException(
- status_code=500,
- detail="Failed to sign out from the OpenID provider.",
- )
- if WEBUI_AUTH_SIGNOUT_REDIRECT_URL:
- return JSONResponse(
- status_code=200,
- content={
- "status": True,
- "redirect_url": WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
- },
- headers=response.headers,
- )
- return JSONResponse(
- status_code=200, content={"status": True}, headers=response.headers
- )
- ############################
- # AddUser
- ############################
- @router.post("/add", response_model=SigninResponse)
- async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
- if not validate_email_format(form_data.email.lower()):
- raise HTTPException(
- status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
- )
- if Users.get_user_by_email(form_data.email.lower()):
- raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
- try:
- hashed = get_password_hash(form_data.password)
- user = Auths.insert_new_auth(
- form_data.email.lower(),
- hashed,
- form_data.name,
- form_data.profile_image_url,
- form_data.role,
- )
- if user:
- token = create_token(data={"id": user.id})
- return {
- "token": token,
- "token_type": "Bearer",
- "id": user.id,
- "email": user.email,
- "name": user.name,
- "role": user.role,
- "profile_image_url": user.profile_image_url,
- }
- else:
- raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
- except Exception as err:
- log.error(f"Add user error: {str(err)}")
- raise HTTPException(
- 500, detail="An internal error occurred while adding the user."
- )
- ############################
- # GetAdminDetails
- ############################
- @router.get("/admin/details")
- async def get_admin_details(request: Request, user=Depends(get_current_user)):
- if request.app.state.config.SHOW_ADMIN_DETAILS:
- admin_email = request.app.state.config.ADMIN_EMAIL
- admin_name = None
- log.info(f"Admin details - Email: {admin_email}, Name: {admin_name}")
- if admin_email:
- admin = Users.get_user_by_email(admin_email)
- if admin:
- admin_name = admin.name
- else:
- admin = Users.get_first_user()
- if admin:
- admin_email = admin.email
- admin_name = admin.name
- return {
- "name": admin_name,
- "email": admin_email,
- }
- else:
- raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
- ############################
- # ToggleSignUp
- ############################
- @router.get("/admin/config")
- async def get_admin_config(request: Request, user=Depends(get_admin_user)):
- return {
- "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
- "WEBUI_URL": request.app.state.config.WEBUI_URL,
- "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
- "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
- "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
- "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
- "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
- "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
- "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
- "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
- "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
- "ENABLE_NOTES": request.app.state.config.ENABLE_NOTES,
- "ENABLE_USER_WEBHOOKS": request.app.state.config.ENABLE_USER_WEBHOOKS,
- "PENDING_USER_OVERLAY_TITLE": request.app.state.config.PENDING_USER_OVERLAY_TITLE,
- "PENDING_USER_OVERLAY_CONTENT": request.app.state.config.PENDING_USER_OVERLAY_CONTENT,
- "RESPONSE_WATERMARK": request.app.state.config.RESPONSE_WATERMARK,
- }
- class AdminConfig(BaseModel):
- SHOW_ADMIN_DETAILS: bool
- WEBUI_URL: str
- ENABLE_SIGNUP: bool
- ENABLE_API_KEY: bool
- ENABLE_API_KEY_ENDPOINT_RESTRICTIONS: bool
- API_KEY_ALLOWED_ENDPOINTS: str
- DEFAULT_USER_ROLE: str
- JWT_EXPIRES_IN: str
- ENABLE_COMMUNITY_SHARING: bool
- ENABLE_MESSAGE_RATING: bool
- ENABLE_CHANNELS: bool
- ENABLE_NOTES: bool
- ENABLE_USER_WEBHOOKS: bool
- PENDING_USER_OVERLAY_TITLE: Optional[str] = None
- PENDING_USER_OVERLAY_CONTENT: Optional[str] = None
- RESPONSE_WATERMARK: Optional[str] = None
- @router.post("/admin/config")
- async def update_admin_config(
- request: Request, form_data: AdminConfig, user=Depends(get_admin_user)
- ):
- request.app.state.config.SHOW_ADMIN_DETAILS = form_data.SHOW_ADMIN_DETAILS
- request.app.state.config.WEBUI_URL = form_data.WEBUI_URL
- request.app.state.config.ENABLE_SIGNUP = form_data.ENABLE_SIGNUP
- request.app.state.config.ENABLE_API_KEY = form_data.ENABLE_API_KEY
- request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
- form_data.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
- )
- request.app.state.config.API_KEY_ALLOWED_ENDPOINTS = (
- form_data.API_KEY_ALLOWED_ENDPOINTS
- )
- request.app.state.config.ENABLE_CHANNELS = form_data.ENABLE_CHANNELS
- request.app.state.config.ENABLE_NOTES = form_data.ENABLE_NOTES
- if form_data.DEFAULT_USER_ROLE in ["pending", "user", "admin"]:
- request.app.state.config.DEFAULT_USER_ROLE = form_data.DEFAULT_USER_ROLE
- pattern = r"^(-1|0|(-?\d+(\.\d+)?)(ms|s|m|h|d|w))$"
- # Check if the input string matches the pattern
- if re.match(pattern, form_data.JWT_EXPIRES_IN):
- request.app.state.config.JWT_EXPIRES_IN = form_data.JWT_EXPIRES_IN
- request.app.state.config.ENABLE_COMMUNITY_SHARING = (
- form_data.ENABLE_COMMUNITY_SHARING
- )
- request.app.state.config.ENABLE_MESSAGE_RATING = form_data.ENABLE_MESSAGE_RATING
- request.app.state.config.ENABLE_USER_WEBHOOKS = form_data.ENABLE_USER_WEBHOOKS
- request.app.state.config.PENDING_USER_OVERLAY_TITLE = (
- form_data.PENDING_USER_OVERLAY_TITLE
- )
- request.app.state.config.PENDING_USER_OVERLAY_CONTENT = (
- form_data.PENDING_USER_OVERLAY_CONTENT
- )
- request.app.state.config.RESPONSE_WATERMARK = form_data.RESPONSE_WATERMARK
- return {
- "SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
- "WEBUI_URL": request.app.state.config.WEBUI_URL,
- "ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
- "ENABLE_API_KEY": request.app.state.config.ENABLE_API_KEY,
- "ENABLE_API_KEY_ENDPOINT_RESTRICTIONS": request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
- "API_KEY_ALLOWED_ENDPOINTS": request.app.state.config.API_KEY_ALLOWED_ENDPOINTS,
- "DEFAULT_USER_ROLE": request.app.state.config.DEFAULT_USER_ROLE,
- "JWT_EXPIRES_IN": request.app.state.config.JWT_EXPIRES_IN,
- "ENABLE_COMMUNITY_SHARING": request.app.state.config.ENABLE_COMMUNITY_SHARING,
- "ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
- "ENABLE_CHANNELS": request.app.state.config.ENABLE_CHANNELS,
- "ENABLE_NOTES": request.app.state.config.ENABLE_NOTES,
- "ENABLE_USER_WEBHOOKS": request.app.state.config.ENABLE_USER_WEBHOOKS,
- "PENDING_USER_OVERLAY_TITLE": request.app.state.config.PENDING_USER_OVERLAY_TITLE,
- "PENDING_USER_OVERLAY_CONTENT": request.app.state.config.PENDING_USER_OVERLAY_CONTENT,
- "RESPONSE_WATERMARK": request.app.state.config.RESPONSE_WATERMARK,
- }
- class LdapServerConfig(BaseModel):
- label: str
- host: str
- port: Optional[int] = None
- attribute_for_mail: str = "mail"
- attribute_for_username: str = "uid"
- app_dn: str
- app_dn_password: str
- search_base: str
- search_filters: str = ""
- use_tls: bool = True
- certificate_path: Optional[str] = None
- validate_cert: bool = True
- ciphers: Optional[str] = "ALL"
- @router.get("/admin/config/ldap/server", response_model=LdapServerConfig)
- async def get_ldap_server(request: Request, user=Depends(get_admin_user)):
- return {
- "label": request.app.state.config.LDAP_SERVER_LABEL,
- "host": request.app.state.config.LDAP_SERVER_HOST,
- "port": request.app.state.config.LDAP_SERVER_PORT,
- "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
- "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
- "app_dn": request.app.state.config.LDAP_APP_DN,
- "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
- "search_base": request.app.state.config.LDAP_SEARCH_BASE,
- "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
- "use_tls": request.app.state.config.LDAP_USE_TLS,
- "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
- "validate_cert": request.app.state.config.LDAP_VALIDATE_CERT,
- "ciphers": request.app.state.config.LDAP_CIPHERS,
- }
- @router.post("/admin/config/ldap/server")
- async def update_ldap_server(
- request: Request, form_data: LdapServerConfig, user=Depends(get_admin_user)
- ):
- required_fields = [
- "label",
- "host",
- "attribute_for_mail",
- "attribute_for_username",
- "app_dn",
- "app_dn_password",
- "search_base",
- ]
- for key in required_fields:
- value = getattr(form_data, key)
- if not value:
- raise HTTPException(400, detail=f"Required field {key} is empty")
- request.app.state.config.LDAP_SERVER_LABEL = form_data.label
- request.app.state.config.LDAP_SERVER_HOST = form_data.host
- request.app.state.config.LDAP_SERVER_PORT = form_data.port
- request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = form_data.attribute_for_mail
- request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = (
- form_data.attribute_for_username
- )
- request.app.state.config.LDAP_APP_DN = form_data.app_dn
- request.app.state.config.LDAP_APP_PASSWORD = form_data.app_dn_password
- request.app.state.config.LDAP_SEARCH_BASE = form_data.search_base
- request.app.state.config.LDAP_SEARCH_FILTERS = form_data.search_filters
- request.app.state.config.LDAP_USE_TLS = form_data.use_tls
- request.app.state.config.LDAP_CA_CERT_FILE = form_data.certificate_path
- request.app.state.config.LDAP_VALIDATE_CERT = form_data.validate_cert
- request.app.state.config.LDAP_CIPHERS = form_data.ciphers
- return {
- "label": request.app.state.config.LDAP_SERVER_LABEL,
- "host": request.app.state.config.LDAP_SERVER_HOST,
- "port": request.app.state.config.LDAP_SERVER_PORT,
- "attribute_for_mail": request.app.state.config.LDAP_ATTRIBUTE_FOR_MAIL,
- "attribute_for_username": request.app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME,
- "app_dn": request.app.state.config.LDAP_APP_DN,
- "app_dn_password": request.app.state.config.LDAP_APP_PASSWORD,
- "search_base": request.app.state.config.LDAP_SEARCH_BASE,
- "search_filters": request.app.state.config.LDAP_SEARCH_FILTERS,
- "use_tls": request.app.state.config.LDAP_USE_TLS,
- "certificate_path": request.app.state.config.LDAP_CA_CERT_FILE,
- "validate_cert": request.app.state.config.LDAP_VALIDATE_CERT,
- "ciphers": request.app.state.config.LDAP_CIPHERS,
- }
- @router.get("/admin/config/ldap")
- async def get_ldap_config(request: Request, user=Depends(get_admin_user)):
- return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
- class LdapConfigForm(BaseModel):
- enable_ldap: Optional[bool] = None
- @router.post("/admin/config/ldap")
- async def update_ldap_config(
- request: Request, form_data: LdapConfigForm, user=Depends(get_admin_user)
- ):
- request.app.state.config.ENABLE_LDAP = form_data.enable_ldap
- return {"ENABLE_LDAP": request.app.state.config.ENABLE_LDAP}
- ############################
- # API Key
- ############################
- # create api key
- @router.post("/api_key", response_model=ApiKey)
- async def generate_api_key(request: Request, user=Depends(get_current_user)):
- if not request.app.state.config.ENABLE_API_KEY:
- raise HTTPException(
- status.HTTP_403_FORBIDDEN,
- detail=ERROR_MESSAGES.API_KEY_CREATION_NOT_ALLOWED,
- )
- api_key = create_api_key()
- success = Users.update_user_api_key_by_id(user.id, api_key)
- if success:
- return {
- "api_key": api_key,
- }
- else:
- raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_API_KEY_ERROR)
- # delete api key
- @router.delete("/api_key", response_model=bool)
- async def delete_api_key(user=Depends(get_current_user)):
- success = Users.update_user_api_key_by_id(user.id, None)
- return success
- # get api key
- @router.get("/api_key", response_model=ApiKey)
- async def get_api_key(user=Depends(get_current_user)):
- api_key = Users.get_user_api_key_by_id(user.id)
- if api_key:
- return {
- "api_key": api_key,
- }
- else:
- raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)
|