-
-
Notifications
You must be signed in to change notification settings - Fork 754
Update AF templates and help #6949
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,5 +39,19 @@ <H2>Job: report</H2> | |
| the strings in the sites list is included. The sites list also supports | ||
| variables. | ||
|
|
||
| <H2>Job: outputSummary</H2> | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not intended to be used by the user, it's an "internal" job to help the migration of the packaged scans to use the AF. |
||
| The outputSummary job allows you to generate a summary of the alerts | ||
| found. | ||
| <pre> | ||
| - type: outputSummary # Print summary to stdout, primarily to mimic the behaviour of the packaged scans | ||
| parameters: | ||
| format: None # String: The format of the output, one of None, Short, Long, default: None | ||
| summaryFile: # String: The full path of a file into which will be written a JSON summary of the scan, default empty | ||
| rules: # A list of rules for which the actions are to be overriden | ||
| - id: # Int: The rule id as per https://www.zaproxy.org/docs/alerts/ | ||
| action: # String: The action to take for this rule, one of IGNORE, INFO, FAIL, default: WARN | ||
| customMessage: # String: A custom message which will be displayed with this rule | ||
| </pre> | ||
|
|
||
| </BODY> | ||
| </HTML> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| - type: outputSummary # Print summary to stdout, primarily to mimic the behaviour of the packaged scans | ||
| parameters: | ||
| format: None # String: The format of the output, one of None, Short, Long, default: None | ||
| summaryFile: # String: The full path of a file into which will be written a JSON summary of the scan, default empty | ||
| summaryFile: # String: The full path of a file into which will be written a JSON summary of the scan, default empty | ||
| rules: # A list of rules for which the actions are to be overridden | ||
| - id: # Int: The rule id as per https://www.zaproxy.org/docs/alerts/ | ||
| action: # String: The action to take for this rule, one of IGNORE, INFO, FAIL, default: WARN | ||
| customMessage: # String: A custom message which will be displayed with this rule |
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be linked from somewhere (either other/main page or the TOC). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> | ||
| <HTML> | ||
| <HEAD> | ||
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> | ||
| <TITLE> | ||
| Technology Detection Automation Framework Support | ||
| </TITLE> | ||
| </HEAD> | ||
| <BODY> | ||
| <H1>Technology Detection Automation Framework Support</H1> | ||
| This add-on supports the Automation Framework. | ||
| <br><br> | ||
| <H2>Job: wappalyzer</H2> | ||
| The <code>wappalyzer</code> job is a data job. It does not have any configurable parameters. | ||
| It provides technology detection data to other jobs via the <code>TechJobResultData</code> class. | ||
|
|
||
| <H2>YAML</H2> | ||
|
|
||
| <pre> | ||
| - type: wappalyzer # Passive scan wait for the passive scanner to finish | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe this is modelled based on another example but it just seems awkward to me. If there's no good description for the job I think advice would be better handled as a note below or leading in. Or maybe make sure the comment is clear that it's a note not a description? Just start it with |
||
| </pre> | ||
|
|
||
| <H2>Job Data</H2> | ||
| The following class will be made available to add-ons that provide access to the Job Data such as the Reporting add-on. | ||
| <ul> | ||
| <li>Key: <code>wappalyzerData</code> | ||
| <li>Class: <a href="https://github.com/zaproxy/zap-extensions/blob/main/addOns/wappalyzer/src/main/java/org/zaproxy/zap/extension/wappalyzer/automation/TechJobResultData.java">TechJobResultData</a> | ||
| </ul> | ||
|
|
||
| </BODY> | ||
| </HTML> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The String should be restored.