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 all commits
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
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.
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.
64 changes: 59 additions & 5 deletions source/includes/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ The following image shows the advanced configurations tab of Spider in the deskt

![spider_advanced](../images/spider_advanced.png)

Use the [setOptionMaxDepth](#spideractionsetoptionmaxdepth) to set the maximum depth the spider can crawl, where 0 refers to unlimited depth.
The [setOptionMaxChildren](#spideractionsetoptionmaxchildren) sets the maximum number of child nodes (per node) that can be crawled,
Use the [setOptionMaxDepth](#spideractionsetoptionmaxdepth) API to set the maximum depth the spider can crawl, where 0 refers to unlimited depth.
The [setOptionMaxChildren](#spideractionsetoptionmaxchildren) API sets the maximum number of child nodes (per node) that can be crawled,
where 0 means no limit. The [setOptionMaxDuration](#spideractionsetoptionmaxduration) API can be used to set the maximum duration the Spider will run.
Use the [setOptionMaxParseSizeBytes](#spideractionsetoptionmaxparsesizebytes) to limit the amount of data parsed by the spider.
Use the [setOptionMaxParseSizeBytes](#spideractionsetoptionmaxparsesizebytes) API to limit the amount of data parsed by the spider.
This allows the spider to skip big responses/files.

View the [Spider section](#spider) in the API Catalogue for additional APIs.
Expand All @@ -26,7 +26,7 @@ Similar to the Spider API, the Ajax spider also provides APIs to set the [maximu

## Passive Scan Settings

The scanning rules can be enabled/disabled using the [enableScanners](#pscanactionenablescanners) and [disableScanners]((#pscanactiondisablescanners)) API.
The scanning rules can be enabled/disabled using the [enableScanners](#pscanactionenablescanners) and [disableScanners]((#pscanactiondisablescanners)) APIs.
Also use the [setScanOnlyInScope](#pscanviewscanonlyinscope) API to limit the passive scanning to a scope. View
the advanced section to learn how to configure a context or scope using ZAP APIs.

Expand All @@ -35,5 +35,59 @@ 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) API to limit the duration of scan and
[setOptionMaxRuleDurationInMins](#ascanactionsetoptionmaxruledurationinmins) API to limit the time of individual active scan rules.
This can be used to prevent rules from running for an excessive amount of time.

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) API 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 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 example, for the following configuration the [optionTargetParamsInjectable](#ascanviewoptiontargetparamsinjectable) and
[optionTargetParamsEnabledRPC](#ascanviewoptiontargetparamsenabledrpc) will yield the results of 11 and 39.
The numbers can be deconstructed in the following manner:

- 1+2+8 = 11 [Query String(1), Post Data(2), HTTP Headers(8)]
- 1+2+4+32 = 39 [Multipart (1), XML (2), JSON (4), DWR (32)]

![input_vectors_code](../images/ascan_advanced_input_vectors_code.png)

Thus, to change the values of `Injectable targets` and `Input Vector Handlers` calculate the exact values and
use the [setoptiontargetparamsinjectable](#ascanactionsetoptiontargetparamsinjectable) and [setoptiontargetparamsenabledrpc](#ascanactionsetoptiontargetparamsenabledrpc) APIs accordingly.

The `Add URL query parameter` option under the `Injectable Tragets` sets whether or not the active scanner should add a query param
to GET requests which do not have parameters to start with. This option can be enabled using the [setoptionaddqueryparam](#ascanactionsetoptionaddqueryparam) API.

### 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.