Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove time.sleep at the end of run #171

Merged
merged 1 commit into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 26 additions & 20 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"github.com/checkmarx/2ms/lib"

"sync"
"time"

"github.com/checkmarx/2ms/plugins"
"github.com/checkmarx/2ms/reporting"
Expand Down Expand Up @@ -129,7 +128,7 @@ func Execute() {
rootCmd.AddGroup(&cobra.Group{Title: group, ID: group})

for _, plugin := range allPlugins {
subCommand, err := plugin.DefineCommand(channels)
subCommand, err := plugin.DefineCommand(channels.Items, channels.Errors)
if err != nil {
log.Fatal().Msg(fmt.Sprintf("error while defining command for plugin %s: %s", plugin.GetName(), err.Error()))
}
Expand Down Expand Up @@ -170,22 +169,32 @@ func preRun(cmd *cobra.Command, args []string) {
log.Fatal().Msg(err.Error())
}

channels.WaitGroup.Add(1)
go func() {
for {
select {
case item := <-channels.Items:
report.TotalItemsScanned++
channels.WaitGroup.Add(1)
go secrets.Detect(item, secretsChan, channels.WaitGroup, ignoreVar)
case secret := <-secretsChan:
report.TotalSecretsFound++
report.Results[secret.ID] = append(report.Results[secret.ID], secret)
case err, ok := <-channels.Errors:
if !ok {
return
}
log.Fatal().Msg(err.Error())
}
defer channels.WaitGroup.Done()

wgItems := &sync.WaitGroup{}
for item := range channels.Items {
report.TotalItemsScanned++
wgItems.Add(1)
go secrets.Detect(item, secretsChan, wgItems, ignoreVar)
}
wgItems.Wait()
close(secretsChan)
}()

channels.WaitGroup.Add(1)
go func() {
defer channels.WaitGroup.Done()
for secret := range secretsChan {
report.TotalSecretsFound++
report.Results[secret.ID] = append(report.Results[secret.ID], secret)
}
}()

go func() {
for err := range channels.Errors {
log.Fatal().Msg(err.Error())
}
}()
}
Expand All @@ -195,9 +204,6 @@ func postRun(cmd *cobra.Command, args []string) {

cfg := config.LoadConfig("2ms", Version)

// Wait for last secret to be added to report
time.Sleep(time.Millisecond * timeSleepInterval)

// -------------------------------------
// Show Report
if report.TotalItemsScanned > 0 {
Expand Down
15 changes: 7 additions & 8 deletions plugins/confluence.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func (p *ConfluencePlugin) GetAuthorizationHeader() string {
return lib.CreateBasicAuthCredentials(p)
}

func (p *ConfluencePlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
func (p *ConfluencePlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
var confluenceCmd = &cobra.Command{
Use: fmt.Sprintf("%s --%s URL", p.GetName(), argUrl),
Short: "Scan Confluence server",
Expand All @@ -67,11 +67,14 @@ func (p *ConfluencePlugin) DefineCommand(channels Channels) (*cobra.Command, err
confluenceCmd.Run = func(cmd *cobra.Command, args []string) {
err := p.initialize(cmd)
if err != nil {
channels.Errors <- fmt.Errorf("error while initializing confluence plugin: %w", err)
errors <- fmt.Errorf("error while initializing confluence plugin: %w", err)
return
}

p.getItems(channels.Items, channels.Errors, channels.WaitGroup)
wg := &sync.WaitGroup{}
p.getItems(items, errors, wg)
wg.Wait()
close(items)
}

return confluenceCmd, nil
Expand All @@ -90,18 +93,14 @@ func (p *ConfluencePlugin) initialize(cmd *cobra.Command) error {
}

func (p *ConfluencePlugin) getItems(items chan Item, errs chan error, wg *sync.WaitGroup) {
p.getSpacesItems(items, errs, wg)
}

func (p *ConfluencePlugin) getSpacesItems(items chan Item, errs chan error, wg *sync.WaitGroup) {
spaces, err := p.getSpaces()
if err != nil {
errs <- err
}

for _, space := range spaces {
go p.getSpaceItems(items, errs, wg, space)
wg.Add(1)
go p.getSpaceItems(items, errs, wg, space)
}
}

Expand Down
9 changes: 6 additions & 3 deletions plugins/discord.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (p *DiscordPlugin) GetName() string {
return "discord"
}

func (p *DiscordPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
func (p *DiscordPlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
var discordCmd = &cobra.Command{
Use: fmt.Sprintf("%s --%s TOKEN --%s SERVER", p.GetName(), tokenFlag, serversFlag),
Short: "Scan Discord server",
Expand All @@ -63,11 +63,14 @@ func (p *DiscordPlugin) DefineCommand(channels Channels) (*cobra.Command, error)
discordCmd.Run = func(cmd *cobra.Command, args []string) {
err := p.initialize(cmd)
if err != nil {
channels.Errors <- fmt.Errorf("discord plugin initialization failed: %w", err)
errors <- fmt.Errorf("discord plugin initialization failed: %w", err)
return
}

p.getItems(channels.Items, channels.Errors, channels.WaitGroup)
wg := &sync.WaitGroup{}
p.getItems(items, errors, wg)
wg.Wait()
close(items)
}

return discordCmd, nil
Expand Down
8 changes: 6 additions & 2 deletions plugins/filesystem.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,18 @@ func (p *FileSystemPlugin) GetName() string {
return "filesystem"
}

func (p *FileSystemPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
func (p *FileSystemPlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
var cmd = &cobra.Command{
Use: fmt.Sprintf("%s --%s PATH", p.GetName(), flagFolder),
Short: "Scan local folder",
Long: "Scan local folder for sensitive information",
Run: func(cmd *cobra.Command, args []string) {
log.Info().Msg("Folder plugin started")
p.getFiles(channels.Items, channels.Errors, channels.WaitGroup)

wg := &sync.WaitGroup{}
p.getFiles(items, errors, wg)
wg.Wait()
close(items)
},
}

Expand Down
13 changes: 10 additions & 3 deletions plugins/git.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"
"os"
"strings"
"sync"

"github.com/gitleaks/go-gitdiff/gitdiff"
"github.com/rs/zerolog/log"
Expand All @@ -29,8 +30,12 @@ func (p *GitPlugin) GetName() string {
return "git"
}

func (p *GitPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
p.Channels = channels
func (p *GitPlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
p.Channels = Channels{
Items: items,
Errors: errors,
WaitGroup: &sync.WaitGroup{},
}

command := &cobra.Command{
Use: fmt.Sprintf("%s <CLONED_REPO>", p.GetName()),
Expand All @@ -39,7 +44,9 @@ func (p *GitPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
Args: cobra.MatchAll(cobra.ExactArgs(1), validGitRepoArgs),
Run: func(cmd *cobra.Command, args []string) {
log.Info().Msg("Git plugin started")
p.scanGit(args[0], p.buildScanOptions(), channels.Items, channels.Errors)
p.scanGit(args[0], p.buildScanOptions(), p.Channels.Items, p.Channels.Errors)
p.WaitGroup.Wait()
close(items)
},
}
flags := command.Flags()
Expand Down
11 changes: 9 additions & 2 deletions plugins/paligo.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"net/http"
"strconv"
"strings"
"sync"
"time"

"github.com/checkmarx/2ms/lib"
Expand Down Expand Up @@ -54,8 +55,12 @@ func (p *PaligoPlugin) GetName() string {
return "paligo"
}

func (p *PaligoPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
p.Channels = channels
func (p *PaligoPlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
p.Channels = Channels{
Items: items,
Errors: errors,
WaitGroup: &sync.WaitGroup{},
}

command := &cobra.Command{
Use: fmt.Sprintf("%s --%s %s --%s %s --%s %s",
Expand All @@ -73,6 +78,8 @@ func (p *PaligoPlugin) DefineCommand(channels Channels) (*cobra.Command, error)
}
log.Info().Msg("Paligo plugin started")
p.getItems()
p.WaitGroup.Wait()
close(items)
},
}

Expand Down
2 changes: 1 addition & 1 deletion plugins/plugins.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ type Channels struct {

type IPlugin interface {
GetName() string
DefineCommand(channels Channels) (*cobra.Command, error)
DefineCommand(items chan Item, errors chan error) (*cobra.Command, error)
}
11 changes: 9 additions & 2 deletions plugins/slack.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package plugins
import (
"fmt"
"strconv"
"sync"
"time"

"github.com/rs/zerolog/log"
Expand Down Expand Up @@ -38,15 +39,21 @@ var (
messagesCountArg int
)

func (p *SlackPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
p.Channels = channels
func (p *SlackPlugin) DefineCommand(items chan Item, errors chan error) (*cobra.Command, error) {
p.Channels = Channels{
Items: items,
Errors: errors,
WaitGroup: &sync.WaitGroup{},
}

command := &cobra.Command{
Use: fmt.Sprintf("%s --%s TOKEN --%s TEAM", p.GetName(), slackTokenFlag, slackTeamFlag),
Short: "Scan Slack team",
Long: "Scan Slack team for sensitive information.",
Run: func(cmd *cobra.Command, args []string) {
p.getItems()
p.Channels.WaitGroup.Wait()
close(items)
},
}

Expand Down