import ast import os import traceback from typing import Optional, Union import httpx import litellm from litellm._logging import verbose_logger from litellm.caching.caching import DualCache from litellm.llms.custom_httpx.http_handler import HTTPHandler from litellm.secret_managers.get_azure_ad_token_provider import ( get_azure_ad_token_provider, ) from litellm.secret_managers.secret_manager_handler import get_secret_from_manager oidc_cache = DualCache() _DEFAULT_OIDC_ALLOWED_CREDENTIAL_DIRS = ("/var/run/secrets", "/run/secrets") def _get_oidc_allowed_credential_dirs() -> list[str]: """ Return the absolute, normalized list of directories from which ``oidc/file/`` is permitted to read token files. Defaults to standard container credential mount points. Operators can override via the ``LITELLM_OIDC_ALLOWED_CREDENTIAL_DIRS`` environment variable (comma-separated list of absolute paths). """ override = os.getenv("LITELLM_OIDC_ALLOWED_CREDENTIAL_DIRS") raw_dirs = ( [d.strip() for d in override.split(",") if d.strip()] if override else list(_DEFAULT_OIDC_ALLOWED_CREDENTIAL_DIRS) ) return [os.path.realpath(d) for d in raw_dirs] def _resolve_oidc_file_path(requested_path: str) -> str: """ Resolve ``requested_path`` and verify it falls within one of the allowed credential directories. Raises ``ValueError`` otherwise. """ if not os.path.isabs(requested_path): raise ValueError( "oidc/file path must be absolute. Use the format " "'oidc/file//var/run/secrets/' (note the leading slash " "after 'oidc/file/')." ) resolved = os.path.realpath(requested_path) for allowed in _get_oidc_allowed_credential_dirs(): try: if os.path.commonpath([resolved, allowed]) == allowed: return resolved except ValueError: # commonpath raises when paths are on different drives (Windows); # treat as not-matching and continue. continue raise ValueError( "oidc/file path is outside the allowed credential directories. " "Set LITELLM_OIDC_ALLOWED_CREDENTIAL_DIRS to extend the allowlist." ) def _get_oidc_http_handler(timeout: Optional[httpx.Timeout] = None) -> HTTPHandler: """ Factory function to create HTTPHandler for OIDC requests. This function can be mocked in tests. Args: timeout: Optional timeout for HTTP requests. Defaults to 600.0 seconds with 5.0 connect timeout. Returns: HTTPHandler instance configured for OIDC requests. """ if timeout is None: timeout = httpx.Timeout(timeout=600.0, connect=5.0) return HTTPHandler(timeout=timeout) ######### Secret Manager ############################ # checks if user has passed in a secret manager client # if passed in then checks the secret there def str_to_bool(value: Optional[str]) -> Optional[bool]: """ Converts a string to a boolean if it's a recognized boolean string. Returns None if the string is not a recognized boolean value. :param value: The string to be checked. :return: True or False if the string is a recognized boolean, otherwise None. """ if value is None: return None true_values = {"true"} false_values = {"false"} value_lower = value.strip().lower() if value_lower in true_values: return True elif value_lower in false_values: return False else: return None def get_secret_str( secret_name: str, default_value: Optional[Union[str, bool]] = None, ) -> Optional[str]: """ Guarantees response from 'get_secret' is either string or none. Used for fixing linting errors. """ value = get_secret(secret_name=secret_name, default_value=default_value) if value is not None and not isinstance(value, str): return None return value def normalize_nonempty_secret_str(val: Optional[str]) -> Optional[str]: """ Strip whitespace and treat None, '', and whitespace-only strings as unset. Use when pairing secrets (mutual exclusion, optional auth) so whitespace-only values do not count as present. """ if val is None: return None stripped = val.strip() return stripped if stripped else None def get_secret_bool( secret_name: str, default_value: Optional[bool] = None, ) -> Optional[bool]: """ Guarantees response from 'get_secret' is either boolean or none. Used for fixing linting errors. Args: secret_name: The name of the secret to get. default_value: The default value to return if the secret is not found. Returns: The secret value as a boolean or None if the secret is not found. """ _secret_value = get_secret(secret_name, default_value) if _secret_value is None: return None elif isinstance(_secret_value, bool): return _secret_value else: return str_to_bool(_secret_value) def get_secret( secret_name: str, default_value: Optional[Union[str, bool]] = None, ): key_management_system = litellm._key_management_system key_management_settings = litellm._key_management_settings secret = None if secret_name.startswith("os.environ/"): secret_name = secret_name.replace("os.environ/", "") # Example: oidc/google/https://bedrock-runtime.us-east-1.amazonaws.com/model/stability.stable-diffusion-xl-v1/invoke if secret_name.startswith("oidc/"): secret_name_split = secret_name.replace("oidc/", "") oidc_provider, oidc_aud = secret_name_split.split("/", 1) oidc_aud = "/".join(secret_name_split.split("/")[1:]) # TODO: Add caching for HTTP requests if oidc_provider == "google": oidc_token = oidc_cache.get_cache(key=secret_name) if oidc_token is not None: return oidc_token oidc_client = _get_oidc_http_handler() # https://cloud.google.com/compute/docs/instances/verifying-instance-identity#request_signature response = oidc_client.get( "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity", params={"audience": oidc_aud}, headers={"Metadata-Flavor": "Google"}, ) if response.status_code == 200: oidc_token = response.text oidc_cache.set_cache(key=secret_name, value=oidc_token, ttl=3600 - 60) return oidc_token else: raise ValueError("Google OIDC provider failed") elif oidc_provider == "circleci": # https://circleci.com/docs/openid-connect-tokens/ env_secret = os.getenv("CIRCLE_OIDC_TOKEN") if env_secret is None: raise ValueError("CIRCLE_OIDC_TOKEN not found in environment") return env_secret elif oidc_provider == "circleci_v2": # https://circleci.com/docs/openid-connect-tokens/ env_secret = os.getenv("CIRCLE_OIDC_TOKEN_V2") if env_secret is None: raise ValueError("CIRCLE_OIDC_TOKEN_V2 not found in environment") return env_secret elif oidc_provider == "github": # https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers#using-custom-actions actions_id_token_request_url = os.getenv("ACTIONS_ID_TOKEN_REQUEST_URL") actions_id_token_request_token = os.getenv("ACTIONS_ID_TOKEN_REQUEST_TOKEN") if ( actions_id_token_request_url is None or actions_id_token_request_token is None ): raise ValueError( "ACTIONS_ID_TOKEN_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_TOKEN not found in environment" ) oidc_token = oidc_cache.get_cache(key=secret_name) if oidc_token is not None: return oidc_token oidc_client = _get_oidc_http_handler() response = oidc_client.get( actions_id_token_request_url, params={"audience": oidc_aud}, headers={ "Authorization": f"Bearer {actions_id_token_request_token}", "Accept": "application/json; api-version=2.0", }, ) if response.status_code == 200: oidc_token = response.json().get("value", None) oidc_cache.set_cache(key=secret_name, value=oidc_token, ttl=300 - 5) return oidc_token else: raise ValueError("Github OIDC provider failed") elif oidc_provider == "azure": # https://azure.github.io/azure-workload-identity/docs/quick-start.html azure_federated_token_file = os.getenv("AZURE_FEDERATED_TOKEN_FILE") if azure_federated_token_file is None: verbose_logger.warning( "AZURE_FEDERATED_TOKEN_FILE not found in environment will use Azure AD token provider" ) azure_token_provider = get_azure_ad_token_provider(azure_scope=oidc_aud) try: oidc_token = azure_token_provider() if oidc_token is None: raise ValueError("Azure OIDC provider returned None token") return oidc_token except Exception as e: error_msg = f"Azure OIDC provider failed: {str(e)}" verbose_logger.error(error_msg) raise ValueError(error_msg) with open(azure_federated_token_file, "r") as f: oidc_token = f.read() return oidc_token elif oidc_provider == "file": # Load token from a file within an allowed credential directory. safe_path = _resolve_oidc_file_path(oidc_aud) with open(safe_path, "r") as f: oidc_token = f.read() return oidc_token elif oidc_provider == "env": # Load token directly from an environment variable oidc_token = os.getenv(oidc_aud) if oidc_token is None: raise ValueError(f"Environment variable {oidc_aud} not found") return oidc_token elif oidc_provider == "env_path": # Load token from a file path specified in an environment variable token_file_path = os.getenv(oidc_aud) if token_file_path is None: raise ValueError(f"Environment variable {oidc_aud} not found") with open(token_file_path, "r") as f: oidc_token = f.read() return oidc_token else: raise ValueError("Unsupported OIDC provider") try: if ( _should_read_secret_from_secret_manager() and litellm.secret_manager_client is not None ): try: client = litellm.secret_manager_client key_manager = "local" if key_management_system is not None: key_manager = key_management_system.value if key_management_settings is not None: if ( key_management_settings.hosted_keys is not None and secret_name not in key_management_settings.hosted_keys ): # allow user to specify which keys to check in hosted key manager key_manager = "local" # Delegate to the secret manager handler secret = get_secret_from_manager( client=client, key_manager=key_manager, secret_name=secret_name, key_management_settings=key_management_settings, ) except Exception as e: # check if it's in os.environ verbose_logger.error( f"Defaulting to os.environ value for key={secret_name}. An exception occurred - {str(e)}.\n\n{traceback.format_exc()}" ) secret = os.getenv(secret_name) try: if isinstance(secret, str): secret_value_as_bool = ast.literal_eval(secret) if isinstance(secret_value_as_bool, bool): return secret_value_as_bool else: return secret except Exception: return secret else: secret = os.environ.get(secret_name) secret_value_as_bool = str_to_bool(secret) if secret is not None else None if secret_value_as_bool is not None and isinstance( secret_value_as_bool, bool ): return secret_value_as_bool else: return secret except Exception as e: if default_value is not None: return default_value else: raise e def _should_read_secret_from_secret_manager() -> bool: """ Returns True if the secret manager should be used to read the secret, False otherwise - If the secret manager client is not set, return False - If the `_key_management_settings` access mode is "read_only" or "read_and_write", return True - Otherwise, return False """ if litellm.secret_manager_client is not None: if litellm._key_management_settings is not None: if ( litellm._key_management_settings.access_mode == "read_only" or litellm._key_management_settings.access_mode == "read_and_write" ): return True return False