🇫🇷 Français | 🇬🇧 English

Outil d'anonymisation de documents (PDF, DOCX, CSV et images PNG/JPEG) auto-hébergé, conçu pour tourner entièrement en local — aucune donnée n'est envoyée à un service tiers. Détecte et caviarde les informations personnelles (noms, dates, identifiants, adresses...) via Presidio, avec une étape de révision humaine avant validation finale.

⚠️ Avant de déployer cet outil sur des documents réels contenant des données sensibles, lisez impérativement SECURITE.md — il détaille les protections en place, les limites connues et les points qui restent sous votre responsabilité (certificat TLS, pentest, supervision).

• Fonctionnalités
• Prérequis
• Démarrage rapide
• Configuration
• Authentification (SSO / OIDC)
• Personnalisation
• Sécurité
• Limites connues
• Mises à jour et versions
• Licence

• Anonymisation de PDF, DOCX, CSV et images (PNG/JPEG avec OCR).
• Détection par NER (Presidio) + reconnaisseurs personnalisés (identifiants métier), avec thèmes de détection configurables (ex. thème médical).
• Écran de révision humaine avant finalisation : chaque détection peut être acceptée, ignorée, ou complétée manuellement.
• Purge complète des métadonnées et des objets résiduels à la sauvegarde (métadonnées EXIF/PDF, objets PDF orphelins, entrées DOCX non référencées).
• Authentification déléguée via un fournisseur OIDC standard (compatible Keycloak, Entra ID, Okta...).
• Fonctionne 100 % hors ligne après l'installation initiale — aucune dépendance réseau sortante pour le traitement des documents.

• Docker ≥ 24.0 et Docker Compose ≥ v2.20 (plugin docker compose, pas l'ancien docker-compose autonome).
• Un serveur/VM avec au minimum 4 vCPU / 8 Go de RAM pour un usage ponctuel ; voir SECURITE.md pour un usage multi-utilisateurs.
• Un fournisseur d'identité OIDC accessible (Keycloak, Entra ID, Okta, ou équivalent) — l'application ne fonctionne pas sans authentification déléguée.
• Un nom de domaine ou entrée DNS interne pointant vers le serveur (un certificat TLS valide sera nécessaire pour tout usage au-delà d'un lab, voir Limites connues).

Pour un lab ou pour tester vous pouvez aussi suivre le document plus complet: deploiement-lab.md

git clone https://github.com/EpicFail20/obfusk8.git
cd obfusk8

cp .env.example .env
# éditez .env avec vos propres valeurs (voir section Configuration ci-dessous)

docker compose pull
docker compose up -d

Vérifiez que tout tourne :

docker compose ps
docker compose logs -f app

Rendez-vous ensuite sur https://<votre-domaine> — vous devriez être redirigé vers votre fournisseur d'identité avant d'accéder à l'application.

Toute la configuration passe par le fichier .env, à copier depuis .env.example puis à remplir. Ne committez jamais votre .env réel — il est exclu par .gitignore.

Chaque variable est documentée directement dans .env.example. Les grandes catégories :

Les plafonds MAX_* ont des valeurs par défaut sûres pour un usage standard ; ne les augmentez qu'en connaissance de cause (voir SECURITE.md).

L'application ne gère jamais elle-même les mots de passe : toute l'authentification passe par oauth2-proxy, configuré pour parler à n'importe quel fournisseur OIDC standard.

1. Démarrez Keycloak seul : docker compose up -d keycloak
2. Ouvrez la console d'administration, créez un realm dédié.
3. Créez un client OIDC confidentiel, avec comme redirect URI : https://<votre-domaine>/oauth2/callback
4. Ajoutez un mapper Group Membership → claim groups si vous souhaitez restreindre l'accès par groupe.
5. Récupérez le client secret généré, placez-le dans .env (OAUTH2_PROXY_CLIENT_SECRET).

Seules les variables .env liées à l'OIDC changent — aucun autre fichier ni aucune ligne de code à modifier :

OAUTH2_PROXY_CLIENT_ID=<client-id-de-votre-fournisseur>
OAUTH2_PROXY_CLIENT_SECRET=<client-secret-de-votre-fournisseur>

et dans oauth2-proxy.cfg, l'URL d'émetteur (oidc_issuer_url) pointée vers votre tenant. Exemple pour Entra ID : https://login.microsoftonline.com/<tenant-id>/v2.0

Le comportement de détection est piloté par des thèmes (dossier themes/), chacun définissant les types d'entités à exclure ou les reconnaisseurs additionnels propres à un contexte métier (un thème médical est fourni en exemple). Voir docs/personnalisation.md pour créer votre propre thème.

Ce projet a fait l'objet d'un audit de sécurité approfondi et itératif, dont le résumé public — protections en place, principes de conception, limites connues et recommandations avant mise en production — est disponible dans SECURITE.md.

Si vous découvrez une vulnérabilité, merci de la signaler de façon responsable plutôt que de la publier directement — voir SECURITE.md#signaler-une-vulnérabilité.

• Certificat TLS : le déploiement de référence utilise un certificat auto-signé, adapté à un lab uniquement. Un certificat de confiance est indispensable avant toute mise en production.
• Dimensionnement : le dimensionnement (vCPU/RAM, nombre de réplicas Presidio) n'a pas été validé par un test de charge réel dans toutes les configurations — à valider dans votre propre environnement avant un usage à plusieurs dizaines d'utilisateurs simultanés.
• Qualité de détection : comme tout système basé sur du NER, la détection n'est pas garantie exhaustive à 100 % — l'écran de révision humaine avant validation est une étape volontairement obligatoire, pas une formalité.
• Scan antivirus et supervision : les intégrations (ICAP, syslog/SIEM) sont prêtes mais désactivées par défaut — elles nécessitent une infrastructure déjà existante côté déploiement pour être activées.
• Pentest externe : recommandé avant tout traitement de données réelles sensibles, en complément de l'audit interne déjà mené.

Ce projet suit le versionnage sémantique. Consultez le CHANGELOG.md et les Releases GitHub pour l'historique des versions. Les images Docker sont publiées et taguées automatiquement à chaque release (ghcr.io/epicfail20/obfusk8:vX.Y.Z).

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See LICENSE for details.