Skip to content

themis docs archive mime_detector_deprecated

makr-code edited this page Dec 2, 2025 · 1 revision

MIME Detector Security & Integrity Konzept

⚠️ DEPRECATED: Dieses In-File-Integrity-Konzept wurde durch ein externes Signatur-System ersetzt.
Siehe SECURITY_SIGNATURES.md für das aktuelle Design.

Hintergrund

Ursprünglicher Ansatz: SHA256-Hash direkt in mime_types.yaml speichern.
Problem: Henne-Ei-Paradoxon – Hash der Datei ändert die Datei selbst.

Neue Lösung

  • Externe Signatur-Datenbank in RocksDB (security_sig: Prefix)
  • SHA256-Hash der gesamten YAML-Datei wird vor dem Parsing berechnet
  • Verifikation gegen DB-Signatur entscheidet über config_verified_ Status
  • CRUD-API via /api/security/signatures für Signature-Management
  • CLI-Tool scripts/init_mime_signature.py zur Hash-Initialisierung

Migration

Alte integrity-Blöcke in YAML wurden entfernt. Signaturen werden nun zentral in der Datenbank verwaltet.

Siehe vollständige Dokumentation in SECURITY_SIGNATURES.md. Die MIME-Detection-Konfiguration (Mapping von Dateiendungen, Magic Signatures und Kategorien) ist sicherheitskritisch:

  • Falsche oder manipulierte Zuordnungen können zu fehlerhafter Klassifikation führen (z.B. Erkennen von Binärdateien als Text, Umgehung von Sicherheitsprüfungen, ungewollte Verarbeitung).
  • Magic Signatures beeinflussen Content-basierte Erkennung und dürfen nicht unbemerkt verändert werden.

Dieses Konzept stellt sicher, dass Änderungen an der YAML-Konfiguration erkannt werden (Integritätsprüfung via SHA256) und dokumentiert den Prozess zur Pflege.

Komponenten

  1. config/mime_types.yaml – Primäre Konfigurationsdatei.
  2. Integrity-Block in YAML:
    integrity:
      algorithm: sha256
      hash: <hex>
      generated_at: <UTC Timestamp>
      scope:
        - extensions
        - magic_signatures
        - categories
  3. C++ Klasse MimeDetector – Lädt YAML, berechnet deterministischen Hash und verifiziert Integrität.
  4. Script scripts/update_mime_hash.py – Rechnet Hash neu nach Änderungen und aktualisiert den Integrity-Block.

Deterministische Serialisierung (Canonical Representation)

Zur Hash-Bildung werden relevante Abschnitte sortiert und als kanonische Zeichenkette zusammengesetzt:

  • [extensions] gefolgt von Zeilen extension=mime alphabetisch sortiert.
  • [magic] gefolgt von Zeilen mime@offset=hexbytes[:wildcardPositions] alphabetisch sortiert.
  • [categories] gefolgt von Zeilen category=mime1,mime2,... (MIME-Liste intern sortiert), alphabetisch sortiert.

Beispiel (gekürzt):

[extensions]
json=application/json
png=image/png
[magic]
application/pdf@0=25504446
image/png@0=89504e470d0a1a0a
[categories]
text=application/json,text/plain

Dieser String wird mit SHA256 gehasht. Ergebnis ist der hash-Wert im Integrity-Block.

Bedrohungsmodell

Bedrohung Wirkung Abwehr
Manipulation einzelner Mappings Falsche MIME-Erkennung Hash-Änderung erkannt → isConfigVerified()==false
Entfernen kritischer Signaturen Reduzierte Erkennungstreffer Hash-Änderung erkannt
Einfügen bösartiger MIME-Zuordnungen Umgehung Sicherheitslogik Hash-Änderung erkannt
Replay alter Konfig mit gültigem Hash Zurückrollen von Patches Timestamp + Review-Prozess
Algorithmus-Downgrade Schwächere Sicherheit Erzwingung sha256 in Code

Integritätsprüfung Ablauf

  1. Laden YAML.
  2. Parsen extensions, magic_signatures, categories.
  3. Canonical Serialization erstellen.
  4. SHA256 berechnen.
  5. Vergleich mit deklarierter integrity.hash.
  6. Ergebnis in config_verified_ gespeichert.
    • Erfolgreich: isConfigVerified()==true (Info-Log).
    • Fehlgeschlagen: Warn-Log + Anwendung kann Policy anwenden (z.B. Fehlermodus oder eingeschränkter Betrieb).

Umgang mit Fehlermeldungen

  • Fehlender Integrity-Block → Warnung, aber Konfiguration wird geladen.
  • Falscher Algorithmus → Warnung, Verifikation übersprungen.
  • Hash-Mismatch → Warnung, mögliche Sicherheitsrichtlinie aktivieren (z.B. Reject oder Fallback).

