mirror of
https://github.com/jazzband/django-axes.git
synced 2026-03-16 22:30:23 +00:00
Improve documentation:
+ Move chapters to a separate file. + Add readthedocs theme. + Remove doc from README.rst
This commit is contained in:
Jorge Galvis
parent
6dd80a6d89
commit
025325adb7
11 changed files with 221 additions and 202 deletions
101
README.rst
101
README.rst
|
|
@ -33,104 +33,3 @@ If you have questions or have trouble using the app please file a bug report
|
|||
at:
|
||||
|
||||
https://github.com/jazzband/django-axes/issues
|
||||
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
``django-axes`` requires a supported Django version. The application is
|
||||
intended to work around the Django admin and the regular
|
||||
``django.contrib.auth`` login-powered pages.
|
||||
Look at https://www.djangoproject.com/download/ to check if your version
|
||||
is supported.
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
You can contribute to this project forking it from github and sending pull requests.
|
||||
|
||||
Running tests
|
||||
-------------
|
||||
|
||||
Clone the repository and install the django version you want. Then run::
|
||||
|
||||
$ ./runtests.py
|
||||
|
||||
Issues
|
||||
======
|
||||
|
||||
Not being locked out after failed attempts
|
||||
------------------------------------------
|
||||
|
||||
You may find that Axes is not capturing your failed login attempts. It may
|
||||
be that you need to manually add watch_login to your login url.
|
||||
|
||||
For example, in your urls.py::
|
||||
|
||||
...
|
||||
from my.custom.app import login
|
||||
from axes.decorators import watch_login
|
||||
...
|
||||
urlpatterns = patterns('',
|
||||
(r'^login/$', watch_login(login)),
|
||||
...
|
||||
|
||||
|
||||
Locked out without reason
|
||||
-------------------------
|
||||
|
||||
It may happen that you have suddenly become locked out without a single failed
|
||||
attempt. One possible reason is that you are using some custom login form and the
|
||||
username field is named something different than "username", e.g. "email". This
|
||||
leads to all users attempts being lumped together. To fix this add the following
|
||||
to your settings:
|
||||
|
||||
AXES_USERNAME_FORM_FIELD = "email"
|
||||
|
||||
|
||||
Using a captcha
|
||||
===============
|
||||
|
||||
Using https://github.com/mbi/django-simple-captcha you do the following:
|
||||
|
||||
1. Change axes lockout url in ``settings.py``::
|
||||
|
||||
AXES_LOCKOUT_URL = '/locked'
|
||||
|
||||
2. Add the url in ``urls.py``::
|
||||
|
||||
url(r'^locked/$', locked_out, name='locked_out'),
|
||||
|
||||
3. Create a captcha form::
|
||||
|
||||
class AxesCaptchaForm(forms.Form):
|
||||
captcha = CaptchaField()
|
||||
|
||||
4. Create a captcha view for the above url that resets on captcha success and redirects::
|
||||
|
||||
def locked_out(request):
|
||||
if request.POST:
|
||||
form = AxesCaptchaForm(request.POST)
|
||||
if form.is_valid():
|
||||
ip = get_ip_address_from_request(request)
|
||||
reset(ip=ip)
|
||||
return HttpResponseRedirect(reverse_lazy('signin'))
|
||||
else:
|
||||
form = AxesCaptchaForm()
|
||||
|
||||
return render_to_response('locked_out.html', dict(form=form), context_instance=RequestContext(request))
|
||||
|
||||
5. Add a captcha template::
|
||||
|
||||
<form action="" method="post">
|
||||
{% csrf_token %}
|
||||
|
||||
{{ form.captcha.errors }}
|
||||
{{ form.captcha }}
|
||||
|
||||
<div class="form-actions">
|
||||
<input type="submit" value="Submit" />
|
||||
</div>
|
||||
</form>
|
||||
|
||||
Done.
|
||||
|
|
|
|||
47
docs/captcha.rst
Normal file
47
docs/captcha.rst
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
.. _captcha:
|
||||
|
||||
Using a captcha
|
||||
===============
|
||||
|
||||
Using https://github.com/mbi/django-simple-captcha you do the following:
|
||||
|
||||
1. Change axes lockout url in ``settings.py``::
|
||||
|
||||
AXES_LOCKOUT_URL = '/locked'
|
||||
|
||||
2. Add the url in ``urls.py``::
|
||||
|
||||
url(r'^locked/$', locked_out, name='locked_out'),
|
||||
|
||||
3. Create a captcha form::
|
||||
|
||||
class AxesCaptchaForm(forms.Form):
|
||||
captcha = CaptchaField()
|
||||
|
||||
4. Create a captcha view for the above url that resets on captcha success and redirects::
|
||||
|
||||
def locked_out(request):
|
||||
if request.POST:
|
||||
form = AxesCaptchaForm(request.POST)
|
||||
if form.is_valid():
|
||||
ip = get_ip_address_from_request(request)
|
||||
reset(ip=ip)
|
||||
return HttpResponseRedirect(reverse_lazy('signin'))
|
||||
else:
|
||||
form = AxesCaptchaForm()
|
||||
|
||||
return render_to_response('locked_out.html', dict(form=form), context_instance=RequestContext(request))
|
||||
|
||||
5. Add a captcha template::
|
||||
|
||||
<form action="" method="post">
|
||||
{% csrf_token %}
|
||||
|
||||
{{ form.captcha.errors }}
|
||||
{{ form.captcha }}
|
||||
|
||||
<div class="form-actions">
|
||||
<input type="submit" value="Submit" />
|
||||
</div>
|
||||
</form>
|
||||
|
||||
|
|
@ -15,6 +15,7 @@
|
|||
import sys
|
||||
import os
|
||||
import shlex
|
||||
import sphinx_rtd_theme
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
|
|
@ -108,7 +109,8 @@ todo_include_todos = False
|
|||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'alabaster'
|
||||
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
|
|
@ -118,6 +120,8 @@ html_theme = 'alabaster'
|
|||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
|
@ -155,6 +159,8 @@ html_static_path = ['_static']
|
|||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], }
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
|
|
|||
63
docs/configuration.rst
Normal file
63
docs/configuration.rst
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
.. _configuration:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Just add `axes` to your ``INSTALLED_APPS``::
|
||||
|
||||
INSTALLED_APPS = (
|
||||
'django.contrib.admin',
|
||||
'django.contrib.auth',
|
||||
'django.contrib.contenttypes',
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.sites',
|
||||
...
|
||||
'axes',
|
||||
...
|
||||
)
|
||||
|
||||
Remember to run ``python manage.py migrate`` to sync the database.
|
||||
|
||||
|
||||
Customizing Axes
|
||||
----------------
|
||||
|
||||
You have a couple options available to you to customize ``django-axes`` a bit.
|
||||
These should be defined in your ``settings.py`` file.
|
||||
|
||||
* ``AXES_LOGIN_FAILURE_LIMIT``: The number of login attempts allowed before a
|
||||
record is created for the failed logins. Default: ``3``
|
||||
* ``AXES_LOCK_OUT_AT_FAILURE``: After the number of allowed login attempts
|
||||
are exceeded, should we lock out this IP (and optional user agent)?
|
||||
Default: ``True``
|
||||
* ``AXES_USE_USER_AGENT``: If ``True``, lock out / log based on an IP address
|
||||
AND a user agent. This means requests from different user agents but from
|
||||
the same IP are treated differently. Default: ``False``
|
||||
* ``AXES_COOLOFF_TIME``: If set, defines a period of inactivity after which
|
||||
old failed login attempts will be forgotten. Can be set to a python
|
||||
timedelta object or an integer. If an integer, will be interpreted as a
|
||||
number of hours. Default: ``None``
|
||||
* ``AXES_LOGGER``: If set, specifies a logging mechanism for axes to use.
|
||||
Default: ``'axes.watch_login'``
|
||||
* ``AXES_LOCKOUT_TEMPLATE``: If set, specifies a template to render when a
|
||||
user is locked out. Template receives cooloff_time and failure_limit as
|
||||
context variables. Default: ``None``
|
||||
* ``AXES_LOCKOUT_URL``: If set, specifies a URL to redirect to on lockout. If
|
||||
both AXES_LOCKOUT_TEMPLATE and AXES_LOCKOUT_URL are set, the template will
|
||||
be used. Default: ``None``
|
||||
* ``AXES_VERBOSE``: If ``True``, you'll see slightly more logging for Axes.
|
||||
Default: ``True``
|
||||
* ``AXES_USERNAME_FORM_FIELD``: the name of the form field that contains your
|
||||
users usernames. Default: ``username``
|
||||
* ``AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``: If ``True`` prevents to login
|
||||
from IP under particular user if attempts limit exceed, otherwise lock out
|
||||
based on IP.
|
||||
Default: ``False``
|
||||
* ``AXES_NEVER_LOCKOUT_WHITELIST``: If ``True``, users can always login from
|
||||
whitelisted IP addresses.
|
||||
Default: ``False``
|
||||
* ``AXES_BEHIND_REVERSE_PROXY``: If ``True``, it will look for the IP address from the header defined at ``AXES_REVERSE_PROXY_HEADER``. Please make sure if you enable this setting to configure your proxy to set the correct value for the header, otherwise you could be attacked by setting this header directly in every request.
|
||||
Default: ``False``
|
||||
* ``AXES_REVERSE_PROXY_HEADER``: If ``AXES_BEHIND_REVERSE_PROXY`` is ``True``, it will look for the IP address from this header.
|
||||
Default: ``HTTP_X_FORWARDED_FOR``
|
||||
|
||||
13
docs/development.rst
Normal file
13
docs/development.rst
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
.. _development:
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
You can contribute to this project forking it from github and sending pull requests.
|
||||
|
||||
Running tests
|
||||
-------------
|
||||
|
||||
Clone the repository and install the django version you want. Then run::
|
||||
|
||||
$ ./runtests.py
|
||||
113
docs/index.rst
113
docs/index.rst
|
|
@ -1,3 +1,5 @@
|
|||
.. _index:
|
||||
|
||||
.. Django Axes documentation master file, created by
|
||||
sphinx-quickstart on Sat Jul 30 16:37:41 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
|
|
@ -6,110 +8,21 @@
|
|||
Welcome to Django Axes's documentation!
|
||||
=======================================
|
||||
|
||||
Contents:
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install the latest stable package running this command::
|
||||
|
||||
$ pip install django-axes
|
||||
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Just add `axes` to your ``INSTALLED_APPS``::
|
||||
|
||||
INSTALLED_APPS = (
|
||||
'django.contrib.admin',
|
||||
'django.contrib.auth',
|
||||
'django.contrib.contenttypes',
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.sites',
|
||||
...
|
||||
'axes',
|
||||
...
|
||||
)
|
||||
|
||||
Remember to run ``python manage.py migrate`` to sync the database.
|
||||
|
||||
|
||||
Customizing Axes
|
||||
----------------
|
||||
|
||||
You have a couple options available to you to customize ``django-axes`` a bit.
|
||||
These should be defined in your ``settings.py`` file.
|
||||
|
||||
* ``AXES_LOGIN_FAILURE_LIMIT``: The number of login attempts allowed before a
|
||||
record is created for the failed logins. Default: ``3``
|
||||
* ``AXES_LOCK_OUT_AT_FAILURE``: After the number of allowed login attempts
|
||||
are exceeded, should we lock out this IP (and optional user agent)?
|
||||
Default: ``True``
|
||||
* ``AXES_USE_USER_AGENT``: If ``True``, lock out / log based on an IP address
|
||||
AND a user agent. This means requests from different user agents but from
|
||||
the same IP are treated differently. Default: ``False``
|
||||
* ``AXES_COOLOFF_TIME``: If set, defines a period of inactivity after which
|
||||
old failed login attempts will be forgotten. Can be set to a python
|
||||
timedelta object or an integer. If an integer, will be interpreted as a
|
||||
number of hours. Default: ``None``
|
||||
* ``AXES_LOGGER``: If set, specifies a logging mechanism for axes to use.
|
||||
Default: ``'axes.watch_login'``
|
||||
* ``AXES_LOCKOUT_TEMPLATE``: If set, specifies a template to render when a
|
||||
user is locked out. Template receives cooloff_time and failure_limit as
|
||||
context variables. Default: ``None``
|
||||
* ``AXES_LOCKOUT_URL``: If set, specifies a URL to redirect to on lockout. If
|
||||
both AXES_LOCKOUT_TEMPLATE and AXES_LOCKOUT_URL are set, the template will
|
||||
be used. Default: ``None``
|
||||
* ``AXES_VERBOSE``: If ``True``, you'll see slightly more logging for Axes.
|
||||
Default: ``True``
|
||||
* ``AXES_USERNAME_FORM_FIELD``: the name of the form field that contains your
|
||||
users usernames. Default: ``username``
|
||||
* ``AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``: If ``True`` prevents to login
|
||||
from IP under particular user if attempts limit exceed, otherwise lock out
|
||||
based on IP.
|
||||
Default: ``False``
|
||||
* ``AXES_NEVER_LOCKOUT_WHITELIST``: If ``True``, users can always login from
|
||||
whitelisted IP addresses.
|
||||
Default: ``False``
|
||||
* ``AXES_BEHIND_REVERSE_PROXY``: If ``True``, it will look for the IP address from the header defined at ``AXES_REVERSE_PROXY_HEADER``. Please make sure if you enable this setting to configure your proxy to set the correct value for the header, otherwise you could be attacked by setting this header directly in every request.
|
||||
Default: ``False``
|
||||
* ``AXES_REVERSE_PROXY_HEADER``: If ``AXES_BEHIND_REVERSE_PROXY`` is ``True``, it will look for the IP address from this header.
|
||||
Default: ``HTTP_X_FORWARDED_FOR``
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Using ``django-axes`` is extremely simple. All you need to do is periodically
|
||||
check the Access Attempts section of the admin.
|
||||
|
||||
By default, django-axes will lock out repeated attempts from the same IP
|
||||
address. You can allow this IP to attempt again by deleting the relevant
|
||||
``AccessAttempt`` records in the admin.
|
||||
|
||||
You can also use the ``axes_reset`` management command using Django's
|
||||
``manage.py``.
|
||||
|
||||
* ``manage.py axes_reset`` will reset all lockouts and access records.
|
||||
* ``manage.py axes_reset ip`` will clear lockout/records for ip
|
||||
|
||||
In your code, you can use ``from axes.utils import reset``.
|
||||
|
||||
* ``reset()`` will reset all lockouts and access records.
|
||||
* ``reset(ip=ip)`` will clear lockout/records for ip
|
||||
* ``reset(username=username)`` will clear lockout/records for a username
|
||||
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
configuration
|
||||
usage
|
||||
requirements
|
||||
development
|
||||
issues
|
||||
captcha
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
|
|||
9
docs/installation.rst
Normal file
9
docs/installation.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install the latest stable package running this command::
|
||||
|
||||
$ pip install django-axes
|
||||
|
||||
33
docs/issues.rst
Normal file
33
docs/issues.rst
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
.. _issues:
|
||||
|
||||
Issues
|
||||
======
|
||||
|
||||
Not being locked out after failed attempts
|
||||
------------------------------------------
|
||||
|
||||
You may find that Axes is not capturing your failed login attempts. It may
|
||||
be that you need to manually add watch_login to your login url.
|
||||
|
||||
For example, in your urls.py::
|
||||
|
||||
...
|
||||
from my.custom.app import login
|
||||
from axes.decorators import watch_login
|
||||
...
|
||||
urlpatterns = patterns('',
|
||||
(r'^login/$', watch_login(login)),
|
||||
...
|
||||
|
||||
|
||||
Locked out without reason
|
||||
-------------------------
|
||||
|
||||
It may happen that you have suddenly become locked out without a single failed
|
||||
attempt. One possible reason is that you are using some custom login form and the
|
||||
username field is named something different than "username", e.g. "email". This
|
||||
leads to all users attempts being lumped together. To fix this add the following
|
||||
to your settings:
|
||||
|
||||
AXES_USERNAME_FORM_FIELD = "email"
|
||||
|
||||
11
docs/requirements.rst
Normal file
11
docs/requirements.rst
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
.. _requirements:
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
``django-axes`` requires a supported Django version. The application is
|
||||
intended to work around the Django admin and the regular
|
||||
``django.contrib.auth`` login-powered pages.
|
||||
Look at https://www.djangoproject.com/download/ to check if your version
|
||||
is supported.
|
||||
|
||||
24
docs/usage.rst
Normal file
24
docs/usage.rst
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
.. _usage:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Using ``django-axes`` is extremely simple. All you need to do is periodically
|
||||
check the Access Attempts section of the admin.
|
||||
|
||||
By default, django-axes will lock out repeated attempts from the same IP
|
||||
address. You can allow this IP to attempt again by deleting the relevant
|
||||
``AccessAttempt`` records in the admin.
|
||||
|
||||
You can also use the ``axes_reset`` management command using Django's
|
||||
``manage.py``.
|
||||
|
||||
* ``manage.py axes_reset`` will reset all lockouts and access records.
|
||||
* ``manage.py axes_reset ip`` will clear lockout/records for ip
|
||||
|
||||
In your code, you can use ``from axes.utils import reset``.
|
||||
|
||||
* ``reset()`` will reset all lockouts and access records.
|
||||
* ``reset(ip=ip)`` will clear lockout/records for ip
|
||||
* ``reset(username=username)`` will clear lockout/records for a username
|
||||
|
||||
|
|
@ -1,2 +1,3 @@
|
|||
Django
|
||||
sphinx-rtd-theme
|
||||
-e .
|
||||
|
|
|
|||
Loading…
Reference in a new issue