Class: ZAPv2::Core

Inherits:
Object
  • Object
show all
Defined in:
lib/zap/v2apis/core.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Core

Returns a new instance of Core.



5
6
7
 
# File 'lib/zap/v2apis/core.rb', line 5

def initialize(client)
  @client = client
end

Instance Method Details

#access_url(url, followredirects) ⇒ Object 



169
170
171
 
# File 'lib/zap/v2apis/core.rb', line 169

def access_url(url, followredirects)
  @client.get("/JSON/core/action/accessUrl/?url=#{url}&followRedirects=#{followredirects}")
end

#add_proxy_chain_excluded_domain(value, isregex, isenabled) ⇒ Object 



173
174
175
 
# File 'lib/zap/v2apis/core.rb', line 173

def add_proxy_chain_excluded_domain(value, isregex, isenabled)
  @client.get("/JSON/core/action/addProxyChainExcludedDomain/?value=#{value}&isRegex=#{isregex}&isEnabled=#{isenabled}")
end

#alert(id) ⇒ Object 



9
10
11
 
# File 'lib/zap/v2apis/core.rb', line 9

def alert(id)
  @client.get("/JSON/core/view/alert/?id=#{id}")
end

#alerts(baseurl, start, count, riskid) ⇒ Object 



13
14
15
 
# File 'lib/zap/v2apis/core.rb', line 13

def alerts(baseurl, start, count, riskid)
  @client.get("/JSON/core/view/alerts/?baseurl=#{baseurl}&start=#{start}&count=#{count}&riskid=#{riskid}")
end

#alerts_summary(baseurl) ⇒ Object 



17
18
19
 
# File 'lib/zap/v2apis/core.rb', line 17

def alerts_summary(baseurl)
  @client.get("/JSON/core/view/alertsSummary/?baseurl=#{baseurl}")
end

#child_nodes(url) ⇒ Object 



21
22
23
 
# File 'lib/zap/v2apis/core.rb', line 21

def child_nodes(url)
  @client.get("/JSON/core/view/childNodes/?url=#{url}")
end

#clear_excluded_from_proxy ⇒ Object 



177
178
179
 
# File 'lib/zap/v2apis/core.rb', line 177

def clear_excluded_from_proxy
  @client.get('/JSON/core/action/clearExcludedFromProxy/')
end

#create_sbom_zip(filepath) ⇒ Object 



181
182
183
 
# File 'lib/zap/v2apis/core.rb', line 181

def create_sbom_zip(filepath)
  @client.get("/JSON/core/action/createSbomZip/?filePath=#{filepath}")
end

#delete_alert(id) ⇒ Object 



185
186
187
 
# File 'lib/zap/v2apis/core.rb', line 185

def delete_alert(id)
  @client.get("/JSON/core/action/deleteAlert/?id=#{id}")
end

#delete_all_alerts ⇒ Object 



189
190
191
 
# File 'lib/zap/v2apis/core.rb', line 189

def delete_all_alerts
  @client.get('/JSON/core/action/deleteAllAlerts/')
end

#delete_site_node(url, method, postdata) ⇒ Object 



193
194
195
 
# File 'lib/zap/v2apis/core.rb', line 193

def delete_site_node(url, method, postdata)
  @client.get("/JSON/core/action/deleteSiteNode/?url=#{url}&method=#{method}&postData=#{postdata}")
end

#disable_all_proxy_chain_excluded_domains ⇒ Object 



197
198
199
 
# File 'lib/zap/v2apis/core.rb', line 197

def disable_all_proxy_chain_excluded_domains
  @client.get('/JSON/core/action/disableAllProxyChainExcludedDomains/')
end

#disable_client_certificate ⇒ Object 



201
202
203
 
# File 'lib/zap/v2apis/core.rb', line 201

def disable_client_certificate
  @client.get('/JSON/core/action/disableClientCertificate/')
end

#enable_all_proxy_chain_excluded_domains ⇒ Object 



205
206
207
 
# File 'lib/zap/v2apis/core.rb', line 205

def enable_all_proxy_chain_excluded_domains
  @client.get('/JSON/core/action/enableAllProxyChainExcludedDomains/')
end

