openSquat Core

📑 Table des matières

• Qu'est-ce qu'openSquat ?
• Mentionné dans
• Modèle open-core
• Fonctionnalités clés
• Démarrage rapide
• Prérequis
• Utilisation
• Modes Premium et API
• Configuration
• Automatisation
• Référence CLI
• Contribuer
• Auteur
• Licence

🎯 Qu'est-ce qu'openSquat ?

openSquat est un outil de sécurité Open Source Intelligence (OSINT) qui identifie les menaces de cybersquattage ciblant votre marque ou vos domaines :

🌟 Mentionné dans

« Un couteau suisse très puissant pour la protection de la marque » — Blog Who isXML API, août 2022

« Un outil d'une puissance incroyable pour lutter contre le typosquattage et tous les types de méfaits informatiques associés. » — Blog Who isXML API, août 2022

« Un outil pratique pour collecter des informations sur les domaines nouvellement enregistrés. » — classé parmi les 5 meilleurs outils de détection d'hameçonnage — Blog SOCRadar, juillet 2022

« openSquat offre une protection essentielle contre le squattage de domaine et les attaques d'hameçonnage grâce à une surveillance et une détection automatisées. » — Prince Yadav, TutorialsPoint, mars 2026

Citation académique

« OpenSquat a identifié 103 domaines de squattage, 960 sites d'hameçonnage actifs et 53 domaines avec des certificats suspects. » — Sharma et al., Journal of Information Security and Cybercrimes Research (JISCR), Vol. 7, Numéro 1, juin 2024

🔓 Modèle open-core

openSquat suit un modèle open-core :

• Moteur de détection principal — Open source et piloté par la communauté
• Capacités avancées — Fournies via des services commerciaux de renseignement

Ce modèle permet la transparence et la collaboration communautaire tout en répondant aux exigences d'échelle, de fiabilité et d'exploitation des entreprises.

✨ Fonctionnalités clés

