Class: CloudmersiveSecurityApiClient::ContentThreatDetectionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentThreatDetectionApi

Returns a new instance of ContentThreatDetectionApi.



19
20
21
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#content_threat_detection_automatic_threat_detection_string(value, opts = {}) ⇒ StringAutomaticThreatDetection

Automatically detect threats in an input string Auto-detects a wide range of threat types in input string, including Cross-Site Scripting (XSS), SQL Injection (SQLI), XML External Entitites (XXE), Server-side Request Forgeries (SSRF), and JSON Insecure Deserialization (JID).

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 27

def content_threat_detection_automatic_threat_detection_string(value, opts = {})
  data, _status_code, _headers = content_threat_detection_automatic_threat_detection_string_with_http_info(value, opts)
  data
end

#content_threat_detection_automatic_threat_detection_string_with_http_info(value, opts = {}) ⇒ Array<(StringAutomaticThreatDetection, Fixnum, Hash)>

Automatically detect threats in an input string Auto-detects a wide range of threat types in input string, including Cross-Site Scripting (XSS), SQL Injection (SQLI), XML External Entitites (XXE), Server-side Request Forgeries (SSRF), and JSON Insecure Deserialization (JID).

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 37

def content_threat_detection_automatic_threat_detection_string_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentThreatDetectionApi.content_threat_detection_automatic_threat_detection_string ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ContentThreatDetectionApi.content_threat_detection_automatic_threat_detection_string"
  end
  # resource path
  local_var_path = '/security/threat-detection/content/automatic/detect/string'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringAutomaticThreatDetection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentThreatDetectionApi#content_threat_detection_automatic_threat_detection_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_threat_detection_check_sql_injection_string(value, opts = {}) ⇒ StringSqlInjectionDetectionResult

Check text input for SQL Injection (SQLI) attacks Detects SQL Injection (SQLI) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 81

def content_threat_detection_check_sql_injection_string(value, opts = {})
  data, _status_code, _headers = content_threat_detection_check_sql_injection_string_with_http_info(value, opts)
  data
end

#content_threat_detection_check_sql_injection_string_with_http_info(value, opts = {}) ⇒ Array<(StringSqlInjectionDetectionResult, Fixnum, Hash)>

Check text input for SQL Injection (SQLI) attacks Detects SQL Injection (SQLI) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 91

def content_threat_detection_check_sql_injection_string_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentThreatDetectionApi.content_threat_detection_check_sql_injection_string ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ContentThreatDetectionApi.content_threat_detection_check_sql_injection_string"
  end
  # resource path
  local_var_path = '/security/threat-detection/content/sql-injection/detect/string'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringSqlInjectionDetectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentThreatDetectionApi#content_threat_detection_check_sql_injection_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_threat_detection_check_xxe(value, opts = {}) ⇒ StringXxeDetectionResult

Protect text input from XML External Entity (XXE) attacks Detects XXE (XML External Entity) attacks from XML text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 135

def content_threat_detection_check_xxe(value, opts = {})
  data, _status_code, _headers = content_threat_detection_check_xxe_with_http_info(value, opts)
  data
end

#content_threat_detection_check_xxe_with_http_info(value, opts = {}) ⇒ Array<(StringXxeDetectionResult, Fixnum, Hash)>

Protect text input from XML External Entity (XXE) attacks Detects XXE (XML External Entity) attacks from XML text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StringXxeDetectionResult, Fixnum, Hash)>) —

    StringXxeDetectionResult data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 145

def content_threat_detection_check_xxe_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentThreatDetectionApi.content_threat_detection_check_xxe ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ContentThreatDetectionApi.content_threat_detection_check_xxe"
  end
  # resource path
  local_var_path = '/security/threat-detection/content/xxe/detect/xml/string'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringXxeDetectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentThreatDetectionApi#content_threat_detection_check_xxe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_threat_detection_detect_insecure_deserialization_json_string(value, opts = {}) ⇒ StringInsecureDeserializationJsonDetection

Detect Insecure Deserialization JSON (JID) attacks in a string Detects Insecure Deserialization JSON (JID) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 189

def content_threat_detection_detect_insecure_deserialization_json_string(value, opts = {})
  data, _status_code, _headers = content_threat_detection_detect_insecure_deserialization_json_string_with_http_info(value, opts)
  data
end

#content_threat_detection_detect_insecure_deserialization_json_string_with_http_info(value, opts = {}) ⇒ Array<(StringInsecureDeserializationJsonDetection, Fixnum, Hash)>

Detect Insecure Deserialization JSON (JID) attacks in a string Detects Insecure Deserialization JSON (JID) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 199

def content_threat_detection_detect_insecure_deserialization_json_string_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentThreatDetectionApi.content_threat_detection_detect_insecure_deserialization_json_string ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ContentThreatDetectionApi.content_threat_detection_detect_insecure_deserialization_json_string"
  end
  # resource path
  local_var_path = '/security/threat-detection/content/insecure-deserialization/json/detect/string'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringInsecureDeserializationJsonDetection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentThreatDetectionApi#content_threat_detection_detect_insecure_deserialization_json_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_threat_detection_protect_xss(value, opts = {}) ⇒ StringXssProtectionResult

Protect text input from Cross-Site-Scripting (XSS) attacks through normalization Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 243

def content_threat_detection_protect_xss(value, opts = {})
  data, _status_code, _headers = content_threat_detection_protect_xss_with_http_info(value, opts)
  data
end

#content_threat_detection_protect_xss_with_http_info(value, opts = {}) ⇒ Array<(StringXssProtectionResult, Fixnum, Hash)>

Protect text input from Cross-Site-Scripting (XSS) attacks through normalization Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StringXssProtectionResult, Fixnum, Hash)>) —

    StringXssProtectionResult data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cloudmersive-security-api-client/api/content_threat_detection_api.rb', line 253

def content_threat_detection_protect_xss_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentThreatDetectionApi.content_threat_detection_protect_xss ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling ContentThreatDetectionApi.content_threat_detection_protect_xss"
  end
  # resource path
  local_var_path = '/security/threat-detection/content/xss/detect/string'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringXssProtectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentThreatDetectionApi#content_threat_detection_protect_xss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end