Commit graph

101 commits

Author SHA1 Message Date
Aleksi Häkli
eedf528767
Update docs
Add new management commands and reorder sections logically.
2019-07-09 15:07:27 +02:00
Hasan Ramezani
6f2048f7ca Added AXES_ONLY_ADMIN_SITE flag. 2019-07-09 08:12:33 +02:00
Aleksi Häkli
9c7c5c175a
Add documentation for updated AXES_FAILURE_LIMIT 2019-06-14 17:21:24 +03:00
Aleksi Häkli
dfcc63b2cd
Improve documentation
Improve language for easier readability
Add missing Axes.W004 check code to docs
Update flow image with better diagram language
2019-06-02 13:23:52 +03:00
Aleksi Häkli
9caaf48b81
Update Django Allauth example
Use example from jazzband/django-oauth-toolkit#712
for reference with props to @hcNick for debugging
2019-05-30 17:44:08 +03:00
Aleksi Häkli
17e2d34b68
Update docs for Python 3 syntax 2019-05-30 17:29:45 +03:00
Aleksi Häkli
291ccdf233
Further update login flow diagram 2019-05-28 16:53:56 +03:00
Aleksi Häkli
77bac90c91
Update login flow diagram 2019-05-28 16:45:54 +03:00
Aleksi Häkli
1e796caa31
Improve architecture documentation 2019-05-26 21:30:08 +03:00
Aleksi Häkli
5f08037f78
Tune documentation titles 2019-05-26 17:42:52 +03:00
Aleksi Häkli
572addc84a
Add authentication flow diagram 2019-05-26 17:41:27 +03:00
Aleksi Häkli
67098c4669
Fix configuration list 2019-05-26 17:34:12 +03:00
Aleksi Häkli
5ab820db6a
Update architecture docs for exception handling
Version 5.0.5 migrated from exceptions to request flagging
which alters the internal behaviour slightly.
2019-05-25 21:12:50 +03:00
Aleksi Häkli
4b7650d37d
Improve middleware documentation 2019-05-25 21:04:47 +03:00
Aleksi Häkli
47ae68b0c0 Deprecate AXES_DISABLE_SUCCESS_ACCESS_LOG flag
Fixes #446
2019-05-25 20:45:21 +03:00
Aleksi Häkli
f028c7d2be Clean up docs on configuration flags
Use separate line for default value for readability
2019-05-25 20:45:21 +03:00
Aleksi Häkli
bfccbf0587
Fix typo in docs 2019-05-19 21:23:24 +03:00
Aleksi Häkli
8c2ae49f9a Add compatibility table 2019-05-19 18:32:40 +03:00
Aleksi Häkli
079263e181 Add Django OAuth Toolkit integration example 2019-05-19 18:32:40 +03:00
Aleksi Häkli
25e7d5cfd3 Fix note block syntax in docs 2019-05-19 18:32:40 +03:00
Aleksi Häkli
2e984f9fdd Fix DRF integration links 2019-05-19 18:32:40 +03:00
Aleksi Häkli
1fa76eb526 Improve usage documentation readability 2019-05-19 18:32:40 +03:00
Aleksi Häkli
465fe4529d Include documentation notes 2019-05-19 18:32:40 +03:00
Aleksi Häkli
f9e850fcbd Add instructions on silencing warnings from checks
Fixes #430
2019-05-19 18:32:40 +03:00
Aleksi Häkli
05fe0e306b Improve docs for attempt tracking, resets, and customization
Fixes #433
2019-05-19 18:32:40 +03:00
Aleksi Häkli
3152b4d7e9 Improve lockout and request handling
The old architecture used exceptions in the signal handler
which prevented transactions from running smoothly
and signal handlers from running after Axes handlers.

The new architecture changes the request approach to request flagging
and moves the exception handling into the middleware call method.

This allows users to more flexibly run their own signal handlers
and optionally use the Axes middleware if they want to do so.

