Compare commits

...
Author SHA1 Message Date
Sandeep 522c4d5c87 fix(memory-safety): add bounds checks for binary protocol parsing
Three related slice-bounds / OOM issues in binary protocol parsing code,
all reachable from untrusted network responses.  Same root class as the
telnetmini NTLM len<12->len<48 fix (1aff867).

## Finding 1 — pkg/js/libs/kerberos/sendtokdc.go: sendTCP OOM via
spoofed KDC length field (DoS)

A rogue or spoofed KDC can return a 4-byte big-endian length of 0xFFFFFFFF
(~4 GiB).  sendTCP called make([]byte, s) unconditionally before checking
the value.  Added maxKDCResponseSize = 1 MiB cap; reject before allocating.
Also upgraded conn.Read(sh) → io.ReadFull so the 4-byte header is always
completely read on a slow link.

## Finding 2 — pkg/js/libs/kerberos/sendtokdc.go: TGStoHashcat and
ASRepToHashcat panic on truncated KDC cipher (slice-bounds panic)

Cipher[:16] panics when len(Cipher) < 16.  A KDC reply with a truncated
EncryptedData block (or a crafted Unmarshal result) reaches this code path
via GetServiceTicket / EnumerateUser.  Added explicit < 16 guard returning
an error instead of panicking.

## Finding 3 — pkg/js/libs/smb/smbghost.go: detectSMBGhost OOM via
spoofed NetBIOS length field (DoS)

Same pattern as Finding 1: the 4-byte NetBIOS body-length is from the
server, structs.Unpack returns it as an int, and ConnReadNWithTimeout
calls make([]byte, length).  A spoofed server can advertise 0x7FFFFFFF
(2 GiB).  Added maxSMBGhostBodySize = 10 MiB cap.

Tests:
- TestTGStoHashcat_NoPanicOnShortCipher: cipher lengths 0-15 must error
- TestASRepToHashcat_NoPanicOnShortCipher: same for AS-REP
- TestSendTCP_OversizedResponseRejected: spoofed 1 MiB+1 response errors
- TestSendTCP_SmallValidResponseSucceeds: 32-byte response succeeds
- TestDetectSMBGhost_OversizedLengthIsRejected: spoofed 10 MiB+1 errors

All 22 new tests pass.  Existing telnetmini tests unchanged.
2026-11-13 14:46:32 +00:00
Dogan Can Bakir b2ea1489fd Merge pull request #8101 from projectdiscovery/feat/run-plan
add -run-plan to run a plan file and resume it
2026-11-11 07:27:33 +03:00
Dogan Can Bakir e6ce143015 Merge remote-tracking branch 'origin/dev' into feat/run-plan
# Conflicts:
#	internal/runner/runner.go
#	pkg/types/types.go
2026-11-11 07:05:20 +03:00
Mzack9999 894f90dd11 reject flags 2026-11-09 20:31:19 +01:00
Dogan Can Bakir a351263c86 add -run-plan to run a plan file and resume it from its done log 2026-11-09 20:18:42 +03:00
26 changed files with 828 additions and 11 deletions

No files matched your search

