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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
|
from typing import Any
from typing import Optional
import jwt
from flask import g
from flask import Response
from werkzeug.local import LocalProxy
from flask_jwt_extended.config import config
from flask_jwt_extended.internal_utils import get_jwt_manager
from flask_jwt_extended.typing import ExpiresDelta
from flask_jwt_extended.typing import Fresh
# Proxy to access the current user
current_user: Any = LocalProxy(lambda: get_current_user())
def get_jwt() -> dict:
"""
In a protected endpoint, this will return the python dictionary which has
the payload of the JWT that is accessing the endpoint. If no JWT is present
due to ``jwt_required(optional=True)``, an empty dictionary is returned.
:return:
The payload (claims) of the JWT in the current request
"""
decoded_jwt = g.get("_jwt_extended_jwt", None)
if decoded_jwt is None:
raise RuntimeError(
"You must call `@jwt_required()` or `verify_jwt_in_request()` "
"before using this method"
)
return decoded_jwt
def get_jwt_header() -> dict:
"""
In a protected endpoint, this will return the python dictionary which has
the header of the JWT that is accessing the endpoint. If no JWT is present
due to ``jwt_required(optional=True)``, an empty dictionary is returned.
:return:
The headers of the JWT in the current request
"""
decoded_header = g.get("_jwt_extended_jwt_header", None)
if decoded_header is None:
raise RuntimeError(
"You must call `@jwt_required()` or `verify_jwt_in_request()` "
"before using this method"
)
return decoded_header
def get_jwt_identity() -> Any:
"""
In a protected endpoint, this will return the identity of the JWT that is
accessing the endpoint. If no JWT is present due to
``jwt_required(optional=True)``, ``None`` is returned.
:return:
The identity of the JWT in the current request
"""
return get_jwt().get(config.identity_claim_key, None)
def get_jwt_request_location() -> Optional[str]:
"""
In a protected endpoint, this will return the "location" at which the JWT
that is accessing the endpoint was found--e.g., "cookies", "query-string",
"headers", or "json". If no JWT is present due to ``jwt_required(optional=True)``,
None is returned.
:return:
The location of the JWT in the current request; e.g., "cookies",
"query-string", "headers", or "json"
"""
return g.get("_jwt_extended_jwt_location", None)
def get_current_user() -> Any:
"""
In a protected endpoint, this will return the user object for the JWT that
is accessing the endpoint.
This is only usable if :meth:`~flask_jwt_extended.JWTManager.user_lookup_loader`
is configured. If the user loader callback is not being used, this will
raise an error.
If no JWT is present due to ``jwt_required(optional=True)``, ``None`` is returned.
:return:
The current user object for the JWT in the current request
"""
get_jwt() # Raise an error if not in a decorated context
jwt_user_dict = g.get("_jwt_extended_jwt_user", None)
if jwt_user_dict is None:
raise RuntimeError(
"You must provide a `@jwt.user_lookup_loader` callback to use "
"this method"
)
return jwt_user_dict["loaded_user"]
def decode_token(
encoded_token: str, csrf_value: Optional[str] = None, allow_expired: bool = False
) -> dict:
"""
Returns the decoded token (python dict) from an encoded JWT. This does all
the checks to ensure that the decoded token is valid before returning it.
This will not fire the user loader callbacks, save the token for access
in protected endpoints, checked if a token is revoked, etc. This is puerly
used to ensure that a JWT is valid.
:param encoded_token:
The encoded JWT to decode.
:param csrf_value:
Expected CSRF double submit value (optional).
:param allow_expired:
If ``True``, do not raise an error if the JWT is expired. Defaults to ``False``
:return:
Dictionary containing the payload of the JWT decoded JWT.
"""
jwt_manager = get_jwt_manager()
return jwt_manager._decode_jwt_from_config(encoded_token, csrf_value, allow_expired)
def create_access_token(
identity: Any,
fresh: Fresh = False,
expires_delta: Optional[ExpiresDelta] = None,
additional_claims=None,
additional_headers=None,
):
"""
Create a new access token.
:param identity:
The identity of this token. This must either be a string, or you must have
defined :meth:`~flask_jwt_extended.JWTManager.user_identity_loader` in order
to convert the object you passed in into a string.
:param fresh:
If this token should be marked as fresh, and can thus access endpoints
protected with ``@jwt_required(fresh=True)``. Defaults to ``False``.
This value can also be a ``datetime.timedelta``, which indicate
how long this token will be considered fresh.
:param expires_delta:
A ``datetime.timedelta`` for how long this token should last before it
expires. Set to False to disable expiration. If this is None, it will use
the ``JWT_ACCESS_TOKEN_EXPIRES`` config value (see :ref:`Configuration Options`)
:param additional_claims:
Optional. A hash of claims to include in the access token. These claims are
merged into the default claims (exp, iat, etc) and claims returned from the
:meth:`~flask_jwt_extended.JWTManager.additional_claims_loader` callback.
On conflict, these claims take precedence.
:param headers:
Optional. A hash of headers to include in the access token. These headers
are merged into the default headers (alg, typ) and headers returned from
the :meth:`~flask_jwt_extended.JWTManager.additional_headers_loader`
callback. On conflict, these headers take precedence.
:return:
An encoded access token
"""
jwt_manager = get_jwt_manager()
return jwt_manager._encode_jwt_from_config(
claims=additional_claims,
expires_delta=expires_delta,
fresh=fresh,
headers=additional_headers,
identity=identity,
token_type="access",
)
def create_refresh_token(
identity: Any,
expires_delta: Optional[ExpiresDelta] = None,
additional_claims=None,
additional_headers=None,
):
"""
Create a new refresh token.
:param identity:
The identity of this token. This must either be a string, or you must have
defined :meth:`~flask_jwt_extended.JWTManager.user_identity_loader` in order
to convert the object you passed in into a string.
:param expires_delta:
A ``datetime.timedelta`` for how long this token should last before it expires.
Set to False to disable expiration. If this is None, it will use the
``JWT_REFRESH_TOKEN_EXPIRES`` config value (see :ref:`Configuration Options`)
:param additional_claims:
Optional. A hash of claims to include in the refresh token. These claims are
merged into the default claims (exp, iat, etc) and claims returned from the
:meth:`~flask_jwt_extended.JWTManager.additional_claims_loader` callback.
On conflict, these claims take precedence.
:param headers:
Optional. A hash of headers to include in the refresh token. These headers
are merged into the default headers (alg, typ) and headers returned from the
:meth:`~flask_jwt_extended.JWTManager.additional_headers_loader` callback.
On conflict, these headers take precedence.
:return:
An encoded refresh token
"""
jwt_manager = get_jwt_manager()
return jwt_manager._encode_jwt_from_config(
claims=additional_claims,
expires_delta=expires_delta,
fresh=False,
headers=additional_headers,
identity=identity,
token_type="refresh",
)
def get_unverified_jwt_headers(encoded_token: str) -> dict:
"""
Returns the Headers of an encoded JWT without verifying the signature of the JWT.
:param encoded_token:
The encoded JWT to get the Header from.
:return:
JWT header parameters as python dict()
"""
return jwt.get_unverified_header(encoded_token)
def get_jti(encoded_token: str) -> Optional[str]:
"""
Returns the JTI (unique identifier) of an encoded JWT
:param encoded_token:
The encoded JWT to get the JTI from.
:return:
The JTI (unique identifier) of a JWT, if it is present.
"""
return decode_token(encoded_token).get("jti")
def get_csrf_token(encoded_token: str) -> str:
"""
Returns the CSRF double submit token from an encoded JWT.
:param encoded_token:
The encoded JWT
:return:
The CSRF double submit token (string)
"""
token = decode_token(encoded_token)
return token["csrf"]
def set_access_cookies(
response: Response, encoded_access_token: str, max_age=None, domain=None
) -> None:
"""
Modifiy a Flask Response to set a cookie containing the access JWT.
Also sets the corresponding CSRF cookies if ``JWT_CSRF_IN_COOKIES`` is ``True``
(see :ref:`Configuration Options`)
:param response:
A Flask Response object.
:param encoded_access_token:
The encoded access token to set in the cookies.
:param max_age:
The max age of the cookie. If this is None, it will use the
``JWT_SESSION_COOKIE`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``max-age`` and the JWT_SESSION_COOKIE option
will be ignored. Values should be the number of seconds (as an integer).
:param domain:
The domain of the cookie. If this is None, it will use the
``JWT_COOKIE_DOMAIN`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``domain`` and the JWT_COOKIE_DOMAIN option
will be ignored.
"""
response.set_cookie(
config.access_cookie_name,
value=encoded_access_token,
max_age=max_age or config.cookie_max_age,
secure=config.cookie_secure,
httponly=True,
domain=domain or config.cookie_domain,
path=config.access_cookie_path,
samesite=config.cookie_samesite,
)
if config.cookie_csrf_protect and config.csrf_in_cookies:
response.set_cookie(
config.access_csrf_cookie_name,
value=get_csrf_token(encoded_access_token),
max_age=max_age or config.cookie_max_age,
secure=config.cookie_secure,
httponly=False,
domain=domain or config.cookie_domain,
path=config.access_csrf_cookie_path,
samesite=config.cookie_samesite,
)
def set_refresh_cookies(
response: Response,
encoded_refresh_token: str,
max_age: Optional[int] = None,
domain: Optional[str] = None,
) -> None:
"""
Modifiy a Flask Response to set a cookie containing the refresh JWT.
Also sets the corresponding CSRF cookies if ``JWT_CSRF_IN_COOKIES`` is ``True``
(see :ref:`Configuration Options`)
:param response:
A Flask Response object.
:param encoded_refresh_token:
The encoded refresh token to set in the cookies.
:param max_age:
The max age of the cookie. If this is None, it will use the
``JWT_SESSION_COOKIE`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``max-age`` and the JWT_SESSION_COOKIE option
will be ignored. Values should be the number of seconds (as an integer).
:param domain:
The domain of the cookie. If this is None, it will use the
``JWT_COOKIE_DOMAIN`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``domain`` and the JWT_COOKIE_DOMAIN option
will be ignored.
"""
response.set_cookie(
config.refresh_cookie_name,
value=encoded_refresh_token,
max_age=max_age or config.cookie_max_age,
secure=config.cookie_secure,
httponly=True,
domain=domain or config.cookie_domain,
path=config.refresh_cookie_path,
samesite=config.cookie_samesite,
)
if config.cookie_csrf_protect and config.csrf_in_cookies:
response.set_cookie(
config.refresh_csrf_cookie_name,
value=get_csrf_token(encoded_refresh_token),
max_age=max_age or config.cookie_max_age,
secure=config.cookie_secure,
httponly=False,
domain=domain or config.cookie_domain,
path=config.refresh_csrf_cookie_path,
samesite=config.cookie_samesite,
)
def unset_jwt_cookies(response: Response, domain: Optional[str] = None) -> None:
"""
Modifiy a Flask Response to delete the cookies containing access or refresh
JWTs. Also deletes the corresponding CSRF cookies if applicable.
:param response:
A Flask Response object
"""
unset_access_cookies(response, domain)
unset_refresh_cookies(response, domain)
def unset_access_cookies(response: Response, domain: Optional[str] = None) -> None:
"""
Modifiy a Flask Response to delete the cookie containing an access JWT.
Also deletes the corresponding CSRF cookie if applicable.
:param response:
A Flask Response object
:param domain:
The domain of the cookie. If this is None, it will use the
``JWT_COOKIE_DOMAIN`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``domain`` and the JWT_COOKIE_DOMAIN option
will be ignored.
"""
response.set_cookie(
config.access_cookie_name,
value="",
expires=0,
secure=config.cookie_secure,
httponly=True,
domain=domain or config.cookie_domain,
path=config.access_cookie_path,
samesite=config.cookie_samesite,
)
if config.cookie_csrf_protect and config.csrf_in_cookies:
response.set_cookie(
config.access_csrf_cookie_name,
value="",
expires=0,
secure=config.cookie_secure,
httponly=False,
domain=domain or config.cookie_domain,
path=config.access_csrf_cookie_path,
samesite=config.cookie_samesite,
)
def unset_refresh_cookies(response: Response, domain: Optional[str] = None) -> None:
"""
Modifiy a Flask Response to delete the cookie containing a refresh JWT.
Also deletes the corresponding CSRF cookie if applicable.
:param response:
A Flask Response object
:param domain:
The domain of the cookie. If this is None, it will use the
``JWT_COOKIE_DOMAIN`` option (see :ref:`Configuration Options`). Otherwise,
it will use this as the cookies ``domain`` and the JWT_COOKIE_DOMAIN option
will be ignored.
"""
response.set_cookie(
config.refresh_cookie_name,
value="",
expires=0,
secure=config.cookie_secure,
httponly=True,
domain=domain or config.cookie_domain,
path=config.refresh_cookie_path,
samesite=config.cookie_samesite,
)
if config.cookie_csrf_protect and config.csrf_in_cookies:
response.set_cookie(
config.refresh_csrf_cookie_name,
value="",
expires=0,
secure=config.cookie_secure,
httponly=False,
domain=domain or config.cookie_domain,
path=config.refresh_csrf_cookie_path,
samesite=config.cookie_samesite,
)
def current_user_context_processor() -> Any:
return {"current_user": get_current_user()}
|