|
@ -1,6 +1,6 @@ |
|
|
# Xvirus SDK C# |
|
|
# Xvirus SDK C# |
|
|
|
|
|
|
|
|
Xvirus SDK 4.0.5 C# bindings. |
|
|
Xvirus SDK 4.1 C# bindings. |
|
|
|
|
|
|
|
|
## Table of Contents |
|
|
## Table of Contents |
|
|
|
|
|
|
|
@ -17,29 +17,38 @@ Xvirus SDK 4.0.5 C# bindings. |
|
|
|
|
|
|
|
|
## Minimum Requirements |
|
|
## Minimum Requirements |
|
|
|
|
|
|
|
|
To run Xvirus SDK you need: |
|
|
To use Xvirus SDK you need: |
|
|
|
|
|
|
|
|
- .NET 5 Runtime - [download](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-5.0.11-windows-x64-installer) |
|
|
- .NET 7 SDK - [download](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) |
|
|
|
|
|
|
|
|
## Changelog |
|
|
## Changelog |
|
|
|
|
|
|
|
|
- Completely redone in .NET 5 |
|
|
- Version **4.1**: |
|
|
- Now supports Linux (CLI and C# bindings only) |
|
|
|
|
|
- Added XvirusAI scan engine (BETA) |
|
|
- Upgraded from .NET 5 to .NET 7 |
|
|
- Scan speed is up to 2x faster |
|
|
- C++ bindings now also support Linux |
|
|
- Fixed memory usage spike when scanning large files |
|
|
- Removed Minimum Requirements on C++ bindings and CLI |
|
|
- Removed file size limit for scanned files by default |
|
|
- Changed how exceptions are handled in C++ bindings |
|
|
- The checkUpdate function can now check for SDK updates |
|
|
|
|
|
- Added 3 new settings "EnableAIScan", "MaxScanLength" and "DatabaseVersion" |
|
|
- Version **4.0**: |
|
|
|
|
|
- Completely redone in .NET 5 |
|
|
|
|
|
- Now supports Linux (CLI and C# bindings only) |
|
|
|
|
|
- Added XvirusAI scan engine (BETA) |
|
|
|
|
|
- Scan speed is up to 2x faster |
|
|
|
|
|
- Fixed memory usage spike when scanning large files |
|
|
|
|
|
- Removed file size limit for scanned files by default |
|
|
|
|
|
- The checkUpdate function can now check for SDK updates |
|
|
|
|
|
- Added 3 new settings "EnableAIScan", "MaxScanLength" and "DatabaseVersion" |
|
|
|
|
|
|
|
|
## Known Issues |
|
|
## Known Issues |
|
|
|
|
|
|
|
|
- XvirusAI engine is still in BETA. It is not recomended to use in production yet. |
|
|
- XvirusAI engine is still in BETA. It is not recomended to use in production yet. |
|
|
|
|
|
- XvirusAI engine does not work in C++ bindings. |
|
|
- The checkUpdate function can now check for SDK updates but can't update it |
|
|
- The checkUpdate function can now check for SDK updates but can't update it |
|
|
|
|
|
|
|
|
## Get Started |
|
|
## Get Started |
|
|
|
|
|
|
|
|
The "`example`" folder contains an example project on how to import and use Xvirus SDK in C# (.NET Core 5). |
|
|
The "`example`" folder contains an example project on how to import and use Xvirus SDK in C# (.NET 7). |
|
|
|
|
|
|
|
|
You can run it by building it and then running executable file in the output folder. |
|
|
You can run it by building it and then running executable file in the output folder. |
|
|
|
|
|
|
|
@ -74,7 +83,7 @@ The `scan` function returns a class `ScanResult` with the following properties: |
|
|
public class ScanResult |
|
|
public class ScanResult |
|
|
{ |
|
|
{ |
|
|
public bool IsMalware { get; set; } // true if malware |
|
|
public bool IsMalware { get; set; } // true if malware |
|
|
public string Name { get; set; } // detection name |
|
|
public string Name { get; set; } // detection name |
|
|
public double MalwareScore { get; set; } // between 0 and 1, higher score means more likely to be malware, -1 if there was an error |
|
|
public double MalwareScore { get; set; } // between 0 and 1, higher score means more likely to be malware, -1 if there was an error |
|
|
} |
|
|
} |
|
|
``` |
|
|
``` |
|
|