cloudmersive-virus-scan-api-client 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d95b3fdf4de55c144335fcfaef9465d6068a90901b6e97d3bc45aa0aedda8c6
-  data.tar.gz: 3cb7f7c6402819bc2a1af6beef79455f53d54c5c2dd7db18fbe21171ab1e8991
+  metadata.gz: 1c4fe8316f17ad8deea480acb1c0bf2f845d6e964f63f03c98a9c77a6799825d
+  data.tar.gz: 55367f0441cf9db6d8b6c271655c2fc7489bbf92dcf31a8daac69cedb1e11375
 SHA512:
-  metadata.gz: 277aaa1ed6c9e2780dd3b8a39561449587b7f91beefdb734a550d4cfde68512aba1ffe006970e83db751852e4420c8698ba2f149f50f585690a615f346cf4fb4
-  data.tar.gz: 28e8f9891589552a72f6b5e58e3f6f691974f59fd30d7120323f87fc742d232709d752ef8883695902f54790a8c2172ca1d6c396ec33cc1ca930a2c1cc5dabe2
+  metadata.gz: a3d0c53313e3e68ecd12127272622c1d1e39a02069dd8016854fa8f8c5bee2939e669b90b51019596d9eada1253bf59310f9d0efee1afc8649566be0a7c1d69a
+  data.tar.gz: 15df472b55a1741f009a60204cebb554372ab650e65f379ad02a38a0ddd95ec98c09bf93022862f163b57cd8fd56d4d7abc2f38b7065657692b2798060e55b36

data/README.md

@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.1.1
+- Package version: 2.2.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-virus-scan-api-client-2.1.1.gem
+gem install ./cloudmersive-virus-scan-api-client-2.2.0.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-virus-scan-api-client', '~> 2.1.1'
+    gem 'cloudmersive-virus-scan-api-client', '~> 2.2.0'
 
 ### Install from Git
 

data/docs/AdditionalAdvancedScanInformation.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **contains_json** | **BOOLEAN** | True if the input file contains JSON data, false otherwise; this is not a threat signal | [optional] 
 **contains_xml** | **BOOLEAN** | True if the input file contains XML data, false otherwise; this is not a threat signal | [optional] 
 **contains_image** | **BOOLEAN** | True if the input file contains an image | [optional] 
+**relevant_subfile_name** | **String** | Relevant subfile name in an archive format for identified threats, if any | [optional] 
 
 

data/docs/ScanApi.md

@@ -87,6 +87,7 @@ api_instance = CloudmersiveVirusScanApiClient::ScanApi.new
 input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
 
 opts = { 
+  file_name: 'file_name_example', # String | Optional: specify the original file name of the file being scanned.  By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter.
   allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
   allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -95,6 +96,9 @@ opts = {
   allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   allow_insecure_deserialization: true, # BOOLEAN | Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   allow_html: true, # BOOLEAN | Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats.  Set to true to allow these file types.  Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].  If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present.
+  allow_unsafe_archives: true, # BOOLEAN | Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes.  Default is false (recommended).  If set to true, unsafe archives will be allowed.
+  allow_ole_embedded_object: true, # BOOLEAN | Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code.  Default is false (recommended).  If set to true, OLE embedded objects will be allowed.
+  options: 'options_example', # String | Comma separated set of configuration operations.  Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files.  Default is no options.
   restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
 }
 
@@ -112,6 +116,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **file_name** | **String**| Optional: specify the original file name of the file being scanned.  By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter. | [optional] 
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended). | [optional] 
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended). | [optional] 
  **allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
@@ -120,6 +125,9 @@ Name | Type | Description  | Notes
  **allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
  **allow_insecure_deserialization** | **BOOLEAN**| Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
  **allow_html** | **BOOLEAN**| Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats.  Set to true to allow these file types.  Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].  If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present. | [optional] 