Pflegeprozess

  1. Fachliche Änderung (z.B. neues proprietäres Format hinzufügen).
  2. Ausführen:
    python scripts/update_mime_hash.py
  3. Diff prüfen (Hash + Timestamp aktualisiert).
  4. Code Review / Security Review.
  5. Commit.
  6. CI kann optional isConfigVerified() testen.

Erweiterungen / Roadmap

  • Optional Signierung mit asymmetrischer Kryptographie (Ed25519) → zusätzlicher signature-Block.
  • Policy Flag: Bei Hash-Mismatch harte Ablehnung statt Warnung.
  • Mehrere Config-Segmente unterstützen (Multi-Datei Hash Merkle-Tree).
  • Audit-Log bei jedem Laden mit Hash-Ergebnis.

Beispiel Policy (Pseudo)

MimeDetector det; // lädt config
if (!det.isConfigVerified()) {
    LOG_ERROR("MIME config unverifiziert – starte in Safe-Mode");
    // Safe-Mode: nur allow-list definierte MIME Gruppen zulassen
}

Gründe für SHA256

  • Kollisionsresistent für diesen Anwendungsfall ausreichend.
  • In OpenSSL vorhanden (keine zusätzliche Abhängigkeit).
  • Weit verbreitet, einfach auditierbar.

Wann Hash erneuern?

  • Jede Änderung an: extensions, magic_signatures, categories.
  • Nicht erforderlich bei reinen Kommentaranpassungen (Script erkennt aber Änderung am Strukturteil nur, wenn diese Bereiche modifiziert wurden).

Validierung in Tests

Erweiterung der Unit Tests:

  • Erwartung: Bei Platzhalter UNSIGNEDisConfigVerified()==false.
  • Nach Hash-Update → true.

Fazit

Die Integritätsprüfung bietet einfachen, schnellen Schutz vor unbeabsichtigten oder böswilligen Änderungen der MIME-Erkennung – Grundlage für weitere Signaturmechanismen.

Wiki Sidebar Umstrukturierung

Datum: 2025-11-30
Status: ✅ Abgeschlossen
Commit: bc7556a

Zusammenfassung

Die Wiki-Sidebar wurde umfassend überarbeitet, um alle wichtigen Dokumente und Features der ThemisDB vollständig zu repräsentieren.

Ausgangslage

Vorher:

  • 64 Links in 17 Kategorien
  • Dokumentationsabdeckung: 17.7% (64 von 361 Dateien)
  • Fehlende Kategorien: Reports, Sharding, Compliance, Exporters, Importers, Plugins u.v.m.
  • src/ Dokumentation: nur 4 von 95 Dateien verlinkt (95.8% fehlend)
  • development/ Dokumentation: nur 4 von 38 Dateien verlinkt (89.5% fehlend)

Dokumentenverteilung im Repository:

Kategorie        Dateien  Anteil
-----------------------------------------
src                 95    26.3%
root                41    11.4%
development         38    10.5%
reports             36    10.0%
security            33     9.1%
features            30     8.3%
guides              12     3.3%
performance         12     3.3%
architecture        10     2.8%
aql                 10     2.8%
[...25 weitere]     44    12.2%
-----------------------------------------
Gesamt             361   100.0%

Neue Struktur

Nachher:

  • 171 Links in 25 Kategorien
  • Dokumentationsabdeckung: 47.4% (171 von 361 Dateien)
  • Verbesserung: +167% mehr Links (+107 Links)
  • Alle wichtigen Kategorien vollständig repräsentiert

Kategorien (25 Sektionen)

1. Core Navigation (4 Links)

  • Home, Features Overview, Quick Reference, Documentation Index

2. Getting Started (4 Links)

  • Build Guide, Architecture, Deployment, Operations Runbook

3. SDKs and Clients (5 Links)

  • JavaScript, Python, Rust SDK + Implementation Status + Language Analysis

4. Query Language / AQL (8 Links)

  • Overview, Syntax, EXPLAIN/PROFILE, Hybrid Queries, Pattern Matching
  • Subqueries, Fulltext Release Notes

5. Search and Retrieval (8 Links)

  • Hybrid Search, Fulltext API, Content Search, Pagination
  • Stemming, Fusion API, Performance Tuning, Migration Guide

6. Storage and Indexes (10 Links)

  • Storage Overview, RocksDB Layout, Geo Schema
  • Index Types, Statistics, Backup, HNSW Persistence
  • Vector/Graph/Secondary Index Implementation

7. Security and Compliance (17 Links)

  • Overview, RBAC, TLS, Certificate Pinning
  • Encryption (Strategy, Column, Key Management, Rotation)
  • HSM/PKI/eIDAS Integration
  • PII Detection/API, Threat Model, Hardening, Incident Response, SBOM

