Aller au contenu

Paramètres du Corps d'Événement Webhook Boost

Le tableau suivant documente les paramètres inclus dans la charge JSON d'un événement Webhook Boost, déclenché par l'analyse de sécurité de Boost. Chaque paramètre est décrit avec son objectif, son type de données, et les références externes pertinentes le cas échéant.

Nom du Paramètre Description Type Référence Externe
analyzer_name Le nom de l'outil d'analyse qui a généré l'événement Webhook. Par exemple, "Gitleaks" indique l'outil utilisé pour détecter les informations sensibles dans le dépôt. Chaîne N/A
findings Un tableau d'objets contenant des détails sur les détections de sécurité identifiées par l'analyseur. Chaque détection représente un problème spécifique détecté dans le dépôt. Tableau[Objet] N/A
findings[].finding_id Un identifiant unique pour la détection spécifique, représenté sous forme de UUID. Chaîne N/A
findings[].finding_url Une URL menant au tableau de bord Boost où la détection peut être consultée en détail. Fournit un accès direct au contexte de la détection dans l'interface de Boost. Chaîne N/A
findings[].state L'état actuel de la détection, indiquant si elle est nouvelle, résolue ou dans un autre statut. Exemple : "new". Chaîne N/A
findings[].timestamp L'horodatage lorsque la détection a été identifiée, formatée en ISO 8601 (ex. "2025-07-29T19:28:51.213098Z"). Chaîne N/A
findings[].analyzer_rule Un objet décrivant la règle violée, qui a déclenché la détection. Il inclut les métadonnées sur la règle et ses classifications. Objet N/A
findings[].analyzer_rule.name Le nom de la règle violée, ex. "generic-api-key" pour des détections liées à des clés API exposées. Chaîne Règles BoostSecurity
findings[].analyzer_rule.description Une description de la règle, expliquant la nature de la violation, ex. l'exposition d'informations sensibles comme une clé API Générique à des acteurs non autorisés. Chaîne Règles BoostSecurity
findings[].analyzer_rule.labels Un tableau d'objets étiquettes qui catégorisent la règle pour le filtrage et la priorisation, offrant un contexte supplémentaire comme les classifications de conformité ou de gravité. Tableau[Objet] N/A
findings[].analyzer_rule.labels[].name L'identifiant de l'étiquette, ex. "ALL", "boost-baseline", ou "cwe-200". Chaîne Varie (voir ci-dessous pour des références spécifiques)
findings[].analyzer_rule.labels[].pretty_name Une version lisible de l'étiquette, ex. "All", "Baseline BoostSecurity", ou "CWE-200 - Exposition d'Informations Sensibles". Chaîne Varie (voir ci-dessous pour des références spécifiques)
findings[].analyzer_rule.labels[].doc_ref Une URL menant à la documentation pour l'étiquette, fournissant plus de détails sur la règle ou la norme, ex. règles BoostSecurity, définitions CWE, ou OWASP Top 10. Exemples incluant des liens vers CWE-200, CWE-522, CWE-798, CWE Top 25, et OWASP Top 10. Chaîne Règles BoostSecurity, CWE-200, CWE-522, CWE-798, CWE Top 25, OWASP Top 10
findings[].confidence Le niveau de confiance de la détection, indiquant la probabilité qu'elle soit exacte. Exemple : "medium". Chaîne N/A
findings[].severity Le niveau de gravité de la détection, indiquant son impact potentiel. Exemple : "warning". Chaîne N/A
findings[].details Un objet contenant des détails spécifiques sur la détection, comme le type de problème, sa localisation dans le code, et sa validité. Objet N/A
findings[].details.type Le type de problème détecté, ex. "generic-api-key" pour une clé API exposée. Chaîne N/A
findings[].details.validity Le statut de validité de la détection, indiquant si le problème est confirmé, inconnu, ou invalide. Exemple : "unknown". Chaîne N/A
findings[].details.critical_service_secret Un booléen indiquant si la détection concerne un secret de service critique. Exemple : false. Booléen N/A
findings[].details.location Le fichier ou la ressource où le problème a été détecté, ex. "config.ini". Chaîne N/A
findings[].details.start_line_number Le numéro de ligne de début dans le fichier où le problème a été trouvé. Exemple : 1. Entier N/A
findings[].details.start_column_number Le numéro de colonne de début sur la ligne où le problème a été trouvé. Exemple : 1. Entier N/A
findings[].details.end_line_number Le numéro de ligne de fin dans le fichier où le problème a été trouvé. Exemple : 1. Entier N/A
findings[].details.end_column_number Le numéro de colonne de fin sur la ligne où le problème a été trouvé. Exemple : 108. Entier N/A
findings[].code_link Un objet contenant une référence à l'emplacement spécifique du code où le problème a été trouvé, y compris un lien cliquable. Objet N/A
findings[].code_link.text La description textuelle de l'emplacement du code, ex. "config.ini#L1". Chaîne N/A
findings[].code_link.href Une URL menant à la ligne spécifique dans le dépôt où le problème a été détecté, ex. un lien de fichier GitHub. Chaîne Documentation GitHub
findings[].suppressions Un tableau de règles de suppression appliquées à la détection, le cas échéant. Un tableau vide ([]) indique aucune suppression. Tableau N/A
findings[].is_critical_risk Un booléen indiquant si la détection est classée comme un risque critique. Exemple : false. Booléen N/A
findings[].critical_risk_justification_text Une explication textuelle justifiant le statut de risque critique, le cas échéant. null si ce n'est pas un risque critique. String/Null N/A
findings[].remediation Étapes recommandées pour résoudre la détection, par ex. supprimer les données sensibles du dépôt et de son historique Git. Inclut un lien vers la documentation pertinente de GitHub pour plus de guidance. Chaîne GitHub : Suppression de Données Sensibles
organization_name Le nom de l'organisation associée au dépôt, ex. "FranckBoostOrg". Chaîne N/A
scm_provider Le fournisseur de gestion de contrôle de source hébergeant le dépôt, ex. "github". Chaîne N/A
base_url L'URL de base pour le dépôt ou le service, le cas échéant. null si non fourni. Chaîne/Null N/A
repository_name Le nom du dépôt où le problème a été détecté, ex. "multi". Chaîne N/A
asset_attributes Attributs supplémentaires ou métadonnées sur le dépôt ou l'actif, le cas échéant. null si non fourni. Objet/Null N/A