Class swarmauri_middleware_auth.AuthMiddleware.AuthMiddleware

swarmauri_middleware_auth.AuthMiddleware.AuthMiddleware

AuthMiddleware(
    secret_key,
    algorithm="HS256",
    verify_exp=True,
    verify_aud=False,
    audience=None,
    issuer=None,
    **kwargs,
)

Bases: MiddlewareBase, ComponentBase

Middleware for handling JWT authentication.

This middleware validates JWT tokens in incoming requests and ensures they are properly signed and not expired before allowing the request to proceed through the application stack.

ATTRIBUTE	DESCRIPTION
secret_key	Secret key used to verify JWT tokens
algorithm	Algorithm used for JWT verification (default: HS256)
verify_exp	Whether to verify token expiration (default: True)
verify_aud	Whether to verify audience claim (default: False)
audience	Expected audience for token verification
issuer	Expected issuer for token verification

Initialize the AuthMiddleware with JWT configuration.

PARAMETER	DESCRIPTION
secret_key	Secret key used to verify JWT tokens TYPE: str
algorithm	Algorithm used for JWT verification TYPE: str DEFAULT: 'HS256'
verify_exp	Whether to verify token expiration TYPE: bool DEFAULT: True
verify_aud	Whether to verify audience claim TYPE: bool DEFAULT: False
audience	Expected audience for token verification TYPE: Optional[str] DEFAULT: None
issuer	Expected issuer for token verification TYPE: Optional[str] DEFAULT: None

Source code in swarmauri_middleware_auth/AuthMiddleware.py

def __init__(
    self,
    secret_key: str,
    algorithm: str = "HS256",
    verify_exp: bool = True,
    verify_aud: bool = False,
    audience: Optional[str] = None,
    issuer: Optional[str] = None,
    **kwargs: Any,
):
    """Initialize the AuthMiddleware with JWT configuration.

    Args:
        secret_key: Secret key used to verify JWT tokens
        algorithm: Algorithm used for JWT verification
        verify_exp: Whether to verify token expiration
        verify_aud: Whether to verify audience claim
        audience: Expected audience for token verification
        issuer: Expected issuer for token verification
    """
    super().__init__(**kwargs)
    self.secret_key = secret_key
    self.algorithm = algorithm
    self.verify_exp = verify_exp
    self.verify_aud = verify_aud
    self.audience = audience
    self.issuer = issuer
    self._jws = JwsSignerVerifier()

secret_key instance-attribute

secret_key = secret_key

algorithm instance-attribute

algorithm = algorithm

verify_exp instance-attribute

verify_exp = verify_exp

verify_aud instance-attribute

verify_aud = verify_aud

audience instance-attribute

audience = audience

issuer instance-attribute

issuer = issuer

type class-attribute instance-attribute

type = 'ComponentBase'

model_config class-attribute instance-attribute

model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

name class-attribute instance-attribute

name = None

resource class-attribute instance-attribute

resource = MIDDLEWARE.value

version class-attribute instance-attribute

version = '0.1.0'

app property

app

dispatch async

dispatch(request, call_next)

Dispatches the request after JWT authentication.

This method extracts and validates JWT tokens from the Authorization header. It checks for proper format, signature, expiration, and other claims as configured.

PARAMETER	DESCRIPTION
request	The incoming request object to be processed. TYPE: Request
call_next	A callable that invokes the next middleware in the chain. TYPE: Callable[[Request], Any]

RETURNS	DESCRIPTION
Any	The response object after all middlewares have processed the request.

RAISES	DESCRIPTION
HTTPException	If authentication fails for any reason.

Source code in swarmauri_middleware_auth/AuthMiddleware.py

async def dispatch(
    self, request: Request, call_next: Callable[[Request], Any]
) -> Any:
    """Dispatches the request after JWT authentication.

    This method extracts and validates JWT tokens from the Authorization header.
    It checks for proper format, signature, expiration, and other claims
    as configured.

    Args:
        request: The incoming request object to be processed.
        call_next: A callable that invokes the next middleware in the chain.

    Returns:
        The response object after all middlewares have processed the request.

    Raises:
        HTTPException: If authentication fails for any reason.
    """

    # Get the authorization header from the request
    auth_header = request.headers.get("Authorization")

    # Check if the authorization header is missing
    if not auth_header:
        logger.warning("Missing Authorization header in request")
        raise HTTPException(status_code=401, detail="Missing Authorization header")

        # Check if the header format is correct
    if not auth_header.startswith("Bearer "):
        logger.warning("Invalid Authorization header format")
        raise HTTPException(status_code=401, detail="Invalid token format")

        # Extract the token from the header
    try:
        token = auth_header.split("Bearer ")[1].strip()
        if not token:
            raise ValueError("Empty token")
    except (IndexError, ValueError):
        logger.warning("Failed to extract token from Authorization header")
        raise HTTPException(status_code=401, detail="Invalid token format")

        # Validate the JWT token
    try:
        payload = await self._validate_jwt_token(token)

        # Add the decoded payload to request state for use in downstream handlers
        request.state.user = payload

        logger.info(
            f"Authentication successful for user: {payload.get('sub', 'unknown')}"
        )
        return await call_next(request)

    except HTTPException as exc:
        logger.warning(exc.detail)
        raise
    except Exception as e:
        logger.error(f"Unexpected error during JWT validation: {str(e)}")
        raise HTTPException(status_code=401, detail="Authentication failed")

verify_token_manually

verify_token_manually(token)

Manually verify a token without raising exceptions.

This is a utility method that can be used for token verification outside of the middleware context.

PARAMETER	DESCRIPTION
token	The JWT token string to verify TYPE: str

RETURNS	DESCRIPTION
Optional[Dict[str, Any]]	Dict containing the decoded payload if valid, None if invalid

Source code in swarmauri_middleware_auth/AuthMiddleware.py

def verify_token_manually(self, token: str) -> Optional[Dict[str, Any]]:
    """Manually verify a token without raising exceptions.

    This is a utility method that can be used for token verification
    outside of the middleware context.

    Args:
        token: The JWT token string to verify

    Returns:
        Dict containing the decoded payload if valid, None if invalid
    """
    try:
        return asyncio.run(self._validate_jwt_token(token))
    except Exception as e:
        logger.debug(f"Token verification failed: {str(e)}")
        return None

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a TOML representation of the model.

Source code in swarmauri_base/TomlMixin.py

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger

on_scope async

on_scope(scope)

Hook executed when the middleware receives a scope.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_scope(self, scope: Scope) -> Scope:
    """Hook executed when the middleware receives a scope."""

    return scope

on_receive async

on_receive(scope, message)

Hook executed for every message received from the client.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_receive(self, scope: Scope, message: Message) -> Message:
    """Hook executed for every message received from the client."""

    return message

on_send async

on_send(scope, message)

Hook executed before messages are sent to the client.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_send(self, scope: Scope, message: Message) -> Message:
    """Hook executed before messages are sent to the client."""

    return message

bind

bind(app)

Bind the downstream ASGI application to the middleware.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

def bind(self, app: ASGIApp) -> None:
    """Bind the downstream ASGI application to the middleware."""

    self._app = app

call_next async

call_next(scope, receive, send)

Invoke the next ASGI application in the chain.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def call_next(
    self, scope: Scope, receive: ReceiveCallable, send: SendCallable
) -> None:
    """Invoke the next ASGI application in the chain."""

    await self.app(scope, receive, send)