#enable_pkcs12_client_certificate(filepath, password, index) ⇒ Object 



209
210
211
 
# File 'lib/zap/v2apis/core.rb', line 209

def enable_pkcs12_client_certificate(filepath, password, index)
  @client.get("/JSON/core/action/enablePKCS12ClientCertificate/?filePath=#{filepath}&password=#{password}&index=#{index}")
end

#exclude_from_proxy(regex) ⇒ Object 



213
214
215
 
# File 'lib/zap/v2apis/core.rb', line 213

def exclude_from_proxy(regex)
  @client.get("/JSON/core/action/excludeFromProxy/?regex=#{regex}")
end

#excluded_from_proxy ⇒ Object 



25
26
27
 
# File 'lib/zap/v2apis/core.rb', line 25

def excluded_from_proxy
  @client.get('/JSON/core/view/excludedFromProxy/')
end

#file_download(filename) ⇒ Object 



337
338
339
 
# File 'lib/zap/v2apis/core.rb', line 337

def file_download(filename)
  @client.get("/OTHER/core/other/fileDownload/?fileName=#{filename}")
end

#file_upload(filename, filecontents) ⇒ Object 



341
342
343
 
# File 'lib/zap/v2apis/core.rb', line 341

def file_upload(filename, filecontents)
  @client.get("/OTHER/core/other/fileUpload/?fileName=#{filename}&fileContents=#{filecontents}")
end

#generate_root_ca ⇒ Object 



217
218
219
 
# File 'lib/zap/v2apis/core.rb', line 217

def generate_root_ca
  @client.get('/JSON/core/action/generateRootCA/')
end

#home_directory ⇒ Object 



29
30
31
 
# File 'lib/zap/v2apis/core.rb', line 29

def home_directory
  @client.get('/JSON/core/view/homeDirectory/')
end

#hosts ⇒ Object 



33
34
35
 
# File 'lib/zap/v2apis/core.rb', line 33

def hosts
  @client.get('/JSON/core/view/hosts/')
end

#htmlreport ⇒ Object 



345
346
347
 
# File 'lib/zap/v2apis/core.rb', line 345

def htmlreport
  @client.get('/OTHER/core/other/htmlreport/')
end

#jsonreport ⇒ Object 



349
350
351
 
# File 'lib/zap/v2apis/core.rb', line 349

def jsonreport
  @client.get('/OTHER/core/other/jsonreport/')
end

#load_session(name) ⇒ Object 



221
222
223
 
# File 'lib/zap/v2apis/core.rb', line 221

def load_session(name)
  @client.get("/JSON/core/action/loadSession/?name=#{name}")
end

#mdreport ⇒ Object 



353
354
355
 
# File 'lib/zap/v2apis/core.rb', line 353

def mdreport
  @client.get('/OTHER/core/other/mdreport/')
end

#message(id) ⇒ Object 



37
38
39
 
# File 'lib/zap/v2apis/core.rb', line 37

def message(id)
  @client.get("/JSON/core/view/message/?id=#{id}")
end

#message_har(id) ⇒ Object 



357
358
359
 
# File 'lib/zap/v2apis/core.rb', line 357

def message_har(id)
  @client.get("/OTHER/core/other/messageHar/?id=#{id}")
end

#messages(baseurl, start, count) ⇒ Object 



41
42
43
 
# File 'lib/zap/v2apis/core.rb', line 41

def messages(baseurl, start, count)
  @client.get("/JSON/core/view/messages/?baseurl=#{baseurl}&start=#{start}&count=#{count}")
end

#messages_by_id(ids) ⇒ Object 



45
46
47
 
# File 'lib/zap/v2apis/core.rb', line 45

def messages_by_id(ids)
  @client.get("/JSON/core/view/messagesById/?ids=#{ids}")
end

#messages_har(baseurl, start, count) ⇒ Object 



361
362
363
 
# File 'lib/zap/v2apis/core.rb', line 361

def messages_har(baseurl, start, count)
  @client.get("/OTHER/core/other/messagesHar/?baseurl=#{baseurl}&start=#{start}&count=#{count}")
end

#messages_har_by_id(ids) ⇒ Object 



365
366
367
 
# File 'lib/zap/v2apis/core.rb', line 365

