Keep track of failed login attempts in Django-powered sites.
Find a file
Bruno Alla 2fb4c81243 feat: pass username to AXES_COOLOFF_TIME callback
If the AXES_COOLOFF_TIME is a callable or path to a callable taking
an argument, pass the username to it.

This should enable users to customize the cool off to be user dependant,
and possibly implement a growing cool-off time:

- First lockout cools off after 5 mins
- Second one after 10 mins
- etc...
2024-10-02 20:15:31 +03:00
.github Remove max-parallel limits for tests 2024-09-21 13:12:21 +03:00
axes feat: pass username to AXES_COOLOFF_TIME callback 2024-10-02 20:15:31 +03:00
docs feat: pass username to AXES_COOLOFF_TIME callback 2024-10-02 20:15:31 +03:00
tests feat: pass username to AXES_COOLOFF_TIME callback 2024-10-02 20:15:31 +03:00
.gitignore chore: add venv to .gitignore 2023-04-26 18:27:33 +03:00
.pre-commit-config.yaml Add .pre-commit-config.yaml 2021-10-12 10:10:05 +03:00
.prospector.yaml Update prospector to 1.8.2 2022-12-03 14:12:51 +02:00
.readthedocs.yaml Clean up RTD build spec 2023-08-17 12:42:58 +03:00
CHANGES.rst Version 6.5.2 2024-09-21 13:04:35 +03:00
CODE_OF_CONDUCT.md Jazzband: Created local 'CODE_OF_CONDUCT.md' from remote 'CODE_OF_CONDUCT.md' 2021-10-21 14:34:07 +00:00
codecov.yml Raise minimum test coverage to 90% 2019-02-10 19:22:13 +02:00
CONTRIBUTING.rst docs: add CONTRIBUTING.rst 2023-04-27 22:04:55 +03:00
LICENSE Update author and licence information 2019-03-13 16:56:56 +02:00
manage.py Move tests outside project source folder 2021-01-07 18:23:33 +02:00
mypy.ini Drop Python 3.7 support 2023-05-17 20:33:11 +03:00
pyproject.toml Drop PyPy support 2024-09-21 13:02:49 +03:00
README.rst Update README.rst 2024-07-01 17:35:43 +03:00
requirements-qa.txt chore(deps): bump mypy from 1.11.1 to 1.11.2 2024-09-21 07:51:35 +00:00
requirements-test.txt Merge pull request #1225 from jazzband/dependabot/pip/pytest-django-4.9.0 2024-09-21 11:33:19 +03:00
requirements.txt chore(deps): bump tox from 4.20.0 to 4.21.0 2024-10-01 12:30:43 +00:00
setup.py Drop PyPy support 2024-09-21 13:02:49 +03:00

django-axes
===========

.. image:: https://jazzband.co/static/img/badge.svg
   :target: https://jazzband.co/
   :alt: Jazzband

.. image:: https://img.shields.io/github/stars/jazzband/django-axes.svg?label=Stars&style=socialcA
   :target: https://github.com/jazzband/django-axes
   :alt: GitHub

.. image:: https://img.shields.io/pypi/v/django-axes.svg
   :target: https://pypi.org/project/django-axes/
   :alt: PyPI release

.. image:: https://img.shields.io/pypi/pyversions/django-axes.svg
   :target: https://pypi.org/project/django-axes/
   :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/djversions/django-axes.svg
   :target: https://pypi.org/project/django-axes/
   :alt: Supported Django versions

.. image:: https://img.shields.io/readthedocs/django-axes.svg
   :target: https://django-axes.readthedocs.io/
   :alt: Documentation

.. image:: https://github.com/jazzband/django-axes/workflows/Test/badge.svg
   :target: https://github.com/jazzband/django-axes/actions
   :alt: GitHub Actions

.. image:: https://codecov.io/gh/jazzband/django-axes/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/jazzband/django-axes
   :alt: Coverage


Axes is a Django plugin for keeping track of suspicious
login attempts for your Django based website
and implementing simple brute-force attack blocking.

The name is sort of a geeky pun, since it can be interpreted as:

* ``access``, as in monitoring access attempts, or
* ``axes``, as in tools you can use to hack (generally on wood).


Functionality
-------------

Axes records login attempts to your Django powered site and prevents attackers
from attempting further logins to your site when they exceed the configured attempt limit.

Axes can track the attempts and persist them in the database indefinitely,
or alternatively use a fast and DDoS resistant cache implementation.

Axes can be configured to monitor login attempts by
IP address, username, user agent, or their combinations.

Axes supports cool off periods, IP address allow listing and block listing,
user account allow listing, and other features for Django access management.


Documentation
-------------

For more information on installation and configuration see the documentation at:

https://django-axes.readthedocs.io/


Issues
------

If you have questions or have trouble using the app please file a bug report at:

https://github.com/jazzband/django-axes/issues


Contributing
------------

See `CONTRIBUTING <CONTRIBUTING.rst>`__.