|
|
|
|
@ -0,0 +1,893 @@
|
|
|
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
|
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
|
// DO NOT EDIT: this file is automatically generated by docgen
|
|
|
|
|
package templates
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"github.com/projectdiscovery/yamldoc-go/encoder"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
var (
|
|
|
|
|
TemplateDoc encoder.Doc
|
|
|
|
|
HTTPRequestDoc encoder.Doc
|
|
|
|
|
MATCHERSMatcherDoc encoder.Doc
|
|
|
|
|
EXTRACTORSExtractorDoc encoder.Doc
|
|
|
|
|
DNSRequestDoc encoder.Doc
|
|
|
|
|
FILERequestDoc encoder.Doc
|
|
|
|
|
NETWORKRequestDoc encoder.Doc
|
|
|
|
|
NETWORKInputDoc encoder.Doc
|
|
|
|
|
HEADLESSRequestDoc encoder.Doc
|
|
|
|
|
ENGINEActionDoc encoder.Doc
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc encoder.Doc
|
|
|
|
|
WORKFLOWSMatcherDoc encoder.Doc
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
|
TemplateDoc.Type = "Template"
|
|
|
|
|
TemplateDoc.Comments[encoder.LineComment] = " Template is a YAML input file which defines the requests and"
|
|
|
|
|
TemplateDoc.Description = "Template is a YAML input file which defines the requests and\n others metadata for a scan template."
|
|
|
|
|
TemplateDoc.Fields = make([]encoder.Doc, 8)
|
|
|
|
|
TemplateDoc.Fields[0].Name = "id"
|
|
|
|
|
TemplateDoc.Fields[0].Type = "string"
|
|
|
|
|
TemplateDoc.Fields[0].Note = ""
|
|
|
|
|
TemplateDoc.Fields[0].Description = "ID is the unique id for the template. IDs must be lowercase\nand must not contain spaces in it.\n\n#### Good IDs\n\nA good ID uniquely identifies what the requests in the template\nare doing. Let's say you have a template that identifies a git-config\nfile on the webservers, a good name would be `git-config-exposure`. Another\nexample name is `azure-apps-nxdomain-takeover`."
|
|
|
|
|
TemplateDoc.Fields[0].Comments[encoder.LineComment] = "ID is the unique id for the template. IDs must be lowercase"
|
|
|
|
|
|
|
|
|
|
TemplateDoc.Fields[0].AddExample("ID Example", "cve-2021-19520")
|
|
|
|
|
TemplateDoc.Fields[1].Name = "info"
|
|
|
|
|
TemplateDoc.Fields[1].Type = "map[string]interface{}"
|
|
|
|
|
TemplateDoc.Fields[1].Note = ""
|
|
|
|
|
TemplateDoc.Fields[1].Description = "Info contains metadata information about the template. At minimum, it\nshould contain `name`, `author`, `severity`, `description`, `tags`. Optionally\nyou can also specify a list of `references` for the template."
|
|
|
|
|
TemplateDoc.Fields[1].Comments[encoder.LineComment] = "Info contains metadata information about the template. At minimum, it"
|
|
|
|
|
TemplateDoc.Fields[2].Name = "requests"
|
|
|
|
|
TemplateDoc.Fields[2].Type = "[]http.Request"
|
|
|
|
|
TemplateDoc.Fields[2].Note = ""
|
|
|
|
|
TemplateDoc.Fields[2].Description = "Requests contains the http request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[2].Comments[encoder.LineComment] = "Requests contains the http request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[3].Name = "dns"
|
|
|
|
|
TemplateDoc.Fields[3].Type = "[]dns.Request"
|
|
|
|
|
TemplateDoc.Fields[3].Note = ""
|
|
|
|
|
TemplateDoc.Fields[3].Description = "DNS contains the dns request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[3].Comments[encoder.LineComment] = "DNS contains the dns request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[4].Name = "file"
|
|
|
|
|
TemplateDoc.Fields[4].Type = "[]file.Request"
|
|
|
|
|
TemplateDoc.Fields[4].Note = ""
|
|
|
|
|
TemplateDoc.Fields[4].Description = "File contains the file request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[4].Comments[encoder.LineComment] = "File contains the file request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[5].Name = "network"
|
|
|
|
|
TemplateDoc.Fields[5].Type = "[]network.Request"
|
|
|
|
|
TemplateDoc.Fields[5].Note = ""
|
|
|
|
|
TemplateDoc.Fields[5].Description = "Network contains the network request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[5].Comments[encoder.LineComment] = "Network contains the network request to make in the template"
|
|
|
|
|
TemplateDoc.Fields[6].Name = "headless"
|
|
|
|
|
TemplateDoc.Fields[6].Type = "[]headless.Request"
|
|
|
|
|
TemplateDoc.Fields[6].Note = ""
|
|
|
|
|
TemplateDoc.Fields[6].Description = "Headless contains the headless request to make in the template."
|
|
|
|
|
TemplateDoc.Fields[6].Comments[encoder.LineComment] = "Headless contains the headless request to make in the template."
|
|
|
|
|
TemplateDoc.Fields[7].Name = "workflows"
|
|
|
|
|
TemplateDoc.Fields[7].Type = "[]workflows.WorkflowTemplate"
|
|
|
|
|
TemplateDoc.Fields[7].Note = ""
|
|
|
|
|
TemplateDoc.Fields[7].Description = "Workflows is a list of workflows to execute for a template."
|
|
|
|
|
TemplateDoc.Fields[7].Comments[encoder.LineComment] = "Workflows is a list of workflows to execute for a template."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Type = "http.Request"
|
|
|
|
|
HTTPRequestDoc.Comments[encoder.LineComment] = " Request contains a http request to be made from a template"
|
|
|
|
|
HTTPRequestDoc.Description = "Request contains a http request to be made from a template"
|
|
|
|
|
HTTPRequestDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "requests",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
HTTPRequestDoc.Fields = make([]encoder.Doc, 24)
|
|
|
|
|
HTTPRequestDoc.Fields[0].Name = "matchers"
|
|
|
|
|
HTTPRequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
|
|
|
|
HTTPRequestDoc.Fields[0].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
|
|
|
|
HTTPRequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
|
|
|
|
HTTPRequestDoc.Fields[1].Name = "extractors"
|
|
|
|
|
HTTPRequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
|
|
|
|
HTTPRequestDoc.Fields[1].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[1].Description = "Extractors contains the extraction mechanism for the request to identify\nand extract parts of the response."
|
|
|
|
|
HTTPRequestDoc.Fields[1].Comments[encoder.LineComment] = "Extractors contains the extraction mechanism for the request to identify"
|
|
|
|
|
HTTPRequestDoc.Fields[2].Name = "matchers-condition"
|
|
|
|
|
HTTPRequestDoc.Fields[2].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[2].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[2].Description = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
HTTPRequestDoc.Fields[2].Comments[encoder.LineComment] = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
HTTPRequestDoc.Fields[2].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
HTTPRequestDoc.Fields[3].Name = "path"
|
|
|
|
|
HTTPRequestDoc.Fields[3].Type = "[]string"
|
|
|
|
|
HTTPRequestDoc.Fields[3].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[3].Description = "Path contains the path/s for the HTTP requests. It supports variables\nas placeholders."
|
|
|
|
|
HTTPRequestDoc.Fields[3].Comments[encoder.LineComment] = "Path contains the path/s for the HTTP requests. It supports variables"
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[3].AddExample("Some example path values", []string{"{{BaseURL}}", "{{BaseURL}}/+CSCOU+/../+CSCOE+/files/file_list.json?path=/sessions"})
|
|
|
|
|
HTTPRequestDoc.Fields[4].Name = "raw"
|
|
|
|
|
HTTPRequestDoc.Fields[4].Type = "[]string"
|
|
|
|
|
HTTPRequestDoc.Fields[4].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[4].Description = "Raw contains HTTP Requests in Raw format."
|
|
|
|
|
HTTPRequestDoc.Fields[4].Comments[encoder.LineComment] = "Raw contains HTTP Requests in Raw format."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[4].AddExample("Some example raw requests", []string{"GET /etc/passwd HTTP/1.1\nHost:\nContent-Length: 4", "POST /.%0d./.%0d./.%0d./.%0d./bin/sh HTTP/1.1\nHost: {{Hostname}}\nUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:71.0) Gecko/20100101 Firefox/71.0\nContent-Length: 1\nConnection: close\n\necho\necho\ncat /etc/passwd 2>&1"})
|
|
|
|
|
HTTPRequestDoc.Fields[5].Name = "id"
|
|
|
|
|
HTTPRequestDoc.Fields[5].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[5].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[5].Description = "ID is the ID of the request"
|
|
|
|
|
HTTPRequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the ID of the request"
|
|
|
|
|
HTTPRequestDoc.Fields[6].Name = "name"
|
|
|
|
|
HTTPRequestDoc.Fields[6].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[6].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[6].Description = "Name is the optional name of the request.\n\nIf a name is specified, all the named request in a template can be matched upon\nin a combined manner allowing multirequest based matchers."
|
|
|
|
|
HTTPRequestDoc.Fields[6].Comments[encoder.LineComment] = "Name is the optional name of the request."
|
|
|
|
|
HTTPRequestDoc.Fields[7].Name = "attack"
|
|
|
|
|
HTTPRequestDoc.Fields[7].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[7].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[7].Description = "Attack is the type of payload combinations to perform.\n\nSniper is each payload once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads."
|
|
|
|
|
HTTPRequestDoc.Fields[7].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform."
|
|
|
|
|
HTTPRequestDoc.Fields[7].Values = []string{
|
|
|
|
|
"sniper",
|
|
|
|
|
"pitchfork",
|
|
|
|
|
"clusterbomb",
|
|
|
|
|
}
|
|
|
|
|
HTTPRequestDoc.Fields[8].Name = "method"
|
|
|
|
|
HTTPRequestDoc.Fields[8].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[8].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[8].Description = "Method is the HTTP Request Method."
|
|
|
|
|
HTTPRequestDoc.Fields[8].Comments[encoder.LineComment] = "Method is the HTTP Request Method."
|
|
|
|
|
HTTPRequestDoc.Fields[8].Values = []string{
|
|
|
|
|
"GET",
|
|
|
|
|
"POST",
|
|
|
|
|
"PUT",
|
|
|
|
|
"DELETE",
|
|
|
|
|
}
|
|
|
|
|
HTTPRequestDoc.Fields[9].Name = "body"
|
|
|
|
|
HTTPRequestDoc.Fields[9].Type = "string"
|
|
|
|
|
HTTPRequestDoc.Fields[9].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[9].Description = "Body is an optional parameter which contains HTTP Request body."
|
|
|
|
|
HTTPRequestDoc.Fields[9].Comments[encoder.LineComment] = "Body is an optional parameter which contains HTTP Request body."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[9].AddExample("Same Body for a Login POST request", "username=test&password=test")
|
|
|
|
|
HTTPRequestDoc.Fields[10].Name = "payloads"
|
|
|
|
|
HTTPRequestDoc.Fields[10].Type = "map[string]interface{}"
|
|
|
|
|
HTTPRequestDoc.Fields[10].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[10].Description = "description: |\n Payloads contains any payloads for the current request.\n\n Payloads support both key-values combinations where a list\n of payloads is provided, or optionally a single file can also\n be provided as payload which will be read on run-time.\n examples:\n - name: A payload list for Tomcat Bruteforce\n value: >\n map[string]interface{}{\n \"username\": []string{\"tomcat\", \"admin\"},\n \"password\": []string{\"tomcat\", \"admin\", \"password\"},\n }\n - name: A payload example of reading from file\n value: >\n map[string]interface{}{\n \"data\": \"helpers/payloads/command-injection.txt\",\n }"
|
|
|
|
|
HTTPRequestDoc.Fields[10].Comments[encoder.LineComment] = " description: |"
|
|
|
|
|
HTTPRequestDoc.Fields[11].Name = "headers"
|
|
|
|
|
HTTPRequestDoc.Fields[11].Type = "map[string]string"
|
|
|
|
|
HTTPRequestDoc.Fields[11].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[11].Description = "Headers contains HTTP Headers to send with the request."
|
|
|
|
|
HTTPRequestDoc.Fields[11].Comments[encoder.LineComment] = "Headers contains HTTP Headers to send with the request."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[11].AddExample("", map[string]string{"Content-Type": "application/x-www-form-urlencoded", "Content-Length": "1", "Any-Header": "Any-Value"})
|
|
|
|
|
HTTPRequestDoc.Fields[12].Name = "race_count"
|
|
|
|
|
HTTPRequestDoc.Fields[12].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[12].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[12].Description = "RaceCount is the number of times to send a request in Race Condition Attack."
|
|
|
|
|
HTTPRequestDoc.Fields[12].Comments[encoder.LineComment] = "RaceCount is the number of times to send a request in Race Condition Attack."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[12].AddExample("Send a request 5 times", 5)
|
|
|
|
|
HTTPRequestDoc.Fields[13].Name = "max-redirects"
|
|
|
|
|
HTTPRequestDoc.Fields[13].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[13].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[13].Description = "MaxRedirects is the maximum number of redirects that should be followed."
|
|
|
|
|
HTTPRequestDoc.Fields[13].Comments[encoder.LineComment] = "MaxRedirects is the maximum number of redirects that should be followed."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[13].AddExample("Follow upto 5 redirects", 5)
|
|
|
|
|
HTTPRequestDoc.Fields[14].Name = "pipeline-concurrent-connections"
|
|
|
|
|
HTTPRequestDoc.Fields[14].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[14].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[14].Description = "PipelineConcurrentConnections is number of connections to create during pipelining."
|
|
|
|
|
HTTPRequestDoc.Fields[14].Comments[encoder.LineComment] = "PipelineConcurrentConnections is number of connections to create during pipelining."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[14].AddExample("Create 40 concurrent connections", 40)
|
|
|
|
|
HTTPRequestDoc.Fields[15].Name = "pipeline-requests-per-connection"
|
|
|
|
|
HTTPRequestDoc.Fields[15].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[15].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[15].Description = "PipelineRequestsPerConnection is number of requests to send per connection when pipelining."
|
|
|
|
|
HTTPRequestDoc.Fields[15].Comments[encoder.LineComment] = "PipelineRequestsPerConnection is number of requests to send per connection when pipelining."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[15].AddExample("Send 100 requests per pipeline connection", 100)
|
|
|
|
|
HTTPRequestDoc.Fields[16].Name = "threads"
|
|
|
|
|
HTTPRequestDoc.Fields[16].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[16].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[16].Description = "Threads specifies number of threads to use sending requests. This enables Connection Pooling.\n\nConnection: Close attribute must not be used in request while using threads flag, otherwise\npooling will fail and engine will continue to close connections after requests."
|
|
|
|
|
HTTPRequestDoc.Fields[16].Comments[encoder.LineComment] = "Threads specifies number of threads to use sending requests. This enables Connection Pooling."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[16].AddExample("Send requests using 10 concurrent threads", 10)
|
|
|
|
|
HTTPRequestDoc.Fields[17].Name = "max-size"
|
|
|
|
|
HTTPRequestDoc.Fields[17].Type = "int"
|
|
|
|
|
HTTPRequestDoc.Fields[17].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[17].Description = "MaxSize is the maximum size of http response body to read in bytes."
|
|
|
|
|
HTTPRequestDoc.Fields[17].Comments[encoder.LineComment] = "MaxSize is the maximum size of http response body to read in bytes."
|
|
|
|
|
|
|
|
|
|
HTTPRequestDoc.Fields[17].AddExample("Read max 2048 bytes of the response", 2048)
|
|
|
|
|
HTTPRequestDoc.Fields[18].Name = "cookie-reuse"
|
|
|
|
|
HTTPRequestDoc.Fields[18].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[18].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[18].Description = "CookieReuse is an optional setting that enables cookie reuse for\nall requests defined in raw section."
|
|
|
|
|
HTTPRequestDoc.Fields[18].Comments[encoder.LineComment] = "CookieReuse is an optional setting that enables cookie reuse for"
|
|
|
|
|
HTTPRequestDoc.Fields[19].Name = "redirects"
|
|
|
|
|
HTTPRequestDoc.Fields[19].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[19].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[19].Description = "Redirects specifies whether redirects should be followed by the HTTP Client.\n\nThis can be used in conjunction with `max-redirects` to control the HTTP request redirects."
|
|
|
|
|
HTTPRequestDoc.Fields[19].Comments[encoder.LineComment] = "Redirects specifies whether redirects should be followed by the HTTP Client."
|
|
|
|
|
HTTPRequestDoc.Fields[20].Name = "pipeline"
|
|
|
|
|
HTTPRequestDoc.Fields[20].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[20].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[20].Description = "Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining\n\nAll requests must be indempotent (GET/POST). This can be used for race conditions/billions requests."
|
|
|
|
|
HTTPRequestDoc.Fields[20].Comments[encoder.LineComment] = "Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining"
|
|
|
|
|
HTTPRequestDoc.Fields[21].Name = "unsafe"
|
|
|
|
|
HTTPRequestDoc.Fields[21].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[21].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[21].Description = "Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests.\n\nThis uses the [rawhttp](https://github.com/projectdiscovery/rawhttp) engine to achieve complete\ncontrol over the request, with no normalization performed by the client."
|
|
|
|
|
HTTPRequestDoc.Fields[21].Comments[encoder.LineComment] = "Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests."
|
|
|
|
|
HTTPRequestDoc.Fields[22].Name = "race"
|
|
|
|
|
HTTPRequestDoc.Fields[22].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[22].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[22].Description = "Race determines if all the request have to be attempted at the same time (Race Condition)\n\nThe actual number of requests that will be sent is determined by the `race_count` field."
|
|
|
|
|
HTTPRequestDoc.Fields[22].Comments[encoder.LineComment] = "Race determines if all the request have to be attempted at the same time (Race Condition)"
|
|
|
|
|
HTTPRequestDoc.Fields[23].Name = "req-condition"
|
|
|
|
|
HTTPRequestDoc.Fields[23].Type = "bool"
|
|
|
|
|
HTTPRequestDoc.Fields[23].Note = ""
|
|
|
|
|
HTTPRequestDoc.Fields[23].Description = "ReqCondition automatically assigns numbers to requests and preserves their history.\n\nThis allows matching on them later for multi-request conditions."
|
|
|
|
|
HTTPRequestDoc.Fields[23].Comments[encoder.LineComment] = "ReqCondition automatically assigns numbers to requests and preserves their history."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Type = "matchers.Matcher"
|
|
|
|
|
MATCHERSMatcherDoc.Comments[encoder.LineComment] = " Matcher is used to match a part in the output from a protocol."
|
|
|
|
|
MATCHERSMatcherDoc.Description = "Matcher is used to match a part in the output from a protocol."
|
|
|
|
|
MATCHERSMatcherDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "http.Request",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "dns.Request",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "file.Request",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "network.Request",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "headless.Request",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
MATCHERSMatcherDoc.Fields = make([]encoder.Doc, 12)
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Name = "type"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Type = "string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Description = "Type is the type of the matcher."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Comments[encoder.LineComment] = "Type is the type of the matcher."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[0].Values = []string{
|
|
|
|
|
"status",
|
|
|
|
|
"size",
|
|
|
|
|
"word",
|
|
|
|
|
"regex",
|
|
|
|
|
"binary",
|
|
|
|
|
"dsl",
|
|
|
|
|
}
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Name = "condition"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Type = "string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Description = "Condition is the optional condition between two matcher variables. By default,\nthe condition is assumed to be OR."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Comments[encoder.LineComment] = "Condition is the optional condition between two matcher variables. By default,"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[1].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].Name = "part"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].Type = "string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].Description = "Part is the part of the request response to match data from.\n\nEach protocol exposes a lot of different parts which are well\ndocumented in docs for each request type."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].Comments[encoder.LineComment] = "Part is the part of the request response to match data from."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].AddExample("", "body")
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[2].AddExample("", "raw")
|
|
|
|
|
MATCHERSMatcherDoc.Fields[3].Name = "negative"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[3].Type = "bool"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[3].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[3].Description = "Negative specifies if the match should be reversed\nIt will only match if the condition is not true."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[3].Comments[encoder.LineComment] = "Negative specifies if the match should be reversed"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].Name = "name"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].Type = "string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].Description = "Name of the matcher. Name should be lowercase and must not contain\nspaces or dashes (-)."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].Comments[encoder.LineComment] = "Name of the matcher. Name should be lowercase and must not contain"
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[4].AddExample("", "cookie-matcher")
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].Name = "status"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].Type = "[]int"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].Description = "Status are the acceptable status codes for the response."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].Comments[encoder.LineComment] = "Status are the acceptable status codes for the response."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[5].AddExample("", []int{200, 302})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].Name = "size"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].Type = "[]int"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].Description = "Size is the acceptable size for the response"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].Comments[encoder.LineComment] = "Size is the acceptable size for the response"
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[6].AddExample("", []int{3029, 2042})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].Name = "words"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].Type = "[]string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].Description = "Words contains word patterns required to be present in the response part."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].Comments[encoder.LineComment] = "Words contains word patterns required to be present in the response part."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].AddExample("Match for outlook mail protection domain", []string{"mail.protection.outlook.com"})
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[7].AddExample("Match for application/json in response headers", []string{"application/json"})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].Name = "regex"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].Type = "[]string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].Description = "Regex contains Regular Expression patterns required to be present in the response part."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].Comments[encoder.LineComment] = "Regex contains Regular Expression patterns required to be present in the response part."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].AddExample("Match for Linkerd Service via Regex", []string{`(?mi)^Via\\s*?:.*?linkerd.*$`})
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[8].AddExample("Match for Open Redirect via Location header", []string{`(?m)^(?:Location\\s*?:\\s*?)(?:https?://|//)?(?:[a-zA-Z0-9\\-_\\.@]*)example\\.com.*$`})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].Name = "binary"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].Type = "[]string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].Description = "Binary are the binary patterns required to be present in the response part."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].Comments[encoder.LineComment] = "Binary are the binary patterns required to be present in the response part."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].AddExample("Match for Springboot Heapdump Actuator \"JAVA PROFILE\", \"HPROF\", \"Gunzip magic byte\"", []string{"4a4156412050524f46494c45", "4850524f46", "1f8b080000000000"})
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[9].AddExample("Match for 7zip files", []string{"377ABCAF271C"})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].Name = "dsl"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].Type = "[]string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].Description = "DSL are the dsl expressions that will be evaluated as part of nuclei matching rules.\nA list of these helper functions are available [here](https://nuclei.projectdiscovery.io/templating-guide/helper-functions/)."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].Comments[encoder.LineComment] = "DSL are the dsl expressions that will be evaluated as part of nuclei matching rules."
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].AddExample("DSL Matcher for package.json file", []string{"contains(body, 'packages') && contains(tolower(all_headers), 'application/octet-stream') && status_code == 200"})
|
|
|
|
|
|
|
|
|
|
MATCHERSMatcherDoc.Fields[10].AddExample("DSL Matcher for missing strict transport security header", []string{"!contains(tolower(all_headers), ''strict-transport-security'')"})
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Name = "encoding"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Type = "string"
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Note = ""
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Description = "Encoding specifies the encoding for the words field if any."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Comments[encoder.LineComment] = "Encoding specifies the encoding for the words field if any."
|
|
|
|
|
MATCHERSMatcherDoc.Fields[11].Values = []string{
|
|
|
|
|
"hex",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Type = "extractors.Extractor"
|
|
|
|
|
EXTRACTORSExtractorDoc.Comments[encoder.LineComment] = " Extractor is used to extract part of response using a regex."
|
|
|
|
|
EXTRACTORSExtractorDoc.Description = "Extractor is used to extract part of response using a regex."
|
|
|
|
|
EXTRACTORSExtractorDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "http.Request",
|
|
|
|
|
FieldName: "extractors",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "dns.Request",
|
|
|
|
|
FieldName: "extractors",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "file.Request",
|
|
|
|
|
FieldName: "extractors",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "network.Request",
|
|
|
|
|
FieldName: "extractors",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "headless.Request",
|
|
|
|
|
FieldName: "extractors",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields = make([]encoder.Doc, 8)
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].Name = "name"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].Type = "string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].Description = "Name of the extractor. Name should be lowercase and must not contain\nspaces or dashes (-)."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].Comments[encoder.LineComment] = "Name of the extractor. Name should be lowercase and must not contain"
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[0].AddExample("", "cookie-extractor")
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Name = "type"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Type = "string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Description = "Type is the type of the extractor."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Comments[encoder.LineComment] = "Type is the type of the extractor."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[1].Values = []string{
|
|
|
|
|
"regex",
|
|
|
|
|
"kval",
|
|
|
|
|
}
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].Name = "regex"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].Type = "[]string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].Description = "Regex contains the regular expression patterns to exract from a part.\n\nGo regex engine does not supports lookaheads or lookbehinds, so as a result\nthey are also not supported in nuclei."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].Comments[encoder.LineComment] = "Regex contains the regular expression patterns to exract from a part."
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].AddExample("Braintree Access Token Regex", []string{"access_token\\$production\\$[0-9a-z]{16}\\$[0-9a-f]{32}"})
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[2].AddExample("Wordpress Author Extraction regex", []string{"Author:(?:[A-Za-z0-9 -\\_=\"]+)?<span(?:[A-Za-z0-9 -\\_=\"]+)?>([A-Za-z0-9]+)<\\/span>"})
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].Name = "group"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].Type = "int"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].Description = "Group specifies a numbered group to extract from the regex."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].Comments[encoder.LineComment] = "Group specifies a numbered group to extract from the regex."
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[3].AddExample("", 1)
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].Name = "kval"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].Type = "[]string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].Description = "kval contains the key-value pairs required in the response.\n\nEach protocol exposes a lot of different data in response. The kval\nextractor can be used to extract those key-value pairs. A list of\nsupported parts is available in docs for request types."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].Comments[encoder.LineComment] = "kval contains the key-value pairs required in the response."
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].AddExample("Extract Server Header From HTTP Response", []string{"Server"})
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[4].AddExample("Extracting value of PHPSESSID Cookie", []string{"PHPSESSID"})
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].Name = "part"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].Type = "string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].Description = "Part is the part of the request response to extract data from.\n\nEach protocol exposes a lot of different parts which are well\ndocumented in docs for each request type."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].Comments[encoder.LineComment] = "Part is the part of the request response to extract data from."
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].AddExample("", "body")
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[5].AddExample("", "raw")
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].Name = "json"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].Type = "[]string"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].Description = "JSON allows using jq-style syntax to extract items from json response"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].Comments[encoder.LineComment] = "JSON allows using jq-style syntax to extract items from json response"
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].AddExample("", ".[] | .id")
|
|
|
|
|
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[6].AddExample("", ".batters | .batter | .[] | .id")
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[7].Name = "internal"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[7].Type = "bool"
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[7].Note = ""
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[7].Description = "Internal, when set to true will allow using the value extracted\nin the next request for some protocols (like HTTP)."
|
|
|
|
|
EXTRACTORSExtractorDoc.Fields[7].Comments[encoder.LineComment] = "Internal, when set to true will allow using the value extracted"
|
|
|
|
|
|
|
|
|
|
DNSRequestDoc.Type = "dns.Request"
|
|
|
|
|
DNSRequestDoc.Comments[encoder.LineComment] = " Request contains a DNS protocol request to be made from a template"
|
|
|
|
|
DNSRequestDoc.Description = "Request contains a DNS protocol request to be made from a template"
|
|
|
|
|
DNSRequestDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "dns",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
DNSRequestDoc.Fields = make([]encoder.Doc, 9)
|
|
|
|
|
DNSRequestDoc.Fields[0].Name = "matchers"
|
|
|
|
|
DNSRequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
|
|
|
|
DNSRequestDoc.Fields[0].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
|
|
|
|
DNSRequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
|
|
|
|
DNSRequestDoc.Fields[1].Name = "extractors"
|
|
|
|
|
DNSRequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
|
|
|
|
DNSRequestDoc.Fields[1].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[1].Description = "Extractors contains the extraction mechanism for the request to identify\nand extract parts of the response."
|
|
|
|
|
DNSRequestDoc.Fields[1].Comments[encoder.LineComment] = "Extractors contains the extraction mechanism for the request to identify"
|
|
|
|
|
DNSRequestDoc.Fields[2].Name = "matchers-condition"
|
|
|
|
|
DNSRequestDoc.Fields[2].Type = "string"
|
|
|
|
|
DNSRequestDoc.Fields[2].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[2].Description = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
DNSRequestDoc.Fields[2].Comments[encoder.LineComment] = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
DNSRequestDoc.Fields[2].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
DNSRequestDoc.Fields[3].Name = "id"
|
|
|
|
|
DNSRequestDoc.Fields[3].Type = "string"
|
|
|
|
|
DNSRequestDoc.Fields[3].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[3].Description = "ID is the ID of the request"
|
|
|
|
|
DNSRequestDoc.Fields[3].Comments[encoder.LineComment] = " ID is the ID of the request"
|
|
|
|
|
DNSRequestDoc.Fields[4].Name = "name"
|
|
|
|
|
DNSRequestDoc.Fields[4].Type = "string"
|
|
|
|
|
DNSRequestDoc.Fields[4].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[4].Description = "Name is the Hostname to make DNS request for.\n\nGenerally, it is set to {{FQDN}} which is the domain we get from input."
|
|
|
|
|
DNSRequestDoc.Fields[4].Comments[encoder.LineComment] = "Name is the Hostname to make DNS request for."
|
|
|
|
|
|
|
|
|
|
DNSRequestDoc.Fields[4].AddExample("", "{{FQDN}}")
|
|
|
|
|
DNSRequestDoc.Fields[5].Name = "type"
|
|
|
|
|
DNSRequestDoc.Fields[5].Type = "string"
|
|
|
|
|
DNSRequestDoc.Fields[5].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[5].Description = "Type is the type of DNS request to make."
|
|
|
|
|
DNSRequestDoc.Fields[5].Comments[encoder.LineComment] = "Type is the type of DNS request to make."
|
|
|
|
|
DNSRequestDoc.Fields[5].Values = []string{
|
|
|
|
|
"A",
|
|
|
|
|
"NS",
|
|
|
|
|
"CNAME",
|
|
|
|
|
"SOA",
|
|
|
|
|
"PTR",
|
|
|
|
|
"MX",
|
|
|
|
|
"TXT",
|
|
|
|
|
"AAAA",
|
|
|
|
|
}
|
|
|
|
|
DNSRequestDoc.Fields[6].Name = "class"
|
|
|
|
|
DNSRequestDoc.Fields[6].Type = "string"
|
|
|
|
|
DNSRequestDoc.Fields[6].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[6].Description = "Class is the class of the DNS request.\n\nUsually it's enough to just leave it as INET."
|
|
|
|
|
DNSRequestDoc.Fields[6].Comments[encoder.LineComment] = "Class is the class of the DNS request."
|
|
|
|
|
DNSRequestDoc.Fields[6].Values = []string{
|
|
|
|
|
"INET",
|
|
|
|
|
"CSNET",
|
|
|
|
|
"CHAOS",
|
|
|
|
|
"HESIOD",
|
|
|
|
|
"NONE",
|
|
|
|
|
"ANY",
|
|
|
|
|
}
|
|
|
|
|
DNSRequestDoc.Fields[7].Name = "retries"
|
|
|
|
|
DNSRequestDoc.Fields[7].Type = "int"
|
|
|
|
|
DNSRequestDoc.Fields[7].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[7].Description = "Retries is the number of retries for the DNS request"
|
|
|
|
|
DNSRequestDoc.Fields[7].Comments[encoder.LineComment] = "Retries is the number of retries for the DNS request"
|
|
|
|
|
|
|
|
|
|
DNSRequestDoc.Fields[7].AddExample("Use a retry of 3 to 5 generally", 5)
|
|
|
|
|
DNSRequestDoc.Fields[8].Name = "recursion"
|
|
|
|
|
DNSRequestDoc.Fields[8].Type = "bool"
|
|
|
|
|
DNSRequestDoc.Fields[8].Note = ""
|
|
|
|
|
DNSRequestDoc.Fields[8].Description = "Recursion determines if resolver should recurse all records to get fresh results."
|
|
|
|
|
DNSRequestDoc.Fields[8].Comments[encoder.LineComment] = "Recursion determines if resolver should recurse all records to get fresh results."
|
|
|
|
|
|
|
|
|
|
FILERequestDoc.Type = "file.Request"
|
|
|
|
|
FILERequestDoc.Comments[encoder.LineComment] = " Request contains a File matching mechanism for local disk operations."
|
|
|
|
|
FILERequestDoc.Description = "Request contains a File matching mechanism for local disk operations."
|
|
|
|
|
FILERequestDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "file",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
FILERequestDoc.Fields = make([]encoder.Doc, 8)
|
|
|
|
|
FILERequestDoc.Fields[0].Name = "matchers"
|
|
|
|
|
FILERequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
|
|
|
|
FILERequestDoc.Fields[0].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
|
|
|
|
FILERequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
|
|
|
|
FILERequestDoc.Fields[1].Name = "extractors"
|
|
|
|
|
FILERequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
|
|
|
|
FILERequestDoc.Fields[1].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[1].Description = "Extractors contains the extraction mechanism for the request to identify\nand extract parts of the response."
|
|
|
|
|
FILERequestDoc.Fields[1].Comments[encoder.LineComment] = "Extractors contains the extraction mechanism for the request to identify"
|
|
|
|
|
FILERequestDoc.Fields[2].Name = "matchers-condition"
|
|
|
|
|
FILERequestDoc.Fields[2].Type = "string"
|
|
|
|
|
FILERequestDoc.Fields[2].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[2].Description = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
FILERequestDoc.Fields[2].Comments[encoder.LineComment] = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
FILERequestDoc.Fields[2].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
FILERequestDoc.Fields[3].Name = "extensions"
|
|
|
|
|
FILERequestDoc.Fields[3].Type = "[]string"
|
|
|
|
|
FILERequestDoc.Fields[3].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[3].Description = "Extensions is the list of extensions to perform matching on."
|
|
|
|
|
FILERequestDoc.Fields[3].Comments[encoder.LineComment] = "Extensions is the list of extensions to perform matching on."
|
|
|
|
|
|
|
|
|
|
FILERequestDoc.Fields[3].AddExample("", []string{".txt", ".go", ".json"})
|
|
|
|
|
FILERequestDoc.Fields[4].Name = "denylist"
|
|
|
|
|
FILERequestDoc.Fields[4].Type = "[]string"
|
|
|
|
|
FILERequestDoc.Fields[4].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[4].Description = "ExtensionDenylist is the list of file extensions to deny during matching.\n\nBy default, it contains some non-interesting extensions that are hardcoded\nin nuclei."
|
|
|
|
|
FILERequestDoc.Fields[4].Comments[encoder.LineComment] = "ExtensionDenylist is the list of file extensions to deny during matching."
|
|
|
|
|
|
|
|
|
|
FILERequestDoc.Fields[4].AddExample("", []string{".avi", ".mov", ".mp3"})
|
|
|
|
|
FILERequestDoc.Fields[5].Name = "id"
|
|
|
|
|
FILERequestDoc.Fields[5].Type = "string"
|
|
|
|
|
FILERequestDoc.Fields[5].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[5].Description = "ID is the ID of the request"
|
|
|
|
|
FILERequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the ID of the request"
|
|
|
|
|
FILERequestDoc.Fields[6].Name = "max-size"
|
|
|
|
|
FILERequestDoc.Fields[6].Type = "int"
|
|
|
|
|
FILERequestDoc.Fields[6].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[6].Description = "MaxSize is the maximum size of the file to run request on.\n\nBy default, nuclei will process 5MB files and not go more than that.\nIt can be set to much lower or higher depending on use."
|
|
|
|
|
FILERequestDoc.Fields[6].Comments[encoder.LineComment] = "MaxSize is the maximum size of the file to run request on."
|
|
|
|
|
|
|
|
|
|
FILERequestDoc.Fields[6].AddExample("", 2048)
|
|
|
|
|
FILERequestDoc.Fields[7].Name = "no-recursive"
|
|
|
|
|
FILERequestDoc.Fields[7].Type = "bool"
|
|
|
|
|
FILERequestDoc.Fields[7].Note = ""
|
|
|
|
|
FILERequestDoc.Fields[7].Description = "NoRecursive specifies whether to not do recursive checks if folders are provided."
|
|
|
|
|
FILERequestDoc.Fields[7].Comments[encoder.LineComment] = "NoRecursive specifies whether to not do recursive checks if folders are provided."
|
|
|
|
|
|
|
|
|
|
NETWORKRequestDoc.Type = "network.Request"
|
|
|
|
|
NETWORKRequestDoc.Comments[encoder.LineComment] = " Request contains a Network protocol request to be made from a template"
|
|
|
|
|
NETWORKRequestDoc.Description = "Request contains a Network protocol request to be made from a template"
|
|
|
|
|
NETWORKRequestDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "network",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
NETWORKRequestDoc.Fields = make([]encoder.Doc, 9)
|
|
|
|
|
NETWORKRequestDoc.Fields[0].Name = "id"
|
|
|
|
|
NETWORKRequestDoc.Fields[0].Type = "string"
|
|
|
|
|
NETWORKRequestDoc.Fields[0].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[0].Description = "ID is the ID of the request"
|
|
|
|
|
NETWORKRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the ID of the request"
|
|
|
|
|
NETWORKRequestDoc.Fields[1].Name = "host"
|
|
|
|
|
NETWORKRequestDoc.Fields[1].Type = "[]string"
|
|
|
|
|
NETWORKRequestDoc.Fields[1].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[1].Description = "Address is the address to send requests to.\n\nUsually it's set to `{{Hostname}}`. If you want to enable TLS for\nTCP Connection, you can use `tls://{{Hostname}}`."
|
|
|
|
|
NETWORKRequestDoc.Fields[1].Comments[encoder.LineComment] = "Address is the address to send requests to."
|
|
|
|
|
|
|
|
|
|
NETWORKRequestDoc.Fields[1].AddExample("", []string{"{{Hostname}}"})
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Name = "attack"
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Type = "string"
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Description = "Attack is the type of payload combinations to perform.\n\nSniper is each payload once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads."
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform."
|
|
|
|
|
NETWORKRequestDoc.Fields[2].Values = []string{
|
|
|
|
|
"sniper",
|
|
|
|
|
"pitchfork",
|
|
|
|
|
"clusterbomb",
|
|
|
|
|
}
|
|
|
|
|
NETWORKRequestDoc.Fields[3].Name = "payloads"
|
|
|
|
|
NETWORKRequestDoc.Fields[3].Type = "map[string]interface{}"
|
|
|
|
|
NETWORKRequestDoc.Fields[3].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[3].Description = "Payloads contains any payloads for the current request.\n\nPayloads support both key-values combinations where a list\nof payloads is provided, or optionally a single file can also\nbe provided as payload which will be read on run-time."
|
|
|
|
|
NETWORKRequestDoc.Fields[3].Comments[encoder.LineComment] = "Payloads contains any payloads for the current request."
|
|
|
|
|
NETWORKRequestDoc.Fields[4].Name = "inputs"
|
|
|
|
|
NETWORKRequestDoc.Fields[4].Type = "[]network.Input"
|
|
|
|
|
NETWORKRequestDoc.Fields[4].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[4].Description = "Inputs contains inputs for the network socket"
|
|
|
|
|
NETWORKRequestDoc.Fields[4].Comments[encoder.LineComment] = "Inputs contains inputs for the network socket"
|
|
|
|
|
NETWORKRequestDoc.Fields[5].Name = "read-size"
|
|
|
|
|
NETWORKRequestDoc.Fields[5].Type = "int"
|
|
|
|
|
NETWORKRequestDoc.Fields[5].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[5].Description = "ReadSize is the size of response to read at the end\n\nDefault value for read-size is 1024."
|
|
|
|
|
NETWORKRequestDoc.Fields[5].Comments[encoder.LineComment] = "ReadSize is the size of response to read at the end"
|
|
|
|
|
|
|
|
|
|
NETWORKRequestDoc.Fields[5].AddExample("", 2048)
|
|
|
|
|
NETWORKRequestDoc.Fields[6].Name = "matchers"
|
|
|
|
|
NETWORKRequestDoc.Fields[6].Type = "[]matchers.Matcher"
|
|
|
|
|
NETWORKRequestDoc.Fields[6].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[6].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
|
|
|
|
NETWORKRequestDoc.Fields[6].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
|
|
|
|
NETWORKRequestDoc.Fields[7].Name = "extractors"
|
|
|
|
|
NETWORKRequestDoc.Fields[7].Type = "[]extractors.Extractor"
|
|
|
|
|
NETWORKRequestDoc.Fields[7].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[7].Description = "Extractors contains the extraction mechanism for the request to identify\nand extract parts of the response."
|
|
|
|
|
NETWORKRequestDoc.Fields[7].Comments[encoder.LineComment] = "Extractors contains the extraction mechanism for the request to identify"
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Name = "matchers-condition"
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Type = "string"
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Note = ""
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Description = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Comments[encoder.LineComment] = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
NETWORKRequestDoc.Fields[8].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
NETWORKInputDoc.Type = "network.Input"
|
|
|
|
|
NETWORKInputDoc.Comments[encoder.LineComment] = ""
|
|
|
|
|
NETWORKInputDoc.Description = ""
|
|
|
|
|
NETWORKInputDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "network.Request",
|
|
|
|
|
FieldName: "inputs",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
NETWORKInputDoc.Fields = make([]encoder.Doc, 4)
|
|
|
|
|
NETWORKInputDoc.Fields[0].Name = "data"
|
|
|
|
|
NETWORKInputDoc.Fields[0].Type = "string"
|
|
|
|
|
NETWORKInputDoc.Fields[0].Note = ""
|
|
|
|
|
NETWORKInputDoc.Fields[0].Description = "Data is the data to send as the input.\n\nIt supports DSL Helper Functions as well as normal expressions."
|
|
|
|
|
NETWORKInputDoc.Fields[0].Comments[encoder.LineComment] = "Data is the data to send as the input."
|
|
|
|
|
|
|
|
|
|
NETWORKInputDoc.Fields[0].AddExample("", "TEST")
|
|
|
|
|
|
|
|
|
|
NETWORKInputDoc.Fields[0].AddExample("", "hex_decode('50494e47')")
|
|
|
|
|
NETWORKInputDoc.Fields[1].Name = "type"
|
|
|
|
|
NETWORKInputDoc.Fields[1].Type = "string"
|
|
|
|
|
NETWORKInputDoc.Fields[1].Note = ""
|
|
|
|
|
NETWORKInputDoc.Fields[1].Description = "Type is the type of input specified in `data` field.\n\nDefault value is text, but hex can be used for hex formatted data."
|
|
|
|
|
NETWORKInputDoc.Fields[1].Comments[encoder.LineComment] = "Type is the type of input specified in `data` field."
|
|
|
|
|
NETWORKInputDoc.Fields[1].Values = []string{
|
|
|
|
|
"hex",
|
|
|
|
|
"text",
|
|
|
|
|
}
|
|
|
|
|
NETWORKInputDoc.Fields[2].Name = "read"
|
|
|
|
|
NETWORKInputDoc.Fields[2].Type = "int"
|
|
|
|
|
NETWORKInputDoc.Fields[2].Note = ""
|
|
|
|
|
NETWORKInputDoc.Fields[2].Description = "Read is the number of bytes to read from socket.\n\nThis can be used for protcols which expected an immediate response. You can\nread and write responses one after another and evetually perform matching\non every data captured with `name` attribute.\n\nThe [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this."
|
|
|
|
|
NETWORKInputDoc.Fields[2].Comments[encoder.LineComment] = "Read is the number of bytes to read from socket."
|
|
|
|
|
|
|
|
|
|
NETWORKInputDoc.Fields[2].AddExample("", 1024)
|
|
|
|
|
NETWORKInputDoc.Fields[3].Name = "name"
|
|
|
|
|
NETWORKInputDoc.Fields[3].Type = "string"
|
|
|
|
|
NETWORKInputDoc.Fields[3].Note = ""
|
|
|
|
|
NETWORKInputDoc.Fields[3].Description = "Name is the optional name of the data read to provide matching on."
|
|
|
|
|
NETWORKInputDoc.Fields[3].Comments[encoder.LineComment] = "Name is the optional name of the data read to provide matching on."
|
|
|
|
|
|
|
|
|
|
NETWORKInputDoc.Fields[3].AddExample("", "prefix")
|
|
|
|
|
|
|
|
|
|
HEADLESSRequestDoc.Type = "headless.Request"
|
|
|
|
|
HEADLESSRequestDoc.Comments[encoder.LineComment] = " Request contains a Headless protocol request to be made from a template"
|
|
|
|
|
HEADLESSRequestDoc.Description = "Request contains a Headless protocol request to be made from a template"
|
|
|
|
|
HEADLESSRequestDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "headless",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
HEADLESSRequestDoc.Fields = make([]encoder.Doc, 5)
|
|
|
|
|
HEADLESSRequestDoc.Fields[0].Name = "id"
|
|
|
|
|
HEADLESSRequestDoc.Fields[0].Type = "string"
|
|
|
|
|
HEADLESSRequestDoc.Fields[0].Note = ""
|
|
|
|
|
HEADLESSRequestDoc.Fields[0].Description = "ID is the ID of the request"
|
|
|
|
|
HEADLESSRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the ID of the request"
|
|
|
|
|
HEADLESSRequestDoc.Fields[1].Name = "steps"
|
|
|
|
|
HEADLESSRequestDoc.Fields[1].Type = "[]engine.Action"
|
|
|
|
|
HEADLESSRequestDoc.Fields[1].Note = ""
|
|
|
|
|
HEADLESSRequestDoc.Fields[1].Description = "Steps is the list of actions to run for headless request"
|
|
|
|
|
HEADLESSRequestDoc.Fields[1].Comments[encoder.LineComment] = "Steps is the list of actions to run for headless request"
|
|
|
|
|
HEADLESSRequestDoc.Fields[2].Name = "matchers"
|
|
|
|
|
HEADLESSRequestDoc.Fields[2].Type = "[]matchers.Matcher"
|
|
|
|
|
HEADLESSRequestDoc.Fields[2].Note = ""
|
|
|
|
|
HEADLESSRequestDoc.Fields[2].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
|
|
|
|
HEADLESSRequestDoc.Fields[2].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
|
|
|
|
HEADLESSRequestDoc.Fields[3].Name = "extractors"
|
|
|
|
|
HEADLESSRequestDoc.Fields[3].Type = "[]extractors.Extractor"
|
|
|
|
|
HEADLESSRequestDoc.Fields[3].Note = ""
|
|
|
|
|
HEADLESSRequestDoc.Fields[3].Description = "Extractors contains the extraction mechanism for the request to identify\nand extract parts of the response."
|
|
|
|
|
HEADLESSRequestDoc.Fields[3].Comments[encoder.LineComment] = "Extractors contains the extraction mechanism for the request to identify"
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Name = "matchers-condition"
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Type = "string"
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Note = ""
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Description = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Comments[encoder.LineComment] = "MatchersCondition is the condition between the matchers. Default is OR."
|
|
|
|
|
HEADLESSRequestDoc.Fields[4].Values = []string{
|
|
|
|
|
"and",
|
|
|
|
|
"or",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
ENGINEActionDoc.Type = "engine.Action"
|
|
|
|
|
ENGINEActionDoc.Comments[encoder.LineComment] = " Action is an action taken by the browser to reach a navigation"
|
|
|
|
|
ENGINEActionDoc.Description = "Action is an action taken by the browser to reach a navigation\n\n Each step that the browser executes is an action. Most navigations\n usually start from the ActionLoadURL event, and further navigations\n are discovered on the found page. We also keep track and only\n scrape new navigation from pages we haven't crawled yet."
|
|
|
|
|
ENGINEActionDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "headless.Request",
|
|
|
|
|
FieldName: "steps",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
ENGINEActionDoc.Fields = make([]encoder.Doc, 4)
|
|
|
|
|
ENGINEActionDoc.Fields[0].Name = "args"
|
|
|
|
|
ENGINEActionDoc.Fields[0].Type = "map[string]string"
|
|
|
|
|
ENGINEActionDoc.Fields[0].Note = ""
|
|
|
|
|
ENGINEActionDoc.Fields[0].Description = "Args contain arguments for the headless action.\nPer action arguments are described in detail [here](https://nuclei.projectdiscovery.io/templating-guide/protocols/headless/)."
|
|
|
|
|
ENGINEActionDoc.Fields[0].Comments[encoder.LineComment] = "Args contain arguments for the headless action."
|
|
|
|
|
ENGINEActionDoc.Fields[1].Name = "name"
|
|
|
|
|
ENGINEActionDoc.Fields[1].Type = "string"
|
|
|
|
|
ENGINEActionDoc.Fields[1].Note = ""
|
|
|
|
|
ENGINEActionDoc.Fields[1].Description = "Name is the name assigned to the headless action.\n\nThis can be used to execute code, for instance in browser\nDOM using script action, and get the result in a variable\nwhich can be matched upon by nuclei. An Example template [here](https://github.com/projectdiscovery/nuclei-templates/blob/master/headless/prototype-pollution-check.yaml)."
|
|
|
|
|
ENGINEActionDoc.Fields[1].Comments[encoder.LineComment] = "Name is the name assigned to the headless action."
|
|
|
|
|
ENGINEActionDoc.Fields[2].Name = "description"
|
|
|
|
|
ENGINEActionDoc.Fields[2].Type = "string"
|
|
|
|
|
ENGINEActionDoc.Fields[2].Note = ""
|
|
|
|
|
ENGINEActionDoc.Fields[2].Description = "Description is the optional description of the headless action"
|
|
|
|
|
ENGINEActionDoc.Fields[2].Comments[encoder.LineComment] = "Description is the optional description of the headless action"
|
|
|
|
|
ENGINEActionDoc.Fields[3].Name = "action"
|
|
|
|
|
ENGINEActionDoc.Fields[3].Type = "string"
|
|
|
|
|
ENGINEActionDoc.Fields[3].Note = ""
|
|
|
|
|
ENGINEActionDoc.Fields[3].Description = "Action is the type of the action to perform."
|
|
|
|
|
ENGINEActionDoc.Fields[3].Comments[encoder.LineComment] = "Action is the type of the action to perform."
|
|
|
|
|
ENGINEActionDoc.Fields[3].Values = []string{
|
|
|
|
|
"navigate",
|
|
|
|
|
"script",
|
|
|
|
|
"click",
|
|
|
|
|
"rightclick",
|
|
|
|
|
"text",
|
|
|
|
|
"screenshot",
|
|
|
|
|
"time",
|
|
|
|
|
"select",
|
|
|
|
|
"files",
|
|
|
|
|
"waitload",
|
|
|
|
|
"getresource",
|
|
|
|
|
"extract",
|
|
|
|
|
"setmethod",
|
|
|
|
|
"addheader",
|
|
|
|
|
"setheader",
|
|
|
|
|
"deleteheader",
|
|
|
|
|
"setbody",
|
|
|
|
|
"waitevent",
|
|
|
|
|
"keyboard",
|
|
|
|
|
"debug",
|
|
|
|
|
"sleep",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Type = "workflows.WorkflowTemplate"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Comments[encoder.LineComment] = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Description = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "Template",
|
|
|
|
|
FieldName: "workflows",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "workflows.WorkflowTemplate",
|
|
|
|
|
FieldName: "subtemplates",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
TypeName: "workflows.Matcher",
|
|
|
|
|
FieldName: "subtemplates",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields = make([]encoder.Doc, 4)
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].Name = "template"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].Type = "string"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].Note = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].Description = "Template is a single template or directory to execute as part of workflow."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].Comments[encoder.LineComment] = "Template is a single template or directory to execute as part of workflow."
|
|
|
|
|
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].AddExample("A single template", "dns/worksites-detection.yaml")
|
|
|
|
|
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[0].AddExample("A template directory", "misconfigurations/aem")
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[1].Name = "tags"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[1].Type = "string"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[1].Note = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[1].Description = "Tags to run templates based on."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[1].Comments[encoder.LineComment] = "Tags to run templates based on."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[2].Name = "matchers"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[2].Type = "[]workflows.Matcher"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[2].Note = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[2].Description = "Matchers perform name based matching to run subtemplates for a workflow."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[2].Comments[encoder.LineComment] = "Matchers perform name based matching to run subtemplates for a workflow."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[3].Name = "subtemplates"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[3].Type = "[]workflows.WorkflowTemplate"
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[3].Note = ""
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[3].Description = "Subtemplates are ran if the `template` field Template matches."
|
|
|
|
|
WORKFLOWSWorkflowTemplateDoc.Fields[3].Comments[encoder.LineComment] = "Subtemplates are ran if the `template` field Template matches."
|
|
|
|
|
|
|
|
|
|
WORKFLOWSMatcherDoc.Type = "workflows.Matcher"
|
|
|
|
|
WORKFLOWSMatcherDoc.Comments[encoder.LineComment] = ""
|
|
|
|
|
WORKFLOWSMatcherDoc.Description = ""
|
|
|
|
|
WORKFLOWSMatcherDoc.AppearsIn = []encoder.Appearance{
|
|
|
|
|
{
|
|
|
|
|
TypeName: "workflows.WorkflowTemplate",
|
|
|
|
|
FieldName: "matchers",
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields = make([]encoder.Doc, 2)
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[0].Name = "name"
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[0].Type = "string"
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[0].Note = ""
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[0].Description = "Name is the name of the item to match."
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[0].Comments[encoder.LineComment] = "Name is the name of the item to match."
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[1].Name = "subtemplates"
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[1].Type = "[]workflows.WorkflowTemplate"
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[1].Note = ""
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[1].Description = "Subtemplates are ran if the name of matcher matches."
|
|
|
|
|
WORKFLOWSMatcherDoc.Fields[1].Comments[encoder.LineComment] = "Subtemplates are ran if the name of matcher matches."
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetTemplateDoc returns documentation for the file templates_doc.go.
|
|
|
|
|
func GetTemplateDoc() *encoder.FileDoc {
|
|
|
|
|
return &encoder.FileDoc{
|
|
|
|
|
Name: "Template",
|
|
|
|
|
Description: "",
|
|
|
|
|
Structs: []*encoder.Doc{
|
|
|
|
|
&TemplateDoc,
|
|
|
|
|
&HTTPRequestDoc,
|
|
|
|
|
&MATCHERSMatcherDoc,
|
|
|
|
|
&EXTRACTORSExtractorDoc,
|
|
|
|
|
&DNSRequestDoc,
|
|
|
|
|
&FILERequestDoc,
|
|
|
|
|
&NETWORKRequestDoc,
|
|
|
|
|
&NETWORKInputDoc,
|
|
|
|
|
&HEADLESSRequestDoc,
|
|
|
|
|
&ENGINEActionDoc,
|
|
|
|
|
&WORKFLOWSWorkflowTemplateDoc,
|
|
|
|
|
&WORKFLOWSMatcherDoc,
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
}
|
Ice3man543