auths.py 14 KB
Newer Older
1
2
import logging

3
4
from authlib.integrations.starlette_client import OAuth
from authlib.oidc.core import UserInfo
5
from fastapi import Request, UploadFile, File
liu.vaayne's avatar
liu.vaayne committed
6
from fastapi import Depends, HTTPException, status
7

liu.vaayne's avatar
liu.vaayne committed
8
from fastapi import APIRouter
9
from pydantic import BaseModel
Timothy J. Baek's avatar
Timothy J. Baek committed
10
import re
Timothy J. Baek's avatar
Timothy J. Baek committed
11
import uuid
12
13
import csv

14
from starlette.responses import RedirectResponse
15

16
from apps.webui.models.auths import (
17
18
    SigninForm,
    SignupForm,
Timothy J. Baek's avatar
Timothy J. Baek committed
19
    AddUserForm,
20
    UpdateProfileForm,
21
    UpdatePasswordForm,
22
23
24
    UserResponse,
    SigninResponse,
    Auths,
Timothy J. Baek's avatar
Timothy J. Baek committed
25
    ApiKey,
26
)
27
from apps.webui.models.users import Users
28

Timothy J. Baek's avatar
Timothy J. Baek committed
29
30
31
32
33
from utils.utils import (
    get_password_hash,
    get_current_user,
    get_admin_user,
    create_token,
Timothy J. Baek's avatar
Timothy J. Baek committed
34
    create_api_key,
Timothy J. Baek's avatar
Timothy J. Baek committed
35
)
Timothy J. Baek's avatar
Timothy J. Baek committed
36
from utils.misc import parse_duration, validate_email_format
Timothy J. Baek's avatar
Timothy J. Baek committed
37
38
from utils.webhook import post_webhook
from constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
39
40
41
42
43
44
from config import (
    WEBUI_AUTH,
    WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
    OAUTH_PROVIDERS,
    ENABLE_OAUTH_SIGNUP,
)
45

Timothy J. Baek's avatar
Timothy J. Baek committed
46
47
router = APIRouter()

48
49
50
51
52
############################
# GetSessionUser
############################


53
@router.get("/", response_model=UserResponse)
54
55
56
57
58
59
60
61
async def get_session_user(user=Depends(get_current_user)):
    return {
        "id": user.id,
        "email": user.email,
        "name": user.name,
        "role": user.role,
        "profile_image_url": user.profile_image_url,
    }
62
63


64
############################
65
# Update Profile
66
67
68
69
############################


@router.post("/update/profile", response_model=UserResponse)
70
71
async def update_profile(
    form_data: UpdateProfileForm, session_user=Depends(get_current_user)
72
73
):
    if session_user:
74
75
76
        user = Users.update_user_by_id(
            session_user.id,
            {"profile_image_url": form_data.profile_image_url, "name": form_data.name},
77
78
79
80
81
82
83
84
85
        )
        if user:
            return user
        else:
            raise HTTPException(400, detail=ERROR_MESSAGES.DEFAULT())
    else:
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)


86
87
88
89
90
############################
# Update Password
############################


91
@router.post("/update/password", response_model=bool)
92
93
94
async def update_password(
    form_data: UpdatePasswordForm, session_user=Depends(get_current_user)
):
95
96
    if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
        raise HTTPException(400, detail=ERROR_MESSAGES.ACTION_PROHIBITED)
97
98
    if session_user:
        user = Auths.authenticate_user(session_user.email, form_data.password)
99

100
101
        if user:
            hashed = get_password_hash(form_data.new_password)
Timothy J. Baek's avatar
Timothy J. Baek committed
102
            return Auths.update_user_password_by_id(user.id, hashed)
103
104
        else:
            raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_PASSWORD)
105
106
107
108
    else:
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)


109
110
111
112
113
114
############################
# SignIn
############################


@router.post("/signin", response_model=SigninResponse)
Timothy J. Baek's avatar
Timothy J. Baek committed
115
async def signin(request: Request, form_data: SigninForm):
116
117
    if WEBUI_AUTH_TRUSTED_EMAIL_HEADER:
        if WEBUI_AUTH_TRUSTED_EMAIL_HEADER not in request.headers:
Timothy J. Baek's avatar
Timothy J. Baek committed
118
119
            raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_TRUSTED_HEADER)

120
121
        trusted_email = request.headers[WEBUI_AUTH_TRUSTED_EMAIL_HEADER].lower()
        if not Users.get_user_by_email(trusted_email.lower()):
Timothy J. Baek's avatar
Timothy J. Baek committed
122
123
124
125
126
127
            await signup(
                request,
                SignupForm(
                    email=trusted_email, password=str(uuid.uuid4()), name=trusted_email
                ),
            )
