Class: ZAPv2::Spider

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Spider

Returns a new instance of Spider.



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

def initialize(client)
  @client = client
end

Instance Method Details

#add_domain_always_in_scope(value, is_regex, is_enabled) ⇒ Object 



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

def add_domain_always_in_scope(value, is_regex, is_enabled)
  @client.get("/JSON/spider/action/addDomainAlwaysInScope/?value=#{value}&isRegex=#{is_regex}&isEnabled=#{is_enabled}")
end

#added_nodes(scan_id) ⇒ Object 



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

def added_nodes(scan_id)
  @client.get("/JSON/spider/view/addedNodes/?scanId=#{scan_id}")
end

#all_urls ⇒ Object 



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

def all_urls
  @client.get('/JSON/spider/view/allUrls/')
end

#clear_excluded_from_scan ⇒ Object 



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

def clear_excluded_from_scan
  @client.get('/JSON/spider/action/clearExcludedFromScan/')
end

#disable_all_domains_always_in_scope ⇒ Object 



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

def disable_all_domains_always_in_scope
  @client.get('/JSON/spider/action/disableAllDomainsAlwaysInScope/')
end

#domains_always_in_scope ⇒ Object 



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

def domains_always_in_scope
  @client.get('/JSON/spider/view/domainsAlwaysInScope/')
end

#enable_all_domains_always_in_scope ⇒ Object 



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

def enable_all_domains_always_in_scope
  @client.get('/JSON/spider/action/enableAllDomainsAlwaysInScope/')
end

#exclude_from_scan(regex) ⇒ Object 



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

def exclude_from_scan(regex)
  @client.get("/JSON/spider/action/excludeFromScan/?regex=#{regex}")
end

#excluded_from_scan ⇒ Object 



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

def excluded_from_scan
  @client.get('/JSON/spider/view/excludedFromScan/')
end

#full_results(scan_id) ⇒ Object 



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

def full_results(scan_id)
  @client.get("/JSON/spider/view/fullResults/?scanId=#{scan_id}")
end

#modify_domain_always_in_scope(index, value, is_regex, is_enabled) ⇒ Object 



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

def modify_domain_always_in_scope(index, value, is_regex, is_enabled)
  @client.get("/JSON/spider/action/modifyDomainAlwaysInScope/?idx=#{index}&value=#{value}&isRegex=#{is_regex}&isEnabled=#{is_enabled}")
end

#option_accept_cookies ⇒ Object 



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

def option_accept_cookies
  @client.get('/JSON/spider/view/optionAcceptCookies/')
end

#option_domains_always_in_scope ⇒ Object 



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

def option_domains_always_in_scope
  @client.get('/JSON/spider/view/optionDomainsAlwaysInScope/')
end

#option_domains_always_in_scope_enabled ⇒ Object 



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

def option_domains_always_in_scope_enabled
  @client.get('/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/')
end

#option_handle_odata_parameters_visited ⇒ Object 



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

def option_handle_odata_parameters_visited
  @client.get('/JSON/spider/view/optionHandleODataParametersVisited/')
end

#option_handle_parameters ⇒ Object 



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

def option_handle_parameters
  @client.get('/JSON/spider/view/optionHandleParameters/')
end

#option_max_children ⇒ Object 



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

def option_max_children
  @client.get('/JSON/spider/view/optionMaxChildren/')
end

#option_max_depth ⇒ Object 



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

def option_max_depth
  @client.get('/JSON/spider/view/optionMaxDepth/')
end

#option_max_duration ⇒ Object 



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

def option_max_duration
  @client.get('/JSON/spider/view/optionMaxDuration/')
end

#option_max_parse_size_bytes ⇒ Object 



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

def option_max_parse_size_bytes
  @client.get('/JSON/spider/view/optionMaxParseSizeBytes/')
end

#option_max_scans_in_ui ⇒ Object 



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

def option_max_scans_in_ui
  @client.get('/JSON/spider/view/optionMaxScansInUI/')
end

#option_parse_comments ⇒ Object 



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

def option_parse_comments
  @client.get('/JSON/spider/view/optionParseComments/')
end

#option_parse_ds_store ⇒ Object 



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

def option_parse_ds_store
  @client.get('/JSON/spider/view/optionParseDsStore/')
end

#option_parse_git ⇒ Object 



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

def option_parse_git
  @client.get('/JSON/spider/view/optionParseGit/')
end

#option_parse_robots_txt ⇒ Object 



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

