Skip to content

Bearers

Very similar to FastAPI's OAuth2PasswordBearer, HTTPBearer and others.

Token Bearer

missil.TokenBearer 

TokenBearer(token_key, secret_key, user_permissions_key=None, algorithms='HS256')

Parent class encapsulating JWT token obtaining and decoding.

Shouldn't be used as a FastAPI dependency, since the call method returns None (and is herefore declared just to avoid code checking alerts), but can be used as a parent class to create customized token procedures.

JWT token obtaining and decoding.

PARAMETER DESCRIPTION
token_key

Name of the header or http cookie key where the token bearing user permissions is stored.

TYPE: str

secret_key

Key used to decode the JWT token. See Python-jose docs for more details.

TYPE: str

user_permissions_key

Key name of the object specifying user permissions on the decoded JWT token, by default None. Example:

Supposing the following decoded token claim: 

{
    "username": "John Doe",
    "permissions": {  # user_permissions_key
        "finances": 0,
        "it": 0,
    },
}

TYPE: str | None DEFAULT: None

algorithms

JWT token decode algorithm, by default "HS256". See Python-jose docs for more details.

TYPE: str DEFAULT: 'HS256'

Source code in missil/bearers.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__(
    self,
    token_key: str,
    secret_key: str,
    user_permissions_key: str | None = None,
    algorithms: str = "HS256",
):
    """
    JWT token obtaining and decoding.

    Parameters
    ----------
    token_key : str
        Name of the header or http cookie key where the token bearing user
        permissions is stored.
    secret_key : str
        Key used to decode the JWT token. See Python-jose docs for more details.
    user_permissions_key : str | None, optional
        Key name of the object specifying user permissions on the
        decoded JWT token, by default None. Example:

        Supposing the following decoded token claim:
        ```python
        {
            "username": "John Doe",
            "permissions": {  # user_permissions_key
                "finances": 0,
                "it": 0,
            },
        }
        ```

    algorithms : str, optional
        JWT token decode algorithm, by default "HS256". See Python-jose docs
        for more details.
    """
    self.token_key = token_key
    self.token_secret_key = secret_key
    self.algorithm = algorithms
    self.user_permissions_key = user_permissions_key

token_key instance-attribute 

token_key = token_key

token_secret_key instance-attribute 

token_secret_key = secret_key

algorithm instance-attribute 

algorithm = algorithms

user_permissions_key instance-attribute 

user_permissions_key = user_permissions_key

split_token_str 

split_token_str(token, sep=' ')

Get only the token value from the source.

Source code in missil/bearers.py 
62
63
64
65
66
67
def split_token_str(self, token: str, sep: str = " ") -> str:
    """Get only the token value from the source."""
    if "bearer" in token.lower():
        token = token.split(sep)[-1]

    return token

get_token_from_cookies 

get_token_from_cookies(request)

Read the token value from http cookies.

Source code in missil/bearers.py 
69
70
71
72
73
74
75
76
77
78
79
def get_token_from_cookies(self, request: Request) -> str:
    """Read the token value from http cookies."""
    token = request.cookies.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request cookies using key '{self.token_key}'",
        )

    return self.split_token_str(token)

get_token_from_header 

get_token_from_header(request)

Get the token value from request headers.

Source code in missil/bearers.py 
81
82
83
84
85
86
87
88
89
90
91
def get_token_from_header(self, request: Request) -> str:
    """Get the token value from request headers."""
    token = request.headers.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request headers using key '{self.token_key}'",
        )

    return self.split_token_str(token)

decode_jwt 

decode_jwt(token)

Decode a retrieved token value and return the user permissions.

Source code in missil/bearers.py 
93
94
95
96
97
98
def decode_jwt(self, token: str) -> dict[str, int]:
    """Decode a retrieved token value and return the user permissions."""
    decoded_token = decode_jwt_token(
        token, self.token_secret_key, algorithm=self.algorithm
    )
    return decoded_token

decode_from_cookies 

decode_from_cookies(request)

Get token from cookies and decode it.