+ **allow_unsafe_archives** | **BOOLEAN**| Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes.  Default is false (recommended).  If set to true, unsafe archives will be allowed. | [optional] 
+ **allow_ole_embedded_object** | **BOOLEAN**| Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code.  Default is false (recommended).  If set to true, OLE embedded objects will be allowed. | [optional] 
+ **options** | **String**| Comma separated set of configuration operations.  Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files.  Default is no options. | [optional] 
  **restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional] 
 
 ### Return type

data/docs/ScanCloudStorageApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 
 # **scan_cloud_storage_scan_aws_s3_file**
-> CloudStorageVirusScanResult scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name)
+> CloudStorageVirusScanResult scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name, opts)
 
 Scan an AWS S3 file for viruses
 
@@ -45,10 +45,13 @@ bucket_name = 'bucket_name_example' # String | Name of the S3 bucket
 
 key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
 
+opts = { 
+  role_arn: 'role_arn_example' # String | Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
+}
 
 begin
   #Scan an AWS S3 file for viruses
-  result = api_instance.scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name)
+  result = api_instance.scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name, opts)
   p result
 rescue CloudmersiveVirusScanApiClient::ApiError => e
   puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_aws_s3_file: #{e}"
@@ -64,6 +67,7 @@ Name | Type | Description  | Notes
  **bucket_region** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' | 
  **bucket_name** | **String**| Name of the S3 bucket | 
  **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. | 
+ **role_arn** | **String**| Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. | [optional] 
 
 ### Return type
 
@@ -112,6 +116,7 @@ bucket_name = 'bucket_name_example' # String | Name of the S3 bucket
 key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
 
 opts = { 
+  role_arn: 'role_arn_example', # String | Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
   allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
   allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -141,6 +146,7 @@ Name | Type | Description  | Notes
  **bucket_region** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' | 
  **bucket_name** | **String**| Name of the S3 bucket | 
  **key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. | 
+ **role_arn** | **String**| Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'. | [optional] 
  **allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended). | [optional] 
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended). | [optional] 
  **allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended). | [optional] 

data/docs/VirusScanAdvancedResult.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **contains_xml_external_entities** | **BOOLEAN** | True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor | [optional] 
 **contains_insecure_deserialization** | **BOOLEAN** | True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor | [optional] 
 **contains_html** | **BOOLEAN** | True if the uploaded file contains HTML, which can be a significant risk factor | [optional] 
+**contains_unsafe_archive** | **BOOLEAN** | True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction | [optional] 
+**contains_ole_embedded_object** | **BOOLEAN** | True if the uploaded file contains an OLE embedded object, which can be a significant risk factor | [optional] 
 **verified_file_format** | **String** | For file format verification-supported file formats, the contents-verified file format of the file.  Null indicates that the file format is not supported for contents verification.  If a Virus or Malware is found, this field will always be set to Null. | [optional] 
 **found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional] 
 **content_information** | [**AdditionalAdvancedScanInformation**](AdditionalAdvancedScanInformation.md) | Contains additional non-threat content verification information | [optional] 

data/lib/cloudmersive-virus-scan-api-client/api/scan_api.rb

@@ -78,6 +78,7 @@ module CloudmersiveVirusScanApiClient
     # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities.  Over 17 million virus and malware signatures.  Continuous cloud-based updates.  Block threats beyond viruses including executables, scripts, invalid files, and more.  Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only).  Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats.  Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats.  Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware.  High-speed in-memory scanning delivers subsecond typical response time.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name Optional: specify the original file name of the file being scanned.  By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter.
     # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -86,6 +87,9 @@ module CloudmersiveVirusScanApiClient
     # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_insecure_deserialization Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_html Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats.  Set to true to allow these file types.  Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].  If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present.
+    # @option opts [BOOLEAN] :allow_unsafe_archives Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes.  Default is false (recommended).  If set to true, unsafe archives will be allowed.
+    # @option opts [BOOLEAN] :allow_ole_embedded_object Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code.  Default is false (recommended).  If set to true, OLE embedded objects will be allowed.
+    # @option opts [String] :options Comma separated set of configuration operations.  Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files.  Default is no options.
     # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
     # @return [VirusScanAdvancedResult]
     def scan_file_advanced(input_file, opts = {})
