Update APIs of add-ons and core

Update `fileUpload` to use the expected HTTP method.

Add/update the APIs of the following add-ons:
 - Custom Payloads version 0.13.0
 - Selenium version 15.16.0

Signed-off-by: thc202 <[email protected]>

Author: thc202

CHANGELOG.md

@@ -4,8 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
+### Added
+* Add the API of the following add-on:
+    * Custom Payloads version 0.13.0.
+
 ### Changed
 * Allow to call the ZAP API with custom HTTP method (e.g. file upload).
+* Update the APIs of the following add-on:
+    * Selenium version 15.16.0.
+
+### Fixed
+* Correct the HTTP method used by `fileUpload` core API.
 
 ## [2.0.0-rc.3] - 2023-10-14
 ### Changed

src/core.js

@@ -881,7 +881,7 @@ Core.prototype.fileDownload = function (args) {
  * @param {string} filecontents - The contents of the file.
  **/
 Core.prototype.fileUpload = function (args) {
-  return this.api.request('/core/other/fileUpload/', { fileName: args.filename, fileContents: args.filecontents }, 'other')
+  return this.api.request('/core/other/fileUpload/', { fileName: args.filename, fileContents: args.filecontents }, 'other', 'POST')
 }
 
 module.exports = Core

src/custompayloads.js

@@ -0,0 +1,132 @@
+/* Zed Attack Proxy (ZAP) and its related class files.
+ *
+ * ZAP is an HTTP/HTTPS proxy for assessing web application security.
+ *
+ * Copyright 2023 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.
+ */
+
+'use strict'
+
+/**
+ * This file was automatically generated.
+ */
+function Custompayloads (clientApi) {
+  this.api = clientApi
+}
+
+/**
+ * Lists all available categories.
+ * This component is optional and therefore the API will only work if it is installed
+ **/
+Custompayloads.prototype.customPayloadsCategories = function () {
+  return this.api.request('/custompayloads/view/customPayloadsCategories/')
+}
+
+/**
+ * Lists all the payloads currently loaded (category, payload, enabled state). Optionally filtered by category.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for which the payloads should be displayed.
+ **/
+Custompayloads.prototype.customPayloads = function (args) {
+  const params = { }
+  if (args.category && args.category !== null) {
+    params.category = args.category
+  }
+  return this.api.request('/custompayloads/view/customPayloads/', params)
+}
+
+/**
+ * Disables payloads for a given category.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for which the payloads should be disabled (leave empty for all).
+ **/
+Custompayloads.prototype.disableCustomPayloads = function (args) {
+  const params = { }
+  if (args.category && args.category !== null) {
+    params.category = args.category
+  }
+  return this.api.request('/custompayloads/action/disableCustomPayloads/', params)
+}
+
+/**
+ * Enables payloads for a given category.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for which the payloads should be enabled (leave empty for all).
+ **/
+Custompayloads.prototype.enableCustomPayloads = function (args) {
+  const params = { }
+  if (args.category && args.category !== null) {
+    params.category = args.category
+  }
+  return this.api.request('/custompayloads/action/enableCustomPayloads/', params)
+}
+
+/**
+ * Removes a payload.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category of the payload being removed.
+ * @param {string} payload - The payload being removed.
+ **/
+Custompayloads.prototype.removeCustomPayload = function (args) {
+  const params = { category: args.category }
+  if (args.payload && args.payload !== null) {
+    params.payload = args.payload
+  }
+  return this.api.request('/custompayloads/action/removeCustomPayload/', params)
+}
+
+/**
+ * Adds a new payload.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for the new payload.
+ * @param {string} payload - The payload to be added.
+ **/
+Custompayloads.prototype.addCustomPayload = function (args) {
+  const params = { category: args.category }
+  if (args.payload && args.payload !== null) {
+    params.payload = args.payload
+  }
+  return this.api.request('/custompayloads/action/addCustomPayload/', params)
+}
+
+/**
+ * Enables a given payload.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for the payload being enabled.
+ * @param {string} payload - The payload being enabled.
+ **/
+Custompayloads.prototype.enableCustomPayload = function (args) {
+  const params = { category: args.category }
+  if (args.payload && args.payload !== null) {
+    params.payload = args.payload
+  }
+  return this.api.request('/custompayloads/action/enableCustomPayload/', params)
+}
+
+/**
+ * Disables a given payload.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} category - The category for the payload being disabled.
+ * @param {string} payload - The payload being disabled.
+ **/
+Custompayloads.prototype.disableCustomPayload = function (args) {
+  const params = { category: args.category }
+  if (args.payload && args.payload !== null) {
+    params.payload = args.payload
+  }
+  return this.api.request('/custompayloads/action/disableCustomPayload/', params)
+}
+
+module.exports = Custompayloads

src/selenium.js

@@ -57,6 +57,13 @@ Selenium.prototype.optionFirefoxBinaryPath = function () {
   return this.api.request('/selenium/view/optionFirefoxBinaryPath/')
 }
 
+/**
+ * This component is optional and therefore the API will only work if it is installed
+ **/
+Selenium.prototype.optionFirefoxDefaultProfile = function () {
+  return this.api.request('/selenium/view/optionFirefoxDefaultProfile/')
+}
+
 /**
  * Returns the current path to Firefox driver (geckodriver)
  * This component is optional and therefore the API will only work if it is installed
@@ -86,6 +93,15 @@ Selenium.prototype.optionPhantomJsBinaryPath = function () {
   return this.api.request('/selenium/view/optionPhantomJsBinaryPath/')
 }
 
+/**
+ * Gets the browser arguments.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} browser - The browser, chrome or firefox.
+ **/
+Selenium.prototype.getBrowserArguments = function (args) {
+  return this.api.request('/selenium/view/getBrowserArguments/', { browser: args.browser })
+}
+
 /**
  * Sets the current path to Chrome binary
  * This component is optional and therefore the API will only work if it is installed
@@ -113,6 +129,13 @@ Selenium.prototype.setOptionFirefoxBinaryPath = function (args) {
   return this.api.request('/selenium/action/setOptionFirefoxBinaryPath/', { String: args.string })
 }
 
+/**
+ * This component is optional and therefore the API will only work if it is installed
+ **/
+Selenium.prototype.setOptionFirefoxDefaultProfile = function (args) {
+  return this.api.request('/selenium/action/setOptionFirefoxDefaultProfile/', { String: args.string })
+}
+
 /**
  * Sets the current path to Firefox driver (geckodriver)
  * This component is optional and therefore the API will only work if it is installed
@@ -143,4 +166,40 @@ Selenium.prototype.setOptionPhantomJsBinaryPath = function (args) {
   return this.api.request('/selenium/action/setOptionPhantomJsBinaryPath/', { String: args.string })
 }
 
+/**
+ * Adds a browser argument.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} browser - The browser, chrome or firefox.
+ * @param {string} argument - The argument.
+ * @param {string} enabled - The enabled state, true or false.
+ **/
+Selenium.prototype.addBrowserArgument = function (args) {
+  const params = { browser: args.browser, argument: args.argument }
+  if (args.enabled && args.enabled !== null) {
+    params.enabled = args.enabled
+  }
+  return this.api.request('/selenium/action/addBrowserArgument/', params)
+}
+
+/**
+ * Removes a browser argument.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} browser - The browser, chrome or firefox.
+ * @param {string} argument - The argument.
+ **/
+Selenium.prototype.removeBrowserArgument = function (args) {
+  return this.api.request('/selenium/action/removeBrowserArgument/', { browser: args.browser, argument: args.argument })
+}
+
+/**
+ * Sets whether or not a browser argument is enabled.
+ * This component is optional and therefore the API will only work if it is installed
+ * @param {string} browser - The browser, chrome or firefox.
+ * @param {string} argument - The argument.
+ * @param {string} enabled - The enabled state, true or false.
+ **/
+Selenium.prototype.setBrowserArgumentEnabled = function (args) {
+  return this.api.request('/selenium/action/setBrowserArgumentEnabled/', { browser: args.browser, argument: args.argument, enabled: args.enabled })
+}
+
 module.exports = Selenium