Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix workflow to publish docs #4743

Merged
merged 2 commits into from
Feb 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
fi
go generate pkg/templates/templates.go
go build -o "cmd/docgen/docgen" cmd/docgen/docgen.go
./cmd/docgen/docgen ../SYNTAX-REFERENCE.md ../nuclei-jsonschema.json
./cmd/docgen/docgen SYNTAX-REFERENCE.md nuclei-jsonschema.json
git status -s | wc -l | xargs -I {} echo CHANGES={} >> $GITHUB_OUTPUT

- name: Commit files
Expand Down
141 changes: 139 additions & 2 deletions SYNTAX-REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1390,12 +1390,12 @@ Valid values:

<div class="dd">

<code>disable-cookie</code> <i>bool</i>
<code>cookie-reuse</code> <i>bool</i>

</div>
<div class="dt">

DisableCookie is an optional setting that disables cookie reuse for
CookieReuse is an optional setting that enables cookie reuse for
all requests defined in raw section.

</div>
Expand All @@ -1404,6 +1404,19 @@ all requests defined in raw section.

<div class="dd">

<code>disable-cookie</code> <i>bool</i>

</div>
<div class="dt">

DisableCookie is an optional setting that disables cookie reuse

</div>

<hr />

<div class="dd">

<code>read-all</code> <i>bool</i>

</div>
Expand Down Expand Up @@ -2115,6 +2128,30 @@ Payloads support both key-values combinations where a list
of payloads is provided, or optionally a single file can also
be provided as payload which will be read on run-time.

</div>

<hr />

<div class="dd">

<code>threads</code> <i>int</i>

</div>
<div class="dt">

Threads to use when sending iterating over payloads



Examples:


```yaml
# Send requests using 10 concurrent threads
threads: 10
```


</div>

<hr />
Expand Down Expand Up @@ -2484,6 +2521,33 @@ Payloads support both key-values combinations where a list
of payloads is provided, or optionally a single file can also
be provided as payload which will be read on run-time.

</div>

<hr />

<div class="dd">

<code>threads</code> <i>int</i>

</div>
<div class="dt">

Threads specifies number of threads to use sending requests. This enables Connection Pooling.

Connection: Close attribute must not be used in request while using threads flag, otherwise
pooling will fail and engine will continue to close connections after requests.



Examples:


```yaml
# Send requests using 10 concurrent threads
threads: 10
```


</div>

<hr />
Expand Down Expand Up @@ -2881,6 +2945,19 @@ Fuzzing describes schema to fuzz headless requests

<div class="dd">

<code>cookie-reuse</code> <i>bool</i>

</div>
<div class="dt">

CookieReuse is an optional setting that enables cookie reuse

</div>

<hr />

<div class="dd">

<code>disable-cookie</code> <i>bool</i>

</div>
Expand Down Expand Up @@ -3227,6 +3304,53 @@ description: |

<hr />

<div class="dd">

<code>tls_version_enum</code> <i>bool</i>

</div>
<div class="dt">

TLS Versions Enum - false if not specified
Enumerates supported TLS versions

</div>

<hr />

<div class="dd">

<code>tls_cipher_enum</code> <i>bool</i>

</div>
<div class="dt">

TLS Ciphers Enum - false if not specified
Enumerates supported TLS ciphers

</div>

<hr />

<div class="dd">

<code>tls_cipher_types</code> <i>[]string</i>

</div>
<div class="dt">

description: |
TLS Cipher types to enumerate
values:
- "insecure" (default)
- "weak"
- "secure"
- "all"

</div>

<hr />




Expand Down Expand Up @@ -3649,6 +3773,19 @@ Code contains code to execute for the javascript request.

<div class="dd">

<code>timeout</code> <i>int</i>

</div>
<div class="dt">

Timeout in seconds is optional timeout for each javascript script execution (i.e init, pre-condition, code)

</div>

<hr />

<div class="dd">

<code>stop-at-first-match</code> <i>bool</i>

</div>
Expand Down
64 changes: 54 additions & 10 deletions nuclei-jsonschema.json
Original file line number Diff line number Diff line change
Expand Up @@ -245,11 +245,6 @@
"type": "boolean",
"title": "use case insensitive extract",
"description": "use case insensitive extract"
},
"to": {
"type": "string",
"title": "save extracted values to file",
"description": "save extracted values to file"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -375,6 +370,11 @@
"type": "boolean",
"title": "match all values",
"description": "match all matcher values ignoring condition"
},
"internal": {
"type": "boolean",
"title": "hide matcher from output",
"description": "hide matcher from output"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -428,11 +428,6 @@
},
"engine": {
"items": {
"enum": [
"python",
"powershell",
"command"
],
"type": "string"
},
"type": "array",
Expand Down Expand Up @@ -648,6 +643,11 @@
"title": "payloads for the network request",
"description": "Payloads contains any payloads for the current request"
},
"threads": {
"type": "integer",
"title": "threads for sending requests",
"description": "Threads specifies number of threads to use sending requests. This enables Connection Pooling"
},
"recursion": {
"type": "boolean",
"title": "recurse all servers",
Expand Down Expand Up @@ -821,6 +821,11 @@
"type": "boolean",
"title": "optional cookie reuse enable",
"description": "Optional setting that enables cookie reuse"
},
"disable-cookie": {
"type": "boolean",
"title": "optional disable cookie reuse",
"description": "Optional setting that disables cookie reuse"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -1049,6 +1054,11 @@
"title": "optional cookie reuse enable",
"description": "Optional setting that enables cookie reuse"
},
"disable-cookie": {
"type": "boolean",
"title": "optional disable cookie reuse",
"description": "Optional setting that disables cookie reuse"
},
"read-all": {
"type": "boolean",
"title": "force read all body",
Expand Down Expand Up @@ -1181,6 +1191,11 @@
"title": "code to execute in javascript",
"description": "Executes inline javascript code for the request"
},
"timeout": {
"type": "integer",
"title": "timeout for javascript execution",
"description": "Timeout in seconds is optional timeout for entire javascript script execution"
},
"stop-at-first-match": {
"type": "boolean",
"title": "stop at first match",
Expand Down Expand Up @@ -1276,6 +1291,11 @@
"title": "payloads for the network request",
"description": "Payloads contains any payloads for the current request"
},
"threads": {
"type": "integer",
"title": "threads for sending requests",
"description": "Threads specifies number of threads to use sending requests. This enables Connection Pooling"
},
"inputs": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
Expand Down Expand Up @@ -1410,6 +1430,30 @@
"type": "string",
"title": "Scan Mode",
"description": "Scan Mode - auto if not specified."
},
"tls_version_enum": {
"type": "boolean",
"title": "Enumerate Versions",
"description": "Enumerate Version - false if not specified"
},
"tls_cipher_enum": {
"type": "boolean",
"title": "Enumerate Ciphers",
"description": "Enumerate Ciphers - false if not specified"
},
"tls_cipher_types": {
"items": {
"enum": [
"weak",
"secure",
"insecure",
"all"
],
"type": "string"
},
"type": "array",
"title": "TLS Cipher Types",
"description": "TLS Cipher Types to enumerate"
}
},
"additionalProperties": false,
Expand Down