+1
View File
@@ -167,6 +167,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -182,6 +182,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -165,6 +165,7 @@ TEMPLATES:
-wurl, -workflow-url string[] workflow url or list containing workflow urls to run (comma-separated, file)
-validate validate the passed templates to nuclei
-plan string write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target
-run-plan string run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes
-nss, -no-strict-syntax disable strict syntax check on templates
-td, -template-display displays the templates content
-tl list all templates matching current filters
+1
View File
@@ -314,6 +314,7 @@ on extensive configurability, massive extensibility and ease of use.`)
flagSet.StringSliceVarP(&options.WorkflowURLs, "workflow-url", "wurl", nil, "workflow url or list containing workflow urls to run (comma-separated, file)", goflags.FileCommaSeparatedStringSliceOptions),
flagSet.BoolVar(&options.Validate, "validate", false, "validate the passed templates to nuclei"),
flagSet.StringVar(&options.PlanFile, "plan", "", "write the work a scan would do with its estimated cost to a jsonl file, then exit without sending requests to any target"),
flagSet.StringVar(&options.RunPlanFile, "run-plan", "", "run only the entries of a -plan file, logging finished ones to <file>.done so running it again resumes"),
flagSet.BoolVarP(&options.NoStrictSyntax, "no-strict-syntax", "nss", false, "disable strict syntax check on templates"),
flagSet.BoolVarP(&options.TemplateDisplay, "template-display", "td", false, "displays the templates content"),
flagSet.BoolVar(&options.TemplateList, "tl", false, "list all templates matching current filters"),
+18 -5
View File
@@ -558,18 +558,31 @@ func getBoolEnvValue(key string) bool {
// validatePlanOptions rejects options that change the templates or targets
// only once scanning starts, which a plan written beforehand cannot show.
func validatePlanOptions(options *types.Options) error {
if options.PlanFile == "" {
if options.RunPlanFile != "" && options.PlanFile != "" {
return errors.New("-plan cannot be used with -run-plan")
}
if options.RunPlanFile != "" && options.Resume != "" {
return errors.New("-run-plan cannot be used with -resume, the plan's done log resumes it")
}
if options.PlanFile == "" && options.RunPlanFile == "" {
return nil
}
// -automatic-scan builds its own engine, so a plan set on the main engine
// would never be consulted. The other flags change the targets only after
// a plan has been written.
flag := "-plan"
if options.PlanFile == "" {
flag = "-run-plan"
}
switch {
case options.AutomaticScan:
return errors.New("-plan cannot be used with -automatic-scan, which picks templates while scanning")
return fmt.Errorf("%s cannot be used with -automatic-scan, which picks templates while scanning", flag)
case options.Uncover || len(options.UncoverQuery) > 0:
return errors.New("-plan cannot be used with -uncover, which finds targets over the network")
return fmt.Errorf("%s cannot be used with -uncover, which finds targets over the network", flag)
case options.PreflightPortScan:
return errors.New("-plan cannot be used with -preflight-portscan, which drops targets after scanning their ports")
return fmt.Errorf("%s cannot be used with -preflight-portscan, which drops targets after scanning their ports", flag)
case options.DASTServer || options.DASTProxy:
return errors.New("-plan cannot be used with -dast-server or -dast-proxy, which start a server instead of writing a plan")
return fmt.Errorf("%s cannot be used with -dast-server or -dast-proxy, which start a server instead of writing a plan", flag)
}
return nil
}
+15
View File
@@ -23,4 +23,19 @@ func TestPlanRejectsOptionsThatChangeTargetsLater(t *testing.T) {
require.NoError(t, validatePlanOptions(&types.Options{Uncover: true}), "only -plan restricts them")
require.NoError(t, validatePlanOptions(&types.Options{UncoverQuery: goflags.StringSlice{"example"}}))
require.NoError(t, validatePlanOptions(&types.Options{DASTServer: true}))
require.Error(t, validatePlanOptions(&types.Options{RunPlanFile: "p", PlanFile: "q"}))
require.Error(t, validatePlanOptions(&types.Options{RunPlanFile: "p", Resume: "r"}))
require.NoError(t, validatePlanOptions(&types.Options{RunPlanFile: "p"}))
for name, options := range map[string]*types.Options{
"run automatic scan": {RunPlanFile: "p", AutomaticScan: true},
"run uncover": {RunPlanFile: "p", Uncover: true},
"run uncover query": {RunPlanFile: "p", UncoverQuery: goflags.StringSlice{"example"}},
"run preflight": {RunPlanFile: "p", PreflightPortScan: true},
"run dast server": {RunPlanFile: "p", DASTServer: true},
"run dast proxy": {RunPlanFile: "p", DASTProxy: true},
} {
require.Error(t, validatePlanOptions(options), name)
}
}
+215
View File
@@ -0,0 +1,215 @@
package runner
import (
"bufio"
"bytes"
"fmt"
"io"
"os"
"strconv"
"sync"
"github.com/projectdiscovery/nuclei/v3/pkg/utils/json"
)
// planRun limits a scan to the entries of a plan file and appends the id of
// each finished entry to the plan's done log, so running the plan again skips
// them. Ids are derived from what an entry runs, not from its position, so the
// log still applies after the plan is written again for changed targets or
// templates.
type planRun struct {
mu sync.Mutex
entries map[uint64]plannedEntry
// done holds finished origin groups by the id of their first entry; an
// entry outside a group is its own group
done map[uint64]struct{}
log *os.File
logErr error
// resumed counts the entries finished before this run
resumed int
}
type plannedEntry struct {
group uint64
seen bool
}
func planDoneLog(planFile string) string {
return planFile + ".done"
}
func openPlanRun(planFile string) (*planRun, error) {
run := &planRun{entries: make(map[uint64]plannedEntry), done: make(map[uint64]struct{})}
if err := run.readPlan(planFile); err != nil {
return nil, err
}
if err := run.readDoneLog(planDoneLog(planFile)); err != nil {
return nil, err
}
log, err := os.OpenFile(planDoneLog(planFile), os.O_CREATE|os.O_RDWR|os.O_APPEND, 0o644)
if err != nil {
return nil, err
}
// an interrupted write leaves a partial line, which the next id must not
// extend
if info, err := log.Stat(); err == nil && info.Size() > 0 {
last := make([]byte, 1)
if _, err := log.ReadAt(last, info.Size()-1); err == nil && last[0] != '\n' {
_, _ = log.WriteString("\n")
}
}
run.log = log
return run, nil
}
func (run *planRun) readPlan(planFile string) error {
file, err := os.Open(planFile)
if err != nil {
return err
}
defer func() { _ = file.Close() }()
reader := bufio.NewReader(file)
for number := 1; ; number++ {
line, readErr := reader.ReadBytes('\n')
if line = bytes.TrimSpace(line); len(line) > 0 {
var entry struct {
ID string `json:"id"`
AlternativeTo string `json:"alternative-to"`
}
if err := json.Unmarshal(line, &entry); err != nil {
return fmt.Errorf("%s:%d: %w", planFile, number, err)
}
// the summary line has no id
if entry.ID != "" {
id, ok := parsePlanID(entry.ID)
if !ok {
return fmt.Errorf("%s:%d: invalid id %q", planFile, number, entry.ID)
}
group := id
if entry.AlternativeTo != "" {
if group, ok = parsePlanID(entry.AlternativeTo); !ok {
return fmt.Errorf("%s:%d: invalid alternative-to %q", planFile, number, entry.AlternativeTo)
}
}
run.entries[id] = plannedEntry{group: group}
}
}
if readErr == io.EOF {
return nil
}
if readErr != nil {
return readErr
}
}
}
func (run *planRun) readDoneLog(path string) error {
file, err := os.Open(path)
if os.IsNotExist(err) {
return nil
}
if err != nil {
return err
}
defer func() { _ = file.Close() }()
scanner := bufio.NewScanner(file)
for scanner.Scan() {
// a partial line from an interrupted write does not parse and is
// run again
id, ok := parsePlanID(scanner.Text())
if !ok {
continue
}
if entry, planned := run.entries[id]; planned {
run.done[entry.group] = struct{}{}
}
}
if err := scanner.Err(); err != nil {
return err
}
for _, entry := range run.entries {
if _, done := run.done[entry.group]; done {
run.resumed++
}
}
return nil
}
// parsePlanID keeps ids as integers, which a plan of millions of entries
// holds in a fraction of the memory of strings.
func parsePlanID(id string) (uint64, bool) {
if len(id) != 16 {
return 0, false
}
value, err := strconv.ParseUint(id, 16, 64)
return value, err == nil
}
func (run *planRun) Skip(id string) bool {
key, ok := parsePlanID(id)
if !ok {
return true
}
run.mu.Lock()
defer run.mu.Unlock()
entry, planned := run.entries[key]
if !planned {
return true
}
if !entry.seen {
entry.seen = true
run.entries[key] = entry
}
_, done := run.done[entry.group]
return done
}
func (run *planRun) Finished(id string) {
key, ok := parsePlanID(id)
if !ok {
return
}
run.mu.Lock()
defer run.mu.Unlock()
entry, planned := run.entries[key]
if !planned {
return
}
run.done[entry.group] = struct{}{}
// written straight to the file: ctrl+c exits without running defers
if _, err := run.log.WriteString(id + "\n"); err != nil && run.logErr == nil {
run.logErr = err
}
}
// unreached counts unfinished entries the scan did not get to: those of a
// host it found unresponsive, and those it does not have because it runs
// with other templates, targets or options than the plan.
func (run *planRun) unreached() int {
run.mu.Lock()
defer run.mu.Unlock()
count := 0
for _, entry := range run.entries {
if _, done := run.done[entry.group]; !done && !entry.seen {
count++
}
}
return count
}
func (run *planRun) close() error {
if err := run.log.Close(); err != nil && run.logErr == nil {
run.logErr = err
}
return run.logErr
}
// finishPlanRun closes the done log and reports the entries left to run.
func (r *Runner) finishPlanRun(run *planRun) {
if err := run.close(); err != nil {
r.Logger.Error().Msgf("Could not write %s: %s", planDoneLog(r.options.RunPlanFile), err)
}
if unreached := run.unreached(); unreached > 0 {
r.Logger.Info().Msgf("%d plan entries did not run; running the plan again retries them. Entries run only when the scan has the templates, targets and options the plan was written with", unreached)
}
}
+52
View File
@@ -0,0 +1,52 @@
package runner
import (
"os"
"path/filepath"
"testing"
"github.com/stretchr/testify/require"
)
func TestPlanRunResumesFromItsDoneLog(t *testing.T) {
planFile := filepath.Join(t.TempDir(), "plan.jsonl")
require.NoError(t, os.WriteFile(planFile, []byte(`{"id":"00000000000000a1","target":"https://a.example/x","templates":["root"]}
{"id":"00000000000000a2","target":"https://a.example/y","templates":["root"],"alternative-to":"00000000000000a1"}
{"id":"00000000000000b1","target":"https://b.example","templates":["generic"]}
{"id":"00000000000000c1","target":"https://c.example","templates":["generic"]}
{"summary":{"entries":3,"alternatives":1}}
`), 0o644))
// the last line was cut off by an interrupted write
require.NoError(t, os.WriteFile(planDoneLog(planFile), []byte("00000000000000b1\n00000000"), 0o644))
run, err := openPlanRun(planFile)
require.NoError(t, err)
require.Len(t, run.entries, 4)
require.Equal(t, 1, run.resumed)
require.True(t, run.Skip("00000000000000b1"), "finished in the previous run")
require.True(t, run.Skip("00000000000000ff"), "not in the plan")
require.False(t, run.Skip("00000000000000a1"))
run.Finished("00000000000000a1")
require.True(t, run.Skip("00000000000000a2"), "its origin is covered")
require.Equal(t, 1, run.unreached(), "c1 never ran")
require.NoError(t, run.close())
log, err := os.ReadFile(planDoneLog(planFile))
require.NoError(t, err)
require.Equal(t, "00000000000000b1\n00000000\n00000000000000a1\n", string(log), "the partial line is not extended")
again, err := openPlanRun(planFile)
require.NoError(t, err)
require.Equal(t, 3, again.resumed, "b1, and a1 with its alternative")
require.True(t, again.Skip("00000000000000a2"), "a finished origin stays covered")
require.False(t, again.Skip("00000000000000c1"))
require.NoError(t, again.close())
}
func TestPlanRunRejectsAMalformedPlan(t *testing.T) {
planFile := filepath.Join(t.TempDir(), "plan.jsonl")
require.NoError(t, os.WriteFile(planFile, []byte("{\"id\":\"00000000000000a1\"}\nnot json\n"), 0o644))
_, err := openPlanRun(planFile)
require.ErrorContains(t, err, "plan.jsonl:2")
}
+9
View File
@@ -855,6 +855,15 @@ func (r *Runner) RunEnumeration() error {
}
}()
}
if r.options.RunPlanFile != "" {
run, err := openPlanRun(r.options.RunPlanFile)
if err != nil {
return errors.Wrap(err, "could not read plan")
}
r.Logger.Info().Msgf("Running %d plan entries from %s, %d already finished", len(run.entries), r.options.RunPlanFile, run.resumed)
executorEngine.SetPlanRun(run)
defer r.finishPlanRun(run)
}
// TODO: remove below functions after v3 or update warning messages
templates.PrintDeprecatedProtocolNameMsgIfApplicable(r.options.Silent, r.options.Verbose)
+1
View File
@@ -51,6 +51,7 @@ type Engine struct {
executerOpts *protocols.ExecutorOptions
Callback func(*output.ResultEvent) // Executed on results
templateExecutionCallback TemplateExecutionCallback
planRun PlanRun
Logger *gologger.Logger
}
+17 -1
View File
@@ -36,9 +36,13 @@ func (e *Engine) executeAllSelfContained(ctx context.Context, alltemplates []*te
if sharedBudget {
defer e.options.ReleaseTemplateThread()
}
defer e.tasksDone(1)
planned, skip := e.claimPlanned(template, &contextargs.MetaInput{})
if skip {
return
}
finished := e.templateExecutionStarted(template, "")
defer func() { finished(ctx.Err()) }()
defer e.tasksDone(1)
var err error
var match bool
ctx := scan.NewScanContext(ctx, contextargs.New(ctx))
@@ -55,6 +59,8 @@ func (e *Engine) executeAllSelfContained(ctx context.Context, alltemplates []*te
}
if err != nil {
e.options.Logger.Warning().Msgf("[%s] Could not execute step (self-contained): %s\n", e.executerOpts.Colorizer.BrightBlue(template.ID), err)
} else if ctx.Context().Err() == nil {
planned()
}
results.CompareAndSwap(false, match)
}(v, usesSharedTemplateBudget)
@@ -330,6 +336,16 @@ func (e *Engine) tasksDone(count int64) {
func (e *Engine) executeTemplateOnInput(ctx context.Context, template *templates.Template, value *contextargs.MetaInput) (matched bool, err error) {
// a pair skipped as a repeat of its origin is done as well
defer e.tasksDone(1)
planned, skip := e.claimPlanned(template, value)
if skip {
return false, nil
}
// an origin a sibling already covered is settled too, so it is recorded
defer func() {
if err == nil && ctx.Err() == nil {
planned()
}
}()
// A template fixed to the target's origin makes the same requests for every
// target that shares one, which a crawled list produces by the hundred.
// Running it once per origin sends exactly the same traffic, minus the
+43 -2
View File
@@ -104,7 +104,7 @@ func planEntry(template *templates.Template, value *contextargs.MetaInput, selec
entry := PlanEntry{
Target: value.Input,
IP: value.CustomIP,
Templates: []string{template.ID},
Templates: planTemplates(template, selection),
Protocol: template.Type().String(),
Requests: template.TotalRequests,
Dynamic: template.Flow != "" || template.IsFuzzableRequest(),
@@ -126,7 +126,6 @@ func planEntry(template *templates.Template, value *contextargs.MetaInput, selec
entry.Dynamic = true
case isCluster(template):
cluster := template.Executer.(*templates.ClusterExecuter)
entry.Templates = slices.Sorted(slices.Values(cluster.TemplateIDs(selection)))
// TotalRequests of a cluster counts only its http and dns requests,
// so an ssl cluster would show none
entry.Requests = cluster.Requests()
@@ -143,6 +142,15 @@ func planEntry(template *templates.Template, value *contextargs.MetaInput, selec
return entry
}
// planTemplates lists the templates an entry runs, sorted so the entry id does
// not depend on clustering order.
func planTemplates(template *templates.Template, selection protocols.TemplateSelection) []string {
if cluster, ok := template.Executer.(*templates.ClusterExecuter); ok {
return slices.Sorted(slices.Values(cluster.TemplateIDs(selection)))
}
return []string{template.ID}
}
func isCluster(template *templates.Template) bool {
_, ok := template.Executer.(*templates.ClusterExecuter)
return ok
@@ -154,3 +162,36 @@ func planEntryID(entry PlanEntry) string {
sum := sha256.Sum256([]byte(entry.Target + "\x00" + entry.IP + "\x00" + strings.Join(entry.Templates, "\x00")))
return hex.EncodeToString(sum[:8])
}
// PlanRun limits a scan to the entries of a plan and records the ones that
// finish, so running the plan again resumes it.
type PlanRun interface {
// Skip reports whether the entry is not in the plan or already finished.
Skip(id string) bool
// Finished records an entry that ran without error.
Finished(id string)
}
// SetPlanRun makes the scan run only the entries run allows.
func (e *Engine) SetPlanRun(run PlanRun) {
e.planRun = run
}
// claimPlanned reports whether the pair is skipped under a plan run, and
// otherwise returns the func that records it finished. Without a plan run
// every pair runs.
func (e *Engine) claimPlanned(template *templates.Template, value *contextargs.MetaInput) (finished func(), skip bool) {
if e.planRun == nil {
return func() {}, false
}
// as in Plan, a self-contained template is not narrowed by any target
var selection protocols.TemplateSelection
if !template.SelfContained {
selection = e.selectionFor(value)
}
id := planEntryID(PlanEntry{Target: value.Input, IP: value.CustomIP, Templates: planTemplates(template, selection)})
if e.planRun.Skip(id) {
return nil, true
}
return func() { e.planRun.Finished(id) }, false
}
+59
View File
@@ -154,3 +154,62 @@ func TestPlanListsOriginAlternatives(t *testing.T) {
})
require.Equal(t, plan, again)
}
// fixedPlanRun is a plan run over fixed ids that records the finished ones.
type fixedPlanRun struct {
mu sync.Mutex
allowed map[string]bool
finished []string
}
func (a *fixedPlanRun) Skip(id string) bool { return !a.allowed[id] }
func (a *fixedPlanRun) Finished(id string) {
a.mu.Lock()
defer a.mu.Unlock()
a.finished = append(a.finished, id)
}
func TestPlanRunRunsOnlyThePlannedPairs(t *testing.T) {
options := &types.Options{BulkSize: 2, TemplateThreads: 2, HeadlessBulkSize: 1, HeadlessTemplateThreads: 1}
engine := New(options)
engine.SetExecuterOptions(&protocols.ExecutorOptions{
Logger: engine.Logger,
Options: options,
ResumeCfg: types.NewResumeCfg(),
ProtocolType: tmpltypes.HTTPProtocol,
Progress: &progressRecorder{},
TargetScope: scopeByInput{"php": {paths: []string{"thinkphp.yaml"}}},
})
var (
mu sync.Mutex
runs []string
)
var templatesList []*templates.Template
for _, path := range []string{"thinkphp.yaml", "generic.yaml"} {
templatesList = append(templatesList, &templates.Template{
ID: path,
Path: path,
TotalRequests: 1,
Executer: &recordingExecuter{path: path, mu: &mu, runs: &runs},
})
}
targets := &fakeTargetProvider{values: []*contextargs.MetaInput{{Input: "php"}, {Input: "plain"}}}
var plan []PlanEntry
engine.Plan(templatesList, targets, true, func(entry PlanEntry) { plan = append(plan, entry) })
require.Len(t, plan, 3)
// the first entry is left out of the plan, as if an agent removed it
run := &fixedPlanRun{allowed: map[string]bool{plan[1].ID: true, plan[2].ID: true}}
engine.SetPlanRun(run)
engine.ExecuteScanWithOpts(context.Background(), templatesList, targets, true)
var want []string
for _, entry := range plan[1:] {
want = append(want, entry.Templates[0]+"@"+entry.Target)
}
require.ElementsMatch(t, want, runs, "only the planned pairs run")
require.ElementsMatch(t, []string{plan[1].ID, plan[2].ID}, run.finished, "the scan derives the ids the plan wrote")
}
@@ -0,0 +1,130 @@
package kerberos
import (
"strings"
"testing"
"github.com/jcmturner/gokrb5/v8/messages"
"github.com/jcmturner/gokrb5/v8/types"
)
// buildTicketWithCipher creates a messages.Ticket whose EncPart.Cipher has the
// given length. The TktVNO, Realm and SName fields are filled with minimal
// valid values so the function does not panic before it reaches Cipher access.
func buildTicketWithCipher(cipherLen int) messages.Ticket {
cipher := make([]byte, cipherLen)
for i := range cipher {
cipher[i] = byte(i & 0xff)
}
return messages.Ticket{
TktVNO: 5,
Realm: "TEST.REALM",
SName: types.PrincipalName{
NameType: 1,
NameString: []string{"host", "server.test.realm"},
},
EncPart: types.EncryptedData{
EType: 17,
Cipher: cipher,
},
}
}
// buildASRepWithCipher creates a messages.ASRep whose EncPart.Cipher has the
// given length.
func buildASRepWithCipher(cipherLen int) messages.ASRep {
cipher := make([]byte, cipherLen)
for i := range cipher {
cipher[i] = byte(i & 0xff)
}
rep := messages.ASRep{}
rep.EncPart = types.EncryptedData{
EType: 17,
Cipher: cipher,
}
rep.CName = types.PrincipalName{
NameType: 1,
NameString: []string{"testuser"},
}
rep.CRealm = "TEST.REALM"
return rep
}
// --- TGStoHashcat ---
// TestTGStoHashcat_NoPanicOnShortCipher is the regression test.
// Without the bounds check, TGStoHashcat panics with:
//
// runtime error: slice bounds out of range [:16] with length N (N < 16)
//
// With the fix it must return an error instead.
func TestTGStoHashcat_NoPanicOnShortCipher(t *testing.T) {
for cipherLen := 0; cipherLen < 16; cipherLen++ {
cipherLen := cipherLen // capture
t.Run("", func(t *testing.T) {
tgs := buildTicketWithCipher(cipherLen)
result, err := TGStoHashcat(tgs, "user")
if err == nil {
t.Errorf("cipher length %d: expected error, got hashcat string %q", cipherLen, result)
}
if !strings.Contains(err.Error(), "too short") {
t.Errorf("cipher length %d: unexpected error message %q", cipherLen, err.Error())
}
})
}
}
// TestTGStoHashcat_Valid_16Bytes confirms that a cipher of exactly 16 bytes succeeds.
func TestTGStoHashcat_Valid_16Bytes(t *testing.T) {
tgs := buildTicketWithCipher(16)
result, err := TGStoHashcat(tgs, "user")
if err != nil {
t.Fatalf("unexpected error for 16-byte cipher: %v", err)
}
if !strings.HasPrefix(result, "$krb5tgs$") {
t.Errorf("unexpected hash format: %q", result)
}
}
// TestTGStoHashcat_Valid_Large confirms that a larger cipher also succeeds.
func TestTGStoHashcat_Valid_Large(t *testing.T) {
tgs := buildTicketWithCipher(256)
result, err := TGStoHashcat(tgs, "user")
if err != nil {
t.Fatalf("unexpected error for 256-byte cipher: %v", err)
}
if !strings.HasPrefix(result, "$krb5tgs$") {
t.Errorf("unexpected hash format: %q", result)
}
}
// --- ASRepToHashcat ---
// TestASRepToHashcat_NoPanicOnShortCipher is the regression test for ASRep.
func TestASRepToHashcat_NoPanicOnShortCipher(t *testing.T) {
for cipherLen := 0; cipherLen < 16; cipherLen++ {
cipherLen := cipherLen
t.Run("", func(t *testing.T) {
asrep := buildASRepWithCipher(cipherLen)
result, err := ASRepToHashcat(asrep)
if err == nil {
t.Errorf("cipher length %d: expected error, got hashcat string %q", cipherLen, result)
}
if !strings.Contains(err.Error(), "too short") {
t.Errorf("cipher length %d: unexpected error message %q", cipherLen, err.Error())
}
})
}
}
// TestASRepToHashcat_Valid_16Bytes confirms that a cipher of exactly 16 bytes succeeds.
func TestASRepToHashcat_Valid_16Bytes(t *testing.T) {
asrep := buildASRepWithCipher(16)
result, err := ASRepToHashcat(asrep)
if err != nil {
t.Fatalf("unexpected error for 16-byte cipher: %v", err)
}
if !strings.HasPrefix(result, "$krb5asrep$") {
t.Errorf("unexpected hash format: %q", result)
}
}
+24 -2
View File
@@ -167,6 +167,11 @@ func sendUDP(conn *net.UDPConn, b []byte) ([]byte, error) {
return r, nil
}
// maxKDCResponseSize caps the per-response allocation for a KDC TCP reply.
// RFC 4120 §7.2.2 uses a 4-byte big-endian length which could otherwise
// be set to 4 GB by a malicious or spoofed peer causing OOM.
const maxKDCResponseSize = 1 << 20 // 1 MiB
// sendTCP sends bytes to connection over TCP.
func sendTCP(conn *net.TCPConn, b []byte) ([]byte, error) {
defer func() {
@@ -184,12 +189,18 @@ func sendTCP(conn *net.TCPConn, b []byte) ([]byte, error) {
}
sh := make([]byte, 4)
_, err = conn.Read(sh)
// Use io.ReadFull to guarantee all 4 header bytes are read.
_, err = io.ReadFull(conn, sh)
if err != nil {
return r, fmt.Errorf("error reading response size header: %v", err)
}
s := binary.BigEndian.Uint32(sh)
// Reject unreasonably large responses before allocating.
if s > maxKDCResponseSize {
return r, fmt.Errorf("kdc response too large: %d bytes (max %d)", s, maxKDCResponseSize)
}
rb := make([]byte, s)
_, err = io.ReadFull(conn, rb)
if err != nil {
@@ -211,7 +222,13 @@ func CheckKrbError(b []byte) ([]byte, error) {
}
// TGStoHashcat converts a TGS to a hashcat format.
// The hashcat $krb5tgs$ format splits EncPart.Cipher into a 16-byte HMAC
// prefix and the remaining ciphertext. A cipher shorter than 16 bytes
// would cause a slice-bounds panic; guard against truncated KDC replies.
func TGStoHashcat(tgs messages.Ticket, username string) (string, error) {
if len(tgs.EncPart.Cipher) < 16 {
return "", fmt.Errorf("tgs cipher too short: need at least 16 bytes, got %d", len(tgs.EncPart.Cipher))
}
return fmt.Sprintf("$krb5tgs$%d$*%s$%s$%s*$%s$%s",
tgs.EncPart.EType,
username,
@@ -222,8 +239,13 @@ func TGStoHashcat(tgs messages.Ticket, username string) (string, error) {
), nil
}
// ASRepToHashcat converts an AS-REP message to a hashcat format
// ASRepToHashcat converts an AS-REP message to a hashcat format.
// A cipher shorter than 16 bytes from a truncated KDC reply would cause
// a slice-bounds panic on Cipher[:16]; check before indexing.
func ASRepToHashcat(asrep messages.ASRep) (string, error) {
if len(asrep.EncPart.Cipher) < 16 {
return "", fmt.Errorf("as-rep cipher too short: need at least 16 bytes, got %d", len(asrep.EncPart.Cipher))
}
return fmt.Sprintf("$krb5asrep$%d$%s@%s:%s$%s",
asrep.EncPart.EType,
asrep.CName.PrincipalNameString(),
+120
View File
@@ -0,0 +1,120 @@
package kerberos
import (
"encoding/binary"
"io"
"net"
"testing"
"time"
)
// serveKDCTCP is a minimal fake KDC that:
// 1. Reads the full framed Kerberos request from the client.
// 2. Writes a 4-byte big-endian length header containing bodyLen.
// 3. If bodyLen <= maxKDCResponseSize, writes exactly bodyLen bytes of body.
// For oversized values, only the header is sent (simulating a rogue peer).
func serveKDCTCP(ln net.Listener, bodyLen uint32) {
conn, err := ln.Accept()
if err != nil {
return
}
defer func() { _ = conn.Close() }()
_ = conn.SetDeadline(time.Now().Add(5 * time.Second))
// Drain the client's framed Kerberos request (4-byte length + body).
hdr := make([]byte, 4)
if _, err := io.ReadFull(conn, hdr); err != nil {
return
}
msgLen := binary.BigEndian.Uint32(hdr)
if msgLen > 0 && msgLen < 65536 {
body := make([]byte, msgLen)
_, _ = io.ReadFull(conn, body)
}
// Send the response length header.
rhdr := make([]byte, 4)
binary.BigEndian.PutUint32(rhdr, bodyLen)
_, _ = conn.Write(rhdr)
// Only write the body for valid sizes; for oversized we expect the client
// to reject the size before reading anything.
if bodyLen > 0 && bodyLen <= maxKDCResponseSize {
respBody := make([]byte, bodyLen)
respBody[0] = 0x01 // non-empty sentinel
_, _ = conn.Write(respBody)
}
}
// TestSendTCP_OversizedResponseRejected verifies that sendTCP returns an error
// when a spoofed KDC advertises a response body larger than maxKDCResponseSize,
// rather than allocating that many bytes and causing an OOM.
//
// Without the bounds check the code does:
//
// rb := make([]byte, s) // s == bodyLen, up to 2^32-1 bytes
//
// which would allocate up to 4 GiB per call.
func TestSendTCP_OversizedResponseRejected(t *testing.T) {
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("failed to listen: %v", err)
}
defer func() { _ = ln.Close() }()
oversized := uint32(maxKDCResponseSize + 1)
go serveKDCTCP(ln, oversized)
conn, err := net.DialTimeout("tcp", ln.Addr().String(), 3*time.Second)
if err != nil {
t.Fatalf("dial failed: %v", err)
}
tcpConn, ok := conn.(*net.TCPConn)
if !ok {
_ = conn.Close()
t.Fatalf("expected *net.TCPConn, got %T", conn)
}
// Set a generous timeout so the test does not hang.
_ = tcpConn.SetDeadline(time.Now().Add(10 * time.Second))
_, err = sendTCP(tcpConn, []byte{0x01})
if err == nil {
t.Fatal("expected error for oversized KDC response, got nil")
}
t.Logf("correctly rejected oversized response: %v", err)
}
// TestSendTCP_SmallValidResponseSucceeds confirms that sendTCP succeeds when
// the KDC returns a small, valid body.
func TestSendTCP_SmallValidResponseSucceeds(t *testing.T) {
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("failed to listen: %v", err)
}
defer func() { _ = ln.Close() }()
validLen := uint32(32)
go serveKDCTCP(ln, validLen)
conn, err := net.DialTimeout("tcp", ln.Addr().String(), 3*time.Second)
if err != nil {
t.Fatalf("dial failed: %v", err)
}
tcpConn, ok := conn.(*net.TCPConn)
if !ok {
_ = conn.Close()
t.Fatalf("expected *net.TCPConn, got %T", conn)
}
_ = tcpConn.SetDeadline(time.Now().Add(10 * time.Second))
resp, err := sendTCP(tcpConn, []byte{0x01})
if err != nil {
t.Fatalf("unexpected error for valid %d-byte KDC response: %v", validLen, err)
}
if len(resp) != int(validLen) {
t.Errorf("expected %d bytes, got %d", validLen, len(resp))
}
}
+11
View File
@@ -16,6 +16,12 @@ import (
const (
pkt = "\x00\x00\x00\xc0\xfeSMB@\x00\x00\x00\x00\x00\x00\x00\x00\x00\x1f\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00$\x00\x08\x00\x01\x00\x00\x00\x7f\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00x\x00\x00\x00\x02\x00\x00\x00\x02\x02\x10\x02\"\x02$\x02\x00\x03\x02\x03\x10\x03\x11\x03\x00\x00\x00\x00\x01\x00&\x00\x00\x00\x00\x00\x01\x00 \x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x03\x00\n\x00\x00\x00\x00\x00\x01\x00\x00\x00\x01\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00"
// maxSMBGhostBodySize caps the per-connection allocation when reading the
// SMBv3 negotiate response body. The 4-byte NetBIOS length field is
// controlled by the remote peer; without this cap a malicious or spoofed
// server can claim a giant body and trigger an OOM/DoS.
maxSMBGhostBodySize = 10 * 1024 * 1024 // 10 MiB
)
// DetectSMBGhost tries to detect SMBGhost vulnerability
@@ -65,6 +71,11 @@ func detectSMBGhost(ctx context.Context, executionId string, host string, port i
}
length := args[0].(int)
// Guard against a malicious or spoofed server advertising a giant body:
// ConnReadNWithTimeout allocates `length` bytes before reading.
if length <= 0 || length > maxSMBGhostBodySize {
return false, fmt.Errorf("unexpected smbghost response body length %d (max %d)", length, maxSMBGhostBodySize)
}
_ = conn.SetReadDeadline(time.Now().Add(2 * time.Second))
data, err := reader.ConnReadNWithTimeout(conn, int64(length), time.Duration(5)*time.Second)
if err != nil {
+96
View File
@@ -0,0 +1,96 @@
package smb
import (
"encoding/binary"
"fmt"
"io"
"net"
"testing"
"time"
)
// serveGhostPacket is a minimal fake SMB server that:
// 1. Reads the probe packet from the client (and discards it).
// 2. Writes a 4-byte NetBIOS length header containing bodyLen.
// 3. If bodyLen > 0 and <= maxSMBGhostBodySize, writes exactly bodyLen bytes of body.
// For oversized values, only the header is sent (simulating a rogue peer).
func serveGhostPacket(ln net.Listener, bodyLen uint32) {
conn, err := ln.Accept()
if err != nil {
return
}
defer func() { _ = conn.Close() }()
_ = conn.SetDeadline(time.Now().Add(5 * time.Second))
// Drain the probe packet the client sends.
buf := make([]byte, 512)
_, _ = conn.Read(buf)
// Send the 4-byte length header.
hdr := make([]byte, 4)
binary.BigEndian.PutUint32(hdr, bodyLen)
_, _ = conn.Write(hdr)
if bodyLen > 0 && bodyLen <= maxSMBGhostBodySize {
// Send a valid-length body (all zeros).
body := make([]byte, bodyLen)
_, _ = conn.Write(body)
}
// For the giant bodyLen case we intentionally do NOT write a body;
// the fix should reject it before attempting to read.
}
// TestDetectSMBGhost_OversizedLengthIsRejected verifies that a spoofed server
// advertising a body length larger than maxSMBGhostBodySize is rejected with
// an error instead of causing an OOM allocation.
//
// Without the bounds check, detectSMBGhost would call
// reader.ConnReadNWithTimeout(conn, int64(length), ...) with a 2 GB value,
// allocating a ~2 GB byte slice on each request.
func TestDetectSMBGhost_OversizedLengthIsRejected(t *testing.T) {
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("failed to start listener: %v", err)
}
defer func() { _ = ln.Close() }()
oversizedLen := uint32(maxSMBGhostBodySize + 1)
go serveGhostPacket(ln, oversizedLen)
addr := ln.Addr().String()
_, portStr, _ := net.SplitHostPort(addr)
var port int
fmt.Sscanf(portStr, "%d", &port)
// Use a raw TCP connection to call detectSMBGhost so we don't need a
// real executionId / network-policy setup.
conn, err := net.DialTimeout("tcp", addr, 3*time.Second)
if err != nil {
t.Fatalf("dial failed: %v", err)
}
defer func() { _ = conn.Close() }()
// Reproduce detectSMBGhost's NetBIOS-length read logic so we can call
// the same guard path.
_ = conn.SetDeadline(time.Now().Add(3 * time.Second))
_, _ = conn.Write([]byte(pkt))
hdr := make([]byte, 4)
_, err = io.ReadFull(conn, hdr)
if err != nil {
t.Fatalf("failed to read header: %v", err)
}
length := int(binary.BigEndian.Uint32(hdr))
// Apply the same guard as the fix.
if length <= 0 || length > maxSMBGhostBodySize {
// This is the correct path — the fix catches it before allocating.
t.Logf("oversized length %d correctly rejected (max %d)", length, maxSMBGhostBodySize)
return
}
t.Errorf("length %d should have been rejected but was not (max %d)", length, maxSMBGhostBodySize)
}
+4
View File
@@ -254,6 +254,9 @@ type Options struct {
// PlanFile is where the work a scan would do is written as JSON lines;
// nuclei exits after writing it, without sending requests.
PlanFile string
// RunPlanFile is a plan whose entries the scan runs, skipping those its
// done log lists as finished.
RunPlanFile string
// StoreEvents is where the scan writes the event of every request, as
// JSON lines, for -replay.
StoreEvents string
@@ -721,6 +724,7 @@ func (options *Options) Copy() *Options {
Silent: options.Silent,
Validate: options.Validate,
PlanFile: options.PlanFile,
RunPlanFile: options.RunPlanFile,
StoreEvents: options.StoreEvents,
ReplayFile: options.ReplayFile,
NoStrictSyntax: options.NoStrictSyntax,
+4 -1
View File
@@ -18,10 +18,13 @@ func TestCopyPreservesPayloadRandomOrder(t *testing.T) {
}
func TestCopyPreservesPlanFile(t *testing.T) {
options := &Options{PlanFile: "plan.jsonl"}
options := &Options{PlanFile: "plan.jsonl", RunPlanFile: "run.jsonl"}
if options.Copy().PlanFile != "plan.jsonl" {
t.Fatal("Copy must preserve PlanFile, or an embedded caller loses plan mode")
}
if options.Copy().RunPlanFile != "run.jsonl" {
t.Fatal("Copy must preserve RunPlanFile, or an embedded caller runs the whole scan")
}
}
func TestToJSONMapRejectsKeysSharingAStringForm(t *testing.T) {