nuclei

Documentation

Index

• Variables
• func NucleiVersionCheck() error
• func PurgeEmptyDirectories(dir string)
• func Scan(target string, fingerprints []string)
• func UpdateIgnoreFile() error
• type PdtmAPIResponse
• type TemplateManager
  • func (t *TemplateManager) FreshInstallIfNotExists() error
  • func (t *TemplateManager) UpdateIfOutdated() error

Variables

var (
	HideProgressBar        = true
	HideUpdateChangesTable = false
	HideReleaseNotes       = true
)

Functions

func NucleiVersionCheck

func NucleiVersionCheck() error

NucleiVersionCheck checks for the latest version of nuclei and nuclei templates and returns an error if it fails to check on success it returns nil and changes are made to the default config in config.DefaultConfig

func PurgeEmptyDirectories

func PurgeEmptyDirectories(dir string)

func Scan

func Scan(target string, fingerprints []string)

func UpdateIgnoreFile

func UpdateIgnoreFile() error

UpdateIgnoreFile updates default ignore file by downloading latest ignore file

Types

type PdtmAPIResponse

type PdtmAPIResponse struct {
	IgnoreHash string `json:"ignore-hash"`
	Tools      []struct {
		Name    string `json:"name"`
		Version string `json:"version"`
	} `json:"tools"`
}

PdtmAPIResponse is the response from pdtm API for nuclei endpoint

type TemplateManager

type TemplateManager struct {
	CustomTemplates        *customtemplates.CustomTemplatesManager // optional if given tries to download custom templates
	DisablePublicTemplates bool                                    // if true,

}

TemplateManager is a manager for templates. It downloads / updates / installs templates.

func (*TemplateManager) FreshInstallIfNotExists

func (t *TemplateManager) FreshInstallIfNotExists() error

FreshInstallIfNotExists installs templates if they are not already installed if templates directory already exists, it does nothing

func (*TemplateManager) UpdateIfOutdated

func (t *TemplateManager) UpdateIfOutdated() error

UpdateIfOutdated updates templates if they are outdated