def option_parse_robots_txt
  @client.get('/JSON/spider/view/optionParseRobotsTxt/')
end

#option_parse_sitemap_xml ⇒ Object 



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

def option_parse_sitemap_xml
  @client.get('/JSON/spider/view/optionParseSitemapXml/')
end

#option_parse_svn_entries ⇒ Object 



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

def option_parse_svn_entries
  @client.get('/JSON/spider/view/optionParseSVNEntries/')
end

#option_post_form ⇒ Object 



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

def option_post_form
  @client.get('/JSON/spider/view/optionPostForm/')
end

#option_process_form ⇒ Object 



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

def option_process_form
  @client.get('/JSON/spider/view/optionProcessForm/')
end

#option_request_wait_time ⇒ Object 



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

def option_request_wait_time
  @client.get('/JSON/spider/view/optionRequestWaitTime/')
end

#option_send_referer_header ⇒ Object 



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

def option_send_referer_header
  @client.get('/JSON/spider/view/optionSendRefererHeader/')
end

#option_show_advanced_dialog ⇒ Object 



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

def option_show_advanced_dialog
  @client.get('/JSON/spider/view/optionShowAdvancedDialog/')
end

#option_skip_url_string ⇒ Object 



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

def option_skip_url_string
  @client.get('/JSON/spider/view/optionSkipURLString/')
end

#option_thread_count ⇒ Object 



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

def option_thread_count
  @client.get('/JSON/spider/view/optionThreadCount/')
end

#option_user_agent ⇒ Object 



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

def option_user_agent
  @client.get('/JSON/spider/view/optionUserAgent/')
end

#pause(scan_id) ⇒ Object 



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

def pause(scan_id)
  @client.get("/JSON/spider/action/pause/?scanId=#{scan_id}")
end

#pause_all_scans ⇒ Object 



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

def pause_all_scans
  @client.get('/JSON/spider/action/pauseAllScans/')
end

#remove_all_scans ⇒ Object 



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

def remove_all_scans
  @client.get('/JSON/spider/action/removeAllScans/')
end

#remove_domain_always_in_scope(index) ⇒ Object 



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

def remove_domain_always_in_scope(index)
  @client.get("/JSON/spider/action/removeDomainAlwaysInScope/?idx=#{index}")
end

#remove_scan(scan_id) ⇒ Object 



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

def remove_scan(scan_id)
  @client.get("/JSON/spider/action/removeScan/?scanId=#{scan_id}")
end

#results(scan_id) ⇒ Object 



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

def results(scan_id)
  @client.get("/JSON/spider/view/results/?scanId=#{scan_id}")
end

#resume(scan_id) ⇒ Object 



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

def resume(scan_id)
  @client.get("/JSON/spider/action/resume/?scanId=#{scan_id}")
end

#resume_all_scans ⇒ Object 



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

def resume_all_scans
  @client.get('/JSON/spider/action/resumeAllScans/')
end

#scan(url, max_children, recurse, context_name, subtree_only) ⇒ Object 



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

def scan(url, max_children, recurse, context_name, subtree_only)
  @client.get("/JSON/spider/action/scan/?url=#{url}&maxChildren=#{max_children}&recurse=#{recurse}&contextName=#{context_name}&subtreeOnly=#{subtree_only}")
end

#scan_as_user(context_id, user_id, url, max_children, recurse, subtree_only) ⇒ Object 



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

def scan_as_user(context_id, user_id, url, max_children, recurse, subtree_only)
  @client.get("/JSON/spider/action/scanAsUser/?contextId=#{context_id}&userId=#{user_id}&url=#{url}&maxChildren=#{max_children}&recurse=#{recurse}&subtreeOnly=#{subtree_only}")
end

#scans ⇒ Object 



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

def scans
  @client.get('/JSON/spider/view/scans/')
end

#set_option_accept_cookies(boolean) ⇒ Object 



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

def set_option_accept_cookies(boolean)
  @client.get("/JSON/spider/action/setOptionAcceptCookies/?Boolean=#{boolean}")
end

#set_option_handle_odata_parameters_visited(boolean) ⇒ Object 



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

def set_option_handle_odata_parameters_visited(boolean)
  @client.get("/JSON/spider/action/setOptionHandleODataParametersVisited/?Boolean=#{boolean}")
end

#set_option_handle_parameters(string) ⇒ Object 



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

def set_option_handle_parameters(string)
  @client.get("/JSON/spider/action/setOptionHandleParameters/?String=#{string}")
end

#set_option_max_children(integer) ⇒ Object 



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

