VMAware

VMAware (VM + Aware) is a cross-platform C++ library for virtual machine detection.

The library is:

• Very easy to use, with only 5 functions in its public interface
• Cross-platform (Windows + MacOS + Linux)
• Compatible with x86 and ARM, with backwards compatibility for 32-bit systems
• Features up to 100+ unique VM detection techniques (list)
• Able to detect 40 VM brands including VMware, VirtualBox, QEMU, Hyper-V, Parallels, and much more
• Very flexible, with total fine-grained control over which techniques get executed
• Able to detect various semi-VM technologies like hypervisors, emulators, containers, and Wine
• Able to guess the VM brand
• Available with C++11 and above
• Header-only
• Memoized, meaning past results are cached and retrieved if ran again for performance benefits
• Contains separate MIT and GPL-3.0 compliant library header files

[!NOTE] The library doesn't guarantee it'll be accurate. If you found a false positive or a false negative then please create an issue with information on what your VM is, what OS you're using, and other relevant details.

Example 🧪

#include "vmaware.hpp"
#include <iostream>

int main() {
    if (VM::detect()) {
        std::cout << "Virtual machine detected!" << std::endl;
        std::cout << "VM name: " << VM::brand() << std::endl;
    } else {
        std::cout << "Running in baremetal" << std::endl;
    }

    std::cout << "VM certainty: " << (int)VM::percentage() << "%" << std::endl;
}

Structure ⚙️

CLI tool 🔧

This project also provides a tiny, but handy CLI tool utilising the full potential of what the library can do. It'll give you all sorts of details about the environment it's running under.

Installation 📥

To install the library, download the vmaware.hpp file in the latest release section to your project. No CMake or shared object linkages are necessary, it's literally that simple.

However, if you want the full project (globally accessible headers with and the CLI tool), follow these commands:

git clone https://github.com/kernelwernel/VMAware 
cd VMAware

FOR LINUX:

sudo dnf/apt/yum update -y # change this to whatever your distro is
mkdir build
cd build
cmake ..
sudo make install

FOR WINDOWS:

cmake -S . -B build/ -G "Visual Studio 16 2019"

If you just want the binaries, head over to the latest release section

Documentation 📒

You can view the full docs here. Trust me, it's not too intimidating ;)

Q&A ❓

• How does it work?

  It utilises a comprehensive list of low-level and high-level anti-VM techniques that gets accounted in a scoring system. The scores (0-100) for each technique are arbitrarily given, and every technique that has detected a VM will have their score added to a single accumulative point, where a threshold point number will decide whether it's actually running in a VM.

• Who is this library for?

  It's designed for security researchers, VM engineers, gamer developers, and pretty much anybody who needs a practical and rock-solid VM detection mechanism in their project. For example, the library is suitable if you're making a VM and you're testing the effectiveness of concealing itself, or if you're a game developer or any proprietary software developer to thwart against reverse engineers, or if you're a malware analyst and you want to check if your VM environment is good enough to avoid detection.

• Why another VM detection project?

  There's already loads of projects that have the same goal such as InviZzzible, pafish and Al-Khaser. But the difference between the aforementioned projects is that they don't provide a programmable interface to interact with the detection mechanisms, on top of having little to no support for non-Windows systems. I wanted the core detection techniques to be accessible programmatically in a cross-platform way for everybody to get something useful out of it rather than providing just a CLI tool like those projects.

• Is it possible to spoof the result?

  Yes. There are some techniques that are trivially spoofable, and there's nothing the library can do about it whether it's a deliberate false positive or even a false negative. This is a problem that every VM detection project is facing, which is why the library is trying to test every technique possible to get the best result based on the environment it's running under.

• What about using this for malware?

  This project is not soliciting the development of malware for obvious reasons. Even if you intend to use it for concealment purposes, it'll most likely be flagged by antiviruses anyway and nothing is obfuscated to begin with.

• Why GPL 3.0 and MIT?

  I would've made it strictly MIT so proprietary software can make use of the library, but some of the techniques employed are from GPL 3.0 projects, and I have no choice but to use the same license for legal reasons. This gave me an idea to make an MIT version without all of the GPL code so it can also be used without forcing your code to be open-source. It should be noted that the MIT version removes 10 techniques out of 85 (as of 1.4 version), and the lesser the number of mechanisms, the less accurate the overall result might be.

• I have linker errors when compiling

  If you're compiling with gcc or clang, add the -lm and -lstdc++ flags, or use g++/clang++ compilers instead. If you're receiving linker errors from a brand new VM environment on Linux, update your system with sudo apt/dnf/yum update -y to install the necessary C++ components.

Issues and pull requests 📬

If you have any suggestions, ideas, or any sort of contribution, feel free to ask! I'll be more than happy to discuss in the issue section. If you want to personally ask something in private, my discord is kr.nl

And if you found this project useful, a star would be appreciated :)

Projects using VMAware

CrashLoggerSSE - SKSE/SKSEVR plugin that generates crash logs

If you know a project, or if you're working on a project that uses VMAware, let me know and I'll add it here.

Credits and contributors ✒️

• Check Point Research
• Unprotect Project
• Al-Khaser
• pafish
• Matteo Malvica
• N. Rin, EP_X0FF
• Peter Ferrie, Symantec
• Graham Sutherland, LRQA Nettitude
• Requiem
• Alex
• Marek Knápek
• Vladyslav Miachkov
• (Offensive Security) Danny Quist
• (Offensive Security) Val Smith
• Tom Liston + Ed Skoudis
• Tobias Klein
• (S21sec) Alfredo Omella
• hfiref0x
• Waleedassar
• 一半人生
• Thomas Roccia (fr0gger)
• systemd project

Legal 📜

I am not responsible nor liable for any damage you cause through any malicious usage of this project.

License: GPL-3.0