{"id":13540369,"url":"https://github.com/hatching/vmcloak","last_synced_at":"2026-01-18T09:05:50.651Z","repository":{"id":15646135,"uuid":"18383293","full_name":"hatching/vmcloak","owner":"hatching","description":"Automated Virtual Machine Generation and Cloaking for Cuckoo Sandbox.","archived":false,"fork":false,"pushed_at":"2024-05-14T08:41:59.000Z","size":7820,"stargazers_count":498,"open_issues_count":65,"forks_count":124,"subscribers_count":40,"default_branch":"main","last_synced_at":"2025-03-04T07:38:37.676Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hatching.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.txt","contributing":null,"funding":null,"license":null,"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":"2014-04-02T22:12:11.000Z","updated_at":"2025-02-24T09:08:12.000Z","dependencies_parsed_at":"2024-06-21T17:53:16.535Z","dependency_job_id":null,"html_url":"https://github.com/hatching/vmcloak","commit_stats":{"total_commits":870,"total_committers":32,"mean_commits":27.1875,"dds":"0.47011494252873565","last_synced_commit":"dc9e513692bc12b05d3912d9f802ffc0548cb24c"},"previous_names":[],"tags_count":66,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hatching%2Fvmcloak","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hatching%2Fvmcloak/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hatching%2Fvmcloak/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hatching%2Fvmcloak/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hatching","download_url":"https://codeload.github.com/hatching/vmcloak/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246774396,"owners_count":20831531,"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-08-01T09:01:47.814Z","updated_at":"2026-01-18T09:05:50.630Z","avatar_url":"https://github.com/hatching.png","language":"Python","readme":"VMCloak\n=======\n\nAutomated Virtual Machine Generation and Cloaking for Cuckoo Sandbox.\n\nIntroduction\n------------\n\nVMCloak is a tool to fully create and prepare Virtual Machines that can be\nused by Cuckoo Sandbox. In order to create a new Virtual Machine one should\nprepare a few configuration values that will be used later on by the tool.\n\nDependencies\n------------\n\nIn order to run VMCloak you'll at the very least require the following:\n\n* Python 3.6 or higher.\n* mkisofs *or* genisoimage.\n* QEMU 2.11 or higher (tested with 4.2.1).\n* **root** access to mount images and perform actions such as creating network bridges.\n\n\nInstallation\n------------\n\nIt is recommended that VMCloak is installed in a Virtualenv and on the user\nthat should own the created virtual machines.\n\nVMCloak is available as a [Python Package](\u003chttps://pypi.python.org/pypi/vmcloak\u003e)\nIt can be installed with ``pip`` using ``pip install -U vmcloak``.\n\nInstall the requirements. See the docs/ for a full list of requirements.\n\n```bash\n$ sudo apt update\n$ sudo apt install python3 genisoimage qemu-system-x86 qemu-utils qemu-system-common\n```\n\n\nIt is recommended to install VMCloak in a virtualenv.\n\n```bash\n$ virtualenv venv\n$ source venv/bin/activate\n$ (venv) pip install -U vmcloak\n```\n\nFetching the [Git repository](\u003chttps://github.com/hatching/vmcloak\u003e)  through allows one access to the latest\ndevelopment version of VMCloak with features that may not have been pushed to\nthe Python Package yet. A full example of installing VMCloak manually can be\nas follows:\n\n```bash\n$ (venv) git clone https://github.com/hatching/vmcloak.git\n$ (venv) cd vmcloak\n$ (venv) pip install .\n```\n\nDocs\n----\n\n```bash\n$ (venv) pip install -e .[docs]\n$ (venv) cd docs\n$ (venv) make html\n$ (venv) \u003cyour browser\u003e/_build/html/index.html\n```\n\n\u003c!--\nUsage\n-----\n\nFor a quick walkthrough on the general usage of VMCloak, please refer to the\nfollowing blogpost: [http://jbremer.org/vmcloak3][blogpost].\n\n[blogpost]: http://jbremer.org/vmcloak3\n\n---\u003e\n\u003c!---\nTesting\n-------\n\nIn order to run the VMCloak unit tests, which should be run on a custom build\nserver due to its huge resource requirements (i.e., setting up multiple\nvirtual machines is not something to take lightly), we provide some pointers\nfor setting up such an environment.\n\nFirst of all, the _~/.vmcloak/config.json_ should be created containing a JSON\nblob with, currently, one value. The _winxp.serialkey_ value should be\nfeatured with a serial key that matches your Windows XP ISO file. An example\nconfig.json file may look as follows.\n\n```javascript\n{\n    \"winxp\": {\n        \"serialkey\": \"windows xp serial key here\"\n    }\n}\n```\n\nThen install _pytest_ and _pytest-xdist_:\n\n```bash\n$ pip install -U pytest pytest-xdist\n```\n\nMount all of the ISO files as required, for a default configuration this looks\nas follows (the following commands should be run as _root_ user):\n\n```bash\n$ mkdir /mnt/winxp\n$ mount -o loop,ro vms/winxppro.iso /mnt/winxp\n\n$ mkdir /mnt/win7x64\n$ mount -o loop,ro vms/win7ultimate.iso /mnt/win7x64\n\n$ mkdir /mnt/win81x64\n$ mount -o loop,ro vms/Win8.1_EnglishInternational_x64.iso /mnt/win81x64\n\n$ mkdir /mnt/win10x64\n$ mount -o loop,ro vms/Win10_1511_2_EnglishInternational_x64.iso /mnt/win10x64\n```\n\nNow we're going to run the actual unit tests. Note that we can speed them up\nby specifying N unit tests to be ran in parallel. As most of the tests\nactually install Windows or run a virtual machine, we recommend to run at most\none unit test per CPU core. Also reserve about two to four gigabytes of RAM\nfor each extra unit test in parallel. E.g., if you want to run four unit tests\nin parallel, then your computer should have at least four CPU cores and 16GB\nof RAM.\n\nFinally run the unit tests:\n\n```bash\npy.test -n 8\n```\n---\u003e\nCredits\n-------\n\nThe development of the VMCloak project initially started out as part of the\nITES Project at Avira, thanks to **Thorsten Sick**. Many thanks to\n**Rasmus Männa** for lots of great contributions lately.\n\n\n\u003c!---\n[![Coverage Status](https://coveralls.io/repos/github/jbremer/vmcloak/badge.svg)](https://coveralls.io/github/jbremer/vmcloak)\n---\u003e\n","funding_links":[],"categories":["\u003ca id=\"a2df15c7819a024c2f5c4a7489285597\"\u003e\u003c/a\u003e密罐\u0026\u0026Honeypot","Honeypots","\u003ca id=\"5830a8f8fb3af1a336053d84dd7330a1\"\u003e\u003c/a\u003e工具"],"sub_categories":["\u003ca id=\"2af349669891f54649a577b357aa81a6\"\u003e\u003c/a\u003e未分类-Honeypot","\u003ca id=\"f2b5c44c2107db2cec6c60477c6aa1d0\"\u003e\u003c/a\u003e新添加的"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhatching%2Fvmcloak","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhatching%2Fvmcloak","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhatching%2Fvmcloak/lists"}