From 6383c9e203a480778c354fb5b9d3a3e4922a39a7 Mon Sep 17 00:00:00 2001 From: sickcodes Date: Tue, 15 Jun 2021 13:49:22 +0000 Subject: [PATCH] Update documentation regarding v11 to v12 --- README.md | 129 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 122 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0c0799f..f764aed 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,29 @@ ![Running mac osx in a docker container](/running-mac-inside-docker-qemu.png?raw=true "OSX KVM DOCKER") -Generate macOS valid serials, uuids, and board serials for good-faith security research. +Generate macOS valid serials, uuids, and board serials for good-faith Security Research & Apple Bug Bounty Research. This project provides two tools for generating serial numbers for Hackintosh, [OpenCore](https://github.com/acidanthera/OpenCorePkg), [Docker-OSX](https://github.com/sickcodes/Docker-OSX) and [OSX-KVM](https://github.com/kholia/OSX-KVM). -Author: Sick.Codes https://sick.codes/ & https://twitter.com/sickcodes +Author: Sick.Codes https://github.com/sickcodes | https://sick.codes | https://twitter.com/sickcodes ### Follow @sickcodes on Twitter for updates! [https://twitter.com/sickcodes](https://twitter.com/sickcodes) -Terms & Conditions: Serial numbers are an important part of conducting iMessage security research and finding vulnerabilities in software prior to Bad Actors, therefore, you must agree to [Apple's Security Bounty program](https://developer.apple.com/security-bounty/requirements/). +Terms & Conditions: Manipulation of serial numbers are an important aspect of conducting Cyber Security Research into the iMessage & Facetime frameworks. Finding and reporting vulnerabilities in Apple software before Threat Actors do is important. To use this project to find & discover vulnerabilities in said protocols, you should agree to [Apple's Security Bounty program](https://developer.apple.com/security-bounty/requirements/). ### Upstream Thanks -This project is a wrapper for the OpenCore bootloader's fantastic tool [macserial](https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macserial). +This project was created for use with [Docker-OSX](https://github.com/sickcodes/Docker-OSX) and uses `config.plist` files from [@Kholia](https://github.com/kholia)'s project https://github.com/kholia/OSX-KVM. -Many thanks to the OpenCore Project for providing `macserial`. +The `config.plist` files are also curated and maintained upstream by [@thenickdude](https://github.com/thenickdude) and we thank both of them for their excellent work. Upstream KVM changes are made at: [https://github.com/thenickdude/KVM-Opencore](https://github.com/thenickdude/KVM-Opencore) + +This project is a wrapper for the [OpenCore project](https://dortania.github.io/getting-started/) bootloader's fantastic tool called [macserial](https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macserial). + +Many thanks to the [OpenCore Project](https://dortania.github.io/getting-started/) for providing `macserial`. See the project which drives Hackintosh: [https://github.com/acidanthera/OpenCorePkg](https://github.com/acidanthera/OpenCorePkg) +As seen on Vice: [Open-Source App Lets Anyone Create a Virtual Army of Hackintoshes](https://www.vice.com/en/article/akdmb8/open-source-app-lets-anyone-create-a-virtual-army-of-hackintoshes) ### PR & Contributor Credits @@ -29,21 +34,23 @@ https://github.com/sickcodes/osx-serial-generator/blob/master/CREDITS.md - [Docker-OSX](https://github.com/sickcodes/Docker-OSX) - [OSX-KVM](https://github.com/kholia/OSX-KVM) +- [KVM-Opencore](https://github.com/thenickdude/KVM-Opencore) - [OpenCore](https://github.com/acidanthera/OpenCorePkg) - [Hackintosh](https://www.reddit.com/r/hackintosh/) # Purpose -These script were written by [@sickcodes](https://github.com/sickcodes) [https://twitter.com/sickcodes](https://twitter.com/sickcodes) for automating generating unique values at runtime in [Docker-OSX](https://github.com/sickcodes/Docker-OSX). +These shell scripts were written by [@sickcodes](https://github.com/sickcodes) [https://twitter.com/sickcodes](https://twitter.com/sickcodes) and were created for automating the generation of unique & valid values at runtime in [Docker-OSX](https://github.com/sickcodes/Docker-OSX). This is for generating sets of serial numbers that simply work. -If this is your first time, just run the first command below, without any options, and you will be given 1 complete set. +If this is your first time, just `bash ./generate-unique-machine-values.sh` and you will be given 1 complete serial number set. With your new serial numbers, you can: - put them in your existing `config.plist` and reboot - tell the script to make a new `OpenCore.qcow2` - output as TSV and CSV, and more! +- use `--help` to see all available goodies Used at runtime in [Docker-OSX](https://github.com/sickcodes/Docker-OSX). @@ -51,6 +58,8 @@ Used at runtime in [Docker-OSX](https://github.com/sickcodes/Docker-OSX). - [https://github.com/sickcodes/Docker-OSX](https://github.com/sickcodes/Docker-OSX): "Run Mac in a Docker! Run near native OSX-KVM in Docker! X11 Forwarding! CI/CD for OS X!" +- [https://github.com/thenickdude/KVM-Opencore](https://github.com/thenickdude/KVM-Opencore): "OpenCore disk image for Proxmox/QEMU" + # Requirements ```bash @@ -273,3 +282,109 @@ In the case example of why these scripts were written is: --height "${HEIGHT:-1080}" \ --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" ``` + + +# Special Update Notes + + + +----------------- + +2021-05-04 - On May 4th 2021 we updated from v11 to v12 via [@thenickdude](https://github.com/thenickdude)'s upstream `config.plist` files from [KVM-Opencore](https://github.com/thenickdude/KVM-Opencore). + +As seen in a PR to OSX-KVM upstream: [https://github.com/kholia/OSX-KVM/pull/173](https://github.com/kholia/OSX-KVM/pull/173) + +```bash +wget https://github.com/thenickdude/KVM-Opencore/compare/v11...v12.patch + +patch -F 10 -p1 --verbose config-nopicker-custom.plist v11...v12.patch + +patch -F 10 -p1 --verbose config-custom.plist v11...v12.patch +``` + +Rejected patch lines: +```patch +--- EFI/OC/config.plist ++++ EFI/OC/config.plist +@@ -224,17 +344,17 @@ + + + Base +- ++ \_SB.PCI0.LPCB.HPET + BaseSkip + 0 + Comment +- _Q12 to XQ12 ++ HPET _CRS to XCRS + Count + 1 + Enabled + + Find +- X1ExMg== ++ X0NSUw== + Limit + 0 + Mask +@@ -1056,9 +1302,9 @@ + AppleEvent + Builtin + CustomDelays +- Auto ++ + KeyInitialDelay +- 0 ++ 50 + KeySubsequentDelay + 5 + PointerSpeedDiv +--- src/OpenCorePkg ++++ src/OpenCorePkg +@@ -1 +1 @@ +-Subproject commit 5cd223f03dd555c2ad0c6f45181808a5105bb605 ++Subproject commit 5668fb62b50e8141d93ae6fce3e3fe238822f6ef +``` + + + +Replaced +```xml + Comment + _Q12 to XQ12 + +``` +with +```xml + Base + \_SB.PCI0.LPCB.HPET + BaseSkip + 0 + Comment + HPET _CRS to XCRS +``` + +and +```diff +- X1ExMg== ++ X0NSUw== +``` + + +Ignored: +```diff +@@ -1056,9 +1302,9 @@ + AppleEvent + Builtin + CustomDelays +- Auto ++ + KeyInitialDelay +- 0 ++ 50 + KeySubsequentDelay + 5 + PointerSpeedDiv +``` + +----------------- \ No newline at end of file