django-ip-access-middleware 1.0.0

Django middleware for IP and hostname-based access control

Django IP Access Control Middleware

A Django middleware for IP and hostname-based access control with support for:

• IP addresses and CIDR ranges from database
• Hostname matching from environment variables
• Automatic same-network detection for Kubernetes
• Route-based access control with regex, exact, startswith, endswith patterns

Features

• Database-driven IP control: Store granted IP addresses and CIDR ranges in the database
• Environment-based hostnames: Configure allowed hostnames via environment variables
• Kubernetes support: Automatic same-network detection for pods in the same cluster
• Flexible route matching: Support for regex, exact match, startswith, and endswith patterns
• Priority-based access control:
  1. Same network detection (highest priority - allows immediately)
  2. Hostname matching (from environment variables)
  3. IP checking (from database)

Installation

pip install django-ip-access-middleware

Or install from source:

pip install -e .

Quick Start

1. Add to INSTALLED_APPS

Add django_ip_access to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ... other apps
    'django_ip_access',
]

2. Add Middleware

Add the middleware to your MIDDLEWARE list in settings.py:

MIDDLEWARE = [
    # ... other middleware
    'django_ip_access.middleware.IPAccessMiddleware',
    # ... other middleware
]

3. Run Migrations

Create and run migrations for the database model:

python manage.py makemigrations django_ip_access
python manage.py migrate django_ip_access

4. Configure Routes

Configure which routes should be protected in settings.py:

IP_ACCESS_MIDDLEWARE_CONFIG = {
    'routes': [
        {
            'pattern': r'^/admin/.*',  # regex pattern
            'type': 'regex',
        },
        {
            'pattern': '/api/',  # starts with
            'type': 'startswith',
        },
        {
            'pattern': '.json',  # ends with
            'type': 'endswith',
        },
        {
            'pattern': '/api/secure/',  # exact match
            'type': 'exact',
        },
    ],
    # Optional: Kubernetes network configuration
    'kubernetes_network_range': os.getenv('KUBERNETES_NETWORK_RANGE', ''),  # e.g., '10.244.0.0/16'
    'pod_ip': os.getenv('POD_IP', ''),  # Kubernetes pod IP
}

# Environment variable for allowed hostnames (comma-separated)
ALLOWED_HOSTNAMES_ENV = os.getenv('ALLOWED_HOSTNAMES', '')
# Example: ALLOWED_HOSTNAMES="*.example.com,api.example.com,*.subdomain.com"

5. Add Granted IPs

Use Django admin or create GrantedIP objects to allow IP addresses:

from django_ip_access.models import GrantedIP

# Add a single IP
GrantedIP.objects.create(
    ip_address='192.168.1.100',
    description='Development server',
    is_active=True
)

# Add an IP range (CIDR)
GrantedIP.objects.create(
    ip_address='10.0.0.0/24',
    description='Internal network',
    is_active=True
)

Configuration

Route Types

• regex: Match using regular expressions
• exact: Exact path match
• startswith: Match if path starts with pattern
• endswith: Match if path ends with pattern

Environment Variables

• ALLOWED_HOSTNAMES: Comma-separated list of allowed hostnames (supports wildcards like *.example.com)
• POD_IP: Kubernetes pod IP (optional, for explicit network detection)
• KUBERNETES_NETWORK_RANGE: Kubernetes network range (optional, e.g., 10.244.0.0/16)

Same Network Detection

The middleware automatically detects if the client IP is on the same network as the server:

• Checks if both IPs are private IPs on the same subnet
• Works automatically without configuration
• Highest priority - if same network is detected, access is allowed immediately

Usage Examples

Protect Admin Routes

IP_ACCESS_MIDDLEWARE_CONFIG = {
    'routes': [
        {
            'pattern': r'^/admin/.*',
            'type': 'regex',
        },
    ],
}

Protect API Routes

IP_ACCESS_MIDDLEWARE_CONFIG = {
    'routes': [
        {
            'pattern': '/api/',
            'type': 'startswith',
        },
    ],
}

Allow Hostnames from Environment

Set environment variable:

export ALLOWED_HOSTNAMES="*.example.com,api.example.com"

Django Admin

The middleware includes a Django admin interface for managing granted IPs at /admin/:

• View all granted IPs
• Add/edit/delete IP addresses and ranges
• Enable/disable IP entries
• Filter and search

Models

GrantedIP

• ip_address: IP address or CIDR range (e.g., 192.168.1.1 or 192.168.1.0/24)
• description: Optional description
• is_active: Enable/disable the IP entry
• created_at: Creation timestamp
• updated_at: Last update timestamp

Testing

Run the test suite:

python test_middleware.py
python test_integration.py

Requirements

• Python 3.8+
• Django 3.2+

Optional Dependencies

• netifaces: For better network interface detection (install with pip install django-ip-access-middleware[dev])

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and questions, please open an issue on GitHub.