feat: adds repository plugin (#62)

Co-authored-by: Baruch Odem <[email protected]>

cmd/main.go

@@ -27,6 +27,7 @@ var Version = ""
 
 var allPlugins = []plugins.IPlugin{
 	&plugins.ConfluencePlugin{},
+	&plugins.RepositoryPlugin{},
 }
 
 func initLog() {

plugins/repository.go

@@ -0,0 +1,102 @@
+package plugins
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+	"sync"
+
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+)
+
+const argRepository = "path"
+
+type RepositoryPlugin struct {
+	Plugin
+	Path string
+}
+
+func (p *RepositoryPlugin) IsEnabled() bool {
+	return p.Enabled
+}
+
+func (p *RepositoryPlugin) DefineCommandLineArgs(cmd *cobra.Command) error {
+	flags := cmd.Flags()
+	flags.String(argRepository, "", "scan repository folder")
+	return nil
+}
+
+func (p *RepositoryPlugin) Initialize(cmd *cobra.Command) error {
+	flags := cmd.Flags()
+	directoryPath, _ := flags.GetString(argRepository)
+	if directoryPath == "" {
+		return errors.New("path to repository missing. Plugin initialization failed")
+	}
+
+	p.Path = directoryPath
+	p.Enabled = true
+	return nil
+}
+
+func (p *RepositoryPlugin) GetItems(items chan Item, errs chan error, wg *sync.WaitGroup) {
+	defer wg.Done()
+
+	wg.Add(1)
+	go p.getFiles(items, errs, wg)
+}
+
+func (p *RepositoryPlugin) getFiles(items chan Item, errs chan error, wg *sync.WaitGroup) {
+	defer wg.Done()
+	fileList := make([]string, 0)
+	err := filepath.Walk(p.Path, func(path string, fInfo os.FileInfo, err error) error {
+		if err != nil {
+			log.Fatal().Err(err).Msg("error while walking through the directory")
+		}
+		if fInfo.Name() == ".git" && fInfo.IsDir() {
+			return filepath.SkipDir
+		}
+		if fInfo.Size() == 0 {
+			return nil
+		}
+		if !fInfo.IsDir() {
+			fileList = append(fileList, path)
+		}
+		return err
+	})
+
+	if err != nil {
+		log.Fatal().Err(err).Msg("error while walking through the directory")
+	}
+
+	p.getItems(items, errs, wg, fileList)
+}
+
+func (p *RepositoryPlugin) getItems(items chan Item, errs chan error, wg *sync.WaitGroup, fileList []string) {
+	for _, filePath := range fileList {
+		wg.Add(1)
+		go func(filePath string) {
+			actualFile, err := p.getItem(wg, filePath)
+			if err != nil {
+				errs <- err
+				return
+			}
+			items <- *actualFile
+		}(filePath)
+	}
+}
+
+func (p *RepositoryPlugin) getItem(wg *sync.WaitGroup, filePath string) (*Item, error) {
+	defer wg.Done()
+	b, err := os.ReadFile(filePath)
+	if err != nil {
+		return nil, err
+	}
+
+	content := &Item{
+		Content: string(b),
+		Source:  filePath,
+		ID:      filePath,
+	}
+	return content, nil
+}

reporting/report.go

@@ -2,6 +2,7 @@ package reporting
 
 import (
 	"fmt"
+	"path/filepath"
 	"strings"
 )
 
@@ -41,9 +42,9 @@ func (r *Report) ShowReport() {
 
 func (r *Report) generateResultsReport() {
 	for source, secrets := range r.Results {
-		itemLink := getItemId(source)
-		fmt.Printf("- Item ID: %s\n", itemLink)
-		fmt.Printf(" - Item Link: %s\n", source)
+		itemId := getItemId(source)
+		fmt.Printf("- Item ID: %s\n", itemId)
+		fmt.Printf(" - Item Full Path: %s\n", source)
 		fmt.Println("  - Secrets:")
 		for _, secret := range secrets {
 			fmt.Printf("   - Type: %s\n", secret.Description)
@@ -53,7 +54,13 @@ func (r *Report) generateResultsReport() {
 }
 
 func getItemId(fullPath string) string {
-	itemLinkStrings := strings.Split(fullPath, "/")
-	itemLink := itemLinkStrings[len(itemLinkStrings)-1]
-	return itemLink
+	var itemId string
+	if strings.Contains(fullPath, "/") {
+		itemLinkStrings := strings.Split(fullPath, "/")
+		itemId = itemLinkStrings[len(itemLinkStrings)-1]
+	}
+	if strings.Contains(fullPath, "\\") {
+		itemId = filepath.Base(fullPath)
+	}
+	return itemId
 }