Merge pull request #74 from thc202/regen-2.8.0

Regenerate core APIs for 2.8.0

Author: kingthorin

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add API for SOAP Scanner add-on, version 3.
 
 ### Changed
+- Core APIs updated for ZAP version 2.8.0.
 - Update Replacer API, per release of version 7.
 - Add description to Importurls API endpoint.
 

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/core/ClientApi.java

@@ -99,6 +99,7 @@ public class ClientApi {
     public Acsrf acsrf = new Acsrf(this);
     public AjaxSpider ajaxSpider = new AjaxSpider(this);
     public AlertFilter alertFilter = new AlertFilter(this);
+    public org.zaproxy.clientapi.gen.Alert alert = new org.zaproxy.clientapi.gen.Alert(this);
     public Ascan ascan = new Ascan(this);
     public Authentication authentication = new Authentication(this);
     public Authorization authorization = new Authorization(this);
@@ -246,7 +247,8 @@ public void checkAlerts(List<Alert> ignoreAlerts, List<Alert> requireAlerts, Fil
 
     public List<Alert> getAlerts(String baseUrl, int start, int count) throws ClientApiException {
         List<Alert> alerts = new ArrayList<Alert>();
-        ApiResponse response = core.alerts(baseUrl, String.valueOf(start), String.valueOf(count));
+        ApiResponse response =
+                alert.alerts(baseUrl, String.valueOf(start), String.valueOf(count), null);
         if (response != null && response instanceof ApiResponseList) {
             ApiResponseList alertList = (ApiResponseList) response;
             for (ApiResponse resp : alertList.getItems()) {

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Alert.java

@@ -0,0 +1,130 @@
+/*
+ * Zed Attack Proxy (ZAP) and its related class files.
+ *
+ * ZAP is an HTTP/HTTPS proxy for assessing web application security.
+ *
+ * Copyright 2019 The ZAP Development Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.zaproxy.clientapi.gen;
+
+import java.util.HashMap;
+import java.util.Map;
+import org.zaproxy.clientapi.core.ApiResponse;
+import org.zaproxy.clientapi.core.ClientApi;
+import org.zaproxy.clientapi.core.ClientApiException;
+
+/** This file was automatically generated. */
+@SuppressWarnings("javadoc")
+public class Alert {
+
+    private final ClientApi api;
+
+    public Alert(ClientApi api) {
+        this.api = api;
+    }
+
+    /**
+     * Gets the alert with the given ID, the corresponding HTTP message can be obtained with the
+     * 'messageId' field and 'message' API method
+     */
+    public ApiResponse alert(String id) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("id", id);
+        return api.callApi("alert", "view", "alert", map);
+    }
+
+    /**
+     * Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with
+     * 'start' position and 'count' of alerts
+     */
+    public ApiResponse alerts(String baseurl, String start, String count, String riskid)
+            throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        if (baseurl != null) {
+            map.put("baseurl", baseurl);
+        }
+        if (start != null) {
+            map.put("start", start);
+        }
+        if (count != null) {
+            map.put("count", count);
+        }
+        if (riskid != null) {
+            map.put("riskId", riskid);
+        }
+        return api.callApi("alert", "view", "alerts", map);
+    }
+
+    /** Gets number of alerts grouped by each risk level, optionally filtering by URL */
+    public ApiResponse alertsSummary(String baseurl) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        if (baseurl != null) {
+            map.put("baseurl", baseurl);
+        }
+        return api.callApi("alert", "view", "alertsSummary", map);
+    }
+
+    /** Gets the number of alerts, optionally filtering by URL or riskId */
+    public ApiResponse numberOfAlerts(String baseurl, String riskid) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        if (baseurl != null) {
+            map.put("baseurl", baseurl);
+        }
+        if (riskid != null) {
+            map.put("riskId", riskid);
+        }
+        return api.callApi("alert", "view", "numberOfAlerts", map);
+    }
+
+    /**
+     * Gets a summary of the alerts, optionally filtered by a 'url'. If 'recurse' is true then all
+     * alerts that apply to urls that start with the specified 'url' will be returned, otherwise
+     * only those on exactly the same 'url' (ignoring url parameters)
+     */
+    public ApiResponse alertsByRisk(String url, String recurse) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        if (url != null) {
+            map.put("url", url);
+        }
+        if (recurse != null) {
+            map.put("recurse", recurse);
+        }
+        return api.callApi("alert", "view", "alertsByRisk", map);
+    }
+
+    /** Gets a count of the alerts, optionally filtered as per alertsPerRisk */
+    public ApiResponse alertCountsByRisk(String url, String recurse) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        if (url != null) {
+            map.put("url", url);
+        }
+        if (recurse != null) {
+            map.put("recurse", recurse);
+        }
+        return api.callApi("alert", "view", "alertCountsByRisk", map);
+    }
+
+    /** Deletes all alerts of the current session. */
+    public ApiResponse deleteAllAlerts() throws ClientApiException {
+        return api.callApi("alert", "action", "deleteAllAlerts", null);
+    }
+
+    /** Deletes the alert with the given ID. */
+    public ApiResponse deleteAlert(String id) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("id", id);
+        return api.callApi("alert", "action", "deleteAlert", map);
+    }
+}

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Ascan.java

