Coder Social home page Coder Social logo

django-forwarded's Introduction

Django-Forwarded

PyPi

Support HTTP "Forwarded" header in your Django applications.

This middleware for Django adds support for the Forwarded header which is standardized by Internet Engineering Task Force (IETF) in RFC 7239 and summarized in Mozilla Developer Network (MDN) article of the same name. This header is used by many reverse HTTP proxies to pass client identification details (such as IPv4 or IPv6) to the backend application.

Installation

Install the middleware with your favorite Python package manager

Pip:

$ pip install django-forwarded

Pipenv:

$ pipenv install django-forwarded

Usage

Activate

Add the middleware to Django's MIDDLEWARE setting.

MIDDLEWARE = (
    ... # some middlewares
    "django_forwarded.Forwarded",
    ... # more middlewares
)

Configure

You can configure Django-Forwarded by adding appropriate variable to your Django application configuration file.

With TRUSTED_PROXY_LIST

Just specify a list of trusted proxies with the TRUSTED_PROXY_LIST variable in the file. This is the recommended way to specify the proxies.

TRUSTED_PROXY_LIST = [
    '2001:db8::10',
    '10.2.3.100',
]

With TRUSTED_PROXY_DEPTH

Just specify the number of trusted proxies with the TRUSTED_PROXY_DEPTH variable. This is useful when you have no control over them and their IP(s) might change frequently over the lifetime of your application.

TRUSTED_PROXY_DEPTH = 2  # trusts maximum of 2 proxies

Note: It is not as secure as specifying a list.

Access client IP

The middleware identifies the correct client IP from the user supplied configuration and the header received from the proxies. This information is then placed in the request.META['REMOTE_ADDR'] field.

def some_function(request):
    print(request.META['REMOTE_ADDR'])

Testing

To execute the included test suit, run the following commands in a terminal:

$ cd <path to the django-forwarded>
$ pip install -r requirements.txt
$ DJANGO_SETTINGS_MODULE=tests.settings python3 -m unittest  # run the tests

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.