Understand the monitored perimeter
Your perimeter is simply anywhere you are storing your shared code repositories. This includes shared repository hosting like GitHub, GitLab, Bitbucket or Azure Repos.
Your perimeter page has two main objectives:
- Identify which of your sources are at risk
- Ensure that your entire perimeter is well protected by GitGuardian
At the bottom of the right-hand side panel, the scope section gives you a quick summary of the different integrations (VCS types) that have been integrated with GitGuardian, alongside a breakdown of sources per integration.
Differences between historical scanning and real-time protection
The first protection and the most effective one for secrets remediation is the real-time monitoring.
As you may have read in our How GitGuardian works section, real-time monitoring means that every single push event (and its commits) is scanned for secrets as soon as they arrive on your VCS server (post-receive hooks).
We then alert you instantly, which will save you time in the remediation process. Indeed, the longer a secret is exposed, the harder the remediation gets.
On the right-hand side panel, we indicate the percentage of sources covered, based on the number of sources you integrated with GitGuardian. Note that some sources may not be eligible to be monitored because of plan restrictions.
Note that the table of sources displayed on the Perimeter page only contains sources that are monitored in real-time. The sources that are not selected in the integration settings page are not displayed.
For performance reasons, we limit the number of commits scanned per push event. By default, this limit is 1,000 scanned commits/push event, but this can be customized per workspace on demand.
The second type of protection offered is the ability to scan the commit history of all the sources you integrated with GitGuardian.
Size limitations apply to historical scans, depending on your plan:
- Free: you can scan sources up to 1GB,
- Business and trial: you can scan sources up to 12 GB.
Here's a list of potential errors you may encounter during historical scanning:
|The source is unavailable due to a DMCA takedown. Please contact the source owner.
|Access to the repository is disabled
|The source has been disabled. Please contact the source owner.
|Account has been disabled
|The source’s account has been disabled. Please contact the source owner.
|Access to repository restricted by IP
|The source’s account has a configured IP allow list. Please contact the source owner.
|Repository not found
|The source could not be found. Please retry and contact the source owner if it persists.
|Clone operation stuck or too slow
|The connection to the server is slow or stuck. Please contact the VCS administrator.
|VCS not ready or responded with an error
|The server did not respond after multiple attempts. Please contact the VCS administrator.
|Repository disabled in GitLab project
|The git repository in the GitLab project has been disabled. Please enable the “repository” functionality in the settings of your GitLab project.
|The repository has been deleted
|The target repository has been deleted. Please contact the VCS administrator.
|Scan worker error
|The scan failed due to an internal worker error. Please reach out to our support team. If you are running GitGuardian on a self-hosted environment, generate a Support Bundle for troubleshooting purposes.
|VCS authentication error
|The authentication to the VCS has failed. Please contact the VCS administrator.
|The scan failed due to an unknown error. Please reach out to our support team. If you are running GitGuardian on a self-hosted environment, generate a Support Bundle for troubleshooting purposes.
A source is considered as monitored when the GitGuardian platform is listening for any activity on that source.
This is the outcome of:
- successfully integrating GitGuardian with the source
- and having a plan that supports its monitoring.
Monitored sources are listed on the Perimeter page.
No longer monitored source
A source is considered as no longer monitored when the GitGuardian is no longer listening to any activity on that source.
This may be the result of
- uninstalling GitGuardian from the source,
- or excluding the source from the monitored perimeter,
- or a change in your plan that no longer supports this source.
A source that is no longer monitored presents a risk, as no occurrence will be created after a secret has been published in it. Such a source is identified with a striked shield icon next to it.
No longer monitored sources are no longer listed on the Perimeter page.
A source is considered deleted only when GitGuardian receives evidence of its actual deletion. This means that we don't consider a source deleted just because it has been removed from GitGuardian, but rather only when it has been truly erased. Eg: the repository is deleted on GitHub.
Such a source is identified with a bin icon next to it.
Deleted sources are no longer listed on the Perimeter page.
A source is defined by a visibility scope. Depending of the installed instance, a source can be:
public: anyone with access to the Internet can view the contents of this source. Your secret is publicly exposed and presents a higher security risk.
internal(specific to GitLab): internal GitLab projects can be viewed by any authenticated user except external users. Such a GitLab project is identified by a shield icon next to it.
private: Only authorized users with access to the source can view its contents. Such a source is identified by a lock icon next to it.
The source criticality feature enables you to assess and assign a level of importance to your monitored sources, helping you prioritize your incidents effectively. This feature allows you to categorize them as low, medium, high, or critical, or leave it unfilled, based on the potential severity of a security incident's impact. Its value depends on the business context of your source, which will be determined by factors such as the nature of the handled data and its connection to resources in a production environment.
The source criticality parameter can be utilized for prioritizing incidents in both SCA and Infra as Code Security modules.
How can I add new sources to my protected perimeter?
Version Control Systems
- GitHub integration
- GitHub Enterprise integration
- Gitlab integration
- Bitbucket integration
- Azure DevOps Repos integration
Messaging & ChatOps
Troubleshooting connectivity problems
Most often, connectivity problems arise because a firewall, proxy server, corporate network, or other network is configured in a way that blocks GitGuardian.
In case you need to authorize incoming/outgoing connections to/from the SAAS application, this paragraph provides the necessary information.
Allowing GitGuardian's IP addresses
GitGuardian serves the application from the following IP addresses:
These IP addresses are used for:
- VCS integrations (eg: GitHub, GitLab)
- Messaging integrations (eg: Slack)
- Ticketing integrations (eg: Jira Cloud)
- Alerting integrations (eg: Slack)
Allowing GitGuardian's domains
The following domains are used to expose the application:
Note: HTTP is only used to redirect to HTTPS.