1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
from __future__ import annotations
from typing import TYPE_CHECKING, Awaitable, Callable, Sequence
from litestar.exceptions import NotAuthorizedException
from litestar.middleware.authentication import (
AbstractAuthenticationMiddleware,
AuthenticationResult,
)
from litestar.security.jwt.token import Token
__all__ = ("JWTAuthenticationMiddleware", "JWTCookieAuthenticationMiddleware")
if TYPE_CHECKING:
from typing import Any
from litestar.connection import ASGIConnection
from litestar.types import ASGIApp, Method, Scopes
class JWTAuthenticationMiddleware(AbstractAuthenticationMiddleware):
"""JWT Authentication middleware.
This class provides JWT authentication functionalities.
"""
__slots__ = (
"algorithm",
"auth_header",
"retrieve_user_handler",
"token_secret",
)
def __init__(
self,
algorithm: str,
app: ASGIApp,
auth_header: str,
exclude: str | list[str] | None,
exclude_http_methods: Sequence[Method] | None,
exclude_opt_key: str,
retrieve_user_handler: Callable[[Token, ASGIConnection[Any, Any, Any, Any]], Awaitable[Any]],
scopes: Scopes,
token_secret: str,
) -> None:
"""Check incoming requests for an encoded token in the auth header specified, and if present retrieve the user
from persistence using the provided function.
Args:
algorithm: JWT hashing algorithm to use.
app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack.
auth_header: Request header key from which to retrieve the token. E.g. ``Authorization`` or ``X-Api-Key``.
exclude: A pattern or list of patterns to skip.
exclude_opt_key: An identifier to use on routes to disable authentication for a particular route.
exclude_http_methods: A sequence of http methods that do not require authentication.
retrieve_user_handler: A function that receives a :class:`Token <.security.jwt.Token>` and returns a user,
which can be any arbitrary value.
scopes: ASGI scopes processed by the authentication middleware.
token_secret: Secret for decoding the JWT token. This value should be equivalent to the secret used to
encode it.
"""
super().__init__(
app=app,
exclude=exclude,
exclude_from_auth_key=exclude_opt_key,
exclude_http_methods=exclude_http_methods,
scopes=scopes,
)
self.algorithm = algorithm
self.auth_header = auth_header
self.retrieve_user_handler = retrieve_user_handler
self.token_secret = token_secret
async def authenticate_request(self, connection: ASGIConnection[Any, Any, Any, Any]) -> AuthenticationResult:
"""Given an HTTP Connection, parse the JWT api key stored in the header and retrieve the user correlating to the
token from the DB.
Args:
connection: An Litestar HTTPConnection instance.
Returns:
AuthenticationResult
Raises:
NotAuthorizedException: If token is invalid or user is not found.
"""
auth_header = connection.headers.get(self.auth_header)
if not auth_header:
raise NotAuthorizedException("No JWT token found in request header")
encoded_token = auth_header.partition(" ")[-1]
return await self.authenticate_token(encoded_token=encoded_token, connection=connection)
async def authenticate_token(
self, encoded_token: str, connection: ASGIConnection[Any, Any, Any, Any]
) -> AuthenticationResult:
"""Given an encoded JWT token, parse, validate and look up sub within token.
Args:
encoded_token: Encoded JWT token.
connection: An ASGI connection instance.
Raises:
NotAuthorizedException: If token is invalid or user is not found.
Returns:
AuthenticationResult
"""
token = Token.decode(
encoded_token=encoded_token,
secret=self.token_secret,
algorithm=self.algorithm,
)
user = await self.retrieve_user_handler(token, connection)
if not user:
raise NotAuthorizedException()
return AuthenticationResult(user=user, auth=token)
class JWTCookieAuthenticationMiddleware(JWTAuthenticationMiddleware):
"""Cookie based JWT authentication middleware."""
__slots__ = ("auth_cookie_key",)
def __init__(
self,
algorithm: str,
app: ASGIApp,
auth_cookie_key: str,
auth_header: str,
exclude: str | list[str] | None,
exclude_opt_key: str,
exclude_http_methods: Sequence[Method] | None,
retrieve_user_handler: Callable[[Token, ASGIConnection[Any, Any, Any, Any]], Awaitable[Any]],
scopes: Scopes,
token_secret: str,
) -> None:
"""Check incoming requests for an encoded token in the auth header or cookie name specified, and if present
retrieves the user from persistence using the provided function.
Args:
algorithm: JWT hashing algorithm to use.
app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack.
auth_cookie_key: Cookie name from which to retrieve the token. E.g. ``token`` or ``accessToken``.
auth_header: Request header key from which to retrieve the token. E.g. ``Authorization`` or ``X-Api-Key``.
exclude: A pattern or list of patterns to skip.
exclude_opt_key: An identifier to use on routes to disable authentication for a particular route.
exclude_http_methods: A sequence of http methods that do not require authentication.
retrieve_user_handler: A function that receives a :class:`Token <.security.jwt.Token>` and returns a user,
which can be any arbitrary value.
scopes: ASGI scopes processed by the authentication middleware.
token_secret: Secret for decoding the JWT token. This value should be equivalent to the secret used to
encode it.
"""
super().__init__(
algorithm=algorithm,
app=app,
auth_header=auth_header,
exclude=exclude,
exclude_http_methods=exclude_http_methods,
exclude_opt_key=exclude_opt_key,
retrieve_user_handler=retrieve_user_handler,
scopes=scopes,
token_secret=token_secret,
)
self.auth_cookie_key = auth_cookie_key
async def authenticate_request(self, connection: ASGIConnection[Any, Any, Any, Any]) -> AuthenticationResult:
"""Given an HTTP Connection, parse the JWT api key stored in the header and retrieve the user correlating to the
token from the DB.
Args:
connection: An Litestar HTTPConnection instance.
Raises:
NotAuthorizedException: If token is invalid or user is not found.
Returns:
AuthenticationResult
"""
auth_header = connection.headers.get(self.auth_header) or connection.cookies.get(self.auth_cookie_key)
if not auth_header:
raise NotAuthorizedException("No JWT token found in request header or cookies")
encoded_token = auth_header.partition(" ")[-1]
return await self.authenticate_token(encoded_token=encoded_token, connection=connection)
|
