From 924b615a6cf1261f26f59e40c764ba4dfc7d06b1 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 29 Mar 2022 12:22:43 +0000 Subject: [PATCH] Auto Generate Syntax Docs + JSONSchema [Tue Mar 29 12:22:43 UTC 2022] :robot: --- SYNTAX-REFERENCE.md | 6 ++++-- nuclei-jsonschema.json | 6 +++++- v2/pkg/templates/templates_doc.go | 8 ++++---- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/SYNTAX-REFERENCE.md b/SYNTAX-REFERENCE.md index 33a555c82..2d40b92c2 100755 --- a/SYNTAX-REFERENCE.md +++ b/SYNTAX-REFERENCE.md @@ -167,6 +167,7 @@ file: extensions: - all archive: false + mimetype: false ``` @@ -2572,6 +2573,7 @@ extractors: extensions: - all archive: false +mimetype: false ``` Part Definitions: @@ -2646,7 +2648,7 @@ Valid values:
-Extensions is the list of extensions to perform matching on. +Extensions is the list of extensions or mime types to perform matching on. @@ -2672,7 +2674,7 @@ extensions:
-DenyList is the list of file, directories or extensions to deny during matching. +DenyList is the list of file, directories, mime types or extensions to deny during matching. By default, it contains some non-interesting extensions that are hardcoded in nuclei. diff --git a/nuclei-jsonschema.json b/nuclei-jsonschema.json index 997ba464f..fa9b21fa9 100755 --- a/nuclei-jsonschema.json +++ b/nuclei-jsonschema.json @@ -451,7 +451,8 @@ }, "file.Request": { "required": [ - "Archive" + "Archive", + "MimeType" ], "properties": { "matchers": { @@ -508,6 +509,9 @@ "Archive": { "type": "boolean" }, + "MimeType": { + "type": "boolean" + }, "no-recursive": { "type": "boolean", "title": "do not perform recursion", diff --git a/v2/pkg/templates/templates_doc.go b/v2/pkg/templates/templates_doc.go index 46089cc04..94aad037e 100644 --- a/v2/pkg/templates/templates_doc.go +++ b/v2/pkg/templates/templates_doc.go @@ -1197,15 +1197,15 @@ func init() { 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].Description = "Extensions is the list of extensions or mime types to perform matching on." + FILERequestDoc.Fields[3].Comments[encoder.LineComment] = "Extensions is the list of extensions or mime types 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 = "DenyList is the list of file, directories or 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] = "DenyList is the list of file, directories or extensions to deny during matching." + FILERequestDoc.Fields[4].Description = "DenyList is the list of file, directories, mime types or 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] = "DenyList is the list of file, directories, mime types or extensions to deny during matching." FILERequestDoc.Fields[4].AddExample("", []string{".avi", ".mov", ".mp3"}) FILERequestDoc.Fields[5].Name = "id"