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

Adding advanced section for active scan #15

Merged
merged 5 commits into from
Jan 20, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ascan_advanced_input_vectors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ascan_advanced_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ascan_advanced_policy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ascan_advanced_tech.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 48 additions & 1 deletion source/includes/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,52 @@ automatic tagging are provided by default. These can be changed, deleted or adde

## Active Scan Settings

Content in progress!
### General Options

The general options for Active Scan can be configured using the options tab in the desktop UI shown below.

![options](../images/ascan_advanced_options.png)

Use the [setOptionMaxScanDurationInMins](#ascanactionsetoptionmaxscandurationinmins) to limit the duration of scan and
kingthorin marked this conversation as resolved.
Show resolved Hide resolved
[setOptionMaxRuleDurationInMins](#ascanactionsetoptionmaxruledurationinmins) API to limit the time of individual active scan rules.
This can be used to prevent rules that are taking an excessive amount of time.
sshniro marked this conversation as resolved.
Show resolved Hide resolved

Use the [setOptionHostPerScan](#ascanactionsetoptionhostperscan) API to set the maximum number of hosts that will be scanned at the same time.
Furthermore, use the [setOptionThreadPerHost](#ascanactionsetoptionthreadperhost) API to set the number of threads the scanner will use per host.
Increasing both of these values will reduce the active scanning time but this may put extra strain on the server ZAP is running on.

Use the [setOptionDelayInMs](#ascanactionsetoptiondelayinms) to delay each request from ZAP in milliseconds. Setting this to a non zero value will increase
the time an active scan takes, but will put less of a strain on the target host. View the [Active Scan](#zap-api-ascan) section in
the API Catalogue for additional information regarding the APIs.

### Input Vectors

![input_vectors](../images/ascan_advanced_input_vectors.png)

Input vectors refers to the elements that Active Scan will target. Specifying the exact elements to target will improve the
scanning time and accuracy of the results. For an example, if you do not need ZAP to target on the
multipart from data then it should be disabled via the [setOptionTargetParamsEnabledRPC](#ascanactionsetoptiontargetparamsenabledrpc) endpoint.
You need to send a map of key value pairs as the input with the corresponding bit values.
sshniro marked this conversation as resolved.
Show resolved Hide resolved

![input_vectors_code](../images/ascan_advanced_input_vector_code.png)
kingthorin marked this conversation as resolved.
Show resolved Hide resolved

### Technology

![technology](../images/ascan_advanced_tech.png)

The Technology tab allows you to specify which types of technologies to scan. Un-selecting technologies that you know are
not present in the target application may speed up the scan, as rules which target that technology can skip those tests.
For an example, if the target web application does not have a database then removing it will increase the performance of the Active Scan.

Use the [includeContextTechnologies](#contextactionincludecontexttechnologies) and [excludeContextTechnologies](#contextactionexcludecontexttechnologies)
API endpoints to include and exclude the technology list from the context.

### Policy

A scan policy defines exactly which rules are run as part of an active scan. It also defines how these rules run influencing
how many requests are made and how likely potential issues are to be flagged. You can define as many scan policies as you
like and select the most appropriate one when you start the scan via the Active Scan.

![policy](../images/ascan_advanced_policy.png)

The Policy tab shown in the above image allows you to override any of the settings specified in the selected scan policy.