privacy-guard-scanner 1.0.1

DSGVO-konformes Erkennen und Ersetzen von PII in LLM-Prompts

privacy-guard

DSGVO/GDPR-konforme PII-Anonymisierung für LLM-Workflows.

privacy-guard erkennt personenbezogene Daten zuverlässig in deutschem Text, ersetzt sie durch stabile Platzhalter und ermöglicht eine saubere Rückführung nach der Verarbeitung. Kein ML-Inference-Overhead zur Laufzeit für die meisten Detektoren, klare Ergebnisse, API-ready.

Highlights

• 🔒 Compliance-first: Schutz sensibler Daten vor externen LLMs
• ⚡ Runtime-freundlich: Regex/Regel-Detektoren ohne schweren Inference-Stack
• 🔁 Deterministisch: stabile Platzhalter plus verlustfreie Rückführung
• 🐳 Deploy-ready: Python Package und FastAPI/Docker sofort nutzbar

Warum privacy-guard?

• Schützt sensible Daten vor dem Versand an externe Modelle
• Ersetzt PII durch deterministische Platzhalter wie [NAME_1], [IBAN_1]
• Stellt Originalwerte mit ScanResult.restore() wieder her
• Löst überlappende Treffer mit Prioritätslogik (z. B. SECRET > IBAN > EMAIL > ...)
• Unterstützt Python-Package und FastAPI/Docker-Betrieb

Erfasste PII-Typen

Typ	Beispiel	Hinweis
NAME	Dr. Anna Schmidt	via spaCy NER (de_core_news_sm)
IBAN	DE89 3704 0044 0532 0130 00	inkl. ISO-7064-Prüfung
PHONE	[phone]	deutschsprachige Formate
EMAIL	[e-mail]	RFC-nahe Muster
ADDRESS	Hauptstraße 12, 79100 Freiburg	regelbasiert
SECRET	API-Keys, Tokens, Passwörter	100+ Musterregeln

Zusätzlich: Personen des öffentlichen Lebens werden per interner Liste standardmäßig nicht maskiert.

Installation

Python Package

pip install privacy-guard-scanner

Für den Namensdetektor wird ein spaCy-Modell benötigt:

pip install "de_core_news_sm @ https://github.com/explosion/spacy-models/releases/download/de_core_news_sm-3.8.0/de_core_news_sm-3.8.0-py3-none-any.whl"
# oder:
python -m spacy download de_core_news_sm

API-Stack lokal

pip install -e ".[api]"
uvicorn api.main:app --reload --port 8000

Quickstart (Python)

from privacy_guard import PrivacyScanner

scanner = PrivacyScanner()

result = scanner.scan(
    "Bitte überweise 500 EUR an Hans Müller, "
    "IBAN DE89 3704 0044 0532 0130 00. "
    "Rückfragen an [e-mail] oder [phone]."
)

print(result.anonymised_text)
# Bitte überweise 500 EUR an [NAME_1], IBAN [IBAN_1]. Rückfragen an [EMAIL_1] oder [PHONE_1].

print(result.mapping)
# {'[NAME_1]': 'Hans Müller', '[IBAN_1]': 'DE89 3704 0044 0532 0130 00', ...}

llm_answer = "Vielen Dank, [NAME_1]. Die Daten zu [IBAN_1] sind verarbeitet."
print(result.restore(llm_answer))
# Vielen Dank, Hans Müller. Die Daten zu DE89 3704 0044 0532 0130 00 sind verarbeitet.

Scanner konfigurieren

from privacy_guard import PiiType, PrivacyScanner

scanner = PrivacyScanner(extra_whitelist_names=["Erika Musterfrau"])
scanner.disable_detector(PiiType.NAME)
scanner.enable_detector(PiiType.NAME)

result = scanner.scan("Kontakt: [e-mail]")

Nur bestimmte Findings auswerten:

from privacy_guard import PiiType

secrets = [f for f in result.findings if f.pii_type == PiiType.SECRET]
for finding in secrets:
    print(finding.rule_id, finding.text, finding.confidence)

REST API (Docker)

docker run -p 8000:8000 noxway/privacy-guard:latest

Alternativ via Compose:

docker compose up

Endpunkte

Methode	Pfad	Beschreibung
GET	/health	Liveness-Check
POST	/scan	Vollständiger Scan (Findings + Mapping + anonymisierter Text)
POST	/anonymize	Nur anonymisierten Text zurückgeben

Request-Body

{
  "text": "Hans Müller, IBAN DE89370400440532013000",
  "detectors": ["IBAN", "EMAIL"],
  "whitelist": ["Hans Müller"]
}

Beispiel mit curl

curl -X POST http://localhost:8000/scan \
  -H "Content-Type: application/json" \
  -d '{"text": "Kontakt: [e-mail], IBAN DE89370400440532013000", "detectors": ["EMAIL", "IBAN"]}'

API-Konfiguration

Variable	Standard	Bedeutung
API_KEY	leer	Wenn gesetzt, muss X-API-Key mitgesendet werden
CORS_ORIGINS	*	Kommagetrennte Origins, z. B. https://app.example.com

Beispiel:

services:
  api:
    image: noxway/privacy-guard:latest
    ports:
      - "8000:8000"
    environment:
      API_KEY: my-secret-key
      CORS_ORIGINS: https://app.example.com

Roadmap-Ideen

• Verbesserte Entitäten-Erkennung für Adressen in DACH-Varianten
• Optionales Audit-Logging für Compliance-Reports
• Erweiterte Mehrsprachigkeit über Deutsch hinaus

Lizenz

MIT. Details in LICENSE.