def messages_har_by_id(ids)
  @client.get("/OTHER/core/other/messagesHarById/?ids=#{ids}")
end

#mode ⇒ Object 



49
50
51
 
# File 'lib/zap/v2apis/core.rb', line 49

def mode
  @client.get('/JSON/core/view/mode/')
end

#modify_proxy_chain_excluded_domain(idx, value, isregex, isenabled) ⇒ Object 



225
226
227
 
# File 'lib/zap/v2apis/core.rb', line 225

def modify_proxy_chain_excluded_domain(idx, value, isregex, isenabled)
  @client.get("/JSON/core/action/modifyProxyChainExcludedDomain/?idx=#{idx}&value=#{value}&isRegex=#{isregex}&isEnabled=#{isenabled}")
end

#new_session(name, overwrite) ⇒ Object 



229
230
231
 
# File 'lib/zap/v2apis/core.rb', line 229

def new_session(name, overwrite)
  @client.get("/JSON/core/action/newSession/?name=#{name}&overwrite=#{overwrite}")
end

#number_of_alerts(baseurl, riskid) ⇒ Object 



53
54
55
 
# File 'lib/zap/v2apis/core.rb', line 53

def number_of_alerts(baseurl, riskid)
  @client.get("/JSON/core/view/numberOfAlerts/?baseurl=#{baseurl}&riskid=#{riskid}")
end

#number_of_messages(baseurl) ⇒ Object 



57
58
59
 
# File 'lib/zap/v2apis/core.rb', line 57

def number_of_messages(baseurl)
  @client.get("/JSON/core/view/numberOfMessages/?baseurl=#{baseurl}")
end

#option_alert_overrides_file_path ⇒ Object 



61
62
63
 
# File 'lib/zap/v2apis/core.rb', line 61

def option_alert_overrides_file_path
  @client.get('/JSON/core/view/optionAlertOverridesFilePath/')
end

#option_default_user_agent ⇒ Object 



65
66
67
 
# File 'lib/zap/v2apis/core.rb', line 65

def option_default_user_agent
  @client.get('/JSON/core/view/optionDefaultUserAgent/')
end

#option_dns_ttl_successful_queries ⇒ Object 



69
70
71
 
# File 'lib/zap/v2apis/core.rb', line 69

def option_dns_ttl_successful_queries
  @client.get('/JSON/core/view/optionDnsTtlSuccessfulQueries/')
end

#option_http_state ⇒ Object 



73
74
75
 
# File 'lib/zap/v2apis/core.rb', line 73

def option_http_state
  @client.get('/JSON/core/view/optionHttpState/')
end

#option_http_state_enabled ⇒ Object 



77
78
79
 
# File 'lib/zap/v2apis/core.rb', line 77

def option_http_state_enabled
  @client.get('/JSON/core/view/optionHttpStateEnabled/')
end

#option_maximum_alert_instances ⇒ Object 



81
82
83
 
# File 'lib/zap/v2apis/core.rb', line 81

def option_maximum_alert_instances
  @client.get('/JSON/core/view/optionMaximumAlertInstances/')
end

#option_merge_related_alerts ⇒ Object 



85
86
87
 
# File 'lib/zap/v2apis/core.rb', line 85

def option_merge_related_alerts
  @client.get('/JSON/core/view/optionMergeRelatedAlerts/')
end

#option_proxy_chain_name ⇒ Object 



89
90
91
 
# File 'lib/zap/v2apis/core.rb', line 89

def option_proxy_chain_name
  @client.get('/JSON/core/view/optionProxyChainName/')
end

#option_proxy_chain_password ⇒ Object 



93
94
95
 
# File 'lib/zap/v2apis/core.rb', line 93

def option_proxy_chain_password
  @client.get('/JSON/core/view/optionProxyChainPassword/')
end

#option_proxy_chain_port ⇒ Object 



97
98
99
 
# File 'lib/zap/v2apis/core.rb', line 97

def option_proxy_chain_port
  @client.get('/JSON/core/view/optionProxyChainPort/')
end

#option_proxy_chain_prompt ⇒ Object 



101
102
103
 
# File 'lib/zap/v2apis/core.rb', line 101

