This is a django application to use django as a proxy server between a frontend device/server and a backend server inside a DMZ
Project description
django_proxy_server
===================
This is a django application to use django as a proxy server between a frontend device/server and a backend server inside a DMZ. Services are exposed using Django REST Framework. To identify itself, django-proxy-server uses the SECRET_KEY variable defined in settings as its API KEY.
Quick start
-----------
Install using pip or easy_install
$ pip install django-proxy-server
$ easy_install django-proxy-server
Add "proxy_server" to your INSTALLED_APPS setting like this:
INSTALLED_APPS = (
...
'proxy_server',
)
Add the following options to the settings.py file to configure:
PROXY_API_KEYS = [
# Add the API KEYS you wish to allow consuming services
# API KEYS are required. Services cannot be consumed without an API KEY
]
# Write the route to the service you wish to use as token validation.
# If you don't wish to have a token validation, skip this setting
PROXY_TOKEN_VALIDATION_SERVICE = 'project.services.token_service'
# The IP or domain address of the backend services to be consumed
BACKEND_HOST = '127.0.0.1'
# The port through which the backend services will be consumed
BACKEND_PORT = '8000'
Usage
-----------
To expose a service using Django, simply decorate a view with
# The option methods is a list of HTTP methods that can be exposed.
# For example: GET, POST, PUT, DELETE
# The option public indicates that the service will be exposed as public,
# thus it doesn't require for the header to include a USER_TOKEN value
@expose_service([ methods ], public=True)
There are two ways of invoking backend services, from a traditional Django view or from an external device that uses Django as a proxy server. The functions to invoke backend services relies on the helper function generate_service_url.
The function generate_service_url allows appending parameters to a URL, as well as encrypting them if the kwarg encrypted is set to True (by default, it is False).
When using traditional Django views, invoke services as follows:
from proxy_server.backend_services import invoke_backend_service
from proxy_server.helpers import generate_service_url
def function(request):
...
response = invoke_backend_service('GET', generate_service_url('/get_user', params={ 'username':'proxy_server_admin' }, encrypted=True))
...
The invoke_backend_service receives the following parameters:
* method: The method of the service to be invoked
* function_path: The path of the service URL
* json_data: A dictionary with the body content of the service. Default value: empty dict.
* request: The request of the Django view with the information of the user and headers
* response_token: Boolean argument that indicates if a response token is expected. By default, the service expects a token on response.
* public: Boolean argument that indicates if the accessed service is public. By default, the invoked services are not public.
When using Django as a proxy server, invoke services as follows:
from proxy_server.decorators import expose_service
from proxy_server.helpers import generate_service_url
from proxy_server.backend_services import invoke_backend_service_as_proxy
import proxy_server
@expose_service('GET')
def home(request):
...
response = invoke_backend_service_as_proxy('GET', generate_service_url('/get_user', params={ 'username':'proxy_server_admin' }, encrypted=True))
...
The invoke_backend_service_as_proxy receives the following parameters:
* method: The method of the service to be invoked
* function_path: The path of the service URL
* json_data: A dictionary with the body content of the service. Default value: empty dict.
* request: The request of the Django view with the information of the user and headers
* response_token: Boolean argument that indicates if a response token is expected. By default, the service expects a token on response.
===================
This is a django application to use django as a proxy server between a frontend device/server and a backend server inside a DMZ. Services are exposed using Django REST Framework. To identify itself, django-proxy-server uses the SECRET_KEY variable defined in settings as its API KEY.
Quick start
-----------
Install using pip or easy_install
$ pip install django-proxy-server
$ easy_install django-proxy-server
Add "proxy_server" to your INSTALLED_APPS setting like this:
INSTALLED_APPS = (
...
'proxy_server',
)
Add the following options to the settings.py file to configure:
PROXY_API_KEYS = [
# Add the API KEYS you wish to allow consuming services
# API KEYS are required. Services cannot be consumed without an API KEY
]
# Write the route to the service you wish to use as token validation.
# If you don't wish to have a token validation, skip this setting
PROXY_TOKEN_VALIDATION_SERVICE = 'project.services.token_service'
# The IP or domain address of the backend services to be consumed
BACKEND_HOST = '127.0.0.1'
# The port through which the backend services will be consumed
BACKEND_PORT = '8000'
Usage
-----------
To expose a service using Django, simply decorate a view with
# The option methods is a list of HTTP methods that can be exposed.
# For example: GET, POST, PUT, DELETE
# The option public indicates that the service will be exposed as public,
# thus it doesn't require for the header to include a USER_TOKEN value
@expose_service([ methods ], public=True)
There are two ways of invoking backend services, from a traditional Django view or from an external device that uses Django as a proxy server. The functions to invoke backend services relies on the helper function generate_service_url.
The function generate_service_url allows appending parameters to a URL, as well as encrypting them if the kwarg encrypted is set to True (by default, it is False).
When using traditional Django views, invoke services as follows:
from proxy_server.backend_services import invoke_backend_service
from proxy_server.helpers import generate_service_url
def function(request):
...
response = invoke_backend_service('GET', generate_service_url('/get_user', params={ 'username':'proxy_server_admin' }, encrypted=True))
...
The invoke_backend_service receives the following parameters:
* method: The method of the service to be invoked
* function_path: The path of the service URL
* json_data: A dictionary with the body content of the service. Default value: empty dict.
* request: The request of the Django view with the information of the user and headers
* response_token: Boolean argument that indicates if a response token is expected. By default, the service expects a token on response.
* public: Boolean argument that indicates if the accessed service is public. By default, the invoked services are not public.
When using Django as a proxy server, invoke services as follows:
from proxy_server.decorators import expose_service
from proxy_server.helpers import generate_service_url
from proxy_server.backend_services import invoke_backend_service_as_proxy
import proxy_server
@expose_service('GET')
def home(request):
...
response = invoke_backend_service_as_proxy('GET', generate_service_url('/get_user', params={ 'username':'proxy_server_admin' }, encrypted=True))
...
The invoke_backend_service_as_proxy receives the following parameters:
* method: The method of the service to be invoked
* function_path: The path of the service URL
* json_data: A dictionary with the body content of the service. Default value: empty dict.
* request: The request of the Django view with the information of the user and headers
* response_token: Boolean argument that indicates if a response token is expected. By default, the service expects a token on response.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-proxy-server-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7ad5b79b25de628bfab7748d294f16fb29706d86d9018169b870b4190dd7014 |
|
MD5 | 08b085c9cbc12f9a91873a0f578e6adc |
|
BLAKE2b-256 | 1e6de6b0f1a2e607c0180a9b6c01ff8b85d08e43e662e756477400d9c1b11cd4 |
Close
Hashes for django-proxy-server-0.1.3.macosx-10.9-x86_64.exe
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2270531c100faed0e14c5a04b03f383bb9b4a852ac822983480897ac56280103 |
|
MD5 | bdf6e69046f43e1aa065461e24d8f143 |
|
BLAKE2b-256 | f9703e130ce584c158a129caab6a4a459f9c12ce326e119433ee3925f6d9180a |