Scan data for secrets

GitLab

18min

Configuration
The GitLab integration scans repositories in GitLab. To scan artifacts in GitLab CI, see Scanning in CI﻿ instead.
﻿
Local configuration
Access Token
Basic Auth
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
﻿
Options
Key
Description
Required
endpoint
The URL endpoint for the GitLab server. Defaults to GitLab cloud.
No
repositories
List of repository names to scan in GitLab. Omit to enumerate instead.
No
ignoreRepos
List of repository names to ignore in an organization scan. Supports globbing with *.
No
includeRepos
List of repository names to include in an organization scan. Supports globbing with *.
No
skipBinaries
whether to skip scanning binary files
No
skipArchives
whether to skip scanning archive files
No
Capabilities
Feature
Supported
Scan archive files
✅
Scan archived repos
✅
Scan base64 encoded data
✅
Scan binaries
✅
Exclude Filter
✅
Include Filter
✅
Pre-commit
✅
Pre-receive
✅
Scan Gitlab Actions
✅
Auto resume
✅
Notes:
TruffleHog does not scan diffs > 1 GB
﻿
Configuration
The GitLab integration scans repositories in GitLab. To scan artifacts in GitLab CI, see Scanning in CI﻿ instead.
﻿
Local configuration
Access Token
Basic Auth
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
﻿
Options
Key
Description
Required
endpoint
The URL endpoint for the GitLab server
No
repositories
List of repository names to scan in GitLab. Omit to enumerate instead.
No
ignoreRepos
List of repository names to ignore in an organization scan. Supports globbing.
No
includeRepos
List of repository names to include in an organization scan. Supports globbing.
No
skipBinaries
whether to skip scanning binary files
No
skipArchives
whether to skip scanning archive files
No
Capabilities
Feature
Supported
Scan archive files
✅
Scan archived repos
✅
Scan base64 encoded data
✅
Scan binaries
✅
Exclude Filter
✅
Include Filter
❌
Pre-commit
✅
Pre-receive
✅
Scan Gitlab Actions
✅
Auto resume
✅
Notes:
TruffleHog does not scan diffs > 1 GB
﻿
Configuration
The GitLab integration scans repositories in GitLab. To scan artifacts in GitLab CI, see Scanning in CI﻿ instead.
﻿
Local configuration
Access Token
Basic Auth
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
﻿
Options
Key
Description
Required
endpoint
The URL endpoint for the GitLab server. Defaults to GitLab cloud.
No
repositories
List of repository names to scan in GitLab. Omit to enumerate instead.
No
ignoreRepos
List of repository names to ignore in an organization scan. Supports globbing.
No
includeRepos
List of repository names to include in an organization scan. Supports globbing.
No
skipBinaries
whether to skip scanning binary files
No
skipArchives
whether to skip scanning archive files
No
Capabilities
Feature
Supported
Scan archive files
✅
Scan archived repos
✅
Scan base64 encoded data
✅
Scan binaries
✅
Exclude Filter
✅
Include Filter
✅
Pre-commit
✅
Pre-receive
✅
Scan Gitlab Actions
✅
Auto resume
✅
Notes:
TruffleHog does not scan diffs > 1 GB
﻿
Configuration
The GitLab integration scans repositories in GitLab. To scan artifacts in GitLab CI, see Scanning in CI﻿ instead.
﻿
Local configuration
Access Token
Basic Auth
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
sources:
- connection:
    '@type': type.googleapis.com/sources.GitLab
    endpoint: https://gitlab.ourbusiness.com
    # The GitLab token must be created with the 
    # `read_api` scope.
    token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    skipBinaries: true
  name: GitLab
  scanPeriod: 12h
  type: SOURCE_TYPE_GITLAB
  verify: true
﻿
Options
Key
Description
Required
endpoint
The URL endpoint for the GitLab server
No
repositories
List of repository names to scan in GitLab. Omit to enumerate instead.
No
ignoreRepos
List of repository names to ignore in an organization scan. Supports globbing.
No
includeRepos
List of repository names to include in an organization scan. Supports globbing.
No
skipBinaries
whether to skip scanning binary files
No
skipArchives
whether to skip scanning archive files
No
Capabilities
Feature
Supported
Scan archive files
✅
Scan archived repos
✅
Scan base64 encoded data
✅
Scan binaries
✅
Exclude Filter
✅
Include Filter
❌
Pre-commit
✅
Pre-receive
✅
Scan Gitlab Actions
✅
Auto resume
✅
Notes:
TruffleHog does not scan diffs > 1 GB
﻿

Key	Description	Required
endpoint	The URL endpoint for the GitLab server. Defaults to GitLab cloud.	No
repositories	List of repository names to scan in GitLab. Omit to enumerate instead.	No
ignoreRepos	List of repository names to ignore in an organization scan. Supports globbing with *.	No
includeRepos	List of repository names to include in an organization scan. Supports globbing with *.	No
skipBinaries	whether to skip scanning binary files	No
skipArchives	whether to skip scanning archive files	No

Feature	Supported
Scan archive files	✅
Scan archived repos	✅
Scan base64 encoded data	✅
Scan binaries	✅
Exclude Filter	✅
Include Filter	✅
Pre-commit	✅
Pre-receive	✅
Scan Gitlab Actions	✅
Auto resume	✅

Key	Description	Required
endpoint	The URL endpoint for the GitLab server	No
repositories	List of repository names to scan in GitLab. Omit to enumerate instead.	No
ignoreRepos	List of repository names to ignore in an organization scan. Supports globbing.	No
includeRepos	List of repository names to include in an organization scan. Supports globbing.	No
skipBinaries	whether to skip scanning binary files	No
skipArchives	whether to skip scanning archive files	No

Feature	Supported
Scan archive files	✅
Scan archived repos	✅
Scan base64 encoded data	✅
Scan binaries	✅
Exclude Filter	✅
Include Filter	❌
Pre-commit	✅
Pre-receive	✅
Scan Gitlab Actions	✅
Auto resume	✅

Key	Description	Required
endpoint	The URL endpoint for the GitLab server. Defaults to GitLab cloud.	No
repositories	List of repository names to scan in GitLab. Omit to enumerate instead.	No
ignoreRepos	List of repository names to ignore in an organization scan. Supports globbing.	No
includeRepos	List of repository names to include in an organization scan. Supports globbing.	No
skipBinaries	whether to skip scanning binary files	No
skipArchives	whether to skip scanning archive files	No

Feature	Supported
Scan archive files	✅
Scan archived repos	✅
Scan base64 encoded data	✅
Scan binaries	✅
Exclude Filter	✅
Include Filter	✅
Pre-commit	✅
Pre-receive	✅
Scan Gitlab Actions	✅
Auto resume	✅

Key	Description	Required
endpoint	The URL endpoint for the GitLab server	No
repositories	List of repository names to scan in GitLab. Omit to enumerate instead.	No
ignoreRepos	List of repository names to ignore in an organization scan. Supports globbing.	No
includeRepos	List of repository names to include in an organization scan. Supports globbing.	No
skipBinaries	whether to skip scanning binary files	No
skipArchives	whether to skip scanning archive files	No

Feature	Supported
Scan archive files	✅
Scan archived repos	✅
Scan base64 encoded data	✅
Scan binaries	✅
Exclude Filter	✅
Include Filter	❌
Pre-commit	✅
Pre-receive	✅
Scan Gitlab Actions	✅
Auto resume	✅

Updated 08 Nov 2024

Did this page help you?

Git

GitHub