Module supertokens_python.recipe.openid.interfaces

Expand source code 
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from abc import ABC, abstractmethod
from typing import Union, List
try:
    from typing import Literal
except ImportError:
    from typing_extensions import Literal
from supertokens_python.framework import BaseRequest, BaseResponse
from supertokens_python.recipe.jwt.types import JsonWebKey


class CreateJwtResult(ABC):
    def __init__(
            self, status: Literal['OK', 'UNSUPPORTED_ALGORITHM_ERROR'], jwt: str = None):
        self.status = status
        self.jwt = jwt


class CreateJwtResultOk(CreateJwtResult):
    def __init__(self, jwt: str):
        super().__init__('OK', jwt)


class CreateJwtResultUnsupportedAlgorithm(CreateJwtResult):
    def __init__(self):
        super().__init__('UNSUPPORTED_ALGORITHM_ERROR')


class GetJWKSResult(ABC):
    def __init__(
            self, status: Literal['OK'], keys: List[JsonWebKey]):
        self.status = status
        self.keys = keys


class GetOpenIdDiscoveryConfigurationResult(ABC):
    def __init__(
            self, status: Literal['OK'], issuer: str, jwks_uri: str):
        self.status = status
        self.issuer = issuer
        self.jwks_uri = jwks_uri


class RecipeInterface(ABC):
    def __init__(self):
        pass

    @abstractmethod
    async def create_jwt(self, payload: dict = None, validity_seconds: int = None) -> CreateJwtResult:
        pass

    @abstractmethod
    async def get_jwks(self) -> GetJWKSResult:
        pass

    @abstractmethod
    async def get_open_id_discovery_configuration(self) -> GetOpenIdDiscoveryConfigurationResult:
        pass


class APIOptions:
    def __init__(self, request: BaseRequest, response: Union[BaseResponse, None], recipe_id: str,
                 config, recipe_implementation: RecipeInterface):
        self.request = request
        self.response = response
        self.recipe_id = recipe_id
        self.config = config
        self.recipe_implementation = recipe_implementation


class OpenIdDiscoveryConfigurationGetResponse:
    def __init__(
            self, status: Literal['OK'], issuer: str, jwks_uri: str):
        self.status = status
        self.issuer = issuer
        self.jwks_uri = jwks_uri

    def to_json(self):
        return {
            'status': self.status,
            'issuer': self.issuer,
            'jwks_uri': self.jwks_uri
        }


class APIInterface:
    def __init__(self):
        self.disable_open_id_discovery_configuration_get = False

    @abstractmethod
    async def open_id_discovery_configuration_get(self, api_options: APIOptions) -> OpenIdDiscoveryConfigurationGetResponse:
        pass

Classes

class APIInterface
Expand source code 
class APIInterface:
    def __init__(self):
        self.disable_open_id_discovery_configuration_get = False

    @abstractmethod
    async def open_id_discovery_configuration_get(self, api_options: APIOptions) -> OpenIdDiscoveryConfigurationGetResponse:
        pass

Subclasses

Methods

async def open_id_discovery_configuration_get(self, api_options: APIOptions) ‑> OpenIdDiscoveryConfigurationGetResponse
Expand source code 
@abstractmethod
async def open_id_discovery_configuration_get(self, api_options: APIOptions) -> OpenIdDiscoveryConfigurationGetResponse:
    pass
class APIOptions (request: BaseRequest, response: Optional[BaseResponse], recipe_id: str, config, recipe_implementation: RecipeInterface)
Expand source code 
class APIOptions:
    def __init__(self, request: BaseRequest, response: Union[BaseResponse, None], recipe_id: str,
                 config, recipe_implementation: RecipeInterface):
        self.request = request
        self.response = response
        self.recipe_id = recipe_id
        self.config = config
        self.recipe_implementation = recipe_implementation
class CreateJwtResult (status: Literal['OK', 'UNSUPPORTED_ALGORITHM_ERROR'], jwt: str = None)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class CreateJwtResult(ABC):
    def __init__(
            self, status: Literal['OK', 'UNSUPPORTED_ALGORITHM_ERROR'], jwt: str = None):
        self.status = status
        self.jwt = jwt

Ancestors

  • abc.ABC

Subclasses

class CreateJwtResultOk (jwt: str)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class CreateJwtResultOk(CreateJwtResult):
    def __init__(self, jwt: str):
        super().__init__('OK', jwt)

Ancestors

class CreateJwtResultUnsupportedAlgorithm

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class CreateJwtResultUnsupportedAlgorithm(CreateJwtResult):
    def __init__(self):
        super().__init__('UNSUPPORTED_ALGORITHM_ERROR')

Ancestors

class GetJWKSResult (status: Literal['OK'], keys: List[JsonWebKey])

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class GetJWKSResult(ABC):
    def __init__(
            self, status: Literal['OK'], keys: List[JsonWebKey]):
        self.status = status
        self.keys = keys

Ancestors

  • abc.ABC
class GetOpenIdDiscoveryConfigurationResult (status: Literal['OK'], issuer: str, jwks_uri: str)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class GetOpenIdDiscoveryConfigurationResult(ABC):
    def __init__(
            self, status: Literal['OK'], issuer: str, jwks_uri: str):
        self.status = status
        self.issuer = issuer
        self.jwks_uri = jwks_uri

Ancestors

  • abc.ABC
class OpenIdDiscoveryConfigurationGetResponse (status: Literal['OK'], issuer: str, jwks_uri: str)
Expand source code 
class OpenIdDiscoveryConfigurationGetResponse:
    def __init__(
            self, status: Literal['OK'], issuer: str, jwks_uri: str):
        self.status = status
        self.issuer = issuer
        self.jwks_uri = jwks_uri

    def to_json(self):
        return {
            'status': self.status,
            'issuer': self.issuer,
            'jwks_uri': self.jwks_uri
        }

Methods

def to_json(self)
Expand source code 
def to_json(self):
    return {
        'status': self.status,
        'issuer': self.issuer,
        'jwks_uri': self.jwks_uri
    }
class RecipeInterface

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code 
class RecipeInterface(ABC):
    def __init__(self):
        pass

    @abstractmethod
    async def create_jwt(self, payload: dict = None, validity_seconds: int = None) -> CreateJwtResult:
        pass

    @abstractmethod
    async def get_jwks(self) -> GetJWKSResult:
        pass

    @abstractmethod
    async def get_open_id_discovery_configuration(self) -> GetOpenIdDiscoveryConfigurationResult:
        pass

Ancestors

  • abc.ABC

Subclasses

Methods

async def create_jwt(self, payload: dict = None, validity_seconds: int = None) ‑> CreateJwtResult
Expand source code 
@abstractmethod
async def create_jwt(self, payload: dict = None, validity_seconds: int = None) -> CreateJwtResult:
    pass
async def get_jwks(self) ‑> GetJWKSResult
Expand source code 
@abstractmethod
async def get_jwks(self) -> GetJWKSResult:
    pass
async def get_open_id_discovery_configuration(self) ‑> GetOpenIdDiscoveryConfigurationResult
Expand source code 
@abstractmethod
async def get_open_id_discovery_configuration(self) -> GetOpenIdDiscoveryConfigurationResult:
    pass