Skip to content

BaseSecurity

fastagency.api.openapi.security.BaseSecurity #

Bases: BaseModel

Base class for security classes.

in_value class-attribute #

in_value: Literal[
    "header",
    "query",
    "cookie",
    "bearer",
    "basic",
    "tls",
    "unsupported",
]

name instance-attribute #

name: str

type class-attribute #

type: Literal[
    "apiKey",
    "http",
    "mutualTLS",
    "oauth2",
    "openIdConnect",
    "unsupported",
]

accept #

accept(security_params: BaseSecurityParameters) -> bool
Source code in fastagency/api/openapi/security.py 
45
46
def accept(self, security_params: "BaseSecurityParameters") -> bool:
    return isinstance(self, security_params.get_security_class())

get_security_class classmethod #

get_security_class(
    type: str, schema_parameters: dict[str, Any]
) -> BaseSecurityType
Source code in fastagency/api/openapi/security.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@classmethod
def get_security_class(
    cls, type: str, schema_parameters: dict[str, Any]
) -> BaseSecurityType:
    sub_classes = cls.__subclasses__()

    for sub_class in sub_classes:
        if sub_class.is_supported(type, schema_parameters):
            return sub_class

    logger.error(
        f"Unsupported type '{type}' and schema_parameters '{schema_parameters}' combination"
    )
    return UnsuportedSecurityStub

get_security_parameters classmethod #

get_security_parameters(
    schema_parameters: dict[str, Any]
) -> str
Source code in fastagency/api/openapi/security.py 
67
68
69
@classmethod
def get_security_parameters(cls, schema_parameters: dict[str, Any]) -> str:
    return f"{cls.__name__}(name=\"{schema_parameters.get('name')}\")"

is_supported classmethod #

is_supported(
    type: str, schema_parameters: dict[str, Any]
) -> bool
Source code in fastagency/api/openapi/security.py 
48
49
50
@classmethod
def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
    return cls.type == type and cls.in_value == schema_parameters.get("in")