mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-07-27 06:28:50 +00:00
21bae296f2
# What does this PR do? - Added ability to specify `required_scope` when declaring an API. This is part of the `@webmethod` decorator. - If auth is enabled, a user can access an API only if `user.attributes['scope']` includes the `required_scope` - We add `required_scope='telemetry.read'` to the telemetry read APIs. ## Test Plan CI with added tests 1. Enable server.auth with github token 2. Observe `client.telemetry.query_traces()` returns 403
115 lines
3.6 KiB
Python
115 lines
3.6 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
import contextvars
|
|
import json
|
|
import logging
|
|
from contextlib import AbstractContextManager
|
|
from typing import Any
|
|
|
|
from llama_stack.distribution.datatypes import User
|
|
|
|
from .utils.dynamic import instantiate_class_type
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
# Context variable for request provider data and auth attributes
|
|
PROVIDER_DATA_VAR = contextvars.ContextVar("provider_data", default=None)
|
|
|
|
|
|
class RequestProviderDataContext(AbstractContextManager):
|
|
"""Context manager for request provider data"""
|
|
|
|
def __init__(self, provider_data: dict[str, Any] | None = None, user: User | None = None):
|
|
self.provider_data = provider_data or {}
|
|
if user:
|
|
self.provider_data["__authenticated_user"] = user
|
|
|
|
self.token = None
|
|
|
|
def __enter__(self):
|
|
# Save the current value and set the new one
|
|
self.token = PROVIDER_DATA_VAR.set(self.provider_data)
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_val, exc_tb):
|
|
# Restore the previous value
|
|
if self.token is not None:
|
|
PROVIDER_DATA_VAR.reset(self.token)
|
|
|
|
|
|
class NeedsRequestProviderData:
|
|
def get_request_provider_data(self) -> Any:
|
|
spec = self.__provider_spec__
|
|
if not spec:
|
|
raise ValueError(f"Provider spec not set on {self.__class__}")
|
|
|
|
provider_type = spec.provider_type
|
|
validator_class = spec.provider_data_validator
|
|
if not validator_class:
|
|
raise ValueError(f"Provider {provider_type} does not have a validator")
|
|
|
|
val = PROVIDER_DATA_VAR.get()
|
|
if not val:
|
|
return None
|
|
|
|
validator = instantiate_class_type(validator_class)
|
|
try:
|
|
provider_data = validator(**val)
|
|
return provider_data
|
|
except Exception as e:
|
|
log.error(f"Error parsing provider data: {e}")
|
|
return None
|
|
|
|
|
|
def parse_request_provider_data(headers: dict[str, str]) -> dict[str, Any] | None:
|
|
"""Parse provider data from request headers"""
|
|
keys = [
|
|
"X-LlamaStack-Provider-Data",
|
|
"x-llamastack-provider-data",
|
|
]
|
|
val = None
|
|
for key in keys:
|
|
val = headers.get(key, None)
|
|
if val:
|
|
break
|
|
|
|
if not val:
|
|
return None
|
|
|
|
try:
|
|
return json.loads(val)
|
|
except json.JSONDecodeError:
|
|
log.error("Provider data not encoded as a JSON object!")
|
|
return None
|
|
|
|
|
|
def request_provider_data_context(
|
|
headers: dict[str, str], auth_attributes: dict[str, list[str]] | None = None
|
|
) -> AbstractContextManager:
|
|
"""Context manager that sets request provider data from headers and auth attributes for the duration of the context"""
|
|
provider_data = parse_request_provider_data(headers)
|
|
return RequestProviderDataContext(provider_data, auth_attributes)
|
|
|
|
|
|
def get_authenticated_user() -> User | None:
|
|
"""Helper to retrieve auth attributes from the provider data context"""
|
|
provider_data = PROVIDER_DATA_VAR.get()
|
|
if not provider_data:
|
|
return None
|
|
return provider_data.get("__authenticated_user")
|
|
|
|
|
|
def user_from_scope(scope: dict) -> User | None:
|
|
"""Create a User object from ASGI scope data (set by authentication middleware)"""
|
|
user_attributes = scope.get("user_attributes", {})
|
|
principal = scope.get("principal", "")
|
|
|
|
# auth not enabled
|
|
if not principal and not user_attributes:
|
|
return None
|
|
|
|
return User(principal=principal, attributes=user_attributes)
|