The HelloWorld directory contains minimal, cross-platform examples that demonstrate how to integrate and use the OESIS Framework (OESIS).
Each sample shows how to:
- Initialize the SDK
- Load and validate an evaluation license
- Enumerate endpoint security products
- Retrieve patch and vulnerability data
| Folder | Description |
|---|---|
| linux-cpp | C++ HelloWorld sample for Linux |
| mac-cpp | C++ HelloWorld sample for macOS |
| windows-cpp | C++ HelloWorld sample for Windows |
| windows-csharp | .NET (C#) HelloWorld sample for Windows |
| windows-go | Go (Golang) HelloWorld sample for Windows |
To get started, email [email protected] to request:
- An evaluation SDK package
- A license key
You’ll receive a ZIP file containing the SDK metadata and licensing information.
Extract the evaluation ZIP into the root of this repository.
After extraction, you should see a file named sdkroot at the project root — this tells helper scripts and examples where the SDK base directory resides.
The SDK Downloader retrieves the latest OPSWAT SDK client binaries for your platform and architecture.
Run the precompiled downloader executable:
cd sdk-downloader\C-Sharp\bin
.\sdk-downloader.exeThis will create the following structure:
OPSWAT-SDK/
└── client/
└── windows/
├── x64/
├── win32/
└── arm64/
Run the Python version of the SDK Downloader:
cd sdk-downloader/PythonSDKDownloader/src
python3 sdk_downloader.pyThis will populate:
OPSWAT-SDK/
└── client/
├── linux/
└── macos/
Note: You may need to install Python dependencies (e.g.,
requests,os,json) using:pip3 install -r requirements.txt
Copy your evaluation license files into:
eval-license/
All HelloWorld samples automatically reference this folder when initializing the SDK.
- Open
windows-cppin Visual Studio - Build for your desired architecture (
x64,win32, orarm64) - Run the generated binary from:
helloworld\windows-cpp\bin\<arch>\(Debug|Release)
- Open
windows-csharpin Visual Studio - Build (Debug/Release)
- Run from:
helloworld\windows-csharp\bin\<arch>\(Debug|Release)
cd windows-go
go run .
# or build
go build -o bin\helloworld.exeEnsure the correct binaries exist under:
OPSWAT-SDK\client\windows\<architecture>\
cd linux-cpp
make
./bin/helloworldMake sure the SDK .so libraries are in your library path:
export LD_LIBRARY_PATH=../../OPSWAT-SDK/client/linux/x64:$LD_LIBRARY_PATHcd mac-cpp
make
./bin/helloworldIf required, set the library path:
export DYLD_LIBRARY_PATH=../../OPSWAT-SDK/client/macos/x64:$DYLD_LIBRARY_PATH- SDK Initialization and License Activation
- Product Enumeration (e.g., AV, Patch, Firewall, Encryption)
- Patch & Vulnerability Detection
- Result Serialization (console or JSON output)
These examples serve as the foundation for OEM partners to build integrations with OESIS for Device Trust, Patch Management, and Vulnerability Assessment.
| Issue | Cause | Fix |
|---|---|---|
| SDK not found | Downloader not executed | Run the downloader for your platform (binary or Python) |
| License not found | Missing files | Copy license files into eval-license/ |
| Illegal characters in path (Windows) | Trailing backslash in post-build output path | Use "$(TargetDir)." in post-build event |
| Architecture mismatch | SDK binaries don’t match build target | Build with the same arch as the SDK (x64, win32, arm64) |
| Python module not found | Missing dependencies | Run pip3 install -r requirements.txt |
OPSWAT OEM Team
📧 [email protected]
🌐 www.opswat.com/oem