nuclei/v2/pkg/templates/templates.go

76 lines
3.8 KiB
Go
Raw Normal View History

//go:generate dstdocgen -path "" -structure Template -output templates_doc.go -package templates
package templates
import (
"github.com/projectdiscovery/nuclei/v2/pkg/model"
2020-12-29 11:03:25 +00:00
"github.com/projectdiscovery/nuclei/v2/pkg/protocols"
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/dns"
2021-01-01 09:58:28 +00:00
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/file"
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/headless"
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/http"
2020-12-30 09:24:20 +00:00
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/network"
"github.com/projectdiscovery/nuclei/v2/pkg/workflows"
)
2021-08-04 08:50:48 +00:00
// Template is a YAML input file which defines all the requests and
// other metadata for a template.
type Template struct {
2021-07-27 10:33:56 +00:00
// description: |
2021-09-01 10:18:01 +00:00
// ID is the unique id for the template.
2021-07-27 10:33:56 +00:00
//
// #### Good IDs
//
2021-08-03 15:06:26 +00:00
// A good ID uniquely identifies what the requests in the template
2021-07-27 10:33:56 +00:00
// are doing. Let's say you have a template that identifies a git-config
// file on the webservers, a good name would be `git-config-exposure`. Another
// example name is `azure-apps-nxdomain-takeover`.
// examples:
// - name: ID Example
2021-09-01 10:23:30 +00:00
// value: "\"CVE-2021-19520\""
2021-10-20 19:58:36 +00:00
ID string `yaml:"id" jsonschema:"title=id of the template,description=The Unique ID for the template,example=cve-2021-19520,pattern=^([a-zA-Z0-9]+[-_])*[a-zA-Z0-9]+$"`
2021-07-27 10:33:56 +00:00
// description: |
2021-08-19 11:21:02 +00:00
// Info contains metadata information about the template.
2021-08-04 08:50:48 +00:00
// examples:
// - value: exampleInfoStructure
2021-08-24 14:32:55 +00:00
Info model.Info `yaml:"info" jsonschema:"title=info for the template,description=Info contains metadata for the template"`
2021-07-27 10:33:56 +00:00
// description: |
2021-08-04 08:50:48 +00:00
// Requests contains the http request to make in the template.
// examples:
// - value: exampleNormalHTTPRequest
RequestsHTTP []*http.Request `yaml:"requests,omitempty" json:"requests,omitempty" jsonschema:"title=http requests to make,description=HTTP requests to make for the template"`
2021-07-27 10:33:56 +00:00
// description: |
// DNS contains the dns request to make in the template
2021-08-04 08:50:48 +00:00
// examples:
// - value: exampleNormalDNSRequest
RequestsDNS []*dns.Request `yaml:"dns,omitempty" json:"dns,omitempty" jsonschema:"title=dns requests to make,description=DNS requests to make for the template"`
2021-07-27 10:33:56 +00:00
// description: |
// File contains the file request to make in the template
2021-08-04 08:50:48 +00:00
// examples:
// - value: exampleNormalFileRequest
RequestsFile []*file.Request `yaml:"file,omitempty" json:"file,omitempty" jsonschema:"title=file requests to make,description=File requests to make for the template"`
2021-07-27 10:33:56 +00:00
// description: |
// Network contains the network request to make in the template
2021-08-04 08:50:48 +00:00
// examples:
// - value: exampleNormalNetworkRequest
RequestsNetwork []*network.Request `yaml:"network,omitempty" json:"network,omitempty" jsonschema:"title=network requests to make,description=Network requests to make for the template"`
2021-07-27 10:33:56 +00:00
// description: |
// Headless contains the headless request to make in the template.
RequestsHeadless []*headless.Request `yaml:"headless,omitempty" json:"headless,omitempty" jsonschema:"title=headless requests to make,description=Headless requests to make for the template"`
2021-07-27 10:33:56 +00:00
// description: |
// Workflows is a yaml based workflow declaration code.
workflows.Workflow `yaml:",inline,omitempty" jsonschema:"title=workflows to run,description=Workflows to run for the template"`
2021-05-01 12:58:24 +00:00
CompiledWorkflow *workflows.Workflow `yaml:"-" json:"-" jsonschema:"-"`
2020-12-30 07:56:55 +00:00
// description: |
2021-10-19 16:58:48 +00:00
// Self Contained marks Requests for the template as self-contained
SelfContained bool `yaml:"self-contained,omitempty" jsonschema:"title=mark requests as self-contained,description=Mark Requests for the template as self-contained"`
// TotalRequests is the total number of requests for the template.
2021-05-01 12:58:24 +00:00
TotalRequests int `yaml:"-" json:"-"`
// Executer is the actual template executor for running template requests
2021-05-01 12:58:24 +00:00
Executer protocols.Executer `yaml:"-" json:"-"`
2021-06-05 17:30:59 +00:00
Path string `yaml:"-" json:"-"`
2020-07-31 15:13:51 +00:00
}