zaproxy 0.0.1 → 0.0.3

data/lib/zap/v2apis/http_sessions.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class HTTPSessions
+    def initialize(client)
+      @client = client
+    end
+
+    def active_session(site)
+      @client.get("/JSON/httpSessions/view/activeSession/?site=#{site}")
+    end
+
+    def default_session_tokens
+      @client.get('/JSON/httpSessions/view/defaultSessionTokens/')
+    end
+
+    def session_tokens(site)
+      @client.get("/JSON/httpSessions/view/sessionTokens/?site=#{site}")
+    end
+
+    def sessions(site, session = nil)
+      @client.get("/JSON/httpSessions/view/sessions/?site=#{site}&session=#{session}")
+    end
+
+    def sites
+      @client.get('/JSON/httpSessions/view/sites/')
+    end
+
+    def add_default_session_token(token, enabled)
+      @client.get("/JSON/httpSessions/action/addDefaultSessionToken/?token=#{token}&enabled=#{enabled}")
+    end
+
+    def add_session_token(site, session_token)
+      @client.get("/JSON/httpSessions/action/addSessionToken/?site=#{site}&sessionToken=#{session_token}")
+    end
+
+    def create_empty_session(site, session = nil)
+      @client.get("/JSON/httpSessions/action/createEmptySession/?site=#{site}&session=#{session}")
+    end
+
+    def remove_default_session_token(token)
+      @client.get("/JSON/httpSessions/action/removeDefaultSessionToken/?token=#{token}")
+    end
+
+    def remove_session(site, session)
+      @client.get("/JSON/httpSessions/action/removeSession/?site=#{site}&session=#{session}")
+    end
+
+    def remove_session_token(site, session_token)
+      @client.get("/JSON/httpSessions/action/removeSessionToken/?site=#{site}&sessionToken=#{session_token}")
+    end
+
+    def rename_session(site, old_session_name, new_session_name)
+      @client.get("/JSON/httpSessions/action/renameSession/?site=#{site}&oldSessionName=#{old_session_name}&newSessionName=#{new_session_name}")
+    end
+
+    def set_active_session(site, session)
+      @client.get("/JSON/httpSessions/action/setActiveSession/?site=#{site}&session=#{session}")
+    end
+
+    def set_default_session_token_enabled(token, enabled)
+      @client.get("/JSON/httpSessions/action/setDefaultSessionTokenEnabled/?token=#{token}&enabled=#{enabled}")
+    end
+
+    def set_session_token_value(site, session, session_token, token_value)
+      @client.get("/JSON/httpSessions/action/setSessionTokenValue/?site=#{site}&session=#{session}&sessionToken=#{session_token}&tokenValue=#{token_value}")
+    end
+
+    def unset_active_session(site)
+      @client.get("/JSON/httpSessions/action/unsetActiveSession/?site=#{site}")
+    end
+  end
+end

