cloudmersive-validate-api-client 2.1.7 → 2.2.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -4
  3. data/docs/DomainApi.md +110 -0
  4. data/docs/HtmlSsrfDetectionResult.md +9 -0
  5. data/docs/IsAdminPathResponse.md +9 -0
  6. data/docs/SqlInjectionCheckBatchRequest.md +9 -0
  7. data/docs/SqlInjectionCheckBatchResponse.md +8 -0
  8. data/docs/SqlInjectionCheckRequestItem.md +8 -0
  9. data/docs/SqlInjectionDetectionResult.md +10 -0
  10. data/docs/TextInputApi.md +288 -1
  11. data/docs/UrlHtmlSsrfRequestFull.md +8 -0
  12. data/docs/UrlHtmlSsrfResponseFull.md +9 -0
  13. data/docs/XxeDetectionBatchRequest.md +8 -0
  14. data/docs/XxeDetectionBatchResponse.md +8 -0
  15. data/docs/XxeDetectionRequestItem.md +11 -0
  16. data/docs/XxeDetectionResult.md +9 -0
  17. data/lib/cloudmersive-validate-api-client.rb +12 -0
  18. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +108 -0
  19. data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +284 -2
  20. data/lib/cloudmersive-validate-api-client/models/html_ssrf_detection_result.rb +196 -0
  21. data/lib/cloudmersive-validate-api-client/models/is_admin_path_response.rb +196 -0
  22. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
  23. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
  24. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
  25. data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
  26. data/lib/cloudmersive-validate-api-client/models/url_html_ssrf_request_full.rb +186 -0
  27. data/lib/cloudmersive-validate-api-client/models/url_html_ssrf_response_full.rb +196 -0
  28. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_request.rb +188 -0
  29. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_response.rb +188 -0
  30. data/lib/cloudmersive-validate-api-client/models/xxe_detection_request_item.rb +220 -0
  31. data/lib/cloudmersive-validate-api-client/models/xxe_detection_result.rb +196 -0
  32. data/lib/cloudmersive-validate-api-client/version.rb +1 -1
  33. data/spec/api/domain_api_spec.rb +24 -0
  34. data/spec/api/text_input_api_spec.rb +65 -1
  35. data/spec/models/html_ssrf_detection_result_spec.rb +47 -0
  36. data/spec/models/is_admin_path_response_spec.rb +47 -0
  37. data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
  38. data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
  39. data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
  40. data/spec/models/sql_injection_detection_result_spec.rb +53 -0
  41. data/spec/models/url_html_ssrf_request_full_spec.rb +41 -0
  42. data/spec/models/url_html_ssrf_response_full_spec.rb +47 -0
  43. data/spec/models/xxe_detection_batch_request_spec.rb +41 -0
  44. data/spec/models/xxe_detection_batch_response_spec.rb +41 -0
  45. data/spec/models/xxe_detection_request_item_spec.rb +59 -0
  46. data/spec/models/xxe_detection_result_spec.rb +47 -0
  47. metadata +38 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4efb7c1b214896dcd9bf6aba9314f75a4d05b90b8d8f1563401ccc1aa6086657
4
- data.tar.gz: ef7cb76a16710e47a88e4b438c25fcb5d65957160ec4655587fc7f23e3c974b1
3
+ metadata.gz: bda2d29aed6f694cefad741670033ee4c4413bca97f808db708b6d96e7bfc623
4
+ data.tar.gz: e98072e83bfa227d8fdc5eda4d050297eaef91fa387b03229051c9b6f66c74bb
5
5
  SHA512:
