Remarque : Secret scanning comme protection de poussée est actuellement en version bêta et peut faire l’objet de modification.
À propos de la protection des poussées pour les secrets
Jusqu’à présent, l’secret scanning vérifie la présence de secrets après une poussée et avertit les utilisateurs des secrets exposés. Lorsque vous activez la protection des poussées, secret scanning vérifie également les poussées des secrets avec un taux de confiance élevé (ceux identifiés avec un taux faible de faux positifs). Secret scanning liste les secrets qu’elle détecte afin que l’auteur puisse passer en revue les secrets et les supprimer ou, si nécessaire, autoriser ces secrets à être poussés.
Si un contributeur contourne un bloc de protection de poussée pour un secret, GitHub :
- crée une alerte sous l’onglet Sécurité du dépôt dans l’état décrit dans le tableau ci-dessous.
- ajoute l’événement de contournement au journal d’audit.
Vous pouvez surveiller les alertes de sécurité pour découvrir quand les utilisateurs contournent les protections de poussées et créent des alertes. Pour plus d’informations, consultez « Audit des alertes de sécurité ».
Ce tableau montre le comportement des alertes pour chaque façon dont un utilisateur peut contourner un blocage de la protection push.
Motif du contournement | Comportement des alertes |
---|---|
Il est utilisé dans des tests | GitHub crée une alerte fermée, résolue comme « utilisé dans des tests » |
C'est un faux positif | GitHub crée une alerte fermée, résolue comme « faux positif » |
Je le corrigerai plus tard | GitHub crée une alerte ouverte |
Pour plus d’informations sur les secrets et fournisseurs de services pris en charge pour la protection par émission de données, consultez « Modèles d’analyse des secrets ».
Activation de l’secret scanning en tant que protection des poussées
Pour pouvoir utiliser l’secret scanning comme protection des poussées, l’organisation ou le dépôt doit avoir à la fois GitHub Advanced Security et l’secret scanning activés. Pour plus d’informations, consultez « Gestion des paramètres de sécurité et d’analyse pour votre organisation », « Gestion des paramètres de sécurité et d’analyse pour votre dépôt » et « À propos de GitHub Advanced Security ».
Les propriétaires d’organisations, les gestionnaires de sécurité et les administrateurs de dépôt peuvent activer la protection des poussées pour l’secret scanning via l’interface utilisateur et l’API. Pour plus d’informations, consultez « Référentiels » et développez la section « Propriétés de l’objet security_and_analysis
» dans la documentation de l’API REST.
Les administrateurs
Activation de l’secret scanning en tant que protection des poussées pour une organisation
Vous pouvez utiliser la pages des paramètres de l’organisation pour « Sécurité et analyse du code » afin d’activer ou de désactiver l’secret scanning comme protection des poussées pour tous les dépôts existants d’une organisation :
-
Sur votre entreprise, accédez à la page principale de l’organisation. 1. Sous le nom de votre organisation, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.
-
Dans la section « Sécurité » de la barre latérale, cliquez sur Sécurité et analyse du code.
-
Sous « Sécurité et analyse du code », recherchez « GitHub Advanced Security ». 1. Sous « Secret scanning », sous « Protection des poussées », cliquez sur Activer tout.
-
Cliquez éventuellement sur « Activer automatiquement pour les référentiels ajoutés à secret scanning ».
Activation de l’secret scanning en tant que protection des poussées pour un dépôt
-
Dans votre entreprise, accédez à la page principale du dépôt. 1. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.
-
Dans la section « Sécurité » de la barre latérale, cliquez sur Sécurité et analyse du code. 1. Sous « Sécurité et analyse du code », recherchez « GitHub Advanced Security ». 1. Sous « Secret scanning », accédez à « Protection des envois » et cliquez sur Activer.
Utilisation de l’analyse des secrets comme protection par émission de données à partir de la ligne de commande
Quand vous tentez de pousser un secret pris en charge vers un dépôt ou une organisation et que l’secret scanning en tant que protection des poussées est activée, GitHub bloque la poussée. Vous pouvez supprimer le secret de votre branche ou suivre une URL fournie pour autoriser l’envoi (push).
Jusqu’à cinq secrets détectés s’affichent à la fois sur la ligne de commande. Si un secret particulier a déjà été détecté dans le dépôt et qu’une alerte existe déjà, GitHub ne bloque pas ce secret.
Si vous confirmez qu’un secret est réel, vous devez supprimer le secret de votre branche, de toutes les validations dans lesquelles il apparaît, avant d’envoyer (push) à nouveau. Pour plus d’informations sur la correction des secrets bloqués, consultez « Envoi d’une branche bloquée par la protection par émission de données ».
Si vous confirmez qu’un secret est réel et que vous avez l’intention de le corriger ultérieurement, vous devez veiller à effectuer la correction dès que possible. Par exemple, vous pouvez révoquer le secret et le supprimer de l’historique des commits du dépôt. Les secrets réels exposés doivent être révoqués pour éviter tout accès non autorisé. Vous pouvez commencer par faire pivoter le secret avant de le révoquer. Pour plus d’informations, consultez « Suppression de données sensibles dans un dépôt ».
Remarques:
- Si votre configuration Git prend en charge les envois vers plusieurs branches, et non seulement vers la branche par défaut, votre envoi peut être bloqué en raison de l’envoi (push) de références supplémentaires et involontaires. Pour plus d’informations, consultez les options
push.default
dans la documentation Git. - Si l’secret scanning à l’occasion de l’expiration d’un envoi (push), GitHub exécute toujours une analyse après l’envoi (push).
Autorisation de la poussée d’un secret bloqué
Si GitHub bloque un secret alors que selon vous sa poussée ne pose pas de problème, vous pouvez autoriser le secret et spécifier la raison pour laquelle il doit être autorisé.
Lorsque vous autorisez un secret à être poussé, une alerte est créée sous l’onglet Sécurité. GitHub ferme l’alerte et n’envoie pas de notification si vous spécifiez que le secret est un faux positif ou qu’il est utilisé uniquement dans les tests. Si vous spécifiez que le secret est bien réel et que vous le corrigerez plus tard, GitHub garde l’alerte de sécurité ouverte et envoie des notifications à l’auteur du commit, ainsi qu’aux administrateurs du dépôt. Pour plus d’informations, consultez « Gestion des alertes à partir de l’analyse des secrets ».
- Visitez l’URL qu’a retournée GitHub quand votre poussée a été bloquée.
- Choisissez l’option qui décrit le mieux la raison pour laquelle vous devez être en mesure de pousser le secret.
- Si le secret est utilisé uniquement dans des tests et ne représente aucune menace, cliquez sur Il est utilisé dans des tests.
- Si la chaîne détectée n’est pas un secret, cliquez sur Il s’agit d’un faux positif.
- Si le secret est réel, mais que vous avez l’intention de le corriger plus tard, cliquez sur Je le corrigerai plus tard.
- Cliquez sur M’autoriser à pousser ce secret.
- Retentez la poussée sur la ligne de commande dans un délai de trois heures. Si vous n’effectuez pas la poussée dans les trois heures, vous devrez répéter ce processus.
Utilisation de l’analyse des secrets comme protection des poussées à partir de l’interface utilisateur web
Quand vous utilisez l’interface utilisateur web pour tenter de commiter un secret pris en charge vers un dépôt ou une organisation avec l’analyse des secrets activée comme protection des poussées, GitHub bloque le commit.
Vous verrez une bannière en haut de la page avec des informations sur l’emplacement du secret, et le secret sera également souligné dans le fichier afin que vous puissiez le trouver facilement.
GitHub n’affiche qu’un secret détecté à la fois dans l’interface utilisateur web. Si un secret particulier a déjà été détecté dans le dépôt et qu’une alerte existe déjà, GitHub ne bloque pas ce secret.
Vous pouvez supprimer le secret du fichier à l’aide de l’interface utilisateur web. Une fois que vous avez supprimé le secret, la bannière en haut de la page change et vous indique que vous pouvez maintenant commiter vos modifications.
Contournement de la protection des poussées pour un secret
Si vous confirmez qu’un secret est réel, vous devez supprimer le secret de votre branche, de toutes les validations dans lesquelles il apparaît, avant d’envoyer (push) à nouveau. Pour plus d’informations sur la correction des secrets bloqués, consultez « Envoi d’une branche bloquée par la protection par émission de données ».
Si vous confirmez qu’un secret est réel et que vous avez l’intention de le corriger ultérieurement, vous devez veiller à effectuer la correction dès que possible. Pour plus d’informations, consultez « Suppression de données sensibles dans un dépôt ».
Si GitHub bloque un secret alors que selon vous sa poussée ne pose pas de problème, vous pouvez autoriser le secret et spécifier la raison pour laquelle il doit être autorisé.
Lorsque vous autorisez un secret à être poussé, une alerte est créée sous l’onglet Sécurité. GitHub ferme l’alerte et n’envoie pas de notification si vous spécifiez que le secret est un faux positif ou qu’il est utilisé uniquement dans les tests. Si vous spécifiez que le secret est bien réel et que vous le corrigerez plus tard, GitHub garde l’alerte de sécurité ouverte et envoie des notifications à l’auteur du commit, ainsi qu’aux administrateurs du dépôt. Pour plus d’informations, consultez « Gestion des alertes à partir de l’analyse des secrets ».
Si vous confirmez qu’un secret est réel et que vous avez l’intention de le corriger ultérieurement, vous devez veiller à effectuer la correction dès que possible.
- Dans la bannière qui s’est affichée en haut de la page quand GitHub a bloqué votre commit, cliquez sur Ignorer la protection.
- Choisissez l’option qui décrit le mieux la raison pour laquelle vous devez être en mesure de pousser le secret.
- Si le secret est utilisé uniquement dans des tests et ne représente aucune menace, cliquez sur Il est utilisé dans des tests.
- Si la chaîne détectée n’est pas un secret, cliquez sur Il s’agit d’un faux positif.
- Si le secret est réel, mais que vous avez l’intention de le corriger plus tard, cliquez sur Je le corrigerai plus tard.
- Cliquez sur Autoriser le secret.