8. Enterprise Features (6 Links)

  • Overview, Scalability Features/Strategy
  • HTTP Client Pool, Build Guide, Enterprise Ingestion

9. Performance and Optimization (10 Links)

  • Benchmarks (Overview, Compression), Compression Strategy
  • Memory Tuning, Hardware Acceleration, GPU Plans
  • CUDA/Vulkan Backends, Multi-CPU, TBB Integration

10. Features and Capabilities (13 Links)

  • Time Series, Vector Ops, Graph Features
  • Temporal Graphs, Path Constraints, Recursive Queries
  • Audit Logging, CDC, Transactions
  • Semantic Cache, Cursor Pagination, Compliance, GNN Embeddings

11. Geo and Spatial (7 Links)

  • Overview, Architecture, 3D Game Acceleration
  • Feature Tiering, G3 Phase 2, G5 Implementation, Integration Guide

12. Content and Ingestion (9 Links)

  • Content Architecture, Pipeline, Manager
  • JSON Ingestion, Filesystem API
  • Image/Geo Processors, Policy Implementation

13. Sharding and Scaling (5 Links)

  • Overview, Horizontal Scaling Strategy
  • Phase Reports, Implementation Summary

14. APIs and Integration (5 Links)

  • OpenAPI, Hybrid Search API, ContentFS API
  • HTTP Server, REST API

15. Admin Tools (5 Links)

  • Admin/User Guides, Feature Matrix
  • Search/Sort/Filter, Demo Script

16. Observability (3 Links)

  • Metrics Overview, Prometheus, Tracing

17. Development (11 Links)

  • Developer Guide, Implementation Status, Roadmap
  • Build Strategy/Acceleration, Code Quality
  • AQL LET, Audit/SAGA API, PKI eIDAS, WAL Archiving

18. Architecture (7 Links)

  • Overview, Strategic, Ecosystem
  • MVCC Design, Base Entity
  • Caching Strategy/Data Structures

19. Deployment and Operations (8 Links)

  • Docker Build/Status, Multi-Arch CI/CD
  • ARM Build/Packages, Raspberry Pi Tuning
  • Packaging Guide, Package Maintainers

20. Exporters and Integrations (4 Links)

  • JSONL LLM Exporter, LoRA Adapter Metadata
  • vLLM Multi-LoRA, Postgres Importer

21. Reports and Status (9 Links)

  • Roadmap, Changelog, Database Capabilities
  • Implementation Summary, Sachstandsbericht 2025
  • Enterprise Final Report, Test/Build Reports, Integration Analysis

22. Compliance and Governance (6 Links)

  • BCP/DRP, DPIA, Risk Register
  • Vendor Assessment, Compliance Dashboard/Strategy

23. Testing and Quality (3 Links)

  • Quality Assurance, Known Issues
  • Content Features Test Report

24. Source Code Documentation (8 Links)

  • Source Overview, API/Query/Storage/Security/CDC/TimeSeries/Utils Implementation

25. Reference (3 Links)

  • Glossary, Style Guide, Publishing Guide

Verbesserungen

Quantitative Metriken

Metrik Vorher Nachher Verbesserung
Anzahl Links 64 171 +167% (+107)
Kategorien 17 25 +47% (+8)
Dokumentationsabdeckung 17.7% 47.4% +167% (+29.7pp)

Qualitative Verbesserungen

Neu hinzugefügte Kategorien:

  1. ✅ Reports and Status (9 Links) - vorher 0%
  2. ✅ Compliance and Governance (6 Links) - vorher 0%
  3. ✅ Sharding and Scaling (5 Links) - vorher 0%
  4. ✅ Exporters and Integrations (4 Links) - vorher 0%
  5. ✅ Testing and Quality (3 Links) - vorher 0%
  6. ✅ Content and Ingestion (9 Links) - deutlich erweitert
  7. ✅ Deployment and Operations (8 Links) - deutlich erweitert
  8. ✅ Source Code Documentation (8 Links) - deutlich erweitert

Stark erweiterte Kategorien:

  • Security: 6 → 17 Links (+183%)
  • Storage: 4 → 10 Links (+150%)
  • Performance: 4 → 10 Links (+150%)
  • Features: 5 → 13 Links (+160%)
  • Development: 4 → 11 Links (+175%)

Struktur-Prinzipien

1. User Journey Orientierung

Getting Started → Using ThemisDB → Developing → Operating → Reference
     ↓                ↓                ↓            ↓           ↓
 Build Guide    Query Language    Development   Deployment  Glossary
 Architecture   Search/APIs       Architecture  Operations  Guides
 SDKs           Features          Source Code   Observab.   

