Skip to content

Commit b448236

Browse files
authored
Merge pull request #3295 from thc202/update-old-pages
Update old user guide pages
2 parents 298c91a + 20c0025 commit b448236

File tree

9 files changed

+11
-173
lines changed

9 files changed

+11
-173
lines changed
Lines changed: 2 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,5 @@
11
---
2-
# This page was generated from the add-on.
32
title: Code Dx
4-
type: userguide
5-
weight: 1
6-
cascade:
7-
addon:
8-
id: codedx
9-
version: 9.0.0
3+
layout: redirect
4+
redirect: /docs/desktop/addons/software-risk-manager/
105
---
11-
12-
# Code Dx
13-
14-
The Code Dx add-on allows you to generate compatible reports and upload them to a Code Dx server. There are two options under the Report menu.
15-
16-
## Code Dx: Upload Report
17-
18-
This option will generate a report for you and upload it to a Code Dx server. Selecting it will prompt you for the Server URL and API Key. After populating the fields, click the refresh button to get a list of projects available to the API Key. Then click the Upload button to send results to the Code Dx server.
19-
20-
## Code Dx: Generate XML Report
21-
22-
This option will generate a standard XML report that includes the HTTP request and response data.
23-
24-
# API
25-
26-
## Actions
27-
28-
### uploadReport
29-
30-
Uploads a report to Code Dx. Note that uploading an empty report with no alerts will cause an Exception to be thrown as Code Dx won't be able to read it and will return a non-200 response.
31-
32-
*Parameters*
33-
34-
* filePath: Absolute path to the report file
35-
* serverUrl: Code Dx server URL
36-
* codeDxApiKey: Code Dx API Key
37-
* projectId: Code Dx Project ID
38-
* fingerprint: Optional SHA1 hash of an invalid certificate to make an exception for
39-
* acceptPermanently: Optional boolean for if the exception should be stored permanently in a truststore file.
40-
41-
*Returns*
42-
"OK" if the report is uploaded successfully.
43-
44-
### generateAndUpload
45-
46-
Generates a Code Dx report, saves it to a temporary file, uploads to Code Dx, then deletes the file.
47-
48-
*Parameters*
49-
50-
* serverUrl: Code Dx server URL
51-
* codeDxApiKey: Code Dx API Key
52-
* projectId: Code Dx Project ID
53-
* fingerprint: Optional SHA1 hash of an invalid certificate to make an exception for
54-
* acceptPermanently: Optional boolean for if the exception should be stored permanently in a truststore file.
55-
56-
*Returns*
57-
"OK" if the report is uploaded successfully.
58-
"EMPTY" if the generated report is empty. The report will not be uploaded to Code Dx.
59-
60-
## Views
61-
62-
### generateReport
63-
64-
Generates an XML report with request and response data.
65-
66-
*Returns*
67-
An XML report String.
Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,5 @@
11
---
2-
# This page was generated from the add-on.
32
title: GraphQL Support Script
4-
type: userguide
5-
weight: 2
3+
layout: redirect
4+
redirect: /docs/desktop/addons/graphql-support/variant/
65
---
7-
8-
# GraphQL Support Script
9-
10-
The GraphQL Support script is responsible for two things:
11-
12-
1. Correctly representing the nodes for a GraphQL request in the sites tree (since ZAP 2.10.0).
13-
2. Adding GraphQL support for Active Scan Input Vectors.
14-
15-
The following sections will elaborate a little on each of these functionalities.
16-
17-
## Sites Tree Representation
18-
19-
Each unique GraphQL request proxied through ZAP is represented in the sites tree. Requests are placed under a common node if they have the same operations. Two queries that have the same fields will be represented by the same node. The only exception is when a query is sent with inline arguments and also using variables. In this case, a prefix of either '0' or '1' is added to distinguish between them respectively.
20-
For example, the following figure illustrates how two requests may be represented in the sites tree.
21-
![](/docs/desktop/addons/graphql-support/images/sitesTreeExample.png)
22-
23-
## Active Scan Input Vectors
24-
25-
If Active Scan Script Input Vectors are enabled, values are injected for inline arguments in all queries proxied through ZAP. If a query uses variables, then variables are replaced inline and variable definitions are deleted.
26-
Note that the built-in JSON Input Vector handler also works when a request is sent as JSON.
27-
28-
## See also
29-
30-
| | | |
31-
|---|------------------------------------------------------------------------|---------------------------------------------------------|
32-
| | [GraphQL](/docs/desktop/addons/graphql-support/) | for an overview of the GraphQL add-on. |
33-
| | [GraphQL Options](/docs/desktop/addons/graphql-support/options/) | for information about the optional parameters. |
34-
| | [GraphQL Automation](/docs/desktop/addons/graphql-support/automation/) | for information about the automation framework support. |
Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
# This page was generated from the add-on.
32
title: Import URLs
43
type: userguide
54
weight: 1
@@ -9,9 +8,4 @@ cascade:
98
version: 9.0.0
109
---
1110