128
        user = Auths.authenticate_user_by_trusted_header(trusted_email)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
129
130
131
    elif WEBUI_AUTH == False:
        admin_email = "admin@localhost"
        admin_password = "admin"
Timothy J. Baek's avatar
Timothy J. Baek committed
132

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
133
134
135
136
137
        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)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
138

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
139
140
141
142
            await signup(
                request,
                SignupForm(email=admin_email, password=admin_password, name="User"),
            )
143

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
144
145
146
            user = Auths.authenticate_user(admin_email.lower(), admin_password)
    else:
        user = Auths.authenticate_user(form_data.email.lower(), form_data.password)
147
148

    if user:
Timothy J. Baek's avatar
Timothy J. Baek committed
149
150
        token = create_token(
            data={"id": user.id},
151
            expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
Timothy J. Baek's avatar
Timothy J. Baek committed
152
        )
153
154
155
156
157
158
159
160

        return {
            "token": token,
            "token_type": "Bearer",
            "id": user.id,
            "email": user.email,
            "name": user.name,
            "role": user.role,
Timothy J. Baek's avatar
Timothy J. Baek committed
161
            "profile_image_url": user.profile_image_url,
162
163
        }
    else:
Timothy J. Baek's avatar
Timothy J. Baek committed
164
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
165
166
167
168
169
170
171
172


############################
# SignUp
############################


@router.post("/signup", response_model=SigninResponse)
173
async def signup(request: Request, form_data: SignupForm):
174
    if not request.app.state.config.ENABLE_SIGNUP and WEBUI_AUTH:
Timothy J. Baek's avatar
Timothy J. Baek committed
175
176
177
        raise HTTPException(
            status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
        )
178

179
    if not validate_email_format(form_data.email.lower()):
Timothy J. Baek's avatar
Timothy J. Baek committed
180
181
182
        raise HTTPException(
            status.HTTP_400_BAD_REQUEST, detail=ERROR_MESSAGES.INVALID_EMAIL_FORMAT
        )
183

184
185
    if Users.get_user_by_email(form_data.email.lower()):
        raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
186

187
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
188
189
190
        role = (
            "admin"
            if Users.get_num_users() == 0
191
            else request.app.state.config.DEFAULT_USER_ROLE
Timothy J. Baek's avatar
Timothy J. Baek committed
192
        )
193
        hashed = get_password_hash(form_data.password)
194
        user = Auths.insert_new_auth(
Danny Liu's avatar
Danny Liu committed
195
196
197
198
199
            form_data.email.lower(),
            hashed,
            form_data.name,
            form_data.profile_image_url,
            role,
200
        )
201

202
        if user:
Timothy J. Baek's avatar
Timothy J. Baek committed
203
204
            token = create_token(
                data={"id": user.id},
205
                expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
Timothy J. Baek's avatar
Timothy J. Baek committed
206
            )
207
208
            # response.set_cookie(key='token', value=token, httponly=True)

209
            if request.app.state.config.WEBHOOK_URL:
Timothy J. Baek's avatar
Timothy J. Baek committed
210
                post_webhook(
211
                    request.app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
212
                    WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
Timothy J. Baek's avatar
Timothy J. Baek committed
213
214
215
216
217
218
219
                    {
                        "action": "signup",
                        "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
                        "user": user.model_dump_json(exclude_none=True),
                    },
                )

220
221
222
223
224
225
226
227
228
229
            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:
230
            raise HTTPException(500, detail=ERROR_MESSAGES.CREATE_USER_ERROR)
Timothy J. Baek's avatar
Timothy J. Baek committed
231
232
233
234
235
236
237
238
239
240
    except Exception as err:
        raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))


############################
# AddUser
############################


@router.post("/add", response_model=SigninResponse)
241
async def add_user(form_data: AddUserForm, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
242
243
244
245
246
247
248
249
250
251

    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:
252
253

        print(form_data)
Timothy J. Baek's avatar
Timothy J. Baek committed
254
255
256
257
258
259
        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,
260
            form_data.role,
Timothy J. Baek's avatar
Timothy J. Baek committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
        )

        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)
276
    except Exception as err:
277
278
        raise HTTPException(500, detail=ERROR_MESSAGES.DEFAULT(err))

279
280
281
282
283
284
285

############################
# ToggleSignUp
############################


@router.get("/signup/enabled", response_model=bool)
286
async def get_sign_up_status(request: Request, user=Depends(get_admin_user)):
287
    return request.app.state.config.ENABLE_SIGNUP
288
289
290


@router.get("/signup/enabled/toggle", response_model=bool)
291
async def toggle_sign_up(request: Request, user=Depends(get_admin_user)):
292
293
    request.app.state.config.ENABLE_SIGNUP = not request.app.state.config.ENABLE_SIGNUP
    return request.app.state.config.ENABLE_SIGNUP
Timothy J. Baek's avatar
Timothy J. Baek committed
294
295
296
297
298
299
300
301
302


############################
# Default User Role
############################


@router.get("/signup/user/role")
async def get_default_user_role(request: Request, user=Depends(get_admin_user)):
303
    return request.app.state.config.DEFAULT_USER_ROLE
Timothy J. Baek's avatar
Timothy J. Baek committed
304
305
306
307
308
309
310
311
312
313
314


class UpdateRoleForm(BaseModel):
    role: str


@router.post("/signup/user/role")
async def update_default_user_role(
    request: Request, form_data: UpdateRoleForm, user=Depends(get_admin_user)
):
    if form_data.role in ["pending", "user", "admin"]:
315
316
        request.app.state.config.DEFAULT_USER_ROLE = form_data.role
    return request.app.state.config.DEFAULT_USER_ROLE
Timothy J. Baek's avatar
Timothy J. Baek committed
317
318
319
320
321
322
323
324
325


############################
# JWT Expiration
############################


@router.get("/token/expires")
async def get_token_expires_duration(request: Request, user=Depends(get_admin_user)):
326
    return request.app.state.config.JWT_EXPIRES_IN
Timothy J. Baek's avatar
Timothy J. Baek committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342


class UpdateJWTExpiresDurationForm(BaseModel):
    duration: str


@router.post("/token/expires/update")
async def update_token_expires_duration(
    request: Request,
    form_data: UpdateJWTExpiresDurationForm,
    user=Depends(get_admin_user),
):
    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.duration):
343
344
        request.app.state.config.JWT_EXPIRES_IN = form_data.duration
        return request.app.state.config.JWT_EXPIRES_IN
Timothy J. Baek's avatar
Timothy J. Baek committed
345
    else:
346
        return request.app.state.config.JWT_EXPIRES_IN
liu.vaayne's avatar
liu.vaayne committed
347
348
349
350
351
352
353
354
355
356
357


############################
# 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()
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
358
    success = Users.update_user_api_key_by_id(user.id, api_key)
liu.vaayne's avatar
liu.vaayne committed
359
360
361
362
363
364
365
366
367
368
369
    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)):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
370
    success = Users.update_user_api_key_by_id(user.id, None)
liu.vaayne's avatar
liu.vaayne committed
371
372
373
374
375
376
    return success


# get api key
@router.get("/api_key", response_model=ApiKey)
async def get_api_key(user=Depends(get_current_user)):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
377
    api_key = Users.get_user_api_key_by_id(user.id)
liu.vaayne's avatar
liu.vaayne committed
378
379
380
381
382
383
    if api_key:
        return {
            "api_key": api_key,
        }
    else:
        raise HTTPException(404, detail=ERROR_MESSAGES.API_KEY_NOT_FOUND)
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462


############################
# OAuth Login & Callback
############################

oauth = OAuth()

for provider_name, provider_config in OAUTH_PROVIDERS.items():
    oauth.register(
        name=provider_name,
        client_id=provider_config["client_id"],
        client_secret=provider_config["client_secret"],
        server_metadata_url=provider_config["server_metadata_url"],
        client_kwargs={
            "scope": provider_config["scope"],
        },
    )


@router.get("/oauth/{provider}/login")
async def oauth_login(provider: str, request: Request):
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    redirect_uri = request.url_for("oauth_callback", provider=provider)
    return await oauth.create_client(provider).authorize_redirect(request, redirect_uri)


@router.get("/oauth/{provider}/callback")
async def oauth_callback(provider: str, request: Request):
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
    token = await client.authorize_access_token(request)
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"

    # Check if the user exists
    user = Users.get_user_by_oauth_sub(provider_sub)

    if not user:
        # If the user does not exist, create a new user if signup is enabled
        if ENABLE_OAUTH_SIGNUP.value:
            user = Auths.insert_new_auth(
                email=user_data.get("email", "").lower(),
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
                name=user_data.get("name", "User"),
                profile_image_url=user_data.get("picture", "/user.png"),
                role=request.app.state.config.DEFAULT_USER_ROLE,
                oauth_sub=provider_sub,
            )

            if request.app.state.config.WEBHOOK_URL:
                post_webhook(
                    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),
                    },
                )
        else:
            raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)

    jwt_token = create_token(
        data={"id": user.id},
        expires_delta=parse_duration(request.app.state.config.JWT_EXPIRES_IN),
    )

    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)