github.com/google/osv-scalibr@v0.4.1/extractor/filesystem/secrets/gitbasicauth/codecatalyst/codecatalyst.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package codecatalyst extends the veles codecatalyst.Detector to search inside the git config and history files
    16  package codecatalyst
    17  
    18  import (
    19  	"path/filepath"
    20  	"strings"
    21  
    22  	"github.com/google/osv-scalibr/extractor/filesystem"
    23  	"github.com/google/osv-scalibr/veles/secrets/gitbasicauth/codecatalyst"
    24  
    25  	"github.com/google/osv-scalibr/extractor/filesystem/secrets/convert"
    26  )
    27  
    28  const (
    29  	// Name is the name of the extractor
    30  	Name = "secrets/codecatalystcredentials"
    31  	// Version is the version of the extractor
    32  	Version = 0
    33  )
    34  
    35  // New returns a filesystem.Extractor which extracts Amazon CodeCatalyst Credentials using the codecatalyst.Detector
    36  func New() filesystem.Extractor {
    37  	return convert.FromVelesDetectorWithRequire(
    38  		codecatalyst.NewDetector(), Name, Version, FileRequired,
    39  	)
    40  }
    41  
    42  // FileRequired reports whether the plugin should scan the given file.
    43  //
    44  // The history.txt file is intentionally excluded because it is already
    45  // processed by the main secrets extractor.
    46  func FileRequired(api filesystem.FileAPI) bool {
    47  	path := filepath.ToSlash(api.Path())
    48  	return strings.HasSuffix(path, ".git/config") ||
    49  		strings.HasSuffix(path, ".git-credentials") ||
    50  		strings.HasSuffix(path, "_history")
    51  }