@@ -97,6 +101,7 @@ module CloudmersiveVirusScanApiClient
     # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities.  Over 17 million virus and malware signatures.  Continuous cloud-based updates.  Block threats beyond viruses including executables, scripts, invalid files, and more.  Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only).  Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats.  Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats.  Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware.  High-speed in-memory scanning delivers subsecond typical response time.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name Optional: specify the original file name of the file being scanned.  By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter.
     # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -105,6 +110,9 @@ module CloudmersiveVirusScanApiClient
     # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_insecure_deserialization Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_html Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats.  Set to true to allow these file types.  Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].  If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present.
+    # @option opts [BOOLEAN] :allow_unsafe_archives Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes.  Default is false (recommended).  If set to true, unsafe archives will be allowed.
+    # @option opts [BOOLEAN] :allow_ole_embedded_object Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code.  Default is false (recommended).  If set to true, OLE embedded objects will be allowed.
+    # @option opts [String] :options Comma separated set of configuration operations.  Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files.  Default is no options.
     # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
     # @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
     def scan_file_advanced_with_http_info(input_file, opts = {})
@@ -127,6 +135,7 @@ module CloudmersiveVirusScanApiClient
       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(['multipart/form-data'])
+      header_params[:'fileName'] = opts[:'file_name'] if !opts[:'file_name'].nil?
       header_params[:'allowExecutables'] = opts[:'allow_executables'] if !opts[:'allow_executables'].nil?
       header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
       header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
@@ -135,6 +144,9 @@ module CloudmersiveVirusScanApiClient
       header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
       header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
       header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
+      header_params[:'allowUnsafeArchives'] = opts[:'allow_unsafe_archives'] if !opts[:'allow_unsafe_archives'].nil?
+      header_params[:'allowOleEmbeddedObject'] = opts[:'allow_ole_embedded_object'] if !opts[:'allow_ole_embedded_object'].nil?
+      header_params[:'options'] = opts[:'options'] if !opts[:'options'].nil?
       header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
 
       # form parameters

data/lib/cloudmersive-virus-scan-api-client/api/scan_cloud_storage_api.rb

@@ -27,6 +27,7 @@ module CloudmersiveVirusScanApiClient
     # @param bucket_name Name of the S3 bucket
     # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
     # @return [CloudStorageVirusScanResult]
     def scan_cloud_storage_scan_aws_s3_file(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
       data, _status_code, _headers = scan_cloud_storage_scan_aws_s3_file_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts)
@@ -41,6 +42,7 @@ module CloudmersiveVirusScanApiClient
     # @param bucket_name Name of the S3 bucket
     # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
     # @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
     def scan_cloud_storage_scan_aws_s3_file_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
       if @api_client.config.debugging
@@ -83,6 +85,7 @@ module CloudmersiveVirusScanApiClient
       header_params[:'bucketRegion'] = bucket_region
       header_params[:'bucketName'] = bucket_name
       header_params[:'keyName'] = key_name
+      header_params[:'roleArn'] = opts[:'role_arn'] if !opts[:'role_arn'].nil?
 
       # form parameters
       form_params = {}
@@ -110,6 +113,7 @@ module CloudmersiveVirusScanApiClient
     # @param bucket_name Name of the S3 bucket
     # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
     # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -133,6 +137,7 @@ module CloudmersiveVirusScanApiClient
     # @param bucket_name Name of the S3 bucket
     # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with &#39;base64:&#39;, such as: &#39;base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV&#39;.
     # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -184,6 +189,7 @@ module CloudmersiveVirusScanApiClient
       header_params[:'bucketRegion'] = bucket_region
       header_params[:'bucketName'] = bucket_name
       header_params[:'keyName'] = key_name
+      header_params[:'roleArn'] = opts[:'role_arn'] if !opts[:'role_arn'].nil?
       header_params[:'allowExecutables'] = opts[:'allow_executables'] if !opts[:'allow_executables'].nil?
       header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
       header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?