data/lib/zap/v2apis/hud.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class HUD
+    def initialize(client)
+      @client = client
+    end
+
+    def get_ui_option(key)
+      @client.get("/JSON/hud/view/getUiOption/?key=#{key}")
+    end
+
+    def heartbeat
+      @client.get('/JSON/hud/view/heartbeat/')
+    end
+
+    def hud_alert_data(url)
+      @client.get("/JSON/hud/view/hudAlertData/?url=#{url}")
+    end
+
+    def option_allow_unsafe_eval
+      @client.get('/JSON/hud/view/optionAllowUnsafeEval/')
+    end
+
+    def option_base_directory
+      @client.get('/JSON/hud/view/optionBaseDirectory/')
+    end
+
+    def option_development_mode
+      @client.get('/JSON/hud/view/optionDevelopmentMode/')
+    end
+
+    def option_enable_on_domain_msgs
+      @client.get('/JSON/hud/view/optionEnableOnDomainMsgs/')
+    end
+
+    def option_enable_telemetry
+      @client.get('/JSON/hud/view/optionEnableTelemetry/')
+    end
+
+    def option_enabled_for_daemon
+      @client.get('/JSON/hud/view/optionEnabledForDaemon/')
+    end
+
+    def option_enabled_for_desktop
+      @client.get('/JSON/hud/view/optionEnabledForDesktop/')
+    end
+
+    def option_in_scope_only
+      @client.get('/JSON/hud/view/optionInScopeOnly/')
+    end
+
+    def option_remove_csp
+      @client.get('/JSON/hud/view/optionRemoveCSP/')
+    end
+
+    def option_show_welcome_screen
+      @client.get('/JSON/hud/view/optionShowWelcomeScreen/')
+    end
+
+    def option_skip_tutorial_tasks
+      @client.get('/JSON/hud/view/optionSkipTutorialTasks/')
+    end
+
+    def option_tutorial_host
+      @client.get('/JSON/hud/view/optionTutorialHost/')
+    end
+
+    def option_tutorial_port
+      @client.get('/JSON/hud/view/optionTutorialPort/')
+    end
+
+    def option_tutorial_tasks_done
+      @client.get('/JSON/hud/view/optionTzutorialTasksDone/')
+    end
+
+    def option_tutorial_test_mode
+      @client.get('/JSON/hud/view/optionTutorialTestMode/')
+    end
+
+    def option_tutorial_updates
+      @client.get('/JSON/hud/view/optionTutorialUpdates/')
+    end
+
+    def tutorial_updates
+      @client.get('/JSON/hud/view/tutorialUpdates/')
+    end
+
+    def upgraded_domains
+      @client.get('/JSON/hud/view/upgradedDomains/')
+    end
+
+    def log(record)
+      @client.get("/JSON/hud/action/log/?record=#{record}")
+    end
+
+    def record_request(header, body)
+      @client.get("/JSON/hud/action/recordRequest/?header=#{header}&body=#{body}")
+    end
+
+    def reset_tutorial_tasks
+      @client.get('/JSON/hud/action/resetTutorialTasks/')
+    end
+
+    def set_option_base_directory(string)
+      @client.get("/JSON/hud/action/setOptionBaseDirectory/?String=#{string}")
+    end
+
+    def set_option_development_mode(boolean)
+      @client.get("/JSON/hud/action/setOptionDevelopmentMode/?Boolean=#{boolean}")
+    end
+
+    def set_option_enable_on_domain_msgs(boolean)
+      @client.get("/JSON/hud/action/setOptionEnableOnDomainMsgs/?Boolean=#{boolean}")
+    end
+
+    def set_option_enabled_for_daemon(boolean)
+      @client.get("/JSON/hud/action/setOptionEnabledForDaemon/?Boolean=#{boolean}")
+    end
+
+    def set_option_enabled_for_desktop(boolean)
+      @client.get("/JSON/hud/action/setOptionEnabledForDesktop/?Boolean=#{boolean}")
+    end
+
+    def set_option_in_scope_only(boolean)
+      @client.get("/JSON/hud/action/setOptionInScopeOnly/?Boolean=#{boolean}")
+    end
+
+    def set_option_remove_csp(boolean)
+      @client.get("/JSON/hud/action/setOptionRemoveCSP/?Boolean=#{boolean}")
+    end
+
+    def set_option_show_welcome_screen(boolean)
+      @client.get("/JSON/hud/action/setOptionShowWelcomeScreen/?Boolean=#{boolean}")
+    end
+
+    def set_option_skip_tutorial_tasks(boolean)
+      @client.get("/JSON/hud/action/setOptionSkipTutorialTasks/?Boolean=#{boolean}")
+    end
+
+    def set_option_tutorial_task_done(string)
+      @client.get("/JSON/hud/action/setOptionTutorialTaskDone/?String=#{string}")
+    end
+
+    def set_option_tutorial_test_mode(boolean)
+      @client.get("/JSON/hud/action/setOptionTutorialTestMode/?Boolean=#{boolean}")
+    end
+
+    def set_ui_option(key, value)
+      @client.get("/JSON/hud/action/setUiOption/?key=#{key}&value=#{value}")
+    end
+
+    def changes_in_html
+      @client.get('/OTHER/hud/other/changesInHtml/')
+    end
+  end
+end

data/lib/zap/v2apis/import_urls.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class ImportURLs
+    def initialize(client)
+      @client = client
+    end
+
+    def importurls(file_path)
+      @client.get("/JSON/importurls/action/importurls/?filePath=#{file_path}")
+    end
+  end
+end

data/lib/zap/v2apis/keyboard.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class Keyboard
+    def initialize(client)
+      @client = client
+    end
+
+    def cheatsheet_action_order(inc_unset)
+      @client.get("/JSON/keyboard/view/cheatsheetActionOrder/?incUnset=#{inc_unset}")
+    end
+
+    def cheatsheet_key_order(inc_unset)
+      @client.get("/JSON/keyboard/view/cheatsheetKeyOrder/?incUnset=#{inc_unset}")
+    end
+  end
+end

