Jira Data Center
GitGuardian fournit une intégration avec Jira Data Center pour permettre aux utilisateurs de synchroniser leurs incidents GitGuardian avec les issues Jira Data Center. Cette intégration vise à simplifier les processus de remédiation d'incidents et à renforcer l'alignement avec votre Software Development Lifecycle (SDLC).
Bénéfices
Cette fonctionnalité simplifie le processus de création d'issues à partir des incidents GitGuardian :
- Supporte la création d'issues manuelle et automatique lors de la détection d'incident.
- Permet la création d'issues directement dans le projet Jira lié à l'équipe GitGuardian.
- Fournit des templates personnalisables qui utilisent les champs personnalisés Jira et les variables GitGuardian pour des descriptions d'issues sur mesure.
- Inclut une fonctionnalité d'auto-resolve qui ferme automatiquement les incidents GitGuardian lorsque les issues Jira correspondantes sont résolues.
Prérequis
Pour créer des tickets Jira, des permissions d'utilisateur classiques suffisent. Les privilèges Administrator sur le site Jira Data Center ne sont requis que pour configurer la fonctionnalité de synchronisation bidirectionnelle Auto-resolve.
La version minimum supportée est Jira Data Center 9.1.
Installation
- Assurez-vous d'être connecté en tant qu'administrateur sur le site Jira Data Center que vous voulez installer
- Allez sur la page Profile
- Allez dans la section Personal Access Tokens et cliquez sur Create token pour créer un nouveau PAT
- Fournissez un Token Name, une Expiry date optionnelle et cliquez sur Create
- Copiez votre nouveau PAT et cliquez sur Close
- L'intégration est disponible dans les paramètres sous Integrations > Destinations. Elle se trouve dans la section Issue Tracking en bas de la page. Faites attention à ne pas la confondre avec l'intégration Jira Data Center pour le secret scanning.
- Collez votre Jira Data Center site URL, votre Administrator Personal Access Token et cliquez sur Add
Jira permet la création de jusqu'à 10 PATs. GitGuardian renouvelle automatiquement les PATs avant qu'ils n'expirent. Pour cela, vous devez avoir au moins 2 emplacements de PAT libres. Sinon, un message d'erreur vous avertira que l'intégration n'est plus fonctionnelle.
Sélection des projets
Sélectionnez les projets Jira à synchroniser.
- Choisissez uniquement les projets nécessaires à GitGuardian.
- Évitez de créer des listes de projets trop longues afin de simplifier la sélection lors de la création manuelle d'issues.
- Évitez les issues dans des projets sans rapport en affinant le choix des projets.
Création de templates et configuration de Jira pour les équipes
L'intégration vous permet de créer des templates pour la création automatique d'issues, adaptés à votre plan de workspace :
- Utilisateurs Free Plan : un template applicable à tous les incidents.
- Utilisateurs Business Plan : créez plusieurs templates, chacun assigné à des équipes spécifiques.
Les templates s'appliquent automatiquement aux nouveaux incidents. Un template spécifique à une équipe est utilisé uniquement pour les incidents liés à cette équipe. Pour appliquer un template à tous les incidents, associez-le à l'équipe « All-incidents ».
Fonctionnement des templates
Les templates sont automatiquement générés en fonction du template Jira défini pour le type d'issue sélectionné.
- Champs requis : clairement marqués comme obligatoires dans le template GitGuardian.
- Champs optionnels : peuvent être ajoutés au besoin.
- UI dynamique : s'ajuste automatiquement en fonction du type de chaque champ.
Bonne pratique : définissez l'assigné par défaut dans chaque projet Jira sur le team lead ou le security champion. Cela permet aux tickets de GitGuardian d'arriver directement chez la bonne personne, qui pourra ensuite les réassigner au bon développeur lors du sprint planning ou du triage. Vous pouvez configurer cela dans Project settings > Details dans Jira. En savoir plus sur la définition des assignés par défaut dans la documentation officielle Jira.
Variables GitGuardian
Lors de la configuration des templates, vous pouvez insérer des variables GitGuardian dans les champs Title et Description. Ces variables sont remplacées dynamiquement par des valeurs spécifiques à l'incident lors de la création de l'issue Jira.
Variables disponibles dans le champ Title :
| Variable | Description |
|---|---|
{sourceName} | Nom de la source où le secret a été détecté |
{sourceType} | Type de source (par exemple, dépôt Git, Jira, Confluence) |
{secretType} | Type de secret détecté (par exemple, AWS Keys, GitHub Token) |
{incidentId} | Identifiant unique de l'incident GitGuardian |
{fileName} | Nom du fichier contenant le secret |
{lineNumber} | Numéro de ligne où le secret a été trouvé |
Variables disponibles dans le champ Description :
| Variable | Description |
|---|---|
{sourceName} | Nom de la source où le secret a été détecté |
{sourceType} | Type de source (par exemple, dépôt Git, Jira, Confluence) |
{secretType} | Type de secret détecté (par exemple, AWS Keys, GitHub Token) |
{locationUrl} | URL directe vers la localisation du secret dans la source |
{incidentUrl} | URL vers la page d'incident dans le tableau de bord GitGuardian |
{incidentId} | Identifiant unique de l'incident GitGuardian |
{fileName} | Nom du fichier contenant le secret |
{lineNumber} | Numéro de ligne où le secret a été trouvé |
Utilisez les variables pour créer des templates informatifs. Par exemple :
- Titre :
A new {secretType} vulnerability has been found - Description :
A secret of type {secretType} has been detected in your {sourceType} "{sourceName}". Link to the secret: {locationUrl}
Champs Jira personnalisés supportés
L'intégration supporte les champs Jira personnalisés suivants :
- Champs de sélection : choix unique/multiple, boutons radio, cases à cocher
- Date & labels : sélecteur de date, labels
- Champs texte : une ligne, multi-lignes
- Champs numériques : nombres (ou flottants)
- Champs spéciaux : champ URL, sélecteur d'utilisateur (utilisateur unique), sélecteurs de groupe (groupe unique), priorité
Pour les champs non supportés, contactez notre équipe support.
Étapes pour créer un template
-
Commencez par ajouter une intégration à l'équipe désirée.
-
Choisissez le projet Jira et le type d'issue correspondant pour le template.
-
Ajustez les champs au besoin et sauvegardez le template en cliquant sur Add Integration.
-
Visualisez le template configuré sous l'équipe sélectionnée, y compris son association avec le projet Jira choisi.
Fonctionnalités supplémentaires
Mise à jour des issues
Par défaut, les mises à jour des incidents GitGuardian (par exemple, changements de statut, commentaires, changements de sévérité) sont ajoutées comme commentaires aux issues Jira. Cette fonctionnalité peut être désactivée.
Affectation automatique
Lorsqu'elle est activée, les tickets sont automatiquement assignés à l'auteur de l'incident si son email correspond à un utilisateur Jira. Si aucune correspondance n'est trouvée, le ticket reste non assigné. Cette fonctionnalité ne fonctionne que pour la création automatique de tickets. L'assigné défini manuellement dans les templates prévaut sur cette fonctionnalité d'affectation automatique. Si aucune des deux ne s'applique, l'assigné par défaut du projet Jira sera utilisé.
Auto-resolve
Lorsqu'elle est activée, spécifiez le statut Jira qui déclenche la fermeture automatique des incidents associés. L'incident sera marqué comme résolu lorsque l'issue Jira atteindra le statut défini.
Note : la réouverture d'issues Jira ne rouvrira pas les incidents.
Création manuelle d'issue
Il est possible de créer manuellement des tickets Jira pour les incidents qui ont été créés avant que l'intégration Jira/GitGuardian ne soit configurée pour créer automatiquement des tickets pour les nouveaux incidents. Les utilisateurs peuvent le faire depuis la page d'incident ou depuis la page liste des incidents, à condition qu'un template soit assigné à l'équipe de l'utilisateur.
L'issue Jira sera accessible depuis la page d'incident.
La création d'issues en masse n'est pas supportée.
Désinstallation
- Naviguez vers Settings > Integrations > Destinations > Jira Data Center.
- Cliquez sur Delete dans le panneau de configuration du site.
- Confirmez la suppression dans GitGuardian.
Dépannage
Si la création d'issue échoue, vérifiez :
- Les permissions de l'utilisateur d'intégration Jira.
- L'existence des projets/types d'issues dans les templates.
- Les champs obligatoires ajoutés aux projets Jira après la création du template.
- Les champs dans les templates qui ont été supprimés de Jira.
Pour de l'aide, contactez le support.
