Aller au contenu principal

Exigences réseau

Selon la méthode d'installation, vous aurez certaines exigences réseau, même pour les environnements Airgap.

Prise en charge d'IPv6

GitGuardian Self-Hosted prend en charge les réseaux IPv4, IPv6 et dual-stack. Pour plus de détails, consultez Réseau IPv6.

Services et composants​

GitGuardian utilise différents composants pour son fonctionnement :

  • Nginx : serveur web,
  • Celery : gestionnaire de files d'attente et de tâches,
  • Django : framework utilisé pour l'application,
  • PostgreSQL : base de données,
  • Redis : gestionnaire de cache,
  • Replicated : console de gestion (KOTS admin et Replicated SDK).

Services and components

Après avoir installé l'application GitGuardian, vous verrez différents pods créés sur votre cluster Kubernetes.

Pour des informations détaillées sur les noms, types et utilisations des déploiements/pods, consultez la page Topologie de l'application GitGuardian.

Accès externe​

Les domaines à mettre en liste blanche et les ports à ouvrir ci-dessous sont spécifiques à l'installation, à la mise à niveau et à l'utilisation de l'application et de sa gestion.

Assurez-vous que les règles pertinentes sont correctement appliquées à votre pare-feu.

Règles entrantes​

Pour que vous puissiez communiquer avec l'application GitGuardian, certains ports entrants doivent être ouverts.

ProtocolePortSourceDestinationDescription
TCP4430.0.0.0Tous les nœuds K8SPoint d'entrée HTTPS GitGuardian
TCP88000.0.0.0Tous les nœuds K8SKOTS Admin Console

Note : La KOTS Admin Console ne s'applique pas lors de l'utilisation de la méthode d'installation Helm.

La source est basée sur la politique d'accès aux services du client. Par exemple, la KOTS Admin Console peut être limitée à certaines IP internes pour empêcher l'accès public.

Nous recommandons de rejeter tout le trafic entrant à l'exception des ports listés ci-dessus.

Règles sortantes​

Pour que l'application GitGuardian puisse communiquer avec des services externes, certains ports sortants doivent être ouverts.

Si vous utilisez un proxy HTTP, vous devrez peut-être également configurer votre proxy pour autoriser le trafic vers les domaines suivants.

ProtocolePortSourceDestinationDescription
TCP443Tous les nœuds K8S*.replicated.comReplicated Registry et Proxy
TCP443Tous les nœuds K8Sreplicated.appReplicated API
TCP443Tous les nœuds K8S*.docker.ioRegistry Docker hub (auth & pull)
TCP443Tous les nœuds K8Sproduction.cloudflare.docker.comRegistry Docker hub

Note : La registry Docker hub ne s'applique pas lors de l'utilisation de la méthode d'installation Helm.

Embedded cluster legacy (kURL) (instances installées en 2024 ou avant)​

Si vous utilisez la méthode d'installation Embedded, il y a quelques ports supplémentaires à ouvrir.

ProtocolePortSourceDestinationDescription
TCP443Tous les nœuds K8Sk8s.kurl.shInstallateur K8S kurl Replicated
TCP443Tous les nœuds K8Ss3.kurl.sh, kurl.shInstallateur kurl Replicated
TCP443Tous les nœuds K8Skurl-sh.s3.amazonaws.comRessources de l'installateur kurl Replicated

Replicated maintient une liste à jour des adresses IP associées à ces domaines.

  • Pour la plage d'adresses IP de k8s.kurl.sh, consultez replicatedhq/ips sur GitHub.
  • La plage d'adresses IP de s3.kurl.sh est la même que celle du domaine kurl.sh. Pour la plage d'adresses IP de kurl.sh, consultez replicatedhq/ips sur GitHub.
  • Les ressources de l'installateur kurl (packages tar.gz) sont téléchargées depuis Amazon S3 lors des installations avec kURL. Pour plus d'informations sur la récupération dynamique des plages IP à autoriser pour accéder à ces packages, consultez AWS IP address ranges dans la documentation AWS.
remarque

Selon vos intégrations et paramètres, des domaines ou plages IP supplémentaires peuvent devoir être mis en liste blanche et/ou autorisés dans votre proxy HTTP si vous en utilisez un.

Voici une liste de fonctionnalités qui effectueront des requêtes sortantes :

  • Honeytoken
  • Public Monitoring
  • Catalogue de plugins Endpoint Protection
  • Vérificateurs de validité des secrets
  • Intégrations VCS (GitHub, GitHub Enterprise Server, GitLab, Bitbucket...)
  • Intégrations de messagerie (Slack, Microsoft Teams...)
  • Intégrations de documentation (Confluence...)
  • Notificateurs externes (Slack, Jira...)
  • Notificateur webhook personnalisé
  • Notifications par e-mail (SMTP ou Sendgrid)