12-
# Import URLs
13-
14-
This add-on adds an option to import a file of URLs via the 'Import' menu. The file must be plain text with one URL per line.
15-
16-
17-
This add-on also exposes a ZAP API endpoint /importurls/importurls (filePath\*) to facilitate programmatic use of the functionality.
11+
This add-on has been superseded by the [Import/Export](/docs/desktop/addons/import-export/) add-on.
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
# This page was generated from the add-on.
32
title: Log File Importer
43
type: userguide
54
weight: 1
@@ -9,6 +8,4 @@ cascade:
98
version: 6.0.0
109
---
1110

12-
# Log File Importer
13-
14-
Allows you to import log files from ModSecurity and files previously exported from ZAP.
11+
This add-on has been superseded by the [Import/Export](/docs/desktop/addons/import-export/) add-on.
Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
# This page was generated from the add-on.
32
title: Port Scan
43
type: userguide
54
weight: 1
@@ -9,23 +8,4 @@ cascade:
98
version: 10.0.0
109
---
1110

12-
# Port Scan
13-
14-
Provides a basic port scanner which shows which ports are open on the target sites.
15-
16-
Port scanning is configured using the [Options Port Scan
17-
screen](/docs/desktop/addons/port-scan/options/).
18-
19-
## Pop up menu item
20-
21-
### Port Scan host
22-
23-
This will initiate a port scan of the host for the selected node.
24-
The [Port Scan tab](/docs/desktop/addons/port-scan/tab/) will be display and will show the progress of the scan.
25-
26-
## Accessed via
27-
28-
| | | |
29-
|---|---------------|-----------------------------------------------|
30-
| | Port Scan tab | |
31-
| | Sites tab | 'Attack/Port Scan host' right click menu item |
11+
This add-on has been retired and is no longer available.
Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
11
---
2-
# This page was generated from the add-on.
32
title: Options Port Scan screen
43
type: userguide
54
weight: 1
65
---
76

8-
# Options Port Scan screen
9-
10-
This screen allows you to configure the port scan options:
11-
12-
### Highest port number to scan
13-
14-
ZAP will start from 1 and work up to this port number.
15-
Selecting a high number will significantly increase the time a port scan takes.
16-
17-
### Concurrent scanning threads per host
18-
19-
The number of threads the scanner will use per host.
20-
Increasing the number of threads will speed up the scan but may put extra strain on the computer ZAP is running on and the target host.
7+
This add-on has been retired and is no longer available.
Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,7 @@
11
---
2-
# This page was generated from the add-on.
32
title: Port Scan tab
43
type: userguide
54
weight: 2
65
---
76

8-
# Port Scan tab
9-
10-
The Port Scan tab allows you to perform a basic port scan on any of the sites that have been accessed.
11-
12-
Sites can be selected via the toolbar or the Sites tab.
13-
Any sites that have have been are are currently being scanned are marked in bold in the toolbar Sites pulldown control.
14-
The toolbar provides a set of buttons which allow you to start, stop, pause and resume the scan.
15-
A progress bar shows how far the scan of the selected site has progressed.
16-
The 'Current scans' value shows how many scans are currently active - hovering over this value will show a list of the sites being scanned in a popup.
17-
18-
## Right click menu
19-
20-
Right clicking on a node will bring up a menu which will allow you to:
21-
22-
### Copy
23-
24-
This will copy the selected port details to the clipboard.
25-
26-
## See also
27-
28-
| | | |
29-
|---|---------------------------------------------------------------------|--------------------------------------------|
30-
| | [Options Port Scan screen](/docs/desktop/addons/port-scan/options/) | for details of the port scan configuration |
7+
This add-on has been retired and is no longer available.
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
# This page was generated from the add-on.
32
title: Save Raw Message
43
type: userguide
54
weight: 1
@@ -9,6 +8,4 @@ cascade:
98
version: 7.0.0
109
---
1110

12-
# Save Raw Message
13-
14-
Provides a context menu to save content of HTTP messages as binary.
11+
This add-on has been superseded by the [Import/Export](/docs/desktop/addons/import-export/) add-on.
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
# This page was generated from the add-on.
32
title: Save XML Message
43
type: userguide
54
weight: 1
@@ -9,6 +8,4 @@ cascade:
98
version: 0.3.0
109
---
1110

12-
# Save XML Message
13-
14-
Provides a context menu to save content of HTTP messages as XML.
11+
This add-on has been superseded by the [Import/Export](/docs/desktop/addons/import-export/) add-on.

0 commit comments

Comments
 (0)