zap_api 0.0.2

The Rust implementation to access the OWASP ZAP API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

/* 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.
 */

use super::ZapApiError;
use super::ZapService;
use serde_json::Value;
use std::collections::HashMap;

/**
 * This file was automatically generated.
 */
/**
 * Returns True if ZAP will break on both requests and responses
*/
pub fn is_break_all(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "view", "isBreakAll", params)
}

/**
 * Returns True if ZAP will break on requests
*/
pub fn is_break_request(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "view", "isBreakRequest", params)
}

/**
 * Returns True if ZAP will break on responses
*/
pub fn is_break_response(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "view", "isBreakResponse", params)
}

/**
 * Returns the HTTP message currently intercepted (if any)
*/
pub fn http_message(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "view", "httpMessage", params)
}

/**
 * Controls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning break off). Scope is not currently used.
*/
pub fn brk(
    service: &ZapService,
    typ: String,
    state: String,
    scope: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("type".to_string(), typ);
    params.insert("state".to_string(), state);
    params.insert("scope".to_string(), scope);
    super::call(service, "break", "action", "break", params)
}

/**
 * Overwrites the currently intercepted message with the data provided
*/
pub fn set_http_message(
    service: &ZapService,
    httpheader: String,
    httpbody: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("httpHeader".to_string(), httpheader);
    params.insert("httpBody".to_string(), httpbody);
    super::call(service, "break", "action", "setHttpMessage", params)
}

/**
 * Submits the currently intercepted message and unsets the global request/response break points
*/
pub fn cont(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "action", "continue", params)
}

/**
 * Submits the currently intercepted message, the next request or response will automatically be intercepted
*/
pub fn step(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "action", "step", params)
}

/**
 * Drops the currently intercepted message
*/
pub fn drop(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "break", "action", "drop", params)
}

/**
 * Adds a custom HTTP breakpont. The string is the string to match. Location may be one of: url, request_header, request_body, response_header or response_body. Match may be: contains or regex. Inverse (match) may be true or false. Lastly, ignorecase (when matching the string) may be true or false.  
*/
pub fn add_http_breakpoint(
    service: &ZapService,
    string: String,
    location: String,
    mtch: String,
    inverse: String,
    ignorecase: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("string".to_string(), string);
    params.insert("location".to_string(), location);
    params.insert("match".to_string(), mtch);
    params.insert("inverse".to_string(), inverse);
    params.insert("ignorecase".to_string(), ignorecase);
    super::call(service, "break", "action", "addHttpBreakpoint", params)
}

/**
 * Removes the specified break point
*/
pub fn remove_http_breakpoint(
    service: &ZapService,
    string: String,
    location: String,
    mtch: String,
    inverse: String,
    ignorecase: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("string".to_string(), string);
    params.insert("location".to_string(), location);
    params.insert("match".to_string(), mtch);
    params.insert("inverse".to_string(), inverse);
    params.insert("ignorecase".to_string(), ignorecase);
    super::call(service, "break", "action", "removeHttpBreakpoint", params)
}