Socket
Socket
Sign inDemoInstall

cloudmersive-virus-api-client

Package Overview
Dependencies
38
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.2.0 to 1.2.1

docs/CloudStorageAdvancedVirusScanResult.md

228

docs/ScanCloudStorageApi.md

@@ -8,4 +8,7 @@ # CloudmersiveVirusApiClient.ScanCloudStorageApi

[**scanCloudStorageScanAwsS3File**](ScanCloudStorageApi.md#scanCloudStorageScanAwsS3File) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses
[**scanCloudStorageScanAwsS3FileAdvanced**](ScanCloudStorageApi.md#scanCloudStorageScanAwsS3FileAdvanced) | **POST** /virus/scan/cloud-storage/aws-s3/single/advanced | Advanced Scan an AWS S3 file for viruses
[**scanCloudStorageScanAzureBlob**](ScanCloudStorageApi.md#scanCloudStorageScanAzureBlob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses
[**scanCloudStorageScanAzureBlobAdvanced**](ScanCloudStorageApi.md#scanCloudStorageScanAzureBlobAdvanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
[**scanCloudStorageScanGcpStorageFile**](ScanCloudStorageApi.md#scanCloudStorageScanGcpStorageFile) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
[**scanCloudStorageScanGcpStorageFileAdvanced**](ScanCloudStorageApi.md#scanCloudStorageScanGcpStorageFileAdvanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses

@@ -78,2 +81,81 @@

<a name="scanCloudStorageScanAwsS3FileAdvanced"></a>
# **scanCloudStorageScanAwsS3FileAdvanced**
> CloudStorageAdvancedVirusScanResult scanCloudStorageScanAwsS3FileAdvanced(accessKey, secretKey, bucketRegion, bucketName, keyName, opts)
Advanced Scan an AWS S3 file for viruses
Advanced Scan the contents of a single AWS S3 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.
### Example
```javascript
var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client');
var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';
var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi();
var accessKey = "accessKey_example"; // String | AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console
var secretKey = "secretKey_example"; // String | AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
var bucketRegion = "bucketRegion_example"; // String | Name of the region of the S3 bucket, such as 'US-East-1'
var bucketName = "bucketName_example"; // String | Name of the S3 bucket
var keyName = "keyName_example"; // String | Key name (also called file name) of the file in S3 that you wish to scan for viruses
var opts = {
'allowExecutables': true, // Boolean | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
'allowInvalidFiles': 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).
'allowScripts': 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).
'allowPasswordProtectedFiles': 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).
'allowMacros': 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).
'restrictFileTypes': "restrictFileTypes_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.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.scanCloudStorageScanAwsS3FileAdvanced(accessKey, secretKey, bucketRegion, bucketName, keyName, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**accessKey** | **String**| AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
**secretKey** | **String**| AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
**bucketRegion** | **String**| Name of the region of the S3 bucket, such as &#39;US-East-1&#39; |
**bucketName** | **String**| Name of the S3 bucket |
**keyName** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses |
**allowExecutables** | **Boolean**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
**allowInvalidFiles** | **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]
**allowScripts** | **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]
**allowPasswordProtectedFiles** | **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]
**allowMacros** | **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]
**restrictFileTypes** | **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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
### Return type
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
### Authorization
[Apikey](../README.md#Apikey)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json, text/json, application/xml, text/xml
<a name="scanCloudStorageScanAzureBlob"></a>

@@ -138,2 +220,75 @@ # **scanCloudStorageScanAzureBlob**

<a name="scanCloudStorageScanAzureBlobAdvanced"></a>
# **scanCloudStorageScanAzureBlobAdvanced**
> CloudStorageAdvancedVirusScanResult scanCloudStorageScanAzureBlobAdvanced(connectionString, containerName, blobPath, opts)
Advanced Scan an Azure Blob for viruses
Advanced Scan the contents of a single Azure Blob 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.
### Example
```javascript
var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client');
var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';
var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi();
var connectionString = "connectionString_example"; // String | Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
var containerName = "containerName_example"; // String | Name of the Blob container within the Azure Blob Storage account
var blobPath = "blobPath_example"; // String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
var opts = {
'allowExecutables': true, // Boolean | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
'allowInvalidFiles': 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).
'allowScripts': 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).
'allowPasswordProtectedFiles': 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).
'allowMacros': 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).
'restrictFileTypes': "restrictFileTypes_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.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.scanCloudStorageScanAzureBlobAdvanced(connectionString, containerName, blobPath, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**connectionString** | **String**| Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal. |
**containerName** | **String**| Name of the Blob container within the Azure Blob Storage account |
**blobPath** | **String**| Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39; |
**allowExecutables** | **Boolean**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
**allowInvalidFiles** | **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]
**allowScripts** | **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]
**allowPasswordProtectedFiles** | **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]
**allowMacros** | **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]
**restrictFileTypes** | **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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
### Return type
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
### Authorization
[Apikey](../README.md#Apikey)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json, text/json, application/xml, text/xml
<a name="scanCloudStorageScanGcpStorageFile"></a>

@@ -198,1 +353,74 @@ # **scanCloudStorageScanGcpStorageFile**

<a name="scanCloudStorageScanGcpStorageFileAdvanced"></a>
# **scanCloudStorageScanGcpStorageFileAdvanced**
> CloudStorageAdvancedVirusScanResult scanCloudStorageScanGcpStorageFileAdvanced(bucketName, objectName, jsonCredentialFile, opts)
Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage 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.
### Example
```javascript
var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client');
var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';
var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi();
var bucketName = "bucketName_example"; // String | Name of the bucket in Google Cloud Storage
var objectName = "objectName_example"; // String | Name of the object or file in Google Cloud Storage
var jsonCredentialFile = "/path/to/file.txt"; // File | Service Account credential for Google Cloud stored in a JSON file.
var opts = {
'allowExecutables': true, // Boolean | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
'allowInvalidFiles': 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).
'allowScripts': 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).
'allowPasswordProtectedFiles': 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).
'allowMacros': 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).
'restrictFileTypes': "restrictFileTypes_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.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.scanCloudStorageScanGcpStorageFileAdvanced(bucketName, objectName, jsonCredentialFile, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bucketName** | **String**| Name of the bucket in Google Cloud Storage |
**objectName** | **String**| Name of the object or file in Google Cloud Storage |
**jsonCredentialFile** | **File**| Service Account credential for Google Cloud stored in a JSON file. |
**allowExecutables** | **Boolean**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
**allowInvalidFiles** | **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]
**allowScripts** | **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]
**allowPasswordProtectedFiles** | **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]
**allowMacros** | **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]
**restrictFileTypes** | **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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
### Return type
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
### Authorization
[Apikey](../README.md#Apikey)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json, text/json, application/xml, text/xml

2

package.json
{
"name": "cloudmersive-virus-api-client",
"version": "1.2.0",
"version": "1.2.1",
"description": "The_Cloudmersive_Virus_Scan_API_lets_you_scan_files_and_content_for_viruses_and_identify_security_issues_with_content_",

@@ -5,0 +5,0 @@ "license": "Apache-2.0",

@@ -8,3 +8,3 @@ # cloudmersive-virus-api-client

- API version: v1
- Package version: 1.2.0
- Package version: 1.2.1

@@ -133,4 +133,7 @@

*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanAwsS3File**](docs/ScanCloudStorageApi.md#scanCloudStorageScanAwsS3File) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses
*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanAwsS3FileAdvanced**](docs/ScanCloudStorageApi.md#scanCloudStorageScanAwsS3FileAdvanced) | **POST** /virus/scan/cloud-storage/aws-s3/single/advanced | Advanced Scan an AWS S3 file for viruses
*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanAzureBlob**](docs/ScanCloudStorageApi.md#scanCloudStorageScanAzureBlob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses
*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanAzureBlobAdvanced**](docs/ScanCloudStorageApi.md#scanCloudStorageScanAzureBlobAdvanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanGcpStorageFile**](docs/ScanCloudStorageApi.md#scanCloudStorageScanGcpStorageFile) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
*CloudmersiveVirusApiClient.ScanCloudStorageApi* | [**scanCloudStorageScanGcpStorageFileAdvanced**](docs/ScanCloudStorageApi.md#scanCloudStorageScanGcpStorageFileAdvanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses

@@ -140,2 +143,3 @@

- [CloudmersiveVirusApiClient.CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)
- [CloudmersiveVirusApiClient.CloudStorageVirusFound](docs/CloudStorageVirusFound.md)

@@ -142,0 +146,0 @@ - [CloudmersiveVirusApiClient.CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)

@@ -36,3 +36,3 @@ /**

* @module api/ScanApi
* @version 1.2.0
* @version 1.2.1
*/

@@ -39,0 +39,0 @@

@@ -19,6 +19,6 @@ /**

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/CloudStorageVirusScanResult'], factory);
define(['ApiClient', 'model/CloudStorageAdvancedVirusScanResult', 'model/CloudStorageVirusScanResult'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('../model/CloudStorageVirusScanResult'));
module.exports = factory(require('../ApiClient'), require('../model/CloudStorageAdvancedVirusScanResult'), require('../model/CloudStorageVirusScanResult'));
} else {

@@ -29,5 +29,5 @@ // Browser globals (root is window)

}
root.CloudmersiveVirusApiClient.ScanCloudStorageApi = factory(root.CloudmersiveVirusApiClient.ApiClient, root.CloudmersiveVirusApiClient.CloudStorageVirusScanResult);
root.CloudmersiveVirusApiClient.ScanCloudStorageApi = factory(root.CloudmersiveVirusApiClient.ApiClient, root.CloudmersiveVirusApiClient.CloudStorageAdvancedVirusScanResult, root.CloudmersiveVirusApiClient.CloudStorageVirusScanResult);
}
}(this, function(ApiClient, CloudStorageVirusScanResult) {
}(this, function(ApiClient, CloudStorageAdvancedVirusScanResult, CloudStorageVirusScanResult) {
'use strict';

@@ -38,3 +38,3 @@

* @module api/ScanCloudStorageApi
* @version 1.2.0
* @version 1.2.1
*/

@@ -130,2 +130,92 @@

/**
* Callback function to receive the result of the scanCloudStorageScanAwsS3FileAdvanced operation.
* @callback module:api/ScanCloudStorageApi~scanCloudStorageScanAwsS3FileAdvancedCallback
* @param {String} error Error message, if any.
* @param {module:model/CloudStorageAdvancedVirusScanResult} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Advanced Scan an AWS S3 file for viruses
* Advanced Scan the contents of a single AWS S3 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.
* @param {String} accessKey AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console
* @param {String} secretKey AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
* @param {String} bucketRegion Name of the region of the S3 bucket, such as &#39;US-East-1&#39;
* @param {String} bucketName Name of the S3 bucket
* @param {String} keyName Key name (also called file name) of the file in S3 that you wish to scan for viruses
* @param {Object} opts Optional parameters
* @param {Boolean} opts.allowExecutables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
* @param {Boolean} opts.allowInvalidFiles 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).
* @param {Boolean} opts.allowScripts 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).
* @param {Boolean} opts.allowPasswordProtectedFiles 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).
* @param {Boolean} opts.allowMacros 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).
* @param {String} opts.restrictFileTypes 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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
* @param {module:api/ScanCloudStorageApi~scanCloudStorageScanAwsS3FileAdvancedCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/CloudStorageAdvancedVirusScanResult}
*/
this.scanCloudStorageScanAwsS3FileAdvanced = function(accessKey, secretKey, bucketRegion, bucketName, keyName, opts, callback) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'accessKey' is set
if (accessKey === undefined || accessKey === null) {
throw new Error("Missing the required parameter 'accessKey' when calling scanCloudStorageScanAwsS3FileAdvanced");
}
// verify the required parameter 'secretKey' is set
if (secretKey === undefined || secretKey === null) {
throw new Error("Missing the required parameter 'secretKey' when calling scanCloudStorageScanAwsS3FileAdvanced");
}
// verify the required parameter 'bucketRegion' is set
if (bucketRegion === undefined || bucketRegion === null) {
throw new Error("Missing the required parameter 'bucketRegion' when calling scanCloudStorageScanAwsS3FileAdvanced");
}
// verify the required parameter 'bucketName' is set
if (bucketName === undefined || bucketName === null) {
throw new Error("Missing the required parameter 'bucketName' when calling scanCloudStorageScanAwsS3FileAdvanced");
}
// verify the required parameter 'keyName' is set
if (keyName === undefined || keyName === null) {
throw new Error("Missing the required parameter 'keyName' when calling scanCloudStorageScanAwsS3FileAdvanced");
}
var pathParams = {
};
var queryParams = {
};
var collectionQueryParams = {
};
var headerParams = {
'accessKey': accessKey,
'secretKey': secretKey,
'bucketRegion': bucketRegion,
'bucketName': bucketName,
'keyName': keyName,
'allowExecutables': opts['allowExecutables'],
'allowInvalidFiles': opts['allowInvalidFiles'],
'allowScripts': opts['allowScripts'],
'allowPasswordProtectedFiles': opts['allowPasswordProtectedFiles'],
'allowMacros': opts['allowMacros'],
'restrictFileTypes': opts['restrictFileTypes']
};
var formParams = {
};
var authNames = ['Apikey'];
var contentTypes = ['multipart/form-data'];
var accepts = ['application/json', 'text/json', 'application/xml', 'text/xml'];
var returnType = CloudStorageAdvancedVirusScanResult;
return this.apiClient.callApi(
'/virus/scan/cloud-storage/aws-s3/single/advanced', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
/**
* Callback function to receive the result of the scanCloudStorageScanAzureBlob operation.

@@ -193,2 +283,78 @@ * @callback module:api/ScanCloudStorageApi~scanCloudStorageScanAzureBlobCallback

/**
* Callback function to receive the result of the scanCloudStorageScanAzureBlobAdvanced operation.
* @callback module:api/ScanCloudStorageApi~scanCloudStorageScanAzureBlobAdvancedCallback
* @param {String} error Error message, if any.
* @param {module:model/CloudStorageAdvancedVirusScanResult} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Advanced Scan an Azure Blob for viruses
* Advanced Scan the contents of a single Azure Blob 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.
* @param {String} connectionString Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.
* @param {String} containerName Name of the Blob container within the Azure Blob Storage account
* @param {String} blobPath Path to the blob within the container, such as &#39;hello.pdf&#39; or &#39;/folder/subfolder/world.pdf&#39;
* @param {Object} opts Optional parameters
* @param {Boolean} opts.allowExecutables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
* @param {Boolean} opts.allowInvalidFiles 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).
* @param {Boolean} opts.allowScripts 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).
* @param {Boolean} opts.allowPasswordProtectedFiles 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).
* @param {Boolean} opts.allowMacros 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).
* @param {String} opts.restrictFileTypes 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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
* @param {module:api/ScanCloudStorageApi~scanCloudStorageScanAzureBlobAdvancedCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/CloudStorageAdvancedVirusScanResult}
*/
this.scanCloudStorageScanAzureBlobAdvanced = function(connectionString, containerName, blobPath, opts, callback) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'connectionString' is set
if (connectionString === undefined || connectionString === null) {
throw new Error("Missing the required parameter 'connectionString' when calling scanCloudStorageScanAzureBlobAdvanced");
}
// verify the required parameter 'containerName' is set
if (containerName === undefined || containerName === null) {
throw new Error("Missing the required parameter 'containerName' when calling scanCloudStorageScanAzureBlobAdvanced");
}
// verify the required parameter 'blobPath' is set
if (blobPath === undefined || blobPath === null) {
throw new Error("Missing the required parameter 'blobPath' when calling scanCloudStorageScanAzureBlobAdvanced");
}
var pathParams = {
};
var queryParams = {
};
var collectionQueryParams = {
};
var headerParams = {
'connectionString': connectionString,
'containerName': containerName,
'blobPath': blobPath,
'allowExecutables': opts['allowExecutables'],
'allowInvalidFiles': opts['allowInvalidFiles'],
'allowScripts': opts['allowScripts'],
'allowPasswordProtectedFiles': opts['allowPasswordProtectedFiles'],
'allowMacros': opts['allowMacros'],
'restrictFileTypes': opts['restrictFileTypes']
};
var formParams = {
};
var authNames = ['Apikey'];
var contentTypes = ['multipart/form-data'];
var accepts = ['application/json', 'text/json', 'application/xml', 'text/xml'];
var returnType = CloudStorageAdvancedVirusScanResult;
return this.apiClient.callApi(
'/virus/scan/cloud-storage/azure-blob/single/advanced', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
/**
* Callback function to receive the result of the scanCloudStorageScanGcpStorageFile operation.

@@ -254,2 +420,78 @@ * @callback module:api/ScanCloudStorageApi~scanCloudStorageScanGcpStorageFileCallback

}
/**
* Callback function to receive the result of the scanCloudStorageScanGcpStorageFileAdvanced operation.
* @callback module:api/ScanCloudStorageApi~scanCloudStorageScanGcpStorageFileAdvancedCallback
* @param {String} error Error message, if any.
* @param {module:model/CloudStorageAdvancedVirusScanResult} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
* Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage 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.
* @param {String} bucketName Name of the bucket in Google Cloud Storage
* @param {String} objectName Name of the object or file in Google Cloud Storage
* @param {File} jsonCredentialFile Service Account credential for Google Cloud stored in a JSON file.
* @param {Object} opts Optional parameters
* @param {Boolean} opts.allowExecutables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
* @param {Boolean} opts.allowInvalidFiles 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).
* @param {Boolean} opts.allowScripts 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).
* @param {Boolean} opts.allowPasswordProtectedFiles 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).
* @param {Boolean} opts.allowMacros 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).
* @param {String} opts.restrictFileTypes 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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
* @param {module:api/ScanCloudStorageApi~scanCloudStorageScanGcpStorageFileAdvancedCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/CloudStorageAdvancedVirusScanResult}
*/
this.scanCloudStorageScanGcpStorageFileAdvanced = function(bucketName, objectName, jsonCredentialFile, opts, callback) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'bucketName' is set
if (bucketName === undefined || bucketName === null) {
throw new Error("Missing the required parameter 'bucketName' when calling scanCloudStorageScanGcpStorageFileAdvanced");
}
// verify the required parameter 'objectName' is set
if (objectName === undefined || objectName === null) {
throw new Error("Missing the required parameter 'objectName' when calling scanCloudStorageScanGcpStorageFileAdvanced");
}
// verify the required parameter 'jsonCredentialFile' is set
if (jsonCredentialFile === undefined || jsonCredentialFile === null) {
throw new Error("Missing the required parameter 'jsonCredentialFile' when calling scanCloudStorageScanGcpStorageFileAdvanced");
}
var pathParams = {
};
var queryParams = {
};
var collectionQueryParams = {
};
var headerParams = {
'bucketName': bucketName,
'objectName': objectName,
'allowExecutables': opts['allowExecutables'],
'allowInvalidFiles': opts['allowInvalidFiles'],
'allowScripts': opts['allowScripts'],
'allowPasswordProtectedFiles': opts['allowPasswordProtectedFiles'],
'allowMacros': opts['allowMacros'],
'restrictFileTypes': opts['restrictFileTypes']
};
var formParams = {
'jsonCredentialFile': jsonCredentialFile
};
var authNames = ['Apikey'];
var contentTypes = ['multipart/form-data'];
var accepts = ['application/json', 'text/json', 'application/xml', 'text/xml'];
var returnType = CloudStorageAdvancedVirusScanResult;
return this.apiClient.callApi(
'/virus/scan/cloud-storage/gcp-storage/single/advanced', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
};

@@ -256,0 +498,0 @@

@@ -35,3 +35,3 @@ /**

* @module ApiClient
* @version 1.2.0
* @version 1.2.1
*/

@@ -38,0 +38,0 @@

@@ -19,8 +19,8 @@ /**

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/CloudStorageVirusFound', 'model/CloudStorageVirusScanResult', 'model/VirusFound', 'model/VirusScanAdvancedResult', 'model/VirusScanResult', 'model/WebsiteScanRequest', 'model/WebsiteScanResult', 'api/ScanApi', 'api/ScanCloudStorageApi'], factory);
define(['ApiClient', 'model/CloudStorageAdvancedVirusScanResult', 'model/CloudStorageVirusFound', 'model/CloudStorageVirusScanResult', 'model/VirusFound', 'model/VirusScanAdvancedResult', 'model/VirusScanResult', 'model/WebsiteScanRequest', 'model/WebsiteScanResult', 'api/ScanApi', 'api/ScanCloudStorageApi'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('./ApiClient'), require('./model/CloudStorageVirusFound'), require('./model/CloudStorageVirusScanResult'), require('./model/VirusFound'), require('./model/VirusScanAdvancedResult'), require('./model/VirusScanResult'), require('./model/WebsiteScanRequest'), require('./model/WebsiteScanResult'), require('./api/ScanApi'), require('./api/ScanCloudStorageApi'));
module.exports = factory(require('./ApiClient'), require('./model/CloudStorageAdvancedVirusScanResult'), require('./model/CloudStorageVirusFound'), require('./model/CloudStorageVirusScanResult'), require('./model/VirusFound'), require('./model/VirusScanAdvancedResult'), require('./model/VirusScanResult'), require('./model/WebsiteScanRequest'), require('./model/WebsiteScanResult'), require('./api/ScanApi'), require('./api/ScanCloudStorageApi'));
}
}(function(ApiClient, CloudStorageVirusFound, CloudStorageVirusScanResult, VirusFound, VirusScanAdvancedResult, VirusScanResult, WebsiteScanRequest, WebsiteScanResult, ScanApi, ScanCloudStorageApi) {
}(function(ApiClient, CloudStorageAdvancedVirusScanResult, CloudStorageVirusFound, CloudStorageVirusScanResult, VirusFound, VirusScanAdvancedResult, VirusScanResult, WebsiteScanRequest, WebsiteScanResult, ScanApi, ScanCloudStorageApi) {
'use strict';

@@ -57,3 +57,3 @@

* @module index
* @version 1.2.0
* @version 1.2.1
*/

@@ -67,2 +67,7 @@ var exports = {

/**
* The CloudStorageAdvancedVirusScanResult model constructor.
* @property {module:model/CloudStorageAdvancedVirusScanResult}
*/
CloudStorageAdvancedVirusScanResult: CloudStorageAdvancedVirusScanResult,
/**
* The CloudStorageVirusFound model constructor.

@@ -69,0 +74,0 @@ * @property {module:model/CloudStorageVirusFound}

@@ -39,3 +39,3 @@ /**

* @module model/CloudStorageVirusFound
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/CloudStorageVirusScanResult
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/VirusFound
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/VirusScanAdvancedResult
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/VirusScanResult
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/WebsiteScanRequest
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/WebsiteScanResult
* @version 1.2.0
* @version 1.2.1
*/

@@ -42,0 +42,0 @@

@@ -63,2 +63,12 @@ /**

});
describe('scanCloudStorageScanAwsS3FileAdvanced', function() {
it('should call scanCloudStorageScanAwsS3FileAdvanced successfully', function(done) {
//uncomment below and update the code to test scanCloudStorageScanAwsS3FileAdvanced
//instance.scanCloudStorageScanAwsS3FileAdvanced(function(error) {
// if (error) throw error;
//expect().to.be();
//});
done();
});
});
describe('scanCloudStorageScanAzureBlob', function() {

@@ -74,2 +84,12 @@ it('should call scanCloudStorageScanAzureBlob successfully', function(done) {

});
describe('scanCloudStorageScanAzureBlobAdvanced', function() {
it('should call scanCloudStorageScanAzureBlobAdvanced successfully', function(done) {
//uncomment below and update the code to test scanCloudStorageScanAzureBlobAdvanced
//instance.scanCloudStorageScanAzureBlobAdvanced(function(error) {
// if (error) throw error;
//expect().to.be();
//});
done();
});
});
describe('scanCloudStorageScanGcpStorageFile', function() {

@@ -85,4 +105,14 @@ it('should call scanCloudStorageScanGcpStorageFile successfully', function(done) {

});
describe('scanCloudStorageScanGcpStorageFileAdvanced', function() {
it('should call scanCloudStorageScanGcpStorageFileAdvanced successfully', function(done) {
//uncomment below and update the code to test scanCloudStorageScanGcpStorageFileAdvanced
//instance.scanCloudStorageScanGcpStorageFileAdvanced(function(error) {
// if (error) throw error;
//expect().to.be();
//});
done();
});
});
});
}));
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc