open-webui/backend/open_webui/apps/webui/routers/auths.py

764 lines
25 KiB
Python
Raw Normal View History

2024-02-20 04:44:00 +00:00
import re
2024-04-02 16:18:36 +00:00
import uuid
2024-10-15 09:48:41 +00:00
import time
import datetime
import logging
2024-05-02 02:02:25 +00:00
from open_webui.apps.webui.models.auths import (
2024-08-27 22:10:27 +00:00
AddUserForm,
ApiKey,
Auths,
2024-10-15 09:48:41 +00:00
Token,
LdapForm,
2023-11-19 00:47:12 +00:00
SigninForm,
2024-08-27 22:10:27 +00:00
SigninResponse,
2023-11-19 00:47:12 +00:00
SignupForm,
2023-12-29 08:12:30 +00:00
UpdatePasswordForm,
2024-08-27 22:10:27 +00:00
UpdateProfileForm,
2023-11-19 00:47:12 +00:00
UserResponse,
)
from open_webui.apps.webui.models.users import Users
from open_webui.config import WEBUI_AUTH
from open_webui.constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
from open_webui.env import (
WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
WEBUI_AUTH_TRUSTED_NAME_HEADER,
WEBUI_SESSION_COOKIE_SAME_SITE,
WEBUI_SESSION_COOKIE_SECURE,
SRC_LOG_LEVELS,
)
2024-08-27 22:10:27 +00:00
from fastapi import APIRouter, Depends, HTTPException, Request, status
from fastapi.responses import Response
from pydantic import BaseModel
from open_webui.utils.misc import parse_duration, validate_email_format
from open_webui.utils.utils import (
2024-04-02 16:18:36 +00:00
create_api_key,
2024-08-27 22:10:27 +00:00
create_token,
get_admin_user,
2024-10-10 19:51:00 +00:00
get_verified_user,
2024-08-27 22:10:27 +00:00
get_current_user,
get_password_hash,
2024-02-14 09:17:43 +00:00
)
from open_webui.utils.webhook import post_webhook
2024-11-17 05:07:56 +00:00
from open_webui.utils.access_control import get_permissions
from typing import Optional, List
from ssl import CERT_REQUIRED, PROTOCOL_TLS
2024-11-17 05:07:56 +00:00
from ldap3 import Server, Connection, ALL, Tls
from ldap3.utils.conv import escape_filter_chars
2023-11-19 00:47:12 +00:00
2023-11-19 08:13:59 +00:00
router = APIRouter()
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
2023-11-19 00:47:12 +00:00
############################
# GetSessionUser
############################
2024-10-15 09:48:41 +00:00
class SessionUserResponse(Token, UserResponse):
expires_at: Optional[int] = None
2024-11-17 05:07:56 +00:00
permissions: Optional[dict] = None
2024-10-15 09:48:41 +00:00
@router.get("/", response_model=SessionUserResponse)
2024-06-19 21:38:09 +00:00
async def get_session_user(
request: Request, response: Response, user=Depends(get_current_user)
):
2024-10-15 09:48:41 +00:00
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())
2024-06-19 21:38:09 +00:00
token = create_token(
data={"id": user.id},
2024-10-15 09:48:41 +00:00
expires_delta=expires_delta,
)
2024-10-15 09:51:08 +00:00
datetime_expires_at = (
datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
if expires_at
else None
2024-06-19 21:38:09 +00:00
)
# Set the cookie token
response.set_cookie(
key="token",
value=token,
2024-10-15 09:48:41 +00:00
expires=datetime_expires_at,
2024-06-19 21:38:09 +00:00
httponly=True, # Ensures the cookie is not accessible via JavaScript
2024-10-15 09:48:41 +00:00
samesite=WEBUI_SESSION_COOKIE_SAME_SITE,
secure=WEBUI_SESSION_COOKIE_SECURE,
2024-06-19 21:38:09 +00:00
)
2024-11-17 05:07:56 +00:00
user_permissions = get_permissions(
user.id, request.app.state.config.USER_PERMISSIONS
)
return {
2024-10-15 09:48:41 +00:00
"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,
2024-11-17 05:07:56 +00:00
"permissions": user_permissions,
}
2023-11-19 00:47:12 +00:00
2024-01-27 04:27:45 +00:00
############################
# Update Profile
2024-01-27 04:27:45 +00:00
############################
@router.post("/update/profile", response_model=UserResponse)
async def update_profile(
2024-10-10 19:51:00 +00:00
form_data: UpdateProfileForm, session_user=Depends(get_verified_user)
2024-01-27 04:27:45 +00:00
):
if session_user:
user = Users.update_user_by_id(
session_user.id,
{"profile_image_url": form_data.profile_image_url, "name": form_data.name},
2024-01-27 04:27:45 +00:00
)
if user:
return user
else:
raise HTTPException(400, detail=ERROR_MESSAGES.DEFAULT())
else:
raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2023-12-29 08:12:30 +00:00
############################
# Update Password
############################
@router.post("/update/password", response_model=bool)
2024-01-27 04:27:45 +00:00
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)
2023-12-29 08:26:47 +00:00
if session_user:
user = Auths.authenticate_user(session_user.email, form_data.password)
2023-12-29 08:12:30 +00:00
2023-12-29 08:26:47 +00:00
if user:
hashed = get_password_hash(form_data.new_password)
2023-12-29 08:29:18 +00:00
return Auths.update_user_password_by_id(user.id, hashed)
2023-12-29 08:26:47 +00:00
else:
raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_PASSWORD)
2023-12-29 08:12:30 +00:00
else:
raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
############################
# LDAP Authentication
############################
@router.post("/ldap", response_model=SigninResponse)
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_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
2024-11-17 05:07:56 +00:00
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:
2024-11-17 05:07:56 +00:00
tls = Tls(
validate=CERT_REQUIRED,
version=PROTOCOL_TLS,
ca_certs_file=LDAP_CA_CERT_FILE,
ciphers=LDAP_CIPHERS,
)
except Exception as e:
log.error(f"An error occurred on TLS: {str(e)}")
raise HTTPException(400, detail=str(e))
try:
2024-11-17 05:07:56 +00:00
server = Server(
host=LDAP_SERVER_HOST,
port=LDAP_SERVER_PORT,
get_info=ALL,
use_ssl=LDAP_USE_TLS,
tls=tls,
)
connection_app = Connection(
server,
LDAP_APP_DN,
LDAP_APP_PASSWORD,
auto_bind="NONE",
authentication="SIMPLE",
)
if not connection_app.bind():
raise HTTPException(400, detail="Application account bind failed")
search_success = connection_app.search(
search_base=LDAP_SEARCH_BASE,
2024-11-17 05:07:56 +00:00
search_filter=f"(&({LDAP_ATTRIBUTE_FOR_USERNAME}={escape_filter_chars(form_data.user.lower())}){LDAP_SEARCH_FILTERS})",
attributes=[f"{LDAP_ATTRIBUTE_FOR_USERNAME}", "mail", "cn"],
)
if not search_success:
raise HTTPException(400, detail="User not found in the LDAP server")
entry = connection_app.entries[0]
2024-11-17 05:07:56 +00:00
username = str(entry[f"{LDAP_ATTRIBUTE_FOR_USERNAME}"]).lower()
mail = str(entry["mail"])
cn = str(entry["cn"])
user_dn = entry.entry_dn
if username == form_data.user.lower():
2024-11-17 05:07:56 +00:00
connection_user = Connection(
server,
user_dn,
form_data.password,
auto_bind="NONE",
authentication="SIMPLE",
)
if not connection_user.bind():
raise HTTPException(400, f"Authentication failed for {form_data.user}")
user = Users.get_user_by_email(mail)
if not user:
try:
hashed = get_password_hash(form_data.password)
2024-11-17 05:07:56 +00:00
user = Auths.insert_new_auth(mail, hashed, cn)
if not user:
2024-11-17 05:07:56 +00:00
raise HTTPException(
500, detail=ERROR_MESSAGES.CREATE_USER_ERROR
)
except HTTPException:
raise
except Exception as err:
raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
user = Auths.authenticate_user(mail, password=str(form_data.password))
if user:
token = create_token(
data={"id": user.id},
2024-11-17 05:07:56 +00:00
expires_delta=parse_duration(
request.app.state.config.JWT_EXPIRES_IN
),
)
# Set the cookie token
response.set_cookie(
key="token",
value=token,
httponly=True, # Ensures the cookie is not accessible via JavaScript
)
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(400, detail=ERROR_MESSAGES.INVALID_CRED)
else:
2024-11-17 05:07:56 +00:00
raise HTTPException(
400,
f"User {form_data.user} does not match the record. Search result: {str(entry[f'{LDAP_ATTRIBUTE_FOR_USERNAME}'])}",
)
except Exception as e:
raise HTTPException(400, detail=str(e))
2023-11-19 00:47:12 +00:00
############################
# SignIn
############################
2024-10-15 09:48:41 +00:00
@router.post("/signin", response_model=SessionUserResponse)
2024-06-20 20:14:58 +00:00
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:
2024-03-29 20:06:18 +00:00
raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)
trusted_email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
trusted_name = trusted_email
if WEBUI_AUTH_TRUSTED_NAME_HEADER:
2024-06-17 04:55:08 +00:00
trusted_name = request.headers.get(
WEBUI_AUTH_TRUSTED_NAME_HEADER, trusted_email
)
if not Users.get_user_by_email(trusted_email.lower()):
2024-03-29 20:06:18 +00:00
await signup(
request,
2024-06-28 04:43:19 +00:00
response,
2024-03-29 20:06:18 +00:00
SignupForm(
email=trusted_email, password=str(uuid.uuid4()), name=trusted_name
2024-03-29 20:06:18 +00:00
),
)
user = Auths.authenticate_user_by_trusted_header(trusted_email)
2024-05-09 00:17:21 +00:00
elif WEBUI_AUTH == False:
admin_email = "admin@localhost"
admin_password = "admin"
2024-05-08 23:19:59 +00:00
2024-05-09 00:17:21 +00:00
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)
2024-05-09 00:15:54 +00:00
2024-05-09 00:17:21 +00:00
await signup(
request,
2024-06-28 04:44:35 +00:00
response,
2024-05-09 00:17:21 +00:00
SignupForm(email=admin_email, password=admin_password, name="User"),
)
2024-05-08 23:42:41 +00:00
2024-05-09 00:17:21 +00:00
user = Auths.authenticate_user(admin_email.lower(), admin_password)
else:
user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
2023-11-19 00:47:12 +00:00
if user:
2024-10-15 09:48:41 +00:00
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())
2024-02-20 04:44:00 +00:00
token = create_token(
data={"id": user.id},
2024-10-15 09:48:41 +00:00
expires_delta=expires_delta,
)
2024-10-15 09:51:08 +00:00
datetime_expires_at = (
datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
if expires_at
else None
2024-02-20 04:44:00 +00:00
)
2023-11-19 00:47:12 +00:00
2024-06-20 20:14:58 +00:00
# Set the cookie token
response.set_cookie(
key="token",
value=token,
2024-10-15 09:48:41 +00:00
expires=datetime_expires_at,
2024-06-20 20:14:58 +00:00
httponly=True, # Ensures the cookie is not accessible via JavaScript
2024-10-15 09:48:41 +00:00
samesite=WEBUI_SESSION_COOKIE_SAME_SITE,
secure=WEBUI_SESSION_COOKIE_SECURE,
2024-06-20 20:14:58 +00:00
)
2024-11-17 05:07:56 +00:00
user_permissions = get_permissions(
user.id, request.app.state.config.USER_PERMISSIONS
)
2023-11-19 00:47:12 +00:00
return {
"token": token,
"token_type": "Bearer",
2024-10-15 09:48:41 +00:00
"expires_at": expires_at,
2023-11-19 00:47:12 +00:00
"id": user.id,
"email": user.email,
"name": user.name,
"role": user.role,
2023-11-19 05:41:43 +00:00
"profile_image_url": user.profile_image_url,
2024-11-17 05:07:56 +00:00
"permissions": user_permissions,
2023-11-19 00:47:12 +00:00
}
else:
2023-11-19 05:41:43 +00:00
raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2023-11-19 00:47:12 +00:00
############################
# SignUp
############################
2024-10-15 09:48:41 +00:00
@router.post("/signup", response_model=SessionUserResponse)
2024-06-20 20:14:58 +00:00
async def signup(request: Request, response: Response, form_data: SignupForm):
2024-09-21 13:35:35 +00:00
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
)
2024-09-21 13:35:35 +00:00
else:
if Users.get_num_users() != 0:
raise HTTPException(
status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
)
2024-01-27 04:27:45 +00:00
if not validate_email_format(form_data.email.lower()):
2024-02-14 09:17:43 +00:00
raise HTTPException(
status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
)
2024-01-27 04:27:45 +00:00
if Users.get_user_by_email(form_data.email.lower()):
raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
2024-01-27 04:27:45 +00:00
try:
2024-02-14 09:17:43 +00:00
role = (
"admin"
if Users.get_num_users() == 0
else request.app.state.config.DEFAULT_USER_ROLE
2024-02-14 09:17:43 +00:00
)
if Users.get_num_users() == 0:
# Disable signup after the first user is created
request.app.state.config.ENABLE_SIGNUP = False
hashed = get_password_hash(form_data.password)
2024-01-27 04:27:45 +00:00
user = Auths.insert_new_auth(
2024-04-04 08:10:51 +00:00
form_data.email.lower(),
hashed,
form_data.name,
form_data.profile_image_url,
role,
2024-01-27 04:27:45 +00:00
)
if user:
2024-10-15 09:48:41 +00:00
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())
2024-02-20 04:44:00 +00:00
token = create_token(
data={"id": user.id},
2024-10-15 09:48:41 +00:00
expires_delta=expires_delta,
)
2024-10-15 09:51:08 +00:00
datetime_expires_at = (
datetime.datetime.fromtimestamp(expires_at, datetime.timezone.utc)
if expires_at
else None
2024-02-20 04:44:00 +00:00
)
2024-06-20 20:14:58 +00:00
# Set the cookie token
response.set_cookie(
key="token",
value=token,
2024-10-15 09:48:41 +00:00
expires=datetime_expires_at,
2024-06-20 20:14:58 +00:00
httponly=True, # Ensures the cookie is not accessible via JavaScript
2024-10-15 09:48:41 +00:00
samesite=WEBUI_SESSION_COOKIE_SAME_SITE,
secure=WEBUI_SESSION_COOKIE_SECURE,
2024-06-20 20:14:58 +00:00
)
if request.app.state.config.WEBHOOK_URL:
2024-03-21 01:35:02 +00:00
post_webhook(
request.app.state.config.WEBHOOK_URL,
2024-03-21 01:47:13 +00:00
WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
2024-03-21 01:35:02 +00:00
{
"action": "signup",
"message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
"user": user.model_dump_json(exclude_none=True),
},
)
2024-11-17 05:07:56 +00:00
user_permissions = get_permissions(
user.id, request.app.state.config.USER_PERMISSIONS
)
return {
"token": token,
"token_type": "Bearer",
2024-10-15 09:48:41 +00:00
"expires_at": expires_at,
"id": user.id,
"email": user.email,
"name": user.name,
"role": user.role,
"profile_image_url": user.profile_image_url,
2024-11-17 05:07:56 +00:00
"permissions": user_permissions,
}
else:
2024-01-27 04:27:45 +00:00
raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
2024-05-02 00:55:18 +00:00
except Exception as err:
raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
2024-10-24 20:35:29 +00:00
@router.get("/signout")
async def signout(response: Response):
response.delete_cookie("token")
return {"status": True}
2024-05-02 00:55:18 +00:00
############################
# AddUser
############################
@router.post("/add", response_model=SigninResponse)
2024-05-02 02:02:25 +00:00
async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
2024-05-02 00:55:18 +00:00
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:
2024-05-02 01:06:02 +00:00
print(form_data)
2024-05-02 00:55:18 +00:00
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,
2024-05-02 01:06:02 +00:00
form_data.role,
2024-05-02 00:55:18 +00:00
)
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:
2024-01-27 04:27:45 +00:00
raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))
############################
# 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
print(admin_email, 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)
2024-02-14 09:17:43 +00:00
############################
# ToggleSignUp
2024-02-14 09:17:43 +00:00
############################
@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,
"ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
"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,
2024-08-19 13:16:49 +00:00
"ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
}
2024-02-14 09:17:43 +00:00
class AdminConfig(BaseModel):
SHOW_ADMIN_DETAILS: bool
ENABLE_SIGNUP: bool
DEFAULT_USER_ROLE: str
JWT_EXPIRES_IN: str
ENABLE_COMMUNITY_SHARING: bool
2024-08-19 13:16:49 +00:00
ENABLE_MESSAGE_RATING: bool
2024-02-14 09:17:43 +00:00
@router.post("/admin/config")
async def update_admin_config(
request: Request, form_data: AdminConfig, user=Depends(get_admin_user)
2024-02-14 09:17:43 +00:00
):
request.app.state.config.SHOW_ADMIN_DETAILS = form_data.SHOW_ADMIN_DETAILS
request.app.state.config.ENABLE_SIGNUP = form_data.ENABLE_SIGNUP
2024-02-20 04:44:00 +00:00
if form_data.DEFAULT_USER_ROLE in ["pending", "user", "admin"]:
request.app.state.config.DEFAULT_USER_ROLE = form_data.DEFAULT_USER_ROLE
2024-02-20 04:44:00 +00:00
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
)
2024-08-19 13:16:49 +00:00
request.app.state.config.ENABLE_MESSAGE_RATING = form_data.ENABLE_MESSAGE_RATING
return {
"SHOW_ADMIN_DETAILS": request.app.state.config.SHOW_ADMIN_DETAILS,
"ENABLE_SIGNUP": request.app.state.config.ENABLE_SIGNUP,
"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,
2024-08-19 13:16:49 +00:00
"ENABLE_MESSAGE_RATING": request.app.state.config.ENABLE_MESSAGE_RATING,
}
2024-03-26 10:22:17 +00:00
class LdapServerConfig(BaseModel):
label: str
host: str
port: Optional[int] = None
2024-11-17 05:07:56 +00:00
attribute_for_username: str = "uid"
app_dn: str
app_dn_password: str
search_base: str
2024-11-17 05:07:56 +00:00
search_filters: str = ""
use_tls: bool = True
certificate_path: Optional[str] = None
2024-11-17 05:07:56 +00:00
ciphers: Optional[str] = "ALL"
@router.get("/admin/config/ldap/server", response_model=LdapServerConfig)
2024-11-17 05:07:56 +00:00
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_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,
2024-11-17 05:07:56 +00:00
"ciphers": request.app.state.config.LDAP_CIPHERS,
}
2024-11-17 05:07:56 +00:00
@router.post("/admin/config/ldap/server")
async def update_ldap_server(
request: Request, form_data: LdapServerConfig, user=Depends(get_admin_user)
):
2024-11-17 05:07:56 +00:00
required_fields = [
"label",
"host",
"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")
if form_data.use_tls and not form_data.certificate_path:
2024-11-17 05:07:56 +00:00
raise HTTPException(
400, detail="TLS is enabled but certificate file path is missing"
)
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
2024-11-17 05:07:56 +00:00
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_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_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,
2024-11-17 05:07:56 +00:00
"ciphers": request.app.state.config.LDAP_CIPHERS,
}
2024-11-17 05:07:56 +00:00
@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}
2024-11-17 05:07:56 +00:00
class LdapConfigForm(BaseModel):
enable_ldap: Optional[bool] = None
2024-11-17 05:07:56 +00:00
@router.post("/admin/config/ldap")
2024-11-17 05:07:56 +00:00
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}
2024-03-26 10:22:17 +00:00
############################
# API Key
############################
# create api key
@router.post("/api_key", response_model=ApiKey)
async def create_api_key_(user=Depends(get_current_user)):
api_key = create_api_key()
2024-04-02 16:27:35 +00:00
success = Users.update_user_api_key_by_id(user.id, api_key)
2024-03-26 10:22:17 +00:00
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)):
2024-04-02 16:27:35 +00:00
success = Users.update_user_api_key_by_id(user.id, None)
2024-03-26 10:22:17 +00:00
return success
# get api key
@router.get("/api_key", response_model=ApiKey)
async def get_api_key(user=Depends(get_current_user)):
2024-04-02 16:27:35 +00:00
api_key = Users.get_user_api_key_by_id(user.id)
2024-03-26 10:22:17 +00:00
if api_key:
return {
"api_key": api_key,
}
else:
raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)