Skip to content

SASLOAuthBearer

faststream.security.SASLOAuthBearer #

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

Bases: BaseSecurity

Security configuration for SASL/OAUTHBEARER authentication.

This class defines basic security configuration for SASL/OAUTHBEARER authentication.

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

ssl_context instance-attribute #

ssl_context: Optional[SSLContext] = ssl_context

use_ssl instance-attribute #

use_ssl: bool = use_ssl

get_requirement #

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

Get the security requirements for SASL/OAUTHBEARER authentication.

Source code in faststream/security.py 
166
167
168
169
@override
def get_requirement(self) -> list["dict[str, Any]"]:
    """Get the security requirements for SASL/OAUTHBEARER authentication."""
    return [{"oauthbearer": []}]

get_schema #

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

Get the security schema for SASL/OAUTHBEARER authentication.

Source code in faststream/security.py 
171
172
173
174
@override
def get_schema(self) -> dict[str, dict[str, str]]:
    """Get the security schema for SASL/OAUTHBEARER authentication."""
    return {"oauthbearer": {"type": "oauth2"}}