def set_option_max_children(integer)
  @client.get("/JSON/spider/action/setOptionMaxChildren/?Integer=#{integer}")
end

#set_option_max_depth(integer) ⇒ Object 



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

def set_option_max_depth(integer)
  @client.get("/JSON/spider/action/setOptionMaxDepth/?Integer=#{integer}")
end

#set_option_max_duration(integer) ⇒ Object 



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

def set_option_max_duration(integer)
  @client.get("/JSON/spider/action/setOptionMaxDuration/?Integer=#{integer}")
end

#set_option_max_parse_size_bytes(integer) ⇒ Object 



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

def set_option_max_parse_size_bytes(integer)
  @client.get("/JSON/spider/action/setOptionMaxParseSizeBytes/?Integer=#{integer}")
end

#set_option_max_scans_in_ui(integer) ⇒ Object 



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

def set_option_max_scans_in_ui(integer)
  @client.get("/JSON/spider/action/setOptionMaxScansInUI/?Integer=#{integer}")
end

#set_option_parse_comments(boolean) ⇒ Object 



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

def set_option_parse_comments(boolean)
  @client.get("/JSON/spider/action/setOptionParseComments/?Boolean=#{boolean}")
end

#set_option_parse_ds_store(boolean) ⇒ Object 



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

def set_option_parse_ds_store(boolean)
  @client.get("/JSON/spider/action/setOptionParseDsStore/?Boolean=#{boolean}")
end

#set_option_parse_git(boolean) ⇒ Object 



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

def set_option_parse_git(boolean)
  @client.get("/JSON/spider/action/setOptionParseGit/?Boolean=#{boolean}")
end

#set_option_parse_robots_txt(boolean) ⇒ Object 



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

def set_option_parse_robots_txt(boolean)
  @client.get("/JSON/spider/action/setOptionParseRobotsTxt/?Boolean=#{boolean}")
end

#set_option_parse_sitemap_xml(boolean) ⇒ Object 



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

def set_option_parse_sitemap_xml(boolean)
  @client.get("/JSON/spider/action/setOptionParseSitemapXml/?Boolean=#{boolean}")
end

#set_option_parse_svn_entries(boolean) ⇒ Object 



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

def set_option_parse_svn_entries(boolean)
  @client.get("/JSON/spider/action/setOptionParseSVNEntries/?Boolean=#{boolean}")
end

#set_option_post_form(boolean) ⇒ Object 



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

def set_option_post_form(boolean)
  @client.get("/JSON/spider/action/setOptionPostForm/?Boolean=#{boolean}")
end

#set_option_process_form(boolean) ⇒ Object 



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

def set_option_process_form(boolean)
  @client.get("/JSON/spider/action/setOptionProcessForm/?Boolean=#{boolean}")
end

#set_option_request_wait_time(integer) ⇒ Object 



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

def set_option_request_wait_time(integer)
  @client.get("/JSON/spider/action/setOptionRequestWaitTime/?Integer=#{integer}")
end

#set_option_send_referer_header(boolean) ⇒ Object 



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

def set_option_send_referer_header(boolean)
  @client.get("/JSON/spider/action/setOptionSendRefererHeader/?Boolean=#{boolean}")
end

#set_option_show_advanced_dialog(boolean) ⇒ Object 



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

def set_option_show_advanced_dialog(boolean)
  @client.get("/JSON/spider/action/setOptionShowAdvancedDialog/?Boolean=#{boolean}")
end

#set_option_skip_url_string(string) ⇒ Object 



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

def set_option_skip_url_string(string)
  @client.get("/JSON/spider/action/setOptionSkipURLString/?String=#{string}")
end

#set_option_thread_count(integer) ⇒ Object 



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

def set_option_thread_count(integer)
  @client.get("/JSON/spider/action/setOptionThreadCount/?Integer=#{integer}")
end

#set_option_user_agent(string) ⇒ Object 



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

def set_option_user_agent(string)
  @client.get("/JSON/spider/action/setOptionUserAgent/?String=#{string}")
end

#status(scan_id) ⇒ Object 



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

def status(scan_id)
  @client.get("/JSON/spider/view/status/?scanId=#{scan_id}")
end

#stop(scan_id) ⇒ Object 



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

def stop(scan_id)
  @client.get("/JSON/spider/action/stop/?scanId=#{scan_id}")
end

#stop_all_scans ⇒ Object 



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

def stop_all_scans
  @client.get('/JSON/spider/action/stopAllScans/')
end