Skip to content

SASLScram256

faststream.security.SASLScram256 #

SASLScram256(
    username: str,
    password: str,
    ssl_context: Optional[SSLContext] = None,
    use_ssl: bool | None = None,
)

Bases: BaseSecurity

Security configuration for SASL/SCRAM-SHA-256 authentication.

This class defines security configuration for SASL/SCRAM-SHA-256 authentication, which includes a username and password.

Source code in faststream/security.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def __init__(
    self,
    username: str,
    password: str,
    ssl_context: Optional["SSLContext"] = None,
    use_ssl: bool | None = None,
) -> None:
    super().__init__(
        ssl_context=ssl_context,
        use_ssl=use_ssl,
    )

    self.username = username
    self.password = password

username instance-attribute #

username = username

password instance-attribute #

password = password

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/SCRAM-SHA-256 authentication.

Source code in faststream/security.py 
109
110
111
112
@override
def get_requirement(self) -> list["dict[str, Any]"]:
    """Get the security requirements for SASL/SCRAM-SHA-256 authentication."""
    return [{"scram256": []}]

get_schema #

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

Get the security schema for SASL/SCRAM-SHA-256 authentication.

Source code in faststream/security.py 
114
115
116
117
@override
def get_schema(self) -> dict[str, dict[str, str]]:
    """Get the security schema for SASL/SCRAM-SHA-256 authentication."""
    return {"scram256": {"type": "scramSha256"}}