Source code in missil/bearers.py 
100
101
102
103
def decode_from_cookies(self, request: Request) -> dict[str, Any]:
    """Get token from cookies and decode it."""
    token = self.get_token_from_cookies(request)
    return self.decode_jwt(token)

decode_from_header 

decode_from_header(request)

Get token from headers and decode it.

Source code in missil/bearers.py 
105
106
107
108
def decode_from_header(self, request: Request) -> dict[str, Any]:
    """Get token from headers and decode it."""
    token = self.get_token_from_header(request)
    return self.decode_jwt(token)

get_user_permissions 

get_user_permissions(decoded_token)

Get user permissions from a decoded token.

Source code in missil/bearers.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_user_permissions(self, decoded_token: dict[str, Any]) -> dict[str, int]:
    """Get user permissions from a decoded token."""
    if self.user_permissions_key:
        try:
            user_permissions: dict[str, int] = decoded_token[
                self.user_permissions_key
            ]
        except KeyError as ke:
            raise TokenErrorException(
                401,
                (
                    "User permissions not found at token key "
                    f"'{self.user_permissions_key}'"
                ),
            ) from ke
        else:
            return user_permissions

    raise TokenErrorException(500, "User permissions key not provided.")

missil.CookieTokenBearer 

CookieTokenBearer(token_key, secret_key, user_permissions_key=None, algorithms='HS256')

Bases: TokenBearer

Read JWT token from http cookies.

JWT token obtaining and decoding.

PARAMETER DESCRIPTION
token_key

Name of the header or http cookie key where the token bearing user permissions is stored.

TYPE: str

secret_key

Key used to decode the JWT token. See Python-jose docs for more details.

TYPE: str

user_permissions_key

Key name of the object specifying user permissions on the decoded JWT token, by default None. Example:

Supposing the following decoded token claim: 

{
    "username": "John Doe",
    "permissions": {  # user_permissions_key
        "finances": 0,
        "it": 0,
    },
}

TYPE: str | None DEFAULT: None

algorithms

JWT token decode algorithm, by default "HS256". See Python-jose docs for more details.

TYPE: str DEFAULT: 'HS256'

Source code in missil/bearers.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__(
    self,
    token_key: str,
    secret_key: str,
    user_permissions_key: str | None = None,
    algorithms: str = "HS256",
):
    """
    JWT token obtaining and decoding.

    Parameters
    ----------
    token_key : str
        Name of the header or http cookie key where the token bearing user
        permissions is stored.
    secret_key : str
        Key used to decode the JWT token. See Python-jose docs for more details.
    user_permissions_key : str | None, optional
        Key name of the object specifying user permissions on the
        decoded JWT token, by default None. Example:

        Supposing the following decoded token claim:
        ```python
        {
            "username": "John Doe",
            "permissions": {  # user_permissions_key
                "finances": 0,
                "it": 0,
            },
        }
        ```

    algorithms : str, optional
        JWT token decode algorithm, by default "HS256". See Python-jose docs
        for more details.
    """
    self.token_key = token_key
    self.token_secret_key = secret_key
    self.algorithm = algorithms
    self.user_permissions_key = user_permissions_key

token_key instance-attribute 

token_key = token_key

token_secret_key instance-attribute 

token_secret_key = secret_key

algorithm instance-attribute 

algorithm = algorithms

user_permissions_key instance-attribute 

user_permissions_key = user_permissions_key

split_token_str 

split_token_str(token, sep=' ')

Get only the token value from the source.

Source code in missil/bearers.py 
62
63
64
65
66
67
def split_token_str(self, token: str, sep: str = " ") -> str:
    """Get only the token value from the source."""
    if "bearer" in token.lower():
        token = token.split(sep)[-1]

    return token

get_token_from_cookies 

get_token_from_cookies(request)

Read the token value from http cookies.

Source code in missil/bearers.py 
69
70
71
72
73
74
75
76
77
78
79
def get_token_from_cookies(self, request: Request) -> str:
    """Read the token value from http cookies."""
    token = request.cookies.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request cookies using key '{self.token_key}'",
        )

    return self.split_token_str(token)

get_token_from_header 

