1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072 |
- 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,
- UserResponse,
- )
- from open_webui.models.users import Users, UpdateProfileForm
- from open_webui.models.groups import Groups
- from open_webui.models.oauth_sessions import OAuthSessions
- 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,
- ENABLE_INITIAL_ADMIN_SIGNUP,
- 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
- class SessionUserInfoResponse(SessionUserResponse):
- bio: Optional[str] = None
- gender: Optional[str] = None
- date_of_birth: Optional[datetime.date] = None
- @router.get("/", response_model=SessionUserInfoResponse)
- 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,
- "bio": user.bio,
- "gender": user.gender,
- "date_of_birth": user.date_of_birth,
- "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,
- form_data.model_dump(),
- )
- 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:
- role = (
- "admin"
- if not Users.has_users()
- 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.has_users():
- 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):
- has_users = Users.has_users()
- if WEBUI_AUTH:
- if (
- not request.app.state.config.ENABLE_SIGNUP
- or not request.app.state.config.ENABLE_LOGIN_FORM
- ):
- if has_users or not ENABLE_INITIAL_ADMIN_SIGNUP:
- raise HTTPException(
- status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
- )
- else:
- if has_users:
- raise HTTPException(
- status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
- )
- 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 not has_users 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:
- await 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 not has_users:
- # 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")
- response.delete_cookie("oui-session")
- response.delete_cookie("oauth_id_token")
- oauth_session_id = request.cookies.get("oauth_session_id")
- if oauth_session_id:
- response.delete_cookie("oauth_session_id")
- session = OAuthSessions.get_session_by_id(oauth_session_id)
- oauth_server_metadata_url = (
- request.app.state.oauth_manager.get_server_metadata_url(session.provider)
- if session
- else None
- ) or OPENID_PROVIDER_URL.value
- if session and oauth_server_metadata_url:
- oauth_id_token = session.token.get("id_token")
- try:
- async with ClientSession(trust_env=True) as session:
- async with session.get(oauth_server_metadata_url) as r:
- if r.status == 200:
- openid_data = await r.json()
- logout_url = openid_data.get("end_session_endpoint")
- if logout_url:
- return JSONResponse(
- status_code=200,
- content={
- "status": True,
- "redirect_url": f"{logout_url}?id_token_hint={oauth_id_token}"
- + (
- f"&post_logout_redirect_uri={WEBUI_AUTH_SIGNOUT_REDIRECT_URL}"
- if WEBUI_AUTH_SIGNOUT_REDIRECT_URL
- else ""
- ),
- },
- headers=response.headers,
- )
- else:
- raise Exception("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.",
- headers=response.headers,
- )
- 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)
|