Spaces:
Sleeping
Sleeping
File size: 12,797 Bytes
287a0bc |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
import chromadb
from contextvars import ContextVar
from functools import wraps
import logging
from typing import Callable, Optional, Dict, List, Union, cast, Any
from overrides import override
from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
from starlette.requests import Request
from starlette.responses import Response
from starlette.types import ASGIApp
from chromadb.config import DEFAULT_TENANT, System
from chromadb.auth import (
AuthorizationContext,
AuthorizationRequestContext,
AuthzAction,
AuthzResource,
AuthzResourceActions,
AuthzUser,
DynamicAuthzResource,
ServerAuthenticationRequest,
AuthInfoType,
ServerAuthenticationResponse,
ServerAuthProvider,
ChromaAuthMiddleware,
ChromaAuthzMiddleware,
ServerAuthorizationProvider,
)
from chromadb.auth.registry import resolve_provider
from chromadb.errors import AuthorizationError
from chromadb.server.fastapi.utils import fastapi_json_response
from chromadb.telemetry.opentelemetry import (
OpenTelemetryGranularity,
trace_method,
)
logger = logging.getLogger(__name__)
class FastAPIServerAuthenticationRequest(ServerAuthenticationRequest[Optional[str]]):
def __init__(self, request: Request) -> None:
self._request = request
@override
def get_auth_info(
self, auth_info_type: AuthInfoType, auth_info_id: str
) -> Optional[str]:
if auth_info_type == AuthInfoType.HEADER:
return str(self._request.headers[auth_info_id])
elif auth_info_type == AuthInfoType.COOKIE:
return str(self._request.cookies[auth_info_id])
elif auth_info_type == AuthInfoType.URL:
return str(self._request.query_params[auth_info_id])
elif auth_info_type == AuthInfoType.METADATA:
raise ValueError("Metadata not supported for FastAPI")
else:
raise ValueError(f"Unknown auth info type: {auth_info_type}")
class FastAPIServerAuthenticationResponse(ServerAuthenticationResponse):
_auth_success: bool
def __init__(self, auth_success: bool) -> None:
self._auth_success = auth_success
@override
def success(self) -> bool:
return self._auth_success
class FastAPIChromaAuthMiddleware(ChromaAuthMiddleware):
_auth_provider: ServerAuthProvider
def __init__(self, system: System) -> None:
super().__init__(system)
self._system = system
self._settings = system.settings
self._settings.require("chroma_server_auth_provider")
self._ignore_auth_paths: Dict[
str, List[str]
] = self._settings.chroma_server_auth_ignore_paths
if self._settings.chroma_server_auth_provider:
logger.debug(
f"Server Auth Provider: {self._settings.chroma_server_auth_provider}"
)
_cls = resolve_provider(
self._settings.chroma_server_auth_provider, ServerAuthProvider
)
self._auth_provider = cast(ServerAuthProvider, self.require(_cls))
@trace_method(
"FastAPIChromaAuthMiddleware.authenticate", OpenTelemetryGranularity.ALL
)
@override
def authenticate(
self, request: ServerAuthenticationRequest[Any]
) -> ServerAuthenticationResponse:
return self._auth_provider.authenticate(request)
@trace_method(
"FastAPIChromaAuthMiddleware.ignore_operation", OpenTelemetryGranularity.ALL
)
@override
def ignore_operation(self, verb: str, path: str) -> bool:
if (
path in self._ignore_auth_paths.keys()
and verb.upper() in self._ignore_auth_paths[path]
):
logger.debug(f"Skipping auth for path {path} and method {verb}")
return True
return False
@override
def instrument_server(self, app: ASGIApp) -> None:
# We can potentially add an `/auth` endpoint to the server to allow for more
# complex auth flows
raise NotImplementedError("Not implemented yet")
class FastAPIChromaAuthMiddlewareWrapper(BaseHTTPMiddleware): # type: ignore
def __init__(
self, app: ASGIApp, auth_middleware: FastAPIChromaAuthMiddleware
) -> None:
super().__init__(app)
self._middleware = auth_middleware
try:
self._middleware.instrument_server(app)
except NotImplementedError:
pass
@trace_method(
"FastAPIChromaAuthMiddlewareWrapper.dispatch", OpenTelemetryGranularity.ALL
)
@override
async def dispatch(
self, request: Request, call_next: RequestResponseEndpoint
) -> Response:
if self._middleware.ignore_operation(request.method, request.url.path):
logger.debug(
f"Skipping auth for path {request.url.path} and method {request.method}"
)
return await call_next(request)
response = self._middleware.authenticate(
FastAPIServerAuthenticationRequest(request)
)
if not response or not response.success():
return fastapi_json_response(AuthorizationError("Unauthorized"))
request.state.user_identity = response.get_user_identity()
return await call_next(request)
request_var: ContextVar[Optional[Request]] = ContextVar("request_var", default=None)
authz_provider: ContextVar[Optional[ServerAuthorizationProvider]] = ContextVar(
"authz_provider", default=None
)
# This needs to be module-level config, since it's used in authz_context() where we
# don't have a system (so don't have easy access to the settings).
overwrite_singleton_tenant_database_access_from_auth: bool = False
def set_overwrite_singleton_tenant_database_access_from_auth(
overwrite: bool = False,
) -> None:
global overwrite_singleton_tenant_database_access_from_auth
overwrite_singleton_tenant_database_access_from_auth = overwrite
def authz_context(
action: Union[str, AuthzResourceActions, List[str], List[AuthzResourceActions]],
resource: Union[AuthzResource, DynamicAuthzResource],
) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
def decorator(f: Callable[..., Any]) -> Callable[..., Any]:
@wraps(f)
def wrapped(*args: Any, **kwargs: Dict[Any, Any]) -> Any:
_dynamic_kwargs = {
"api": args[0]._api,
"function": f,
"function_args": args,
"function_kwargs": kwargs,
}
request = request_var.get()
if request:
_provider = authz_provider.get()
a_list: List[Union[str, AuthzAction]] = []
if not isinstance(action, list):
a_list = [action]
else:
a_list = cast(List[Union[str, AuthzAction]], action)
a_authz_responses = []
for a in a_list:
_action = a if isinstance(a, AuthzAction) else AuthzAction(id=a)
_resource = (
resource
if isinstance(resource, AuthzResource)
else resource.to_authz_resource(**_dynamic_kwargs)
)
_context = AuthorizationContext(
user=AuthzUser(
id=request.state.user_identity.get_user_id()
if hasattr(request.state, "user_identity")
else "Anonymous",
tenant=request.state.user_identity.get_user_tenant()
if hasattr(request.state, "user_identity")
else DEFAULT_TENANT,
attributes=request.state.user_identity.get_user_attributes()
if hasattr(request.state, "user_identity")
else {},
),
resource=_resource,
action=_action,
)
if _provider:
a_authz_responses.append(_provider.authorize(_context))
if not any(a_authz_responses):
raise AuthorizationError("Unauthorized")
# In a multi-tenant environment, we may want to allow users to send
# requests without configuring a tenant and DB. If so, they can set
# the request tenant and DB however they like and we simply overwrite it.
if overwrite_singleton_tenant_database_access_from_auth:
desired_tenant = request.state.user_identity.get_user_tenant()
if desired_tenant and "tenant" in kwargs:
if isinstance(kwargs["tenant"], str):
kwargs["tenant"] = desired_tenant
elif isinstance(
kwargs["tenant"], chromadb.server.fastapi.types.CreateTenant
):
kwargs["tenant"].name = desired_tenant
databases = request.state.user_identity.get_user_databases()
if databases and len(databases) == 1 and "database" in kwargs:
desired_database = databases[0]
if isinstance(kwargs["database"], str):
kwargs["database"] = desired_database
elif isinstance(
kwargs["database"],
chromadb.server.fastapi.types.CreateDatabase,
):
kwargs["database"].name = desired_database
return f(*args, **kwargs)
return wrapped
return decorator
class FastAPIAuthorizationRequestContext(AuthorizationRequestContext[Request]):
_request: Request
def __init__(self, request: Request) -> None:
self._request = request
pass
@override
def get_request(self) -> Request:
return self._request
class FastAPIChromaAuthzMiddleware(ChromaAuthzMiddleware[ASGIApp, Request]):
_authz_provider: ServerAuthorizationProvider
def __init__(self, system: System) -> None:
super().__init__(system)
self._system = system
self._settings = system.settings
self._settings.require("chroma_server_authz_provider")
self._ignore_auth_paths: Dict[
str, List[str]
] = self._settings.chroma_server_authz_ignore_paths
if self._settings.chroma_server_authz_provider:
logger.debug(
"Server Authorization Provider: "
f"{self._settings.chroma_server_authz_provider}"
)
_cls = resolve_provider(
self._settings.chroma_server_authz_provider, ServerAuthorizationProvider
)
self._authz_provider = cast(ServerAuthorizationProvider, self.require(_cls))
@override
def pre_process(self, request: AuthorizationRequestContext[Request]) -> None:
rest_request = request.get_request()
request_var.set(rest_request)
authz_provider.set(self._authz_provider)
@override
def ignore_operation(self, verb: str, path: str) -> bool:
if (
path in self._ignore_auth_paths.keys()
and verb.upper() in self._ignore_auth_paths[path]
):
logger.debug(f"Skipping authz for path {path} and method {verb}")
return True
return False
@override
def instrument_server(self, app: ASGIApp) -> None:
# We can potentially add an `/auth` endpoint to the server to allow
# for more complex auth flows
raise NotImplementedError("Not implemented yet")
class FastAPIChromaAuthzMiddlewareWrapper(BaseHTTPMiddleware): # type: ignore
def __init__(
self, app: ASGIApp, authz_middleware: FastAPIChromaAuthzMiddleware
) -> None:
super().__init__(app)
self._middleware = authz_middleware
try:
self._middleware.instrument_server(app)
except NotImplementedError:
pass
@trace_method(
"FastAPIChromaAuthzMiddlewareWrapper.dispatch", OpenTelemetryGranularity.ALL
)
@override
async def dispatch(
self, request: Request, call_next: RequestResponseEndpoint
) -> Response:
if self._middleware.ignore_operation(request.method, request.url.path):
logger.debug(
f"Skipping authz for path {request.url.path} "
"and method {request.method}"
)
return await call_next(request)
self._middleware.pre_process(FastAPIAuthorizationRequestContext(request))
return await call_next(request)
|