get_token_from_header(request)

Get the token value from request headers.

Source code in missil/bearers.py 
81
82
83
84
85
86
87
88
89
90
91
def get_token_from_header(self, request: Request) -> str:
    """Get the token value from request headers."""
    token = request.headers.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request headers using key '{self.token_key}'",
        )

    return self.split_token_str(token)

decode_jwt 

decode_jwt(token)

Decode a retrieved token value and return the user permissions.

Source code in missil/bearers.py 
93
94
95
96
97
98
def decode_jwt(self, token: str) -> dict[str, int]:
    """Decode a retrieved token value and return the user permissions."""
    decoded_token = decode_jwt_token(
        token, self.token_secret_key, algorithm=self.algorithm
    )
    return decoded_token

decode_from_cookies 

decode_from_cookies(request)

Get token from cookies and decode it.

Source code in missil/bearers.py 
100
101
102
103
def decode_from_cookies(self, request: Request) -> dict[str, Any]:
    """Get token from cookies and decode it."""
    token = self.get_token_from_cookies(request)
    return self.decode_jwt(token)

decode_from_header 

decode_from_header(request)

Get token from headers and decode it.

Source code in missil/bearers.py 
105
106
107
108
def decode_from_header(self, request: Request) -> dict[str, Any]:
    """Get token from headers and decode it."""
    token = self.get_token_from_header(request)
    return self.decode_jwt(token)

get_user_permissions 

get_user_permissions(decoded_token)

Get user permissions from a decoded token.

Source code in missil/bearers.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_user_permissions(self, decoded_token: dict[str, Any]) -> dict[str, int]:
    """Get user permissions from a decoded token."""
    if self.user_permissions_key:
        try:
            user_permissions: dict[str, int] = decoded_token[
                self.user_permissions_key
            ]
        except KeyError as ke:
            raise TokenErrorException(
                401,
                (
                    "User permissions not found at token key "
                    f"'{self.user_permissions_key}'"
                ),
            ) from ke
        else:
            return user_permissions

    raise TokenErrorException(500, "User permissions key not provided.")

HTTP Token Bearer

missil.HTTPTokenBearer 

HTTPTokenBearer(token_key, secret_key, user_permissions_key=None, algorithms='HS256')

Bases: TokenBearer

Read JWT token from the request header.

JWT token obtaining and decoding.

PARAMETER DESCRIPTION
token_key

Name of the header or http cookie key where the token bearing user permissions is stored.

TYPE: str

secret_key

Key used to decode the JWT token. See Python-jose docs for more details.

TYPE: str

user_permissions_key

Key name of the object specifying user permissions on the decoded JWT token, by default None. Example:

Supposing the following decoded token claim: 

{
    "username": "John Doe",
    "permissions": {  # user_permissions_key
        "finances": 0,
        "it": 0,
    },
}

TYPE: str | None DEFAULT: None

algorithms

JWT token decode algorithm, by default "HS256". See Python-jose docs for more details.

TYPE: str DEFAULT: 'HS256'

Source code in missil/bearers.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__(
    self,
    token_key: str,
    secret_key: str,
    user_permissions_key: str | None = None,
    algorithms: str = "HS256",
):
    """
    JWT token obtaining and decoding.

    Parameters
    ----------
    token_key : str
        Name of the header or http cookie key where the token bearing user
        permissions is stored.
    secret_key : str
        Key used to decode the JWT token. See Python-jose docs for more details.
    user_permissions_key : str | None, optional
        Key name of the object specifying user permissions on the
        decoded JWT token, by default None. Example:

        Supposing the following decoded token claim:
        ```python
        {
            "username": "John Doe",
            "permissions": {  # user_permissions_key
                "finances": 0,
                "it": 0,
            },
        }
        ```

    algorithms : str, optional
        JWT token decode algorithm, by default "HS256". See Python-jose docs
        for more details.
    """
    self.token_key = token_key
    self.token_secret_key = secret_key
    self.algorithm = algorithms
    self.user_permissions_key = user_permissions_key

token_key instance-attribute 

token_key = token_key

