cloudmersive-security-api-client 2.0.1

data/docs/IPThreatDetectionResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveSecurityApiClient::IPThreatDetectionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_threat** | **BOOLEAN** | True if the input IP address is a threat, false otherwise | [optional] 
+**threat_type** | **String** | Specifies the type of IP threat; possible values include Blocklist, Botnet, WebBot | [optional] 
+
+

data/docs/NetworkThreatDetectionApi.md

@@ -0,0 +1,228 @@
+# CloudmersiveSecurityApiClient::NetworkThreatDetectionApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**network_threat_detection_detect_ssrf_url**](NetworkThreatDetectionApi.md#network_threat_detection_detect_ssrf_url) | **POST** /security/threat-detection/network/url/ssrf/detect | Check a URL for Server-side Request Forgery (SSRF) threats
+[**network_threat_detection_is_bot**](NetworkThreatDetectionApi.md#network_threat_detection_is_bot) | **POST** /security/threat-detection/network/ip/is-bot | Check if IP address is a Bot client threat
+[**network_threat_detection_is_threat**](NetworkThreatDetectionApi.md#network_threat_detection_is_threat) | **POST** /security/threat-detection/network/ip/is-threat | Check if IP address is a known threat
+[**network_threat_detection_is_tor_node**](NetworkThreatDetectionApi.md#network_threat_detection_is_tor_node) | **POST** /security/threat-detection/network/ip/is-tor-node | Check if IP address is a Tor node server
+
+
+# **network_threat_detection_detect_ssrf_url**
+> UrlSsrfThreatDetectionResponseFull network_threat_detection_detect_ssrf_url(request)
+
+Check a URL for Server-side Request Forgery (SSRF) threats
+
+Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveSecurityApiClient::NetworkThreatDetectionApi.new
+
+request = CloudmersiveSecurityApiClient::UrlSsrfThreatDetectionRequestFull.new # UrlSsrfThreatDetectionRequestFull | Input URL request
+
+
+begin
+  #Check a URL for Server-side Request Forgery (SSRF) threats
+  result = api_instance.network_threat_detection_detect_ssrf_url(request)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling NetworkThreatDetectionApi->network_threat_detection_detect_ssrf_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UrlSsrfThreatDetectionRequestFull**](UrlSsrfThreatDetectionRequestFull.md)| Input URL request | 
+
+### Return type
+
+[**UrlSsrfThreatDetectionResponseFull**](UrlSsrfThreatDetectionResponseFull.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **network_threat_detection_is_bot**
+> ThreatDetectionBotCheckResponse network_threat_detection_is_bot(value)
+
+Check if IP address is a Bot client threat
+
+Check if the input IP address is a Bot, robot, or otherwise a non-user entity.  Leverages real-time signals to check against known high-probability bots..
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveSecurityApiClient::NetworkThreatDetectionApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a Bot client threat
+  result = api_instance.network_threat_detection_is_bot(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling NetworkThreatDetectionApi->network_threat_detection_is_bot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**ThreatDetectionBotCheckResponse**](ThreatDetectionBotCheckResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **network_threat_detection_is_threat**
+> IPThreatDetectionResponse network_threat_detection_is_threat(value)
+
+Check if IP address is a known threat
+
+Check if the input IP address is a known threat IP address.  Checks against known bad IPs, botnets, compromised servers, and other lists of threats.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveSecurityApiClient::NetworkThreatDetectionApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a known threat
+  result = api_instance.network_threat_detection_is_threat(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling NetworkThreatDetectionApi->network_threat_detection_is_threat: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**IPThreatDetectionResponse**](IPThreatDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **network_threat_detection_is_tor_node**
+> ThreatDetectionTorNodeResponse network_threat_detection_is_tor_node(value)
+
+Check if IP address is a Tor node server
+
+Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveSecurityApiClient::NetworkThreatDetectionApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a Tor node server
+  result = api_instance.network_threat_detection_is_tor_node(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling NetworkThreatDetectionApi->network_threat_detection_is_tor_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**ThreatDetectionTorNodeResponse**](ThreatDetectionTorNodeResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/StringAutomaticThreatDetection.md

@@ -0,0 +1,18 @@
+# CloudmersiveSecurityApiClient::StringAutomaticThreatDetection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**clean_result** | **BOOLEAN** |  | [optional] 
+**contained_json_insecure_deserialization_attack** | **BOOLEAN** | True if the input contained Insecure Deserialization JSON, false otherwise | [optional] 
+**contained_xss_threat** | **BOOLEAN** | True if the input contained XSS attack, false otherwise | [optional] 
+**contained_xxe_threat** | **BOOLEAN** | True if the input contained XXE attack, false otherwise | [optional] 
+**contained_sql_injection_threat** | **BOOLEAN** | True if the input contained SQL Injection attack, false otherwise | [optional] 
+**contained_ssrf_threat** | **BOOLEAN** | True if the input contained an Server-Side Request Forgery (SSRF) URL attack, false otherwise | [optional] 
+**is_xml** | **BOOLEAN** | True if the input string is XML, false otherwise | [optional] 
+**is_json** | **BOOLEAN** | True if the input string is JSON, false otherwise | [optional] 
+**is_url** | **BOOLEAN** | True if the input string is a URL, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+
+

data/docs/StringInsecureDeserializationJsonDetection.md

@@ -0,0 +1,10 @@
+# CloudmersiveSecurityApiClient::StringInsecureDeserializationJsonDetection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_json_insecure_deserialization_attack** | **BOOLEAN** | True if the input contained Insecure Deserialization JSON, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+
+

data/docs/StringSqlInjectionDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveSecurityApiClient::StringSqlInjectionDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_sql_injection_attack** | **BOOLEAN** | True if the input contained SQL Injection attacks, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+
+

data/docs/StringXssProtectionResult.md

@@ -0,0 +1,11 @@
+# CloudmersiveSecurityApiClient::StringXssProtectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_xss** | **BOOLEAN** | True if the input contained XSS scripting, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+**normalized_result** | **String** | Normalized string result, with XSS removed | [optional] 
+
+

data/docs/StringXxeDetectionResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveSecurityApiClient::StringXxeDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_xxe** | **BOOLEAN** | True if the input contained XXE threats, false otherwise | [optional] 
+
+

data/docs/ThreatDetectionBotCheckResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveSecurityApiClient::ThreatDetectionBotCheckResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_bot** | **BOOLEAN** | True if the input IP address is a Bot or Robot, false otherwise | [optional] 
+
+

data/docs/ThreatDetectionTorNodeResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveSecurityApiClient::ThreatDetectionTorNodeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_tor_node** | **BOOLEAN** | True if the input IP address is a Tor exit node, false otherwise | [optional] 
+
+

data/docs/UrlSsrfThreatDetectionRequestFull.md

@@ -0,0 +1,9 @@
+# CloudmersiveSecurityApiClient::UrlSsrfThreatDetectionRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+**blocked_domains** | **Array<String>** | Top level domains that you do not want to allow access to, e.g. mydomain.com - will block all subdomains as well | [optional] 
+
+

data/docs/UrlSsrfThreatDetectionResponseFull.md

@@ -0,0 +1,9 @@
+# CloudmersiveSecurityApiClient::UrlSsrfThreatDetectionResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing an SSRF threat or attack | [optional] 
+**threat_level** | **String** | Threat level of the URL; possible values are High, Medium, Low and None | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/cloudmersive-security-api-client.rb

@@ -0,0 +1,51 @@
+=begin
+#securityapi
+
+#The security APIs help you detect and block security threats.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-security-api-client/api_client'
+require 'cloudmersive-security-api-client/api_error'
+require 'cloudmersive-security-api-client/version'
+require 'cloudmersive-security-api-client/configuration'
+
+# Models
+require 'cloudmersive-security-api-client/models/ip_threat_detection_response'
+require 'cloudmersive-security-api-client/models/string_automatic_threat_detection'
+require 'cloudmersive-security-api-client/models/string_insecure_deserialization_json_detection'
+require 'cloudmersive-security-api-client/models/string_sql_injection_detection_result'
+require 'cloudmersive-security-api-client/models/string_xss_protection_result'
+require 'cloudmersive-security-api-client/models/string_xxe_detection_result'
+require 'cloudmersive-security-api-client/models/threat_detection_bot_check_response'
+require 'cloudmersive-security-api-client/models/threat_detection_tor_node_response'
+require 'cloudmersive-security-api-client/models/url_ssrf_threat_detection_request_full'
+require 'cloudmersive-security-api-client/models/url_ssrf_threat_detection_response_full'
+
+# APIs
+require 'cloudmersive-security-api-client/api/content_threat_detection_api'
+require 'cloudmersive-security-api-client/api/network_threat_detection_api'
+
+module CloudmersiveSecurityApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveSecurityApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end