Miccah
ab5dd03ee0
* Update linter to disallow assigning SecretParts later This means all detectors.Result objects must be created with the SecretParts field set. * Update documentation * Migrate existing detectors to always initialize SecretParts
101 lines
2.9 KiB
Go
101 lines
2.9 KiB
Go
package gitlab
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"maps"
|
|
"net/http"
|
|
"strings"
|
|
|
|
regexp "github.com/wasilibs/go-re2"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
|
|
v1 "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/gitlab/v1"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detector_typepb"
|
|
)
|
|
|
|
type Scanner struct {
|
|
client *http.Client
|
|
detectors.EndpointSetter
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interfaces at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
var _ detectors.EndpointCustomizer = (*Scanner)(nil)
|
|
var _ detectors.Versioner = (*Scanner)(nil)
|
|
|
|
func (Scanner) Version() int { return 3 }
|
|
func (Scanner) CloudEndpoint() string { return "https://gitlab.com" }
|
|
|
|
var (
|
|
defaultClient = common.SaneHttpClient()
|
|
// pattern taken from gitlab's PR for the format change: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169322
|
|
keyPat = regexp.MustCompile(`\b(glpat-[a-zA-Z0-9\-=_]{27,300}.[0-9a-z]{2}.[a-z0-9]{9})\b`)
|
|
)
|
|
|
|
func (s Scanner) getClient() *http.Client {
|
|
if s.client != nil {
|
|
return s.client
|
|
}
|
|
|
|
return defaultClient
|
|
}
|
|
|
|
// Keywords are used for efficiently pre-filtering chunks.
|
|
// Use identifiers in the secret preferably, or the provider name.
|
|
func (s Scanner) Keywords() []string { return []string{"glpat-"} }
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.DetectorType_Gitlab
|
|
}
|
|
|
|
func (s Scanner) Description() string {
|
|
return "GitLab is a web-based DevOps lifecycle tool that provides a Git repository manager providing wiki, issue-tracking, and CI/CD pipeline features. GitLab Personal Access Tokens (PATs) can be used to authenticate and access GitLab resources."
|
|
}
|
|
|
|
// FromData will find and optionally verify Gitlab secrets in a given set of bytes.
|
|
func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {
|
|
dataStr := string(data)
|
|
|
|
matches := keyPat.FindAllStringSubmatch(dataStr, -1)
|
|
for _, match := range matches {
|
|
resMatch := strings.TrimSpace(match[1])
|
|
|
|
for _, endpoint := range s.Endpoints() {
|
|
s1 := detectors.Result{
|
|
DetectorType: detector_typepb.DetectorType_Gitlab,
|
|
Raw: []byte(resMatch),
|
|
RawV2: []byte(resMatch + endpoint),
|
|
ExtraData: map[string]string{
|
|
"rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/",
|
|
"version": fmt.Sprintf("%d", s.Version()),
|
|
},
|
|
SecretParts: map[string]string{
|
|
"key": resMatch,
|
|
"host": endpoint,
|
|
},
|
|
}
|
|
|
|
if verify {
|
|
|
|
isVerified, extraData, verificationErr := v1.VerifyGitlab(ctx, s.getClient(), endpoint, resMatch)
|
|
s1.Verified = isVerified
|
|
maps.Copy(s1.ExtraData, extraData)
|
|
|
|
s1.SetVerificationError(verificationErr)
|
|
|
|
// for verified keys break out of the endpoint loop to continue to next secret
|
|
if s1.Verified {
|
|
results = append(results, s1)
|
|
break
|
|
}
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
}
|
|
|
|
return results, nil
|
|
}
|