-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
nuclei 'stats' build : scan events + chart utils (#5032)
* prototype new scan events * scan-event: improvements + conditional build * add scan charts server: make scan-charts * scan-charts: bug fix
- Loading branch information
1 parent
bec7cb2
commit ea2e13a
Showing
14 changed files
with
692 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
|
|
||
| "github.com/projectdiscovery/nuclei/v3/pkg/scan/charts" | ||
| ) | ||
|
|
||
| var ( | ||
| dir string | ||
| address string | ||
| output string | ||
| ) | ||
|
|
||
| func main() { | ||
| flag.StringVar(&dir, "dir", "", "directory to scan") | ||
| flag.StringVar(&address, "address", ":9000", "address to run the server on") | ||
| flag.StringVar(&output, "output", "", "output filename of generated html file") | ||
| flag.Parse() | ||
|
|
||
| if dir == "" { | ||
| flag.Usage() | ||
| return | ||
| } | ||
|
|
||
| server, err := charts.NewScanEventsCharts(dir) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| server.PrintInfo() | ||
|
|
||
| if output != "" { | ||
| if err = server.GenerateHTML(output); err != nil { | ||
| panic(err) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| server.Start(address) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package charts | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/labstack/echo/v4" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/scan/events" | ||
| fileutil "github.com/projectdiscovery/utils/file" | ||
| ) | ||
|
|
||
| // ScanEventsCharts is a struct for nuclei event charts | ||
| type ScanEventsCharts struct { | ||
| eventsDir string | ||
| config *events.ScanConfig | ||
| data []events.ScanEvent | ||
| } | ||
|
|
||
| func (sc *ScanEventsCharts) PrintInfo() { | ||
| fmt.Printf("[+] Scan Info\n") | ||
| fmt.Printf(" - Name: %s\n", sc.config.Name) | ||
| fmt.Printf(" - Target Count: %d\n", sc.config.TargetCount) | ||
| fmt.Printf(" - Template Count: %d\n", sc.config.TemplatesCount) | ||
| fmt.Printf(" - Template Concurrency: %d\n", sc.config.TemplateConcurrency) | ||
| fmt.Printf(" - Payload Concurrency: %d\n", sc.config.PayloadConcurrency) | ||
| fmt.Printf(" - Retries: %v\n", sc.config.Retries) | ||
| fmt.Printf(" - Total Events: %d\n", len(sc.data)) | ||
| fmt.Println() | ||
| } | ||
|
|
||
| // NewScanEventsCharts creates a new nuclei event charts | ||
| func NewScanEventsCharts(eventsDir string) (*ScanEventsCharts, error) { | ||
| sc := &ScanEventsCharts{eventsDir: eventsDir} | ||
| if !fileutil.FolderExists(eventsDir) { | ||
| return nil, fmt.Errorf("events directory does not exist") | ||
| } | ||
| // open two files | ||
| // config.json | ||
| bin, err := os.ReadFile(filepath.Join(eventsDir, events.ConfigFile)) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var config events.ScanConfig | ||
| err = json.Unmarshal(bin, &config) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| sc.config = &config | ||
|
|
||
| // events.jsonl | ||
| f, err := os.Open(filepath.Join(eventsDir, events.EventsFile)) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer f.Close() | ||
|
|
||
| data := []events.ScanEvent{} | ||
| dec := json.NewDecoder(f) | ||
| for { | ||
| var event events.ScanEvent | ||
| if err := dec.Decode(&event); err != nil { | ||
| break | ||
| } | ||
| data = append(data, event) | ||
| } | ||
| sc.data = data | ||
|
|
||
| if len(data) == 0 { | ||
| return nil, fmt.Errorf("no events found in the events file") | ||
| } | ||
|
|
||
| return sc, nil | ||
| } | ||
|
|
||
| // Start starts the nuclei event charts server | ||
| func (sc *ScanEventsCharts) Start(addr string) { | ||
| e := echo.New() | ||
| e.HideBanner = true | ||
| e.GET("/concurrency", sc.ConcurrencyVsTime) | ||
| e.GET("/requests", sc.TotalRequestsOverTime) | ||
| e.GET("/slow", sc.TopSlowTemplates) | ||
| e.GET("/rps", sc.RequestsVSInterval) | ||
| e.GET("/", sc.AllCharts) | ||
| e.Logger.Fatal(e.Start(addr)) | ||
| } |
Oops, something went wrong.