Pourquoi les modèles personnalisés sont importants

Bien qu'AI Diff Review soit livré avec des modèles intégrés pour les secrets courants, votre base de code peut utiliser des formats personnalisés qui ne sont pas couverts par les valeurs par défaut. Créer des modèles de rédaction personnalisés garantit que tous vos secrets sont protégés, quel que soit leur format.

Comprendre le format des modèles

Les modèles de rédaction utilisent des expressions régulières (regex), vous donnant des capacités de correspondance puissantes. Un bon modèle devrait :

  • Correspondre précisément à votre format de secret
  • Ne pas correspondre aux valeurs non secrètes (éviter les faux positifs)
  • Être suffisamment spécifique pour capturer les variations
  • Ne pas être trop large (éviter de rédiger trop)

Exemples de modèles courants

Clés API avec préfixes

API_KEY\s*[:=]\s*['"]?[A-Za-z0-9]{32,}['"]?

Correspond aux clés API dans divers formats d'assignation avec des clés de 32+ caractères.

Jetons JWT

eyJ[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}

Correspond aux jetons JWT (trois parties encodées en base64 séparées par des points).

Chaînes de connexion à la base de données

(?:jdbc:|mongodb\+srv://|postgresql://)[^\s'"]+

Correspond à diverses chaînes de connexion à la base de données.

Jetons OAuth

oauth[_-]?token\s*[:=]\s*['"]?[A-Za-z0-9_-]{20,}['"]?

Correspond aux jetons OAuth dans divers formats.

Créer des modèles personnalisés

Pour ajouter un modèle personnalisé :

  1. Allez dans Paramètres → Outils → AI Diff Review
  2. Naviguez vers la section Rédaction de secrets
  3. Cliquez sur "Ajouter un modèle"
  4. Entrez votre modèle regex
  5. Le modèle est validé immédiatement
  6. Les modèles invalides affichent un message d'erreur

Validation des modèles

AI Diff Review valide les modèles lorsque vous les ajoutez ou les modifiez :

  • La syntaxe regex invalide est détectée immédiatement
  • Les messages d'erreur expliquent ce qui ne va pas
  • Vous ne pouvez pas sauvegarder des modèles invalides
  • Cela évite la frustration des modèles cassés

Gestion des modèles

Visualisation des modèles

Vous pouvez voir tous les modèles (intégrés et personnalisés) dans les paramètres. Les modèles intégrés sont marqués et ne peuvent pas être supprimés, mais vous pouvez les désactiver si nécessaire.

Modification des modèles

Les modèles personnalisés peuvent être modifiés à tout moment. Cliquez sur un modèle pour le modifier, et la validation se fait immédiatement.

Suppression des modèles

Vous pouvez supprimer les modèles personnalisés dont vous n'avez plus besoin. Les modèles intégrés ne peuvent pas être supprimés mais peuvent être désactivés.

Réorganisation des modèles

Les modèles sont appliqués dans l'ordre, donc la réorganisation est importante. Les modèles plus spécifiques doivent venir avant les généraux pour assurer une correspondance correcte.

Importation et exportation

Vous pouvez exporter votre ensemble de modèles vers un fichier texte (un regex par ligne) et l'importer sur d'autres machines. C'est utile pour :

  • Partager des modèles avec les membres de l'équipe
  • Sauvegarder votre configuration
  • Utiliser les mêmes modèles entre projets
  • Contrôler la version de vos modèles

Tester les modèles

Après avoir créé un modèle, testez-le :

  1. Créez un commit de test avec des secrets d'exemple
  2. Exécutez une analyse
  3. Vérifiez que les secrets sont correctement rédigés
  4. Vérifiez qu'il n'y a pas de faux positifs (non-secrets étant rédigés)
  5. Ajustez le modèle si nécessaire

Meilleures pratiques

Commencer spécifique

Créez d'abord des modèles spécifiques, puis ajoutez des modèles plus généraux si nécessaire. Les modèles spécifiques sont moins susceptibles de causer des faux positifs.

Tester soigneusement

Testez les modèles avec de vrais exemples de votre base de code pour vous assurer qu'ils fonctionnent correctement.

Documenter les modèles

Envisagez de documenter ce que chaque modèle personnalisé correspond, surtout si vous avez beaucoup de modèles.

Réviser régulièrement

Révisez périodiquement vos modèles pour vous assurer qu'ils sont toujours pertinents et ne causent pas de problèmes.

L'ordre compte

Placez les modèles plus spécifiques avant les généraux. La première correspondance gagne, donc l'ordre affecte ce qui est rédigé.

Pièges courants

Trop large

Évitez les modèles qui correspondent à trop de choses. Par exemple, ne rédigez pas toutes les chaînes—soyez spécifique sur ce qui constitue un secret.

Trop étroit

Assurez-vous que les modèles capturent les variations. Si vos secrets peuvent apparaître dans différents formats, tenez-en compte.

Ne pas tester

Toujours tester les modèles avant de s'y fier. Un modèle qui semble correct pourrait ne pas fonctionner comme prévu.

Conclusion

Les modèles de rédaction de secrets personnalisés vous permettent de protéger vos formats de secrets spécifiques, garantissant une protection complète pour votre base de code. En comprenant les regex et en suivant les meilleures pratiques, vous pouvez créer des modèles efficaces qui gardent vos secrets en sécurité.

N'oubliez pas de tester les modèles, de les ordonner correctement et de les réviser régulièrement. Avec une gestion appropriée des modèles, vous pouvez maintenir une sécurité forte tout en utilisant la révision de code IA.

Prêt à personnaliser votre protection ? Installez AI Diff Review et commencez à créer des modèles de rédaction personnalisés pour votre base de code.