diff -pruN 5.39.0-6/.github/ISSUE_TEMPLATE/bug_report.md 7.0.1-0ubuntu1/.github/ISSUE_TEMPLATE/bug_report.md --- 5.39.0-6/.github/ISSUE_TEMPLATE/bug_report.md 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/ISSUE_TEMPLATE/bug_report.md 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve django-axes +title: 'BUG: Short description of the problem' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. +2. +3. +4. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Your environment** +python version: +django version: +django-axes version: +Operating system: + +**Additional context** +Add any other context about the problem here. + +**Possible implementation** +Not obligatory, but suggest an idea for implementing addition or change diff -pruN 5.39.0-6/.github/ISSUE_TEMPLATE/feature_request.md 7.0.1-0ubuntu1/.github/ISSUE_TEMPLATE/feature_request.md --- 5.39.0-6/.github/ISSUE_TEMPLATE/feature_request.md 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/ISSUE_TEMPLATE/feature_request.md 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for django-axes +title: 'FEATURE REQUEST: Short description of requested feature' +labels: 'feature request' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff -pruN 5.39.0-6/.github/PULL_REQUEST_TEMPLATE.md 7.0.1-0ubuntu1/.github/PULL_REQUEST_TEMPLATE.md --- 5.39.0-6/.github/PULL_REQUEST_TEMPLATE.md 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/PULL_REQUEST_TEMPLATE.md 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,19 @@ +# What does this PR do? + + + + + +Fixes # (issue) + + +## Before submitting +- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). +- [ ] Did you make sure to update the documentation with your changes? +- [ ] Did you write any new necessary tests? diff -pruN 5.39.0-6/.github/workflows/codeql.yml 7.0.1-0ubuntu1/.github/workflows/codeql.yml --- 5.39.0-6/.github/workflows/codeql.yml 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/workflows/codeql.yml 2024-12-02 16:23:57.000000000 +0000 @@ -14,11 +14,11 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 # Override language selection by uncommenting this and choosing your languages # with: # languages: go, javascript, csharp, python, cpp, java @@ -26,7 +26,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below). - name: Autobuild - uses: github/codeql-action/autobuild@v2 + uses: github/codeql-action/autobuild@v3 # ℹ️ Command-line programs to run using the OS shell. # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun @@ -40,4 +40,4 @@ jobs: # make release - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 diff -pruN 5.39.0-6/.github/workflows/release.yml 7.0.1-0ubuntu1/.github/workflows/release.yml --- 5.39.0-6/.github/workflows/release.yml 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/workflows/release.yml 2024-12-02 16:23:57.000000000 +0000 @@ -14,14 +14,14 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: - python-version: 3.8 + python-version: 3.9 - name: Install dependencies run: | @@ -36,8 +36,8 @@ jobs: - name: Upload packages to Jazzband if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') - uses: pypa/gh-action-pypi-publish@master + uses: pypa/gh-action-pypi-publish@release/v1 with: user: jazzband password: ${{ secrets.JAZZBAND_RELEASE_KEY }} - repository_url: https://jazzband.co/projects/django-axes/upload + repository-url: https://jazzband.co/projects/django-axes/upload diff -pruN 5.39.0-6/.github/workflows/test.yml 7.0.1-0ubuntu1/.github/workflows/test.yml --- 5.39.0-6/.github/workflows/test.yml 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/.github/workflows/test.yml 2024-12-02 16:23:57.000000000 +0000 @@ -11,44 +11,30 @@ jobs: runs-on: ubuntu-latest strategy: fail-fast: false - max-parallel: 5 matrix: - python-version: ['3.7', '3.8', '3.9', '3.10', 'pypy-3.8'] - django-version: ['3.2', '4.0', '4.1'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] + django-version: ['4.2', '5.0', '5.1'] include: # Tox configuration for QA environment - - python-version: '3.10' + - python-version: '3.13' django-version: 'qa' # Django main - - python-version: '3.8' - django-version: 'main' - experimental: true - - python-version: '3.9' - django-version: 'main' - experimental: true - - python-version: '3.10' - django-version: 'main' - experimental: true - - python-version: 'pypy-3.8' - django-version: '4.1' - experimental: true - - python-version: 'pypy-3.8' + - python-version: '3.13' django-version: 'main' experimental: true exclude: - # Exclude Python 3.7 for Django 4.0 and Django main - - python-version: '3.7' - django-version: '4.0' - - python-version: '3.7' - django-version: '4.1' - - python-version: '3.7' - django-version: 'main' + - python-version: '3.9' + django-version: '5.0' + - python-version: '3.13' + django-version: '5.0' + - python-version: '3.9' + django-version: '5.1' steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -58,7 +44,7 @@ jobs: echo "::set-output name=dir::$(pip cache dir)" - name: Cache - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: ${{ steps.pip-cache.outputs.dir }} key: diff -pruN 5.39.0-6/.gitignore 7.0.1-0ubuntu1/.gitignore --- 5.39.0-6/.gitignore 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/.gitignore 2024-12-02 16:23:57.000000000 +0000 @@ -16,4 +16,11 @@ docs/_build test.db .eggs pip-wheel-metadata -.vscode/ \ No newline at end of file +.vscode/ +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ diff -pruN 5.39.0-6/.prospector.yaml 7.0.1-0ubuntu1/.prospector.yaml --- 5.39.0-6/.prospector.yaml 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/.prospector.yaml 2024-12-02 16:23:57.000000000 +0000 @@ -5,3 +5,11 @@ ignore-paths: pycodestyle: options: max-line-length: 142 + +pylint: + disable: + - django-not-configured + +pyflakes: + disable: + - F401 diff -pruN 5.39.0-6/.readthedocs.yaml 7.0.1-0ubuntu1/.readthedocs.yaml --- 5.39.0-6/.readthedocs.yaml 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/.readthedocs.yaml 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,15 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.11" +sphinx: + configuration: docs/conf.py +formats: + - pdf + - epub +python: + install: + - requirements: requirements.txt diff -pruN 5.39.0-6/CHANGES.rst 7.0.1-0ubuntu1/CHANGES.rst --- 5.39.0-6/CHANGES.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/CHANGES.rst 2024-12-02 16:23:57.000000000 +0000 @@ -3,6 +3,196 @@ Changes ======= +7.0.1 (2024-12-02) +------------------ + +- Add Python 3.13 support. + [aleksihakli] +- Deprecate Python 3.8 support. + [aleksihakli] + + +7.0.0 (2024-10-02) +------------------ + +- Add support for dynamic cooloff time calculation from request. This is a breaking change. Please see `version 7 upgrade notes in the documentation `_. + [browniebroke] + + +6.5.2 (2024-09-21) +------------------ + +- Add test matrix support for Django 5.1. +- Drop support for EOL Django 3.2. +- Drop support for PyPy 3.10. + + +6.5.1 (2024-07-01) +------------------ + +- Make 0007_alter_accessattempt_unique_together.py migration backwards compatible. + [hirotasoshu] + + +6.5.0 (2024-06-11) +------------------ + +- Add session hash to access log. + [sevdog] + + +6.4.0 (2024-03-04) +------------------ + +- Add support for Python 3.12 and Django 5.0, drop support for Django 4.1. + [aleksihakli] + + +6.3.1 (2024-03-04) +------------------ + +- Drop ``setuptools`` and ``pkg_resources`` dependencies. + [Viicos] + + +6.3.0 (2023-12-27) +------------------ + +- Add async support to middleware. + [Taikono-Himazin] + + +6.2.0 (2023-12-08) +------------------ + +- Update documentation. + [funkybob] +- Add new management command ``axes_reset_ip_username``. + [p-l-] +- Add French translations. + [laulaz] +- Avoid running data migration on incorrect databases. + [christianbundy] + + +6.1.1 (2023-08-01) +------------------ + +- Fix ``TransactionManagementError`` when using the database handler + with a custom database with for ``AccessAttempt`` or ``AccessFailureLog``. + [hirotasoshu] + + +6.1.0 (2023-07-30) +------------------ + +- Set ``AXES_SENSITIVE_PARAMETERS`` default value to ``["username", "ip_address"]`` in addition to the ``AXES_PASSWORD_FORM_FIELD`` configuration flag. + This masks the username and IP address fields by default in the logs when writing information about login attempts to the application logs. + Reverting to old configuration default of ``[]`` can be done by setting ``AXES_SENSITIVE_PARAMETERS = []`` in the Django project settings file. + [GitRon] +- Improve documentation on GDPR and privacy notes and configuration flags. + [GitRon] + + +6.0.5 (2023-07-01) +------------------ + +- Add Indonesion translation. + [kiraware] + + +6.0.4 (2023-06-22) +------------------ + +- Remove unused methods from AxesStandaloneBackend. + [314eter] + + +6.0.3 (2023-06-18) +------------------ + +- Add username to admin fieldsets. + [sevdog] + + +6.0.2 (2023-06-13) +------------------ + +- Add Django system checks for validating callable import path settings. + [iafisher] +- Improve documentation. + [hirotasoshu] +- Improve repository issue and PR templates. + [hirotasoshu] + + +6.0.1 (2023-05-17) +------------------ + +- Fine-tune CI pipelines and RTD build requirements. + [aleksihakli] + + +6.0.0 (2023-05-17) +------------------ + +Version 6 is a breaking release. Please see the documentation for upgrade instructions. + +- Deprecate Python 3.7 support. + [aleksihakli] +- Deprecate ``is_admin_site`` API call with misleading naming. + [hirotasoshu] +- Add ``AXES_LOCKOUT_PARAMETERS`` configuration flag that will supersede ``AXES_ONLY_USER_FAILURES``, ``AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``, ``AXES_LOCK_OUT_BY_USER_OR_IP``, and ``AXES_USE_USER_AGENT`` configurations. Add deprecation warnings for old flags. See project documentation on RTD for update instructions. + [hirotasoshu] +- Improve translations. + [hirotasoshu] +- Use Django ``cache.incr`` API for atomic cached failure counting + [hirotasoshu, aleksihakli] +- Make ``django-ipware`` an optional dependency. Install it with e.g. ``pip install django-axes[ipware]`` package and extras specifier. [aleksihakli] +- Deprecate and rename old configuration flags. Old flags will be removed in or after version ``6.1``. [aleksihakli] + * ``AXES_PROXY_ORDER`` is now ``AXES_IPWARE_PROXY_ORDER``, + * ``AXES_PROXY_COUNT`` is now ``AXES_IPWARE_PROXY_COUNT``, + * ``AXES_PROXY_TRUSTED_IPS`` is now ``AXES_IPWARE_PROXY_TRUSTED_IPS``, and + * ``AXES_META_PRECEDENCE_ORDER`` is now ``AXES_IPWARE_META_PRECEDENCE_ORDER``. +- Set 429 as the default lockout response code. [hirotasoshu] + + +5.41.1 (2023-04-16) +------------------- + +- Fix sensitive parameter logging for database handler. [stereodamage] + +5.41.0 (2023-04-02) +------------------- + +- Fix tests. [hirotasoshu] +- Add ``AXES_CLIENT_CALLABLE`` setting. [hirotasoshu] +- Update Python, Django, and package versions. [hramezani] + + +5.40.1 (2022-11-24) +------------------- + +- Fix bug in user agent request blocking. [PetrDlouhy] + + +5.40.0 (2022-11-19) +------------------- + +- Update packages and linters for new version support. + [hramezani] +- Update documentation links. + [Arhell] +- Use importlib instead of setuptools for Python 3.8+. + [jedie] +- Python 3.11 support. + [joshuadavidthomas] +- Documentation improvements. + [nsht] +- Documentation improvements. + [timgates42] + + 5.39.0 (2022-08-18) ------------------- diff -pruN 5.39.0-6/CONTRIBUTING.rst 7.0.1-0ubuntu1/CONTRIBUTING.rst --- 5.39.0-6/CONTRIBUTING.rst 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/CONTRIBUTING.rst 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,72 @@ +.. image:: https://jazzband.co/static/img/jazzband.svg + :target: https://jazzband.co/ + :alt: Jazzband + +This is a `Jazzband `_ project. By contributing you agree to abide by the `Contributor Code of Conduct `_ and follow the `guidelines `_. + + +Contributions +============= + +All contributions are welcome! + +It is best to separate proposed changes and PRs into small, distinct patches +by type so that they can be merged faster into upstream and released quicker. + +One way to organize contributions would be to separate PRs for e.g. + +* bugfixes, +* new features, +* code and design improvements, +* documentation improvements, or +* tooling and CI improvements. + +Merging contributions requires passing the checks configured +with the CI. This includes running tests and linters successfully +on the currently officially supported Python and Django versions. + + +Development +=========== + +You can contribute to this project forking it from GitHub and sending pull requests. + +First `fork `_ the +`repository `_ and then clone it:: + + $ git clone git@github.com:/django-axes.git + +Initialize a virtual environment for development purposes:: + + $ mkdir -p ~/.virtualenvs + $ python3 -m venv ~/.virtualenvs/django-axes + $ source ~/.virtualenvs/django-axes/bin/activate + +Then install the necessary requirements:: + + $ cd django-axes + $ pip install -r requirements.txt + +Unit tests are located in the ``axes/tests`` folder and can be easily run with the pytest tool:: + + $ pytest + +Prospector runs a number of source code style, safety, and complexity checks:: + + $ prospector + +Mypy runs static typing checks to verify the source code type annotations and correctness:: + + $ mypy . + +Before committing, you can run all the above tests against all supported Python and Django versions with tox:: + + $ tox + +Tox runs the same test set that is run by GitHub Actions, and your code should be good to go if it passes. + +If you wish to limit the testing to specific environment(s), you can parametrize the tox run:: + + $ tox -e py39-django32 + +After you have pushed your changes, open a pull request on GitHub for getting your code upstreamed. diff -pruN 5.39.0-6/README.rst 7.0.1-0ubuntu1/README.rst --- 5.39.0-6/README.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/README.rst 2024-12-02 16:23:57.000000000 +0000 @@ -57,8 +57,8 @@ or alternatively use a fast and DDoS res Axes can be configured to monitor login attempts by IP address, username, user agent, or their combinations. -Axes supports cool off periods, IP address whitelisting and blacklisting, -user account whitelisting, and other features for Django access management. +Axes supports cool off periods, IP address allow listing and block listing, +user account allow listing, and other features for Django access management. Documentation @@ -77,30 +77,7 @@ If you have questions or have trouble us https://github.com/jazzband/django-axes/issues -Contributions -------------- - -All contributions are welcome! - -It is best to separate proposed changes and PRs into small, distinct patches -by type so that they can be merged faster into upstream and released quicker. - -One way to organize contributions would be to separate PRs for e.g. +Contributing +------------ -* bugfixes, -* new features, -* code and design improvements, -* documentation improvements, or -* tooling and CI improvements. - -Merging contributions requires passing the checks configured -with the CI. This includes running tests and linters successfully -on the currently officially supported Python and Django versions. - -The test automation is run automatically with GitHub Actions, but you can -run it locally with the ``tox`` command before pushing commits. - -Please note that this is a `Jazzband `_ project. -By contributing you agree to abide by the -`Contributor Code of Conduct `_ -and follow the `guidelines `_. +See `CONTRIBUTING `__. diff -pruN 5.39.0-6/axes/__init__.py 7.0.1-0ubuntu1/axes/__init__.py --- 5.39.0-6/axes/__init__.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/__init__.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,4 +1,3 @@ -from pkg_resources import get_distribution +from importlib.metadata import version - -__version__ = get_distribution("django-axes").version +__version__ = version("django-axes") diff -pruN 5.39.0-6/axes/admin.py 7.0.1-0ubuntu1/axes/admin.py --- 5.39.0-6/axes/admin.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/admin.py 2024-12-02 16:23:57.000000000 +0000 @@ -23,7 +23,7 @@ class AccessAttemptAdmin(admin.ModelAdmi date_hierarchy = "attempt_time" fieldsets = ( - (None, {"fields": ("path_info", "failures_since_start")}), + (None, {"fields": ("username", "path_info", "failures_since_start")}), (_("Form Data"), {"fields": ("get_data", "post_data")}), (_("Meta Data"), {"fields": ("user_agent", "ip_address", "http_accept")}), ) @@ -61,7 +61,7 @@ class AccessLogAdmin(admin.ModelAdmin): date_hierarchy = "attempt_time" fieldsets = ( - (None, {"fields": ("path_info",)}), + (None, {"fields": ("username", "path_info")}), (_("Meta Data"), {"fields": ("user_agent", "ip_address", "http_accept")}), ) @@ -96,7 +96,7 @@ class AccessFailureLogAdmin(admin.ModelA date_hierarchy = "attempt_time" fieldsets = ( - (None, {"fields": ("path_info",)}), + (None, {"fields": ("username", "path_info")}), (_("Meta Data"), {"fields": ("user_agent", "ip_address", "http_accept")}), ) diff -pruN 5.39.0-6/axes/apps.py 7.0.1-0ubuntu1/axes/apps.py --- 5.39.0-6/axes/apps.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/apps.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,7 +1,10 @@ +# pylint: disable=import-outside-toplevel, unused-import + from logging import getLogger from django import apps -from pkg_resources import get_distribution + +from axes import __version__ log = getLogger(__name__) @@ -25,22 +28,31 @@ class AppConfig(apps.AppConfig): cls.initialized = True # Only import settings, checks, and signals one time after Django has been initialized - from axes.conf import settings # noqa - from axes import checks, signals # noqa + from axes.conf import settings + from axes import checks, signals # Skip startup log messages if Axes is not set to verbose if settings.AXES_VERBOSE: - if settings.AXES_ONLY_USER_FAILURES: - mode = "blocking by username only" - elif settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP: - mode = "blocking by combination of username and IP" - elif settings.AXES_LOCK_OUT_BY_USER_OR_IP: - mode = "blocking by username or IP" + if callable(settings.AXES_LOCKOUT_PARAMETERS) or isinstance( + settings.AXES_LOCKOUT_PARAMETERS, str + ): + mode = "blocking by parameters that are calculated in a custom callable" + else: - mode = "blocking by IP only" + mode = "blocking by " + " or ".join( + [ + ( + param + if isinstance(param, str) + else "combination of " + " and ".join(param) + ) + for param in settings.AXES_LOCKOUT_PARAMETERS + ] + ) + log.info( "AXES: BEGIN version %s, %s", - get_distribution("django-axes").version, + __version__, mode, ) diff -pruN 5.39.0-6/axes/attempts.py 7.0.1-0ubuntu1/axes/attempts.py --- 5.39.0-6/axes/attempts.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/attempts.py 2024-12-02 16:23:57.000000000 +0000 @@ -12,17 +12,18 @@ from axes.models import AccessAttempt log = getLogger(__name__) -def get_cool_off_threshold(attempt_time: Optional[datetime] = None) -> datetime: +def get_cool_off_threshold(request: Optional[HttpRequest] = None) -> datetime: """ Get threshold for fetching access attempts from the database. """ - cool_off = get_cool_off() + cool_off = get_cool_off(request) if cool_off is None: raise TypeError( "Cool off threshold can not be calculated with settings.AXES_COOLOFF_TIME set to None" ) + attempt_time = request.axes_attempt_time if attempt_time is None: return now() - cool_off return attempt_time - cool_off @@ -38,7 +39,7 @@ def filter_user_attempts( username = get_client_username(request, credentials) filter_kwargs_list = get_client_parameters( - username, request.axes_ip_address, request.axes_user_agent + username, request.axes_ip_address, request.axes_user_agent, request, credentials ) attempts_list = [ AccessAttempt.objects.filter(**filter_kwargs) @@ -62,12 +63,12 @@ def get_user_attempts( ) return attempts_list - threshold = get_cool_off_threshold(request.axes_attempt_time) + threshold = get_cool_off_threshold(request) log.debug("AXES: Getting access attempts that are newer than %s", threshold) return [attempts.filter(attempt_time__gte=threshold) for attempts in attempts_list] -def clean_expired_user_attempts(attempt_time: Optional[datetime] = None) -> int: +def clean_expired_user_attempts(request: Optional[HttpRequest] = None) -> int: """ Clean expired user attempts from the database. """ @@ -78,7 +79,7 @@ def clean_expired_user_attempts(attempt_ ) return 0 - threshold = get_cool_off_threshold(attempt_time) + threshold = get_cool_off_threshold(request) count, _ = AccessAttempt.objects.filter(attempt_time__lt=threshold).delete() log.info( "AXES: Cleaned up %s expired access attempts from database that were older than %s", diff -pruN 5.39.0-6/axes/backends.py 7.0.1-0ubuntu1/axes/backends.py --- 5.39.0-6/axes/backends.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/backends.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,6 +1,6 @@ from typing import Optional from django.conf import settings -from django.contrib.auth.backends import BaseBackend, ModelBackend +from django.contrib.auth.backends import ModelBackend from django.http import HttpRequest from axes.exceptions import ( @@ -11,7 +11,7 @@ from axes.handlers.proxy import AxesProx from axes.helpers import get_credentials, get_lockout_message, toggleable -class AxesStandaloneBackend(BaseBackend): +class AxesStandaloneBackend: """ Authentication backend class that forbids login attempts for locked out users. diff -pruN 5.39.0-6/axes/checks.py 7.0.1-0ubuntu1/axes/checks.py --- 5.39.0-6/axes/checks.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/checks.py 2024-12-02 16:23:57.000000000 +0000 @@ -21,6 +21,7 @@ class Messages: ) BACKEND_INVALID = "You do not have 'axes.backends.AxesStandaloneBackend' or a subclass in your settings.AUTHENTICATION_BACKENDS." SETTING_DEPRECATED = "You have a deprecated setting {deprecated_setting} configured in your project settings" + CALLABLE_INVALID = "{callable_setting} is not a valid callable." class Hints: @@ -28,6 +29,7 @@ class Hints: MIDDLEWARE_INVALID = None BACKEND_INVALID = "AxesModelBackend was renamed to AxesStandaloneBackend in django-axes version 5.0." SETTING_DEPRECATED = None + CALLABLE_INVALID = None class Codes: @@ -35,6 +37,7 @@ class Codes: MIDDLEWARE_INVALID = "axes.W002" BACKEND_INVALID = "axes.W003" SETTING_DEPRECATED = "axes.W004" + CALLABLE_INVALID = "axes.W005" @register(Tags.security, Tags.caches, Tags.compatibility) @@ -122,6 +125,19 @@ def axes_deprecation_check(app_configs, deprecated_settings = [ "AXES_DISABLE_SUCCESS_ACCESS_LOG", "AXES_LOGGER", + # AXES_PROXY_ and AXES_META_ parameters were updated to more explicit + # AXES_IPWARE_PROXY_ and AXES_IPWARE_META_ prefixes in version 6.x + "AXES_PROXY_ORDER", + "AXES_PROXY_COUNT", + "AXES_PROXY_TRUSTED_IPS", + "AXES_META_PRECEDENCE_ORDER", + # AXES_ONLY_USER_FAILURES, AXES_USE_USER_AGENT and + # AXES_LOCK_OUT parameters were replaced with AXES_LOCKOUT_PARAMETERS + # in version 6.x + "AXES_ONLY_USER_FAILURES", + "AXES_LOCK_OUT_BY_USER_OR_IP", + "AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP", + "AXES_USE_USER_AGENT", ] for deprecated_setting in deprecated_settings: @@ -140,3 +156,49 @@ def axes_deprecation_check(app_configs, pass return warnings + + +@register +def axes_conf_check(app_configs, **kwargs): # pylint: disable=unused-argument + warnings = [] + + callable_settings = [ + "AXES_CLIENT_IP_CALLABLE", + "AXES_CLIENT_STR_CALLABLE", + "AXES_LOCKOUT_CALLABLE", + "AXES_USERNAME_CALLABLE", + "AXES_WHITELIST_CALLABLE", + "AXES_COOLOFF_TIME", + "AXES_LOCKOUT_PARAMETERS", + ] + + for callable_setting in callable_settings: + value = getattr(settings, callable_setting) + if not is_valid_callable(value): + warnings.append( + Warning( + msg=Messages.CALLABLE_INVALID.format( + callable_setting=callable_setting + ), + hint=Hints.CALLABLE_INVALID, + id=Codes.CALLABLE_INVALID, + ) + ) + + return warnings + + +def is_valid_callable(value) -> bool: + if value is None: + return True + + if callable(value): + return True + + if isinstance(value, str): + try: + import_string(value) + except ImportError: + return False + + return True diff -pruN 5.39.0-6/axes/conf.py 7.0.1-0ubuntu1/axes/conf.py --- 5.39.0-6/axes/conf.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/conf.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,7 +1,6 @@ from django.conf import settings from django.utils.translation import gettext_lazy as _ - # disable plugin when set to False settings.AXES_ENABLED = getattr(settings, "AXES_ENABLED", True) @@ -11,18 +10,30 @@ settings.AXES_FAILURE_LIMIT = getattr(se # see if the user has set axes to lock out logins after failure limit settings.AXES_LOCK_OUT_AT_FAILURE = getattr(settings, "AXES_LOCK_OUT_AT_FAILURE", True) -# lock out with the combination of username and IP address -settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP = getattr( - settings, "AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP", False -) - -# lock out with the username or IP address -settings.AXES_LOCK_OUT_BY_USER_OR_IP = getattr( - settings, "AXES_LOCK_OUT_BY_USER_OR_IP", False -) - -# lock out with username and never the IP or user agent -settings.AXES_ONLY_USER_FAILURES = getattr(settings, "AXES_ONLY_USER_FAILURES", False) +# lockout parameters +# default value will be ["ip_address"] after removing AXES_LOCK_OUT params support +settings.AXES_LOCKOUT_PARAMETERS = getattr(settings, "AXES_LOCKOUT_PARAMETERS", None) + +# TODO: remove it in future versions +if settings.AXES_LOCKOUT_PARAMETERS is None: + if getattr(settings, "AXES_ONLY_USER_FAILURES", False): + settings.AXES_LOCKOUT_PARAMETERS = ["username"] + else: + if getattr(settings, "AXES_LOCK_OUT_BY_USER_OR_IP", False): + settings.AXES_LOCKOUT_PARAMETERS = ["username", "ip_address"] + elif getattr(settings, "AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP", False): + settings.AXES_LOCKOUT_PARAMETERS = [["username", "ip_address"]] + else: + settings.AXES_LOCKOUT_PARAMETERS = ["ip_address"] + + if getattr(settings, "AXES_USE_USER_AGENT", False): + if isinstance(settings.AXES_LOCKOUT_PARAMETERS[0], str): + settings.AXES_LOCKOUT_PARAMETERS[0] = [ + settings.AXES_LOCKOUT_PARAMETERS[0], + "user_agent", + ] + else: + settings.AXES_LOCKOUT_PARAMETERS[0].append("user_agent") # lock out just for admin site settings.AXES_ONLY_ADMIN_SITE = getattr(settings, "AXES_ONLY_ADMIN_SITE", False) @@ -30,9 +41,6 @@ settings.AXES_ONLY_ADMIN_SITE = getattr( # show Axes logs in admin settings.AXES_ENABLE_ADMIN = getattr(settings, "AXES_ENABLE_ADMIN", True) -# lock out with the user agent, has no effect when ONLY_USER_FAILURES is set -settings.AXES_USE_USER_AGENT = getattr(settings, "AXES_USE_USER_AGENT", False) - # use a specific username field to retrieve from login POST data settings.AXES_USERNAME_FORM_FIELD = getattr( settings, "AXES_USERNAME_FORM_FIELD", "username" @@ -52,6 +60,9 @@ settings.AXES_WHITELIST_CALLABLE = getat # return custom lockout response if configured settings.AXES_LOCKOUT_CALLABLE = getattr(settings, "AXES_LOCKOUT_CALLABLE", None) +# use a provided callable to get client ip address +settings.AXES_CLIENT_IP_CALLABLE = getattr(settings, "AXES_CLIENT_IP_CALLABLE", None) + # reset the number of failed attempts after one successful attempt settings.AXES_RESET_ON_SUCCESS = getattr(settings, "AXES_RESET_ON_SUCCESS", False) @@ -106,24 +117,6 @@ settings.AXES_PERMALOCK_MESSAGE = getatt ), ) -# if your deployment is using reverse proxies, set this value to 'left-most' or 'right-most' per your configuration -settings.AXES_PROXY_ORDER = getattr(settings, "AXES_PROXY_ORDER", "left-most") - -# if your deployment is using reverse proxies, set this value to the number of proxies in front of Django -settings.AXES_PROXY_COUNT = getattr(settings, "AXES_PROXY_COUNT", None) - -# if your deployment is using reverse proxies, set to your trusted proxy IP addresses prefixes if needed -settings.AXES_PROXY_TRUSTED_IPS = getattr(settings, "AXES_PROXY_TRUSTED_IPS", None) - -# set to the names of request.META attributes that should be checked for the IP address of the client -# if your deployment is using reverse proxies, ensure that the header attributes are securely set by the proxy -# ensure that the client can not spoof the headers by setting them and sending them through the proxy -settings.AXES_META_PRECEDENCE_ORDER = getattr( - settings, - "AXES_META_PRECEDENCE_ORDER", - getattr(settings, "IPWARE_META_PRECEDENCE_ORDER", ("REMOTE_ADDR",)), -) - # set CORS allowed origins when calling authentication over ajax settings.AXES_ALLOWED_CORS_ORIGINS = getattr(settings, "AXES_ALLOWED_CORS_ORIGINS", "*") @@ -131,7 +124,7 @@ settings.AXES_ALLOWED_CORS_ORIGINS = get settings.AXES_SENSITIVE_PARAMETERS = getattr( settings, "AXES_SENSITIVE_PARAMETERS", - [], + ["username", "ip_address"], ) # set the callable for the readable string that can be used in @@ -139,9 +132,50 @@ settings.AXES_SENSITIVE_PARAMETERS = get settings.AXES_CLIENT_STR_CALLABLE = getattr(settings, "AXES_CLIENT_STR_CALLABLE", None) # set the HTTP response code given by too many requests -settings.AXES_HTTP_RESPONSE_CODE = getattr(settings, "AXES_HTTP_RESPONSE_CODE", 403) +settings.AXES_HTTP_RESPONSE_CODE = getattr(settings, "AXES_HTTP_RESPONSE_CODE", 429) # If True, a failed login attempt during lockout will reset the cool off period settings.AXES_RESET_COOL_OFF_ON_FAILURE_DURING_LOCKOUT = getattr( settings, "AXES_RESET_COOL_OFF_ON_FAILURE_DURING_LOCKOUT", True ) + + +### +# django-ipware settings for client IP address calculation and proxy detection +# there are old AXES_PROXY_ and AXES_META_ legacy keys present for backwards compatibility +# see https://github.com/un33k/django-ipware for further details +### + +# if your deployment is using reverse proxies, set this value to 'left-most' or 'right-most' per your configuration +settings.AXES_IPWARE_PROXY_ORDER = getattr( + settings, + "AXES_IPWARE_PROXY_ORDER", + getattr(settings, "AXES_PROXY_ORDER", "left-most"), +) + +# if your deployment is using reverse proxies, set this value to the number of proxies in front of Django +settings.AXES_IPWARE_PROXY_COUNT = getattr( + settings, + "AXES_IPWARE_PROXY_COUNT", + getattr(settings, "AXES_PROXY_COUNT", None), +) + +# if your deployment is using reverse proxies, set to your trusted proxy IP addresses prefixes if needed +settings.AXES_IPWARE_PROXY_TRUSTED_IPS = getattr( + settings, + "AXES_IPWARE_PROXY_TRUSTED_IPS", + getattr(settings, "AXES_PROXY_TRUSTED_IPS", None), +) + +# set to the names of request.META attributes that should be checked for the IP address of the client +# if your deployment is using reverse proxies, ensure that the header attributes are securely set by the proxy +# ensure that the client can not spoof the headers by setting them and sending them through the proxy +settings.AXES_IPWARE_META_PRECEDENCE_ORDER = getattr( + settings, + "AXES_IPWARE_META_PRECEDENCE_ORDER", + getattr( + settings, + "AXES_META_PRECEDENCE_ORDER", + getattr(settings, "IPWARE_META_PRECEDENCE_ORDER", ("REMOTE_ADDR",)), + ), +) diff -pruN 5.39.0-6/axes/handlers/base.py 7.0.1-0ubuntu1/axes/handlers/base.py --- 5.39.0-6/axes/handlers/base.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/handlers/base.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,6 +1,7 @@ import re from abc import ABC, abstractmethod from typing import Optional +from warnings import warn from django.urls import reverse from django.urls.exceptions import NoReverseMatch @@ -81,7 +82,7 @@ class AxesBaseHandler: # pylint: disabl and inspiration on some common checks and access restrictions before writing your own implementation. """ - if self.is_admin_site(request): + if settings.AXES_ONLY_ADMIN_SITE and not self.is_admin_request(request): return True if self.is_blacklisted(request, credentials): @@ -134,10 +135,41 @@ class AxesBaseHandler: # pylint: disabl return False + def get_admin_url(self) -> Optional[str]: + """ + Returns admin url if exists, otherwise returns None + """ + try: + return reverse("admin:index") + except NoReverseMatch: + return None + + def is_admin_request(self, request) -> bool: + """ + Checks that request located under admin site + """ + if hasattr(request, "path"): + admin_url = self.get_admin_url() + return ( + admin_url is not None + and re.match(f"^{admin_url}", request.path) is not None + ) + + return False + def is_admin_site(self, request) -> bool: """ - Checks if the request is for admin site. + Checks if the request is NOT for admin site + if `settings.AXES_ONLY_ADMIN_SITE` is True. """ + warn( + ( + "This method is deprecated and will be removed in future versions. " + "If you looking for method that checks if `request.path` located under " + "admin site, use `is_admin_request` instead." + ), + DeprecationWarning, + ) if settings.AXES_ONLY_ADMIN_SITE and hasattr(request, "path"): try: admin_url = reverse("admin:index") diff -pruN 5.39.0-6/axes/handlers/cache.py 7.0.1-0ubuntu1/axes/handlers/cache.py --- 5.39.0-6/axes/handlers/cache.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/handlers/cache.py 2024-12-02 16:23:57.000000000 +0000 @@ -6,11 +6,12 @@ from axes.handlers.base import AxesBaseH from axes.helpers import ( get_cache, get_cache_timeout, - get_client_cache_key, + get_client_cache_keys, get_client_str, get_client_username, get_credentials, get_failure_limit, + get_lockout_parameters, ) from axes.models import AccessAttempt from axes.signals import user_locked_out @@ -29,8 +30,8 @@ class AxesCacheHandler(AbstractAxesHandl def reset_attempts( self, *, - ip_address: str = None, - username: str = None, + ip_address: Optional[str] = None, + username: Optional[str] = None, ip_or_username: bool = False, ) -> int: cache_keys: list = [] @@ -44,7 +45,7 @@ class AxesCacheHandler(AbstractAxesHandl ) cache_keys.extend( - get_client_cache_key( + get_client_cache_keys( AccessAttempt(username=username, ip_address=ip_address) ) ) @@ -58,7 +59,7 @@ class AxesCacheHandler(AbstractAxesHandl return count def get_failures(self, request, credentials: Optional[dict] = None) -> int: - cache_keys = get_client_cache_key(request, credentials) + cache_keys = get_client_cache_keys(request, credentials) failure_count = max( self.cache.get(cache_key, default=0) for cache_key in cache_keys ) @@ -78,9 +79,10 @@ class AxesCacheHandler(AbstractAxesHandl return username = get_client_username(request, credentials) - if settings.AXES_ONLY_USER_FAILURES and username is None: + lockout_parameters = get_lockout_parameters(request, credentials) + if lockout_parameters == ["username"] and username is None: log.warning( - "AXES: Username is None and AXES_ONLY_USER_FAILURES is enabled, new record will NOT be created." + "AXES: Username is None and username is the only one lockout parameter, new record will NOT be created." ) return @@ -110,7 +112,18 @@ class AxesCacheHandler(AbstractAxesHandl log.info("AXES: Login failed from whitelisted client %s.", client_str) return - failures_since_start = 1 + self.get_failures(request, credentials) + cache_keys = get_client_cache_keys(request, credentials) + cache_timeout = get_cache_timeout(request) + failures = [] + for cache_key in cache_keys: + added = self.cache.add(key=cache_key, value=1, timeout=cache_timeout) + if added: + failures.append(1) + else: + failures.append(self.cache.incr(key=cache_key, delta=1)) + self.cache.touch(key=cache_key, timeout=cache_timeout) + + failures_since_start = max(failures) request.axes_failures_since_start = failures_since_start if failures_since_start > 1: @@ -126,11 +139,6 @@ class AxesCacheHandler(AbstractAxesHandl client_str, ) - cache_keys = get_client_cache_key(request, credentials) - for cache_key in cache_keys: - failures = self.cache.get(cache_key, default=0) - self.cache.set(cache_key, failures + 1, get_cache_timeout()) - if ( settings.AXES_LOCK_OUT_AT_FAILURE and failures_since_start >= get_failure_limit(request, credentials) @@ -166,7 +174,7 @@ class AxesCacheHandler(AbstractAxesHandl log.info("AXES: Successful login by %s.", client_str) if settings.AXES_RESET_ON_SUCCESS: - cache_keys = get_client_cache_key(request, credentials) + cache_keys = get_client_cache_keys(request, credentials) for cache_key in cache_keys: failures_since_start = self.cache.get(cache_key, default=0) self.cache.delete(cache_key) diff -pruN 5.39.0-6/axes/handlers/database.py 7.0.1-0ubuntu1/axes/handlers/database.py --- 5.39.0-6/axes/handlers/database.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/handlers/database.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,8 +1,8 @@ from logging import getLogger from typing import Optional -from django.db import transaction -from django.db.models import F, Sum, Value, Q +from django.db import router, transaction +from django.db.models import F, Q, Sum, Value from django.db.models.functions import Concat from django.utils import timezone @@ -14,10 +14,12 @@ from axes.attempts import ( from axes.conf import settings from axes.handlers.base import AxesBaseHandler, AbstractAxesHandler from axes.helpers import ( + get_client_session_hash, get_client_str, get_client_username, get_credentials, get_failure_limit, + get_lockout_parameters, get_query_str, ) from axes.models import AccessLog, AccessAttempt, AccessFailureLog @@ -130,7 +132,7 @@ class AxesDatabaseHandler(AbstractAxesHa return # 1. database query: Clean up expired user attempts from the database before logging new attempts - clean_expired_user_attempts(request.axes_attempt_time) + clean_expired_user_attempts(request) username = get_client_username(request, credentials) client_str = get_client_str( @@ -164,12 +166,13 @@ class AxesDatabaseHandler(AbstractAxesHa return # 2. database query: Get or create access record with the new failure data - if settings.AXES_ONLY_USER_FAILURES and username is None: + lockout_parameters = get_lockout_parameters(request, credentials) + if lockout_parameters == ["username"] and username is None: log.warning( - "AXES: Username is None and AXES_ONLY_USER_FAILURES is enabled, new record will NOT be created." + "AXES: Username is None and username is the only one lockout parameter, new record will NOT be created." ) else: - with transaction.atomic(): + with transaction.atomic(using=router.db_for_write(AccessAttempt)): ( attempt, created, @@ -241,7 +244,7 @@ class AxesDatabaseHandler(AbstractAxesHa # 5. database entry: Log for ever the attempt in the AccessFailureLog if settings.AXES_ENABLE_ACCESS_FAILURE_LOG: - with transaction.atomic(): + with transaction.atomic(using=router.db_for_write(AccessFailureLog)): AccessFailureLog.objects.create( username=username, ip_address=request.axes_ip_address, @@ -259,7 +262,7 @@ class AxesDatabaseHandler(AbstractAxesHa """ # 1. database query: Clean up expired user attempts from the database - clean_expired_user_attempts(request.axes_attempt_time) + clean_expired_user_attempts(request) username = user.get_username() credentials = get_credentials(username) @@ -282,6 +285,9 @@ class AxesDatabaseHandler(AbstractAxesHa http_accept=request.axes_http_accept, path_info=request.axes_path_info, attempt_time=request.axes_attempt_time, + # evaluate session hash here to ensure having the correct + # value which is stored on the backend + session_hash=get_client_session_hash(request), ) if settings.AXES_RESET_ON_SUCCESS: @@ -299,7 +305,7 @@ class AxesDatabaseHandler(AbstractAxesHa """ # 1. database query: Clean up expired user attempts from the database - clean_expired_user_attempts(request.axes_attempt_time) + clean_expired_user_attempts(request) username = user.get_username() if user else None client_str = get_client_str( @@ -315,7 +321,10 @@ class AxesDatabaseHandler(AbstractAxesHa if username and not settings.AXES_DISABLE_ACCESS_LOG: # 2. database query: Update existing attempt logs with logout time AccessLog.objects.filter( - username=username, logout_time__isnull=True + username=username, + logout_time__isnull=True, + # update only access log for given session + session_hash=get_client_session_hash(request), ).update(logout_time=request.axes_attempt_time) def post_save_access_attempt(self, instance, **kwargs): diff -pruN 5.39.0-6/axes/handlers/test.py 7.0.1-0ubuntu1/axes/handlers/test.py --- 5.39.0-6/axes/handlers/test.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/handlers/test.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,7 @@ from axes.handlers.base import AxesHandl from typing import Optional -class AxesTestHandler(AxesHandler): # pylint: disable=unused-argument +class AxesTestHandler(AxesHandler): """ Signal handler implementation that does nothing, ideal for a test suite. """ diff -pruN 5.39.0-6/axes/helpers.py 7.0.1-0ubuntu1/axes/helpers.py --- 5.39.0-6/axes/helpers.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/helpers.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,13 +2,13 @@ from datetime import timedelta from hashlib import sha256 from logging import getLogger from string import Template -from typing import Callable, Optional, Type, Union +from typing import Callable, Optional, Type, Union, List from urllib.parse import urlencode -import ipware.ip -from django.core.cache import caches, BaseCache +from django.core.cache import BaseCache, caches from django.http import HttpRequest, HttpResponse, JsonResponse, QueryDict -from django.shortcuts import render, redirect +from django.shortcuts import redirect, render +from django.utils.encoding import force_bytes from django.utils.module_loading import import_string from axes.conf import settings @@ -16,6 +16,13 @@ from axes.models import AccessBase log = getLogger(__name__) +try: + import ipware.ip + + IPWARE_INSTALLED = True +except ImportError: + IPWARE_INSTALLED = False + def get_cache() -> BaseCache: """ @@ -25,32 +32,33 @@ def get_cache() -> BaseCache: return caches[getattr(settings, "AXES_CACHE", "default")] -def get_cache_timeout() -> Optional[int]: +def get_cache_timeout(request: Optional[HttpRequest] = None) -> Optional[int]: """ Return the cache timeout interpreted from settings.AXES_COOLOFF_TIME. The cache timeout can be either None if not configured or integer of seconds if configured. - Notice that the settings.AXES_COOLOFF_TIME can be None, timedelta, integer, callable, or str path, + Notice that the settings.AXES_COOLOFF_TIME can be None, timedelta, float, integer, callable, or str path, and this function offers a unified _integer or None_ representation of that configuration for use with the Django cache backends. """ - cool_off = get_cool_off() + cool_off = get_cool_off(request) if cool_off is None: return None return int(cool_off.total_seconds()) -def get_cool_off() -> Optional[timedelta]: +def get_cool_off(request: Optional[HttpRequest] = None) -> Optional[timedelta]: """ Return the login cool off time interpreted from settings.AXES_COOLOFF_TIME. The return value is either None or timedelta. - Notice that the settings.AXES_COOLOFF_TIME is either None, timedelta, or integer of hours, - and this function offers a unified _timedelta or None_ representation of that configuration - for use with the Axes internal implementations. + Notice that the settings.AXES_COOLOFF_TIME is either None, timedelta, integer/float of hours, + a path to a callable or a callable taking 1 argument (the request). This function + offers a unified _timedelta or None_ representation of that configuration for use with the + Axes internal implementations. :exception TypeError: if settings.AXES_COOLOFF_TIME is of wrong type. """ @@ -62,9 +70,10 @@ def get_cool_off() -> Optional[timedelta if isinstance(cool_off, float): return timedelta(minutes=cool_off * 60) if isinstance(cool_off, str): - return import_string(cool_off)() + cool_off_func = import_string(cool_off) + return cool_off_func(request) if callable(cool_off): - return cool_off() # pylint: disable=not-callable + return cool_off(request) # pylint: disable=not-callable return cool_off @@ -148,23 +157,55 @@ def get_client_username( return request_data.get(settings.AXES_USERNAME_FORM_FIELD, None) -def get_client_ip_address(request: HttpRequest) -> str: +def get_client_ip_address( + request: HttpRequest, + use_ipware: Optional[bool] = None, +) -> Optional[str]: """ Get client IP address as configured by the user. - The django-ipware package is used for address resolution - and parameters can be configured in the Axes package. + The order of preference for address resolution is as follows: + + 1. If configured, use ``AXES_CLIENT_IP_CALLABLE``, and supply ``request`` as argument + 2. If available, use django-ipware package (parameters can be configured in the Axes package) + 3. Use ``request.META.get('REMOTE_ADDR', None)`` as a fallback + + :param request: incoming Django ``HttpRequest`` or similar object from authentication backend or other source """ - client_ip_address, _ = ipware.ip.get_client_ip( - request, - proxy_order=settings.AXES_PROXY_ORDER, - proxy_count=settings.AXES_PROXY_COUNT, - proxy_trusted_ips=settings.AXES_PROXY_TRUSTED_IPS, - request_header_order=settings.AXES_META_PRECEDENCE_ORDER, - ) + if settings.AXES_CLIENT_IP_CALLABLE: + log.debug("Using settings.AXES_CLIENT_IP_CALLABLE to get client IP address") - return client_ip_address + if callable(settings.AXES_CLIENT_IP_CALLABLE): + return settings.AXES_CLIENT_IP_CALLABLE( # pylint: disable=not-callable + request + ) + if isinstance(settings.AXES_CLIENT_IP_CALLABLE, str): + return import_string(settings.AXES_CLIENT_IP_CALLABLE)(request) + raise TypeError( + "settings.AXES_CLIENT_IP_CALLABLE needs to be a string, callable, or None." + ) + + # Resolve using django-ipware from a configuration flag that can be set to False to explicitly disable + # this is added to both enable or disable the branch when ipware is installed in the test environment + if use_ipware is None: + use_ipware = IPWARE_INSTALLED + if use_ipware: + log.debug("Using django-ipware to get client IP address") + + client_ip_address, _ = ipware.ip.get_client_ip( + request, + proxy_order=settings.AXES_IPWARE_PROXY_ORDER, + proxy_count=settings.AXES_IPWARE_PROXY_COUNT, + proxy_trusted_ips=settings.AXES_IPWARE_PROXY_TRUSTED_IPS, + request_header_order=settings.AXES_IPWARE_META_PRECEDENCE_ORDER, + ) + return client_ip_address + + log.debug( + "Using request.META.get('REMOTE_ADDR', None) fallback method to get client IP address" + ) + return request.META.get("REMOTE_ADDR", None) def get_client_user_agent(request: HttpRequest) -> str: @@ -179,7 +220,33 @@ def get_client_http_accept(request: Http return request.META.get("HTTP_ACCEPT", "")[:1025] -def get_client_parameters(username: str, ip_address: str, user_agent: str) -> list: +def get_lockout_parameters( + request_or_attempt: Union[HttpRequest, AccessBase], + credentials: Optional[dict] = None, +) -> List[Union[str, List[str]]]: + if callable(settings.AXES_LOCKOUT_PARAMETERS): + return settings.AXES_LOCKOUT_PARAMETERS(request_or_attempt, credentials) + + if isinstance(settings.AXES_LOCKOUT_PARAMETERS, str): + return import_string(settings.AXES_LOCKOUT_PARAMETERS)( + request_or_attempt, credentials + ) + + if isinstance(settings.AXES_LOCKOUT_PARAMETERS, list): + return settings.AXES_LOCKOUT_PARAMETERS + + raise TypeError( + "settings.AXES_LOCKOUT_PARAMETERS needs to be a callable or iterable" + ) + + +def get_client_parameters( + username: str, + ip_address: str, + user_agent: str, + request_or_attempt: Union[HttpRequest, AccessBase], + credentials: Optional[dict] = None, +) -> List[dict]: """ Get query parameters for filtering AccessAttempt queryset. @@ -188,29 +255,39 @@ def get_client_parameters(username: str, Returns list of dict, every item of list are separate parameters """ + lockout_parameters = get_lockout_parameters(request_or_attempt, credentials) - if settings.AXES_ONLY_USER_FAILURES: - # 1. Only individual usernames can be tracked with parametrization - filter_query = [{"username": username}] - else: - if settings.AXES_LOCK_OUT_BY_USER_OR_IP: - # One of `username` or `IP address` is used - filter_query = [{"username": username}, {"ip_address": ip_address}] - elif settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP: - # 2. A combination of username and IP address can be used as well - filter_query = [{"username": username, "ip_address": ip_address}] - else: - # 3. Default case is to track the IP address only, which is the most secure option - filter_query = [{"ip_address": ip_address}] - - if settings.AXES_USE_USER_AGENT: - # 4. The HTTP User-Agent can be used to track e.g. one browser - filter_query.append({"user_agent": user_agent}) + parameters_dict = { + "username": username, + "ip_address": ip_address, + "user_agent": user_agent, + } + + filter_kwargs = [] - return filter_query + for parameter in lockout_parameters: + try: + if isinstance(parameter, str): + filter_kwarg = {parameter: parameters_dict[parameter]} + else: + filter_kwarg = { + combined_parameter: parameters_dict[combined_parameter] + for combined_parameter in parameter + } + filter_kwargs.append(filter_kwarg) + + except KeyError as e: + error_msg = ( + f"{e} lockout parameter is not allowed. " + f"Allowed parameters: {', '.join(parameters_dict.keys())}" + ) + log.exception(error_msg) + raise ValueError(error_msg) from e + + return filter_kwargs -def make_cache_key_list(filter_kwargs_list): +def make_cache_key_list(filter_kwargs_list: List[dict]) -> List[str]: cache_keys = [] for filter_kwargs in filter_kwargs_list: cache_key_components = "".join( @@ -221,10 +298,10 @@ def make_cache_key_list(filter_kwargs_li return cache_keys -def get_client_cache_key( +def get_client_cache_keys( request_or_attempt: Union[HttpRequest, AccessBase], credentials: Optional[dict] = None, -) -> str: +) -> List[str]: """ Build cache key name from request or AccessAttempt object. @@ -242,7 +319,9 @@ def get_client_cache_key( ip_address = get_client_ip_address(request_or_attempt) user_agent = get_client_user_agent(request_or_attempt) - filter_kwargs_list = get_client_parameters(username, ip_address, user_agent) + filter_kwargs_list = get_client_parameters( + username, ip_address, user_agent, request_or_attempt, credentials + ) return make_cache_key_list(filter_kwargs_list) @@ -285,11 +364,11 @@ def get_client_str( client_dict["user_agent"] = user_agent else: # Other modes initialize the attributes that are used for the actual lockouts - client_list = get_client_parameters(username, ip_address, user_agent) + client_list = get_client_parameters(username, ip_address, user_agent, request) client_dict = {} for client in client_list: client_dict.update(client) - + client_dict = cleanse_parameters(client_dict.copy()) # Path info is always included as last component in the client string for traceability purposes if path_info and isinstance(path_info, (tuple, list)): path_info = path_info[0] @@ -385,7 +464,7 @@ def get_lockout_response( "username": get_client_username(request, credentials) or "", } - cool_off = get_cool_off() + cool_off = get_cool_off(request) if cool_off: context.update( { @@ -398,13 +477,13 @@ def get_lockout_response( if request.META.get("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest": json_response = JsonResponse(context, status=status) - json_response[ - "Access-Control-Allow-Origin" - ] = settings.AXES_ALLOWED_CORS_ORIGINS + json_response["Access-Control-Allow-Origin"] = ( + settings.AXES_ALLOWED_CORS_ORIGINS + ) json_response["Access-Control-Allow-Methods"] = "POST, OPTIONS" - json_response[ - "Access-Control-Allow-Headers" - ] = "Origin, Content-Type, Accept, Authorization, x-requested-with" + json_response["Access-Control-Allow-Headers"] = ( + "Origin, Content-Type, Accept, Authorization, x-requested-with" + ) return json_response if settings.AXES_LOCKOUT_TEMPLATE: @@ -538,3 +617,24 @@ def toggleable(func) -> Callable: return func(*args, **kwargs) return inner + + +def get_client_session_hash(request: HttpRequest) -> str: + """ + Get client session and returns the SHA256 hash of session key, forcing session creation if required. + + If no session is available on request returns an empty string. + """ + try: + session = request.session + except AttributeError: + # when no session is available just return an empty string + return "" + + # ensure that a session key exists at this point + # because session middleware usually creates the session key at the end + # of request cycle + if session.session_key is None: + session.create() + + return sha256(force_bytes(session.session_key)).hexdigest() Binary files 5.39.0-6/axes/locale/fr/LC_MESSAGES/django.mo and 7.0.1-0ubuntu1/axes/locale/fr/LC_MESSAGES/django.mo differ diff -pruN 5.39.0-6/axes/locale/fr/LC_MESSAGES/django.po 7.0.1-0ubuntu1/axes/locale/fr/LC_MESSAGES/django.po --- 5.39.0-6/axes/locale/fr/LC_MESSAGES/django.po 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/locale/fr/LC_MESSAGES/django.po 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,109 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-11-06 05:21-0600\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" + +#: admin.py:27 +msgid "Form Data" +msgstr "Données de formulaire" + +#: admin.py:28 admin.py:65 admin.py:100 +msgid "Meta Data" +msgstr "Métadonnées" + +#: conf.py:108 +msgid "Account locked: too many login attempts. Please try again later." +msgstr "" +"Compte verrouillé: trop de tentatives de connexion. Veuillez réessayer plus " +"tard." + +#: conf.py:116 +msgid "" +"Account locked: too many login attempts. Contact an admin to unlock your " +"account." +msgstr "" +"Compte verrouillé: trop de tentatives de connexion. Contactez un " +"administrateur pour déverrouiller votre compte." + +#: models.py:6 +msgid "User Agent" +msgstr "User Agent" + +#: models.py:8 +msgid "IP Address" +msgstr "Adresse IP" + +#: models.py:10 +msgid "Username" +msgstr "Nom d'utilisateur" + +#: models.py:12 +msgid "HTTP Accept" +msgstr "HTTP Accept" + +#: models.py:14 +msgid "Path" +msgstr "Chemin" + +#: models.py:16 +msgid "Attempt Time" +msgstr "Date de la tentative" + +#: models.py:26 +msgid "Access lock out" +msgstr "Verrouillage de l'accès" + +#: models.py:34 +msgid "access failure" +msgstr "échec de connexion" + +#: models.py:35 +msgid "access failures" +msgstr "échecs de connexion" + +#: models.py:39 +msgid "GET Data" +msgstr "Données GET" + +#: models.py:41 +msgid "POST Data" +msgstr "Données POST" + +#: models.py:43 +msgid "Failed Logins" +msgstr "Nombre d'échecs" + +#: models.py:49 +msgid "access attempt" +msgstr "tentative de connexion" + +#: models.py:50 +msgid "access attempts" +msgstr "tentatives de connexion" + +#: models.py:55 +msgid "Logout Time" +msgstr "Date de la déconnexion" + +#: models.py:61 +msgid "access log" +msgstr "connexion" + +#: models.py:62 +msgid "access logs" +msgstr "connexions" Binary files 5.39.0-6/axes/locale/id/LC_MESSAGES/django.mo and 7.0.1-0ubuntu1/axes/locale/id/LC_MESSAGES/django.mo differ diff -pruN 5.39.0-6/axes/locale/id/LC_MESSAGES/django.po 7.0.1-0ubuntu1/axes/locale/id/LC_MESSAGES/django.po --- 5.39.0-6/axes/locale/id/LC_MESSAGES/django.po 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/locale/id/LC_MESSAGES/django.po 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,105 @@ +# Indonesian translation for django-axes. +# Copyright (C) 2023 +# This file is distributed under the same license as the django-axes package. +# Kira , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: django-axes 6.0.4\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-30 09:21+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: Kira \n" +"Language-Team: LANGUAGE \n" +"Language: id\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0;\n" +#: .\axes\admin.py:27 +msgid "Form Data" +msgstr "Data Formulir" + +#: .\axes\admin.py:28 .\axes\admin.py:65 .\axes\admin.py:100 +msgid "Meta Data" +msgstr "Meta Data" + +#: .\axes\conf.py:108 +msgid "Account locked: too many login attempts. Please try again later." +msgstr "Akun terkunci: terlalu banyak percobaan login. Silakan coba lagi nanti." + +#: .\axes\conf.py:116 +msgid "" +"Account locked: too many login attempts. Contact an admin to unlock your " +"account." +msgstr "Akun terkunci: terlalu banyak percobaan login. Hubungi admin untuk" +" membuka kunci akun" + +#: .\axes\models.py:6 +msgid "User Agent" +msgstr "User Agent" + +#: .\axes\models.py:8 +msgid "IP Address" +msgstr "Alamat IP" + +#: .\axes\models.py:10 +msgid "Username" +msgstr "Nama Pengguna" + +#: .\axes\models.py:12 +msgid "HTTP Accept" +msgstr "HTTP Accept" + +#: .\axes\models.py:14 +msgid "Path" +msgstr "Path" + +#: .\axes\models.py:16 +msgid "Attempt Time" +msgstr "Waktu Percobaan" + +#: .\axes\models.py:26 +msgid "Access lock out" +msgstr "Akses terkunci" + +#: .\axes\models.py:34 +msgid "access failure" +msgstr "kegagalan akses" + +#: .\axes\models.py:35 +msgid "access failures" +msgstr "kegagalan akses" + +#: .\axes\models.py:39 +msgid "GET Data" +msgstr "Data GET" + +#: .\axes\models.py:41 +msgid "POST Data" +msgstr "Data POST" + +#: .\axes\models.py:43 +msgid "Failed Logins" +msgstr "Login Gagal" + +#: .\axes\models.py:49 +msgid "access attempt" +msgstr "upaya akses" + +#: .\axes\models.py:50 +msgid "access attempts" +msgstr "upaya akses" + +#: .\axes\models.py:55 +msgid "Logout Time" +msgstr "Waktu Logout" + +#: .\axes\models.py:61 +msgid "access log" +msgstr "log akses" + +#: .\axes\models.py:62 +msgid "access logs" +msgstr "log akses" Binary files 5.39.0-6/axes/locale/ru/LC_MESSAGES/django.mo and 7.0.1-0ubuntu1/axes/locale/ru/LC_MESSAGES/django.mo differ diff -pruN 5.39.0-6/axes/locale/ru/LC_MESSAGES/django.po 7.0.1-0ubuntu1/axes/locale/ru/LC_MESSAGES/django.po --- 5.39.0-6/axes/locale/ru/LC_MESSAGES/django.po 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/locale/ru/LC_MESSAGES/django.po 2024-12-02 16:23:57.000000000 +0000 @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2019-01-11 12:20+0300\n" +"POT-Creation-Date: 2023-05-13 12:36+0500\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -18,80 +18,92 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" -#: axes/admin.py:38 +#: axes/admin.py:27 msgid "Form Data" msgstr "Данные формы" -#: axes/admin.py:41 axes/admin.py:95 +#: axes/admin.py:28 axes/admin.py:65 axes/admin.py:100 msgid "Meta Data" msgstr "Метаданные" -#: axes/conf.py:58 +#: axes/conf.py:99 msgid "Account locked: too many login attempts. Please try again later." msgstr "" -"Учетная запись заблокирована: слишком много попыток входа. " -"Повторите попытку позже." +"Учетная запись заблокирована: слишком много попыток входа. Повторите попытку " +"позже." -#: axes/conf.py:61 +#: axes/conf.py:107 msgid "" "Account locked: too many login attempts. Contact an admin to unlock your " "account." msgstr "" -"Учетная запись заблокирована: слишком много попыток входа. " -"Обратитесь к администратору для разблокирования учетной записи." +"Учетная запись заблокирована: слишком много попыток входа. Свяжитесь с " +"администратором, чтобы разблокировать учетную запись." -#: axes/models.py:9 +#: axes/models.py:6 msgid "User Agent" -msgstr "Браузер пользователя" +msgstr "User Agent" -#: axes/models.py:15 +#: axes/models.py:8 msgid "IP Address" -msgstr "Адрес IP" +msgstr "IP Адрес" -#: axes/models.py:21 +#: axes/models.py:10 msgid "Username" -msgstr "Пользователь" +msgstr "Имя пользователя" -#: axes/models.py:35 +#: axes/models.py:12 msgid "HTTP Accept" -msgstr "Запрос HTTP" +msgstr "HTTP Accept" -#: axes/models.py:40 +#: axes/models.py:14 msgid "Path" msgstr "Путь" -#: axes/models.py:45 +#: axes/models.py:16 msgid "Attempt Time" -msgstr "Время входа" +msgstr "Время попытки входа" + +#: axes/models.py:26 +msgid "Access lock out" +msgstr "Доступ запрещен" + +#: axes/models.py:34 +msgid "access failure" +msgstr "Ошибка доступа" + +#: axes/models.py:35 +msgid "access failures" +msgstr "Ошибки доступа" -#: axes/models.py:57 +#: axes/models.py:39 msgid "GET Data" msgstr "Данные GET-запроса" -#: axes/models.py:61 +#: axes/models.py:41 msgid "POST Data" msgstr "Данные POST-запроса" -#: axes/models.py:65 +#: axes/models.py:43 msgid "Failed Logins" msgstr "Ошибочные попытки" -#: axes/models.py:76 +#: axes/models.py:49 msgid "access attempt" msgstr "Запись о попытке доступа" -#: axes/models.py:77 +#: axes/models.py:50 msgid "access attempts" msgstr "Попытки доступа" -#: axes/models.py:81 +#: axes/models.py:55 msgid "Logout Time" msgstr "Время выхода" -#: axes/models.py:90 +#: axes/models.py:61 msgid "access log" msgstr "Запись о доступе" -#: axes/models.py:91 +#: axes/models.py:62 msgid "access logs" msgstr "Логи доступа" diff -pruN 5.39.0-6/axes/management/commands/axes_reset_ip_username.py 7.0.1-0ubuntu1/axes/management/commands/axes_reset_ip_username.py --- 5.39.0-6/axes/management/commands/axes_reset_ip_username.py 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/management/commands/axes_reset_ip_username.py 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,19 @@ +from django.core.management.base import BaseCommand + +from axes.utils import reset + + +class Command(BaseCommand): + help = "Reset all access attempts and lockouts for a given IP address and username" + + def add_arguments(self, parser): + parser.add_argument("ip", type=str) + parser.add_argument("username", type=str) + + def handle(self, *args, **options): + count = reset(ip=options["ip"], username=options["username"]) + + if count: + self.stdout.write(f"{count} attempts removed.") + else: + self.stdout.write("No attempts found.") diff -pruN 5.39.0-6/axes/middleware.py 7.0.1-0ubuntu1/axes/middleware.py --- 5.39.0-6/axes/middleware.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/middleware.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,5 +1,6 @@ from typing import Callable +from asgiref.sync import iscoroutinefunction, markcoroutinefunction, sync_to_async from django.conf import settings from django.http import HttpRequest, HttpResponse @@ -30,15 +31,37 @@ class AxesMiddleware: - ``AXES_PERMALOCK_MESSAGE``. """ + async_capable = True + sync_capable = True + def __init__(self, get_response: Callable) -> None: self.get_response = get_response + if iscoroutinefunction(self.get_response): + markcoroutinefunction(self) def __call__(self, request: HttpRequest) -> HttpResponse: - response = self.get_response(request) + # Exit out to async mode, if needed + if iscoroutinefunction(self): + return self.__acall__(request) + response = self.get_response(request) if settings.AXES_ENABLED: if getattr(request, "axes_locked_out", None): credentials = getattr(request, "axes_credentials", None) response = get_lockout_response(request, credentials) # type: ignore return response + + async def __acall__(self, request: HttpRequest) -> HttpResponse: + response = await self.get_response(request) + + if settings.AXES_ENABLED: + if getattr(request, "axes_locked_out", None): + credentials = getattr(request, "axes_credentials", None) + response = await sync_to_async( + get_lockout_response, thread_sensitive=True + )( + request, credentials + ) # type: ignore + + return response diff -pruN 5.39.0-6/axes/migrations/0001_initial.py 7.0.1-0ubuntu1/axes/migrations/0001_initial.py --- 5.39.0-6/axes/migrations/0001_initial.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0001_initial.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,6 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [] operations = [ diff -pruN 5.39.0-6/axes/migrations/0002_auto_20151217_2044.py 7.0.1-0ubuntu1/axes/migrations/0002_auto_20151217_2044.py --- 5.39.0-6/axes/migrations/0002_auto_20151217_2044.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0002_auto_20151217_2044.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,6 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [("axes", "0001_initial")] operations = [ diff -pruN 5.39.0-6/axes/migrations/0003_auto_20160322_0929.py 7.0.1-0ubuntu1/axes/migrations/0003_auto_20160322_0929.py --- 5.39.0-6/axes/migrations/0003_auto_20160322_0929.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0003_auto_20160322_0929.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,6 @@ from django.db import models, migrations class Migration(migrations.Migration): - dependencies = [("axes", "0002_auto_20151217_2044")] operations = [ diff -pruN 5.39.0-6/axes/migrations/0004_auto_20181024_1538.py 7.0.1-0ubuntu1/axes/migrations/0004_auto_20181024_1538.py --- 5.39.0-6/axes/migrations/0004_auto_20181024_1538.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0004_auto_20181024_1538.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,6 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [("axes", "0003_auto_20160322_0929")] operations = [ diff -pruN 5.39.0-6/axes/migrations/0005_remove_accessattempt_trusted.py 7.0.1-0ubuntu1/axes/migrations/0005_remove_accessattempt_trusted.py --- 5.39.0-6/axes/migrations/0005_remove_accessattempt_trusted.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0005_remove_accessattempt_trusted.py 2024-12-02 16:23:57.000000000 +0000 @@ -2,7 +2,6 @@ from django.db import migrations class Migration(migrations.Migration): - dependencies = [("axes", "0004_auto_20181024_1538")] operations = [migrations.RemoveField(model_name="accessattempt", name="trusted")] diff -pruN 5.39.0-6/axes/migrations/0006_remove_accesslog_trusted.py 7.0.1-0ubuntu1/axes/migrations/0006_remove_accesslog_trusted.py --- 5.39.0-6/axes/migrations/0006_remove_accesslog_trusted.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0006_remove_accesslog_trusted.py 2024-12-02 16:23:57.000000000 +0000 @@ -4,7 +4,6 @@ from django.db import migrations class Migration(migrations.Migration): - dependencies = [("axes", "0005_remove_accessattempt_trusted")] operations = [migrations.RemoveField(model_name="accesslog", name="trusted")] diff -pruN 5.39.0-6/axes/migrations/0007_alter_accessattempt_unique_together.py 7.0.1-0ubuntu1/axes/migrations/0007_alter_accessattempt_unique_together.py --- 5.39.0-6/axes/migrations/0007_alter_accessattempt_unique_together.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0007_alter_accessattempt_unique_together.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,36 +1,43 @@ # Generated by Django 3.2.7 on 2021-09-13 15:16 -from django.db import migrations +from django.db import migrations, router from django.db.models import Count def deduplicate_attempts(apps, schema_editor): AccessAttempt = apps.get_model("axes", "AccessAttempt") + db_alias = schema_editor.connection.alias + + if db_alias != router.db_for_write(AccessAttempt): + return + duplicated_attempts = ( - AccessAttempt.objects.values("username", "user_agent", "ip_address") + AccessAttempt.objects.using(db_alias) + .values("username", "user_agent", "ip_address") .annotate(Count("id")) .order_by() .filter(id__count__gt=1) ) for attempt in duplicated_attempts: - redundant_attempts = AccessAttempt.objects.filter( + redundant_attempts = AccessAttempt.objects.using(db_alias).filter( username=attempt["username"], user_agent=attempt["user_agent"], ip_address=attempt["ip_address"], )[1:] for redundant_attempt in redundant_attempts: - redundant_attempt.delete() + redundant_attempt.delete(using=db_alias) class Migration(migrations.Migration): - dependencies = [ ("axes", "0006_remove_accesslog_trusted"), ] operations = [ - migrations.RunPython(deduplicate_attempts), + migrations.RunPython( + deduplicate_attempts, reverse_code=migrations.RunPython.noop + ), migrations.AlterUniqueTogether( name="accessattempt", unique_together={("username", "ip_address", "user_agent")}, diff -pruN 5.39.0-6/axes/migrations/0008_accessfailurelog.py 7.0.1-0ubuntu1/axes/migrations/0008_accessfailurelog.py --- 5.39.0-6/axes/migrations/0008_accessfailurelog.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0008_accessfailurelog.py 2024-12-02 16:23:57.000000000 +0000 @@ -4,7 +4,6 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [ ("axes", "0007_alter_accessattempt_unique_together"), ] diff -pruN 5.39.0-6/axes/migrations/0009_add_session_hash.py 7.0.1-0ubuntu1/axes/migrations/0009_add_session_hash.py --- 5.39.0-6/axes/migrations/0009_add_session_hash.py 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/migrations/0009_add_session_hash.py 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,22 @@ +# Generated by Django 4.2.2 on 2024-04-30 07:57 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("axes", "0008_accessfailurelog"), + ] + + operations = [ + migrations.AddField( + model_name="accesslog", + name="session_hash", + field=models.CharField( + blank=True, + default="", + max_length=64, + verbose_name="Session key hash (sha256)", + ), + ), + ] diff -pruN 5.39.0-6/axes/models.py 7.0.1-0ubuntu1/axes/models.py --- 5.39.0-6/axes/models.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/models.py 2024-12-02 16:23:57.000000000 +0000 @@ -53,6 +53,7 @@ class AccessAttempt(AccessBase): class AccessLog(AccessBase): logout_time = models.DateTimeField(_("Logout Time"), null=True, blank=True) + session_hash = models.CharField(_("Session key hash (sha256)"), default="", blank=True, max_length=64) def __str__(self): return f"Access Log for {self.username} @ {self.attempt_time}" diff -pruN 5.39.0-6/axes/utils.py 7.0.1-0ubuntu1/axes/utils.py --- 5.39.0-6/axes/utils.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/axes/utils.py 2024-12-02 16:23:57.000000000 +0000 @@ -10,9 +10,8 @@ from typing import Optional from django.http import HttpRequest -from axes.conf import settings from axes.handlers.proxy import AxesProxyHandler -from axes.helpers import get_client_ip_address +from axes.helpers import get_client_ip_address, get_lockout_parameters log = getLogger(__name__) @@ -37,23 +36,38 @@ def reset_request(request: HttpRequest) This utility method is meant to be used from the CLI or via Python API. """ + lockout_paramaters = get_lockout_parameters(request) ip: Optional[str] = get_client_ip_address(request) username = request.GET.get("username", None) - ip_or_username = settings.AXES_LOCK_OUT_BY_USER_OR_IP - if settings.AXES_ONLY_USER_FAILURES: + ip_required = False + username_required = False + ip_and_username = False + + for param in lockout_paramaters: + # hack: in works with all iterables, including strings + # so this checks works with separate parameters + # and with parameters combinations + if "username" in param and "ip_address" in param: + ip_and_username = True + ip_required = True + username_required = True + break + if "username" in param: + username_required = True + elif "ip_address" in param: + ip_required = True + + ip_or_username = not ip_and_username and ip_required and username_required + if not ip_required: ip = None - elif not ( - settings.AXES_LOCK_OUT_BY_USER_OR_IP - or settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP - ): + if not username_required: username = None if not ip and not username: return 0 # We don't want to reset everything, if there is some wrong request parameter - # if settings.AXES_USE_USER_AGENT: # TODO: reset based on user_agent? return reset(ip, username, ip_or_username) diff -pruN 5.39.0-6/debian/changelog 7.0.1-0ubuntu1/debian/changelog --- 5.39.0-6/debian/changelog 2024-11-21 00:12:29.000000000 +0000 +++ 7.0.1-0ubuntu1/debian/changelog 2024-12-20 18:56:02.000000000 +0000 @@ -1,3 +1,12 @@ +django-axes (7.0.1-0ubuntu1) plucky; urgency=medium + + * New upstream version 7.0.1 + * 0001-Adopt-test-based-on-Django-security-release.patch: Remove - fixed + upstream + * 0003-remove-dependency-on-pkg-resources.patch: Remove - no longer needed + + -- Lena Voytek Fri, 20 Dec 2024 13:56:02 -0500 + django-axes (5.39.0-6) unstable; urgency=medium * d/patches: Update patch to remove pkg_resources dependency properly. diff -pruN 5.39.0-6/debian/control 7.0.1-0ubuntu1/debian/control --- 5.39.0-6/debian/control 2024-11-21 00:12:29.000000000 +0000 +++ 7.0.1-0ubuntu1/debian/control 2024-12-20 18:56:02.000000000 +0000 @@ -1,5 +1,6 @@ Source: django-axes -Maintainer: FreedomBox packaging team +Maintainer: Ubuntu Developers +XSBC-Original-Maintainer: FreedomBox packaging team Uploaders: Joseph Nuthalapati , Federico Ceratto , diff -pruN 5.39.0-6/debian/patches/0001-Adopt-test-based-on-Django-security-release.patch 7.0.1-0ubuntu1/debian/patches/0001-Adopt-test-based-on-Django-security-release.patch --- 5.39.0-6/debian/patches/0001-Adopt-test-based-on-Django-security-release.patch 2024-11-21 00:12:29.000000000 +0000 +++ 7.0.1-0ubuntu1/debian/patches/0001-Adopt-test-based-on-Django-security-release.patch 1970-01-01 00:00:00.000000000 +0000 @@ -1,24 +0,0 @@ -From: James Valleroy -Date: Sat, 18 Feb 2023 09:09:03 -0500 -Subject: Adopt test based on Django security release - -Apply patch from upstream PR to fix test. - -Origin: https://github.com/jazzband/django-axes/pull/1004 -Bug-Debian: https://bugs.debian.org/1031461 ---- - tests/test_logging.py | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/tests/test_logging.py b/tests/test_logging.py -index 35ae52e..ae2a7c6 100644 ---- a/tests/test_logging.py -+++ b/tests/test_logging.py -@@ -69,6 +69,7 @@ class AccessLogTestCase(AxesTestCase): - - self.assertIsNotNone(AccessLog.objects.latest("id").logout_time) - -+ @override_settings(DATA_UPLOAD_MAX_NUMBER_FIELDS=1500) - def test_log_data_truncated(self): - """ - Test that get_query_str properly truncates data to the max_length (default 1024). diff -pruN 5.39.0-6/debian/patches/0003-remove-dependency-on-pkg-resources.patch 7.0.1-0ubuntu1/debian/patches/0003-remove-dependency-on-pkg-resources.patch --- 5.39.0-6/debian/patches/0003-remove-dependency-on-pkg-resources.patch 2024-11-21 00:12:29.000000000 +0000 +++ 7.0.1-0ubuntu1/debian/patches/0003-remove-dependency-on-pkg-resources.patch 1970-01-01 00:00:00.000000000 +0000 @@ -1,94 +0,0 @@ -From: Sunil Mohan Adapa -Date: Tue, 08 Oct 2024 13:00:22 -0700 -Subject: Drop dependency on pkg_resources -Forwarded: not-needed - ---- a/axes/__init__.py -+++ b/axes/__init__.py -@@ -1,4 +1 @@ --from pkg_resources import get_distribution -- -- --__version__ = get_distribution("django-axes").version -+__version__ = "5.39.0" ---- a/axes/apps.py -+++ b/axes/apps.py -@@ -1,7 +1,7 @@ - from logging import getLogger - - from django import apps --from pkg_resources import get_distribution -+from . import __version__ - - log = getLogger(__name__) - -@@ -40,7 +40,7 @@ - mode = "blocking by IP only" - log.info( - "AXES: BEGIN version %s, %s", -- get_distribution("django-axes").version, -+ __version__, - mode, - ) - ---- a/docs/conf.py -+++ b/docs/conf.py -@@ -7,7 +7,7 @@ - """ - - import sphinx_rtd_theme --from pkg_resources import get_distribution -+from axes import __version__ - - import django - from django.conf import settings -@@ -43,7 +43,7 @@ - author = "Jazzband" - - # The full version, including alpha/beta/rc tags. --release = get_distribution("django-axes").version -+release = __version__ - - # The short X.Y version. - version = ".".join(release.split(".")[:2]) ---- a/requirements-qa.txt -+++ b/requirements-qa.txt -@@ -1,4 +1,3 @@ - black==22.6.0 - mypy==0.971 - prospector==1.7.7 --types-pkg_resources # Type stub ---- a/tests/test_logging.py -+++ b/tests/test_logging.py -@@ -2,14 +2,14 @@ - - from django.test import override_settings - from django.urls import reverse --from pkg_resources import get_distribution - -+from axes import __version__ - from axes.apps import AppConfig - from axes.models import AccessAttempt, AccessLog - from tests.base import AxesTestCase - - _BEGIN = "AXES: BEGIN version %s, %s" --_VERSION = get_distribution("django-axes").version -+_VERSION = __version__ - - - @patch("axes.apps.AppConfig.initialized", False) ---- a/setup.py -+++ b/setup.py -@@ -33,10 +33,9 @@ - }, - license="MIT", - package_dir={"axes": "axes"}, -- use_scm_version=True, -- setup_requires=["setuptools_scm"], -+ version="5.39.0", - python_requires=">=3.7", -- install_requires=["django>=3.2", "django-ipware>=3", "setuptools"], -+ install_requires=["django>=3.2", "django-ipware>=3"], - include_package_data=True, - packages=find_packages(exclude=["tests"]), - classifiers=[ diff -pruN 5.39.0-6/debian/patches/series 7.0.1-0ubuntu1/debian/patches/series --- 5.39.0-6/debian/patches/series 2024-11-21 00:12:29.000000000 +0000 +++ 7.0.1-0ubuntu1/debian/patches/series 2024-12-20 18:54:00.000000000 +0000 @@ -1,3 +1 @@ -0001-Adopt-test-based-on-Django-security-release.patch 0002-Remove-test-coverage.patch -0003-remove-dependency-on-pkg-resources.patch diff -pruN 5.39.0-6/docs/1_requirements.rst 7.0.1-0ubuntu1/docs/1_requirements.rst --- 5.39.0-6/docs/1_requirements.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/1_requirements.rst 2024-12-02 16:23:57.000000000 +0000 @@ -3,11 +3,11 @@ Requirements ============ -Axes requires a supported Django version and runs on Python versions 3.6 and above. +Axes requires a supported Django version and runs on Python versions 3.9 and above. Refer to the project source code repository in `GitHub `_ and see the -`Tox configuration `_ and +`pyproject.toml file `_ and `Python package definition `_ to check if your Django and Python version are supported. diff -pruN 5.39.0-6/docs/2_installation.rst 7.0.1-0ubuntu1/docs/2_installation.rst --- 5.39.0-6/docs/2_installation.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/2_installation.rst 2024-12-02 16:23:57.000000000 +0000 @@ -5,7 +5,8 @@ Installation Axes is easy to install from the PyPI package:: - $ pip install django-axes + $ pip install django-axes[ipware] # use django-ipware for resolving client IP addresses OR + $ pip install django-axes # implement and configure custom AXES_CLIENT_IP_CALLABLE After installing the package, the project settings need to be configured. @@ -33,10 +34,10 @@ After installing the package, the projec 'django.contrib.auth.backends.ModelBackend', ] - For backwards compatibility, ``AxesBackend`` can be used in place of ``AxesStandaloneBackend``. - The only difference is that ``AxesBackend`` also provides the permissions-checking functionality - of Django's ``ModelBackend`` behind the scenes. We recommend using ``AxesStandaloneBackend`` - if you have any custom logic to override Django's standard permissions checks. +For backwards compatibility, ``AxesBackend`` can be used in place of ``AxesStandaloneBackend``. +The only difference is that ``AxesBackend`` also provides the permissions-checking functionality +of Django's ``ModelBackend`` behind the scenes. We recommend using ``AxesStandaloneBackend`` +if you have any custom logic to override Django's standard permissions checks. **3.** Add ``axes.middleware.AxesMiddleware`` to your list of ``MIDDLEWARE``:: @@ -74,6 +75,84 @@ Many people have different configuration and running the application with misconfigured settings can prevent security features from working. +Version 7 breaking changes and upgrading from django-axes version 6 +------------------------------------------------------------------- + +If you use ``settings.AXES_COOLOFF_TIME`` for configuring a callable that returns the cooloff time, it needs to accept at minimum a ``request`` argument of type ``HttpRequest`` from version 7 onwards. Example: ``AXES_COOLOFF_TIME = lambda request: timedelta(hours=2)`` (new call signature) instead of ``AXES_COOLOFF_TIME = lambda: timedelta(hours=2)`` (old cal signature). + +Please see configuration documentation and `jazzband/django-axes#1222 `_ for reference. + + +Version 6 breaking changes and upgrading from django-axes version 5 +------------------------------------------------------------------- + +If you have not specialized ``django-axes`` configuration in any way +you do not have to update any of the configuration. + +The instructions apply to users who have configured ``django-axes`` in their projects +and have used flags that are deprecated. The deprecated flags will be removed in the future +but are compatible for at least version 6.0 of ``django-axes``. + +The following flags and configuration have changed: + +``django-ipware`` has become an optional dependency. +To keep old behaviour, use ``pip install django-axes[ipware]`` +in your install script or use ``django-axes[ipware]`` +in your requirements file(s) instead of plain ``django-axes``. +The new ``django-axes`` package does not include ``django-ipware`` by default +but does use ``django-ipware`` if it is installed +and no callables for IP address resolution are configured +with the ``settings.AXES_CLIENT_IP_CALLABLE`` configuration flag. + +``django-ipware`` related flags have changed names. +The old flags have been deprecated and will be removed in the future. +To keep old behaviour, rename them in your settings file: + +- ``settings.AXES_PROXY_ORDER`` is now ``settings.AXES_IPWARE_PROXY_ORDER``, +- ``settings.AXES_PROXY_COUNT`` is now ``settings.AXES_IPWARE_PROXY_COUNT``, +- ``settings.AXES_PROXY_TRUSTED_IPS`` is now ``settings.AXES_IPWARE_PROXY_TRUSTED_IPS``, and +- ``settings.AXES_META_PRECEDENCE_ORDER`` is now ``settings.AXES_IPWARE_META_PRECEDENCE_ORDER``. + +``settings.AXES_LOCKOUT_PARAMETERS`` configuration flag has been added which supersedes the following configuration keys: + +#. No configuration for failure tracking in the following items (default behaviour). +#. ``settings.AXES_ONLY_USER_FAILURES``, +#. ``settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``, +#. ``settings.AXES_LOCK_OUT_BY_USER_OR_IP``, and +#. ``settings.AXES_USE_USER_AGENT``. + +To keep old behaviour with the new flag, configure the following: + +#. If you did not use any flags, use ``settings.AXES_LOCKOUT_PARAMETERS = ["ip_address"]``, +#. If you used ``settings.AXES_ONLY_USER_FAILURES``, use ``settings.AXES_LOCKOUT_PARAMETERS = ["username"]``, +#. If you used ``settings.AXES_LOCK_OUT_BY_USER_OR_IP``, use ``settings.AXES_LOCKOUT_PARAMETERS = ["username", "ip_address"]``, and +#. If you used ``settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``, use ``settings.AXES_LOCKOUT_PARAMETERS = [["username", "ip_address"]]``, +#. If you used ``settings.AXES_USE_USER_AGENT``, add ``"user_agent"`` to your list(s) of lockout parameters. + #. ``settings.AXES_USE_USER_AGENT`` would become ``settings.AXES_LOCKOUT_PARAMETERS = [["ip_address", "user_agent"]]`` + #. ``settings.AXES_USE_USER_AGENT`` with ``settings.AXES_ONLY_USER_FAILURES`` would become ``settings.AXES_LOCKOUT_PARAMETERS = [["username", "user_agent"]]`` + #. ``settings.AXES_USE_USER_AGENT`` with ``settings.AXES_LOCK_OUT_BY_USER_OR_IP`` would become ``settings.AXES_LOCKOUT_PARAMETERS = [["ip_address", "user_agent"], "username"]`` + #. ``settings.AXES_USE_USER_AGENT`` with ``settings.AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP`` would become ``settings.AXES_LOCKOUT_PARAMETERS = [["ip_address", "user_agent", "username"]]`` + #. Other combinations of flags were previously not considered; the flags had precedence over each other as described in the documentation but were less-than-trivial to understand in their previous form. The new form is more explicit and flexible, although it requires more in-depth configuration. + +The new lockout parameters define a combined list of attributes to consider when tracking failed authentication attempts. +They can be any combination of ``username``, ``ip_address`` or ``user_agent`` in a list of strings or list of lists of strings. +The attributes defined in the lists are combined and saved into the database, cache, or other backend for failed logins. +The semantics of the evaluation are available in the documentation and ``axes.helpers.get_client_parameters`` callable. + +``settings.AXES_HTTP_RESPONSE_CODE`` default has been changed from ``403`` (Forbidden) to ``429`` (Too Many Requests). +To keep the old behavior, set ``settings.AXES_HTTP_RESPONSE_CODE = 403`` in your settings. + +``axes.handlers.base.AxesBaseHandler.is_admin_site`` has been deprecated due to misleading naming +in favour of better-named ``axes.handlers.base.AxesBaseHandler.is_admin_request``. +The old implementation has been kept for backwards compatibility, but will be removed in the future. +The old implementation checked if a request is NOT made for an admin site if ``settings.AXES_ONLY_ADMIN_SITE`` was set. +The new implementation correctly checks if a request is made for an admin site. + +``axes.handlers.cache.AxesCacheHandler`` has been updated to use atomic ``cache.incr`` calls +instead of old ``cache.set`` calls in authentication failure tracking +to enable better parallel backend support for atomic cache backends like Redis and Memcached. + + Disabling Axes system checks ---------------------------- @@ -127,7 +206,7 @@ other code, preventing the login mechani being thrown in some part of the code, preventing access attempts being logged to database with Axes or causing similar problems. -If new attempts or log objects are not being correctly written to the Axes tables, +If new attempts or log objects are not being correctly written to the Axes tables, it is possible to configure Django ``ATOMIC_REQUESTS`` setting to to ``False``:: ATOMIC_REQUESTS = False diff -pruN 5.39.0-6/docs/3_usage.rst 7.0.1-0ubuntu1/docs/3_usage.rst --- 5.39.0-6/docs/3_usage.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/3_usage.rst 2024-12-02 16:23:57.000000000 +0000 @@ -80,7 +80,7 @@ Resetting attempts from command line ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Axes offers a command line interface with -``axes_reset``, ``axes_reset_ip``, and ``axes_reset_username`` +``axes_reset``, ``axes_reset_ip``, ``axes_reset_username``, and ``axes_reset_ip_username`` management commands with the Django ``manage.py`` or ``django-admin`` command helpers: - ``python manage.py axes_reset`` @@ -89,6 +89,8 @@ management commands with the Django ``ma will clear lockouts and records for the given IP addresses. - ``python manage.py axes_reset_username [username ...]`` will clear lockouts and records for the given usernames. +- ``python manage.py axes_reset_ip_username [ip] [username]`` + will clear lockouts and records for the given IP address and username. - ``python manage.py axes_reset_logs (age)`` will reset (i.e. delete) AccessLog records that are older than the given age where the default is 30 days. @@ -107,3 +109,24 @@ In your code, you can use the ``axes.uti Please note that if you give both ``username`` and ``ip`` arguments to ``reset`` that attempts that have both the set IP and username are reset. The effective behaviour of ``reset`` is to ``and`` the terms instead of ``or`` ing them. + + + +Data privacy and GDPR +--------------------- + +Most European countries have quite strict laws regarding data protection and privacy. It's highly recommended and good +practice to treat your sensitive user data with care. The general rule here is that you shouldn't store what you don't need. + +When dealing with brute-force protection, the IP address and the username (often the email address) are most crucial. +Given that you can perfectly use `django-axes` without locking the user out by IP but by username, it does make sense to +avoid storing the IP address at all. You can not lose what you don't have. + +You can adjust the AXES settings as follows:: + + # Block by Username only (i.e.: Same user different IP is still blocked, but different user same IP is not) + AXES_LOCKOUT_PARAMETERS = ["username"] + + # Disable logging the IP-Address of failed login attempts by returning None for attempts to get the IP + # Ignore assigning a lambda function to a variable for brevity + AXES_CLIENT_IP_CALLABLE = lambda x: None # noqa: E731 diff -pruN 5.39.0-6/docs/4_configuration.rst 7.0.1-0ubuntu1/docs/4_configuration.rst --- 5.39.0-6/docs/4_configuration.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/4_configuration.rst 2024-12-02 16:23:57.000000000 +0000 @@ -23,19 +23,19 @@ The following ``settings.py`` options ar +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_LOCK_OUT_AT_FAILURE | True | After the number of allowed login attempts are exceeded, should we lock out this IP (and optional user agent)? | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_COOLOFF_TIME | None | If set, defines a period of inactivity after which old failed login attempts will be cleared. Can be set to a Python timedelta object, an integer, a float, a callable, or a string path to a callable which takes no arguments. If an integer or float, will be interpreted as a number of hours: ``AXES_COOLOFF_TIME = 2`` 2 hours, ``AXES_COOLOFF_TIME = 2.0`` 2 hours, 120 minutes, ``AXES_COOLOFF_TIME = 1.7`` 1.7 hours, 102 minutes, 6120 seconds | +| AXES_COOLOFF_TIME | None | If set, defines a period of inactivity after which old failed login attempts will be cleared. Can be set to a Python timedelta object, an integer, a float, a callable, or a string path to a callable which takes the request as argument. If an integer or float, will be interpreted as a number of hours: ``AXES_COOLOFF_TIME = 2`` 2 hours, ``AXES_COOLOFF_TIME = 2.0`` 2 hours, 120 minutes, ``AXES_COOLOFF_TIME = 1.7`` 1.7 hours, 102 minutes, 6120 seconds | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_ONLY_ADMIN_SITE | False | If ``True``, lock is only enabled for admin site. Admin site is determined by checking request path against the path of ``"admin:index"`` view. If admin urls are not registered in current urlconf, all requests will not be locked. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_ONLY_USER_FAILURES | False | If ``True``, only lock based on username, and never lock based on IP if attempts exceed the limit. Otherwise utilize the existing IP and user locking logic. | +| AXES_ONLY_USER_FAILURES | False | DEPRECATED: USE ``AXES_LOCKOUT_PARAMETERS`` INSTEAD. If ``True``, only lock based on username, and never lock based on IP if attempts exceed the limit. Otherwise utilize the existing IP and user locking logic. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_ENABLE_ADMIN | True | If ``True``, admin views for access attempts and logins are shown in Django admin interface. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP | False | If ``True``, prevent login from IP under a particular username if the attempt limit has been exceeded, otherwise lock out based on IP. | +| AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP | False | DEPRECATED: USE ``AXES_LOCKOUT_PARAMETERS`` INSTEAD. If ``True``, prevent login from IP under a particular username if the attempt limit has been exceeded, otherwise lock out based on IP. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_LOCK_OUT_BY_USER_OR_IP | False | If ``True``, prevent login from if the attempt limit has been exceeded for IP or username. | +| AXES_LOCK_OUT_BY_USER_OR_IP | False | DEPRECATED: USE ``AXES_LOCKOUT_PARAMETERS`` INSTEAD. If ``True``, prevent login from if the attempt limit has been exceeded for IP or username. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_USE_USER_AGENT | False | If ``True``, lock out and log based on the IP address and the user agent. This means requests from different user agents but from the same IP are treated differently. This settings has no effect if the ``AXES_ONLY_USER_FAILURES`` setting is active. | +| AXES_USE_USER_AGENT | False | DEPRECATED: USE ``AXES_LOCKOUT_PARAMETERS`` INSTEAD. If ``True``, lock out and log based on the IP address and the user agent. This means requests from different user agents but from the same IP are treated differently. This settings has no effect if the ``AXES_ONLY_USER_FAILURES`` setting is active. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_HANDLER | 'axes.handlers.database.AxesDatabaseHandler' | The path to the handler class to use. If set, overrides the default signal handler backend. Default: ``'axes.handlers.database.AxesDatabaseHandler'`` | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,9 +55,11 @@ The following ``settings.py`` options ar +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_LOCKOUT_CALLABLE | None | A callable or a string path to callable that takes two arguments returns a response. For example: ``def generate_lockout_response(request: HttpRequest, credentials: dict) -> HttpResponse: ...``. This can be any callable similarly to ``AXES_USERNAME_CALLABLE``. If not callable is defined, then the default implementation in ``axes.helpers.get_lockout_response`` is used for determining the correct lockout response that is sent to the requesting client. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| AXES_CLIENT_IP_CALLABLE | None | A callable or a string path to callable that takes HttpRequest as an argument and returns the resolved IP as a response. For example: ``def get_ip(request: HttpRequest) -> str: ...``. This can be any callable similarly to ``AXES_USERNAME_CALLABLE``. If not callable is defined, then the default implementation in ``axes.helpers.get_client_ip_address`` is used. | ++------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_PASSWORD_FORM_FIELD | 'password' | The name of the form or credentials field that contains your users password. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_SENSITIVE_PARAMETERS | [] | Configures POST and GET parameter values (in addition to the value of ``AXES_PASSWORD_FORM_FIELD``) to mask in login attempt logging. | +| AXES_SENSITIVE_PARAMETERS | ["username", "ip_address"] | Configures POST and GET parameter values (in addition to the value of ``AXES_PASSWORD_FORM_FIELD``) to mask in login attempt logging. Defaults enable privacy-by-design. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_NEVER_LOCKOUT_GET | False | If ``True``, Axes will never lock out HTTP GET requests. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,10 +79,12 @@ The following ``settings.py`` options ar +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_ALLOWED_CORS_ORIGINS | "*" | Configures lockout response CORS headers for XHR requests. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| AXES_HTTP_RESPONSE_CODE | 403 | Sets the http response code returned when ``AXES_FAILURE_LIMIT`` is reached. For example: ``AXES_HTTP_RESPONSE_CODE = 429`` | +| AXES_HTTP_RESPONSE_CODE | 429 | Sets the http response code returned when ``AXES_FAILURE_LIMIT`` is reached. For example: ``AXES_HTTP_RESPONSE_CODE = 403`` | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AXES_RESET_COOL_OFF_ON_FAILURE_DURING_LOCKOUT | True | If ``True``, a failed login attempt during lockout will reset the cool off period. | +------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| AXES_LOCKOUT_PARAMETERS | ["ip_address"] | A list of parameters that Axes uses to lock out users. It can also be callable, which takes an http request or AccesAttempt object and credentials and returns a list of parameters. Each parameter can be a string (a single parameter) or a list of strings (a combined parameter). For example, if you configure ``AXES_LOCKOUT_PARAMETERS = ["ip_address", ["username", "user_agent"]]``, axes will block clients by ip and/or username and user agent combination. See :ref:`customizing-lockout-parameters` for more details. | ++------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ The configuration option precedences for the access attempt monitoring are: @@ -101,8 +105,8 @@ and uses some conservative configuration If you are using reverse proxies, you will need to configure one or more of the following settings to suit your set up to correctly resolve client IP addresses: -* ``AXES_PROXY_COUNT``: The number of reverse proxies in front of Django as an integer. Default: ``None`` -* ``AXES_META_PRECEDENCE_ORDER``: The names of ``request.META`` attributes as a tuple of strings +* ``AXES_IPWARE_PROXY_COUNT``: The number of reverse proxies in front of Django as an integer. Default: ``None`` +* ``AXES_IPWARE_META_PRECEDENCE_ORDER``: The names of ``request.META`` attributes as a tuple of strings to check to get the client IP address. Check the Django documentation for header naming conventions. Default: ``IPWARE_META_PRECEDENCE_ORDER`` setting if set, else ``('REMOTE_ADDR', )`` @@ -112,7 +116,7 @@ following settings to suit your set up t .. code-block:: python # refer to the Django request and response objects documentation - AXES_META_PRECEDENCE_ORDER = [ + AXES_IPWARE_META_PRECEDENCE_ORDER = [ 'HTTP_X_FORWARDED_FOR', 'REMOTE_ADDR', ] @@ -133,6 +137,12 @@ with the ``AXES_HANDLER`` setting in pro logs attempts to database and creates AccessAttempt and AccessLog records that persist until removed from the database manually or automatically after their cool offs expire (checked on each login event). + +.. note:: + To keep track of concurrent sessions AccessLog stores an hash of ``session_key`` if the session engine is configured. + When no session engine is configured each access is stored with the same dummy value, then a logout will cause each *not-logged-out yet* logs to set a logout time. + Due to how ``django.contrib.auth`` works it is not possible to correctly track the logout of a session in which the user changed its password, since it will create a new session without firing any logout event. + - ``axes.handlers.cache.AxesCacheHandler`` only uses the cache for monitoring attempts and does not persist data other than in the cache backend; this data can be purged automatically diff -pruN 5.39.0-6/docs/5_customization.rst 7.0.1-0ubuntu1/docs/5_customization.rst --- 5.39.0-6/docs/5_customization.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/5_customization.rst 2024-12-02 16:23:57.000000000 +0000 @@ -34,7 +34,7 @@ Here is a more detailed example of sendi and a custom auth backend at an endpoint that expects JSON requests. The custom authentication can be swapped out with ``authenticate`` and ``login`` from ``django.contrib.auth``, but beware that those methods take -care of sending the nessary signals for you, and there is no need to duplicate +care of sending the necessary signals for you, and there is no need to duplicate them as per the example. ``example/forms.py``:: @@ -155,7 +155,6 @@ into ``my_namespace-username``: fine, but Axes does not inject these changes into the authentication flow for you. - Customizing lockout responses ----------------------------- @@ -173,3 +172,59 @@ An example of usage could be e.g. a cust ``settings.py``:: AXES_LOCKOUT_CALLABLE = "example.views.lockout" + +.. _customizing-lockout-parameters: + +Customizing lockout parameters +------------------------------ + +Axes can be configured with ``AXES_LOCKOUT_PARAMETERS`` to lock out users not only by IP address. + +``AXES_LOCKOUT_PARAMETERS`` can be a list of strings (which represents a separate lockout parameter) or nested lists of strings (which represents lockout parameters used in combination) or a callable which accepts HttpRequest or AccessAttempt and credentials and returns a list of the same form as described earlier. + +Example ``AXES_LOCKOUT_PARAMETERS`` configuration: + +``settings.py``:: + + AXES_LOCKOUT_PARAMETERS = ["ip_address", ["username", "user_agent"]] + +This way, axes will lock out users using ip_address and/or combination of username and user agent + +Example of callable ``AXES_LOCKOUT_PARAMETERS``: + +``example/utils.py``:: + + from django.http import HttpRequest + + def get_lockout_parameters(request_or_attempt, credentials): + + if isinstance(request_or_attempt, HttpRequest): + is_localhost = request.META.get("REMOTE_ADDR") == "127.0.0.1" + + else: + is_localhost = request_or_attempt.ip_address == "127.0.0.1" + + if is_localhost: + return ["username"] + + return ["ip_address", "username"] + +``settings.py``:: + + AXES_LOCKOUT_PARAMETERS = "example.utils.get_lockout_parameters" + +This way, if client ip_address is localhost, axes will lockout client only by username. In other case, axes will lockout client by username and/or ip_address. + +Customizing client ip address lookups +------------------------------------- + +Axes can be configured with ``AXES_CLIENT_IP_CALLABLE`` to use custom client ip address lookup logic. + +``example/utils.py``:: + + def get_client_ip(request): + return request.META.get("REMOTE_ADDR") + +``settings.py``:: + + AXES_CLIENT_IP_CALLABLE = "example.utils.get_client_ip" diff -pruN 5.39.0-6/docs/6_integration.rst 7.0.1-0ubuntu1/docs/6_integration.rst --- 5.39.0-6/docs/6_integration.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/6_integration.rst 2024-12-02 16:23:57.000000000 +0000 @@ -20,6 +20,7 @@ Django Allauth Django Simple Captcha |check| Django OAuth Toolkit |check| Django Reversion |check| +Django Auth LDAP |check| ======================= ============= ============ ============ ============== .. |check| unicode:: U+2713 diff -pruN 5.39.0-6/docs/7_architecture.rst 7.0.1-0ubuntu1/docs/7_architecture.rst --- 5.39.0-6/docs/7_architecture.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/7_architecture.rst 2024-12-02 16:23:57.000000000 +0000 @@ -56,7 +56,7 @@ are not blocked, and allows the requests If the authentication attempt matches a lockout rule, e.g. it is from a blacklisted IP or exceeds the maximum configured authentication attempts, -it is blocked by raising the ``PermissionDenied`` excepton in the backend. +it is blocked by raising the ``PermissionDenied`` exception in the backend. Axes monitors logins with the ``user_login_failed`` signal receiver and records authentication failures from both the ``AxesBackend`` and diff -pruN 5.39.0-6/docs/9_contributing.rst 7.0.1-0ubuntu1/docs/9_contributing.rst --- 5.39.0-6/docs/9_contributing.rst 1970-01-01 00:00:00.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/9_contributing.rst 2024-12-02 16:23:57.000000000 +0000 @@ -0,0 +1,3 @@ +.. _contributing: + +.. include:: ../CONTRIBUTING.rst diff -pruN 5.39.0-6/docs/9_development.rst 7.0.1-0ubuntu1/docs/9_development.rst --- 5.39.0-6/docs/9_development.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/9_development.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,46 +0,0 @@ -.. _development: - -Development -=========== - -You can contribute to this project forking it from GitHub and sending pull requests. - -First `fork `_ the -`repository `_ and then clone it:: - - $ git clone git@github.com:/django-axes.git - -Initialize a virtual environment for development purposes:: - - $ mkdir -p ~/.virtualenvs - $ python3 -m venv ~/.virtualenvs/django-axes - $ source ~/.virtualenvs/django-axes/bin/activate - -Then install the necessary requirements:: - - $ cd django-axes - $ pip install -r requirements.txt - -Unit tests are located in the ``axes/tests`` folder and can be easily run with the pytest tool:: - - $ pytest - -Prospector runs a number of source code style, safety, and complexity checks:: - - $ prospector - -Mypy runs static typing checks to verify the source code type annotations and correctness:: - - $ mypy . - -Before committing, you can run all the above tests against all supported Python and Django versions with tox:: - - $ tox - -Tox runs the same test set that is run by GitHub Actions, and your code should be good to go if it passes. - -If you wish to limit the testing to specific environment(s), you can parametrize the tox run:: - - $ tox -e py39-django32 - -After you have pushed your changes, open a pull request on GitHub for getting your code upstreamed. diff -pruN 5.39.0-6/docs/Makefile 7.0.1-0ubuntu1/docs/Makefile --- 5.39.0-6/docs/Makefile 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/Makefile 2024-12-02 16:23:57.000000000 +0000 @@ -9,7 +9,7 @@ BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/) endif # Internal variables. diff -pruN 5.39.0-6/docs/conf.py 7.0.1-0ubuntu1/docs/conf.py --- 5.39.0-6/docs/conf.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/conf.py 2024-12-02 16:23:57.000000000 +0000 @@ -3,7 +3,7 @@ Sphinx documentation generator configura More information on the configuration options is available at: - http://www.sphinx-doc.org/en/master/usage/configuration.html + https://www.sphinx-doc.org/en/master/usage/configuration.html """ import sphinx_rtd_theme diff -pruN 5.39.0-6/docs/index.rst 7.0.1-0ubuntu1/docs/index.rst --- 5.39.0-6/docs/index.rst 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/docs/index.rst 2024-12-02 16:23:57.000000000 +0000 @@ -18,7 +18,7 @@ Contents 6_integration 7_architecture 8_reference - 9_development + 9_contributing 10_changelog diff -pruN 5.39.0-6/mypy.ini 7.0.1-0ubuntu1/mypy.ini --- 5.39.0-6/mypy.ini 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/mypy.ini 2024-12-02 16:23:57.000000000 +0000 @@ -1,5 +1,5 @@ [mypy] -python_version = 3.6 +python_version = 3.9 ignore_missing_imports = True [mypy-axes.migrations.*] diff -pruN 5.39.0-6/pyproject.toml 7.0.1-0ubuntu1/pyproject.toml --- 5.39.0-6/pyproject.toml 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/pyproject.toml 2024-12-02 16:23:57.000000000 +0000 @@ -10,25 +10,25 @@ DJANGO_SETTINGS_MODULE = "tests.settings legacy_tox_ini = """ [tox] envlist = - py{37,38,39,310,py38}-dj32 - py{38,39,310,py38}-dj40 - py{38,39,310,py38}-dj41 - py{38,39,310,py38}-djmain - py310-djqa + py{39,310,311,312}-dj42 + py{310,311,312}-dj50 + py{310,311,312,313}-dj51 + py311-djmain + py311-djqa [gh-actions] python = - 3.7: py37 - 3.8: py38 3.9: py39 3.10: py310 - pypy-3.8: pypy38 + 3.11: py311 + 3.12: py312 + 3.13: py313 [gh-actions:env] DJANGO = - 3.2: dj32 - 4.0: dj40 - 4.1: dj41 + 4.2: dj42 + 5.0: dj50 + 5.1: dj51 main: djmain qa: djqa @@ -36,9 +36,9 @@ DJANGO = [testenv] deps = -r requirements-test.txt - dj32: django>=3.2,<3.3 - dj40: django>=4.0,<4.1 - dj41: django>=4.1,<4.2 + dj42: django>=4.1,<4.2 + dj50: django>=5.0,<5.1 + dj51: django>=5.1,<5.2 djmain: https://github.com/django/django/archive/main.tar.gz usedevelop = true commands = pytest @@ -47,16 +47,14 @@ setenv = # Django development version is allowed to fail the test matrix ignore_outcome = djmain: True - pypy38-dj41: True ignore_errors = djmain: True - pypy38-dj41: True # QA runs type checks, linting, and code formatting checks -[testenv:py310-djqa] +[testenv:py313-djqa] deps = -r requirements-qa.txt commands = mypy axes prospector - black -t py38 --check --diff axes + black -t py39 --check --diff axes """ diff -pruN 5.39.0-6/requirements-qa.txt 7.0.1-0ubuntu1/requirements-qa.txt --- 5.39.0-6/requirements-qa.txt 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/requirements-qa.txt 2024-12-02 16:23:57.000000000 +0000 @@ -1,4 +1,3 @@ -black==22.6.0 -mypy==0.971 -prospector==1.7.7 -types-pkg_resources # Type stub +black==24.10.0 +mypy==1.13.0 +prospector==1.12.1 diff -pruN 5.39.0-6/requirements-test.txt 7.0.1-0ubuntu1/requirements-test.txt --- 5.39.0-6/requirements-test.txt 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/requirements-test.txt 2024-12-02 16:23:57.000000000 +0000 @@ -1,6 +1,7 @@ -e . -coverage==6.4.4 -pytest==7.1.2 -pytest-cov==3.0.0 -pytest-django==4.5.2 -pytest-subtests==0.8.0 +django-ipware>=3 +coverage==7.6.4 +pytest==8.3.3 +pytest-cov==5.0.0 +pytest-django==4.9.0 +pytest-subtests==0.13.1 diff -pruN 5.39.0-6/requirements.txt 7.0.1-0ubuntu1/requirements.txt --- 5.39.0-6/requirements.txt 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/requirements.txt 2024-12-02 16:23:57.000000000 +0000 @@ -1,5 +1,5 @@ -e . -r requirements-qa.txt -r requirements-test.txt -sphinx_rtd_theme==1.0.0 -tox==3.25.1 +sphinx_rtd_theme==3.0.1 +tox==4.23.2 diff -pruN 5.39.0-6/setup.py 7.0.1-0ubuntu1/setup.py --- 5.39.0-6/setup.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/setup.py 2024-12-02 16:23:57.000000000 +0000 @@ -36,7 +36,13 @@ setup( use_scm_version=True, setup_requires=["setuptools_scm"], python_requires=">=3.7", - install_requires=["django>=3.2", "django-ipware>=3", "setuptools"], + install_requires=[ + "django>=3.2", + "asgiref>=3.6.0", + ], + extras_require={ + "ipware": "django-ipware>=3", + }, include_package_data=True, packages=find_packages(exclude=["tests"]), classifiers=[ @@ -44,21 +50,21 @@ setup( "Environment :: Web Environment", "Environment :: Plugins", "Framework :: Django", - "Framework :: Django :: 3.2", - "Framework :: Django :: 4.0", - "Framework :: Django :: 4.1", + "Framework :: Django :: 4.2", + "Framework :: Django :: 5.0", + "Framework :: Django :: 5.1", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: CPython", - "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet :: Log Analysis", "Topic :: Security", "Topic :: System :: Logging", diff -pruN 5.39.0-6/tests/base.py 7.0.1-0ubuntu1/tests/base.py --- 5.39.0-6/tests/base.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/base.py 2024-12-02 16:23:57.000000000 +0000 @@ -48,7 +48,7 @@ class AxesTestCase(TestCase): STATUS_SUCCESS = 200 ALLOWED = 302 - BLOCKED = 403 + BLOCKED = 429 def setUp(self): """ diff -pruN 5.39.0-6/tests/test_attempts.py 7.0.1-0ubuntu1/tests/test_attempts.py --- 5.39.0-6/tests/test_attempts.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_attempts.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,7 +1,7 @@ from unittest.mock import patch from django.http import HttpRequest -from django.test import override_settings +from django.test import override_settings, RequestFactory from django.utils.timezone import now from axes.attempts import get_cool_off_threshold @@ -15,12 +15,13 @@ class GetCoolOffThresholdTestCase(AxesTe def test_get_cool_off_threshold(self): timestamp = now() + request = RequestFactory().post("/") with patch("axes.attempts.now", return_value=timestamp): - attempt_time = timestamp - threshold_now = get_cool_off_threshold(attempt_time) + request.axes_attempt_time = timestamp + threshold_now = get_cool_off_threshold(request) - attempt_time = None - threshold_none = get_cool_off_threshold(attempt_time) + request.axes_attempt_time = None + threshold_none = get_cool_off_threshold(request) self.assertEqual(threshold_now, threshold_none) @@ -82,74 +83,74 @@ class ResetResponseTestCase(AxesTestCase reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_reset_user_failures(self): reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 5) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_reset_ip_user_failures(self): self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 5) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_reset_username_user_failures(self): self.request.GET["username"] = self.USERNAME_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_reset_ip_username_user_failures(self): self.request.GET["username"] = self.USERNAME_1 self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_reset_user_or_ip(self): reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 5) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_reset_ip_user_or_ip(self): self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_reset_username_user_or_ip(self): self.request.GET["username"] = self.USERNAME_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_reset_ip_username_user_or_ip(self): self.request.GET["username"] = self.USERNAME_1 self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 2) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_reset_user_and_ip(self): reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 5) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_reset_ip_user_and_ip(self): self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_reset_username_user_and_ip(self): self.request.GET["username"] = self.USERNAME_1 reset_request(self.request) self.assertEqual(AccessAttempt.objects.count(), 3) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_AND=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_reset_ip_username_user_and_ip(self): self.request.GET["username"] = self.USERNAME_1 self.request.META["REMOTE_ADDR"] = self.IP_1 reset_request(self.request) - self.assertEqual(AccessAttempt.objects.count(), 3) + self.assertEqual(AccessAttempt.objects.count(), 4) diff -pruN 5.39.0-6/tests/test_checks.py 7.0.1-0ubuntu1/tests/test_checks.py --- 5.39.0-6/tests/test_checks.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_checks.py 2024-12-02 16:23:57.000000000 +0000 @@ -110,3 +110,22 @@ class DeprecatedSettingsTestCase(AxesTes def test_deprecated_success_access_log_flag(self): warnings = run_checks() self.assertEqual(warnings, [self.disable_success_access_log_warning]) + + +class ConfCheckTestCase(AxesTestCase): + @override_settings(AXES_USERNAME_CALLABLE="module.not_defined") + def test_invalid_import_path(self): + warnings = run_checks() + warning = Warning( + msg=Messages.CALLABLE_INVALID.format( + callable_setting="AXES_USERNAME_CALLABLE" + ), + hint=Hints.CALLABLE_INVALID, + id=Codes.CALLABLE_INVALID, + ) + self.assertEqual(warnings, [warning]) + + @override_settings(AXES_COOLOFF_TIME=lambda: 1) + def test_valid_callable(self): + warnings = run_checks() + self.assertEqual(warnings, []) diff -pruN 5.39.0-6/tests/test_decorators.py 7.0.1-0ubuntu1/tests/test_decorators.py --- 5.39.0-6/tests/test_decorators.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_decorators.py 2024-12-02 16:23:57.000000000 +0000 @@ -8,7 +8,7 @@ from tests.base import AxesTestCase class DecoratorTestCase(AxesTestCase): SUCCESS_RESPONSE = HttpResponse(status=200, content="Dispatched") - LOCKOUT_RESPONSE = HttpResponse(status=403, content="Locked out") + LOCKOUT_RESPONSE = HttpResponse(status=429, content="Locked out") def setUp(self): self.request = MagicMock() diff -pruN 5.39.0-6/tests/test_handlers.py 7.0.1-0ubuntu1/tests/test_handlers.py --- 5.39.0-6/tests/test_handlers.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_handlers.py 2024-12-02 16:23:57.000000000 +0000 @@ -55,14 +55,36 @@ class AxesHandlerTestCase(AxesTestCase): for setting_value, url, expected in tests: with override_settings(AXES_ONLY_ADMIN_SITE=setting_value): request.path = url - self.assertEqual(AxesProxyHandler().is_admin_site(request), expected) + with self.assertWarns(DeprecationWarning): + self.assertEqual(AxesProxyHandler().is_admin_site(request), expected) + + def test_is_admin_request(self): + request = MagicMock() + tests = ( # (URL, Expected) + ("/test/", False), + (reverse("admin:index"), True), + ) + + for url, expected in tests: + request.path = url + self.assertEqual(AxesProxyHandler().is_admin_request(request), expected) @override_settings(ROOT_URLCONF="tests.urls_empty") @override_settings(AXES_ONLY_ADMIN_SITE=True) def test_is_admin_site_no_admin_site(self): request = MagicMock() request.path = "/admin/" - self.assertTrue(AxesProxyHandler().is_admin_site(self.request)) + with self.assertWarns(DeprecationWarning): + self.assertTrue(AxesProxyHandler().is_admin_site(self.request)) + + @override_settings(ROOT_URLCONF="tests.urls_empty") + def test_is_admin_request_no_admin_site(self): + request = MagicMock() + request.path = "/admin/" + self.assertFalse(AxesProxyHandler().is_admin_request(self.request)) + + def test_is_admin_request_no_path(self): + self.assertFalse(AxesProxyHandler().is_admin_request(self.request)) class AxesProxyHandlerTestCase(AxesTestCase): @@ -214,11 +236,6 @@ class ResetAttemptsTestCase(AxesHandlerB AXES_RESET_ON_SUCCESS=True, AXES_ENABLE_ACCESS_FAILURE_LOG=True, ) -@mark.xfail( - python_implementation() == "PyPy", - reason="PyPy implementation is flaky for this test", - strict=False, -) class AxesDatabaseHandlerTestCase(AxesHandlerBaseTestCase): def test_handler_reset_attempts(self): self.create_attempt() @@ -261,7 +278,10 @@ class AxesDatabaseHandlerTestCase(AxesHa _more = 10 for i in range(settings.AXES_ACCESS_FAILURE_LOG_PER_USER_LIMIT + _more): self.create_failure_log() - self.assertEqual(_more, AxesProxyHandler.remove_out_of_limit_failure_logs(username=self.username)) + self.assertEqual( + _more, + AxesProxyHandler.remove_out_of_limit_failure_logs(username=self.username), + ) @override_settings(AXES_RESET_ON_SUCCESS=True) def test_handler(self): @@ -296,7 +316,7 @@ class AxesDatabaseHandlerTestCase(AxesHa def test_whitelist(self, log): self.check_whitelist(log) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) @patch("axes.handlers.database.log") def test_user_login_failed_only_user_failures_with_none_username(self, log): credentials = {"username": None, "password": "test"} @@ -305,7 +325,7 @@ class AxesDatabaseHandlerTestCase(AxesHa attempt = AccessAttempt.objects.all() self.assertEqual(0, AccessAttempt.objects.count()) log.warning.assert_called_with( - "AXES: Username is None and AXES_ONLY_USER_FAILURES is enabled, new record will NOT be created." + "AXES: Username is None and username is the only one lockout parameter, new record will NOT be created." ) def test_user_login_failed_with_none_username(self): @@ -318,22 +338,37 @@ class AxesDatabaseHandlerTestCase(AxesHa def test_user_login_failed_multiple_username(self): configurations = ( (2, 1, {}, ["admin", "admin1"]), - (2, 1, {"AXES_USE_USER_AGENT": True}, ["admin", "admin1"]), - (2, 1, {"AXES_ONLY_USER_FAILURES": True}, ["admin", "admin1"]), ( 2, 1, - {"AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP": True}, + {"AXES_LOCKOUT_PARAMETERS": [["ip_address", "user_agent"]]}, + ["admin", "admin1"], + ), + (2, 1, {"AXES_LOCKOUT_PARAMETERS": ["username"]}, ["admin", "admin1"]), + ( + 2, + 1, + {"AXES_LOCKOUT_PARAMETERS": [["username", "ip_address"]]}, ["admin", "admin1"], ), ( 1, 2, - {"AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP": True}, + {"AXES_LOCKOUT_PARAMETERS": [["username", "ip_address"]]}, + ["admin", "admin"], + ), + ( + 1, + 2, + {"AXES_LOCKOUT_PARAMETERS": ["username", "ip_address"]}, ["admin", "admin"], ), - (1, 2, {"AXES_LOCK_OUT_BY_USER_OR_IP": True}, ["admin", "admin"]), - (2, 1, {"AXES_LOCK_OUT_BY_USER_OR_IP": True}, ["admin", "admin1"]), + ( + 2, + 1, + {"AXES_LOCKOUT_PARAMETERS": ["username", "ip_address"]}, + ["admin", "admin1"], + ), ) for ( @@ -400,7 +435,7 @@ class ResetAttemptsCacheHandlerTestCase( with self.assertRaises(NotImplementedError): AxesProxyHandler.reset_attempts() - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_handler_reset_attempts_username(self): self.set_up_login_attempts() self.assertEqual( @@ -436,7 +471,7 @@ class ResetAttemptsCacheHandlerTestCase( self.check_failures(0, ip_address=self.IP_1) self.check_failures(2, ip_address=self.IP_2) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_handler_reset_attempts_ip_and_username(self): self.set_up_login_attempts() self.check_failures(1, username=self.USERNAME_1, ip_address=self.IP_1) @@ -482,7 +517,7 @@ class AxesCacheHandlerTestCase(AxesHandl def test_whitelist(self, log): self.check_whitelist(log) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) @patch.object(cache, "set") @patch("axes.handlers.cache.log") def test_user_login_failed_only_user_failures_with_none_username( @@ -493,15 +528,15 @@ class AxesCacheHandlerTestCase(AxesHandl AxesProxyHandler.user_login_failed(sender, credentials, self.request) self.assertFalse(cache_set.called) log.warning.assert_called_with( - "AXES: Username is None and AXES_ONLY_USER_FAILURES is enabled, new record will NOT be created." + "AXES: Username is None and username is the only one lockout parameter, new record will NOT be created." ) - @patch.object(cache, "set") - def test_user_login_failed_with_none_username(self, cache_set): + @patch.object(cache, "add") + def test_user_login_failed_with_none_username(self, cache_add): credentials = {"username": None, "password": "test"} sender = MagicMock() AxesProxyHandler.user_login_failed(sender, credentials, self.request) - self.assertTrue(cache_set.called) + self.assertTrue(cache_add.called) @override_settings(AXES_HANDLER="axes.handlers.dummy.AxesDummyHandler") diff -pruN 5.39.0-6/tests/test_helpers.py 7.0.1-0ubuntu1/tests/test_helpers.py --- 5.39.0-6/tests/test_helpers.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_helpers.py 2024-12-02 16:23:57.000000000 +0000 @@ -3,16 +3,18 @@ from hashlib import sha256 from unittest.mock import patch from django.contrib.auth import get_user_model -from django.http import JsonResponse, HttpResponseRedirect, HttpResponse, HttpRequest -from django.test import override_settings, RequestFactory +from django.http import HttpRequest, HttpResponse, HttpResponseRedirect, JsonResponse +from django.test import RequestFactory, override_settings from axes.apps import AppConfig from axes.helpers import ( + cleanse_parameters, get_cache_timeout, + get_client_cache_keys, + get_client_ip_address, + get_client_parameters, get_client_str, get_client_username, - get_client_cache_key, - get_client_parameters, get_cool_off, get_cool_off_iso8601, get_lockout_response, @@ -23,7 +25,6 @@ from axes.helpers import ( is_ip_address_in_whitelist, is_user_attempt_whitelisted, toggleable, - cleanse_parameters, ) from axes.models import AccessAttempt from tests.base import AxesTestCase @@ -58,6 +59,38 @@ class CacheTestCase(AxesTestCase): def test_get_cache_timeout_none(self): self.assertEqual(get_cache_timeout(), None) + def test_get_increasing_cache_timeout_by_username(self): + user_durations = { + "ben": timedelta(minutes=5), + "jen": timedelta(minutes=10), + } + + def _callback(request): + username = request.POST["username"] if request else object() + previous_duration = user_durations.get(username, timedelta()) + user_durations[username] = previous_duration + timedelta(minutes=5) + return user_durations[username] + + rf = RequestFactory() + ben_req = rf.post("/", data={"username": "ben"}) + jen_req = rf.post("/", data={"username": "jen"}) + james_req = rf.post("/", data={"username": "james"}) + + with override_settings(AXES_COOLOFF_TIME=_callback): + with self.subTest("no username"): + self.assertEqual(get_cache_timeout(), 300) + + with self.subTest("ben"): + self.assertEqual(get_cache_timeout(ben_req), 600) + self.assertEqual(get_cache_timeout(ben_req), 900) + self.assertEqual(get_cache_timeout(ben_req), 1200) + + with self.subTest("jen"): + self.assertEqual(get_cache_timeout(jen_req), 900) + + with self.subTest("james"): + self.assertEqual(get_cache_timeout(james_req), 300) + class TimestampTestCase(AxesTestCase): def test_iso8601(self): @@ -81,6 +114,7 @@ class TimestampTestCase(AxesTestCase): self.assertEqual(get_cool_off_iso8601(delta), iso_duration) +@override_settings(AXES_SENSITIVE_PARAMETERS=[]) class ClientStringTestCase(AxesTestCase): @staticmethod def get_expected_client_str(*args, **kwargs): @@ -149,7 +183,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) @override_settings(AXES_VERBOSE=True) def test_verbose_user_only_client_details(self): username = "test@example.com" @@ -166,7 +200,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) @override_settings(AXES_VERBOSE=False) def test_non_verbose_user_only_client_details(self): username = "test@example.com" @@ -181,7 +215,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) @override_settings(AXES_VERBOSE=True) def test_verbose_user_ip_combo_client_details(self): username = "test@example.com" @@ -198,7 +232,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) @override_settings(AXES_VERBOSE=False) def test_non_verbose_user_ip_combo_client_details(self): username = "test@example.com" @@ -213,7 +247,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_USE_USER_AGENT=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"]]) @override_settings(AXES_VERBOSE=True) def test_verbose_user_agent_client_details(self): username = "test@example.com" @@ -230,7 +264,7 @@ class ClientStringTestCase(AxesTestCase) self.assertEqual(expected, actual) - @override_settings(AXES_USE_USER_AGENT=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"]]) @override_settings(AXES_VERBOSE=False) def test_non_verbose_user_agent_client_details(self): username = "test@example.com" @@ -268,6 +302,26 @@ class ClientStringTestCase(AxesTestCase) self.email, ) + @override_settings(AXES_SENSITIVE_PARAMETERS=["username"]) + def test_get_client_str_with_sensitive_parameters(self): + username = "test@example.com" + ip_address = "127.0.0.1" + user_agent = "Googlebot/2.1 (+http://www.googlebot.com/bot.html)" + path_info = "/admin/" + + expected = self.get_expected_client_str( + "********************", + ip_address, + user_agent, + path_info, + self.request + ) + actual = get_client_str( + username, ip_address, user_agent, path_info, self.request + ) + + self.assertEqual(expected, actual) + def get_dummy_client_str(username, ip_address, user_agent, path_info, request): return "client string" @@ -279,76 +333,265 @@ def get_dummy_client_str_using_request( return f"{request.user.email}" +def get_dummy_lockout_parameters(request, credentials=None): + return ["ip_address", ["username", "user_agent"]] + + class ClientParametersTestCase(AxesTestCase): - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_get_filter_kwargs_user(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), [{"username": self.username}], ) - @override_settings( - AXES_ONLY_USER_FAILURES=False, - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=False, - AXES_USE_USER_AGENT=False, - ) def test_get_filter_kwargs_ip(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), [{"ip_address": self.ip_address}], ) - @override_settings( - AXES_ONLY_USER_FAILURES=False, - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True, - AXES_USE_USER_AGENT=False, - ) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_get_filter_kwargs_user_and_ip(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), [{"username": self.username, "ip_address": self.ip_address}], ) - @override_settings( - AXES_ONLY_USER_FAILURES=False, - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=False, - AXES_LOCK_OUT_BY_USER_OR_IP=True, - AXES_USE_USER_AGENT=False, - ) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "user_agent"]]) + def test_get_filter_kwargs_user_and_user_agent(self): + self.assertEqual( + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), + [{"username": self.username, "user_agent": self.user_agent}], + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=["ip_address", ["username", "user_agent"]]) + def test_get_filter_kwargs_ip_or_user_and_user_agent(self): + self.assertEqual( + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), + [{"ip_address": self.ip_address}, {"username": self.username, "user_agent": self.user_agent}], + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"], ["username", "user_agent"]]) + def test_get_filter_kwargs_ip_and_user_agent_or_user_and_user_agent(self): + self.assertEqual( + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), + [{"ip_address": self.ip_address, "user_agent": self.user_agent}, {"username": self.username, "user_agent": self.user_agent}], + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_get_filter_kwargs_user_or_ip(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), [{"username": self.username}, {"ip_address": self.ip_address}], ) - @override_settings( - AXES_ONLY_USER_FAILURES=False, - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=False, - AXES_USE_USER_AGENT=True, - ) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address", "user_agent"]) + def test_get_filter_kwargs_user_or_ip_or_user_agent(self): + self.assertEqual( + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), + [{"username": self.username}, {"ip_address": self.ip_address}, {"user_agent": self.user_agent}], + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"]]) def test_get_filter_kwargs_ip_and_agent(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), - [{"ip_address": self.ip_address}, {"user_agent": self.user_agent}], + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), + [{"ip_address": self.ip_address, "user_agent": self.user_agent}], ) @override_settings( - AXES_ONLY_USER_FAILURES=False, - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True, - AXES_USE_USER_AGENT=True, + AXES_LOCKOUT_PARAMETERS=[["username", "ip_address", "user_agent"]] ) def test_get_filter_kwargs_user_ip_agent(self): self.assertEqual( - get_client_parameters(self.username, self.ip_address, self.user_agent), + get_client_parameters(self.username, self.ip_address, self.user_agent, self.request, self.credentials), [ - {"username": self.username, "ip_address": self.ip_address}, - {"user_agent": self.user_agent}, + { + "username": self.username, + "ip_address": self.ip_address, + "user_agent": self.user_agent, + }, ], ) + @override_settings(AXES_LOCKOUT_PARAMETERS=["wrong_param"]) + @patch("axes.helpers.log") + def test_get_filter_kwargs_invalid_parameter(self, log): + with self.assertRaises(ValueError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + log.exception.assert_called_with( + ( + "wrong_param lockout parameter is not allowed. " + "Allowed lockout parameters: username, ip_address, user_agent" + ) + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "wrong_param"]]) + @patch("axes.helpers.log") + def test_get_filter_kwargs_invalid_combined_parameter(self, log): + with self.assertRaises(ValueError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + log.exception.assert_called_with( + ( + "wrong_param lockout parameter is not allowed. " + "Allowed lockout parameters: username, ip_address, user_agent" + ) + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=get_dummy_lockout_parameters) + def test_get_filter_kwargs_callable_lockout_parameters(self): + self.assertEqual( + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ), + [ + { + "ip_address": self.ip_address, + }, + { + "username": self.username, + "user_agent": self.user_agent, + }, + ], + ) + + @override_settings( + AXES_LOCKOUT_PARAMETERS="tests.test_helpers.get_dummy_lockout_parameters" + ) + def test_get_filter_kwargs_callable_str_lockout_parameters(self): + self.assertEqual( + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ), + [ + { + "ip_address": self.ip_address, + }, + { + "username": self.username, + "user_agent": self.user_agent, + }, + ], + ) + + @override_settings( + AXES_LOCKOUT_PARAMETERS=lambda request, credentials: ["username"] + ) + def test_get_filter_kwargs_callable_lambda_lockout_parameters(self): + self.assertEqual( + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ), + [ + { + "username": self.username, + }, + ], + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=True) + def test_get_filter_kwargs_not_list_or_callable(self): + with self.assertRaises(TypeError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=lambda: None) + def test_get_filter_kwargs_invalid_callable_too_few_arguments(self): + with self.assertRaises(TypeError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + + @override_settings(AXES_LOCKOUT_PARAMETERS=lambda request, credentials, extra: None) + def test_get_filter_kwargs_invalid_callable_too_many_arguments(self): + with self.assertRaises(TypeError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + + @override_settings( + AXES_LOCKOUT_PARAMETERS=lambda request, credentials: ["wrong_param"] + ) + @patch("axes.helpers.log") + def test_get_filter_kwargs_callable_invalid_lockout_param(self, log): + with self.assertRaises(ValueError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + log.exception.assert_called_with( + ( + "wrong_param lockout parameter is not allowed. " + "Allowed lockout parameters: username, ip_address, user_agent" + ) + ) + + @override_settings( + AXES_LOCKOUT_PARAMETERS=lambda request, credentials: [ + ["ip_address", "wrong_param"] + ] + ) + @patch("axes.helpers.log") + def test_get_filter_kwargs_callable_invalid_combined_lockout_param(self, log): + with self.assertRaises(ValueError): + get_client_parameters( + self.username, + self.ip_address, + self.user_agent, + self.request, + self.credentials, + ) + log.exception.assert_called_with( + ( + "wrong_param lockout parameter is not allowed. " + "Allowed lockout parameters: username, ip_address, user_agent" + ) + ) + class ClientCacheKeyTestCase(AxesTestCase): - def test_get_cache_key(self): + def test_get_cache_keys(self): """ Test the cache key format. """ @@ -362,7 +605,7 @@ class ClientCacheKeyTestCase(AxesTestCas "/admin/login/", data={"username": self.username, "password": "test"} ) - self.assertEqual([cache_hash_key], get_client_cache_key(request)) + self.assertEqual([cache_hash_key], get_client_cache_keys(request)) # Getting cache key from AccessAttempt Object attempt = AccessAttempt( @@ -376,7 +619,7 @@ class ClientCacheKeyTestCase(AxesTestCas failures_since_start=0, ) - self.assertEqual([cache_hash_key], get_client_cache_key(attempt)) + self.assertEqual([cache_hash_key], get_client_cache_keys(attempt)) def test_get_cache_key_empty_ip_address(self): """ @@ -396,7 +639,7 @@ class ClientCacheKeyTestCase(AxesTestCas REMOTE_ADDR=empty_ip_address, ) - self.assertEqual([cache_hash_key], get_client_cache_key(request)) + self.assertEqual([cache_hash_key], get_client_cache_keys(request)) # Getting cache key from AccessAttempt Object attempt = AccessAttempt( @@ -410,7 +653,7 @@ class ClientCacheKeyTestCase(AxesTestCas failures_since_start=0, ) - self.assertEqual([cache_hash_key], get_client_cache_key(attempt)) + self.assertEqual([cache_hash_key], get_client_cache_keys(attempt)) def test_get_cache_key_credentials(self): """ @@ -430,7 +673,7 @@ class ClientCacheKeyTestCase(AxesTestCas # Difference between the upper test: new call signature with credentials credentials = {"username": self.username} - self.assertEqual([cache_hash_key], get_client_cache_key(request, credentials)) + self.assertEqual([cache_hash_key], get_client_cache_keys(request, credentials)) # Getting cache key from AccessAttempt Object attempt = AccessAttempt( @@ -443,7 +686,7 @@ class ClientCacheKeyTestCase(AxesTestCas path_info=request.META.get("PATH_INFO", ""), failures_since_start=0, ) - self.assertEqual([cache_hash_key], get_client_cache_key(attempt)) + self.assertEqual([cache_hash_key], get_client_cache_keys(attempt)) class UsernameTestCase(AxesTestCase): @@ -554,6 +797,53 @@ def get_username(request, credentials: d return "username" +def get_ip(request: HttpRequest) -> str: + return "127.0.0.1" + + +class ClientIpAddressTestCase(AxesTestCase): + @override_settings(AXES_CLIENT_IP_CALLABLE=get_ip) + def test_get_client_ip_address(self): + self.assertEqual(get_client_ip_address(HttpRequest()), "127.0.0.1") + + @override_settings(AXES_CLIENT_IP_CALLABLE="tests.test_helpers.get_ip") + def test_get_client_ip_address_str(self): + self.assertEqual(get_client_ip_address(HttpRequest()), "127.0.0.1") + + @override_settings( + AXES_CLIENT_IP_CALLABLE=lambda request: "127.0.0.1" + ) # pragma: no cover + def test_get_client_ip_address_lambda(self): + self.assertEqual(get_client_ip_address(HttpRequest()), "127.0.0.1") + + @override_settings(AXES_CLIENT_IP_CALLABLE=True) + def test_get_client_ip_address_not_callable(self): + with self.assertRaises(TypeError): + get_client_ip_address(HttpRequest()) + + @override_settings(AXES_CLIENT_IP_CALLABLE=lambda: None) # pragma: no cover + def test_get_client_ip_address_invalid_callable_too_few_arguments(self): + with self.assertRaises(TypeError): + get_client_ip_address(HttpRequest()) + + @override_settings( + AXES_CLIENT_IP_CALLABLE=lambda request, extra: None + ) # pragma: no cover + def test_get_client_ip_address_invalid_callable_too_many_arguments(self): + with self.assertRaises(TypeError): + get_client_ip_address(HttpRequest()) + + def test_get_client_ip_address_with_ipware(self): + request = HttpRequest() + request.META["REMOTE_ADDR"] = "127.0.0.2" + self.assertEqual(get_client_ip_address(request, use_ipware=True), "127.0.0.2") + + def test_get_client_ip_address_without_ipware(self): + request = HttpRequest() + request.META["REMOTE_ADDR"] = "127.0.0.3" + self.assertEqual(get_client_ip_address(request, use_ipware=False), "127.0.0.3") + + class IPWhitelistTestCase(AxesTestCase): def setUp(self): self.request = HttpRequest() @@ -657,7 +947,7 @@ class LockoutResponseTestCase(AxesTestCa self.assertEqual(type(response), HttpResponse) -def mock_get_cool_off_str(): +def mock_get_cool_off_str(req): return timedelta(seconds=30) @@ -671,18 +961,18 @@ class AxesCoolOffTestCase(AxesTestCase): self.assertEqual(get_cool_off(), timedelta(hours=2)) @override_settings(AXES_COOLOFF_TIME=2.0) - def test_get_cool_off_int(self): + def test_get_cool_off_float(self): self.assertEqual(get_cool_off(), timedelta(minutes=120)) @override_settings(AXES_COOLOFF_TIME=0.25) - def test_get_cool_off_int(self): + def test_get_cool_off_float_lt_0(self): self.assertEqual(get_cool_off(), timedelta(minutes=15)) @override_settings(AXES_COOLOFF_TIME=1.7) - def test_get_cool_off_int(self): + def test_get_cool_off_float_gt_0(self): self.assertEqual(get_cool_off(), timedelta(seconds=6120)) - @override_settings(AXES_COOLOFF_TIME=lambda: timedelta(seconds=30)) + @override_settings(AXES_COOLOFF_TIME=lambda r: timedelta(seconds=30)) def test_get_cool_off_callable(self): self.assertEqual(get_cool_off(), timedelta(seconds=30)) @@ -730,12 +1020,12 @@ class AxesLockoutTestCase(AxesTestCase): def test_get_lockout_response(self): response = get_lockout_response(self.request, self.credentials) - self.assertEqual(403, response.status_code) + self.assertEqual(429, response.status_code) - @override_settings(AXES_HTTP_RESPONSE_CODE=429) + @override_settings(AXES_HTTP_RESPONSE_CODE=403) def test_get_lockout_response_with_custom_http_response_code(self): response = get_lockout_response(self.request, self.credentials) - self.assertEqual(429, response.status_code) + self.assertEqual(403, response.status_code) @override_settings(AXES_LOCKOUT_CALLABLE=mock_get_lockout_response) def test_get_lockout_response_override_callable(self): @@ -763,6 +1053,7 @@ class AxesCleanseParamsTestCase(AxesTest "other_sensitive_data": "sensitive", } + @override_settings(AXES_SENSITIVE_PARAMETERS=[]) def test_cleanse_parameters(self): cleansed = cleanse_parameters(self.parameters) self.assertEqual("test_user", cleansed["username"]) @@ -784,6 +1075,7 @@ class AxesCleanseParamsTestCase(AxesTest self.assertEqual("********************", cleansed["password"]) self.assertEqual("********************", cleansed["other_sensitive_data"]) + @override_settings(AXES_SENSITIVE_PARAMETERS=[]) @override_settings(AXES_PASSWORD_FORM_FIELD=None) def test_cleanse_parameters_override_empty(self): cleansed = cleanse_parameters(self.parameters) diff -pruN 5.39.0-6/tests/test_logging.py 7.0.1-0ubuntu1/tests/test_logging.py --- 5.39.0-6/tests/test_logging.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_logging.py 2024-12-02 16:23:57.000000000 +0000 @@ -1,15 +1,14 @@ from unittest.mock import patch from django.test import override_settings -from django.urls import reverse -from pkg_resources import get_distribution +from axes import __version__ from axes.apps import AppConfig from axes.models import AccessAttempt, AccessLog from tests.base import AxesTestCase _BEGIN = "AXES: BEGIN version %s, %s" -_VERSION = get_distribution("django-axes").version +_VERSION = __version__ @patch("axes.apps.AppConfig.initialized", False) @@ -34,48 +33,55 @@ class AppsTestCase(AxesTestCase): AppConfig.initialize() self.assertFalse(log.info.called) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_axes_config_log_user_only(self, log): AppConfig.initialize() - log.info.assert_called_with(_BEGIN, _VERSION, "blocking by username only") + log.info.assert_called_with(_BEGIN, _VERSION, "blocking by username") - @override_settings(AXES_ONLY_USER_FAILURES=False) def test_axes_config_log_ip_only(self, log): AppConfig.initialize() - log.info.assert_called_with(_BEGIN, _VERSION, "blocking by IP only") + log.info.assert_called_with(_BEGIN, _VERSION, "blocking by ip_address") - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_axes_config_log_user_ip(self, log): AppConfig.initialize() - log.info.assert_called_with(_BEGIN, _VERSION, "blocking by combination of username and IP") + log.info.assert_called_with( + _BEGIN, _VERSION, "blocking by combination of username and ip_address" + ) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_axes_config_log_user_or_ip(self, log): AppConfig.initialize() - log.info.assert_called_with(_BEGIN, _VERSION, "blocking by username or IP") + log.info.assert_called_with(_BEGIN, _VERSION, "blocking by username or ip_address") class AccessLogTestCase(AxesTestCase): def test_access_log_on_logout(self): """ - Test a valid logout and make sure the logout_time is updated. + Test a valid logout and make sure the logout_time is updated only for that. """ self.login(is_valid_username=True, is_valid_password=True) - self.assertIsNone(AccessLog.objects.latest("id").logout_time) + latest_log = AccessLog.objects.latest("id") + self.assertIsNone(latest_log.logout_time) + other_log = self.create_log(session_hash='not-the-session') + self.assertIsNone(other_log.logout_time) - response = self.client.get(reverse("admin:logout")) + response = self.logout() self.assertContains(response, "Logged out") + other_log.refresh_from_db() + self.assertIsNone(other_log.logout_time) + latest_log.refresh_from_db() + self.assertIsNotNone(latest_log.logout_time) - self.assertIsNotNone(AccessLog.objects.latest("id").logout_time) - + @override_settings(DATA_UPLOAD_MAX_NUMBER_FIELDS=1500) def test_log_data_truncated(self): """ Test that get_query_str properly truncates data to the max_length (default 1024). """ # An impossibly large post dict - extra_data = {"a" * x: x for x in range(1024)} + extra_data = {"too-large-field": "x" * 2 ** 16} self.login(**extra_data) self.assertEqual(len(AccessAttempt.objects.latest("id").post_data), 1024) @@ -84,7 +90,7 @@ class AccessLogTestCase(AxesTestCase): AccessLog.objects.all().delete() response = self.login(is_valid_username=True, is_valid_password=True) - response = self.client.get(reverse("admin:logout")) + response = self.logout() self.assertEqual(AccessLog.objects.all().count(), 0) self.assertContains(response, "Logged out", html=True) @@ -107,7 +113,7 @@ class AccessLogTestCase(AxesTestCase): AccessLog.objects.all().delete() response = self.login(is_valid_username=True, is_valid_password=True) - response = self.client.get(reverse("admin:logout")) + response = self.logout() self.assertEqual(AccessLog.objects.count(), 0) self.assertContains(response, "Logged out", html=True) diff -pruN 5.39.0-6/tests/test_login.py 7.0.1-0ubuntu1/tests/test_login.py --- 5.39.0-6/tests/test_login.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_login.py 2024-12-02 16:23:57.000000000 +0000 @@ -28,7 +28,7 @@ class DjangoLoginTestCase(TestCase): self.username = "john.doe" self.password = "hunter2" - self.user = get_user_model().objects.create(username=self.username) + self.user = get_user_model().objects.create(username=self.username, is_staff=True) self.user.set_password(self.password) self.user.save() self.user.backend = "django.contrib.auth.backends.ModelBackend" @@ -47,13 +47,19 @@ class DjangoContribAuthLoginTestCase(Dja class DjangoTestClientLoginTestCase(DjangoLoginTestCase): def test_client_login(self): self.client.login(username=self.username, password=self.password) + response = self.client.get(reverse("admin:index")) + self.assertEqual(response.status_code, 200) def test_client_logout(self): self.client.login(username=self.username, password=self.password) self.client.logout() + response = self.client.get(reverse("admin:index")) + self.assertEqual(response.status_code, 302) def test_client_force_login(self): self.client.force_login(self.user) + response = self.client.get(reverse("admin:index")) + self.assertEqual(response.status_code, 200) class DatabaseLoginTestCase(AxesTestCase): @@ -84,9 +90,9 @@ class DatabaseLoginTestCase(AxesTestCase LOGIN_FORM_KEY = '' ATTEMPT_NOT_BLOCKED = 200 ALLOWED = 302 - BLOCKED = 403 + BLOCKED = 429 - def _login(self, username, password, ip_addr="127.0.0.1", **kwargs): + def _login(self, username, password, ip_addr="127.0.0.1", user_agent="test-browser", **kwargs): """ Login a user and get the response. @@ -101,13 +107,13 @@ class DatabaseLoginTestCase(AxesTestCase reverse("admin:login"), post_data, REMOTE_ADDR=ip_addr, - HTTP_USER_AGENT="test-browser", + HTTP_USER_AGENT=user_agent, ) - def _lockout_user_from_ip(self, username, ip_addr): + def _lockout_user_from_ip(self, username, ip_addr, user_agent="test-browser"): for _ in range(settings.AXES_FAILURE_LIMIT): response = self._login( - username=username, password=self.WRONG_PASSWORD, ip_addr=ip_addr + username=username, password=self.WRONG_PASSWORD, ip_addr=ip_addr, user_agent=user_agent, ) return response @@ -182,10 +188,11 @@ class DatabaseLoginTestCase(AxesTestCase self.assertContains(response, self.LOCKED_MESSAGE, status_code=self.BLOCKED) self.assertTrue(self.attempt_count()) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_combination_user_and_ip(self): """ - Test login failure when AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP is True. + Test login failure when lockout parameters is combination + of username and ip_address. """ # test until one try before the limit @@ -197,12 +204,12 @@ class DatabaseLoginTestCase(AxesTestCase # So, we shouldn't have gotten a lock-out yet. # But we should get one now response = self.login(is_valid_username=True, is_valid_password=False) - self.assertContains(response, self.LOCKED_MESSAGE, status_code=403) + self.assertContains(response, self.LOCKED_MESSAGE, status_code=429) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_only_user_failures(self): """ - Test login failure when AXES_ONLY_USER_FAILURES is True. + Test login failure when lockout parameter is username. """ # test until one try before the limit @@ -238,6 +245,139 @@ class DatabaseLoginTestCase(AxesTestCase response, self.LOGIN_FORM_KEY, status_code=self.ALLOWED, html=True ) + @override_settings(AXES_LOCKOUT_PARAMETERS=["user_agent"]) + def test_lockout_by_user_agent_only(self): + """ + Test login failure when lockout parameter is only user_agent + """ + # User is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked with another username: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked with another ip: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test with another user agent: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser-2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + @override_settings(AXES_LOCKOUT_PARAMETERS=["ip_address", "username", "user_agent"]) + def test_lockout_by_all_parameters(self): + # User is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by username: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by ip: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser2") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by user_agent: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is allowed to login with different username, ip and user_agent + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "username", "user_agent"]]) + def test_lockout_by_combination_of_all_parameters(self): + # User is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is allowed to login with different username: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different IP: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different user_agent: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different username, ip and user_agent + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + @override_settings(AXES_LOCKOUT_PARAMETERS=["ip_address", ["username", "user_agent"]]) + def test_lockout_by_ip_or_username_and_user_agent(self): + # User is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by ip: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser2") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by username and user_agent: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is allowed to login with different username and ip + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different user_agent and ip + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different username, ip and user_agent + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"], ["username", "user_agent"]]) + def test_lockout_by_ip_and_user_agent_or_username_and_user_agent(self): + # User is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by ip and user_agent: + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is locked by username and user_agent: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test he is allowed to login with different username and ip + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different user_agent + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test he is allowed to login with different username, ip and user_agent + response = self._login("username2", self.VALID_PASSWORD, ip_addr=self.IP_2, user_agent="test-browser2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + + # Test for true and false positives when blocking by IP *OR* user (default) # Cache disabled. Default settings. def test_lockout_by_ip_blocks_when_same_user_same_ip_without_cache(self): @@ -274,7 +414,7 @@ class DatabaseLoginTestCase(AxesTestCase # Test for true and false positives when blocking by user only. # Cache disabled. When AXES_ONLY_USER_FAILURES = True - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_blocks_when_same_user_same_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -283,7 +423,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_blocks_when_same_user_diff_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -292,7 +432,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_allows_when_diff_user_same_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -301,7 +441,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_allows_when_diff_user_diff_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -310,7 +450,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_with_empty_username_allows_other_users_without_cache(self): # User with empty username is locked out from IP 1. self._lockout_user_from_ip(username="", ip_addr=self.IP_1) @@ -321,7 +461,7 @@ class DatabaseLoginTestCase(AxesTestCase # Test for true and false positives when blocking by user and IP together. # Cache disabled. When LOCK_OUT_BY_COMBINATION_USER_AND_IP = True - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_blocks_when_same_user_same_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -330,7 +470,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_same_user_diff_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -339,7 +479,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_diff_user_same_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -348,7 +488,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_diff_user_diff_ip_without_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -357,7 +497,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_with_empty_username_allows_other_users_without_cache( self, ): @@ -368,6 +508,19 @@ class DatabaseLoginTestCase(AxesTestCase response = self.client.get(reverse("admin:login"), REMOTE_ADDR=self.IP_1) self.assertContains(response, self.LOGIN_FORM_KEY, status_code=200, html=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["ip_address", "user_agent"]]) + def test_lockout_by_user_still_allows_login_with_differnet_user_agent(self): + # User with empty username is locked out with "test-browser" user agent. + self._lockout_user_from_ip(username="username", ip_addr=self.IP_1, user_agent="test-browser") + + # Test he is locked: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser") + self.assertEqual(response.status_code, self.BLOCKED) + + # Test with another user agent: + response = self._login("username", self.VALID_PASSWORD, ip_addr=self.IP_1, user_agent="test-browser-2") + self.assertEqual(response.status_code, self.ATTEMPT_NOT_BLOCKED) + # Test for true and false positives when blocking by IP *OR* user (default) # With cache enabled. Default criteria. def test_lockout_by_ip_blocks_when_same_user_same_ip_using_cache(self): @@ -402,7 +555,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_with_empty_username_allows_other_users_using_cache(self): # User with empty username is locked out from IP 1. self._lockout_user_from_ip(username="", ip_addr=self.IP_1) @@ -413,7 +566,7 @@ class DatabaseLoginTestCase(AxesTestCase # Test for true and false positives when blocking by user only. # With cache enabled. When AXES_ONLY_USER_FAILURES = True - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_blocks_when_same_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -422,7 +575,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_blocks_when_same_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -431,7 +584,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_allows_when_diff_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -440,7 +593,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_ONLY_USER_FAILURES=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username"]) def test_lockout_by_user_allows_when_diff_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -451,7 +604,7 @@ class DatabaseLoginTestCase(AxesTestCase # Test for true and false positives when blocking by user and IP together. # With cache enabled. When LOCK_OUT_BY_COMBINATION_USER_AND_IP = True - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_blocks_when_same_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -460,7 +613,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_same_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -469,7 +622,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_diff_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -478,7 +631,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_allows_when_diff_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -488,7 +641,7 @@ class DatabaseLoginTestCase(AxesTestCase self.assertEqual(response.status_code, self.ALLOWED) @override_settings( - AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True, AXES_FAILURE_LIMIT=2 + AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]], AXES_FAILURE_LIMIT=2 ) def test_lockout_by_user_and_ip_allows_when_diff_user_same_ip_using_cache_multiple_attempts( self, @@ -517,7 +670,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=[["username", "ip_address"]]) def test_lockout_by_user_and_ip_with_empty_username_allows_other_users_using_cache( self, ): @@ -530,7 +683,7 @@ class DatabaseLoginTestCase(AxesTestCase # Test for true and false positives when blocking by user or IP together. # With cache enabled. When AXES_LOCK_OUT_BY_USER_OR_IP = True - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_lockout_by_user_or_ip_blocks_when_same_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -539,7 +692,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_lockout_by_user_or_ip_allows_when_same_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -548,7 +701,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_1, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_lockout_by_user_or_ip_allows_when_diff_user_same_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -557,7 +710,9 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_1) self.assertEqual(response.status_code, self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True, AXES_FAILURE_LIMIT=3) + @override_settings( + AXES_LOCKOUT_PARAMETERS=["username", "ip_address"], AXES_FAILURE_LIMIT=3 + ) def test_lockout_by_user_or_ip_allows_when_diff_user_same_ip_using_cache_multiple_attempts( self, ): @@ -587,7 +742,9 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_3, self.WRONG_PASSWORD, ip_addr=self.IP_1) self.assertContains(response, self.LOCKED_MESSAGE, status_code=self.BLOCKED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True, AXES_FAILURE_LIMIT=3) + @override_settings( + AXES_LOCKOUT_PARAMETERS=["username", "ip_address"], AXES_FAILURE_LIMIT=3 + ) def test_lockout_by_user_or_ip_allows_when_diff_user_same_ip_using_cache_multiple_failed_attempts( self, ): @@ -612,7 +769,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_lockout_by_user_or_ip_allows_when_diff_user_diff_ip_using_cache(self): # User 1 is locked out from IP 1. self._lockout_user1_from_ip1() @@ -621,7 +778,7 @@ class DatabaseLoginTestCase(AxesTestCase response = self._login(self.USER_2, self.VALID_PASSWORD, ip_addr=self.IP_2) self.assertEqual(response.status_code, self.ALLOWED) - @override_settings(AXES_LOCK_OUT_BY_USER_OR_IP=True) + @override_settings(AXES_LOCKOUT_PARAMETERS=["username", "ip_address"]) def test_lockout_by_user_or_ip_with_empty_username_allows_other_users_using_cache( self, ): diff -pruN 5.39.0-6/tests/test_management.py 7.0.1-0ubuntu1/tests/test_management.py --- 5.39.0-6/tests/test_management.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_management.py 2024-12-02 16:23:57.000000000 +0000 @@ -56,18 +56,22 @@ class ManagementCommandTestCase(AxesTest username="john.doe", ip_address="10.0.0.2", failures_since_start="15" ) + AccessAttempt.objects.create( + username="richard.doe", ip_address="10.0.0.4", failures_since_start="12" + ) + def test_axes_list_attempts(self): out = StringIO() call_command("axes_list_attempts", stdout=out) - expected = "10.0.0.1\tjane.doe\t4\n10.0.0.2\tjohn.doe\t15\n" + expected = "10.0.0.1\tjane.doe\t4\n10.0.0.2\tjohn.doe\t15\n10.0.0.4\trichard.doe\t12\n" self.assertEqual(expected, out.getvalue()) def test_axes_reset(self): out = StringIO() call_command("axes_reset", stdout=out) - expected = "2 attempts removed.\n" + expected = "3 attempts removed.\n" self.assertEqual(expected, out.getvalue()) def test_axes_reset_not_found(self): @@ -86,6 +90,13 @@ class ManagementCommandTestCase(AxesTest expected = "1 attempts removed.\n" self.assertEqual(expected, out.getvalue()) + + def test_axes_reset_ip_username(self): + out = StringIO() + call_command("axes_reset_ip_username", "10.0.0.4", "richard.doe", stdout=out) + + expected = "1 attempts removed.\n" + self.assertEqual(expected, out.getvalue()) def test_axes_reset_ip_not_found(self): out = StringIO() diff -pruN 5.39.0-6/tests/test_middleware.py 7.0.1-0ubuntu1/tests/test_middleware.py --- 5.39.0-6/tests/test_middleware.py 2022-08-18 13:33:17.000000000 +0000 +++ 7.0.1-0ubuntu1/tests/test_middleware.py 2024-12-02 16:23:57.000000000 +0000 @@ -12,7 +12,7 @@ def get_username(request, credentials: d class MiddlewareTestCase(AxesTestCase): STATUS_SUCCESS = 200 - STATUS_LOCKOUT = 403 + STATUS_LOCKOUT = 429 def setUp(self): self.request = HttpRequest()