Skip to content

BaseSecurity

faststream.security.BaseSecurity #

BaseSecurity(
    ssl_context: Optional[SSLContext] = None,
    use_ssl: bool | None = None,
)

Base class for defining security configurations.

This class provides a base for defining security configurations for communication with a broker. It allows setting SSL encryption and provides methods to retrieve security requirements and schemas.

Source code in faststream/security.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
def __init__(
    self,
    ssl_context: Optional["SSLContext"] = None,
    use_ssl: bool | None = None,
) -> None:
    if ssl_context is not None:
        use_ssl = True

    if use_ssl is None:
        use_ssl = False

    self.use_ssl = use_ssl
    self.ssl_context = ssl_context

use_ssl instance-attribute #

use_ssl: bool = use_ssl

ssl_context instance-attribute #

ssl_context: Optional[SSLContext] = ssl_context

get_requirement #

get_requirement() -> list[dict[str, Any]]

Get the security requirements.

Source code in faststream/security.py 
35
36
37
def get_requirement(self) -> list["dict[str, Any]"]:  # ruff: ignore[no-self-use]
    """Get the security requirements."""
    return []

get_schema #

get_schema() -> dict[str, dict[str, str]]

Get the security schema.

Source code in faststream/security.py 
39
40
41
def get_schema(self) -> dict[str, dict[str, str]]:  # ruff: ignore[no-self-use]
    """Get the security schema."""
    return {}