mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-17 17:25:28 +00:00
8c27ca2591
* fix(schema): generation of missing JSON schema definitions * make headers and data to accept multi-type inputs * misc update
85 lines
3.0 KiB
Go
85 lines
3.0 KiB
Go
package engine
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/invopop/jsonschema"
|
|
)
|
|
|
|
// Action is an action taken by the browser to reach a navigation
|
|
//
|
|
// Each step that the browser executes is an action. Most navigations
|
|
// usually start from the ActionLoadURL event, and further navigations
|
|
// are discovered on the found page. We also keep track and only
|
|
// scrape new navigation from pages we haven't crawled yet.
|
|
type Action struct {
|
|
// description:
|
|
// Args contain arguments for the headless action.
|
|
//
|
|
// Per action arguments are described in detail [here](https://nuclei.projectdiscovery.io/templating-guide/protocols/headless/).
|
|
Data map[string]string `yaml:"args,omitempty" json:"args,omitempty" jsonschema:"title=arguments for headless action,description=Args contain arguments for the headless action"`
|
|
// description: |
|
|
// Name is the name assigned to the headless action.
|
|
//
|
|
// This can be used to execute code, for instance in browser
|
|
// DOM using script action, and get the result in a variable
|
|
// which can be matched upon by nuclei. An Example template [here](https://github.com/projectdiscovery/nuclei-templates/blob/main/headless/prototype-pollution-check.yaml).
|
|
Name string `yaml:"name,omitempty" json:"name,omitempty" jsonschema:"title=name for headless action,description=Name is the name assigned to the headless action"`
|
|
// description: |
|
|
// Description is the optional description of the headless action
|
|
Description string `yaml:"description,omitempty" json:"description,omitempty" jsonschema:"title=description for headless action,description=Description of the headless action"`
|
|
// description: |
|
|
// Action is the type of the action to perform.
|
|
ActionType ActionTypeHolder `yaml:"action" json:"action" jsonschema:"title=action to perform,description=Type of actions to perform,enum=navigate,enum=script,enum=click,enum=rightclick,enum=text,enum=screenshot,enum=time,enum=select,enum=files,enum=waitload,enum=getresource,enum=extract,enum=setmethod,enum=addheader,enum=setheader,enum=deleteheader,enum=setbody,enum=waitevent,enum=keyboard,enum=debug,enum=sleep"`
|
|
}
|
|
|
|
func (a Action) JSONSchemaExtend(schema *jsonschema.Schema) {
|
|
argsSchema, ok := schema.Properties.Get("args")
|
|
if !ok {
|
|
return
|
|
}
|
|
argsSchema.PatternProperties = map[string]*jsonschema.Schema{
|
|
".*": {
|
|
OneOf: []*jsonschema.Schema{
|
|
{
|
|
Type: "string",
|
|
},
|
|
{
|
|
Type: "integer",
|
|
},
|
|
{
|
|
Type: "boolean",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
argsSchema.Ref = ""
|
|
}
|
|
|
|
// String returns the string representation of an action
|
|
func (a *Action) String() string {
|
|
builder := &strings.Builder{}
|
|
builder.WriteString(a.ActionType.String())
|
|
if a.Name != "" {
|
|
builder.WriteString(" Name:")
|
|
builder.WriteString(a.Name)
|
|
}
|
|
builder.WriteString(" ")
|
|
for k, v := range a.Data {
|
|
builder.WriteString(k)
|
|
builder.WriteString(":")
|
|
builder.WriteString(v)
|
|
builder.WriteString(",")
|
|
}
|
|
return strings.TrimSuffix(builder.String(), ",")
|
|
}
|
|
|
|
// GetArg returns an arg for a name
|
|
func (a *Action) GetArg(name string) string {
|
|
v, ok := a.Data[name]
|
|
if !ok {
|
|
return ""
|
|
}
|
|
return v
|
|
}
|