Version 4.2

README.md

@@ -1,6 +1,6 @@
 # Xvirus SDK C#
 
-Xvirus SDK 4.0.5 C# bindings.
+Xvirus SDK 4.2 C# bindings.
 
 ## Table of Contents
 
@@ -17,29 +17,61 @@ Xvirus SDK 4.0.5 C# bindings.
 
 ## Minimum Requirements
 
-To run Xvirus SDK you need:
+To use Xvirus C# 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)
+
+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
 
-- Completely redone in .NET 5
+- Version **4.2**:
-- Now supports Linux (CLI and C# bindings only)
+  - Reduced glibc minimum version to 2.17 on Linux
-- Added XvirusAI scan engine (BETA)
+  - Added "Logging()" function to enable/disable logging
-- Scan speed is up to 2x faster
+  - Added "BaseFolder()" function to set a custom base folder
-- Fixed memory usage spike when scanning large files
+  - Added new setting "DatabaseFolder" to set the Database folder path
-- Removed file size limit for scanned files by default
+  - Fixed C++ binding will return "Success=false" correctly when failing to scan a file 
-- 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
+  - 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.
 
@@ -64,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
@@ -74,18 +108,19 @@ 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
 }
 ```
 
 ## 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:
@@ -95,6 +130,7 @@ Example of a `settings.json` file:
   "EnableHeuristics": true,
   "EnableAIScan": false,
   "MaxScanLength": null,
+  "DatabaseFolder": "Database",
   "DatabaseVersion": {
     "AIModel": 0,
     "MainDB": 0,

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
-    }
-  }
-}

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": {
+    ".NETCoreApp,Version=v7.0": {
-      "XescSDK/4.0.5": {
+      "XvirusSDK/4.2.0.0": {
         "dependencies": {
-          "Microsoft.ML": "1.7.1",
+          "BaseLibrary": "1.0.0"
-          "Microsoft.ML.FastTree": "1.7.1",
-          "PeNet": "1.6.1"
         },
         "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.2.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/settings.json

@@ -2,6 +2,7 @@
   "EnableHeuristics": true,
   "EnableAIScan": false,
   "MaxScanLength": null,
+  "DatabaseFolder": "Database",
   "DatabaseVersion": {
     "AIModel": 0,
     "MainDB": 0,

example/Example.csproj

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