data/lib/zap/v2apis/local_proxies.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class LocalProxies
+    def initialize(client)
+      @client = client
+    end
+
+    def additional_proxies
+      @client.get('/JSON/localProxies/view/additionalProxies/')
+    end
+
+    def add_additional_proxy(address, port, behind_nat, always_decode_zip, remove_unsupported_encodings)
+      @client.get("/JSON/localProxies/action/addAdditionalProxy/?address=#{address}&port=#{port}&behindNat=#{behind_nat}&alwaysDecodeZip=#{always_decode_zip}&removeUnsupportedEncodings=#{remove_unsupported_encodings}")
+    end
+
+    def remove_additional_proxy(address, port)
+      @client.get("/JSON/localProxies/action/removeAdditionalProxy/?address=#{address}&port=#{port}")
+    end
+  end
+end

data/lib/zap/v2apis/network.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class Network
+    def initialize(client)
+      @client = client
+    end
+
+    def get_aliases
+      @client.get('/JSON/network/view/getAliases/')
+    end
+
+    def get_connection_timeout
+      @client.get('/JSON/network/view/getConnectionTimeout/')
+    end
+
+    def get_default_user_agent
+      @client.get('/JSON/network/view/getDefaultUserAgent/')
+    end
+
+    def get_dns_ttl_successful_queries
+      @client.get('/JSON/network/view/getDnsTtlSuccessfulQueries/')
+    end
+
+    def get_http_proxy
+      @client.get('/JSON/network/view/getHttpProxy/')
+    end
+
+    def get_http_proxy_exclusions
+      @client.get('/JSON/network/view/getHttpProxyExclusions/')
+    end
+
+    def get_local_servers
+      @client.get('/JSON/network/view/getLocalServers/')
+    end
+
+    def get_pass_throughs
+      @client.get('/JSON/network/view/getPassThroughs/')
+    end
+
+    def get_rate_limit_rules
+      @client.get('/JSON/network/view/getRateLimitRules/')
+    end
+
+    def get_root_ca_cert_validity
+      @client.get('/JSON/network/view/getRootCaCertValidity/')
+    end
+
+    def get_server_cert_validity
+      @client.get('/JSON/network/view/getServerCertValidity/')
+    end
+
+    def get_socks_proxy
+      @client.get('/JSON/network/view/getSocksProxy/')
+    end
+
+    def is_http_proxy_auth_enabled
+      @client.get('/JSON/network/view/isHttpProxyAuthEnabled/')
+    end
+
+    def is_http_proxy_enabled
+      @client.get('/JSON/network/view/isHttpProxyEnabled/')
+    end
+
+    def is_socks_proxy_enabled
+      @client.get('/JSON/network/view/isSocksProxyEnabled/')
+    end
+
+    def is_use_global_http_state
+      @client.get('/JSON/network/view/isUseGlobalHttpState/')
+    end
+
+    def add_alias(name, enabled)
+      @client.get("/JSON/network/action/addAlias/?name=#{name}&enabled=#{enabled}")
+    end
+
+    def add_http_proxy_exclusion(host, enabled)
+      @client.get("/JSON/network/action/addHttpProxyExclusion/?host=#{host}&enabled=#{enabled}")
+    end
+
+    def add_local_server(address, port, api, proxy, behind_nat, decode_response, remove_accept_encoding)
+      @client.get("/JSON/network/action/addLocalServer/?address=#{address}&port=#{port}&api=#{api}&proxy=#{proxy}&behindNat=#{behind_nat}&decodeResponse=#{decode_response}&removeAcceptEncoding=#{remove_accept_encoding}")
+    end
+
+    def add_pass_through(authority, enabled)
+      @client.get("/JSON/network/action/addPassThrough/?authority=#{authority}&enabled=#{enabled}")
+    end
+
+    def add_pkcs12_client_certificate(file_path, password, index)
+      @client.get("/JSON/network/action/addPkcs12ClientCertificate/?filePath=#{file_path}&password=#{password}&index=#{index}")
+    end
+
+    def add_rate_limit_rule(description, enabled, match_regex, match_string, requests_per_second, group_by)
+      @client.get("/JSON/network/action/addRateLimitRule/?description=#{description}&enabled=#{enabled}&matchRegex=#{match_regex}&matchString=#{match_string}&requestsPerSecond=#{requests_per_second}&groupBy=#{group_by}")
+    end
+
+    def generate_root_ca_cert
+      @client.get('/JSON/network/action/generateRootCaCert/')
+    end
+
+    def import_root_ca_cert(file_path)
+      @client.get("/JSON/network/action/importRootCaCert/?filePath=#{file_path}")
+    end
+
+    def remove_alias(name)
+      @client.get("/JSON/network/action/removeAlias/?name=#{name}")
+    end
+
+    def remove_http_proxy_exclusion(host)
+      @client.get("/JSON/network/action/removeHttpProxyExclusion/?host=#{host}")
+    end
+
+    def remove_local_server(address, port)
+      @client.get("/JSON/network/action/removeLocalServer/?address=#{address}&port=#{port}")
+    end
+
+    def remove_pass_through(authority)
+      @client.get("/JSON/network/action/removePassThrough/?authority=#{authority}")
+    end
+
+    def remove_rate_limit_rule(description)
+      @client.get("/JSON/network/action/removeRateLimitRule/?description=#{description}")
+    end
+
+    def set_alias_enabled(name, enabled)
+      @client.get("/JSON/network/action/setAliasEnabled/?name=#{name}&enabled=#{enabled}")
+    end
+
+    def set_connection_timeout(timeout)
+      @client.get("/JSON/network/action/setConnectionTimeout/?timeout=#{timeout}")
+    end
+
+    def set_default_user_agent(user_agent)
+      @client.get("/JSON/network/action/setDefaultUserAgent/?userAgent=#{user_agent}")
+    end
+
+    def set_dns_ttl_successful_queries(ttl)
+      @client.get("/JSON/network/action/setDnsTtlSuccessfulQueries/?ttl=#{ttl}")
+    end
+
+    def set_http_proxy(host, port, realm, username, password)
+      @client.get("/JSON/network/action/setHttpProxy/?host=#{host}&port=#{port}&realm=#{realm}&username=#{username}&password=#{password}")
+    end
+
+    def set_http_proxy_auth_enabled(enabled)
+      @client.get("/JSON/network/action/setHttpProxyAuthEnabled/?enabled=#{enabled}")
+    end
+
+    def set_http_proxy_enabled(enabled)
+      @client.get("/JSON/network/action/setHttpProxyEnabled/?enabled=#{enabled}")
+    end
+
+    def set_http_proxy_exclusion_enabled(host, enabled)
+      @client.get("/JSON/network/action/setHttpProxyExclusionEnabled/?host=#{host}&enabled=#{enabled}")
+    end
+
+    def set_pass_through_enabled(authority, enabled)
+      @client.get("/JSON/network/action/setPassThroughEnabled/?authority=#{authority}&enabled=#{enabled}")
+    end
+
+    def set_rate_limit_rule_enabled(description, enabled)
+      @client.get("/JSON/network/action/setRateLimitRuleEnabled/?description=#{description}&enabled=#{enabled}")
+    end
+
+    def set_root_ca_cert_validity(validity)
+      @client.get("/JSON/network/action/setRootCaCertValidity/?validity=#{validity}")
+    end
+
+    def set_server_cert_validity(validity)
+      @client.get("/JSON/network/action/setServerCertValidity/?validity=#{validity}")
+    end
+
+    def set_socks_proxy(host, port, version, use_dns, username, password)
+      @client.get("/JSON/network/action/setSocksProxy/?host=#{host}&port=#{port}&version=#{version}&useDns=#{use_dns}&username=#{username}&password=#{password}")
+    end
+
+    def set_socks_proxy_enabled(enabled)
+      @client.get("/JSON/network/action/setSocksProxyEnabled/?enabled=#{enabled}")
+    end
+
+    def set_use_client_certificate(use)
+      @client.get("/JSON/network/action/setUseClientCertificate/?use=#{use}")
+    end
+
+    def set_use_global_http_state(use)
+      @client.get("/JSON/network/action/setUseGlobalHttpState/?use=#{use}")
+    end
+
+    def proxy_pac
+      @client.get('/OTHER/network/other/proxy.pac/')
+    end
+
+    def root_ca_cert
+      @client.get('/OTHER/network/other/rootCaCert/')
+    end
+
+    def set_proxy(proxy)
+      @client.get("/OTHER/network/other/setProxy/?proxy=#{proxy}")
+    end
+  end
+end

