{"id":20589659,"url":"https://github.com/coreos/vmw_backdoor-rs","last_synced_at":"2025-07-01T09:39:02.379Z","repository":{"id":52794027,"uuid":"249049627","full_name":"coreos/vmw_backdoor-rs","owner":"coreos","description":"A pure-Rust library for VMware host-guest protocol (\"VMXh backdoor\")","archived":false,"fork":false,"pushed_at":"2025-03-19T16:30:10.000Z","size":88,"stargazers_count":16,"open_issues_count":3,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-20T08:07:43.325Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.rs/vmw_backdoor","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coreos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE-2.0","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-21T19:50:52.000Z","updated_at":"2025-03-19T16:30:15.000Z","dependencies_parsed_at":"2025-04-09T16:06:12.472Z","dependency_job_id":"237ba76f-e4ef-4bd9-a8a3-f31fd6ef7859","html_url":"https://github.com/coreos/vmw_backdoor-rs","commit_stats":{"total_commits":31,"total_committers":2,"mean_commits":15.5,"dds":"0.16129032258064513","last_synced_commit":"e7cace47201a092fa4b1bfa964cbbee738ca3d04"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/coreos/vmw_backdoor-rs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fvmw_backdoor-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fvmw_backdoor-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fvmw_backdoor-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fvmw_backdoor-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coreos","download_url":"https://codeload.github.com/coreos/vmw_backdoor-rs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fvmw_backdoor-rs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261372970,"owners_count":23148910,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T07:30:14.971Z","updated_at":"2025-07-01T09:39:02.313Z","avatar_url":"https://github.com/coreos.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vmw\\_backdoor\n\n[![crates.io](https://img.shields.io/crates/v/vmw_backdoor.svg)](https://crates.io/crates/vmw_backdoor)\n[![Documentation](https://docs.rs/vmw_backdoor/badge.svg)](https://docs.rs/vmw_backdoor)\n\nA pure-Rust library for VMware host-guest protocol (\"VMXh backdoor\").\n\nThis library provides helpers to access and use the VMware backdoor from a\nguest VM. It allows bi-directional interactions with the VMWare hypervisor\nand host environment.\n\nThe \"backdoor\" protocol does not have official specifications, but it has been\nwidely analyzed and there are multiple projects documenting it:\n  1. [https://github.com/vmware/open-vm-tools/blob/stable-11.0.5/open-vm-tools/lib/include/backdoor_def.h][1]\n  2. [https://wiki.osdev.org/VMware_tools][2]\n  3. [https://sysprogs.com/legacy/articles/kdvmware/guestrpc.shtml][3]\n  4. [https://github.com/vmware/vmw-guestinfo/tree/master/bdoor][4]\n  5. [https://sites.google.com/site/chitchatvmback/backdoor][5]\n\n[1]: https://github.com/vmware/open-vm-tools/blob/stable-11.0.5/open-vm-tools/lib/include/backdoor_def.h\n[2]: https://wiki.osdev.org/VMware_tools\n[3]: https://sysprogs.com/legacy/articles/kdvmware/guestrpc.shtml\n[4]: https://github.com/vmware/vmw-guestinfo/tree/master/bdoor\n[5]: https://sites.google.com/site/chitchatvmback/backdoor\n\n## Example\n\n```rust\nlet is_vmw = vmw_backdoor::is_vmware_cpu();\nprintln!(\"VMware CPU detected: {}.\", is_vmw);\n\nlet mut guard = vmw_backdoor::access_backdoor().unwrap();\nprintln!(\"Raised I/O access to reach backdoor port.\");\n\nlet found = guard.probe_vmware_backdoor().unwrap_or(false);\nprintln!(\"VMware backdoor detected: {}.\", found);\n\nlet mut erpc = guard.open_enhanced_chan().unwrap();\nlet key = \"guestinfo.ignition.config.data\";\nlet guestinfo = erpc.get_guestinfo(key.as_bytes()).unwrap();\n\nif let Some(val) = guestinfo {\n    println!(\"Got value for key '{}':\", key);\n    println!(\"{}\", String::from_utf8_lossy(\u0026val));\n};\n```\n\nSome more examples are available under [examples](examples).\n\n## License\n\nLicensed under either of\n\n * MIT license - \u003chttp://opensource.org/licenses/MIT\u003e\n * Apache License, Version 2.0 - \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e\n\nat your option.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fvmw_backdoor-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoreos%2Fvmw_backdoor-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fvmw_backdoor-rs/lists"}