@@ -85,6 +85,9 @@ public ApiResponse excludedFromScan() throws ClientApiException {
         return api.callApi("ascan", "view", "excludedFromScan", null);
     }
 
+    /**
+     * Gets the scanners, optionally, of the given scan policy and/or scanner policy/category ID.
+     */
     public ApiResponse scanners(String scanpolicyname, String policyid) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         if (scanpolicyname != null) {
@@ -189,6 +192,14 @@ public ApiResponse optionThreadPerHost() throws ClientApiException {
         return api.callApi("ascan", "view", "optionThreadPerHost", null);
     }
 
+    /**
+     * Tells whether or not the active scanner should add a query parameter to GET request that
+     * don't have parameters to start with.
+     */
+    public ApiResponse optionAddQueryParam() throws ClientApiException {
+        return api.callApi("ascan", "view", "optionAddQueryParam", null);
+    }
+
     public ApiResponse optionAllowAttackOnStart() throws ClientApiException {
         return api.callApi("ascan", "view", "optionAllowAttackOnStart", null);
     }
@@ -368,6 +379,9 @@ public ApiResponse excludeFromScan(String regex) throws ClientApiException {
         return api.callApi("ascan", "action", "excludeFromScan", map);
     }
 
+    /**
+     * Enables all scanners of the scan policy with the given name, or the default if none given.
+     */
     public ApiResponse enableAllScanners(String scanpolicyname) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         if (scanpolicyname != null) {
@@ -376,6 +390,9 @@ public ApiResponse enableAllScanners(String scanpolicyname) throws ClientApiExce
         return api.callApi("ascan", "action", "enableAllScanners", map);
     }
 
+    /**
+     * Disables all scanners of the scan policy with the given name, or the default if none given.
+     */
     public ApiResponse disableAllScanners(String scanpolicyname) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         if (scanpolicyname != null) {
@@ -384,6 +401,10 @@ public ApiResponse disableAllScanners(String scanpolicyname) throws ClientApiExc
         return api.callApi("ascan", "action", "disableAllScanners", map);
     }
 
+    /**
+     * Enables the scanners with the given IDs (comma separated list of IDs) of the scan policy with
+     * the given name, or the default if none given.
+     */
     public ApiResponse enableScanners(String ids, String scanpolicyname) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("ids", ids);
@@ -393,6 +414,10 @@ public ApiResponse enableScanners(String ids, String scanpolicyname) throws Clie
         return api.callApi("ascan", "action", "enableScanners", map);
     }
 
+    /**
+     * Disables the scanners with the given IDs (comma separated list of IDs) of the scan policy
+     * with the given name, or the default if none given.
+     */
     public ApiResponse disableScanners(String ids, String scanpolicyname)
             throws ClientApiException {
         Map<String, String> map = new HashMap<>();
@@ -572,6 +597,16 @@ public ApiResponse setOptionDefaultPolicy(String string) throws ClientApiExcepti
         return api.callApi("ascan", "action", "setOptionDefaultPolicy", map);
     }
 
+    /**
+     * Sets whether or not the active scanner should add a query param to GET requests which do not
+     * have parameters to start with.
+     */
+    public ApiResponse setOptionAddQueryParam(boolean bool) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("Boolean", Boolean.toString(bool));
+        return api.callApi("ascan", "action", "setOptionAddQueryParam", map);
+    }
+
     public ApiResponse setOptionAllowAttackOnStart(boolean bool) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("Boolean", Boolean.toString(bool));

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Authentication.java

@@ -36,35 +36,41 @@ public Authentication(ClientApi api) {
         this.api = api;
     }
 