def option_proxy_chain_prompt
  @client.get('/JSON/core/view/optionProxyChainPrompt/')
end

#option_proxy_chain_realm ⇒ Object 



105
106
107
 
# File 'lib/zap/v2apis/core.rb', line 105

def option_proxy_chain_realm
  @client.get('/JSON/core/view/optionProxyChainRealm/')
end

#option_proxy_chain_skip_name ⇒ Object 



109
110
111
 
# File 'lib/zap/v2apis/core.rb', line 109

def option_proxy_chain_skip_name
  @client.get('/JSON/core/view/optionProxyChainSkipName/')
end

#option_proxy_chain_user_name ⇒ Object 



113
114
115
 
# File 'lib/zap/v2apis/core.rb', line 113

def option_proxy_chain_user_name
  @client.get('/JSON/core/view/optionProxyChainUserName/')
end

#option_proxy_excluded_domains ⇒ Object 



117
118
119
 
# File 'lib/zap/v2apis/core.rb', line 117

def option_proxy_excluded_domains
  @client.get('/JSON/core/view/optionProxyExcludedDomains/')
end

#option_proxy_excluded_domains_enabled ⇒ Object 



121
122
123
 
# File 'lib/zap/v2apis/core.rb', line 121

def option_proxy_excluded_domains_enabled
  @client.get('/JSON/core/view/optionProxyExcludedDomainsEnabled/')
end

#option_single_cookie_request_header ⇒ Object 



125
126
127
 
# File 'lib/zap/v2apis/core.rb', line 125

def option_single_cookie_request_header
  @client.get('/JSON/core/view/optionSingleCookieRequestHeader/')
end

#option_timeout_in_secs ⇒ Object 



129
130
131
 
# File 'lib/zap/v2apis/core.rb', line 129

def option_timeout_in_secs
  @client.get('/JSON/core/view/optionTimeoutInSecs/')
end

#option_use_proxy_chain ⇒ Object 



133
134
135
 
# File 'lib/zap/v2apis/core.rb', line 133

def option_use_proxy_chain
  @client.get('/JSON/core/view/optionUseProxyChain/')
end

#option_use_proxy_chain_auth ⇒ Object 



137
138
139
 
# File 'lib/zap/v2apis/core.rb', line 137

def option_use_proxy_chain_auth
  @client.get('/JSON/core/view/optionUseProxyChainAuth/')
end

#option_use_socks_proxy ⇒ Object 



141
142
143
 
# File 'lib/zap/v2apis/core.rb', line 141

def option_use_socks_proxy
  @client.get('/JSON/core/view/optionUseSocksProxy/')
end

#proxy_chain_excluded_domains ⇒ Object 



145
146
147
 
# File 'lib/zap/v2apis/core.rb', line 145

def proxy_chain_excluded_domains
  @client.get('/JSON/core/view/proxyChainExcludedDomains/')
end

#proxy_pac ⇒ Object 



369
370
371
 
# File 'lib/zap/v2apis/core.rb', line 369

def proxy_pac
  @client.get('/OTHER/core/other/proxy.pac/')
end

#remove_proxy_chain_excluded_domain(idx) ⇒ Object 



233
234
235
 
# File 'lib/zap/v2apis/core.rb', line 233

def remove_proxy_chain_excluded_domain(idx)
  @client.get("/JSON/core/action/removeProxyChainExcludedDomain/?idx=#{idx}")
end

#rootcert ⇒ Object 



373
374
375
 
# File 'lib/zap/v2apis/core.rb', line 373

def rootcert
  @client.get('/OTHER/core/other/rootcert/')
end

#run_garbage_collection ⇒ Object 



237
238
239
 
# File 'lib/zap/v2apis/core.rb', line 237

def run_garbage_collection
  @client.get('/JSON/core/action/runGarbageCollection/')
end

#save_session(name, overwrite) ⇒ Object 



241
242
243
 
# File 'lib/zap/v2apis/core.rb', line 241

def save_session(name, overwrite)
  @client.get("/JSON/core/action/saveSession/?name=#{name}&overwrite=#{overwrite}")
end

#send_har_request(request, followredirects) ⇒ Object 



377
378
379
 
# File 'lib/zap/v2apis/core.rb', line 377