Catalogue de plugins Endpoint Protection​

Votre instance télécharge le plugin Endpoint Protection depuis le dépôt de plugins GitGuardian. ggshield récupère le plugin depuis votre instance, et non depuis ce dépôt.

ProtocolePortSourceDestinationDescription
TCP443Tous les nœuds K8Ssatori-repository.gitguardian.comDépôt de plugins GitGuardian

Votre instance se connecte à cet hôte :

  • Toutes les 10 minutes, pour rechercher de nouvelles versions de plugins. Elle ne le fait que si votre licence inclut Endpoint Protection et qu'un ou plusieurs workspaces ont le catalogue de plugins activé.
  • Chaque fois qu'un utilisateur exécute ggshield plugin install.

Votre instance ne télécharge que des fichiers. Elle n'envoie aucune donnée de workspace ni aucune donnée utilisateur.

Pour arrêter ces connexions, réglez Settings > Workspace > Endpoints > Enable the ggshield plugin catalog for this workspace sur off. Puis installez le plugin à partir d'un fichier.

remarque

Avant la version 2026.11, votre instance se connecte à cet hôte toutes les 10 minutes, même si aucun workspace n'utilise de plugins. Si vous n'utilisez pas Endpoint Protection, vous pouvez bloquer cet hôte. Votre instance consigne alors une erreur à chaque connexion.

Exemple de reverse proxy Nginx pour une installation embedded​

Si vous souhaitez configurer un reverse proxy devant votre installation embedded, vous devez configurer et transmettre correctement l'en-tête SNI.

Voici un exemple de configuration pour un hôte virtuel Nginx. external_gitguardian_hostname est le nom d'hôte à utiliser dans un navigateur pour accéder au dashboard, et internal_gitguardian_hostname est le nom d'hôte utilisé pour joindre l'instance GitGuardian en interne depuis le reverse proxy. C'est également le nom d'hôte configuré dans la KOTS Admin Console.

server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name external_gitguardian_hostname;

ssl_certificate /path/to/fullchain.pem;
ssl_certificate_key /path/to/privkey.pem;

set $target_host internal_gitguardian_hostname;

location / {
proxy_set_header Host $target_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

proxy_pass https://$target_host;
proxy_read_timeout 60;
proxy_ssl_name $target_host;
proxy_ssl_server_name on;
proxy_ssl_protocols TLSv1.2 TLSv1.3;
proxy_ssl_session_reuse off;
}
}

Exemples d'architecture​

Voici quelques exemples d'architecture qui peuvent vous aider à installer et configurer votre environnement GitGuardian.

Réseau interne​

Internal network graph

Si vous disposez d'un réseau interne derrière un pare-feu, vous pouvez facilement vous connecter à un VCS interne (par exemple : GitLab self-hosted).

Cependant, si vous souhaitez vous connecter à github.com, ce qui nécessite donc un accès internet, vous devrez ouvrir largement l'accès entrant au port HTTPS de votre instance GitGuardian.

remarque

Il est possible de restreindre le trafic aux adresses IP de github.com, mais cela n'est pas recommandé par GitHub. Vous pouvez utiliser un pare-feu applicatif web (WAF) ou un proxy pour surveiller de près le trafic entrant sur l'instance GitGuardian.

Dans ce scénario, l'instance GitGuardian a besoin d'un port de sortie 443 ouvert pour obtenir les mises à jour.

Réseau interne avec DMZ​

DMZ network graph

Si, en plus d'un réseau interne, vous disposez d'une DMZ et que vous souhaitez vous intégrer à github.com, vous pouvez placer l'instance GitGuardian dans la DMZ. Cela facilite l'accès à github.com mais vous devrez exposer votre VCS interne en dehors de votre réseau interne afin que l'instance GitGuardian puisse y accéder.

Dans ce scénario, GitGuardian a besoin d'un port de sortie 443 ouvert pour obtenir les mises à jour.

Réseau isolé​

GitGuardian propose une solution entièrement hors ligne, garantissant que vos données restent à tout moment dans votre environnement.

Isolated network graph

Dans ce scénario, l'instance GitGuardian est complètement isolée d' Internet. Elle est hors ligne et airgapped. Cela signifie qu'aucune surveillance de github.com n'est possible, et Public Monitoring ne peut pas fonctionner non plus, car cela nécessite un accès sortant au service Public Monitoring de GitGuardian. Cela signifie également que vous n'avez pas besoin d'un port de sortie 443 ouvert pour obtenir les mises à jour.

Pour plus de détails sur l'installation de GitGuardian dans un environnement airgap, consultez notre guide d'installation.

info

Cette fonctionnalité Airgap n'est pas disponible par défaut. Veuillez contacter votre représentant commercial si vous souhaitez l'activer.