Package org.zaproxy.zap.extension.ascan

Class ScriptsActiveScanner

    • Constructor Detail

      • ScriptsActiveScanner

        public ScriptsActiveScanner()

    • Method Detail

      • getId

        public int getId()
        Description copied from interface: Plugin
        Unique Paros ID of this plugin.
        Returns:
        the ID

      • getName

        public java.lang.String getName()
        Description copied from interface: Plugin
        Plugin name. This is the human readable plugin name for display.
        Returns:
        the internationalised name

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Plugin
        Default description of this plugin.
        Returns:
        the description

      • getCategory

        public int getCategory()
        Description copied from interface: Plugin
        Gets the category of this scanner.
        Returns:
        the category of the scanner
        See Also:
        Category

      • getSolution

        public java.lang.String getSolution()
        Description copied from interface: Plugin
        Default solution returned by this plugin.
        Returns:
        the solution

      • getReference

        public java.lang.String getReference()
        Description copied from interface: Plugin
        Reference document provided by this plugin.
        Returns:
        the references

      • init

        public void init()
        Description copied from class: AbstractPlugin
        Finishes the initialisation of the plugin, subclasses should add any initialisation logic/code to this method.

        Called after the plugin has been initialised with the message being scanned. By default it does nothing.

        Since 2.5.0 it is no longer abstract.

        Overrides:
        init in class AbstractPlugin
        See Also:
        AbstractPlugin.init(HttpMessage, HostProcess)

      • scan

        public void scan​(HttpMessage msg,
                 java.lang.String param,
                 java.lang.String value)
        Description copied from class: AbstractAppParamPlugin
        Plugin method that need to be implemented for the specific test. The passed message is a copy which maintains only the Request's information so if the plugin need to manage the original Response body a getBaseMsg() call should be done. the param name and the value are the original value retrieved by the crawler and the current applied Variant.
        Overrides:
        scan in class AbstractAppParamPlugin
        Parameters:
        msg - a copy of the HTTP message currently under scanning
        param - the name of the parameter under testing
        value - the clean value (no escaping is needed)

      • isStop

        public boolean isStop()
        Description copied from class: AbstractPlugin
        Check if this test should be stopped. It should be checked periodically in Plugin (e.g. when in loops) so the HostProcess can stop this Plugin cleanly.
        Overrides:
        isStop in class AbstractPlugin
        Returns:
        true if the scanner should stop, false otherwise

      • setParam

        public java.lang.String setParam​(HttpMessage msg,
                                 java.lang.String param,
                                 java.lang.String value)

      • raiseAlert

        @Deprecated
public void raiseAlert​(int risk,
                       int confidence,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String uri,
                       java.lang.String param,
                       java.lang.String attack,
                       java.lang.String otherInfo,
                       java.lang.String solution,
                       java.lang.String evidence,
                       int cweId,
                       int wascId,
                       HttpMessage msg)
        Deprecated.
        (2.9.0) Use newAlert() to build and raise alerts.

      • raiseAlert

        @Deprecated
public void raiseAlert​(int risk,
                       int confidence,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String uri,
                       java.lang.String param,
                       java.lang.String attack,
                       java.lang.String otherInfo,
                       java.lang.String solution,
                       java.lang.String evidence,
                       java.lang.String reference,
                       int cweId,
                       int wascId,
                       HttpMessage msg)
        Deprecated.
        (2.9.0) Use newAlert() to build and raise alerts.

      • isPage200

        public boolean isPage200​(HttpMessage msg)
        Description copied from class: AbstractPlugin
        Tells whether or not the message matches CustomPage.Type.OK_200 definitions. Falls back to use Analyser which analyzes specific behavior and status codes. Checks if the message matches CustomPage.Type.ERROR_500 or CusotmPage.Type.NOTFOUND_404 first, in case the user is trying to override something.
        Overrides:
        isPage200 in class AbstractPlugin
        Parameters:
        msg - the message that will be checked
        Returns:
        true if the message matches, false otherwise

      • isPage404

        public boolean isPage404​(HttpMessage msg)
        Description copied from class: AbstractPlugin
        Tells whether or not the message matches a CustomPage.Type.NOTFOUND_404 definition. Falls back to Analyser. Checks if the message matches CustomPage.Type.OK_200 or CustomPage.Type.ERROR_500 first, in case the user is trying to override something.
        Overrides:
        isPage404 in class AbstractPlugin
        Parameters:
        msg - the message that will be checked
        Returns:
        true if the message matches, false otherwise

      • isPage500

        public boolean isPage500​(HttpMessage msg)
        Description copied from class: AbstractPlugin
        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 CusotmPage.Type.NOTFOUND_404 first, in case the user is trying to override something.
        Overrides:
        isPage500 in class AbstractPlugin
        Parameters:
        msg - the message that will be checked
        Returns:
        true if the message matches, false otherwise

      • isPageOther

        public boolean isPageOther​(HttpMessage msg)
        Description copied from class: AbstractPlugin
        Tells whether or not the message matches CustomPage.Type.OTHER definitions.
        Overrides:
        isPageOther in class AbstractPlugin
        Parameters:
        msg - the message that will be checked
        Returns:
        true if the message matches, false otherwise