data/lib/cloudmersive-virus-scan-api-client/models/additional_advanced_scan_information.rb

@@ -24,12 +24,16 @@ module CloudmersiveVirusScanApiClient
     # True if the input file contains an image
     attr_accessor :contains_image
 
+    # Relevant subfile name in an archive format for identified threats, if any
+    attr_accessor :relevant_subfile_name
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'contains_json' => :'ContainsJSON',
         :'contains_xml' => :'ContainsXML',
-        :'contains_image' => :'ContainsImage'
+        :'contains_image' => :'ContainsImage',
+        :'relevant_subfile_name' => :'RelevantSubfileName'
       }
     end
 
@@ -38,7 +42,8 @@ module CloudmersiveVirusScanApiClient
       {
         :'contains_json' => :'BOOLEAN',
         :'contains_xml' => :'BOOLEAN',
-        :'contains_image' => :'BOOLEAN'
+        :'contains_image' => :'BOOLEAN',
+        :'relevant_subfile_name' => :'String'
       }
     end
 
@@ -61,6 +66,10 @@ module CloudmersiveVirusScanApiClient
       if attributes.has_key?(:'ContainsImage')
         self.contains_image = attributes[:'ContainsImage']
       end
+
+      if attributes.has_key?(:'RelevantSubfileName')
+        self.relevant_subfile_name = attributes[:'RelevantSubfileName']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -83,7 +92,8 @@ module CloudmersiveVirusScanApiClient
       self.class == o.class &&
           contains_json == o.contains_json &&
           contains_xml == o.contains_xml &&
-          contains_image == o.contains_image
+          contains_image == o.contains_image &&
+          relevant_subfile_name == o.relevant_subfile_name
     end
 
     # @see the `==` method
@@ -95,7 +105,7 @@ module CloudmersiveVirusScanApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [contains_json, contains_xml, contains_image].hash
+      [contains_json, contains_xml, contains_image, relevant_subfile_name].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-virus-scan-api-client/models/virus_scan_advanced_result.rb

@@ -45,6 +45,12 @@ module CloudmersiveVirusScanApiClient
     # True if the uploaded file contains HTML, which can be a significant risk factor
     attr_accessor :contains_html
 
+    # True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction
+    attr_accessor :contains_unsafe_archive
+
+    # True if the uploaded file contains an OLE embedded object, which can be a significant risk factor
+    attr_accessor :contains_ole_embedded_object
+
     # For file format verification-supported file formats, the contents-verified file format of the file.  Null indicates that the file format is not supported for contents verification.  If a Virus or Malware is found, this field will always be set to Null.
     attr_accessor :verified_file_format
 
@@ -67,6 +73,8 @@ module CloudmersiveVirusScanApiClient
         :'contains_xml_external_entities' => :'ContainsXmlExternalEntities',
         :'contains_insecure_deserialization' => :'ContainsInsecureDeserialization',
         :'contains_html' => :'ContainsHtml',
+        :'contains_unsafe_archive' => :'ContainsUnsafeArchive',
+        :'contains_ole_embedded_object' => :'ContainsOleEmbeddedObject',
         :'verified_file_format' => :'VerifiedFileFormat',
         :'found_viruses' => :'FoundViruses',
         :'content_information' => :'ContentInformation'
@@ -86,6 +94,8 @@ module CloudmersiveVirusScanApiClient
         :'contains_xml_external_entities' => :'BOOLEAN',
         :'contains_insecure_deserialization' => :'BOOLEAN',
         :'contains_html' => :'BOOLEAN',
+        :'contains_unsafe_archive' => :'BOOLEAN',
+        :'contains_ole_embedded_object' => :'BOOLEAN',
         :'verified_file_format' => :'String',
         :'found_viruses' => :'Array<VirusFound>',
         :'content_information' => :'AdditionalAdvancedScanInformation'
@@ -140,6 +150,14 @@ module CloudmersiveVirusScanApiClient
         self.contains_html = attributes[:'ContainsHtml']
       end
 