def send_har_request(request, followredirects)
  @client.get("/OTHER/core/other/sendHarRequest/?request=#{request}&followRedirects=#{followredirects}")
end

#send_request(request, followredirects) ⇒ Object 



245
246
247
 
# File 'lib/zap/v2apis/core.rb', line 245

def send_request(request, followredirects)
  @client.get("/JSON/core/action/sendRequest/?request=#{request}&followRedirects=#{followredirects}")
end

#session_location ⇒ Object 



149
150
151
 
# File 'lib/zap/v2apis/core.rb', line 149

def session_location
  @client.get('/JSON/core/view/sessionLocation/')
end

#set_home_directory(dir) ⇒ Object 



249
250
251
 
# File 'lib/zap/v2apis/core.rb', line 249

def set_home_directory(dir)
  @client.get("/JSON/core/action/setHomeDirectory/?dir=#{dir}")
end

#set_mode(mode) ⇒ Object 



253
254
255
 
# File 'lib/zap/v2apis/core.rb', line 253

def set_mode(mode)
  @client.get("/JSON/core/action/setMode/?mode=#{mode}")
end

#set_option_alert_overrides_file_path(filepath) ⇒ Object 



257
258
259
 
# File 'lib/zap/v2apis/core.rb', line 257

def set_option_alert_overrides_file_path(filepath)
  @client.get("/JSON/core/action/setOptionAlertOverridesFilePath/?filePath=#{filepath}")
end

#set_option_default_user_agent(string) ⇒ Object 



261
262
263
 
# File 'lib/zap/v2apis/core.rb', line 261

def set_option_default_user_agent(string)
  @client.get("/JSON/core/action/setOptionDefaultUserAgent/?String=#{string}")
end

#set_option_dns_ttl_successful_queries(integer) ⇒ Object 



265
266
267
 
# File 'lib/zap/v2apis/core.rb', line 265

def set_option_dns_ttl_successful_queries(integer)
  @client.get("/JSON/core/action/setOptionDnsTtlSuccessfulQueries/?Integer=#{integer}")
end

#set_option_http_state_enabled(boolean) ⇒ Object 



269
270
271
 
# File 'lib/zap/v2apis/core.rb', line 269

def set_option_http_state_enabled(boolean)
  @client.get("/JSON/core/action/setOptionHttpStateEnabled/?Boolean=#{boolean}")
end

#set_option_maximum_alert_instances(numberofinstances) ⇒ Object 



273
274
275
 
# File 'lib/zap/v2apis/core.rb', line 273

def set_option_maximum_alert_instances(numberofinstances)
  @client.get("/JSON/core/action/setOptionMaximumAlertInstances/?numberOfInstances=#{numberofinstances}")
end

#set_option_merge_related_alerts(enabled) ⇒ Object 



277
278
279
 
# File 'lib/zap/v2apis/core.rb', line 277

def set_option_merge_related_alerts(enabled)
  @client.get("/JSON/core/action/setOptionMergeRelatedAlerts/?enabled=#{enabled}")
end

#set_option_proxy_chain_name(string) ⇒ Object 



281
282
283
 
# File 'lib/zap/v2apis/core.rb', line 281

def set_option_proxy_chain_name(string)
  @client.get("/JSON/core/action/setOptionProxyChainName/?String=#{string}")
end

#set_option_proxy_chain_password(string) ⇒ Object 



285
286
287
 
# File 'lib/zap/v2apis/core.rb', line 285

def set_option_proxy_chain_password(string)
  @client.get("/JSON/core/action/setOptionProxyChainPassword/?String=#{string}")
end

#set_option_proxy_chain_port(integer) ⇒ Object 



289
290
291
 
# File 'lib/zap/v2apis/core.rb', line 289

def set_option_proxy_chain_port(integer)
  @client.get("/JSON/core/action/setOptionProxyChainPort/?Integer=#{integer}")
end

#set_option_proxy_chain_prompt(boolean) ⇒ Object 



293
294
295
 
# File 'lib/zap/v2apis/core.rb', line 293

def set_option_proxy_chain_prompt(boolean)
  @client.get("/JSON/core/action/setOptionProxyChainPrompt/?Boolean=#{boolean}")
