jwag956 / flask-security / 352
97%

DEFAULT BRANCH: master
Ran
Jobs 9
Files 24
Run time 8min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
352

push

travis-ci

web-flow 
fix/enhancement - Fix slow auth tokens. (#164)

Current auth tokens are slow because they use the user's password (hashed) as a uniquifier (the
user id isn't really enough since it might be reused). This requires checking the (hashed) password against
what is in the token on EVERY request - however hashing is (on purpose) slow. So this can add almost a whole second
to every request!

This PR introduces a new UserModel field - fs_uniquifier - that if present in the UserModel will be populated and used rather than the password. This results in 50x reduction in time when authenticating via token.

Furthermore, the actual token verification has been moved from request_loader into the UserMixin - so
that it could be overridden (creating the auth_token already was in the UserMixin).

Note that this does require a DB migration to add the field. The fsqla model has been updated, and docs
describing at least one way to migrate the DB have been added.

2 new backwards compatibility configurations have been added that can revert some new default behavior.

First - in the past- the auth token was included always in JSON responses to login, reset and change -
even if the caller was a browser. This is
really not great since auth tokens may have very long expire times (or none) and it shouldn't even be sent if not needed.
Now, by default, the auth token is NEVER returned - the caller may request is during login, reset, or change by adding the
'include_auth_token' query param.

Second, since auth tokens used to be checked against the hashed password - changing a user's password meant that any
outstanding auth tokens would be invalidated. That seems like strange behavior - so by default, tokens that are verified
with the new fs_uniquifier won't be invalidated just because the user's password changes. The
BACKWARDS_COMPAT_AUTH_TOKEN_INVALID config variable will cause the fs_uniquifier to be changed whenever the user's password changes, thus rest... (continued)

2140 of 2274 relevant lines covered (94.11%)

8.47 hits per line

Jobs
ID Job ID Ran Files Coverage
1 352.1 (REQUIREMENTS=lowest) 0
94.07
 Travis Job 352.1
2 352.2 (REQUIREMENTS=lowest) 0
94.06
 Travis Job 352.2
3 352.3 (REQUIREMENTS=lowest) 0
94.06
 Travis Job 352.3
4 352.4 (REQUIREMENTS=lowest) 0
94.06
 Travis Job 352.4
5 352.5 (REQUIREMENTS=release) 0
97.1
 Travis Job 352.5
6 352.6 (REQUIREMENTS=release) 0
97.09
 Travis Job 352.6
7 352.7 (REQUIREMENTS=release) 0
97.09
 Travis Job 352.7
8 352.8 (REQUIREMENTS=release) 0
97.14
 Travis Job 352.8
9 352.9 (REQUIREMENTS=lowest) 0
94.07
 Travis Job 352.9
Source Files on build 352
Detailed source file information is not available for this build.