+    /** Gets the name of the authentication methods. */
     public ApiResponse getSupportedAuthenticationMethods() throws ClientApiException {
         return api.callApi("authentication", "view", "getSupportedAuthenticationMethods", null);
     }
 
+    /** Gets the configuration parameters for the authentication method with the given name. */
     public ApiResponse getAuthenticationMethodConfigParams(String authmethodname)
             throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("authMethodName", authmethodname);
         return api.callApi("authentication", "view", "getAuthenticationMethodConfigParams", map);
     }
 
+    /** Gets the name of the authentication method for the context with the given ID. */
     public ApiResponse getAuthenticationMethod(String contextid) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("contextId", contextid);
         return api.callApi("authentication", "view", "getAuthenticationMethod", map);
     }
 
+    /** Gets the logged in indicator for the context with the given ID. */
     public ApiResponse getLoggedInIndicator(String contextid) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("contextId", contextid);
         return api.callApi("authentication", "view", "getLoggedInIndicator", map);
     }
 
+    /** Gets the logged out indicator for the context with the given ID. */
     public ApiResponse getLoggedOutIndicator(String contextid) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("contextId", contextid);
         return api.callApi("authentication", "view", "getLoggedOutIndicator", map);
     }
 
+    /** Sets the authentication method for the context with the given ID. */
     public ApiResponse setAuthenticationMethod(
             String contextid, String authmethodname, String authmethodconfigparams)
             throws ClientApiException {
@@ -77,6 +83,7 @@ public ApiResponse setAuthenticationMethod(
         return api.callApi("authentication", "action", "setAuthenticationMethod", map);
     }
 
+    /** Sets the logged in indicator for the context with the given ID. */
     public ApiResponse setLoggedInIndicator(String contextid, String loggedinindicatorregex)
             throws ClientApiException {
         Map<String, String> map = new HashMap<>();
@@ -85,6 +92,7 @@ public ApiResponse setLoggedInIndicator(String contextid, String loggedinindicat
         return api.callApi("authentication", "action", "setLoggedInIndicator", map);
     }
 
+    /** Sets the logged out indicator for the context with the given ID. */
     public ApiResponse setLoggedOutIndicator(String contextid, String loggedoutindicatorregex)
             throws ClientApiException {
         Map<String, String> map = new HashMap<>();

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Autoupdate.java

@@ -51,6 +51,11 @@ public ApiResponse installedAddons() throws ClientApiException {
         return api.callApi("autoupdate", "view", "installedAddons", null);
     }
 
+    /** Returns a list with all local add-ons, installed or not. */
+    public ApiResponse localAddons() throws ClientApiException {
+        return api.callApi("autoupdate", "view", "localAddons", null);
+    }
+
     /**
      * Return a list of any add-ons that have been added to the Marketplace since the last check for
      * updates
@@ -139,6 +144,12 @@ public ApiResponse installAddon(String id) throws ClientApiException {
         return api.callApi("autoupdate", "action", "installAddon", map);
     }
 
+    public ApiResponse installLocalAddon(String file) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("file", file);
+        return api.callApi("autoupdate", "action", "installLocalAddon", map);
+    }
+
     /** Uninstalls the specified add-on */
     public ApiResponse uninstallAddon(String id) throws ClientApiException {
         Map<String, String> map = new HashMap<>();

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Context.java

@@ -81,6 +81,13 @@ public ApiResponse excludedTechnologyList(String contextname) throws ClientApiEx
         return api.callApi("context", "view", "excludedTechnologyList", map);
     }
 
+    /** Lists the URLs accessed through/by ZAP, that belong to the context with the given name. */
+    public ApiResponse urls(String contextname) throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("contextName", contextname);
+        return api.callApi("context", "view", "urls", map);
+    }
+
     /** Add exclude regex to context */
     public ApiResponse excludeFromContext(String contextname, String regex)
             throws ClientApiException {
@@ -99,6 +106,16 @@ public ApiResponse includeInContext(String contextname, String regex)
         return api.callApi("context", "action", "includeInContext", map);
     }
 
+    /** Set the regexs to include and exclude for a context, both supplied as JSON string arrays */
+    public ApiResponse setContextRegexs(String contextname, String incregexs, String excregexs)
+            throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("contextName", contextname);
+        map.put("incRegexs", incregexs);
+        map.put("excRegexs", excregexs);
+        return api.callApi("context", "action", "setContextRegexs", map);
+    }
+
     /** Creates a new context with the given name in the current session */
     public ApiResponse newContext(String contextname) throws ClientApiException {
         Map<String, String> map = new HashMap<>();