-
Notifications
You must be signed in to change notification settings - Fork 0
themis docs admin_tools feature_matrix
| Feature | Status | Beschreibung |
|---|---|---|
| Schlüssel-Übersicht | ✅ | Anzeige LEK/KEK/DEK inkl. Version/Status |
| Manuelle Rotation | ✅ | POST /keys/rotate mit key_id (Body/Query) |
| Filter | ✅ | Nach Typ (LEK/KEK/DEK), „nur abgelaufene“ |
| Status-Updates | ✅ | Zähler gesamt/abgelaufen |
| Fehlerbehandlung | ✅ | 400/503 verständlich anzeigen |
| Feature | Status | Beschreibung |
|---|---|---|
| Regeln laden | ✅ | GET /classification/rules
|
| Test-Classification | ✅ | POST /classification/test mit { text, metadata }
|
| Export | ✅ | CSV-Export der Ergebnisse |
| Filter | ✅ | Level, Verschlüsselung, Compliance-Status |
| Live-Statistik | ✅ | Counts in Sidebar |
| Feature | Status | Beschreibung |
|---|---|---|
| Report-Generierung | ✅ | GET /reports/compliance?type=...
|
| Formate | ✅ | JSON (Server), Export in den Tools (CSV/PDF/Excel) |
| Vorlagen | ✅ | Standard/Detailliert (Tool-seitig) |
| Zeitraum | ✅ | Parametrierbar (Tool-seitig) |
| Fehlerbehandlung | ✅ | 503 „Reports API not available“ verständlich |
| Feature | Status | Beschreibung |
|---|---|---|
| Datumsfilter | ✅ | Von/Bis-Datum mit DatePicker |
| Benutzerfilter | ✅ | Filter nach Username |
| Aktionsfilter | ✅ | Filter nach Action-Typ |
| Entitätsfilter | ✅ | Filter nach EntityType |
| Erfolgsfilter | ✅ | "Nur erfolgreiche Aktionen" Checkbox |
| Globale Suche | ✅ | Durchsucht alle 9 Spalten gleichzeitig |
| Multi-Column Sort | ✅ | Sortierung nach ID, Timestamp, User, Action, etc. |
| Toggle Sort | ✅ | Klick wechselt aufsteigend/absteigend |
| Paginierung | ✅ | Vor/Zurück Buttons, 100 Einträge/Seite |
| CSV Export | ✅ | Export gefilterte Daten |
| Status-Updates | ✅ | Zeigt gefilterte/gesamt Anzahl |
| Filter löschen | ✅ | Reset aller Filter auf Default |
| ICollectionView | ✅ | Performante Client-Filter |
| MVVM Pattern | ✅ | Clean Architecture |
| Dependency Injection | ✅ | Microsoft.Extensions.DI |
Durchsuchbare Felder:
- User (Benutzername)
- Action (Aktion)
- EntityType (Entitätstyp)
- EntityId (Entitäts-ID)
- OldValue (Alter Wert)
- NewValue (Neuer Wert)
- IpAddress (IP-Adresse)
- SessionId (Sitzungs-ID)
- ErrorMessage (Fehlermeldung)
| Feature | Status | Beschreibung |
|---|---|---|
| Batch-Liste | ✅ | Übersicht aller SAGA-Batches |
| Batch-Suche | ✅ | Suche nach ID, Hash, Signatur, Timestamp |
| Batch-Detail | ✅ | Vollständige Batch-Informationen |
| SAGA-Steps | ✅ | Liste aller Schritte im Batch |
| Step-Suche | ✅ | Suche nach SAGA ID, Step Name, Status, etc. |
| Multi-Column Sort | ✅ | Sortierung für Batches & Steps |
| Signatur-Verifizierung | ✅ | Kryptographische Prüfung |
| Batch Flush | ✅ | Manuelles Flushen des aktuellen Batches |
| CSV Export | ✅ | Export SAGA-Steps |
| Auto-Load Detail | ✅ | Automatisches Laden bei Batch-Auswahl |
| Status-Updates | ✅ | Zeigt gefilterte/gesamt Anzahl |
| Split-View | ✅ | Batch-Liste |
| Visual Feedback | ✅ | ✓/✗ für Verifikations-Status |
| ICollectionView | ✅ | Separate Filter für Batches & Steps |
| MVVM Pattern | ✅ | CommunityToolkit.Mvvm |
Batch-Suchfelder:
- BatchId (Batch-ID)
- Hash (SHA-256 Hash)
- Signature (Kryptographische Signatur)
- Timestamp (Zeitstempel)
Step-Suchfelder:
- SagaId (SAGA-ID)
- StepName (Schrittname)
- Status (Status)
- CorrelationId (Korrelations-ID)
- Metadata (Metadaten JSON)
| Komponente | Technologie | Version |
|---|---|---|
| Framework | .NET | 8.0 |
| UI | WPF | Windows Presentation Foundation |
| MVVM | CommunityToolkit.Mvvm | 8.x |
| DI | Microsoft.Extensions.DI | 8.x |
| HTTP | HttpClient | .NET 8 |
| Config | Microsoft.Extensions.Configuration.Json | 8.x |
| Backend | C++ themis_server | REST API |
✅ MVVM (Model-View-ViewModel)
- Klare Trennung UI ↔ Logik
- Data Binding
- Command Pattern
- ObservableObject/ObservableProperty
✅ Dependency Injection
- Service Container (App.xaml.cs)
- Singleton ThemisServerConfig
- Transient ViewModels & Windows
- Factory Pattern für HttpClient
✅ ICollectionView Pattern
- Client-seitige Filterung
- Keine Änderung der Source-Collection
- Performance-Optimierung
- Kombinierbar mit Sorting
✅ Repository Pattern
- ThemisApiClient als Repository
- ApiResponse Wrapper
- Error Handling
- Asynchrone Operationen
✅ Echtzeit-Suche
- UpdateSourceTrigger=PropertyChanged
- Instant Feedback
- Keine Server-Anfragen bei Texteingabe
✅ Visuelle Indikatoren
- Loading Spinner/Progress Bar
- Status-Leiste mit Meldungen
- Sortier-Pfeile in Spaltenüberschriften
- Platzhalter-Text in Suchfeldern ("🔍 Search...")
✅ Tastatur-Support
- Tab-Navigation
- Enter in Suchfeldern
- ESC für Abbrechen
✅ Responsive Design
- GridSplitter für variable Layouts
- Auto-Sizing Columns
- ScrollViewer für große Daten
- AlternatingRowBackground für Lesbarkeit
✅ Optimierungen
- Server-seitige Paginierung (100/Seite)
- Client-seitige Filterung nur auf geladene Daten
- ICollectionView statt Collection-Manipulation
- Async/Await für non-blocking UI
- Background-Threads für I/O
✅ Memory Management
- ObservableCollection statt List (für Binding)
- Dispose Pattern in App.OnExit
- ServiceProvider Lifecycle Management
✅ Exception Handling
- Try-Catch in allen Commands
- MessageBox für Benutzer-Feedback
- ErrorMessage Property für UI
- StatusMessage für Kontext
✅ Validation
- Null-Checks vor API-Calls
- Config-Validation beim Startup
- Filter-Validation (optional vs. required)
| Endpoint | Method | Beschreibung |
|---|---|---|
/keys |
GET | Liste aller gemanagten Schlüssel |
/keys/rotate |
POST | Rotation; key_id im Body { key_id: "DEK" } oder Query ?key_id=DEK
|
/classification/rules |
GET | Liste der Klassifizierungsregeln |
/classification/test |
POST | Test-Classification { text, metadata }
|
/reports/compliance |
GET | Compliance-Report `?type=overview |
Hinweis: Einige Tool-Clients verwenden einen /api-Prefix (z. B. /api/keys). Siehe Admin-Guide für Reverse-Proxy-Rewrite auf prefix-freie Server-Endpunkte.
| Endpoint | Method | Beschreibung |
|---|---|---|
/api/audit |
GET | Liste Audit-Logs mit Filtern |
/api/audit/export/csv |
GET | Export als CSV |
Query-Parameter:
-
start_date(DateTime) -
end_date(DateTime) -
user(string) -
action(string) -
entity_type(string) -
success_only(bool) -
page(int) -
page_size(int)
| Endpoint | Method | Beschreibung |
|---|---|---|
/api/saga/batches |
GET | Liste aller SAGA-Batches |
/api/saga/batch/{id} |
GET | Batch-Detail mit Steps |
/api/saga/batch/{id}/verify |
POST | Verifiziere Signatur |
/api/saga/flush |
POST | Flush aktuellen Batch |
- PII-Manager Tool
- UUID ↔ Pseudonym Mapping
- DSGVO Art. 17 Löschung
- Export-Funktionen
- Retention-Manager
- Policy-Konfiguration
- Überwachung
- Manuelle Bereinigung
- Erweiterte Admin-Features
- Saved Filter Profiles
- Team-Filter Templates
- Regex-Support in Suche
- Advanced Filter Builder (AND/OR)
- Visualisierung (Charts)
✅ Development Build
- Debug-Build funktionsfähig
- Local Testing erfolgreich
- themis_server Integration getestet
-
Release Build
- Optimierte Binaries
- Code-Signierung
- Installer (MSI/ClickOnce)
-
Auto-Update
- ClickOnce Deployment
- Version-Check
- Automatische Updates
-
Documentation
- Benutzerhandbücher
- Admin-Guide
- API-Dokumentation
- Video-Tutorials
Aktuelle Features:
- ✅ Admin-Tools: AuditLogViewer, SAGAVerifier, KeyRotation, Classification, Compliance Reports
- ✅ Vollständige Such-, Sortier- und Filterlogik
- ✅ REST API Integration (inkl. Keys, Classification, Reports)
- ✅ MVVM + DI Architecture
- ✅ ICollectionView Performance-Optimierung
- ✅ CSV Export
- ✅ Echtzeit-Suche
- ✅ Multi-Column Sorting
- ✅ Responsive UI
Nächste Schritte:
- PII-Manager Tool entwickeln
- Retention-Manager erstellen
- Deployment vorbereiten
- Dokumentation vervollständigen
Code-Qualität:
- ✅ MVVM Pattern konsequent
- ✅ Dependency Injection
- ✅ Error Handling
- ✅ Performance-optimiert
- ✅ Wartbar & erweiterbar
Datum: 2025-11-30
Status: ✅ Abgeschlossen
Commit: bc7556a
Die Wiki-Sidebar wurde umfassend überarbeitet, um alle wichtigen Dokumente und Features der ThemisDB vollständig zu repräsentieren.
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%
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
- Home, Features Overview, Quick Reference, Documentation Index
- Build Guide, Architecture, Deployment, Operations Runbook
- JavaScript, Python, Rust SDK + Implementation Status + Language Analysis
- Overview, Syntax, EXPLAIN/PROFILE, Hybrid Queries, Pattern Matching
- Subqueries, Fulltext Release Notes
- Hybrid Search, Fulltext API, Content Search, Pagination
- Stemming, Fusion API, Performance Tuning, Migration Guide
- Storage Overview, RocksDB Layout, Geo Schema
- Index Types, Statistics, Backup, HNSW Persistence
- Vector/Graph/Secondary Index Implementation
- Overview, RBAC, TLS, Certificate Pinning
- Encryption (Strategy, Column, Key Management, Rotation)
- HSM/PKI/eIDAS Integration
- PII Detection/API, Threat Model, Hardening, Incident Response, SBOM
- Overview, Scalability Features/Strategy
- HTTP Client Pool, Build Guide, Enterprise Ingestion
- Benchmarks (Overview, Compression), Compression Strategy
- Memory Tuning, Hardware Acceleration, GPU Plans
- CUDA/Vulkan Backends, Multi-CPU, TBB Integration
- Time Series, Vector Ops, Graph Features
- Temporal Graphs, Path Constraints, Recursive Queries
- Audit Logging, CDC, Transactions
- Semantic Cache, Cursor Pagination, Compliance, GNN Embeddings
- Overview, Architecture, 3D Game Acceleration
- Feature Tiering, G3 Phase 2, G5 Implementation, Integration Guide
- Content Architecture, Pipeline, Manager
- JSON Ingestion, Filesystem API
- Image/Geo Processors, Policy Implementation
- Overview, Horizontal Scaling Strategy
- Phase Reports, Implementation Summary
- OpenAPI, Hybrid Search API, ContentFS API
- HTTP Server, REST API
- Admin/User Guides, Feature Matrix
- Search/Sort/Filter, Demo Script
- Metrics Overview, Prometheus, Tracing
- Developer Guide, Implementation Status, Roadmap
- Build Strategy/Acceleration, Code Quality
- AQL LET, Audit/SAGA API, PKI eIDAS, WAL Archiving
- Overview, Strategic, Ecosystem
- MVCC Design, Base Entity
- Caching Strategy/Data Structures
- Docker Build/Status, Multi-Arch CI/CD
- ARM Build/Packages, Raspberry Pi Tuning
- Packaging Guide, Package Maintainers
- JSONL LLM Exporter, LoRA Adapter Metadata
- vLLM Multi-LoRA, Postgres Importer
- Roadmap, Changelog, Database Capabilities
- Implementation Summary, Sachstandsbericht 2025
- Enterprise Final Report, Test/Build Reports, Integration Analysis
- BCP/DRP, DPIA, Risk Register
- Vendor Assessment, Compliance Dashboard/Strategy
- Quality Assurance, Known Issues
- Content Features Test Report
- Source Overview, API/Query/Storage/Security/CDC/TimeSeries/Utils Implementation
- Glossary, Style Guide, Publishing Guide
| Metrik | Vorher | Nachher | Verbesserung |
|---|---|---|---|
| Anzahl Links | 64 | 171 | +167% (+107) |
| Kategorien | 17 | 25 | +47% (+8) |
| Dokumentationsabdeckung | 17.7% | 47.4% | +167% (+29.7pp) |
Neu hinzugefügte Kategorien:
- ✅ Reports and Status (9 Links) - vorher 0%
- ✅ Compliance and Governance (6 Links) - vorher 0%
- ✅ Sharding and Scaling (5 Links) - vorher 0%
- ✅ Exporters and Integrations (4 Links) - vorher 0%
- ✅ Testing and Quality (3 Links) - vorher 0%
- ✅ Content and Ingestion (9 Links) - deutlich erweitert
- ✅ Deployment and Operations (8 Links) - deutlich erweitert
- ✅ 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%)
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.
- 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
- Alle 35 Kategorien des Repositorys vertreten
- Fokus auf wichtigste 3-8 Dokumente pro Kategorie
- Balance zwischen Übersicht und Details
- Klare, beschreibende Titel
- Keine Emojis (PowerShell-Kompatibilität)
- Einheitliche Formatierung
-
Datei:
sync-wiki.ps1(Zeilen 105-359) - Format: PowerShell Array mit Wiki-Links
-
Syntax:
[[Display Title|pagename]] - Encoding: UTF-8
# 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- ✅ Alle Links syntaktisch korrekt
- ✅ Wiki-Link-Format
[[Title|page]]verwendet - ✅ Keine PowerShell-Syntaxfehler (& Zeichen escaped)
- ✅ Keine Emojis (UTF-8 Kompatibilität)
- ✅ Automatisches Datum-Timestamp
GitHub Wiki URL: https://github.com/makr-code/ThemisDB/wiki
- 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)
| 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%)
- 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)
- Sidebar automatisch aus DOCUMENTATION_INDEX.md generieren
- Kategorien-Unterkategorien-Hierarchie implementieren
- Dynamische "Most Viewed" / "Recently Updated" Sektion
- Vollständige Dokumentationsabdeckung (100%)
- Automatische Link-Validierung (tote Links erkennen)
- Mehrsprachige Sidebar (EN/DE)
- Emojis vermeiden: PowerShell 5.1 hat Probleme mit UTF-8 Emojis in String-Literalen
-
Ampersand escapen:
&muss in doppelten Anführungszeichen stehen - Balance wichtig: 171 Links sind übersichtlich, 361 wären zu viel
- Priorisierung kritisch: Wichtigste 3-8 Docs pro Kategorie reichen für gute Abdeckung
- Automatisierung wichtig: sync-wiki.ps1 ermöglicht schnelle Updates
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