Fix workflow to publish docs (#4743)

* Fix workflow to publish docs

* Auto Generate Syntax Docs + JSONSchema [Thu Feb  8 13:24:29 UTC 2024] 🤖

---------

Co-authored-by: GitHub Action <action@github.com>
dev
Ramana Reddy 2024-02-08 19:13:26 +05:30 committed by GitHub
parent 7e108cdd82
commit d60c846439
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 194 additions and 13 deletions

View File

@ -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

View File

@ -1390,13 +1390,26 @@ Valid values:
<div class="dd">
<code>cookie-reuse</code> <i>bool</i>
</div>
<div class="dt">
CookieReuse is an optional setting that enables cookie reuse for
all requests defined in raw section.
</div>
<hr />
<div class="dd">
<code>disable-cookie</code> <i>bool</i>
</div>
<div class="dt">
DisableCookie is an optional setting that disables cookie reuse for
all requests defined in raw section.
DisableCookie is an optional setting that disables cookie reuse
</div>
@ -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 />
@ -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 />
@ -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>
@ -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 />
@ -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>

View File

@ -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,
@ -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,
@ -428,11 +428,6 @@
},
"engine": {
"items": {
"enum": [
"python",
"powershell",
"command"
],
"type": "string"
},
"type": "array",
@ -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",
@ -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,
@ -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",
@ -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",
@ -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#",
@ -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,