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
|
from datetime import datetime
from datetime import timedelta
from datetime import timezone
from json import JSONEncoder
from typing import Iterable
from typing import List
from typing import Optional
from typing import Sequence
from typing import Type
from typing import Union
from flask import current_app
from jwt.algorithms import requires_cryptography
from flask_jwt_extended.internal_utils import get_json_encoder
from flask_jwt_extended.typing import ExpiresDelta
class _Config(object):
"""
Helper object for accessing and verifying options in this extension. This
is meant for internal use of the application; modifying config options
should be done with flasks ```app.config```.
Default values for the configuration options are set in the jwt_manager
object. All of these values are read only. This is simply a loose wrapper
with some helper functionality for flasks `app.config`.
"""
@property
def is_asymmetric(self) -> bool:
return self.algorithm in requires_cryptography
@property
def encode_key(self) -> str:
return self._private_key if self.is_asymmetric else self._secret_key
@property
def decode_key(self) -> str:
return self._public_key if self.is_asymmetric else self._secret_key
@property
def token_location(self) -> Sequence[str]:
locations = current_app.config["JWT_TOKEN_LOCATION"]
if isinstance(locations, str):
locations = (locations,)
elif not isinstance(locations, Iterable):
raise RuntimeError("JWT_TOKEN_LOCATION must be a sequence or a set")
elif not locations:
raise RuntimeError(
"JWT_TOKEN_LOCATION must contain at least one "
'of "headers", "cookies", "query_string", or "json"'
)
for location in locations:
if location not in ("headers", "cookies", "query_string", "json"):
raise RuntimeError(
"JWT_TOKEN_LOCATION can only contain "
'"headers", "cookies", "query_string", or "json"'
)
return locations
@property
def jwt_in_cookies(self) -> bool:
return "cookies" in self.token_location
@property
def jwt_in_headers(self) -> bool:
return "headers" in self.token_location
@property
def jwt_in_query_string(self) -> bool:
return "query_string" in self.token_location
@property
def jwt_in_json(self) -> bool:
return "json" in self.token_location
@property
def header_name(self) -> str:
name = current_app.config["JWT_HEADER_NAME"]
if not name:
raise RuntimeError("JWT_ACCESS_HEADER_NAME cannot be empty")
return name
@property
def header_type(self) -> str:
return current_app.config["JWT_HEADER_TYPE"]
@property
def query_string_name(self) -> str:
return current_app.config["JWT_QUERY_STRING_NAME"]
@property
def query_string_value_prefix(self) -> str:
return current_app.config["JWT_QUERY_STRING_VALUE_PREFIX"]
@property
def access_cookie_name(self) -> str:
return current_app.config["JWT_ACCESS_COOKIE_NAME"]
@property
def refresh_cookie_name(self) -> str:
return current_app.config["JWT_REFRESH_COOKIE_NAME"]
@property
def access_cookie_path(self) -> str:
return current_app.config["JWT_ACCESS_COOKIE_PATH"]
@property
def refresh_cookie_path(self) -> str:
return current_app.config["JWT_REFRESH_COOKIE_PATH"]
@property
def cookie_secure(self) -> bool:
return current_app.config["JWT_COOKIE_SECURE"]
@property
def cookie_domain(self) -> str:
return current_app.config["JWT_COOKIE_DOMAIN"]
@property
def session_cookie(self) -> bool:
return current_app.config["JWT_SESSION_COOKIE"]
@property
def cookie_samesite(self) -> str:
return current_app.config["JWT_COOKIE_SAMESITE"]
@property
def json_key(self) -> str:
return current_app.config["JWT_JSON_KEY"]
@property
def refresh_json_key(self) -> str:
return current_app.config["JWT_REFRESH_JSON_KEY"]
@property
def cookie_csrf_protect(self) -> bool:
return current_app.config["JWT_COOKIE_CSRF_PROTECT"]
@property
def csrf_request_methods(self) -> Iterable[str]:
return current_app.config["JWT_CSRF_METHODS"]
@property
def csrf_in_cookies(self) -> bool:
return current_app.config["JWT_CSRF_IN_COOKIES"]
@property
def access_csrf_cookie_name(self) -> str:
return current_app.config["JWT_ACCESS_CSRF_COOKIE_NAME"]
@property
def refresh_csrf_cookie_name(self) -> str:
return current_app.config["JWT_REFRESH_CSRF_COOKIE_NAME"]
@property
def access_csrf_cookie_path(self) -> str:
return current_app.config["JWT_ACCESS_CSRF_COOKIE_PATH"]
@property
def refresh_csrf_cookie_path(self) -> str:
return current_app.config["JWT_REFRESH_CSRF_COOKIE_PATH"]
@property
def access_csrf_header_name(self) -> str:
return current_app.config["JWT_ACCESS_CSRF_HEADER_NAME"]
@property
def refresh_csrf_header_name(self) -> str:
return current_app.config["JWT_REFRESH_CSRF_HEADER_NAME"]
@property
def csrf_check_form(self) -> bool:
return current_app.config["JWT_CSRF_CHECK_FORM"]
@property
def access_csrf_field_name(self) -> str:
return current_app.config["JWT_ACCESS_CSRF_FIELD_NAME"]
@property
def refresh_csrf_field_name(self) -> str:
return current_app.config["JWT_REFRESH_CSRF_FIELD_NAME"]
@property
def access_expires(self) -> ExpiresDelta:
delta = current_app.config["JWT_ACCESS_TOKEN_EXPIRES"]
if type(delta) is int:
delta = timedelta(seconds=delta)
if delta is not False:
try:
# Basically runtime typechecking. Probably a better way to do
# this with proper type checking
delta + datetime.now(timezone.utc)
except TypeError as e:
err = (
"must be able to add JWT_ACCESS_TOKEN_EXPIRES to datetime.datetime"
)
raise RuntimeError(err) from e
return delta
@property
def refresh_expires(self) -> ExpiresDelta:
delta = current_app.config["JWT_REFRESH_TOKEN_EXPIRES"]
if type(delta) is int:
delta = timedelta(seconds=delta)
if delta is not False:
# Basically runtime typechecking. Probably a better way to do
# this with proper type checking
try:
delta + datetime.now(timezone.utc)
except TypeError as e:
err = (
"must be able to add JWT_REFRESH_TOKEN_EXPIRES to datetime.datetime"
)
raise RuntimeError(err) from e
return delta
@property
def algorithm(self) -> str:
return current_app.config["JWT_ALGORITHM"]
@property
def decode_algorithms(self) -> List[str]:
algorithms = current_app.config["JWT_DECODE_ALGORITHMS"]
if not algorithms:
return [self.algorithm]
if self.algorithm not in algorithms:
algorithms.append(self.algorithm)
return algorithms
@property
def _secret_key(self) -> str:
key = current_app.config["JWT_SECRET_KEY"]
if not key:
key = current_app.config.get("SECRET_KEY", None)
if not key:
raise RuntimeError(
"JWT_SECRET_KEY or flask SECRET_KEY "
"must be set when using symmetric "
'algorithm "{}"'.format(self.algorithm)
)
return key
@property
def _public_key(self) -> str:
key = current_app.config["JWT_PUBLIC_KEY"]
if not key:
raise RuntimeError(
"JWT_PUBLIC_KEY must be set to use "
"asymmetric cryptography algorithm "
'"{}"'.format(self.algorithm)
)
return key
@property
def _private_key(self) -> str:
key = current_app.config["JWT_PRIVATE_KEY"]
if not key:
raise RuntimeError(
"JWT_PRIVATE_KEY must be set to use "
"asymmetric cryptography algorithm "
'"{}"'.format(self.algorithm)
)
return key
@property
def cookie_max_age(self) -> Optional[int]:
# Returns the appropiate value for max_age for flask set_cookies. If
# session cookie is true, return None, otherwise return a number of
# seconds 1 year in the future
return None if self.session_cookie else 31540000 # 1 year
@property
def identity_claim_key(self) -> str:
return current_app.config["JWT_IDENTITY_CLAIM"]
@property
def exempt_methods(self) -> Iterable[str]:
return {"OPTIONS"}
@property
def error_msg_key(self) -> str:
return current_app.config["JWT_ERROR_MESSAGE_KEY"]
@property
def json_encoder(self) -> Type[JSONEncoder]:
return get_json_encoder(current_app)
@property
def decode_audience(self) -> Union[str, Iterable[str]]:
return current_app.config["JWT_DECODE_AUDIENCE"]
@property
def encode_audience(self) -> Union[str, Iterable[str]]:
return current_app.config["JWT_ENCODE_AUDIENCE"]
@property
def encode_issuer(self) -> str:
return current_app.config["JWT_ENCODE_ISSUER"]
@property
def decode_issuer(self) -> str:
return current_app.config["JWT_DECODE_ISSUER"]
@property
def leeway(self) -> int:
return current_app.config["JWT_DECODE_LEEWAY"]
@property
def verify_sub(self) -> bool:
return current_app.config["JWT_VERIFY_SUB"]
@property
def encode_nbf(self) -> bool:
return current_app.config["JWT_ENCODE_NBF"]
config = _Config()
|
