django_octo_security

Enterprise-ready, non-intrusive Django runtime security posture and zero-dependency environment CVE audit module under the Django-Octo architecture.

Core Philosophy: Non-Intrusive Dual Access

django-octo-security is engineered to plug into any existing Django application without altering your host project's native logic, templates, or root routes:

1. Public/Internal Posture Endpoint (/security-audit/): Single-query database lookup (CveAuditScan.objects.first()) rendering enforced HTTP security headers and the latest environment vulnerability audit status.
2. Native Django Admin Integration (Security > CVE Checker): Automatically registers a dedicated administrative module in the left sidebar of /admin/ with one-click environment scanning (Run CVE Environment Audit), querying the official OSV.dev vulnerability database via Python standard library (importlib.metadata + urllib.request) with zero external runtime dependencies.

Security & Audit Architecture

Plug-and-Play Installation

Install the official package directly into any modern Django (>=6.1.2) and Python (>=3.12) infrastructure using pip or Rye:

1. Clone & Synchronize Environment

Clone the repository and trigger the Rust-backed Rye environment compiler to lock and synchronize dependencies:

git clone https://github.com/jeanpmodev/django_octo_security.git
cd django_octo_security
rye sync

2. Register in settings.py

Add "django_octo_security" to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ... your existing apps
    "django_octo_security",
]

3. Include the Audit Route in urls.py

Including the module at the root preserves your host application's homepage (/) and mounts the posture report at /security-audit/:

from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path("admin/", admin.site.urls),
    path("", include("django_octo_security.urls")),
]

4. Apply Migrations

python3 manage.py migrate

5. Initialize Runtime Service

Fire up the local development engine instance:

python3 manage.py runserver

Navigate to 127.0.0.1:8000/security-audit/ to inspect live.

Usage

• Security Posture Screen: Navigate to http://127.0.0.1:8000/security-audit/ to inspect active HTTP security policies and the latest environment CVE audit badge.
• Admin CVE Checker: Log in to http://127.0.0.1:8000/admin/, open Security > CVE Checker in the left navigation bar, and click Run CVE Environment Audit at the top right to scan all installed Python packages in real time.

Quality Assurance & Testing

This module is backed by a dedicated QA suite covering Unit & Query-Count Tests (pytest), BDD Specifications (behave), and Load Testing (locust). To keep the core package minimal, test dependencies are installed on demand—see TESTING.md for instructions and benchmark reports.

📄 License & Ecosystem Blueprint

Distributed under the permissive terms of the MIT License.