Module `supertokens_python.recipe.jwt.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 Any, Dict, List, Union, Optional

from supertokens_python.framework import BaseRequest, BaseResponse
from supertokens_python.types import APIResponse, GeneralErrorResponse

from .utils import JWTConfig


class JsonWebKey:
    def __init__(self, kty: str, kid: str, n: str, e: str, alg: str, use: str):
        self.kty = kty
        self.kid = kid
        self.n = n
        self.e = e
        self.alg = alg
        self.use = use


class CreateJwtOkResult:
    def __init__(self, jwt: str):
        self.jwt = jwt


class CreateJwtResultUnsupportedAlgorithm:
    pass


class GetJWKSResult:
    def __init__(self, keys: List[JsonWebKey], validity_in_secs: Optional[int]):
        self.keys = keys
        self.validity_in_secs = validity_in_secs


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

    @abstractmethod
    async def create_jwt(
        self,
        payload: Dict[str, Any],
        validity_seconds: Optional[int],
        use_static_signing_key: Optional[bool],
        user_context: Dict[str, Any],
    ) -> Union[CreateJwtOkResult, CreateJwtResultUnsupportedAlgorithm]:
        pass

    @abstractmethod
    async def get_jwks(self, user_context: Dict[str, Any]) -> GetJWKSResult:
        pass


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


class JWKSGetResponse(APIResponse):
    def __init__(self, keys: List[JsonWebKey]):
        self.keys = keys

    def to_json(self) -> Dict[str, Any]:
        keys: List[Dict[str, Any]] = []
        for key in self.keys:
            keys.append(
                {
                    "kty": key.kty,
                    "kid": key.kid,
                    "n": key.n,
                    "e": key.e,
                    "alg": key.alg,
                    "use": key.use,
                }
            )

        return {"keys": keys}


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

    @abstractmethod
    async def jwks_get(
        self, api_options: APIOptions, user_context: Dict[str, Any]
    ) -> Union[JWKSGetResponse, GeneralErrorResponse]:
        pass

Classes

class APIInterface

Expand source code

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

    @abstractmethod
    async def jwks_get(
        self, api_options: APIOptions, user_context: Dict[str, Any]
    ) -> Union[JWKSGetResponse, GeneralErrorResponse]:
        pass

Subclasses

APIImplementation

Methods

async def jwks_get(self, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[JWKSGetResponse, GeneralErrorResponse]

Expand source code

@abstractmethod
async def jwks_get(
    self, api_options: APIOptions, user_context: Dict[str, Any]
) -> Union[JWKSGetResponse, GeneralErrorResponse]:
    pass

class APIOptions (request: BaseRequest, response: BaseResponse, recipe_id: str, config: JWTConfig, recipe_implementation: RecipeInterface)

Expand source code

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

class CreateJwtOkResult (jwt: str)

Expand source code

class CreateJwtOkResult:
    def __init__(self, jwt: str):
        self.jwt = jwt

class CreateJwtResultUnsupportedAlgorithm

Expand source code

class CreateJwtResultUnsupportedAlgorithm:
    pass

class GetJWKSResult (keys: List[JsonWebKey], validity_in_secs: Optional[int])

Expand source code

class GetJWKSResult:
    def __init__(self, keys: List[JsonWebKey], validity_in_secs: Optional[int]):
        self.keys = keys
        self.validity_in_secs = validity_in_secs

class JWKSGetResponse (keys: List[JsonWebKey])

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

Expand source code

class JWKSGetResponse(APIResponse):
    def __init__(self, keys: List[JsonWebKey]):
        self.keys = keys

    def to_json(self) -> Dict[str, Any]:
        keys: List[Dict[str, Any]] = []
        for key in self.keys:
            keys.append(
                {
                    "kty": key.kty,
                    "kid": key.kid,
                    "n": key.n,
                    "e": key.e,
                    "alg": key.alg,
                    "use": key.use,
                }
            )

        return {"keys": keys}

Ancestors

APIResponse
abc.ABC

Methods

def to_json(self) ‑> Dict[str, Any]

Expand source code

def to_json(self) -> Dict[str, Any]:
    keys: List[Dict[str, Any]] = []
    for key in self.keys:
        keys.append(
            {
                "kty": key.kty,
                "kid": key.kid,
                "n": key.n,
                "e": key.e,
                "alg": key.alg,
                "use": key.use,
            }
        )

    return {"keys": keys}

class JsonWebKey (kty: str, kid: str, n: str, e: str, alg: str, use: str)

Expand source code

class JsonWebKey:
    def __init__(self, kty: str, kid: str, n: str, e: str, alg: str, use: str):
        self.kty = kty
        self.kid = kid
        self.n = n
        self.e = e
        self.alg = alg
        self.use = use

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[str, Any],
        validity_seconds: Optional[int],
        use_static_signing_key: Optional[bool],
        user_context: Dict[str, Any],
    ) -> Union[CreateJwtOkResult, CreateJwtResultUnsupportedAlgorithm]:
        pass

    @abstractmethod
    async def get_jwks(self, user_context: Dict[str, Any]) -> GetJWKSResult:
        pass

Ancestors

abc.ABC

Subclasses

RecipeImplementation

Methods

async def create_jwt(self, payload: Dict[str, Any], validity_seconds: Optional[int], use_static_signing_key: Optional[bool], user_context: Dict[str, Any]) ‑> Union[CreateJwtOkResult, CreateJwtResultUnsupportedAlgorithm]

Expand source code

@abstractmethod
async def create_jwt(
    self,
    payload: Dict[str, Any],
    validity_seconds: Optional[int],
    use_static_signing_key: Optional[bool],
    user_context: Dict[str, Any],
) -> Union[CreateJwtOkResult, CreateJwtResultUnsupportedAlgorithm]:
    pass

async def get_jwks(self, user_context: Dict[str, Any]) ‑> GetJWKSResult

Expand source code

@abstractmethod
async def get_jwks(self, user_context: Dict[str, Any]) -> GetJWKSResult:
    pass