end

#set_option_proxy_chain_realm(string) ⇒ Object 



297
298
299
 
# File 'lib/zap/v2apis/core.rb', line 297

def set_option_proxy_chain_realm(string)
  @client.get("/JSON/core/action/setOptionProxyChainRealm/?String=#{string}")
end

#set_option_proxy_chain_skip_name(string) ⇒ Object 



301
302
303
 
# File 'lib/zap/v2apis/core.rb', line 301

def set_option_proxy_chain_skip_name(string)
  @client.get("/JSON/core/action/setOptionProxyChainSkipName/?String=#{string}")
end

#set_option_proxy_chain_user_name(string) ⇒ Object 



305
306
307
 
# File 'lib/zap/v2apis/core.rb', line 305

def set_option_proxy_chain_user_name(string)
  @client.get("/JSON/core/action/setOptionProxyChainUserName/?String=#{string}")
end

#set_option_single_cookie_request_header(boolean) ⇒ Object 



309
310
311
 
# File 'lib/zap/v2apis/core.rb', line 309

def set_option_single_cookie_request_header(boolean)
  @client.get("/JSON/core/action/setOptionSingleCookieRequestHeader/?Boolean=#{boolean}")
end

#set_option_timeout_in_secs(integer) ⇒ Object 



313
314
315
 
# File 'lib/zap/v2apis/core.rb', line 313

def set_option_timeout_in_secs(integer)
  @client.get("/JSON/core/action/setOptionTimeoutInSecs/?Integer=#{integer}")
end

#set_option_use_proxy_chain(boolean) ⇒ Object 



317
318
319
 
# File 'lib/zap/v2apis/core.rb', line 317

def set_option_use_proxy_chain(boolean)
  @client.get("/JSON/core/action/setOptionUseProxyChain/?Boolean=#{boolean}")
end

#set_option_use_proxy_chain_auth(boolean) ⇒ Object 



321
322
323
 
# File 'lib/zap/v2apis/core.rb', line 321

def set_option_use_proxy_chain_auth(boolean)
  @client.get("/JSON/core/action/setOptionUseProxyChainAuth/?Boolean=#{boolean}")
end

#set_option_use_socks_proxy(boolean) ⇒ Object 



325
326
327
 
# File 'lib/zap/v2apis/core.rb', line 325

def set_option_use_socks_proxy(boolean)
  @client.get("/JSON/core/action/setOptionUseSocksProxy/?Boolean=#{boolean}")
end

#setproxy(proxy) ⇒ Object 



381
382
383
 
# File 'lib/zap/v2apis/core.rb', line 381

def setproxy(proxy)
  @client.get("/OTHER/core/other/setproxy/?proxy=#{proxy}")
end

#shutdown ⇒ Object 



329
330
331
 
# File 'lib/zap/v2apis/core.rb', line 329

def shutdown
  @client.get('/JSON/core/action/shutdown/')
end

#sites ⇒ Object 



153
154
155
 
# File 'lib/zap/v2apis/core.rb', line 153

def sites
  @client.get('/JSON/core/view/sites/')
end

#snapshot_session(name, overwrite) ⇒ Object 



333
334
335
 
# File 'lib/zap/v2apis/core.rb', line 333

def snapshot_session(name, overwrite)
  @client.get("/JSON/core/action/snapshotSession/?name=#{name}&overwrite=#{overwrite}")
end

#urls(baseurl) ⇒ Object 



157
158
159
 
# File 'lib/zap/v2apis/core.rb', line 157

def urls(baseurl)
  @client.get("/JSON/core/view/urls/?baseurl=#{baseurl}")
end

#version ⇒ Object 



161
162
163
 
# File 'lib/zap/v2apis/core.rb', line 161

def version
  @client.get('/JSON/core/view/version/')
end

#xmlreport ⇒ Object 



385
386
387
 
# File 'lib/zap/v2apis/core.rb', line 385

def xmlreport
  @client.get('/OTHER/core/other/xmlreport/')
end

#zap_home_path ⇒ Object 



165
166
167
 
# File 'lib/zap/v2apis/core.rb', line 165

def zap_home_path
  @client.get('/JSON/core/view/zapHomePath/')
end