cloudmersive-virus-scan-api-client 2.0.5 → 2.0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -4
- data/docs/AdditionalAdvancedScanInformation.md +9 -0
- data/docs/ScanApi.md +6 -0
- data/docs/ScanCloudStorageApi.md +165 -0
- data/docs/VirusScanAdvancedResult.md +4 -0
- data/lib/cloudmersive-virus-scan-api-client/api/scan_api.rb +9 -0
- data/lib/cloudmersive-virus-scan-api-client/api/scan_cloud_storage_api.rb +204 -0
- data/lib/cloudmersive-virus-scan-api-client/models/additional_advanced_scan_information.rb +196 -0
- data/lib/cloudmersive-virus-scan-api-client/models/virus_scan_advanced_result.rb +44 -4
- data/lib/cloudmersive-virus-scan-api-client/version.rb +1 -1
- data/lib/cloudmersive-virus-scan-api-client.rb +1 -0
- data/spec/api/scan_api_spec.rb +3 -0
- data/spec/api/scan_cloud_storage_api_spec.rb +46 -0
- data/spec/models/additional_advanced_scan_information_spec.rb +47 -0
- data/spec/models/virus_scan_advanced_result_spec.rb +24 -0
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 137bd7763b18f850e5041a72ce7d0b47f5aa314a99c78feb1639c21fa54bb782
|
4
|
+
data.tar.gz: 6380f584c660cf63ddbc8ab1715031b59607446775cb0ed70e1bca82b0d987ff
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: af3451faa07d54652ef015cf871889e8d4ded02e389140f117f1ef4206267bd0309d30005507d1036b6378744c114e52ebe5c99ede84cfc69feaa5945138ec57
|
7
|
+
data.tar.gz: bf5de355966f1ca791cd085ec6956f8bdd97d675cb5c96cdad416e7f879407646afeed6c5cefbc32b4e896c655adb01bceea90a64c387b43f4798987ada6bf6a
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
|
|
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.0.
|
10
|
+
- Package version: 2.0.9
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-virus-scan-api-client-2.0.
|
26
|
+
gem install ./cloudmersive-virus-scan-api-client-2.0.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.9.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-virus-scan-api-client', '~> 2.0.
|
34
|
+
gem 'cloudmersive-virus-scan-api-client', '~> 2.0.9'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -92,10 +92,13 @@ Class | Method | HTTP request | Description
|
|
92
92
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
|
93
93
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
|
94
94
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
95
|
+
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive
|
96
|
+
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive
|
95
97
|
|
96
98
|
|
97
99
|
## Documentation for Models
|
98
100
|
|
101
|
+
- [CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation](docs/AdditionalAdvancedScanInformation.md)
|
99
102
|
- [CloudmersiveVirusScanApiClient::CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)
|
100
103
|
- [CloudmersiveVirusScanApiClient::CloudStorageVirusFound](docs/CloudStorageVirusFound.md)
|
101
104
|
- [CloudmersiveVirusScanApiClient::CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**contains_json** | **BOOLEAN** | True if the input file contains JSON data, false otherwise; this is not a threat signal | [optional]
|
7
|
+
**contains_xml** | **BOOLEAN** | True if the input file contains XML data, false otherwise; this is not a threat signal | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ScanApi.md
CHANGED
@@ -92,6 +92,9 @@ opts = {
|
|
92
92
|
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).
|
93
93
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
94
94
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
95
|
+
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).
|
96
|
+
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).
|
97
|
+
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].
|
95
98
|
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.
|
96
99
|
}
|
97
100
|
|
@@ -114,6 +117,9 @@ Name | Type | Description | Notes
|
|
114
117
|
**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]
|
115
118
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
116
119
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
120
|
+
**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]
|
121
|
+
**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]
|
122
|
+
**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]. | [optional]
|
117
123
|
**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]
|
118
124
|
|
119
125
|
### Return type
|
data/docs/ScanCloudStorageApi.md
CHANGED
@@ -10,6 +10,8 @@ Method | HTTP request | Description
|
|
10
10
|
[**scan_cloud_storage_scan_azure_blob_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
|
11
11
|
[**scan_cloud_storage_scan_gcp_storage_file**](ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
|
12
12
|
[**scan_cloud_storage_scan_gcp_storage_file_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
13
|
+
[**scan_cloud_storage_scan_share_point_online_file**](ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive
|
14
|
+
[**scan_cloud_storage_scan_share_point_online_file_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive
|
13
15
|
|
14
16
|
|
15
17
|
# **scan_cloud_storage_scan_aws_s3_file**
|
@@ -115,6 +117,7 @@ opts = {
|
|
115
117
|
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).
|
116
118
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
117
119
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
120
|
+
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).
|
118
121
|
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.
|
119
122
|
}
|
120
123
|
|
@@ -141,6 +144,7 @@ Name | Type | Description | Notes
|
|
141
144
|
**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]
|
142
145
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
143
146
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
147
|
+
**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]
|
144
148
|
**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]
|
145
149
|
|
146
150
|
### Return type
|
@@ -251,6 +255,7 @@ opts = {
|
|
251
255
|
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).
|
252
256
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
253
257
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
258
|
+
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).
|
254
259
|
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.
|
255
260
|
}
|
256
261
|
|
@@ -275,6 +280,7 @@ Name | Type | Description | Notes
|
|
275
280
|
**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]
|
276
281
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
277
282
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
283
|
+
**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]
|
278
284
|
**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]
|
279
285
|
|
280
286
|
### Return type
|
@@ -385,6 +391,7 @@ opts = {
|
|
385
391
|
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).
|
386
392
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
387
393
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
394
|
+
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).
|
388
395
|
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.
|
389
396
|
}
|
390
397
|
|
@@ -409,6 +416,164 @@ Name | Type | Description | Notes
|
|
409
416
|
**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]
|
410
417
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
411
418
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
419
|
+
**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]
|
420
|
+
**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]
|
421
|
+
|
422
|
+
### Return type
|
423
|
+
|
424
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
425
|
+
|
426
|
+
### Authorization
|
427
|
+
|
428
|
+
[Apikey](../README.md#Apikey)
|
429
|
+
|
430
|
+
### HTTP request headers
|
431
|
+
|
432
|
+
- **Content-Type**: multipart/form-data
|
433
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
# **scan_cloud_storage_scan_share_point_online_file**
|
438
|
+
> CloudStorageVirusScanResult scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
439
|
+
|
440
|
+
Virus Scan a file in a SharePoint Online Site Drive
|
441
|
+
|
442
|
+
Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. 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. Wide file format support including Office, PDF, HTML, Flash. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
443
|
+
|
444
|
+
### Example
|
445
|
+
```ruby
|
446
|
+
# load the gem
|
447
|
+
require 'cloudmersive-virus-scan-api-client'
|
448
|
+
# setup authorization
|
449
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
450
|
+
# Configure API key authorization: Apikey
|
451
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
453
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
454
|
+
end
|
455
|
+
|
456
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
457
|
+
|
458
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
459
|
+
|
460
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
461
|
+
|
462
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
463
|
+
|
464
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
465
|
+
|
466
|
+
file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
467
|
+
|
468
|
+
opts = {
|
469
|
+
tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
|
470
|
+
item_id: 'item_id_example' # String | SharePoint itemID, such as a DriveItem Id
|
471
|
+
}
|
472
|
+
|
473
|
+
begin
|
474
|
+
#Virus Scan a file in a SharePoint Online Site Drive
|
475
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
476
|
+
p result
|
477
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
478
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file: #{e}"
|
479
|
+
end
|
480
|
+
```
|
481
|
+
|
482
|
+
### Parameters
|
483
|
+
|
484
|
+
Name | Type | Description | Notes
|
485
|
+
------------- | ------------- | ------------- | -------------
|
486
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
487
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
488
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
489
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
490
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
491
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
492
|
+
**item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
|
493
|
+
|
494
|
+
### Return type
|
495
|
+
|
496
|
+
[**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md)
|
497
|
+
|
498
|
+
### Authorization
|
499
|
+
|
500
|
+
[Apikey](../README.md#Apikey)
|
501
|
+
|
502
|
+
### HTTP request headers
|
503
|
+
|
504
|
+
- **Content-Type**: multipart/form-data
|
505
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
# **scan_cloud_storage_scan_share_point_online_file_advanced**
|
510
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts)
|
511
|
+
|
512
|
+
Advanced Virus Scan a file in a SharePoint Online Site Drive
|
513
|
+
|
514
|
+
Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. 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. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
515
|
+
|
516
|
+
### Example
|
517
|
+
```ruby
|
518
|
+
# load the gem
|
519
|
+
require 'cloudmersive-virus-scan-api-client'
|
520
|
+
# setup authorization
|
521
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
522
|
+
# Configure API key authorization: Apikey
|
523
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
524
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
525
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
526
|
+
end
|
527
|
+
|
528
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
529
|
+
|
530
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
531
|
+
|
532
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
533
|
+
|
534
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
535
|
+
|
536
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
537
|
+
|
538
|
+
opts = {
|
539
|
+
tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
|
540
|
+
file_path: 'file_path_example', # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
541
|
+
item_id: 'item_id_example', # String | SharePoint itemID, such as a DriveItem Id
|
542
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
543
|
+
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).
|
544
|
+
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).
|
545
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
546
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
547
|
+
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).
|
548
|
+
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.
|
549
|
+
}
|
550
|
+
|
551
|
+
begin
|
552
|
+
#Advanced Virus Scan a file in a SharePoint Online Site Drive
|
553
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts)
|
554
|
+
p result
|
555
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
556
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file_advanced: #{e}"
|
557
|
+
end
|
558
|
+
```
|
559
|
+
|
560
|
+
### Parameters
|
561
|
+
|
562
|
+
Name | Type | Description | Notes
|
563
|
+
------------- | ------------- | ------------- | -------------
|
564
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
565
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
566
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
567
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
568
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
569
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' | [optional]
|
570
|
+
**item_id** | **String**| SharePoint itemID, such as a DriveItem Id | [optional]
|
571
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
572
|
+
**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]
|
573
|
+
**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]
|
574
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
575
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
576
|
+
**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]
|
412
577
|
**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]
|
413
578
|
|
414
579
|
### Return type
|
@@ -10,7 +10,11 @@ Name | Type | Description | Notes
|
|
10
10
|
**contains_password_protected_file** | **BOOLEAN** | True if the scan contained a password protected or encrypted file, which can be a significant risk factor | [optional]
|
11
11
|
**contains_restricted_file_format** | **BOOLEAN** | True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false | [optional]
|
12
12
|
**contains_macros** | **BOOLEAN** | True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor | [optional]
|
13
|
+
**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]
|
14
|
+
**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]
|
15
|
+
**contains_html** | **BOOLEAN** | True if the uploaded file contains HTML, which can be a significant risk factor | [optional]
|
13
16
|
**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]
|
14
17
|
**found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional]
|
18
|
+
**content_information** | [**AdditionalAdvancedScanInformation**](AdditionalAdvancedScanInformation.md) | Contains additional non-threat content verification information | [optional]
|
15
19
|
|
16
20
|
|
@@ -83,6 +83,9 @@ module CloudmersiveVirusScanApiClient
|
|
83
83
|
# @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).
|
84
84
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
85
85
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
86
|
+
# @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).
|
87
|
+
# @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).
|
88
|
+
# @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].
|
86
89
|
# @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.
|
87
90
|
# @return [VirusScanAdvancedResult]
|
88
91
|
def scan_file_advanced(input_file, opts = {})
|
@@ -99,6 +102,9 @@ module CloudmersiveVirusScanApiClient
|
|
99
102
|
# @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).
|
100
103
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
101
104
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
105
|
+
# @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).
|
106
|
+
# @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).
|
107
|
+
# @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].
|
102
108
|
# @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.
|
103
109
|
# @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
|
104
110
|
def scan_file_advanced_with_http_info(input_file, opts = {})
|
@@ -126,6 +132,9 @@ module CloudmersiveVirusScanApiClient
|
|
126
132
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
127
133
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
128
134
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
135
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
136
|
+
header_params[:'allowInsecureDeserialization'] = opts[:'allow_insecure_deserialization'] if !opts[:'allow_insecure_deserialization'].nil?
|
137
|
+
header_params[:'allowHtml'] = opts[:'allow_html'] if !opts[:'allow_html'].nil?
|
129
138
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
130
139
|
|
131
140
|
# form parameters
|
@@ -115,6 +115,7 @@ module CloudmersiveVirusScanApiClient
|
|
115
115
|
# @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).
|
116
116
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
117
117
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
118
|
+
# @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).
|
118
119
|
# @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.
|
119
120
|
# @return [CloudStorageAdvancedVirusScanResult]
|
120
121
|
def scan_cloud_storage_scan_aws_s3_file_advanced(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
@@ -135,6 +136,7 @@ module CloudmersiveVirusScanApiClient
|
|
135
136
|
# @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).
|
136
137
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
137
138
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
139
|
+
# @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).
|
138
140
|
# @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.
|
139
141
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
140
142
|
def scan_cloud_storage_scan_aws_s3_file_advanced_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
@@ -183,6 +185,7 @@ module CloudmersiveVirusScanApiClient
|
|
183
185
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
184
186
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
185
187
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
188
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
186
189
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
187
190
|
|
188
191
|
# form parameters
|
@@ -283,6 +286,7 @@ module CloudmersiveVirusScanApiClient
|
|
283
286
|
# @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).
|
284
287
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
285
288
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
289
|
+
# @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).
|
286
290
|
# @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.
|
287
291
|
# @return [CloudStorageAdvancedVirusScanResult]
|
288
292
|
def scan_cloud_storage_scan_azure_blob_advanced(connection_string, container_name, blob_path, opts = {})
|
@@ -301,6 +305,7 @@ module CloudmersiveVirusScanApiClient
|
|
301
305
|
# @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).
|
302
306
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
303
307
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
308
|
+
# @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).
|
304
309
|
# @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.
|
305
310
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
306
311
|
def scan_cloud_storage_scan_azure_blob_advanced_with_http_info(connection_string, container_name, blob_path, opts = {})
|
@@ -339,6 +344,7 @@ module CloudmersiveVirusScanApiClient
|
|
339
344
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
340
345
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
341
346
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
347
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
342
348
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
343
349
|
|
344
350
|
# form parameters
|
@@ -439,6 +445,7 @@ module CloudmersiveVirusScanApiClient
|
|
439
445
|
# @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).
|
440
446
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
441
447
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
448
|
+
# @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).
|
442
449
|
# @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.
|
443
450
|
# @return [CloudStorageAdvancedVirusScanResult]
|
444
451
|
def scan_cloud_storage_scan_gcp_storage_file_advanced(bucket_name, object_name, json_credential_file, opts = {})
|
@@ -457,6 +464,7 @@ module CloudmersiveVirusScanApiClient
|
|
457
464
|
# @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).
|
458
465
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
459
466
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
467
|
+
# @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).
|
460
468
|
# @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.
|
461
469
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
462
470
|
def scan_cloud_storage_scan_gcp_storage_file_advanced_with_http_info(bucket_name, object_name, json_credential_file, opts = {})
|
@@ -494,6 +502,7 @@ module CloudmersiveVirusScanApiClient
|
|
494
502
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
495
503
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
496
504
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
505
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
497
506
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
498
507
|
|
499
508
|
# form parameters
|
@@ -515,5 +524,200 @@ module CloudmersiveVirusScanApiClient
|
|
515
524
|
end
|
516
525
|
return data, status_code, headers
|
517
526
|
end
|
527
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
528
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. 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. Wide file format support including Office, PDF, HTML, Flash. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
529
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
530
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
531
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
532
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
533
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
534
|
+
# @param [Hash] opts the optional parameters
|
535
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
536
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
537
|
+
# @return [CloudStorageVirusScanResult]
|
538
|
+
def scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
539
|
+
data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
540
|
+
data
|
541
|
+
end
|
542
|
+
|
543
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
544
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. 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. Wide file format support including Office, PDF, HTML, Flash. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
545
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
546
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
547
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
548
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
549
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
550
|
+
# @param [Hash] opts the optional parameters
|
551
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
552
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
553
|
+
# @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
|
554
|
+
def scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
555
|
+
if @api_client.config.debugging
|
556
|
+
@api_client.config.logger.debug 'Calling API: ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file ...'
|
557
|
+
end
|
558
|
+
# verify the required parameter 'client_id' is set
|
559
|
+
if @api_client.config.client_side_validation && client_id.nil?
|
560
|
+
fail ArgumentError, "Missing the required parameter 'client_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
561
|
+
end
|
562
|
+
# verify the required parameter 'client_secret' is set
|
563
|
+
if @api_client.config.client_side_validation && client_secret.nil?
|
564
|
+
fail ArgumentError, "Missing the required parameter 'client_secret' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
565
|
+
end
|
566
|
+
# verify the required parameter 'sharepoint_domain_name' is set
|
567
|
+
if @api_client.config.client_side_validation && sharepoint_domain_name.nil?
|
568
|
+
fail ArgumentError, "Missing the required parameter 'sharepoint_domain_name' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
569
|
+
end
|
570
|
+
# verify the required parameter 'site_id' is set
|
571
|
+
if @api_client.config.client_side_validation && site_id.nil?
|
572
|
+
fail ArgumentError, "Missing the required parameter 'site_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
573
|
+
end
|
574
|
+
# verify the required parameter 'file_path' is set
|
575
|
+
if @api_client.config.client_side_validation && file_path.nil?
|
576
|
+
fail ArgumentError, "Missing the required parameter 'file_path' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
577
|
+
end
|
578
|
+
# resource path
|
579
|
+
local_var_path = '/virus/scan/cloud-storage/sharepoint-online/site/single'
|
580
|
+
|
581
|
+
# query parameters
|
582
|
+
query_params = {}
|
583
|
+
|
584
|
+
# header parameters
|
585
|
+
header_params = {}
|
586
|
+
# HTTP header 'Accept' (if needed)
|
587
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
588
|
+
# HTTP header 'Content-Type'
|
589
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
590
|
+
header_params[:'clientID'] = client_id
|
591
|
+
header_params[:'clientSecret'] = client_secret
|
592
|
+
header_params[:'sharepointDomainName'] = sharepoint_domain_name
|
593
|
+
header_params[:'siteID'] = site_id
|
594
|
+
header_params[:'filePath'] = file_path
|
595
|
+
header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
|
596
|
+
header_params[:'itemID'] = opts[:'item_id'] if !opts[:'item_id'].nil?
|
597
|
+
|
598
|
+
# form parameters
|
599
|
+
form_params = {}
|
600
|
+
|
601
|
+
# http body (model)
|
602
|
+
post_body = nil
|
603
|
+
auth_names = ['Apikey']
|
604
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
605
|
+
:header_params => header_params,
|
606
|
+
:query_params => query_params,
|
607
|
+
:form_params => form_params,
|
608
|
+
:body => post_body,
|
609
|
+
:auth_names => auth_names,
|
610
|
+
:return_type => 'CloudStorageVirusScanResult')
|
611
|
+
if @api_client.config.debugging
|
612
|
+
@api_client.config.logger.debug "API called: ScanCloudStorageApi#scan_cloud_storage_scan_share_point_online_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
613
|
+
end
|
614
|
+
return data, status_code, headers
|
615
|
+
end
|
616
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
617
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. 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. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
618
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
619
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
620
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
621
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
622
|
+
# @param [Hash] opts the optional parameters
|
623
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
624
|
+
# @option opts [String] :file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
625
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
626
|
+
# @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).
|
627
|
+
# @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).
|
628
|
+
# @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).
|
629
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
630
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
631
|
+
# @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).
|
632
|
+
# @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.
|
633
|
+
# @return [CloudStorageAdvancedVirusScanResult]
|
634
|
+
def scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
|
635
|
+
data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, opts)
|
636
|
+
data
|
637
|
+
end
|
638
|
+
|
639
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
640
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. 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. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
641
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
642
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
643
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
644
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
645
|
+
# @param [Hash] opts the optional parameters
|
646
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
647
|
+
# @option opts [String] :file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
648
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
649
|
+
# @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).
|
650
|
+
# @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).
|
651
|
+
# @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).
|
652
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
653
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
654
|
+
# @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).
|
655
|
+
# @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.
|
656
|
+
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
657
|
+
def scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, opts = {})
|
658
|
+
if @api_client.config.debugging
|
659
|
+
@api_client.config.logger.debug 'Calling API: ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced ...'
|
660
|
+
end
|
661
|
+
# verify the required parameter 'client_id' is set
|
662
|
+
if @api_client.config.client_side_validation && client_id.nil?
|
663
|
+
fail ArgumentError, "Missing the required parameter 'client_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
664
|
+
end
|
665
|
+
# verify the required parameter 'client_secret' is set
|
666
|
+
if @api_client.config.client_side_validation && client_secret.nil?
|
667
|
+
fail ArgumentError, "Missing the required parameter 'client_secret' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
668
|
+
end
|
669
|
+
# verify the required parameter 'sharepoint_domain_name' is set
|
670
|
+
if @api_client.config.client_side_validation && sharepoint_domain_name.nil?
|
671
|
+
fail ArgumentError, "Missing the required parameter 'sharepoint_domain_name' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
672
|
+
end
|
673
|
+
# verify the required parameter 'site_id' is set
|
674
|
+
if @api_client.config.client_side_validation && site_id.nil?
|
675
|
+
fail ArgumentError, "Missing the required parameter 'site_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
676
|
+
end
|
677
|
+
# resource path
|
678
|
+
local_var_path = '/virus/scan/cloud-storage/sharepoint-online/site/advanced'
|
679
|
+
|
680
|
+
# query parameters
|
681
|
+
query_params = {}
|
682
|
+
|
683
|
+
# header parameters
|
684
|
+
header_params = {}
|
685
|
+
# HTTP header 'Accept' (if needed)
|
686
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
687
|
+
# HTTP header 'Content-Type'
|
688
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
689
|
+
header_params[:'clientID'] = client_id
|
690
|
+
header_params[:'clientSecret'] = client_secret
|
691
|
+
header_params[:'sharepointDomainName'] = sharepoint_domain_name
|
692
|
+
header_params[:'siteID'] = site_id
|
693
|
+
header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
|
694
|
+
header_params[:'filePath'] = opts[:'file_path'] if !opts[:'file_path'].nil?
|
695
|
+
header_params[:'itemID'] = opts[:'item_id'] if !opts[:'item_id'].nil?
|
696
|
+
header_params[:'allowExecutables'] = opts[:'allow_executables'] if !opts[:'allow_executables'].nil?
|
697
|
+
header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
|
698
|
+
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
699
|
+
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
700
|
+
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
701
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
702
|
+
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
703
|
+
|
704
|
+
# form parameters
|
705
|
+
form_params = {}
|
706
|
+
|
707
|
+
# http body (model)
|
708
|
+
post_body = nil
|
709
|
+
auth_names = ['Apikey']
|
710
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
711
|
+
:header_params => header_params,
|
712
|
+
:query_params => query_params,
|
713
|
+
:form_params => form_params,
|
714
|
+
:body => post_body,
|
715
|
+
:auth_names => auth_names,
|
716
|
+
:return_type => 'CloudStorageAdvancedVirusScanResult')
|
717
|
+
if @api_client.config.debugging
|
718
|
+
@api_client.config.logger.debug "API called: ScanCloudStorageApi#scan_cloud_storage_scan_share_point_online_file_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
719
|
+
end
|
720
|
+
return data, status_code, headers
|
721
|
+
end
|
518
722
|
end
|
519
723
|
end
|
@@ -0,0 +1,196 @@
|
|
1
|
+
=begin
|
2
|
+
#virusapi
|
3
|
+
|
4
|
+
#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveVirusScanApiClient
|
16
|
+
# Additional non-threat content verification information
|
17
|
+
class AdditionalAdvancedScanInformation
|
18
|
+
# True if the input file contains JSON data, false otherwise; this is not a threat signal
|
19
|
+
attr_accessor :contains_json
|
20
|
+
|
21
|
+
# True if the input file contains XML data, false otherwise; this is not a threat signal
|
22
|
+
attr_accessor :contains_xml
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'contains_json' => :'ContainsJSON',
|
28
|
+
:'contains_xml' => :'ContainsXML'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Attribute type mapping.
|
33
|
+
def self.swagger_types
|
34
|
+
{
|
35
|
+
:'contains_json' => :'BOOLEAN',
|
36
|
+
:'contains_xml' => :'BOOLEAN'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Initializes the object
|
41
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
42
|
+
def initialize(attributes = {})
|
43
|
+
return unless attributes.is_a?(Hash)
|
44
|
+
|
45
|
+
# convert string to symbol for hash key
|
46
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
47
|
+
|
48
|
+
if attributes.has_key?(:'ContainsJSON')
|
49
|
+
self.contains_json = attributes[:'ContainsJSON']
|
50
|
+
end
|
51
|
+
|
52
|
+
if attributes.has_key?(:'ContainsXML')
|
53
|
+
self.contains_xml = attributes[:'ContainsXML']
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
58
|
+
# @return Array for valid properties with the reasons
|
59
|
+
def list_invalid_properties
|
60
|
+
invalid_properties = Array.new
|
61
|
+
invalid_properties
|
62
|
+
end
|
63
|
+
|
64
|
+
# Check to see if the all the properties in the model are valid
|
65
|
+
# @return true if the model is valid
|
66
|
+
def valid?
|
67
|
+
true
|
68
|
+
end
|
69
|
+
|
70
|
+
# Checks equality by comparing each attribute.
|
71
|
+
# @param [Object] Object to be compared
|
72
|
+
def ==(o)
|
73
|
+
return true if self.equal?(o)
|
74
|
+
self.class == o.class &&
|
75
|
+
contains_json == o.contains_json &&
|
76
|
+
contains_xml == o.contains_xml
|
77
|
+
end
|
78
|
+
|
79
|
+
# @see the `==` method
|
80
|
+
# @param [Object] Object to be compared
|
81
|
+
def eql?(o)
|
82
|
+
self == o
|
83
|
+
end
|
84
|
+
|
85
|
+
# Calculates hash code according to all attributes.
|
86
|
+
# @return [Fixnum] Hash code
|
87
|
+
def hash
|
88
|
+
[contains_json, contains_xml].hash
|
89
|
+
end
|
90
|
+
|
91
|
+
# Builds the object from hash
|
92
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
93
|
+
# @return [Object] Returns the model itself
|
94
|
+
def build_from_hash(attributes)
|
95
|
+
return nil unless attributes.is_a?(Hash)
|
96
|
+
self.class.swagger_types.each_pair do |key, type|
|
97
|
+
if type =~ /\AArray<(.*)>/i
|
98
|
+
# check to ensure the input is an array given that the attribute
|
99
|
+
# is documented as an array but the input is not
|
100
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
101
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
102
|
+
end
|
103
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
104
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
105
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
106
|
+
end
|
107
|
+
|
108
|
+
self
|
109
|
+
end
|
110
|
+
|
111
|
+
# Deserializes the data based on type
|
112
|
+
# @param string type Data type
|
113
|
+
# @param string value Value to be deserialized
|
114
|
+
# @return [Object] Deserialized data
|
115
|
+
def _deserialize(type, value)
|
116
|
+
case type.to_sym
|
117
|
+
when :DateTime
|
118
|
+
DateTime.parse(value)
|
119
|
+
when :Date
|
120
|
+
Date.parse(value)
|
121
|
+
when :String
|
122
|
+
value.to_s
|
123
|
+
when :Integer
|
124
|
+
value.to_i
|
125
|
+
when :Float
|
126
|
+
value.to_f
|
127
|
+
when :BOOLEAN
|
128
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
129
|
+
true
|
130
|
+
else
|
131
|
+
false
|
132
|
+
end
|
133
|
+
when :Object
|
134
|
+
# generic object (usually a Hash), return directly
|
135
|
+
value
|
136
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
137
|
+
inner_type = Regexp.last_match[:inner_type]
|
138
|
+
value.map { |v| _deserialize(inner_type, v) }
|
139
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
140
|
+
k_type = Regexp.last_match[:k_type]
|
141
|
+
v_type = Regexp.last_match[:v_type]
|
142
|
+
{}.tap do |hash|
|
143
|
+
value.each do |k, v|
|
144
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
145
|
+
end
|
146
|
+
end
|
147
|
+
else # model
|
148
|
+
temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
|
149
|
+
temp_model.build_from_hash(value)
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
# Returns the string representation of the object
|
154
|
+
# @return [String] String presentation of the object
|
155
|
+
def to_s
|
156
|
+
to_hash.to_s
|
157
|
+
end
|
158
|
+
|
159
|
+
# to_body is an alias to to_hash (backward compatibility)
|
160
|
+
# @return [Hash] Returns the object in the form of hash
|
161
|
+
def to_body
|
162
|
+
to_hash
|
163
|
+
end
|
164
|
+
|
165
|
+
# Returns the object in the form of hash
|
166
|
+
# @return [Hash] Returns the object in the form of hash
|
167
|
+
def to_hash
|
168
|
+
hash = {}
|
169
|
+
self.class.attribute_map.each_pair do |attr, param|
|
170
|
+
value = self.send(attr)
|
171
|
+
next if value.nil?
|
172
|
+
hash[param] = _to_hash(value)
|
173
|
+
end
|
174
|
+
hash
|
175
|
+
end
|
176
|
+
|
177
|
+
# Outputs non-array value in the form of hash
|
178
|
+
# For object, use to_hash. Otherwise, just return the value
|
179
|
+
# @param [Object] value Any valid value
|
180
|
+
# @return [Hash] Returns the value in the form of hash
|
181
|
+
def _to_hash(value)
|
182
|
+
if value.is_a?(Array)
|
183
|
+
value.compact.map { |v| _to_hash(v) }
|
184
|
+
elsif value.is_a?(Hash)
|
185
|
+
{}.tap do |hash|
|
186
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
187
|
+
end
|
188
|
+
elsif value.respond_to? :to_hash
|
189
|
+
value.to_hash
|
190
|
+
else
|
191
|
+
value
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
end
|
196
|
+
end
|
@@ -36,12 +36,24 @@ module CloudmersiveVirusScanApiClient
|
|
36
36
|
# True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
|
37
37
|
attr_accessor :contains_macros
|
38
38
|
|
39
|
+
# 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
|
40
|
+
attr_accessor :contains_xml_external_entities
|
41
|
+
|
42
|
+
# True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor
|
43
|
+
attr_accessor :contains_insecure_deserialization
|
44
|
+
|
45
|
+
# True if the uploaded file contains HTML, which can be a significant risk factor
|
46
|
+
attr_accessor :contains_html
|
47
|
+
|
39
48
|
# 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.
|
40
49
|
attr_accessor :verified_file_format
|
41
50
|
|
42
51
|
# Array of viruses found, if any
|
43
52
|
attr_accessor :found_viruses
|
44
53
|
|
54
|
+
# Contains additional non-threat content verification information
|
55
|
+
attr_accessor :content_information
|
56
|
+
|
45
57
|
# Attribute mapping from ruby-style variable name to JSON key.
|
46
58
|
def self.attribute_map
|
47
59
|
{
|
@@ -52,8 +64,12 @@ module CloudmersiveVirusScanApiClient
|
|
52
64
|
:'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
|
53
65
|
:'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
|
54
66
|
:'contains_macros' => :'ContainsMacros',
|
67
|
+
:'contains_xml_external_entities' => :'ContainsXmlExternalEntities',
|
68
|
+
:'contains_insecure_deserialization' => :'ContainsInsecureDeserialization',
|
69
|
+
:'contains_html' => :'ContainsHtml',
|
55
70
|
:'verified_file_format' => :'VerifiedFileFormat',
|
56
|
-
:'found_viruses' => :'FoundViruses'
|
71
|
+
:'found_viruses' => :'FoundViruses',
|
72
|
+
:'content_information' => :'ContentInformation'
|
57
73
|
}
|
58
74
|
end
|
59
75
|
|
@@ -67,8 +83,12 @@ module CloudmersiveVirusScanApiClient
|
|
67
83
|
:'contains_password_protected_file' => :'BOOLEAN',
|
68
84
|
:'contains_restricted_file_format' => :'BOOLEAN',
|
69
85
|
:'contains_macros' => :'BOOLEAN',
|
86
|
+
:'contains_xml_external_entities' => :'BOOLEAN',
|
87
|
+
:'contains_insecure_deserialization' => :'BOOLEAN',
|
88
|
+
:'contains_html' => :'BOOLEAN',
|
70
89
|
:'verified_file_format' => :'String',
|
71
|
-
:'found_viruses' => :'Array<VirusFound>'
|
90
|
+
:'found_viruses' => :'Array<VirusFound>',
|
91
|
+
:'content_information' => :'AdditionalAdvancedScanInformation'
|
72
92
|
}
|
73
93
|
end
|
74
94
|
|
@@ -108,6 +128,18 @@ module CloudmersiveVirusScanApiClient
|
|
108
128
|
self.contains_macros = attributes[:'ContainsMacros']
|
109
129
|
end
|
110
130
|
|
131
|
+
if attributes.has_key?(:'ContainsXmlExternalEntities')
|
132
|
+
self.contains_xml_external_entities = attributes[:'ContainsXmlExternalEntities']
|
133
|
+
end
|
134
|
+
|
135
|
+
if attributes.has_key?(:'ContainsInsecureDeserialization')
|
136
|
+
self.contains_insecure_deserialization = attributes[:'ContainsInsecureDeserialization']
|
137
|
+
end
|
138
|
+
|
139
|
+
if attributes.has_key?(:'ContainsHtml')
|
140
|
+
self.contains_html = attributes[:'ContainsHtml']
|
141
|
+
end
|
142
|
+
|
111
143
|
if attributes.has_key?(:'VerifiedFileFormat')
|
112
144
|
self.verified_file_format = attributes[:'VerifiedFileFormat']
|
113
145
|
end
|
@@ -117,6 +149,10 @@ module CloudmersiveVirusScanApiClient
|
|
117
149
|
self.found_viruses = value
|
118
150
|
end
|
119
151
|
end
|
152
|
+
|
153
|
+
if attributes.has_key?(:'ContentInformation')
|
154
|
+
self.content_information = attributes[:'ContentInformation']
|
155
|
+
end
|
120
156
|
end
|
121
157
|
|
122
158
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -144,8 +180,12 @@ module CloudmersiveVirusScanApiClient
|
|
144
180
|
contains_password_protected_file == o.contains_password_protected_file &&
|
145
181
|
contains_restricted_file_format == o.contains_restricted_file_format &&
|
146
182
|
contains_macros == o.contains_macros &&
|
183
|
+
contains_xml_external_entities == o.contains_xml_external_entities &&
|
184
|
+
contains_insecure_deserialization == o.contains_insecure_deserialization &&
|
185
|
+
contains_html == o.contains_html &&
|
147
186
|
verified_file_format == o.verified_file_format &&
|
148
|
-
found_viruses == o.found_viruses
|
187
|
+
found_viruses == o.found_viruses &&
|
188
|
+
content_information == o.content_information
|
149
189
|
end
|
150
190
|
|
151
191
|
# @see the `==` method
|
@@ -157,7 +197,7 @@ module CloudmersiveVirusScanApiClient
|
|
157
197
|
# Calculates hash code according to all attributes.
|
158
198
|
# @return [Fixnum] Hash code
|
159
199
|
def hash
|
160
|
-
[clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses].hash
|
200
|
+
[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
|
161
201
|
end
|
162
202
|
|
163
203
|
# Builds the object from hash
|
@@ -17,6 +17,7 @@ require 'cloudmersive-virus-scan-api-client/version'
|
|
17
17
|
require 'cloudmersive-virus-scan-api-client/configuration'
|
18
18
|
|
19
19
|
# Models
|
20
|
+
require 'cloudmersive-virus-scan-api-client/models/additional_advanced_scan_information'
|
20
21
|
require 'cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result'
|
21
22
|
require 'cloudmersive-virus-scan-api-client/models/cloud_storage_virus_found'
|
22
23
|
require 'cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result'
|
data/spec/api/scan_api_spec.rb
CHANGED
@@ -54,6 +54,9 @@ describe 'ScanApi' do
|
|
54
54
|
# @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).
|
55
55
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
56
56
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
57
|
+
# @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).
|
58
|
+
# @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).
|
59
|
+
# @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].
|
57
60
|
# @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.
|
58
61
|
# @return [VirusScanAdvancedResult]
|
59
62
|
describe 'scan_file_advanced test' do
|
@@ -62,6 +62,7 @@ describe 'ScanCloudStorageApi' do
|
|
62
62
|
# @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).
|
63
63
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
64
64
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
65
|
+
# @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).
|
65
66
|
# @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.
|
66
67
|
# @return [CloudStorageAdvancedVirusScanResult]
|
67
68
|
describe 'scan_cloud_storage_scan_aws_s3_file_advanced test' do
|
@@ -96,6 +97,7 @@ describe 'ScanCloudStorageApi' do
|
|
96
97
|
# @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).
|
97
98
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
98
99
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
100
|
+
# @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).
|
99
101
|
# @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.
|
100
102
|
# @return [CloudStorageAdvancedVirusScanResult]
|
101
103
|
describe 'scan_cloud_storage_scan_azure_blob_advanced test' do
|
@@ -130,6 +132,7 @@ describe 'ScanCloudStorageApi' do
|
|
130
132
|
# @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).
|
131
133
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
132
134
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
135
|
+
# @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).
|
133
136
|
# @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.
|
134
137
|
# @return [CloudStorageAdvancedVirusScanResult]
|
135
138
|
describe 'scan_cloud_storage_scan_gcp_storage_file_advanced test' do
|
@@ -138,4 +141,47 @@ describe 'ScanCloudStorageApi' do
|
|
138
141
|
end
|
139
142
|
end
|
140
143
|
|
144
|
+
# unit tests for scan_cloud_storage_scan_share_point_online_file
|
145
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
146
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. 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. Wide file format support including Office, PDF, HTML, Flash. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
147
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
148
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
149
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
150
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
151
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
152
|
+
# @param [Hash] opts the optional parameters
|
153
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
154
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
155
|
+
# @return [CloudStorageVirusScanResult]
|
156
|
+
describe 'scan_cloud_storage_scan_share_point_online_file test' do
|
157
|
+
it 'should work' do
|
158
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
# unit tests for scan_cloud_storage_scan_share_point_online_file_advanced
|
163
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
164
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. 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. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
165
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
166
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
167
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
168
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
169
|
+
# @param [Hash] opts the optional parameters
|
170
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
171
|
+
# @option opts [String] :file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
172
|
+
# @option opts [String] :item_id SharePoint itemID, such as a DriveItem Id
|
173
|
+
# @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).
|
174
|
+
# @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).
|
175
|
+
# @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).
|
176
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
177
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
178
|
+
# @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).
|
179
|
+
# @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.
|
180
|
+
# @return [CloudStorageAdvancedVirusScanResult]
|
181
|
+
describe 'scan_cloud_storage_scan_share_point_online_file_advanced test' do
|
182
|
+
it 'should work' do
|
183
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
184
|
+
end
|
185
|
+
end
|
186
|
+
|
141
187
|
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
=begin
|
2
|
+
#virusapi
|
3
|
+
|
4
|
+
#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'AdditionalAdvancedScanInformation' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of AdditionalAdvancedScanInformation' do
|
31
|
+
it 'should create an instance of AdditionalAdvancedScanInformation' do
|
32
|
+
expect(@instance).to be_instance_of(CloudmersiveVirusScanApiClient::AdditionalAdvancedScanInformation)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "contains_json"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "contains_xml"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
@@ -74,6 +74,24 @@ describe 'VirusScanAdvancedResult' do
|
|
74
74
|
end
|
75
75
|
end
|
76
76
|
|
77
|
+
describe 'test attribute "contains_xml_external_entities"' do
|
78
|
+
it 'should work' do
|
79
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
describe 'test attribute "contains_insecure_deserialization"' do
|
84
|
+
it 'should work' do
|
85
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
describe 'test attribute "contains_html"' do
|
90
|
+
it 'should work' do
|
91
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
77
95
|
describe 'test attribute "verified_file_format"' do
|
78
96
|
it 'should work' do
|
79
97
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -86,4 +104,10 @@ describe 'VirusScanAdvancedResult' do
|
|
86
104
|
end
|
87
105
|
end
|
88
106
|
|
107
|
+
describe 'test attribute "content_information"' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
89
113
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cloudmersive-virus-scan-api-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.9
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cloudmersive
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -202,6 +202,7 @@ files:
|
|
202
202
|
- "./README.md"
|
203
203
|
- "./Rakefile"
|
204
204
|
- "./cloudmersive-virus-scan-api-client.gemspec"
|
205
|
+
- "./docs/AdditionalAdvancedScanInformation.md"
|
205
206
|
- "./docs/CloudStorageAdvancedVirusScanResult.md"
|
206
207
|
- "./docs/CloudStorageVirusFound.md"
|
207
208
|
- "./docs/CloudStorageVirusScanResult.md"
|
@@ -219,6 +220,7 @@ files:
|
|
219
220
|
- "./lib/cloudmersive-virus-scan-api-client/api_client.rb"
|
220
221
|
- "./lib/cloudmersive-virus-scan-api-client/api_error.rb"
|
221
222
|
- "./lib/cloudmersive-virus-scan-api-client/configuration.rb"
|
223
|
+
- "./lib/cloudmersive-virus-scan-api-client/models/additional_advanced_scan_information.rb"
|
222
224
|
- "./lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb"
|
223
225
|
- "./lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_found.rb"
|
224
226
|
- "./lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb"
|
@@ -232,6 +234,7 @@ files:
|
|
232
234
|
- "./spec/api/scan_cloud_storage_api_spec.rb"
|
233
235
|
- "./spec/api_client_spec.rb"
|
234
236
|
- "./spec/configuration_spec.rb"
|
237
|
+
- "./spec/models/additional_advanced_scan_information_spec.rb"
|
235
238
|
- "./spec/models/cloud_storage_advanced_virus_scan_result_spec.rb"
|
236
239
|
- "./spec/models/cloud_storage_virus_found_spec.rb"
|
237
240
|
- "./spec/models/cloud_storage_virus_scan_result_spec.rb"
|