Skip to content

hololinked.td.security_definitions.SecurityScheme

Bases: Schema

Represents a security scheme. schema - https://www.w3.org/TR/wot-thing-description11/#sec-security-vocabulary-definition

Source code in hololinked/hololinked/td/security_definitions.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class SecurityScheme(Schema):
    """
    Represents a security scheme.
    schema - https://www.w3.org/TR/wot-thing-description11/#sec-security-vocabulary-definition
    """

    scheme: str = None
    description: str = None
    descriptions: Optional[dict[str, str]] = None
    proxy: Optional[str] = None

    def __init__(self):
        super().__init__()

    def build(self):
        raise NotImplementedError("Please implement specific security scheme builders")

hololinked.td.security_definitions.NoSecurityScheme

Bases: SecurityScheme

No Security Scheme

Source code in hololinked/hololinked/td/security_definitions.py 
26
27
28
29
30
31
class NoSecurityScheme(SecurityScheme):
    """No Security Scheme"""

    def build(self):
        self.scheme = "nosec"
        self.description = "currently no security scheme supported"

hololinked.td.security_definitions.BasicSecurityScheme

Bases: SecurityScheme

Basic Security Scheme, username and password

Source code in hololinked/hololinked/td/security_definitions.py 
34
35
36
37
38
39
40
41
42
class BasicSecurityScheme(SecurityScheme):
    """Basic Security Scheme, username and password"""

    in_: str = Field(default="header", alias="in")

    def build(self):
        self.scheme = "basic"
        self.description = "HTTP Basic Authentication"
        self.in_ = "header"

hololinked.td.security_definitions.APIKeySecurityScheme

Bases: SecurityScheme

API Key Security Scheme

Source code in hololinked/hololinked/td/security_definitions.py 
45
46
47
48
49
50
51
52
53
class APIKeySecurityScheme(SecurityScheme):
    """API Key Security Scheme"""

    in_: str = Field(default="header", alias="in")

    def build(self):
        self.scheme = "apikey"
        self.description = "API Key Authentication"
        self.in_ = "header"

hololinked.td.security_definitions.OIDCSecurityScheme

Bases: SecurityScheme

OIDC Security Scheme

Source code in hololinked/hololinked/td/security_definitions.py 
56
57
58
59
60
61
62
63
64
65
66
67
class OIDCSecurityScheme(SecurityScheme):
    """OIDC Security Scheme"""

    scheme: str = "oauth2"
    token: str = ""
    scopes: list[str] = Field(default_factory=list)

    def build(self, token_url: str, scopes: list[str] | None = ["openid"]):
        self.description = "OpenID Connect Authentication"
        self.token = token_url
        if scopes is not None:
            self.scopes = scopes