token_secret_key instance-attribute 

token_secret_key = secret_key

algorithm instance-attribute 

algorithm = algorithms

user_permissions_key instance-attribute 

user_permissions_key = user_permissions_key

split_token_str 

split_token_str(token, sep=' ')

Get only the token value from the source.

Source code in missil/bearers.py 
62
63
64
65
66
67
def split_token_str(self, token: str, sep: str = " ") -> str:
    """Get only the token value from the source."""
    if "bearer" in token.lower():
        token = token.split(sep)[-1]

    return token

get_token_from_cookies 

get_token_from_cookies(request)

Read the token value from http cookies.

Source code in missil/bearers.py 
69
70
71
72
73
74
75
76
77
78
79
def get_token_from_cookies(self, request: Request) -> str:
    """Read the token value from http cookies."""
    token = request.cookies.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request cookies using key '{self.token_key}'",
        )

    return self.split_token_str(token)

get_token_from_header 

get_token_from_header(request)

Get the token value from request headers.

Source code in missil/bearers.py 
81
82
83
84
85
86
87
88
89
90
91
def get_token_from_header(self, request: Request) -> str:
    """Get the token value from request headers."""
    token = request.headers.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request headers using key '{self.token_key}'",
        )

    return self.split_token_str(token)

decode_jwt 

decode_jwt(token)

Decode a retrieved token value and return the user permissions.

Source code in missil/bearers.py 
93
94
95
96
97
98
def decode_jwt(self, token: str) -> dict[str, int]:
    """Decode a retrieved token value and return the user permissions."""
    decoded_token = decode_jwt_token(
        token, self.token_secret_key, algorithm=self.algorithm
    )
    return decoded_token

decode_from_cookies 

decode_from_cookies(request)

Get token from cookies and decode it.

Source code in missil/bearers.py 
100
101
102
103
def decode_from_cookies(self, request: Request) -> dict[str, Any]:
    """Get token from cookies and decode it."""
    token = self.get_token_from_cookies(request)
    return self.decode_jwt(token)

decode_from_header 

decode_from_header(request)

Get token from headers and decode it.

Source code in missil/bearers.py 
105
106
107
108
def decode_from_header(self, request: Request) -> dict[str, Any]:
    """Get token from headers and decode it."""
    token = self.get_token_from_header(request)
    return self.decode_jwt(token)

get_user_permissions 

get_user_permissions(decoded_token)

Get user permissions from a decoded token.

Source code in missil/bearers.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_user_permissions(self, decoded_token: dict[str, Any]) -> dict[str, int]:
    """Get user permissions from a decoded token."""
    if self.user_permissions_key:
        try:
            user_permissions: dict[str, int] = decoded_token[
                self.user_permissions_key
            ]
        except KeyError as ke:
            raise TokenErrorException(
                401,
                (
                    "User permissions not found at token key "
                    f"'{self.user_permissions_key}'"
                ),
            ) from ke
        else:
            return user_permissions

    raise TokenErrorException(500, "User permissions key not provided.")

Flexible Token Bearer

missil.FlexibleTokenBearer 

FlexibleTokenBearer(token_key, secret_key, user_permissions_key=None, algorithms='HS256')

Bases: TokenBearer

Tries to read the token from the cookies or from request headers.

JWT token obtaining and decoding.

PARAMETER DESCRIPTION
token_key

Name of the header or http cookie key where the token bearing user permissions is stored.

TYPE: str

secret_key

Key used to decode the JWT token. See Python-jose docs for more details.

TYPE: str

user_permissions_key

Key name of the object specifying user permissions on the decoded JWT token, by default None. Example:

Supposing the following decoded token claim: 

{
    "username": "John Doe",
    "permissions": {  # user_permissions_key
        "finances": 0,
        "it": 0,
    },
}

TYPE: str | None DEFAULT: None

algorithms

JWT token decode algorithm, by default "HS256". See Python-jose docs for more details.

TYPE: str DEFAULT: 'HS256'

