Configurer les préférences
Pour configurer les préférences afin d'ajuster finement votre instance GitGuardian, naviguez vers Settings > General > Preferences.
Veuillez faire attention, certaines préférences vous permettent d'activer des fonctionnalités en mode bêta. En cas de doute, veuillez demander conseil à l'équipe GitGuardian.
Tableau des préférences
Général
| Préférence | Valeur par défaut | Description |
|---|
token_expire_in_days | 7 | Durée de vie, en jours, des invitations et des liens de réinitialisation de mot de passe |
presence_check_enabled | true | Activer la vérification de présence des secrets. Pour plus d'informations, veuillez consulter la page Examiner les incidents |
presence_check_display_enabled | true | Activer l'affichage des vérifications de présence des secrets |
background_presence_check_enabled | true | Activer la vérification automatique de présence des secrets dans les tâches en arrière-plan |
validity_check_enabled | true | Activer la vérification de validité des secrets |
background_validity_check_enabled | true | Activer la vérification automatique de validité des secrets dans les tâches en arrière-plan |
validity_check_for_invalid_secrets_enabled | true | Indique s'il faut inclure les secrets invalides dans les vérifications périodiques de validité (utile car certains secrets peuvent être temporairement invalides). Désactivez pour réduire la charge sur les workers. |
SAML SSO
Pour plus d'informations, veuillez consulter la page SAML SSO.
| Préférence | Valeur par défaut | Description |
|---|
use_model_signature_settings | true | Activer la configuration manuelle des exigences de signatures SAML |
is_custom_nameid_format_enabled | false | Activer le choix du format NameID |
Bitbucket
Pour plus d'informations, veuillez consulter la documentation d'intégration Bitbucket.
| Préférence | Valeur par défaut | Description |
|---|
min_delay_between_syncs | 60 | Délai minimum, en minutes, entre deux synchronisations consécutives d'une installation Bitbucket |
auth_error_grace_period | 0 | Période minimum, en minutes, d'erreurs d'authentification répétées après laquelle un token doit être révoqué |
On Premise
| Préférence | Valeur par défaut | Description |
|---|
bitbucket_disable_admin_check | false | Désactiver la vérification Admin de l'intégration Bitbucket lors de la création de l'intégration |
prometheus_metrics_active | false | Activer l'exportateur de métriques Prometheus sur /metrics. Pour plus d'informations, veuillez consulter la page des métriques applicatives |
custom_telemetry_active | true | Activer l'envoi de métriques de télémétrie à GitGuardian |
tls_client_force_second_factor_auth | false | Option d'authentification multi-facteurs pour l'authentification basée sur certificat |
version_update_notifications_active | true | Activer les notifications de mise à jour de version (carte de barre latérale, page de licence et alertes e-mail) |
support_bundle_admin_area_enabled | true | Activer la génération et l'upload d'un bundle de support depuis l'Admin Area. Pour plus d'informations, veuillez consulter la page Support. |
Notifier
Pour plus d'informations, veuillez consulter la page Custom webhook.
| Préférence | Valeur par défaut | Description |
|---|
max_webhooks_per_integration_type | 1000 | Nombre maximum de webhooks configurés par type d'intégration |
Source Scanner (VCS)
Pour plus d'informations, veuillez consulter la page sur le scan historique.
| Préférence | Valeur par défaut | Description |
|---|
minutes_between_scans_per_source | 0 | Minutes minimum entre deux scans sur la même source. (0 = désactivé) |
vcs_clone_fetch_all_refs_enabled | true | Récupère toutes les références que le remote expose pendant les scans historiques (refs de pull/merge request, Git notes, refs keep-around GitLab, refs de change Gerrit, etc.) en plus des branches et tags standards. Pour plus d'informations, veuillez consulter la page sur le scan historique. |
Intégrations de sources
Pour plus d'informations, veuillez consulter la documentation d'intégration Gerrit.
| Préférence | Valeur par défaut | Description |
|---|
is_gerrit_enabled | false | Activer l'intégration Gerrit (bêta). |
is_gerrit_historical_scan_enabled | false | Activer les scans historiques sur les sources Gerrit (bêta). |
Source Scanner
| Préférence | Valeur par défaut | Description |
|---|
servicenow_data_source_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources ServiceNow. |
aws_ecr_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources Amazon ECR. |
azure_cr_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources Azure Container Registry. |
google_artifact_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources Google Artifact Registry. |
docker_hub_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources Docker Hub. |
jfrog_artifact_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources JFrog Container Registry. |
microsoft_teams_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources Microsoft Teams. |
microsoft_teams_recurrent_scan_window | 1209600 | Fenêtre temporelle, en secondes, pour les scans récurrents Microsoft Teams. |
jfrog_package_registry_recurrent_scan_interval | 28800 | Secondes minimum entre deux scans récurrents sur les sources JFrog Package Registry. |
red_hat_quay_recurrent_scan_interval | 172800 | Secondes minimum entre deux scans récurrents sur les sources Red Hat Quay. |
sharepoint_online_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources SharePoint Online. |
microsoft_onedrive_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources Microsoft OneDrive. |
confluence_cloud_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources Confluence Cloud. |
jira_cloud_recurrent_scan_interval | 21600 | Secondes minimum entre deux scans récurrents sur les sources Jira Cloud. |
Container Registries
| Préférence | Valeur par défaut | Description |
|---|
enable_repository_scoped_layers_cache | false | Inclut le nom du dépôt dans les clés de cache des layers pour limiter le cache par dépôt. Cela permet de créer plusieurs occurrences de secret au lieu d'une seule lorsque le même layer avec le même secret est rencontré sur différentes images. |
Politique
| Préférence | Valeur par défaut | Description |
|---|
is_repo_size_controlled | false | Limiter la taille des dépôts pour le scan historique. (supprimé en 2024.9.0) |
repo_scan_size_limit | 1073741824 | Taille maximale du dépôt pour le scan historique, en octets. Pour plus d'informations, veuillez consulter la page suivante. |
repo_scan_pending_limit_in_hours | 168 | Délai d'expiration, en heures, du temps de file d'attente du scan historique d'un dépôt. Pour plus d'informations, veuillez consulter la page suivante. |
repo_scan_time_limit_in_sec | 7200 | Délai d'expiration, en secondes, pour le scan historique d'un dépôt. Pour plus d'informations, veuillez consulter la page suivante. |
maximum_scan_size | 1048576 | Taille maximale du document pour le scan de détection de secrets via l'API, en octets. |
repo_scan_max_commit_length | 1073741824 | Longueur totale maximale d'un commit à scanner, en octets ; les commits plus volumineux sont tronqués (-1 = illimité). |
displayed_content_max_size | 10485760 | Taille maximale du contenu affiché, en octets. Introduit en 2023.11. |
displayed_content_max_lines | 100000 | Nombre maximum de lignes du contenu affiché. Introduit en 2023.11. |
skip_unchanged_scans | True | Ce paramètre permet d'ignorer le scan historique d'un dépôt s'il n'a pas changé depuis le dernier scan. |
API publique
Pour plus d'informations, veuillez consulter notre documentation API.
| Préférence | Valeur par défaut | Description |
|---|
maximum_multifile_documents | 20 | Nombre maximum de fichiers dans un document multi-fichiers pour le scan via l'API |
maximum_token_per_account | 150 | Nombre maximum de clés API autorisées par workspace |
maximum_token_per_member | 5 | Nombre maximum de tokens d'accès personnels autorisés par membre |
quotas | 10000000 | Quotas glissants mensuels pour les appels API (supprimé en 2024.7.0) |
max_page_size | 100 | Borne supérieure du paramètre per_page dans l'API publique qui contrôle le nombre de données retournées dans les endpoints paginés. |
GitHub
Pour plus d'informations, veuillez consulter la documentation d'intégration GitHub.
| Préférence | Valeur par défaut | Description |
|---|
is_actionable_checkrun_enabled | false | Active les boutons d'action sur les checkruns (supprimé en 2024.2.0) |
check_runs_overrides_labels_ghe | false | Active la surcharge des paramètres de check run avec les labels de dépôt sur GitHub Enterprise Server |
enable_check_runs_scans | false | Fonctionne en parallèle de check_runs_skip_too_large_pr. Lorsque les deux feature flags sont activés, GitGuardian exécute des évaluations basées sur le scan pour les check runs dont les pull requests sont trop volumineuses pour l'évaluation basique en temps réel. Les évaluations basées sur le scan reposent sur un git clone et consomment donc beaucoup moins de quota de rate limit. |
check_runs_skip_too_large_pr | false | Ignore l'évaluation en temps réel des check runs lorsque leur pull request est trop volumineuse, afin que les très grandes pull requests ne consomment pas la totalité du quota de rate limit. Utilisé en parallèle des paramètres pr_max_commits_for_check_run, pr_max_files_for_check_run et pr_max_changes_for_check_run. |
disable_check_run_softtimelimit_retry | false | Les check runs ont un temps limité pour terminer leur évaluation en temps réel. Par défaut, une fois ce temps atteint, l'évaluation est relancée avec une limite de temps plus longue, ce qui consomme habituellement beaucoup de quota de rate limit. Activez ce feature flag pour désactiver la nouvelle tentative. |
pr_max_commits_for_check_run | 0 | Seuil de nombre de commits au-dessus duquel le check run est ignoré. Définir à 0 pour désactiver ce seuil. |
pr_max_files_for_check_run | 0 | Seuil de nombre de fichiers mis à jour au-dessus duquel le check run est ignoré. Définir à 0 pour désactiver ce seuil. |
pr_max_changes_for_check_run | 0 | Seuil de nombre de lignes modifiées au-dessus duquel le check run est ignoré. Définir à 0 pour désactiver ce seuil. |
commit_collector_max_workers | 4 | Nombre maximum d'appels par worker pour le collecteur de commits. Un nombre plus élevé rendra la collecte de commits plus rapide, mais est plus susceptible d'atteindre les rate limits GitHub. Valeur attendue entre 1 et 4. |
Health Checks
Pour plus d'informations, veuillez consulter la page Vérifier la santé de l'environnement.
| Préférence | Valeur par défaut | Description |
|---|
periodic_enabled | true | Activer les health checks périodiques. |
periodic_interval | 1h | Supprimé en 2024.7.0, désormais configurable avec spread_periodic_range_minutes. |
spread_periodic_range_minutes | 60 | Intervalle entre deux exécutions des health checks périodiques (en minutes). |
Teams
Pour plus d'informations, veuillez consulter la page des teams.
| Préférence | Valeur par défaut | Description |
|---|
max_teams | 500 | Nombre maximum d'équipes autorisé sur un compte. ⚠️ Dépasser cette limite peut impacter les performances. |
Pour plus d'informations, veuillez consulter la page de suivi de remédiation.
| Préférence | Valeur par défaut | Description |
|---|
scan_after_push_force_rate_limit | 300 | Limite de débit en secondes pour les scans démarrés par le moteur de suivi de fichiers. Appliquée par source, branche et type de scan. |
| Préférence | Valeur par défaut | Description |
|---|
max_custom_tag_keys_per_workspace | 50 | Nombre maximum de clés de tags personnalisés par workspace. Les tags personnalisés oneword comptent comme 1 clé |
max_custom_tag_values_per_key_per_workspace | 50 | Nombre maximum de valeurs de tags personnalisés pour une clé donnée. Les tags personnalisés oneword comptent comme 1 valeur pour la clé oneword |
max_custom_tags_per_resource | 100 | Nombre maximum de tags personnalisés liés à 1 ressource (par ex. honeytoken, incident privé, etc.) |
|
Authentification multi-facteurs
Pour plus d'informations, veuillez consulter la page des paramètres de compte.
| Préférence | Valeur par défaut | Description |
|---|
is_mfa_enabled | false | Activer l'authentification multi-facteurs pour le workspace. |
sudo_mode_duration | 30 | Durée, en minutes, d'une session élevée (sudo) avant qu'une nouvelle authentification soit requise. |
Fréquences de vérification de présence en arrière-plan
Pour plus d'informations, veuillez consulter la page Examiner les incidents.
| Préférence | Valeur par défaut | Description |
|---|
ignored_old | 0 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret ignorés depuis plus d'un an |
ignored_recent | 178 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret ignorés depuis moins d'un an |
open_old | 7 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret ouverts depuis plus d'un an |
open_recent | 1 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret ouverts depuis moins d'un an |
resolved_old | 178 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret résolus depuis plus d'un an |
resolved_recent | 30 | Fréquence, en jours, des vérifications automatisées de présence dans l'historique git pour les incidents de secret résolus depuis moins d'un an |
Fréquences de vérification de validité en arrière-plan
Pour plus d'informations, veuillez consulter la page sur les vérifications de validité.
| Préférence | Valeur par défaut | Description |
|---|
ignored_old | 178 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents ignorés depuis plus d'un an |
ignored_recent | 30 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents ignorés depuis moins d'un an |
open_old | 7 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents ouverts depuis plus d'un an |
open_recent | 1 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents ouverts depuis moins d'un an |
resolved_old | 178 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents résolus depuis plus d'un an |
resolved_recent | 30 | Fréquence, en jours, des vérifications automatisées de validité des secrets pour les incidents résolus depuis moins d'un an |