data/lib/zap/v2apis/openapi.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class OpenAPI
+    def initialize(client)
+      @client = client
+    end
+
+    def import_file(target, contextid)
+      @client.get("/JSON/openapi/action/importFile/?target=#{target}&contextId=#{contextid}")
+    end
+
+    def import_url(host_override, contextid)
+      @client.get("/JSON/openapi/action/importUrl/?hostOverride=#{host_override}&contextId=#{contextid}")
+    end
+  end
+end

data/lib/zap/v2apis/params.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class Params
+    def initialize(client)
+      @client = client
+    end
+
+    def params(site)
+      @client.get("/JSON/params/view/params/?site=#{site}")
+    end
+  end
+end

data/lib/zap/v2apis/pnh.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class PnH
+    def initialize(client)
+      @client = client
+    end
+
+    def monitor(message)
+      @client.get("/JSON/pnh/action/monitor/?message=#{message}")
+    end
+
+    def oracle
+      @client.get('/JSON/pnh/view/oracle/')
+    end
+
+    def start_monitoring(url)
+      @client.get("/JSON/pnh/action/startMonitoring/?url=#{url}")
+    end
+
+    def stop_monitoring(id)
+      @client.get("/JSON/pnh/action/stopMonitoring/?id=#{id}")
+    end
+
+    def fx_pnh_xpi
+      @client.get('/OTHER/core/other/fx_pnh.xpi/')
+    end
+
+    def manifest
+      @client.get('/OTHER/core/other/manifest/')
+    end
+
+    def pnh
+      @client.get('/OTHER/core/other/pnh/')
+    end
+
+    def service
+      @client.get('/OTHER/core/other/service/')
+    end
+  end
+end

