vmnet-cli 0.1.0__tar.gz

vmnet_cli-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vmnet_cli-0.1.0/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: vmnet-cli
+Version: 0.1.0
+Summary: Unofficial CLI clone of VMware Workstation's Virtual Network Editor (vmnetcfg.exe), built on the reverse-engineered vnetlib.dll VNL_* API
+Author: fl0l0u
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/fl0l0u/vmnet-cli
+Project-URL: Documentation, https://github.com/fl0l0u/vmnet-cli#readme
+Project-URL: Repository, https://github.com/fl0l0u/vmnet-cli.git
+Project-URL: Issues, https://github.com/fl0l0u/vmnet-cli/issues
+Keywords: vmware,workstation,vmnet,vmnetcfg,network,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Dynamic: license-file
+
+<h1 align="center">
+  <br>
+  vmnet-cli
+  <br>
+</h1>
+
+<h4 align="center">Command-line VMware Workstation Virtual Network Editor — full vmnetcfg.exe parity over the reverse-engineered vnetlib.dll API</h4>
+
+<p align="center">
+  <a href="https://github.com/fl0l0u/vmnet-cli/releases/latest">
+    <img src="https://img.shields.io/github/v/release/fl0l0u/vmnet-cli?style=flat-square&label=release&color=green" alt="Release">
+  </a>
+  <a href="https://pypi.org/project/vmnet-cli/">
+    <img src="https://img.shields.io/pypi/v/vmnet-cli?style=flat-square&color=blue" alt="PyPI">
+  </a>
+  <a href="https://pypi.org/project/vmnet-cli/">
+    <img src="https://img.shields.io/pypi/pyversions/vmnet-cli?style=flat-square" alt="Python Version">
+  </a>
+  <a href="LICENSE">
+    <img src="https://img.shields.io/badge/license-Apache--2.0-blue?style=flat-square" alt="License">
+  </a>
+  <img src="https://img.shields.io/badge/platform-Windows-lightgrey?style=flat-square" alt="Platform">
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#quick-start">Quick Start</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#architecture">Architecture</a> •
+  <a href="#development">Development</a> •
+  <a href="#license">License</a>
+</p>
+
+---
+
+**vmnet-cli** is an **unofficial**, dependency-free CLI clone of VMware
+Workstation's **Virtual Network Editor** (`vmnetcfg.exe`), built directly on
+the reverse-engineered `vnetlib.dll` `VNL_*` API. Manage hostonly, NAT and
+bridged networks, port forwards, DHCP and the virtual adapters — from a
+terminal, elevated, without opening the GUI.
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Full vmnetcfg.exe parity** | Every Virtual Network Editor operation: add/edit/remove networks, bridging, NAT port forwards, DHCP, IP pools |
+| **Two identical implementations** | Native C x64 `.exe` (MinGW-w64, single small binary, no runtime deps) and Python 3 (pure `ctypes`) |
+| **Zero dependencies** | No pip packages, no runtime DLLs — the tool only loads `vnetlib.dll` from your own Workstation install |
+| **Phased batch engine** | Multi-network operations mirror the GUI's Apply machinery exactly: all config changes first, then ONE adapter PnP settle, ONE conf regen, ONE service restart, ONE bridge cycle |
+| **Config backup/restore** | `export` / `import` of the `VMnetConfig` registry hive |
+| **Automation-ready** | `autobridge` with `--dry-run`, idempotent commands, exit codes, scriptable batch mode |
+
+### Command coverage
+
+| Command | Description |
+|---------|-------------|
+| `adapters` | List physical interfaces (VMware adapters filtered out) |
+| `list` | List vmnet segments + features |
+| `add hostonly\|nat\|bridged` | Create a network, optionally pinned to a physical adapter |
+| `edit --vnet N` | Change type, name, subnet, mask, DHCP, NAT, leases, IP pools |
+| `bridged` / `unpin` | Pin a bridge to a physical adapter / drop the binding, keep the network |
+| `set-ip --vnet N` | Set the host adapter IP |
+| `natfw list\|add\|remove` | Manage NAT port forwards |
+| `natcfg show\|set` | Gateway, DNS, timeouts, IPv6, and other NAT/DHCP parameters |
+| `remove --vnet N` | Delete a network entirely (phased batch, `--force` for vmnet1/8) |
+| `clear` / `flush` | Remove EVERY network (`--force`; vmnet0 stays) |
+| `restore-defaults` | Wipe custom nets, recreate vmnet1 + vmnet8 |
+| `autobridge` | Bridge each physical NIC: Ethernet→LAN\<n\>, Wi-Fi→WLAN\<n\> (`--dry-run`) |
+| `export` / `import` | Save / restore the config registry hive |
+
+---
+
+## Installation
+
+> Runs **elevated as an Administrator** on the Windows host where VMware
+> Workstation is installed — same requirement as `vmnetcfg.exe` itself.
+> SYSTEM is **not** needed; the Network Configuration Operators group is
+> **not** sufficient (no service start/stop rights, no `HKLM` writes).
+> On other platforms it exits with a clear error.
+
+### From PyPI
+
+```bash
+pipx install vmnet-cli
+# or
+pip install vmnet-cli
+```
+
+### From GitHub Releases (no Python needed)
+
+Grab `vmnet-cli-windows-x64.exe` from the [latest
+release](https://github.com/fl0l0u/vmnet-cli/releases/latest) — a single self-contained native binary compiled from
+`src/` with MinGW-w64.
+
+### From Source
+
+```bash
+git clone https://github.com/fl0l0u/vmnet-cli.git
+cd vmnet-cli
+pip install -e .
+```
+
+### Verify Installation
+
+```bash
+vmnet-cli --help
+vmnet-cli list
+```
+
+---
+
+## Quick Start
+
+```bash
+# Inspect the current setup
+vmnet-cli list
+vmnet-cli adapters
+
+# Create a host-only network on VMnet2
+vmnet-cli add hostonly --name LAN2 --subnet 192.168.90.0 --mask 255.255.255.0 --vnet 2
+
+# Create a NAT network with a port forward
+vmnet-cli add nat --name NAT2 --vnet 3
+vmnet-cli natfw add --vnet 3 --proto tcp --hport 2222 --vm-ip 192.168.150.5 --vm-port 22 --desc ssh
+
+# Bridge every physical NIC (preview first)
+vmnet-cli autobridge --dry-run
+vmnet-cli autobridge
+
+# Backup before experimenting, restore if it goes sideways
+vmnet-cli export --file backup.xml
+vmnet-cli restore-defaults --force
+vmnet-cli import --file backup.xml
+```
+
+---
+
+## Usage
+
+### Command overview
+
+```
+adapters | list | add hostonly|nat|bridged | edit | bridged | unpin
+set-ip | natfw list|add|remove | natcfg show|set | export | import
+remove [--vnet N]...  |  clear|flush --force  |  restore-defaults --force
+autobridge [--dry-run]
+```
+
+Multi-network operations (`remove` with repeated `--vnet`, `clear`,
+`restore-defaults`) run in **phases** exactly like the GUI's Apply machinery:
+all config changes first, then ONE adapter PnP settle wait, ONE conf regen,
+ONE service restart, ONE bridge cycle.
+
+---
+
+## Architecture
+
+### C layout (`src/`)
+
+| File | Responsibility |
+|------|----------------|
+| `vmnet.h` | shared types, constants, all prototypes; states the two ABI invariants |
+| `util.c` | `die`, string/subprocess glue, privileges, shared constants |
+| `vnl.c` | `vnetlib.dll` loading + the VNL calling layer (`vlstr` lives here) |
+| `registry.c` | `VMnetConfig` database + `VMnetBridge` adapter-pin table |
+| `services.c` | VMnetDHCP / VMnetNAT / VMnetBridge control via the SCM |
+| `adapters.c` | virtual-NIC enumeration, physical classification, PnP install/remove |
+| `batch.c` | the stage/apply batch context (`remove_stage`, `batch_apply`) |
+| `args.c` | argv accessors (`opt_str`, `opt_flag`, `parse_vnet`) |
+| `cmds_topo.c` | adapters, list, add, edit, bridged, unpin, autobridge |
+| `cmds_cfg.c` | set-ip, export, import, natfw, natcfg |
+| `cmds_remove.c` | remove, clear/flush, restore-defaults |
+| `main.c` | command dispatch |
+
+### Python layout (`vmnet_cli/`)
+
+Same module boundaries: `vnl` / `registry` / `services` / `adapters` / `conf` /
+`batch` / `commands` / `commands_nat` / `cli` (argparse + dispatch). Imports
+flow one way:
+
+```
+cli → commands → batch → {adapters, conf, services} → {vnl} → registry
+```
+
+---
+
+## Development
+
+### Non-negotiable API invariants (from RECON.md)
+
+`RECON.md` is the authoritative record of everything learned about the API —
+read it before changing anything that touches `VNL_*`.
+
+1. **Fixed-width string args.** vnetlib zero-pads string arguments ~260 bytes
+   IN PLACE. In C every VNL string arg goes through `vlstr()` (512-byte
+   scratch); in Python `_c` wraps every bytes/str arg in a roomy buffer.
+   Never pass a literal, stack array, or tight `.encode()` bytes to VNL_*.
+2. **rc semantics.** Most calls return `1` = success. `VNL_GetVNetFeatures`
+   returns `rc=0` (output untouched) when the vnet is absent; getters may not
+   write their out-buffer at all — out buffers must be big and pre-zeroed.
+3. **`VNL_SetNATParam` crashes.** NAT settings go to the registry;
+   `VNL_UpdateNATFromConfig` renders them.
+4. **Concurrency.** Never leave a looping vnetlib process running; vnetlib
+   serializes on an internal lock and will starve other callers.
+5. **vmnet0** is the bridge driver's auto segment: never removable, never
+   re-typeable, never explicitly pinned. vmnet1/vmnet8 removal needs `--force`.
+6. **Out-of-range `--vnet`** values are refused up front: vnetlib *clamps*
+   oversized indices when reading another segment's features (setters do
+   validate), so every `--vnet` goes through `require_vnet()` / `require_vnet`.
+
+### Build & test
+
+Everything is built ON the Windows test box (no cross toolchain needed for
+development). Style and static checks are enforced by the `lint` CI job:
+`clang-format` (config in `.clang-format`, pinned version — hand-aligned blocks
+are guarded with `clang-format off` regions), `cppcheck`, and `ruff`
+(`pipx run ruff format .` locally). Test scripts talk to a Windows test box; point them at yours
+with the `VMNET_TEST_BOX` / `VMNET_TEST_USER` / `VMNET_TEST_PW` environment
+variables (`tools/deploy.py`, `tests/test_vmnet_cli.py`, `tools/fuzz.py`).
+
+```bash
+python tools/deploy.py                                # uploads src/ + vmnet_cli/, compiles exe
+VMNET_TOOL=exe .venv/bin/python tests/test_vmnet_cli.py   # 89-check e2e suite (exit = fails)
+```
+
+`tools/deploy.py` writes `C:\ludus\vmnet-cli.exe` from `C:\ludus\src\*.c` with the
+portable MinGW at `C:\Temp\mingw64`, and stages the Python package at
+`C:\ludus\vmnet_cli\` behind launcher `C:\ludus\vmnet-cli.py`.
+
+Releases are built by [`.github/workflows/release.yml`](.github/workflows/release.yml):
+pushing a `v*` tag publishes the wheel + sdist and the cross-compiled
+`vmnet-cli-windows-x64.exe` as a GitHub release (and to PyPI via trusted
+publishing).
+
+### Repo layout
+
+| Path | Contents |
+|------|----------|
+| `src/` | native C implementation |
+| `vmnet_cli/` | Python package (launcher: `tools/vmnet-cli.py`) |
+| `RECON.md` | the vnetlib.dll reverse-engineering record |
+| `analysis/` | static-analysis scripts used for RECON.md (run against your own local copies of vmnetcfg.exe / vnetlib.dll; the binaries and their derived dumps are proprietary and not in this repo) |
+| `legacy/` | original single-file implementations, for reference |
+| `deploy.py` / `test_vmnet_cli.py` / `fuzz.py` | test-box deploy + e2e suite + fuzzing |
+
+---
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE) - see the [LICENSE](LICENSE)
+file for details.
+
+vmnet-cli is an independent project and contains **no VMware code or
+binaries**; it drives `vnetlib.dll` from the user's own installed copy of
+VMware Workstation. It is not affiliated with, sponsored by, or endorsed by
+VMware or Broadcom. VMware and VMware Workstation are trademarks of their
+respective owners.
+
+---
+
+## Credits & References
+
+- Target application: VMware Workstation's Virtual Network Editor
+  (`vmnetcfg.exe`) and its `vnetlib.dll` `VNL_*` API
+- [`RECON.md`](RECON.md) — full API reverse engineering (static analysis of
+  Workstation 26H1, build 25688693)