Fixes #440
Fixes #442
2019-05-19 18:32:40 +03:00
Aleksi Häkli
816676f68d Add settings flag for disabling Axes
AXES_ENABLED = False can be used to toggle
the plugin off in tests which use the built-in
Django test client login, force_login and logout
methods which do not supply a request views.

Fixes #433
2019-05-07 23:37:48 +03:00
Aleksi Häkli
16f96de8fd
Add changelog to documentation 2019-05-03 21:20:45 +03:00
Aleksi Häkli
7d979e2bdc
Update Python version support information in the docs 2019-05-01 18:38:59 +03:00
Aleksi Häkli
0a90a7d075
Improve documentation 2019-05-01 18:28:29 +03:00
Aleksi Häkli
29d7d769e6 Revert name change for cooloff_time template argument 2019-05-01 14:30:21 +03:00
Aleksi Häkli
d4dc3ba246 Improve documentation
Fixes #410
2019-04-27 18:51:02 +03:00
Aleksi Häkli
0a2620095a Fix typo in docs 2019-04-27 18:51:02 +03:00
Aleksi Häkli
1b3bd0f99e Improve command documentation format 2019-04-27 18:51:02 +03:00
Aleksi Häkli
430946a9d1 Rename AxesBaseHandler to AxesHandler 2019-04-27 18:51:02 +03:00
Aleksi Häkli
43cf2b94aa Add upgrade note for Python language support 2019-04-27 18:51:02 +03:00
Aleksi Häkli
41307e6c55 Add API reference into docs 2019-04-27 18:51:02 +03:00
Aleksi Häkli
3dc69a4f56 Clean up documentation line feeds 2019-04-27 18:51:02 +03:00
Aleksi Häkli
9b895941c8 Add section numbering to documentation 2019-04-27 18:51:02 +03:00
Aleksi Häkli
3bece1aaaa
Set Axes request attributes in middleware
Fixes #415

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-03-03 22:13:13 +02:00
Aleksi Häkli
b55cba78e6
Rename migrating to upgrading in docs
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-03-02 22:40:18 +02:00
Aleksi Häkli
5f61b0ae76
Improve documentation on axes.utils.reset
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-26 13:04:56 +02:00
Aleksi Häkli
ff6cb8bffd
Move utils to helpers module
In order to offer backwards compatible import path for the
axes.utils.reset function it has to have a separate
implementation that can be imported independently from
the axes.helpers functions that are used by the
AxesBaseHandler implementation.

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-25 22:54:40 +02:00
Aleksi Häkli
e50bbd4701
Enumerate documentation source files
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-25 22:35:44 +02:00
Aleksi Häkli
6d8aea8aab
Clean up documentation configuration
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-25 22:02:31 +02:00
Aleksi Häkli
677d4c48f4
Improve documentation
- Add information on handlers
- Document configuration options and precedences
- Restructure documentation for better readability

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-25 17:04:03 +02:00
Aleksi Häkli
e69d479f6a
Refactor handlers to a more pluggable format
- Define a base handler API with method signatures
- Move proxy handler to a separate path for importability
- Implement a database handler with clean external dependencies
- Change the authentication backend and decorators to use the authentication backend

This enables clean pluggable authentication backend definitions that users
can override and specialize with e.g. cached handlers in their own packages.

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-22 19:55:57 +02:00
Aleksi Häkli
139a2b38fb
Update changelog and documentation
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-22 19:55:55 +02:00
Aleksi Häkli
cd56631865
Refactor attempts and add NEVER_LOCKOUT_GET flag
- Move cache and cool off utility functions to the axes.utils module
- Clean up axes.attempts duplicate code in attempt and cache calculations
- Add stable implementation for AccessAttempt attribute calculation
  in the axes.attempts.get_filter_kwargs function

Fixes #398

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-13 18:20:04 +02:00
Aleksi Häkli
a9e9b0d984
Pluggable signal handler backend for lockouts
Implements a proxied API which enables overriding
a handler backend with a user supplied implementation.

Fixes #399

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-02-07 22:13:30 +02:00