data/lib/zap/v2apis/postman.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class Postman
+    def initialize(client)
+      @client = client
+    end
+
+    def import_file(target, contextid)
+      @client.get("/JSON/postman/action/importFile/?target=#{target}&contextId=#{contextid}")
+    end
+
+    def import_url(host_override, contextid)
+      @client.get("/JSON/postman/action/importUrl/?hostOverride=#{host_override}&contextId=#{contextid}")
+    end
+  end
+end

data/lib/zap/v2apis/pscan.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class Pscan
+    def initialize(client)
+      @client = client
+    end
+
+    def current_rule
+      @client.get('/JSON/pscan/view/currentRule/')
+    end
+
+    def current_tasks
+      @client.get('/JSON/pscan/view/currentTasks/')
+    end
+
+    def max_alerts_per_rule
+      @client.get('/JSON/pscan/view/maxAlertsPerRule/')
+    end
+
+    def records_to_scan
+      @client.get('/JSON/pscan/view/recordsToScan/')
+    end
+
+    def scan_only_in_scope
+      @client.get('/JSON/pscan/view/scanOnlyInScope/')
+    end
+
+    def scanners
+      @client.get('/JSON/pscan/view/scanners/')
+    end
+
+    def clear_queue
+      @client.get('/JSON/pscan/action/clearQueue/')
+    end
+
+    def disable_all_scanners
+      @client.get('/JSON/pscan/action/disableAllScanners/')
+    end
+
+    def disable_all_tags
+      @client.get('/JSON/pscan/action/disableAllTags/')
+    end
+
+    def disable_scanners(ids)
+      @client.get("/JSON/pscan/action/disableScanners/?ids=#{ids}")
+    end
+
+    def enable_all_scanners
+      @client.get('/JSON/pscan/action/enableAllScanners/')
+    end
+
+    def enable_all_tags
+      @client.get('/JSON/pscan/action/enableAllTags/')
+    end
+
+    def enable_scanners(ids)
+      @client.get("/JSON/pscan/action/enableScanners/?ids=#{ids}")
+    end
+
+    def set_enabled(enabled)
+      @client.get("/JSON/pscan/action/setEnabled/?enabled=#{enabled}")
+    end
+
+    def set_max_alerts_per_rule(max_alerts)
+      @client.get("/JSON/pscan/action/setMaxAlertsPerRule/?maxAlerts=#{max_alerts}")
+    end
+
+    def set_scan_only_in_scope(only_in_scope)
+      @client.get("/JSON/pscan/action/setScanOnlyInScope/?onlyInScope=#{only_in_scope}")
+    end
+
+    def set_scanner_alert_threshold(id, alert_threshold)
+      @client.get("/JSON/pscan/action/setScannerAlertThreshold/?id=#{id}&alertThreshold=#{alert_threshold}")
+    end
+  end
+end

data/lib/zap/v2apis/quickstartlaunch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ZAPv2 < ZAP
+  class QuickStartLaunch
+    def initialize(client)
+      @client = client
+    end
+
+    def start_page
+      @client.get('/JSON/quickstart/view/startPage/')
+    end
+  end
+end