GitLab Secret Scanning

Prerequisites

Feedback
Create a GitLab Connection with Secret Scanning permissions

Create a GitLab Data Source in Hanzo KMS

1. Navigate to your Secret Scanning Project's Dashboard and click the Add Data Source button.

2. Select the GitLab option.

3. Configure which workspace and repositories you would like to scan. Then click Next.

   • GitLab Connection - the connection that has access to the repositories you want to scan.
   • Scope - the GitLab scope to scan secrets in.
     • Project - scan an individual GitLab project.
     • Group - scan one or more projects belonging to a GitLab group.
   • Scan Repositories - when using Group Scope, select which repositories you would like to scan.
     • All Repositories - Hanzo KMS will scan all repositories associated with your connection.
     • Select Repositories - Hanzo KMS will scan the selected repositories.
   • Auto-Scan Enabled - whether Hanzo KMS should automatically perform a scan when a push is made to configured repositories.

4. Give your data source a name and description (optional). Then click Next.

   • Name - the name of the data source. Must be slug-friendly.
   • Description (optional) - a description of this data source.

5. Review your data source, then click Create Data Source.

6. Your GitLab Data Source is now available and will begin a full scan if Auto-Scan is enabled.

7. You can view repositories and scan results by clicking on your data source.

8. In addition, you can review any findings from the Findings Page.

To create a GitLab Data Source, make an API request to the Create GitLab Data Source API endpoint.

Sample request

curl --request POST \
--url https://us.kms.hanzo.ai/api/v2/secret-scanning/data-sources/gitlab \
--header 'Content-Type: application/json' \
--data '{
    "name": "my-gitlab-source",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "my gitlab data source",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isAutoScanEnabled": true,
    "config": {
        "scope": "project",
        "projectId": 123456789,
        "projectName": "my-group/my-project"
    }
}'

Sample response

{
    "dataSource": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalId": "1234567890",
        "name": "my-gitlab-source",
        "description": "my gitlab data source",
        "isAutoScanEnabled": true,
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "type": "gitlab",
        "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "connection": {
            "app": "gitlab",
            "name": "my-gitlab-app",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "config": {
            "scope": "project",
            "projectId": 123456789,
            "projectName": "my-group/my-project"
        }
    }
}