|
|
|
@ -1,6 +1,6 @@ |
|
|
|
# Xvirus SDK C# |
|
|
|
|
|
|
|
Xvirus SDK 4.1 C# bindings. |
|
|
|
Xvirus SDK 4.2 C# bindings. |
|
|
|
|
|
|
|
## Table of Contents |
|
|
|
|
|
|
|
@ -17,17 +17,40 @@ Xvirus SDK 4.1 C# bindings. |
|
|
|
|
|
|
|
## Minimum Requirements |
|
|
|
|
|
|
|
To use Xvirus SDK you need: |
|
|
|
To use Xvirus C# SDK you need: |
|
|
|
|
|
|
|
- .NET 7 SDK - [download](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) |
|
|
|
|
|
|
|
The following Operating Systems are supported: |
|
|
|
|
|
|
|
- Windows: |
|
|
|
- Windows 10 1607 |
|
|
|
- Windows 11 22000 |
|
|
|
- Windows Server 2012 |
|
|
|
- Windows Server Core 2012 |
|
|
|
- Linux (glibc 2.17): |
|
|
|
- Alpine Linux 3.15 |
|
|
|
- CentOS 7 |
|
|
|
- Debian 10 |
|
|
|
- Fedora 36 |
|
|
|
- openSUSE 15 |
|
|
|
- Oracle Linux 7 |
|
|
|
- Red Hat Enterprise Linux 7 |
|
|
|
- SUSE Enterprise Linux (SLES) 12 SP2 |
|
|
|
- Ubuntu 18.04 |
|
|
|
|
|
|
|
## Changelog |
|
|
|
|
|
|
|
- Version **4.1**: |
|
|
|
- Version **4.2**: |
|
|
|
- Reduced glibc minimum version to 2.17 on Linux |
|
|
|
- Added "Logging()" function to enable/disable logging |
|
|
|
- Added "BaseFolder()" function to set a custom base folder |
|
|
|
- Added new setting "DatabaseFolder" to set the Database folder path |
|
|
|
- Fixed C++ binding will return "Success=false" correctly when failing to scan a file |
|
|
|
|
|
|
|
- Version **4.1**: |
|
|
|
- Upgraded from .NET 5 to .NET 7 |
|
|
|
- C++ bindings now also support Linux |
|
|
|
- Removed Minimum Requirements on C++ bindings and CLI |
|
|
|
- Changed how exceptions are handled in C++ bindings |
|
|
|
|
|
|
|
- Version **4.0**: |
|
|
|
@ -73,6 +96,8 @@ You have the following functions available: |
|
|
|
- "**Database is up-to-date!**" |
|
|
|
- **GetSettings** - returns object representation of the `settings.json` file. |
|
|
|
- **GetSettingsAsString** - returns a string representation of the `settings.json` file. |
|
|
|
- **Logging** - Sets and returns if `Logging` is enabled. If no `enableLogging` value is provided it will only return. |
|
|
|
- **BaseFolder** - Sets and returns the `BaseFolder` path. If no `baseFolder` value is provided it will only return. |
|
|
|
- **Version** - returns the version of the SDK/CLI. |
|
|
|
|
|
|
|
## Model |
|
|
|
@ -90,11 +115,12 @@ public class ScanResult |
|
|
|
|
|
|
|
## Settings |
|
|
|
|
|
|
|
Settings are located in the "`settings.json`" file in the root folder of the SDK. There are 4 avaiable options: |
|
|
|
Settings are located in the "`settings.json`" file in the root folder of the SDK. There are 5 avaiable options: |
|
|
|
|
|
|
|
- **EnableHeuristics** - Enables heuristics scanning of files. Default: _true_ |
|
|
|
- **EnableAIScan** - Enables XvirusAI scan engine. This feature is still in BETA. Default: _false_ |
|
|
|
- **MaxScanLength** - Maximum file size to be scanned in bytes. If set "null" then there is no limit. Default: _null_ |
|
|
|
- **DatabaseFolder** - Path to the database folder, it accepts both relative and absolute paths. Default: _"Database"_ |
|
|
|
- **DatabaseVersion** - KeyValue list of database files version. This is updated automatically when using the "checkUpdate()" function. |
|
|
|
|
|
|
|
Example of a `settings.json` file: |
|
|
|
@ -104,6 +130,7 @@ Example of a `settings.json` file: |
|
|
|
"EnableHeuristics": true, |
|
|
|
"EnableAIScan": false, |
|
|
|
"MaxScanLength": null, |
|
|
|
"DatabaseFolder": "Database", |
|
|
|
"DatabaseVersion": { |
|
|
|
"AIModel": 0, |
|
|
|
"MainDB": 0, |
|
|
|
|
Dani Santos
1 year ago