6
- metadata.gz: 9d84a9600887dde17dd1446cb558698ddc4a91c44a39c909537c54940531279b51f6bc93f7e67058dcf0c56f169e39c0b3e858e795b66b9aa69686441e75a082
7
- data.tar.gz: e7a718999f87d3c8d70c4da49eb610f09b8154286b070b36755599003ba84ca27600d8a3d3cca5ca83b10ad2f5c6010defdb7b5bf0d4d2406cb2a7130792182f
6
+ metadata.gz: 6833aa20a67fbeba89dfd15e5b5c6278c79610c830813ced064432c472b0cd1de6a6d4645c9802fdde217a918f96c3fa0c19c894d32f5272fe56860cbf090ab1
7
+ data.tar.gz: 6b7bb18a5c190a57f15af84fd75bcc019ebde4d27f832493d23430d844a1a2a869eba4b4f285546175a55411f8148815944e866672f4420a123fa672509faca0
data/README.md CHANGED
@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.1.7
10
+ - Package version: 2.2.4
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-validate-api-client-2.1.7.gem
26
+ gem install ./cloudmersive-validate-api-client-2.2.4.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.7.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.4.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-validate-api-client', '~> 2.1.7'
34
+ gem 'cloudmersive-validate-api-client', '~> 2.2.4'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -103,6 +103,7 @@ Class | Method | HTTP request | Description
103
103
  *CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_standard_date_time**](docs/DateTimeApi.md#date_time_parse_standard_date_time) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
104
104
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
105
105
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_get_top_level_domain_from_url**](docs/DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
106
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_is_admin_path**](docs/DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk or vulnerable server administration path
106
107
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_phishing_check**](docs/DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
107
108
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
108
109
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
@@ -110,6 +111,7 @@ Class | Method | HTTP request | Description
110
111
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check**](docs/DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
111
112
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check_batch**](docs/DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
112
113
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
114
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_html_ssrf_check**](docs/DomainApi.md#domain_url_html_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check/html-embedded | Check a URL for HTML embedded SSRF threats
113
115
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
114
116
  *CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
115
117
  *CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
@@ -128,8 +130,13 @@ Class | Method | HTTP request | Description
128
130
  *CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
129
131
  *CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
130
132
  *CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
133
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_html_ssrf**](docs/TextInputApi.md#text_input_check_html_ssrf) | **POST** /validate/text-input/html/check/ssrf | Protect html input from Server-side Request Forgery (SSRF) attacks
134
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection**](docs/TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
135
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection_batch**](docs/TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
131
136
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss**](docs/TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
132
137
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss_batch**](docs/TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
138
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe**](docs/TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
139
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe_batch**](docs/TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
133
140
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_protect_xss**](docs/TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
134
141
  *CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
135
142
  *CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
@@ -160,9 +167,11 @@ Class | Method | HTTP request | Description
160
167
  - [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
161
168
  - [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
162
169
  - [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
170
+ - [CloudmersiveValidateApiClient::HtmlSsrfDetectionResult](docs/HtmlSsrfDetectionResult.md)
163
171
  - [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
164
172
  - [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
165
173
  - [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
174
+ - [CloudmersiveValidateApiClient::IsAdminPathResponse](docs/IsAdminPathResponse.md)
166
175
  - [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
167
176
  - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
168
177
  - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
@@ -178,8 +187,14 @@ Class | Method | HTTP request | Description
178
187
  - [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
179
188
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
180
189
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
190
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest](docs/SqlInjectionCheckBatchRequest.md)
191
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse](docs/SqlInjectionCheckBatchResponse.md)
192
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem](docs/SqlInjectionCheckRequestItem.md)
193
+ - [CloudmersiveValidateApiClient::SqlInjectionDetectionResult](docs/SqlInjectionDetectionResult.md)
181
194
  - [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
182
195
  - [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
196
+ - [CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull](docs/UrlHtmlSsrfRequestFull.md)
197
+ - [CloudmersiveValidateApiClient::UrlHtmlSsrfResponseFull](docs/UrlHtmlSsrfResponseFull.md)
183
198
  - [CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull](docs/UrlSafetyCheckRequestFull.md)
184
199
  - [CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull](docs/UrlSafetyCheckResponseFull.md)
185
200
  - [CloudmersiveValidateApiClient::UrlSsrfRequestBatch](docs/UrlSsrfRequestBatch.md)
@@ -211,6 +226,10 @@ Class | Method | HTTP request | Description
211
226
  - [CloudmersiveValidateApiClient::XssProtectionBatchResponse](docs/XssProtectionBatchResponse.md)
212
227
  - [CloudmersiveValidateApiClient::XssProtectionRequestItem](docs/XssProtectionRequestItem.md)
213
228
  - [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
229
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchRequest](docs/XxeDetectionBatchRequest.md)
230
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchResponse](docs/XxeDetectionBatchResponse.md)
231
+ - [CloudmersiveValidateApiClient::XxeDetectionRequestItem](docs/XxeDetectionRequestItem.md)
232
+ - [CloudmersiveValidateApiClient::XxeDetectionResult](docs/XxeDetectionResult.md)
214
233
 
215
234
 
216
235
  ## Documentation for Authorization
data/docs/DomainApi.md CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
8
8
  [**domain_get_top_level_domain_from_url**](DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
9
+ [**domain_is_admin_path**](DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk or vulnerable server administration path
9
10
  [**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
10
11
  [**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
11
12
  [**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
@@ -13,6 +14,7 @@ Method | HTTP request | Description
13
14
  [**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
14
15
  [**domain_ssrf_check_batch**](DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
15
16
  [**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
17
+ [**domain_url_html_ssrf_check**](DomainApi.md#domain_url_html_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check/html-embedded | Check a URL for HTML embedded SSRF threats
16
18
  [**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
17
19
 
18
20
 
@@ -124,6 +126,60 @@ Name | Type | Description | Notes
124
126
 
125
127
 
126
128
 
129
+ # **domain_is_admin_path**
130
+ > IsAdminPathResponse domain_is_admin_path(value)
131
+
132
+ Check if path is a high-risk or vulnerable server administration path
133
+
134
+ Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.
135
+
136
+ ### Example
137
+ ```ruby
138
+ # load the gem
139
+ require 'cloudmersive-validate-api-client'
140
+ # setup authorization
141
+ CloudmersiveValidateApiClient.configure do |config|
142
+ # Configure API key authorization: Apikey
143
+ config.api_key['Apikey'] = 'YOUR API KEY'
144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
145
+ #config.api_key_prefix['Apikey'] = 'Bearer'
146
+ end
147
+
148
+ api_instance = CloudmersiveValidateApiClient::DomainApi.new
149
+
150
+ value = 'value_example' # String | URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes.
151
+
152
+
153
+ begin
154
+ #Check if path is a high-risk or vulnerable server administration path
155
+ result = api_instance.domain_is_admin_path(value)
156
+ p result
157
+ rescue CloudmersiveValidateApiClient::ApiError => e
158
+ puts "Exception when calling DomainApi->domain_is_admin_path: #{e}"
159
+ end
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ Name | Type | Description | Notes
165
+ ------------- | ------------- | ------------- | -------------
166
+ **value** | **String**| URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes. |
167
+
168
+ ### Return type
169
+
170
+ [**IsAdminPathResponse**](IsAdminPathResponse.md)
171
+
172
+ ### Authorization
173
+
174
+ [Apikey](../README.md#Apikey)
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: application/json, text/json
179
+ - **Accept**: application/json, text/json, application/xml, text/xml
180
+
181
+
182
+
127
183
  # **domain_phishing_check**
128
184
  > PhishingCheckResponse domain_phishing_check(request)
129
185
 
@@ -502,6 +558,60 @@ Name | Type | Description | Notes
502
558
 
503
559
 
504
560
 
561
+ # **domain_url_html_ssrf_check**
562
+ > UrlHtmlSsrfResponseFull domain_url_html_ssrf_check(request)
563
+
564
+ Check a URL for HTML embedded SSRF threats
565
+
566
+ Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.
567
+
568
+ ### Example
569
+ ```ruby
570
+ # load the gem
571
+ require 'cloudmersive-validate-api-client'
572
+ # setup authorization
573
+ CloudmersiveValidateApiClient.configure do |config|
574
+ # Configure API key authorization: Apikey
575
+ config.api_key['Apikey'] = 'YOUR API KEY'
576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
577
+ #config.api_key_prefix['Apikey'] = 'Bearer'
578
+ end
579
+
580
+ api_instance = CloudmersiveValidateApiClient::DomainApi.new
581
+
582
+ request = CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull.new # UrlHtmlSsrfRequestFull | Input URL request
583
+
584
+
585
+ begin
586
+ #Check a URL for HTML embedded SSRF threats
587
+ result = api_instance.domain_url_html_ssrf_check(request)
588
+ p result
589
+ rescue CloudmersiveValidateApiClient::ApiError => e
590
+ puts "Exception when calling DomainApi->domain_url_html_ssrf_check: #{e}"
591
+ end
592
+ ```
593
+
594
+ ### Parameters
595
+
596
+ Name | Type | Description | Notes
597
+ ------------- | ------------- | ------------- | -------------
598
+ **request** | [**UrlHtmlSsrfRequestFull**](UrlHtmlSsrfRequestFull.md)| Input URL request |
599
+
600
+ ### Return type
601
+
602
+ [**UrlHtmlSsrfResponseFull**](UrlHtmlSsrfResponseFull.md)
603
+
604
+ ### Authorization
605
+
606
+ [Apikey](../README.md#Apikey)
607
+
608
+ ### HTTP request headers
609
+
610
+ - **Content-Type**: application/json, text/json
611
+ - **Accept**: application/json, text/json, application/xml, text/xml
612
+
613
+
614
+
505
615
  # **domain_url_syntax_only**
506
616
  > ValidateUrlResponseSyntaxOnly domain_url_syntax_only(request)
507
617
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::HtmlSsrfDetectionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **contained_threats** | **BOOLEAN** | True if the input contained SSRF threats, false otherwise | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::IsAdminPathResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **is_admin_path_node** | **BOOLEAN** | True if the input IP address is an Admin Path, and false otherwise | [optional]
7
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_items** | [**Array<SqlInjectionCheckRequestItem>**](SqlInjectionCheckRequestItem.md) | Multiple items to detect for SQL Injection | [optional]
7
+ **detection_level** | **String** | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended). | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **result_items** | [**Array<SqlInjectionDetectionResult>**](SqlInjectionDetectionResult.md) | Results from performing a batch SQL Injection detection operation; order is preserved from input data | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_text** | **String** | Individual input text item to check for SQL Injection | [optional]
7
+
8
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionDetectionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **contained_sql_injection_attack** | **BOOLEAN** | True if the input contained SQL Injection attacks, false otherwise | [optional]
8
+ **original_input** | **String** | Original input string | [optional]
9
+
10
+
data/docs/TextInputApi.md CHANGED
@@ -4,11 +4,182 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**text_input_check_html_ssrf**](TextInputApi.md#text_input_check_html_ssrf) | **POST** /validate/text-input/html/check/ssrf | Protect html input from Server-side Request Forgery (SSRF) attacks
8
+ [**text_input_check_sql_injection**](TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
9
+ [**text_input_check_sql_injection_batch**](TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
7
10
  [**text_input_check_xss**](TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
8
11
  [**text_input_check_xss_batch**](TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
12
+ [**text_input_check_xxe**](TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
13
+ [**text_input_check_xxe_batch**](TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
9
14
  [**text_input_protect_xss**](TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
10
15
 
11
16
 
17
+ # **text_input_check_html_ssrf**
18
+ > HtmlSsrfDetectionResult text_input_check_html_ssrf(value)
19
+
20
+ Protect html input from Server-side Request Forgery (SSRF) attacks
21
+
22
+ Detects SSRF (Server-side request forgery) attacks and unsafe URL attacks from HTML text input, where attackers can attempt to access unsafe local or network paths in the server environment by injecting them into HTML.
23
+
24
+ ### Example
25
+ ```ruby
26
+ # load the gem
27
+ require 'cloudmersive-validate-api-client'
28
+ # setup authorization
29
+ CloudmersiveValidateApiClient.configure do |config|
30
+ # Configure API key authorization: Apikey
31
+ config.api_key['Apikey'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ #config.api_key_prefix['Apikey'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
37
+
38
+ value = 'value_example' # String | User-facing HTML input.
39
+
40
+
41
+ begin
42
+ #Protect html input from Server-side Request Forgery (SSRF) attacks
43
+ result = api_instance.text_input_check_html_ssrf(value)
44
+ p result
45
+ rescue CloudmersiveValidateApiClient::ApiError => e
46
+ puts "Exception when calling TextInputApi->text_input_check_html_ssrf: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **value** | **String**| User-facing HTML input. |
55
+
56
+ ### Return type
57
+
58
+ [**HtmlSsrfDetectionResult**](HtmlSsrfDetectionResult.md)
59
+
60
+ ### Authorization
61
+
62
+ [Apikey](../README.md#Apikey)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json, text/json
67
+ - **Accept**: application/json, text/json, application/xml, text/xml
68
+
69
+
70
+
71
+ # **text_input_check_sql_injection**
72
+ > SqlInjectionDetectionResult text_input_check_sql_injection(value, opts)
73
+
74
+ Check text input for SQL Injection (SQLI) attacks
75
+
76
+ Detects SQL Injection (SQLI) attacks from text input.
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'cloudmersive-validate-api-client'
82
+ # setup authorization
83
+ CloudmersiveValidateApiClient.configure do |config|
84
+ # Configure API key authorization: Apikey
85
+ config.api_key['Apikey'] = 'YOUR API KEY'
86
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
87
+ #config.api_key_prefix['Apikey'] = 'Bearer'
88
+ end
89
+
90
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
91
+
92
+ value = 'value_example' # String | User-facing text input.
93
+
94
+ opts = {
95
+ detection_level: 'detection_level_example' # String | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended).
96
+ }
97
+
98
+ begin
99
+ #Check text input for SQL Injection (SQLI) attacks
100
+ result = api_instance.text_input_check_sql_injection(value, opts)
101
+ p result
102
+ rescue CloudmersiveValidateApiClient::ApiError => e
103
+ puts "Exception when calling TextInputApi->text_input_check_sql_injection: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ Name | Type | Description | Notes
110
+ ------------- | ------------- | ------------- | -------------
111
+ **value** | **String**| User-facing text input. |
112
+ **detection_level** | **String**| Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended). | [optional]
113
+
114
+ ### Return type
115
+
116
+ [**SqlInjectionDetectionResult**](SqlInjectionDetectionResult.md)
117
+
118
+ ### Authorization
119
+
120
+ [Apikey](../README.md#Apikey)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: application/json, text/json
125
+ - **Accept**: application/json, text/json, application/xml, text/xml
126
+
127
+
128
+
129
+ # **text_input_check_sql_injection_batch**
130
+ > SqlInjectionCheckBatchResponse text_input_check_sql_injection_batch(value)
131
+
132
+ Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
133
+
134
+ Detects SQL Injection (SQLI) attacks from multiple text inputs. Output preverses order of input items.
135
+
136
+ ### Example
137
+ ```ruby
138
+ # load the gem
139
+ require 'cloudmersive-validate-api-client'
140
+ # setup authorization
141
+ CloudmersiveValidateApiClient.configure do |config|
142
+ # Configure API key authorization: Apikey
143
+ config.api_key['Apikey'] = 'YOUR API KEY'
144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
145
+ #config.api_key_prefix['Apikey'] = 'Bearer'
146
+ end
147
+
148
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
149
+
150
+ value = CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest.new # SqlInjectionCheckBatchRequest | User-facing text input.
151
+
152
+
153
+ begin
154
+ #Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
155
+ result = api_instance.text_input_check_sql_injection_batch(value)
156
+ p result
157
+ rescue CloudmersiveValidateApiClient::ApiError => e
158
+ puts "Exception when calling TextInputApi->text_input_check_sql_injection_batch: #{e}"
159
+ end
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ Name | Type | Description | Notes
165
+ ------------- | ------------- | ------------- | -------------
166
+ **value** | [**SqlInjectionCheckBatchRequest**](SqlInjectionCheckBatchRequest.md)| User-facing text input. |
167
+
168
+ ### Return type
169
+
170
+ [**SqlInjectionCheckBatchResponse**](SqlInjectionCheckBatchResponse.md)
171
+
172
+ ### Authorization
173
+
174
+ [Apikey](../README.md#Apikey)
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: application/json, text/json
179
+ - **Accept**: application/json, text/json, application/xml, text/xml
180
+
181
+
182
+
12
183
  # **text_input_check_xss**
13
184
  > XssProtectionResult text_input_check_xss(value)
14
185
 
@@ -68,7 +239,7 @@ Name | Type | Description | Notes
68
239
 
69
240
  Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
70
241
 
71
- Detects XSS (Cross-Site-Scripting) attacks from multiple text input. Output preverses order of input items.
242
+ Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs. Output preverses order of input items.
72
243
 
73
244
  ### Example
74
245
  ```ruby
@@ -117,6 +288,122 @@ Name | Type | Description | Notes
117
288
 
118
289
 
119
290
 
291
+ # **text_input_check_xxe**
292
+ > XxeDetectionResult text_input_check_xxe(value, opts)
293
+
294
+ Protect text input from XML External Entity (XXE) attacks
295
+
296
+ Detects XXE (XML External Entity) attacks from text input.
297
+
298
+ ### Example
299
+ ```ruby
300
+ # load the gem
301
+ require 'cloudmersive-validate-api-client'
302
+ # setup authorization
303
+ CloudmersiveValidateApiClient.configure do |config|
304
+ # Configure API key authorization: Apikey
305
+ config.api_key['Apikey'] = 'YOUR API KEY'
306
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
307
+ #config.api_key_prefix['Apikey'] = 'Bearer'
308
+ end
309
+
310
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
311
+
312
+ value = 'value_example' # String | User-facing text input.
313
+
314
+ opts = {
315
+ allow_internet_urls: true, # BOOLEAN | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false.
316
+ known_safe_urls: 'known_safe_urls_example', # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
317
+ known_unsafe_urls: 'known_unsafe_urls_example' # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
318
+ }
319
+
320
+ begin
321
+ #Protect text input from XML External Entity (XXE) attacks
322
+ result = api_instance.text_input_check_xxe(value, opts)
323
+ p result
324
+ rescue CloudmersiveValidateApiClient::ApiError => e
325
+ puts "Exception when calling TextInputApi->text_input_check_xxe: #{e}"
326
+ end
327
+ ```
328
+
329
+ ### Parameters
330
+
331
+ Name | Type | Description | Notes
332
+ ------------- | ------------- | ------------- | -------------
333
+ **value** | **String**| User-facing text input. |
334
+ **allow_internet_urls** | **BOOLEAN**| Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false. | [optional]
335
+ **known_safe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional]
336
+ **known_unsafe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional]
337
+
338
+ ### Return type
339
+
340
+ [**XxeDetectionResult**](XxeDetectionResult.md)
341
+
342
+ ### Authorization
343
+
344
+ [Apikey](../README.md#Apikey)
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: application/json, text/json
349
+ - **Accept**: application/json, text/json, application/xml, text/xml
350
+
351
+
352
+
353
+ # **text_input_check_xxe_batch**
354
+ > XxeDetectionBatchResponse text_input_check_xxe_batch(request)
355
+
356
+ Protect text input from XML External Entity (XXE) attacks
357
+
358
+ Detects XXE (XML External Entity) attacks from text input.
359
+
360
+ ### Example
361
+ ```ruby
362
+ # load the gem
363
+ require 'cloudmersive-validate-api-client'
364
+ # setup authorization
365
+ CloudmersiveValidateApiClient.configure do |config|
366
+ # Configure API key authorization: Apikey
367
+ config.api_key['Apikey'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ #config.api_key_prefix['Apikey'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
373
+
374
+ request = CloudmersiveValidateApiClient::XxeDetectionBatchRequest.new # XxeDetectionBatchRequest |
375
+
376
+
377
+ begin
378
+ #Protect text input from XML External Entity (XXE) attacks
379
+ result = api_instance.text_input_check_xxe_batch(request)
380
+ p result
381
+ rescue CloudmersiveValidateApiClient::ApiError => e
382
+ puts "Exception when calling TextInputApi->text_input_check_xxe_batch: #{e}"
383
+ end
384
+ ```
385
+
386
+ ### Parameters
387
+
388
+ Name | Type | Description | Notes
389
+ ------------- | ------------- | ------------- | -------------
390
+ **request** | [**XxeDetectionBatchRequest**](XxeDetectionBatchRequest.md)| |
391
+
392
+ ### Return type
393
+
394
+ [**XxeDetectionBatchResponse**](XxeDetectionBatchResponse.md)
395
+
396
+ ### Authorization
397
+
398
+ [Apikey](../README.md#Apikey)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: application/json, text/json
403
+ - **Accept**: application/json, text/json, application/xml, text/xml
404
+
405
+
406
+
120
407
  # **text_input_protect_xss**
121
408
  > XssProtectionResult text_input_protect_xss(value)
122
409