Browse Source

Version 4.1

master XvirusSDK4.1
Dani Santos 2 years ago
parent
commit
1fcabbd8b6
  1. 35
      README.md
  2. BIN
      bin/BaseLibrary.dll
  3. BIN
      bin/XescSDK.dll
  4. 12
      bin/XescSDK.runtimeconfig.json
  5. 29
      bin/XvirusSDK.deps.json
  6. BIN
      bin/XvirusSDK.dll
  7. 6
      example/Example.csproj

35
README.md

@ -1,6 +1,6 @@
# Xvirus SDK C#
Xvirus SDK 4.0.5 C# bindings.
Xvirus SDK 4.1 C# bindings.
## Table of Contents
@ -17,29 +17,38 @@ Xvirus SDK 4.0.5 C# bindings.
## 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
- 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"
- 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**:
- 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
- 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
## 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.
@ -74,7 +83,7 @@ The `scan` function returns a class `ScanResult` with the following properties:
public class ScanResult
{
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
}
```

BIN
bin/BaseLibrary.dll

Binary file not shown.

BIN
bin/XescSDK.dll

Binary file not shown.

12
bin/XescSDK.runtimeconfig.json

@ -1,12 +0,0 @@
{
"runtimeOptions": {
"tfm": "net5.0",
"framework": {
"name": "Microsoft.NETCore.App",
"version": "5.0.0"
},
"configProperties": {
"System.Reflection.Metadata.MetadataUpdater.IsSupported": false
}
}
}

29
bin/XescSDK.deps.json → bin/XvirusSDK.deps.json

@ -1,19 +1,17 @@
{
"runtimeTarget": {
"name": ".NETCoreApp,Version=v5.0",
"name": ".NETCoreApp,Version=v7.0",
"signature": ""
},
"compilationOptions": {},
"targets": {
".NETCoreApp,Version=v5.0": {
"XescSDK/4.0.5": {
".NETCoreApp,Version=v7.0": {
"XvirusSDK/4.1.0.0": {
"dependencies": {
"Microsoft.ML": "1.7.1",
"Microsoft.ML.FastTree": "1.7.1",
"PeNet": "1.6.1"
"BaseLibrary": "1.0.0"
},
"runtime": {
"XescSDK.dll": {}
"XvirusSDK.dll": {}
}
},
"Microsoft.CSharp/4.3.0": {
@ -1035,11 +1033,21 @@
"fileVersion": "1.3.12.62151"
}
}
},
"BaseLibrary/1.0.0": {
"dependencies": {
"Microsoft.ML": "1.7.1",
"Microsoft.ML.FastTree": "1.7.1",
"PeNet": "1.6.1"
},
"runtime": {
"BaseLibrary.dll": {}
}
}
}
},
"libraries": {
"XescSDK/4.0.5": {
"XvirusSDK/4.1.0.0": {
"type": "project",
"serviceable": false,
"sha512": ""
@ -1743,6 +1751,11 @@
"sha512": "sha512-CQETcfKyEq6Uki9pExNZI5sEHeKqdt9Fc4pdLHu1mgaboQp0aI4W45M+UUnG6Zc2hxWTDmbD2AFVKA1wjU19YA==",
"path": "xunit.skippablefact/1.3.12",
"hashPath": "xunit.skippablefact.1.3.12.nupkg.sha512"
},
"BaseLibrary/1.0.0": {
"type": "project",
"serviceable": false,
"sha512": ""
}
}
}

BIN
bin/XvirusSDK.dll

Binary file not shown.

6
example/Example.csproj

@ -2,12 +2,12 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
<TargetFramework>net7.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<Reference Include="XescSDK">
<HintPath>..\bin\XescSDK.dll</HintPath>
<Reference Include="XvirusSDK">
<HintPath>..\bin\XvirusSDK.dll</HintPath>
</Reference>
</ItemGroup>

Loading…
Cancel
Save