Spaces:
Sleeping
Sleeping
File size: 10,613 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 |
import json
import logging
import string
from enum import Enum
from typing import List, Optional, Tuple, Any, TypedDict, cast, Dict, TypeVar
from overrides import override
from pydantic import SecretStr
import yaml
from chromadb.auth import (
ServerAuthProvider,
ClientAuthProvider,
ServerAuthenticationRequest,
ServerAuthCredentialsProvider,
AuthInfoType,
ClientAuthCredentialsProvider,
ClientAuthResponse,
SecretStrAbstractCredentials,
AbstractCredentials,
SimpleServerAuthenticationResponse,
SimpleUserIdentity,
)
from chromadb.auth.registry import register_provider, resolve_provider
from chromadb.config import System
from chromadb.telemetry.opentelemetry import (
OpenTelemetryGranularity,
trace_method,
)
from chromadb.utils import get_class
T = TypeVar("T")
logger = logging.getLogger(__name__)
__all__ = ["TokenAuthServerProvider", "TokenAuthClientProvider"]
_token_transport_headers = ["Authorization", "X-Chroma-Token"]
class TokenTransportHeader(Enum):
AUTHORIZATION = "Authorization"
X_CHROMA_TOKEN = "X-Chroma-Token"
class TokenAuthClientAuthResponse(ClientAuthResponse):
_token_transport_header: TokenTransportHeader
def __init__(
self,
credentials: SecretStr,
token_transport_header: TokenTransportHeader = TokenTransportHeader.AUTHORIZATION,
) -> None:
self._credentials = credentials
self._token_transport_header = token_transport_header
@override
def get_auth_info_type(self) -> AuthInfoType:
return AuthInfoType.HEADER
@override
def get_auth_info(self) -> Tuple[str, SecretStr]:
if self._token_transport_header == TokenTransportHeader.AUTHORIZATION:
return "Authorization", SecretStr(
f"Bearer {self._credentials.get_secret_value()}"
)
elif self._token_transport_header == TokenTransportHeader.X_CHROMA_TOKEN:
return "X-Chroma-Token", SecretStr(
f"{self._credentials.get_secret_value()}"
)
else:
raise ValueError(
f"Invalid token transport header: {self._token_transport_header}"
)
def check_token(token: str) -> None:
token_str = str(token)
if not all(
c in string.digits + string.ascii_letters + string.punctuation
for c in token_str
):
raise ValueError("Invalid token. Must contain only ASCII letters and digits.")
@register_provider("token_config")
class TokenConfigServerAuthCredentialsProvider(ServerAuthCredentialsProvider):
_token: SecretStr
def __init__(self, system: System) -> None:
super().__init__(system)
system.settings.require("chroma_server_auth_credentials")
token_str = str(system.settings.chroma_server_auth_credentials)
check_token(token_str)
self._token = SecretStr(token_str)
@trace_method(
"TokenConfigServerAuthCredentialsProvider.validate_credentials",
OpenTelemetryGranularity.ALL,
)
@override
def validate_credentials(self, credentials: AbstractCredentials[T]) -> bool:
_creds = cast(Dict[str, SecretStr], credentials.get_credentials())
if "token" not in _creds:
logger.error("Returned credentials do not contain token")
return False
return _creds["token"].get_secret_value() == self._token.get_secret_value()
@override
def get_user_identity(
self, credentials: AbstractCredentials[T]
) -> Optional[SimpleUserIdentity]:
return None
class Token(TypedDict):
token: str
secret: str
class User(TypedDict):
id: str
role: str
tenant: Optional[str]
databases: Optional[List[str]]
tokens: List[Token]
@register_provider("user_token_config")
class UserTokenConfigServerAuthCredentialsProvider(ServerAuthCredentialsProvider):
_users: List[User]
_token_user_mapping: Dict[str, str] # reverse mapping of token to user
def __init__(self, system: System) -> None:
super().__init__(system)
if system.settings.chroma_server_auth_credentials_file:
system.settings.require("chroma_server_auth_credentials_file")
user_file = str(system.settings.chroma_server_auth_credentials_file)
with open(user_file) as f:
self._users = cast(List[User], yaml.safe_load(f)["users"])
elif system.settings.chroma_server_auth_credentials:
self._users = cast(
List[User], json.loads(system.settings.chroma_server_auth_credentials)
)
self._token_user_mapping = {}
for user in self._users:
for t in user["tokens"]:
token_str = t["token"]
check_token(token_str)
if token_str in self._token_user_mapping:
raise ValueError("Token already exists for another user")
self._token_user_mapping[token_str] = user["id"]
def find_user_by_id(self, _user_id: str) -> Optional[User]:
for user in self._users:
if user["id"] == _user_id:
return user
return None
@override
def validate_credentials(self, credentials: AbstractCredentials[T]) -> bool:
_creds = cast(Dict[str, SecretStr], credentials.get_credentials())
if "token" not in _creds:
logger.error("Returned credentials do not contain token")
return False
return _creds["token"].get_secret_value() in self._token_user_mapping.keys()
@override
def get_user_identity(
self, credentials: AbstractCredentials[T]
) -> Optional[SimpleUserIdentity]:
_creds = cast(Dict[str, SecretStr], credentials.get_credentials())
if "token" not in _creds:
logger.error("Returned credentials do not contain token")
return None
# below is just simple identity mapping and may need future work for more
# complex use cases
_user_id = self._token_user_mapping[_creds["token"].get_secret_value()]
_user = self.find_user_by_id(_user_id)
return SimpleUserIdentity(
user_id=_user_id,
tenant=_user["tenant"] if _user and "tenant" in _user else "*",
databases=_user["databases"] if _user and "databases" in _user else ["*"],
)
class TokenAuthCredentials(SecretStrAbstractCredentials):
_token: SecretStr
def __init__(self, token: SecretStr) -> None:
self._token = token
@override
def get_credentials(self) -> Dict[str, SecretStr]:
return {"token": self._token}
@staticmethod
def from_header(
header: str,
token_transport_header: TokenTransportHeader = TokenTransportHeader.AUTHORIZATION,
) -> "TokenAuthCredentials":
"""
Extracts token from header and returns a TokenAuthCredentials object.
"""
if token_transport_header == TokenTransportHeader.AUTHORIZATION:
header = header.replace("Bearer ", "")
header = header.strip()
token = header
elif token_transport_header == TokenTransportHeader.X_CHROMA_TOKEN:
header = header.strip()
token = header
else:
raise ValueError(
f"Invalid token transport header: {token_transport_header}"
)
return TokenAuthCredentials(SecretStr(token))
@register_provider("token")
class TokenAuthServerProvider(ServerAuthProvider):
_credentials_provider: ServerAuthCredentialsProvider
_token_transport_header: TokenTransportHeader = TokenTransportHeader.AUTHORIZATION
def __init__(self, system: System) -> None:
super().__init__(system)
self._settings = system.settings
system.settings.require("chroma_server_auth_credentials_provider")
self._credentials_provider = cast(
ServerAuthCredentialsProvider,
system.require(
resolve_provider(
str(system.settings.chroma_server_auth_credentials_provider),
ServerAuthCredentialsProvider,
)
),
)
if system.settings.chroma_server_auth_token_transport_header:
self._token_transport_header = TokenTransportHeader[
str(system.settings.chroma_server_auth_token_transport_header)
]
@trace_method("TokenAuthServerProvider.authenticate", OpenTelemetryGranularity.ALL)
@override
def authenticate(
self, request: ServerAuthenticationRequest[Any]
) -> SimpleServerAuthenticationResponse:
try:
_auth_header = request.get_auth_info(
AuthInfoType.HEADER, self._token_transport_header.value
)
_token_creds = TokenAuthCredentials.from_header(
_auth_header, self._token_transport_header
)
return SimpleServerAuthenticationResponse(
self._credentials_provider.validate_credentials(_token_creds),
self._credentials_provider.get_user_identity(_token_creds),
)
except Exception as e:
logger.error(f"TokenAuthServerProvider.authenticate failed: {repr(e)}")
return SimpleServerAuthenticationResponse(False, None)
@register_provider("token")
class TokenAuthClientProvider(ClientAuthProvider):
_credentials_provider: ClientAuthCredentialsProvider[Any]
_token_transport_header: TokenTransportHeader = TokenTransportHeader.AUTHORIZATION
def __init__(self, system: System) -> None:
super().__init__(system)
self._settings = system.settings
system.settings.require("chroma_client_auth_credentials_provider")
self._credentials_provider = system.require(
get_class(
str(system.settings.chroma_client_auth_credentials_provider),
ClientAuthCredentialsProvider,
)
)
_token = self._credentials_provider.get_credentials()
check_token(_token.get_secret_value())
if system.settings.chroma_client_auth_token_transport_header:
self._token_transport_header = TokenTransportHeader[
str(system.settings.chroma_client_auth_token_transport_header)
]
@trace_method("TokenAuthClientProvider.authenticate", OpenTelemetryGranularity.ALL)
@override
def authenticate(self) -> ClientAuthResponse:
_token = self._credentials_provider.get_credentials()
return TokenAuthClientAuthResponse(_token, self._token_transport_header)
|