• 📅 Flux NRD quotidiens — Mise à jour automatique des nouveaux domaines enregistrés
• 🔍 Détection de similarité — Algorithme de distance de Levenshtein
• 🔓 Trois modes de fonctionnement — Communauté (flux gratuit), Flux Premium (flux payant, même pipeline local) ou API Premium (service d'imitation hébergé). Les deux modes Premium partagent une seule clé API openSquat — voir Modes Premium et API.
• 🛡️ Intégration VirusTotal — Vérification de la réputation des domaines
• 🌐 Validation DNS Quad9 — Identification des domaines malveillants
• 📜 Transparence des certificats — Surveillance des certificats SSL/TLS
• 📊 Formats de sortie multiples — TXT, JSON, CSV

🚀 Démarrage rapide

Installer via pip (recommandé)

pip install opensquat
opensquat -k keywords.txt

Ou cloner le dépôt

git clone https://github.com/atenreiro/opensquat
cd opensquat
pip install -r requirements.txt
python3 opensquat.py -k keywords.txt

Utilisateurs du dépôt : dans tous les exemples ci-dessous, remplacez opensquat par python3 opensquat.py pour exécuter depuis une copie clonée.

📦 Prérequis

• Python 3.10+
• Dépendances : confusable_homoglyphs, homoglyphs, colorama, requests, dnspython, beautifulsoup4

📖 Utilisation

Commandes de base

# Exécution par défaut
opensquat

# Afficher toutes les options
opensquat -h

# Utiliser un fichier de mots-clés personnalisé
opensquat -k my_keywords.txt

Options de validation

# Validation DNS via Quad9
opensquat --dns

# Vérifier les logs de transparence des certificats
opensquat --ct

# Scanner les ports ouverts (80/443)
opensquat --portcheck

# Recouper les bases de données d'hameçonnage
opensquat --phishing results.txt

Formats de sortie

# Enregistrer au format JSON
opensquat -o results.json -t json

# Enregistrer au format CSV
opensquat -o results.csv -t csv

Niveaux de confiance

Remarque : côté API (--api), les cinq niveaux de confiance correspondent à quatre valeurs de flou (exact, low, auto, high) — -c 3 et -c 4 correspondent tous deux à high. Voir Modes Premium et API pour la correspondance complète et comment la remplacer avec --api-fuzziness.

💎 Modes Premium et API

openSquat prend en charge trois modes. Le mode par défaut (Communauté) est inchangé — les utilisateurs existants n'ont besoin d'aucun drapeau. Les deux modes Premium partagent une seule clé API openSquat ; choisissez Flux Premium si vous souhaitez le même pipeline de détection local avec un flux plus volumineux, ou API Premium si vous préférez une détection côté serveur sans téléchargement de flux local.

Obtenir une clé API

Inscrivez-vous sur opensquat.com pour obtenir une clé. La même clé fonctionne pour le Flux Premium (--premium) et l'API Premium (--api).

Fournir la clé API (ordre de priorité)

1. --api-key VOTRE_CLÉ sur la ligne de commande
2. Variable d'environnement OPENSQUAT_API_KEY
3. Fichier api_key.txt dans le répertoire courant (une clé par fichier, commentaires # autorisés)

Le drapeau CLI est visible dans la sortie ps. Privilégiez la variable d'environnement ou le fichier de clé dans les environnements partagés.

Exemples

# Mode Flux Premium — même pipeline local, flux plus volumineux
export OPENSQUAT_API_KEY=os_xxxxxxxxxxxx
opensquat -k keywords.txt --premium

# Mode API Premium — détection côté serveur par mot-clé
opensquat -k keywords.txt --api

# API Premium + vérification de la réputation DNS sur chaque domaine retourné
opensquat -k keywords.txt --api --dns

# API Premium avec sortie JSON groupée par mot-clé
opensquat -k keywords.txt --api -t json -o results.json

# Ajuster la recherche API Premium
opensquat -k keywords.txt --api --api-fuzziness high --api-history-days 7 --api-max-results 200

Lorsque --premium ou --api charge une clé avec succès, la CLI affiche une ligne de confirmation masquée afin que vous puissiez vérifier quelle clé a été utilisée sans la divulguer :

[*] Clé API chargée : os_gL...L5Mb

En mode API Premium, le résumé de l'exécution indique le mode actif, le nombre d'appels API effectués, et votre solde restant avec le delta d'utilisation (par exemple, 4972 (utilisé 4 sur 4976 dans cette exécution)). Les lignes de progression par mot-clé apparaissent dans le même ordre que votre fichier de mots-clés, même si les appels s'exécutent en parallèle. L'épuisement du quota (HTTP 429) renvoie gracieusement des résultats partiels ; les erreurs d'authentification (401) et de plan (403) interrompent avec un message clair.

Si le backend limite votre demande (HTTP 429 avec un en-tête Retry-After), l'outil la distingue de l'épuisement du quota : vous verrez un avertissement jaune [!] Limite de débit atteinte (réessayer dans Ns) au lieu du message rouge quota épuisé, les résultats partiels sont toujours renvoyés, et le résumé préserve votre solde API réel afin que vous puissiez voir exactement combien de crédits vous avez utilisés. Pour éviter de déclencher les limites de débit lors de grandes analyses, passez --api-rate-limit N pour limiter les requêtes sortantes par seconde sur l'ensemble des workers. Une valeur de 8 est un point de départ sûr pour la plupart des serveurs.

# Limiter à 8 requêtes/seconde sur tous les workers
opensquat -k keywords.txt --api --api-rate-limit 8

Recommandation de format de sortie

Le format JSON est recommandé pour le mode API Premium car l'API renvoie des métadonnées par domaine que les autres formats ne peuvent pas transporter aussi proprement : le TLD enregistré, la date de première observation NRD, un drapeau IDN homographique, et le rendu Unicode de l'homographe lorsque le domaine en est un.

opensquat -k keywords.txt --api -t json -o results.json

Exemple de la sortie enrichie en mode API Premium (tronquée) :

[
  {
    "keyword": "microsoft",
    "domains": [
      {"domain": "securite-microsoft.fr", "tld": "fr", "date": "09-04-2026", "idn": false},
      {"domain": "xn--mirosoft-hw7c.com", "tld": "com", "date": "09-04-2026", "idn": true, "unicode": "miᴄrosoft.com"}
    ]
  }
]

Le drapeau idn combiné au rendu unicode vous permet de voir en un coup d'œil que xn--mirosoft-hw7c.com est en fait ᴄ (Lettre latine petite capitale C) imitant le c dans "microsoft" — une information qu'une chaîne punycode simple cache complètement.

La sortie CSV est également prise en charge et produit une ligne par domaine avec les mêmes colonnes de métadonnées, ce qui convient aux analystes travaillant dans Excel ou pandas :

opensquat -k keywords.txt --api -t csv -o results.csv

Le CSV est écrit avec un BOM UTF-8 afin qu'Excel sous Windows rende correctement la colonne des homographes Unicode.

Les modes Communauté et Flux Premium émettent la même forme JSON de haut niveau pour la cohérence entre les modes, mais avec uniquement le champ domain renseigné par entrée — le flux NRD ne transporte pas les métadonnées par domaine que seule l'API hébergée possède :

[
  {
    "keyword": "microsoft",
    "domains": [
      {"domain": "mirosoft.com"},
      {"domain": "mcrosoft.net"}
    ]
  }
]

Si vous passez --api-key sans sélectionner également --premium ou --api, la CLI affiche une indication d'une ligne indiquant que la clé sera ignorée en mode Communauté (pas de changement de mode silencieux).

En mode API Premium, -c/--confidence est automatiquement mappé au flou de l'API (0→exact, 1→low, 2→auto, 3→high, 4→high). Utilisez --api-fuzziness pour remplacer.

L'API Premium (--api) est incompatible avec --doppelganger et -d/--domains.

⚙️ Configuration

Fichier de mots-clés (keywords.txt)

# Les lignes commençant par # sont des commentaires
maentreprise
mamarque
monproduit

Clé API VirusTotal (vt_key.txt)

Pour utiliser --vt ou --subdomains, ajoutez votre clé API :

# Obtenez votre clé API gratuite sur https://www.virustotal.com
votre_clé_api_ici

Clé API openSquat (api_key.txt)

Requis pour --premium et --api. Créez un fichier api_key.txt dans le répertoire de travail :

# Obtenez votre clé sur https://opensquat.com
# Les lignes commençant par # sont ignorées ; la première ligne non commentée est utilisée.
os_votre_clé_ici

La CLI résout la clé dans cet ordre : drapeau --api-key → variable d'environnement $OPENSQUAT_API_KEY → fichier api_key.txt. Les méthodes par variable d'environnement et fichier sont préférées au drapeau CLI dans les environnements partagés, car les arguments CLI sont visibles via ps.

🤖 Automatisation

Exécution quotidienne via crontab :

# Installé via pip (recommandé) — tous les jours à 8h, les flux se mettent à jour vers 7h30 UTC
0 8 * * * cd /chemin/vers/répertoire && opensquat -k keywords.txt -o results.json -t json

# Dépôt cloné — invoquer opensquat.py directement avec python3
0 8 * * * cd /chemin/vers/opensquat && python3 opensquat.py -k keywords.txt -o results.json -t json

Le cd dans un répertoire de travail est important si vous dépendez de api_key.txt (résolu à partir du répertoire courant) ou si vous voulez que results.json soit écrit à un emplacement spécifique.

📋 Référence CLI

🤝 Contribuer

Nous accueillons les contributions ! Consultez notre Guide de contribution pour plus de détails.

• 🐛 Signaler des bugs via les Problèmes GitHub
• 💡 Demander des fonctionnalités en ouvrant un problème
• 🔧 Soumettre des PR pour des corrections de bugs ou des améliorations
• 📝 Notes de version — voir le CHANGELOG pour les nouveautés de chaque version

👤 Auteur

Andre Tenreiro — LinkedIn · Clé PGP

📜 Licence

Ce projet est sous licence GNU GPL v3.