Source code in missil/bearers.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__(
    self,
    token_key: str,
    secret_key: str,
    user_permissions_key: str | None = None,
    algorithms: str = "HS256",
):
    """
    JWT token obtaining and decoding.

    Parameters
    ----------
    token_key : str
        Name of the header or http cookie key where the token bearing user
        permissions is stored.
    secret_key : str
        Key used to decode the JWT token. See Python-jose docs for more details.
    user_permissions_key : str | None, optional
        Key name of the object specifying user permissions on the
        decoded JWT token, by default None. Example:

        Supposing the following decoded token claim:
        ```python
        {
            "username": "John Doe",
            "permissions": {  # user_permissions_key
                "finances": 0,
                "it": 0,
            },
        }
        ```

    algorithms : str, optional
        JWT token decode algorithm, by default "HS256". See Python-jose docs
        for more details.
    """
    self.token_key = token_key
    self.token_secret_key = secret_key
    self.algorithm = algorithms
    self.user_permissions_key = user_permissions_key

token_key instance-attribute 

token_key = token_key

token_secret_key instance-attribute 

token_secret_key = secret_key

algorithm instance-attribute 

algorithm = algorithms

user_permissions_key instance-attribute 

user_permissions_key = user_permissions_key

split_token_str 

split_token_str(token, sep=' ')

Get only the token value from the source.

Source code in missil/bearers.py 
62
63
64
65
66
67
def split_token_str(self, token: str, sep: str = " ") -> str:
    """Get only the token value from the source."""
    if "bearer" in token.lower():
        token = token.split(sep)[-1]

    return token

get_token_from_cookies 

get_token_from_cookies(request)

Read the token value from http cookies.

Source code in missil/bearers.py 
69
70
71
72
73
74
75
76
77
78
79
def get_token_from_cookies(self, request: Request) -> str:
    """Read the token value from http cookies."""
    token = request.cookies.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request cookies using key '{self.token_key}'",
        )

    return self.split_token_str(token)

get_token_from_header 

get_token_from_header(request)

Get the token value from request headers.

Source code in missil/bearers.py 
81
82
83
84
85
86
87
88
89
90
91
def get_token_from_header(self, request: Request) -> str:
    """Get the token value from request headers."""
    token = request.headers.get(self.token_key)

    if not token:
        raise TokenErrorException(
            status.HTTP_403_FORBIDDEN,
            f"Token not found on request headers using key '{self.token_key}'",
        )

    return self.split_token_str(token)

decode_jwt 

decode_jwt(token)

Decode a retrieved token value and return the user permissions.

Source code in missil/bearers.py 
93
94
95
96
97
98
def decode_jwt(self, token: str) -> dict[str, int]:
    """Decode a retrieved token value and return the user permissions."""
    decoded_token = decode_jwt_token(
        token, self.token_secret_key, algorithm=self.algorithm
    )
    return decoded_token

decode_from_cookies 

decode_from_cookies(request)

Get token from cookies and decode it.

Source code in missil/bearers.py 
100
101
102
103
def decode_from_cookies(self, request: Request) -> dict[str, Any]:
    """Get token from cookies and decode it."""
    token = self.get_token_from_cookies(request)
    return self.decode_jwt(token)

decode_from_header 

decode_from_header(request)

Get token from headers and decode it.

Source code in missil/bearers.py 
105
106
107
108
def decode_from_header(self, request: Request) -> dict[str, Any]:
    """Get token from headers and decode it."""
    token = self.get_token_from_header(request)
    return self.decode_jwt(token)

get_user_permissions 

get_user_permissions(decoded_token)

Get user permissions from a decoded token.

Source code in missil/bearers.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_user_permissions(self, decoded_token: dict[str, Any]) -> dict[str, int]:
    """Get user permissions from a decoded token."""
    if self.user_permissions_key:
        try:
            user_permissions: dict[str, int] = decoded_token[
                self.user_permissions_key
            ]
        except KeyError as ke:
            raise TokenErrorException(
                401,
                (
                    "User permissions not found at token key "
                    f"'{self.user_permissions_key}'"
                ),
            ) from ke
        else:
            return user_permissions

    raise TokenErrorException(500, "User permissions key not provided.")