From 1e52124b3bb04c3fefc0d737d2741656254c5804 Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:08:36 +0530 Subject: [PATCH 1/6] Added metadata field example for string type to PLUGINS.md --- PLUGINS.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/PLUGINS.md b/PLUGINS.md index 79010834..dc23a13c 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -104,6 +104,33 @@ Only run scans against systems you own or are explicitly authorized to assess. | Binary Signature Scan | `yara_scan` | `forensics` | `intrusive` | `yara` | Binary and file-system signature matching with YARA rules. | | DAST Web Proxy (ZAP) | `zap_scanner` | `vulnerability` | `exploit` | `python3` | Dynamic proxy spidering and payload injection. | +## Examples for common field types in metadata.json + +# String Field - Single-line text + +-Use for free-form text inputs such as hostnames, domain names, file paths, or any +value that does not fit a more specific type. + +```json +{ + "id": "target", + "label": "Root Domain", + "type": "string", + "required": true, + "placeholder": "example.com", + "description": "The root domain to enumerate. Do not include a scheme or trailing slash." +} +``` + + + + + + + + + + ## Maintenance Notes - If a plugin is added, renamed, or removed, update this file from the plugin metadata rather than editing counts by hand. From 873160cd8c36a353133296ec058a5f66e60dc38e Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:21:58 +0530 Subject: [PATCH 2/6] Added metadata field examples for url and select. --- PLUGINS.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index dc23a13c..4d5c43b8 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -106,7 +106,7 @@ Only run scans against systems you own or are explicitly authorized to assess. ## Examples for common field types in metadata.json -# String Field - Single-line text +## string - Single-line text -Use for free-form text inputs such as hostnames, domain names, file paths, or any value that does not fit a more specific type. @@ -118,10 +118,43 @@ value that does not fit a more specific type. "type": "string", "required": true, "placeholder": "example.com", - "description": "The root domain to enumerate. Do not include a scheme or trailing slash." + //"description": "The root domain to enumerate. Do not include a scheme or trailing slash." } ``` +## url - URL + +-Use when the field expects a well-formed URL (a complete target url). + +```json +{ + "id": "target_url", + "label": "Target URL", + "type": "url", + "required": true, + "placeholder": "https://example.com", + //"description": "Full URL of the target, including scheme. Must begin with http:// or https://." +} +``` + +## select - Single-choice dropdown + +- Use when user must choose a predefined option or say exactly one value from a fixed list. + +```json +{ + "id": "scan_depth", + "label": "Scan Depth", + "type": "select", + "required": true, + "options": ["shallow", "normal", "deep"], + "default": "normal", + //"description": "Controls how aggressively the plugin probes the target. Start with 'normal' for most scans." +} +``` + + + From 8a71872919492ac8b72bb42f66d3fa84c525c03d Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:27:55 +0530 Subject: [PATCH 3/6] Added metadata field example for boolean. --- PLUGINS.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index 4d5c43b8..d79fc605 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -117,8 +117,7 @@ value that does not fit a more specific type. "label": "Root Domain", "type": "string", "required": true, - "placeholder": "example.com", - //"description": "The root domain to enumerate. Do not include a scheme or trailing slash." + "placeholder": "example.com" } ``` @@ -132,8 +131,7 @@ value that does not fit a more specific type. "label": "Target URL", "type": "url", "required": true, - "placeholder": "https://example.com", - //"description": "Full URL of the target, including scheme. Must begin with http:// or https://." + "placeholder": "https://example.com" } ``` @@ -148,8 +146,21 @@ value that does not fit a more specific type. "type": "select", "required": true, "options": ["shallow", "normal", "deep"], - "default": "normal", - //"description": "Controls how aggressively the plugin probes the target. Start with 'normal' for most scans." + "default": "normal" +} +``` +## boolean - Toggle/checkbox + +-Use boolean fields for true/false configuration options. +-Always provide a default of true or false. + +```json +{ + "id": "verbose", + "label": "Verbose Output", + "type": "boolean", + "required": false, + "default": false } ``` From 5e0a41589c83380fdca8b4cde2321da186a1887f Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:36:31 +0530 Subject: [PATCH 4/6] Added metadata field example for number and multiselect. --- PLUGINS.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/PLUGINS.md b/PLUGINS.md index d79fc605..b912bbb7 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -163,12 +163,38 @@ value that does not fit a more specific type. "default": false } ``` +## number - Numeric input +-Use for numeric limits, thresholds or timeout values. +-Use min and max to constrain the accepted range (both bounds are inclusive). +-The backend will reject values outside the declared range. +```json +{ + "id": "timeout", + "label": "Timeout (seconds)", + "type": "number", + "required": false, + "default": 30, + "min": 1, + "max": 300 +} +``` +## multiselect - Multi-choice selection +-Use multiselect fields when users can choose multiple options. - +```json +{ + "id": "output_formats", + "label": "Output Formats", + "type": "multiselect", + "required": false, + "options": ["json", "csv", "txt"], + "default": ["json"] +} +``` From 9762c48b9973c1adea5847afa6e323f519b14828 Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:39:43 +0530 Subject: [PATCH 5/6] Appearence modification --- PLUGINS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLUGINS.md b/PLUGINS.md index b912bbb7..cc5fca73 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -106,7 +106,7 @@ Only run scans against systems you own or are explicitly authorized to assess. ## Examples for common field types in metadata.json -## string - Single-line text +1. string - Single-line text -Use for free-form text inputs such as hostnames, domain names, file paths, or any value that does not fit a more specific type. From 5d633d6d5edeb7d0818a3524c6c0f268d9a4eca2 Mon Sep 17 00:00:00 2001 From: SHRESTHA-012 Date: Wed, 20 May 2026 01:42:23 +0530 Subject: [PATCH 6/6] Added serial numbers for fields for better readability. --- PLUGINS.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index cc5fca73..ad0d39d6 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -121,7 +121,7 @@ value that does not fit a more specific type. } ``` -## url - URL +2. url - URL -Use when the field expects a well-formed URL (a complete target url). @@ -135,7 +135,7 @@ value that does not fit a more specific type. } ``` -## select - Single-choice dropdown +3. select - Single-choice dropdown - Use when user must choose a predefined option or say exactly one value from a fixed list. @@ -149,7 +149,7 @@ value that does not fit a more specific type. "default": "normal" } ``` -## boolean - Toggle/checkbox +4. boolean - Toggle/checkbox -Use boolean fields for true/false configuration options. -Always provide a default of true or false. @@ -163,7 +163,7 @@ value that does not fit a more specific type. "default": false } ``` -## number - Numeric input +5. number - Numeric input -Use for numeric limits, thresholds or timeout values. -Use min and max to constrain the accepted range (both bounds are inclusive). @@ -181,7 +181,7 @@ value that does not fit a more specific type. } ``` -## multiselect - Multi-choice selection +6. multiselect - Multi-choice selection -Use multiselect fields when users can choose multiple options.