2. Priorisierung nach Wichtigkeit

  • Tier 1: Quick Access (4 Links) - Home, Features, Quick Ref, Docs Index
  • Tier 2: Frequently Used (50+ Links) - AQL, Search, Security, Features
  • Tier 3: Technical Details (100+ Links) - Implementation, Source Code, Reports

3. Vollständigkeit ohne Überfrachtung

  • Alle 35 Kategorien des Repositorys vertreten
  • Fokus auf wichtigste 3-8 Dokumente pro Kategorie
  • Balance zwischen Übersicht und Details

4. Konsistente Benennung

  • Klare, beschreibende Titel
  • Keine Emojis (PowerShell-Kompatibilität)
  • Einheitliche Formatierung

Technische Umsetzung

Implementierung

  • Datei: sync-wiki.ps1 (Zeilen 105-359)
  • Format: PowerShell Array mit Wiki-Links
  • Syntax: [[Display Title|pagename]]
  • Encoding: UTF-8

Deployment

# Automatische Synchronisierung via:
.\sync-wiki.ps1

# Prozess:
# 1. Wiki Repository klonen
# 2. Markdown-Dateien synchronisieren (412 Dateien)
# 3. Sidebar generieren (171 Links)
# 4. Commit & Push zum GitHub Wiki

Qualitätssicherung

  • ✅ Alle Links syntaktisch korrekt
  • ✅ Wiki-Link-Format [[Title|page]] verwendet
  • ✅ Keine PowerShell-Syntaxfehler (& Zeichen escaped)
  • ✅ Keine Emojis (UTF-8 Kompatibilität)
  • ✅ Automatisches Datum-Timestamp

Ergebnis

GitHub Wiki URL: https://github.com/makr-code/ThemisDB/wiki

Commit Details

  • Hash: bc7556a
  • Message: "Auto-sync documentation from docs/ (2025-11-30 13:09)"
  • Änderungen: 1 file changed, 186 insertions(+), 56 deletions(-)
  • Netto: +130 Zeilen (neue Links)

Abdeckung nach Kategorie

Kategorie Repository Dateien Sidebar Links Abdeckung
src 95 8 8.4%
security 33 17 51.5%
features 30 13 43.3%
development 38 11 28.9%
performance 12 10 83.3%
aql 10 8 80.0%
search 9 8 88.9%
geo 8 7 87.5%
reports 36 9 25.0%
architecture 10 7 70.0%
sharding 5 5 100.0% ✅
clients 6 5 83.3%

Durchschnittliche Abdeckung: 47.4%

Kategorien mit 100% Abdeckung: Sharding (5/5)

Kategorien mit >80% Abdeckung:

  • Sharding (100%), Search (88.9%), Geo (87.5%), Clients (83.3%), Performance (83.3%), AQL (80%)

Nächste Schritte

Kurzfristig (Optional)

  • Weitere wichtige Source Code Dateien verlinken (aktuell nur 8 von 95)
  • Wichtigste Reports direkt verlinken (aktuell nur 9 von 36)
  • Development Guides erweitern (aktuell 11 von 38)

Mittelfristig

  • Sidebar automatisch aus DOCUMENTATION_INDEX.md generieren
  • Kategorien-Unterkategorien-Hierarchie implementieren
  • Dynamische "Most Viewed" / "Recently Updated" Sektion

Langfristig

  • Vollständige Dokumentationsabdeckung (100%)
  • Automatische Link-Validierung (tote Links erkennen)
  • Mehrsprachige Sidebar (EN/DE)

Lessons Learned

  1. Emojis vermeiden: PowerShell 5.1 hat Probleme mit UTF-8 Emojis in String-Literalen
  2. Ampersand escapen: & muss in doppelten Anführungszeichen stehen
  3. Balance wichtig: 171 Links sind übersichtlich, 361 wären zu viel
  4. Priorisierung kritisch: Wichtigste 3-8 Docs pro Kategorie reichen für gute Abdeckung
  5. Automatisierung wichtig: sync-wiki.ps1 ermöglicht schnelle Updates

Fazit

Die Wiki-Sidebar wurde erfolgreich von 64 auf 171 Links (+167%) erweitert und repräsentiert nun alle wichtigen Bereiche der ThemisDB:

Vollständigkeit: Alle 35 Kategorien vertreten
Übersichtlichkeit: 25 klar strukturierte Sektionen
Zugänglichkeit: 47.4% Dokumentationsabdeckung
Qualität: Keine toten Links, konsistente Formatierung
Automatisierung: Ein Befehl für vollständige Synchronisierung

Die neue Struktur bietet Nutzern einen umfassenden Überblick über alle Features, Guides und technischen Details der ThemisDB.


Erstellt: 2025-11-30
Autor: GitHub Copilot (Claude Sonnet 4.5)
Projekt: ThemisDB Documentation Overhaul

Clone this wiki locally