PayloadShield Documentation

PayloadShield provides request/response payload encryption integrations for Django, FastAPI, Flask, Laravel, and Symfony. The Python integrations use ComPyPS; the PHP integrations use ComPHPPS.

Index

1. Django
2. FastAPI
3. Flask
4. Laravel
5. Symfony
6. Encryption and cross-language communication

Shared API envelope

For encrypted requests, send JSON with a string encrypted property:

{"encrypted":"<handler output>"}

For encrypted responses, the integrations return the same envelope. The encrypted bytes encode a JSON object or array; the selected handler and its key configuration must match at both ends. Use HTTPS as well: payload encryption does not replace transport security, authentication, authorization, or replay protection.

Choose an integration

Framework	Package	Integration style	Guide
Django	django_payloadshield	View decorators	Django
FastAPI	fastapi_payloadshield	Route decorators	FastAPI
Flask	flask-payloadshield	View decorators	Flask
Laravel	payloadshield/laravelps	Route middleware	Laravel
Symfony	payloadshield/symfonyps	Route defaults and event subscriber	Symfony