Créer des tickets Jira à partir des alertes
Une fois Jira connecté, un opérateur transforme une alerte ou un constat de sécurité en ticket Jira en un clic. Le ticket est prérempli avec tout ce que sait Excubius, sa clé est stockée sur l'alerte, et son état est suivi jusqu'à ce qu'il soit terminé. Ce guide explique comment connecter Jira Cloud, comment envoyer chaque client vers son propre projet et ce que contient le ticket.
Avant de commencer
- Un site Jira Cloud. Jira Server et Data Center ne sont pas pris en charge.
- Un compte Atlassian pour Excubius avec ces autorisations dans les projets cibles : Browse projects, Create issues, Add comments et Link issues. Aucun droit d'administration n'est nécessaire : Excubius ne fait jamais changer l'état d'un ticket, ne le modifie pas et ne le supprime pas.
- La fonctionnalité
collab.jiraest activée dans Settings › Instance. Elle nécessitecollab.assign. C'est un super-administrateur qui l'active. - Pour définir des valeurs par défaut pour tout le serveur, vous devez avoir accès à la configuration du serveur. Pour définir les paramètres Jira propres à une entité, vous avez besoin du rôle Entity admin (administrateur d'entité) sur celle-ci.
Il n'existe pas d'écran de paramètres Jira dans la console dans cette version : vous définissez les valeurs par défaut dans la configuration du serveur et les paramètres par entité via l'API.
Choisir comment Excubius se connecte à Jira
auth | Informations d'identification | Quand l'utiliser |
|---|---|---|
token (par défaut) | L'adresse e-mail du compte et un jeton d'API | Le cas habituel : un compte Atlassian dédié avec un jeton d'API |
oauth | L'ID client et le secret client d'un compte de service Atlassian, ainsi que l'ID cloud du site | Votre organisation utilise des comptes de service Atlassian avec les informations d'identification client OAuth 2.0. L'API est alors accessible à l'adresse https://api.atlassian.com/ex/jira/<cloud_id> |
bearer | Un jeton envoyé tel quel | Un jeton d'accès personnel derrière une passerelle |
Trouvez l'ID cloud d'un site à l'adresse https://<site>.atlassian.net/_edge/tenant_info.
Définir les valeurs par défaut sur le serveur
Les valeurs par défaut s'appliquent à chaque entité qui ne définit pas les siennes.
-
Connectez-vous au serveur et prenez l'identité du compte de service avec
sudo -iu excubius. -
Ajoutez les paramètres à
/opt/excubius/.env. Pour l'authentificationtokenpar défaut :JIRA_BASE_URL=https://areito.atlassian.netJIRA_EMAIL=monitoring@areito.exampleJIRA_API_TOKEN=<API token>JIRA_DEFAULT_PROJECT=OPSJIRA_ISSUE_TYPE=TaskPour
oauth, définissezJIRA_AUTH=oauth,JIRA_OAUTH_CLIENT_ID,JIRA_OAUTH_CLIENT_SECRETetJIRA_CLOUD_IDau lieu de l'adresse e-mail et du jeton d'API. -
Redémarrez la plateforme :
export XDG_RUNTIME_DIR=/run/user/$(id -u)systemctl --user restart excubius.service
Envoyer un client vers son propre projet
Chaque entité peut définir elle-même n'importe quelle clé Jira. Le paramètre est hérité dans l'arborescence clé par clé : l'entité la plus proche qui définit une clé l'emporte. Un même site Jira peut ainsi servir tous les clients, chacun avec son propre projet et ses propres informations d'identification.
-
Stockez les informations d'identification Jira sur l'entité : ouvrez Settings › Credentials, choisissez l'entité, par exemple Combray SA, et ajoutez des informations d'identification de type HTTP user and password (l'adresse e-mail et le jeton d'API, ou l'ID client et le secret OAuth) ou Bearer token. Le secret est stocké chiffré et n'est plus jamais affiché.
-
Définissez les clés de l'entité via l'API.
$BASEvauthttps://<your server>/api/v1etHcontient votre jeton, comme dans Démarrage rapide : ajouter une instance SQL Server avec l'API :curl -s "${H[@]}" -X PUT "$BASE/entities/$CIGUAPA/jira" -d '{"project_key": "CIG", "issue_type": "Task","credential_id": "'"$JIRA_CRED"'", "labels": ["monitoring"]}' -
Vérifiez ce qui s'applique et d'où provient chaque clé. La réponse indique si l'entité est
configuredet, dans le cas contraire, ce qui manque dansproblem:curl -s "${H[@]}" "$BASE/entities/$CIGUAPA/jira" | jq '{configured, problem, effective, sources}' -
Testez la connexion. Le test se contente de lire : l'identité des informations d'identification dans Jira, le projet et ses types de tickets.
curl -s "${H[@]}" -X POST "$BASE/entities/$CIGUAPA/jira/test"
Pour rétablir la valeur héritée d'une clé, envoyez-la avec la valeur null. DELETE /entities/{id}/jira supprime toutes les clés propres à l'entité.
| Clé | Valeur par défaut | Signification |
|---|---|---|
base_url | JIRA_BASE_URL | https://<site>.atlassian.net |
auth | JIRA_AUTH, token si non défini | token, oauth ou bearer |
credential_id | L'adresse e-mail et le jeton, ou le client OAuth, de la configuration du serveur | Des informations d'identification de cette entité ou d'un ancêtre : HTTP user and password pour token et oauth, Bearer token pour bearer |
cloud_id | JIRA_CLOUD_ID | Pour oauth uniquement |
project_key | JIRA_DEFAULT_PROJECT | Destination des tickets, par exemple OPS |
issue_type | JIRA_ISSUE_TYPE, Task si non défini | Le nom du type de ticket dans ce projet |
priority_map | critical → High, warning → Medium, info → Low | Correspondance entre gravité et nom de priorité Jira |
labels | Aucune | Étiquettes supplémentaires, sans espaces |
summary_prefix | Le nom du produit entre crochets | Texte placé avant le résumé ; un texte vide pour n'en mettre aucun |
sync | true | Suivre l'état du ticket |
done_comment | true | Commenter le ticket lorsqu'il est terminé, en indiquant si la condition est toujours détectée |
resolve_events_on_done | true | Résoudre les alertes d'événement, comme une modification des membres d'un groupe privilégié, lorsque leur ticket est terminé |
Créer un ticket
- Dans Alert inbox, sélectionnez l'alerte. Pour un constat de sécurité, ouvrez-le sur la page Security posture.
- Sélectionnez Create Jira ticket. Vous avez besoin du rôle Operator (opérateur) ou d'un rôle supérieur.
Excubius confirme Jira ticket OPS-123 created et stocke la clé sur l'alerte, où tout le monde la voit. Une alerte a au plus un ticket : une nouvelle demande renvoie la clé existante.
Le ticket contient :
- Summary (résumé) : le préfixe, le titre de l'alerte et la ressource.
- Description : la gravité, la catégorie et l'état ; la première et la dernière détection ; la ressource avec le chemin de son entité, sa criticité, ses étiquettes et des détails d'identification comme l'hôte, la version et le groupe de disponibilité ; la valeur de la vérification comparée au seuil et l'endroit où ce seuil est défini ; pour un constat, ses preuves ; la référence de la base de référence ; les dix derniers événements de la chronologie ; l'action suggérée, signalée comme une suggestion ; et des liens vers l'alerte et la ressource.
- Labels (étiquettes) : le nom du produit, la catégorie (
alert,finding,advisory), la gravité et vos étiquettes supplémentaires. - Priority (priorité) : déduite de la gravité via
priority_map. Lorsque le projet n'accepte pas de priorité, le ticket est créé sans priorité. - Un lien sur le ticket vers l'alerte.
Suivre l'état du ticket
Toutes les 10 minutes, Excubius lit l'état de 100 tickets ouverts au maximum, en commençant par ceux vérifiés le moins récemment. JIRA_SYNC_MINUTES modifie l'intervalle. Lorsqu'un ticket atteint un état de la catégorie Done :
- La chronologie de l'alerte l'enregistre.
- Une alerte d'événement, comme une modification des membres de
sysadmin, est résolue : la modification a été examinée. - Les autres alertes ne sont pas résolues par le ticket. Elles se résolvent lorsque la vérification suivante ne détecte plus la condition, et le commentaire sur le ticket indique si elle est toujours détectée.
Un jeton expiré ou un ticket supprimé est enregistré et retenté lors de la synchronisation suivante. Le ticket n'est plus suivi une fois terminé.
Limitations
- L'état est obtenu par interrogation ; les webhooks Jira vers Excubius ne sont pas encore utilisés.
- OAuth 2.0 correspond au flux d'informations d'identification client d'un compte de service Atlassian. OAuth par utilisateur n'est pas pris en charge.
- Jira Server et Data Center ne sont pas pris en charge.