+      if attributes.has_key?(:'ContainsUnsafeArchive')
+        self.contains_unsafe_archive = attributes[:'ContainsUnsafeArchive']
+      end
+
+      if attributes.has_key?(:'ContainsOleEmbeddedObject')
+        self.contains_ole_embedded_object = attributes[:'ContainsOleEmbeddedObject']
+      end
+
       if attributes.has_key?(:'VerifiedFileFormat')
         self.verified_file_format = attributes[:'VerifiedFileFormat']
       end
@@ -183,6 +201,8 @@ module CloudmersiveVirusScanApiClient
           contains_xml_external_entities == o.contains_xml_external_entities &&
           contains_insecure_deserialization == o.contains_insecure_deserialization &&
           contains_html == o.contains_html &&
+          contains_unsafe_archive == o.contains_unsafe_archive &&
+          contains_ole_embedded_object == o.contains_ole_embedded_object &&
           verified_file_format == o.verified_file_format &&
           found_viruses == o.found_viruses &&
           content_information == o.content_information
@@ -197,7 +217,7 @@ module CloudmersiveVirusScanApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, contains_xml_external_entities, contains_insecure_deserialization, contains_html, verified_file_format, found_viruses, content_information].hash
+      [clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, contains_xml_external_entities, contains_insecure_deserialization, contains_html, contains_unsafe_archive, contains_ole_embedded_object, verified_file_format, found_viruses, content_information].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-virus-scan-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveVirusScanApiClient
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/spec/api/scan_api_spec.rb

@@ -49,6 +49,7 @@ describe 'ScanApi' do
   # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities.  Over 17 million virus and malware signatures.  Continuous cloud-based updates.  Block threats beyond viruses including executables, scripts, invalid files, and more.  Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only).  Wide file format support including Office, PDF, HTML, Flash, MSG, and a wide range of image file formats.  Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats.  Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware.  High-speed in-memory scanning delivers subsecond typical response time.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :file_name Optional: specify the original file name of the file being scanned.  By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter.
   # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
@@ -57,6 +58,9 @@ describe 'ScanApi' do
   # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_insecure_deserialization Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_html Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats.  Set to true to allow these file types.  Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].  If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present.
+  # @option opts [BOOLEAN] :allow_unsafe_archives Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes.  Default is false (recommended).  If set to true, unsafe archives will be allowed.
+  # @option opts [BOOLEAN] :allow_ole_embedded_object Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code.  Default is false (recommended).  If set to true, OLE embedded objects will be allowed.
+  # @option opts [String] :options Comma separated set of configuration operations.  Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files.  Default is no options.
   # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
   # @return [VirusScanAdvancedResult]
   describe 'scan_file_advanced test' do

data/spec/api/scan_cloud_storage_api_spec.rb

@@ -41,6 +41,7 @@ describe 'ScanCloudStorageApi' do
   # @param bucket_name Name of the S3 bucket
   # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
   # @return [CloudStorageVirusScanResult]
   describe 'scan_cloud_storage_scan_aws_s3_file test' do
     it 'should work' do
@@ -57,6 +58,7 @@ describe 'ScanCloudStorageApi' do
   # @param bucket_name Name of the S3 bucket
   # @param key_name Key name (also called file name) of the file in S3 that you wish to scan for viruses.  If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :role_arn Optional: Role ARN for STS Credential-based access.  This is for advanced access using the Security Token Service and is not required.  If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.
   # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).

data/spec/models/additional_advanced_scan_information_spec.rb

@@ -50,4 +50,10 @@ describe 'AdditionalAdvancedScanInformation' do
     end
   end
 
+  describe 'test attribute "relevant_subfile_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/virus_scan_advanced_result_spec.rb

@@ -92,6 +92,18 @@ describe 'VirusScanAdvancedResult' do
     end
   end
 
+  describe 'test attribute "contains_unsafe_archive"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_ole_embedded_object"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "verified_file_format"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-virus-scan-api-client
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-11 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus