zhuchaowe/maxkb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Access can only be granted after OpenAPI authentication (#3599)

Browse Source
This commit is contained in:
shaohuzhang1 2025-07-15 13:49:33 +08:00 committed by GitHub
parent 2520461544
commit c2f52d0759
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 55 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
apps/common/init/init_doc.py
View File

@ -18,15 +18,14 @@ chat_api_prefix = CONFIG.get_chat_path()[1:] + '/api/'
def init_app_doc(system_urlpatterns): def init_app_doc(system_urlpatterns):
system_urlpatterns += [ system_urlpatterns += [
path('schema/', SpectacularAPIView.as_view(), name='schema'), # schema的配置文件的路由，下面两个ui也是根据这个配置文件来生成的 path('doc/schema/', SpectacularAPIView.as_view(), name='schema'), # schema的配置文件的路由，下面两个ui也是根据这个配置文件来生成的
path('doc/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'), # swagger-ui的路由 path('doc/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'), # swagger-ui的路由
path('redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'), # redoc的路由
] ]
def init_chat_doc(system_urlpatterns, chat_urlpatterns): def init_chat_doc(system_urlpatterns, chat_urlpatterns):
system_urlpatterns += [ system_urlpatterns += [
path('doc_chat_schema/', path('doc_chat/schema/',
SpectacularAPIView.as_view(patterns=[ SpectacularAPIView.as_view(patterns=[
URLPattern(pattern=f'{chat_api_prefix}{str(url.pattern)}', callback=url.callback, URLPattern(pattern=f'{chat_api_prefix}{str(url.pattern)}', callback=url.callback,
default_args=url.default_args, default_args=url.default_args,
@ -34,7 +33,6 @@ def init_chat_doc(system_urlpatterns, chat_urlpatterns):
['chat', 'open', 'profile'].__contains__(url.name)]), ['chat', 'open', 'profile'].__contains__(url.name)]),
name='chat_schema'), # schema的配置文件的路由，下面两个ui也是根据这个配置文件来生成的 name='chat_schema'), # schema的配置文件的路由，下面两个ui也是根据这个配置文件来生成的
path('doc_chat/', SpectacularSwaggerView.as_view(url_name='chat_schema'), name='swagger-ui'), # swagger-ui的路由 path('doc_chat/', SpectacularSwaggerView.as_view(url_name='chat_schema'), name='swagger-ui'), # swagger-ui的路由
path('redoc_chat/', SpectacularRedocView.as_view(url_name='chat_schema'), name='redoc'), # redoc的路由
] ]

42
apps/common/middleware/doc_headers_middleware.py
View File

@ -6,9 +6,13 @@
@date：2024/3/13 18:26 @date：2024/3/13 18:26
@desc: @desc:
""" """
from django.http import HttpResponse from django.http import HttpResponse
from django.utils.deprecation import MiddlewareMixin from django.utils.deprecation import MiddlewareMixin
from common.auth import TokenDetails, handles
from maxkb.const import CONFIG
content = """ content = """
<!doctype html> <!doctype html>
<html lang="en"> <html lang="en">
@ -18,18 +22,28 @@ content = """
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title> <title>Document</title>
<script> <script>
function setCookie(name, value, days) {
var expires = "";
if (days) {
var date = new Date();
date.setTime(date.getTime() + (days*2));
expires = "; expires=" + date.toUTCString();
}
document.cookie = name + "=" + (value || "") + expires + "; path=/";
}
window.onload = () => { window.onload = () => {
var xhr = new XMLHttpRequest() var xhr = new XMLHttpRequest()
xhr.open('GET', '/api/user', true) xhr.open('GET', '/api/user/profile', true)
xhr.setRequestHeader('Content-Type', 'application/json') xhr.setRequestHeader('Content-Type', 'application/json')
const token = localStorage.getItem('token') const token = localStorage.getItem('token')
const pathname = window.location.pathname const pathname = window.location.pathname
if (token) { if (token) {
xhr.setRequestHeader('Authorization', token) xhr.setRequestHeader('Authorization', 'Bearer '+token)
xhr.onreadystatechange = function () { xhr.onreadystatechange = function () {
if (xhr.readyState === 4) { if (xhr.readyState === 4) {
if (xhr.status === 200) { if (xhr.status === 200) {
setCookie("Authorization",'Bearer '+token)
window.location.href = pathname window.location.href = pathname
} }
if (xhr.status === 401) { if (xhr.status === 401) {
@ -48,15 +62,27 @@ content = """
<body></body> <body></body>
</html> </html>
""" """.replace("/api/user/profile", CONFIG.get_admin_path() + '/api/user/profile').replace('/admin/login',
CONFIG.get_admin_path() + '/login')
class DocHeadersMiddleware(MiddlewareMixin): class DocHeadersMiddleware(MiddlewareMixin):
def process_response(self, request, response): def process_response(self, request, response):
if request.path.startswith('/doc/') or request.path.startswith('/doc/chat/'): if request.path.startswith('/doc/') or request.path.startswith('/doc_chat/'):
HTTP_REFERER = request.META.get('HTTP_REFERER') auth = request.COOKIES.get('Authorization')
if HTTP_REFERER is None: if auth is None:
return HttpResponse(content) return HttpResponse(content)
if HTTP_REFERER == request._current_scheme_host + request.path: else:
return response if not auth.startswith("Bearer "):
return HttpResponse(content)
try:
token = auth[7:]
token_details = TokenDetails(token)
for handle in handles:
if handle.support(request, token, token_details.get_token_details):
handle.handle(request, token, token_details.get_token_details)
return response
return HttpResponse(content)
except Exception as e:
return HttpResponse(content)
return response return response

19
apps/maxkb/settings/base.py
View File

@ -100,6 +100,19 @@ TEMPLATES = [
], ],
}, },
}, },
{"NAME": "DOC",
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': ["apps/static/drf_spectacular_sidecar"],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
] ]
SPECTACULAR_SETTINGS = { SPECTACULAR_SETTINGS = {
'TITLE': 'MaxKB API', 'TITLE': 'MaxKB API',
@ -107,9 +120,9 @@ SPECTACULAR_SETTINGS = {
'VERSION': 'v2', 'VERSION': 'v2',
'SERVE_INCLUDE_SCHEMA': False, 'SERVE_INCLUDE_SCHEMA': False,
# OTHER SETTINGS # OTHER SETTINGS
'SWAGGER_UI_DIST': 'SIDECAR', # shorthand to use the sidecar instead 'SWAGGER_UI_DIST': '/doc/swagger-ui-dist', # shorthand to use the sidecar instead
'SWAGGER_UI_FAVICON_HREF': 'SIDECAR', 'SWAGGER_UI_FAVICON_HREF': '/doc/swagger-ui-dist/favicon-32x32.png',
'REDOC_DIST': 'SIDECAR', 'REDOC_DIST': '/doc/redoc',
'SECURITY_DEFINITIONS': { 'SECURITY_DEFINITIONS': {
'Bearer': { 'Bearer': {
'type': 'apiKey', 'type': 'apiKey',

7
apps/maxkb/urls.py
View File

@ -49,15 +49,12 @@ urlpatterns = [
path(f'{chat_ui_prefix[1:]}/', include('oss.retrieval_urls')), path(f'{chat_ui_prefix[1:]}/', include('oss.retrieval_urls')),
] ]
init_doc(urlpatterns, chat_urlpatterns) init_doc(urlpatterns, chat_urlpatterns)
urlpatterns.append(
re_path(r'^static/(?P<path>.*)$', static.serve, {'document_root': settings.STATIC_ROOT}, name='static'),
)
def pro(): def pro():
# 暴露静态主要是swagger资源
urlpatterns.append( urlpatterns.append(
re_path(r'^static/(?P<path>.*)$', static.serve, {'document_root': settings.STATIC_ROOT}, name='static'), re_path(r'^doc/(?P<path>.*)$', static.serve,
{'document_root': os.path.join(settings.STATIC_ROOT, "drf_spectacular_sidecar")}, name='doc'),
) )
# 暴露ui静态资源 # 暴露ui静态资源
urlpatterns.append( urlpatterns.append(

2
apps/users/views/login.py
View File

@ -61,7 +61,7 @@ class Logout(APIView):
get_operation_object=lambda r, k: {'name': r.user.username}) get_operation_object=lambda r, k: {'name': r.user.username})
def post(self, request: Request): def post(self, request: Request):
version, get_key = Cache_Version.TOKEN.value version, get_key = Cache_Version.TOKEN.value
cache.delete(get_key(token=request.auth), version=version) cache.delete(get_key(token=request.META.get('HTTP_AUTHORIZATION')[7:]), version=version)
return result.success(True) return result.success(True)