django-sslify-admin
Force SSL on your Django admin site
Install
To install django-sslify-admin
, simply run
pip install django-sslify-admin
and you'll get the latest version
installed automatically.
Usage
Modify your Django settings.py
file, and prepend
sslifyadmin.middleware.SSLifyAdminMiddleware
to your
MIDDLEWARE_CLASSES
setting:
.. code:: python
MIDDLEWARE_CLASSES = (
'sslifyadmin.middleware.SSLifyAdminMiddleware',
# ...
)
NOTE: Make sure sslify.middleware.SSLifyMiddleware
is the first
middleware class listed, as this will ensure that if a user makes an
unsecure request (over HTTP), they will be redirected to HTTPs before
any actual processing happens. If you plan to use
i18n_patterns`` <https://docs.djangoproject.com/en/dev/topics/i18n/translation/#django.conf.urls.i18n.i18n_patterns>`__ on admin urls, this middleware needs to be appended AFTER
django.middleware.locale.LocaleMiddleware`` https://docs.djangoproject.com/en/dev/ref/middleware/#django.middleware.locale.LocaleMiddleware`__!
Custom admin url?
If you are using a custom admin url, you have to set
``SSLIFY_ADMIN_NAMESPACE`` in your ``settings.py``:
.. code:: python
# SSLIFY_ADMIN_NAMESPACE = "admin" # default
SSLIFY_ADMIN_NAMESPACE = "myadminurl" # custom
Enabling/Disabling
By default, the admin is sslfying if settings.DEBUG is False, but for
some reason (ie. local, test suite) you may want remove debugging and not trigger the sslify.
You have to set SSLIFY_ADMIN_DISABLE
in your settings.py
:
.. code:: python
SSLIFY_ADMIN_DISABLE = True
Behind a Proxy? (Heroku)
If your Django app is behind a proxy (like Heroku), though, the proxy
may be “swallowing” the fact that a request is HTTPS, using a non-HTTPS
connection between the proxy and Django.
In this situation, you’ll want to configure the proxy (Heroku already
does that for you) to set a custom HTTP header that tells Django whether
the request came in via HTTPS, and you’ll want to set
``SECURE_PROXY_SSL_HEADER`` so that Django knows what header to look
for, like this:
.. code:: python
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
Notes
-----
This code was taken and modified from `this StackOverflow
thread <http://stackoverflow.com/questions/8436666/how-to-make-python-on-heroku-https-only>`__.
This Project is also influenced by Randall Degges
`django-sslify <https://github.com/rdegges/django-sslify>`__, use this,
if you want to secure your whole site, and not only the admin interface
of Django.
If you like this project please consider giving me a
`gittip <https://www.gittip.com/return1_at/>`__, thanks! :)
Tests
-----
|Build Status|
.. code:: bash
$ git clone https://github.com/return1/django-sslify-admin.git
$ cd django-sslify-admin
$ python setup.py develop
...
$ python setup.py test
Creating test database for alias 'default'...
..
----------------------------------------------------------------------
Ran 2 tests in 0.003s
OK
Destroying test database for alias 'default'...
License
=======
http://return1.mit-license.org/
.. |Build Status| image:: https://api.travis-ci.org/return1/django-sslify-admin.png?branch=master
:target: http://travis-ci.org/return1/django-sslify-admin