org.zaproxy.zap.extension.pscan

Class PassiveScanData

java.lang.Object

org.zaproxy.zap.extension.pscan.PassiveScanData

public class PassiveScanData
extends Object

A utility class to simplify providing Context data to passive scan rules. Details will be based on the first Context matched (if any).

Since:

2.9.0

See Also:

PassiveScanThread, PluginPassiveScanner

Method Summary

Modifier and Type	Method and Description
Context	getContext() Returns the Context associated with the message being passively scanned.
TechSet	getTechSet() Returns the TechSet associated with the Context of the message being passively scanned.
List<User>	getUsers() Returns an unmodifiable list of s for the HttpMessage being passively scanned.
boolean	hasContext() Returns a boolean indicating whether or not the HttpMessage being passively scanned is currently associated with a Context.
boolean	isClientError(HttpMessage msg) Tells whether or not the response has a status code between 400 and 499 (inclusive), or CustomPage.Type.NOTFOUND_404.
boolean	isPage200(HttpMessage msg) Tells whether or not the message matches CustomPage.Type.OK_200 definitions.
boolean	isPage404(HttpMessage msg) Tells whether or not the message matches CustomPage.Type.NOTFOUND_404 definitions.
boolean	isPage500(HttpMessage msg) Tells whether or not the message matches CustomPage.Type.ERROR_500 definitions.
boolean	isPageOther(HttpMessage msg) Tells whether or not the message matches CustomPage.Type.OTHER definitions.
boolean	isServerError(HttpMessage msg) Tells whether or not the response has a status code between 500 and 599 (inclusive), or CustomPage.Type.EROOR_500.
boolean	isSuccess(HttpMessage msg) Tells whether or not the response has a status code between 200 and 299 (inclusive), or CustomPage.Type.OK_200.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUsers

public List<User> getUsers()

Returns an unmodifiable list of s for the HttpMessage being passively scanned. The list returned is based on the first Context matched.

Returns:

A list of users if some are available, an empty list otherwise.

hasContext

public boolean hasContext()

Returns a boolean indicating whether or not the HttpMessage being passively scanned is currently associated with a Context.

Returns:

true if there is an associated context, false if not.

getContext

public Context getContext()

Returns the Context associated with the message being passively scanned.

Returns:

the Context if the message has been matched to a Context, null otherwise.

getTechSet

public TechSet getTechSet()

Returns the TechSet associated with the Context of the message being passively scanned.

Returns:

the TechSet if the message has been matched to a Context, TechSet.AllTech otherwise.

isPage200

public boolean isPage200(HttpMessage msg)

Tells whether or not the message matches CustomPage.Type.OK_200 definitions. Falls back to simply checking the response status code for "200 - Ok". Checks if the message matches CustomPage.Type.ERROR_500 or CusotmPage.Type.NOTFOUND_404 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isPage500

public boolean isPage500(HttpMessage msg)

Tells whether or not the message matches CustomPage.Type.ERROR_500 definitions. Falls back to simply checking the response status code for "500 - Internal Server Error". Checks if the message matches CustomPage.Type.OK_200 or CustomPage.Type.NOTFOUND_404 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isPage404

public boolean isPage404(HttpMessage msg)

Tells whether or not the message matches CustomPage.Type.NOTFOUND_404 definitions. Falls back to simply checking the response status code for "404 - Not Found". Checks if the message matches CustomPage.Type.OK_200 or CustomPage.Type.ERROR_500 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isPageOther

public boolean isPageOther(HttpMessage msg)

Tells whether or not the message matches CustomPage.Type.OTHER definitions.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isSuccess

public boolean isSuccess(HttpMessage msg)

Tells whether or not the response has a status code between 200 and 299 (inclusive), or CustomPage.Type.OK_200. Checks if the message matches CustomPage.Type.NOTFOUND_404 or CusotmPage.Type.ERROR_500 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isClientError

public boolean isClientError(HttpMessage msg)

Tells whether or not the response has a status code between 400 and 499 (inclusive), or CustomPage.Type.NOTFOUND_404. Checks if the message matches CustomPage.Type.OK_200 or CusotmPage.Type.ERROR_500 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0

isServerError

public boolean isServerError(HttpMessage msg)

Tells whether or not the response has a status code between 500 and 599 (inclusive), or CustomPage.Type.EROOR_500. Checks if the message matches CustomPage.Type.OK_200 or CustomPage.Type.NOTFOUND_404 first, in case the user is trying to override something.

Parameters:

msg - the message that will be checked

Returns:

true if the message matches, false otherwise

Since:

2.10.0