vmwsmr Automatic Builder, Signer, and Installer for VMware Workstation Modules

VMware Workstation must already be installed to use this. It can be obtained and licensed for free at https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Workstation%20Pro&freeDownloads=true

This tool solves the issue where VMware Workstation modules (vmmon, vmnet) fail to load on Linux systems with Secure Boot enabled, particularly after Kernel updates.

It creates a systemd service that runs once at boot, checks if the modules for the current kernel are compiled/signed, and if not, recompiles them, signs them with your MOK (Machine Owner Key), and loads them before the VMware service starts.

Prerequisites

• Ubuntu/Debian based system (Scripts use apt).
• VMware Workstation installed.
• Secure Boot enabled (otherwise you don't need this).

Installation

1. Clone this repository:

   git clone https://github.com/chriv/vmws_module_rebuilder
   cd vmws_module_rebuilder

2. Run the setup script as root:

   sudo ./setup.sh

3. Follow the on-screen prompts.

   • If you do not have MOK keys, the script will generate them and ask you to set a password for enrollment.
   • IMPORTANT: If keys were generated, you must REBOOT.
   • Upon reboot, you will see a blue "MOK Management" screen. Select Enroll MOK, view the key, continue, and enter the password you just set.

4. That's it!

   • Every time the system reboots, this service should run before the vmware service.
   • This service will use VMware's own tool to rebuild all modules (and also attempt to start them)
   • After VMware's tool exits (failing to load vmmon and vmnet because of secure boot), this service will sign the modules.
   • After signing the modules, this service will load the modules.
   • The vmware service should trigger on its own after this service finishes and exits.

How it works

1. Configuration: Stores settings in /etc/vmwsmr/vmwsmr.conf.
2. Keys: Stores keys in /etc/vmwsmr/ (restricted to root).
3. Service: A systemd unit vmwsmr.service runs before vmware.service.
4. Script: /usr/local/bin/vmwsmr.sh compiles the modules using vmware-modconfig, signs them using the kernel headers script, and loads them.

Updating Dependencies

The setup script installs linux-headers-generic, which is a metapackage. This ensures that when you run apt upgrade and get a new kernel, you also automatically get the matching headers required for signing.

---

Disclaimers and Trademark Notice

• This project, vmwsmr, is an independent, community-driven tool and is not affiliated with, endorsed by, or sponsored by VMware, Inc. or its parent company, Broadcom Inc.
• The use of VMware and VMware Workstation in this documentation and in the functionality of the tool refers to the trademarked product owned by Broadcom Inc. and is used solely for descriptive purposes.
• The user is responsible for ensuring compliance with VMware's licensing and terms of service.
• Broadcom Inc. reserves all rights to the VMware and VMware Workstation trademarks.

---