diff --git a/.github/ISSUE_TEMPLATE/issue-running-docker-osx.md b/.github/ISSUE_TEMPLATE/issue-running-docker-osx.md new file mode 100644 index 0000000..1d266c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-running-docker-osx.md @@ -0,0 +1,26 @@ +--- +name: Issue Running Docker-OSX +about: OS related issued, please help us identify the issue by posting the output + of this +title: '' +labels: '' +assignees: '' + +--- + +# OS related issued, please help us identify the issue by posting the output of this +uname -a \ +; echo "${DISPLAY}" \ +; echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs \ +; grep NAME /etc/os-release \ +; df -h . \ +; qemu-system-x86_64 --version \ +; libvirtd --version \ +; free -mh \ +; nproc \ +; egrep -c '(svm|vmx)' /proc/cpuinfo \ +; ls -lha /dev/kvm \ +; ls -lha /tmp/.X11-unix/ \ +; ps aux | grep dockerd \ +; docker ps | grep osx \ +; grep "docker\|kvm\|virt" /etc/group diff --git a/.github/ISSUE_TEMPLATE/open-an-issue.md b/.github/ISSUE_TEMPLATE/open-an-issue.md new file mode 100644 index 0000000..a6a1892 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/open-an-issue.md @@ -0,0 +1,10 @@ +--- +name: Open an Issue +about: About anything! +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..66e60a1 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "osx-serial-generator"] + path = osx-serial-generator + url = https://github.com/sickcodes/osx-serial-generator.git diff --git a/CHANGELOG.md b/CHANGELOG.md index f8d9df2..fa95f9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ |Version|Date|Notes| |---|---|---| +| |2021-04-18|Add LIBGUESTFS debug & trace commands, exit on fail when creating bootdisks. Silence touch errors.| +|4.3|2021-03-24|Enable interactive QEMU again. Remove envsubst since we are already using bash... Add set -x flag| +|4.2|2021-03-24|Add all ENV variables to each dockerfile for readability. Add RAM allocation buffer and cache drop bug fix. Add kvm and libvirt groups. Add `IMAGE_FORMAT=qcow2` to allow `IMAGE_FORMAT=raw` too.| +| |2021-03-19|Use RAM=3 as the default RAM allocation. Add instructions to clear buff/cache.| +| |2021-03-17|Add RAM=max and RAM=half to dynamically select ram at runtime (DEFAULT).| +| |2021-03-06|Change envs to require --envs. Automatically enable --envs if --output-env is used. Same for plists, bootdisks. Fix help ugliness and sanity of generate serial scripts. Fix bootdisk not getting written to persistent file when using NOPICKER=true. NOPICKER=true is overridden by a custom plist now anyway. Remove useless case statements. Allow -e HEADLESS=true as human readable alternative to -e DISPLAY=:99.| +|4.1|2021-03-04|Add `-e MASTER_PLIST_URL` to all images to allow using your own remote plist.| +| |2021-03-03|Add `WIDTH` and `HEIGHT` to set the x and y resolutions, use in conjuction with serial numbers.| +| |2021-03-02|Add ADDITIONAL_PORTS, for example `-e ADDITIONAL_PORTS='hostfwd=tcp::23-:23,'`| |4.0|2021-02-27|Add big-sur support. Use `sickcodes/docker-osx:big-sur` or build using `--build-arg VERSION=11`| | |2021-02-26|Change `-e NOPICKER=true` to simply do `sed -i '/^.*InstallMedia.*/d' Launch.sh` and `export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2`.| |3.2|2021-02-25|Add a script to generate unique machine serial numbers. Add a script to generate a bootdisk from given serial numbers. Add Linux for libguestfs which allows the docker container to make QEMU bootdisks with specific serial numbers.| diff --git a/CREDITS.md b/CREDITS.md index 82f579a..7a78a67 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,8 +1,16 @@ # Credits -The upstream credits are available at [@Kholia](https://github.com/Kholia)'s repo https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md +## Upstream Acknowledgements: -These credits refer to the contributors to this repository: +This project uses OSX-KVM from https://github.com/kholia/OSX-KVM and fully appreciates the work done by [@Kholia](https://github.com/Kholia) and all the contributors who are listed: [https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md](https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md) + +This project also uses KVM-OpenCore from https://github.com/Leoyzen/KVM-Opencore and fully appreciates the work done by [@Leoyzen](https://github.com/Leoyzen). + +We use a special fork by [Nicholas Sherlock](https://www.nicksherlock.com/) of KVM-Opencore https://github.com/thenickdude/KVM-Opencore and thank Nick for his awesome upstream work! + +This project now uses the fantastic OpenCore bootloader from the community OpenCore project: https://github.com/acidanthera/OpenCorePkg. You can join their [Subreddit here](https://www.reddit.com/r/hackintosh/)! + +## These credits refer to the contributors to this repository: [@GreeFine](https://github.com/GreeFine) - Readme Typo #9 @@ -56,3 +64,18 @@ These credits refer to the contributors to this repository: [@MrBenFTW](https://github.com/MrBenFTW) - Tempfix for arch #150 +[@edsonboldrini](https://github.com/edsonboldrini) - Update README.md #161 + +[@TheHackerCoding](https://github.com/TheHackerCoding) - Typo in README.md #194 + +[@panos](https://github.com/panos) - Improved README #212 + +[@ggjulio](https://github.com/ggjulio) - Restarting an "auto" container #216 + +[@panos](https://github.com/panos) - Made further improvements to the README #219 + +[@a10kiloham](https://github.com/a10kiloham) - Dockerfile for :naked image with VNC support #245 + +[@a10kiloham](https://github.com/a10kiloham) - Adding Bluebubbles as an example use case #250 + +[@aronzvi](https://github.com/aronzvi) - Fixed Failed to boot OSX with GENERATE_UNIQUE #244 diff --git a/Dockerfile b/Dockerfile index 707f1ba..c8c01d6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,11 +5,12 @@ # / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | # /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| # -# Repo: https://github.com/sickcodes/Docker-OSX/ -# Title: Mac on Docker (Docker-OSX) -# Author: Sick.Codes https://sick.codes/ -# Version: 4.0 +# Title: Docker-OSX (Mac on Docker) +# Author: Sick.Codes https://twitter.com/sickcodes +# Version: 4.3 # License: GPLv3+ +# Repository: https://github.com/sickcodes/Docker-OSX +# Website: https://sick.codes # # All credits for OSX-KVM and the rest at @Kholia's repo: https://github.com/kholia/osx-kvm # OpenCore support go to https://github.com/Leoyzen/KVM-Opencore @@ -113,7 +114,7 @@ RUN tee -a sshd_config <<< 'AllowTcpForwarding yes' \ USER arch # download OSX-KVM -RUN git clone --depth 1 https://github.com/kholia/OSX-KVM.git /home/arch/OSX-KVM +RUN git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git /home/arch/OSX-KVM # enable ssh # docker exec .... ./enable-ssh.sh @@ -146,6 +147,8 @@ RUN yes | sudo pacman -Syu qemu libvirt dnsmasq virt-manager bridge-utils openre WORKDIR /home/arch/OSX-KVM +RUN wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/fetch-macOS.py + RUN [[ "${VERSION%%.*}" -lt 11 ]] && { python fetch-macOS.py --version "${VERSION}" \ && qemu-img convert BaseSystem.dmg -O qcow2 -p -c BaseSystem.img \ && qemu-img create -f qcow2 mac_hdd_ng.img "${SIZE}" \ @@ -164,9 +167,6 @@ RUN [[ "${VERSION%%.*}" -ge 11 ]] && { wget "${FETCH_MAC_OS_RAW}" \ && rm -f BaseSystem.dmg \ ; } || true -# > Launch.sh -# > Docker-OSX.xml - WORKDIR /home/arch/OSX-KVM ARG LINUX=true @@ -176,20 +176,30 @@ RUN if [[ "${LINUX}" == true ]]; then \ sudo pacman -Syu linux libguestfs --noconfirm \ ; fi +# TEMP-FIX for file 5.40 libguestfs issue +RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \ + && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for file 5.40 libguestfs issue + # optional --build-arg to change branches for testing ARG BRANCH=master ARG REPO='https://github.com/sickcodes/Docker-OSX.git' -RUN git clone --branch "${BRANCH}" "${REPO}" +RUN git clone --recurse-submodules --depth 1 --branch "${BRANCH}" "${REPO}" RUN touch Launch.sh \ && chmod +x ./Launch.sh \ - && tee -a Launch.sh <<< '#!/bin/sh' \ - && tee -a Launch.sh <<< 'set -eu' \ + && tee -a Launch.sh <<< '#!/bin/bash' \ + && tee -a Launch.sh <<< 'set -eux' \ && tee -a Launch.sh <<< 'sudo chown $(id -u):$(id -g) /dev/kvm 2>/dev/null || true' \ && tee -a Launch.sh <<< 'sudo chown -R $(id -u):$(id -g) /dev/snd 2>/dev/null || true' \ - && tee -a Launch.sh <<< 'exec qemu-system-x86_64 -m ${RAM:-8}000 \' \ + && tee -a Launch.sh <<< '[[ "${RAM}" = max ]] && export RAM="$(("$(head -n1 /proc/meminfo | tr -dc "[:digit:]") / 1000000"))"' \ + && tee -a Launch.sh <<< '[[ "${RAM}" = half ]] && export RAM="$(("$(head -n1 /proc/meminfo | tr -dc "[:digit:]") / 2000000"))"' \ + && tee -a Launch.sh <<< 'sudo chown -R $(id -u):$(id -g) /dev/snd 2>/dev/null || true' \ + && tee -a Launch.sh <<< 'exec qemu-system-x86_64 -m ${RAM:-2}000 \' \ && tee -a Launch.sh <<< '-cpu Penryn,vendor=GenuineIntel,+invtsc,vmware-cpuid-freq=on,+pcid,+ssse3,+sse4.2,+popcnt,+avx,+aes,+xsave,+xsaveopt,check \' \ - && tee -a Launch.sh <<< '-machine q35,accel=kvm:tcg \' \ + && tee -a Launch.sh <<< '-machine q35,${KVM-"accel=kvm:tcg"} \' \ && tee -a Launch.sh <<< '-smp ${CPU_STRING:-${SMP:-4},cores=${CORES:-4}} \' \ && tee -a Launch.sh <<< '-usb -device usb-kbd -device usb-tablet \' \ && tee -a Launch.sh <<< '-device isa-applesmc,osk=ourhardworkbythesewordsguardedpleasedontsteal\(c\)AppleComputerInc \' \ @@ -202,10 +212,10 @@ RUN touch Launch.sh \ && tee -a Launch.sh <<< '-device ide-hd,bus=sata.2,drive=OpenCoreBoot \' \ && tee -a Launch.sh <<< '-device ide-hd,bus=sata.3,drive=InstallMedia \' \ && tee -a Launch.sh <<< '-drive id=InstallMedia,if=none,file=/home/arch/OSX-KVM/BaseSystem.img,format=qcow2 \' \ - && tee -a Launch.sh <<< '-drive id=MacHDD,if=none,file=${IMAGE_PATH:-/home/arch/OSX-KVM/mac_hdd_ng.img},format=qcow2 \' \ + && tee -a Launch.sh <<< '-drive id=MacHDD,if=none,file=${IMAGE_PATH:-/home/arch/OSX-KVM/mac_hdd_ng.img},format=${IMAGE_FORMAT:-qcow2} \' \ && tee -a Launch.sh <<< '-device ide-hd,bus=sata.4,drive=MacHDD \' \ - && tee -a Launch.sh <<< '-netdev user,id=net0,hostfwd=tcp::${INTERNAL_SSH_PORT:-10022}-:22,hostfwd=tcp::${SCREEN_SHARE_PORT:-5900}-:5900, \' \ - && tee -a Launch.sh <<< '-device ${NETWORKING:-e1000-82545em},netdev=net0,id=net0,mac=${MAC_ADDRESS:-52:54:00:09:49:17} \' \ + && tee -a Launch.sh <<< '-netdev user,id=net0,hostfwd=tcp::${INTERNAL_SSH_PORT:-10022}-:22,hostfwd=tcp::${SCREEN_SHARE_PORT:-5900}-:5900,${ADDITIONAL_PORTS} \' \ + && tee -a Launch.sh <<< '-device ${NETWORKING:-vmxnet3},netdev=net0,id=net0,mac=${MAC_ADDRESS:-52:54:00:09:49:17} \' \ && tee -a Launch.sh <<< '-monitor stdio \' \ && tee -a Launch.sh <<< '-vga vmware \' \ && tee -a Launch.sh <<< '${EXTRA:-}' @@ -221,21 +231,50 @@ USER arch ENV USER arch -ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 +#### SPECIAL RUNTIME ARGUMENTS BELOW + +# env -e ADDITIONAL_PORTS with a comma +# for example, -e ADDITIONAL_PORTS=hostfwd=tcp::23-:23, +ENV ADDITIONAL_PORTS= + +ENV BOOTDISK= ENV DISPLAY=:0.0 ENV ENV=/env +# Boolean for generating a bootdisk with new random serials. +ENV GENERATE_UNIQUE=false + +# Boolean for generating a bootdisk with specific serials. +ENV GENERATE_SPECIFIC=false + ENV IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img +ENV IMAGE_FORMAT=qcow2 -ENV NETWORKING=e1000-82545em -# ENV NETWORKING=vmxnet3 +ENV KVM='accel=kvm:tcg' +ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist" + +# ENV NETWORKING=e1000-82545em +ENV NETWORKING=vmxnet3 + +# boolean for skipping the disk selection menu at in the boot process ENV NOPICKER=false -ENV UNIQUE=false -# Boolean for generating a bootdisk with new serials. +# dynamic RAM options for runtime +ENV RAM=3 +# ENV RAM=max +# ENV RAM=half + +# The x and y coordinates for resolution. +# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true. +ENV WIDTH=1920 +ENV HEIGHT=1080 + +# libguestfs verbose +ENV LIBGUESTFS_DEBUG=1 +ENV LIBGUESTFS_TRACE=1 VOLUME ["/tmp/.X11-unix"] @@ -258,42 +297,38 @@ VOLUME ["/tmp/.X11-unix"] # the default serial numbers are already contained in ./OpenCore-Catalina/OpenCore.qcow2 # And the default serial numbers -CMD sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ - ; case "$(file --brief /image)" in \ - QEMU\ QCOW2\ Image* ) export IMAGE_PATH=/image \ - ;; \ - directory* ) export IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img \ - ;; \ - esac \ +CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ + ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \ ; [[ "${NOPICKER}" == true ]] && { \ sed -i '/^.*InstallMedia.*/d' Launch.sh \ - && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \ + && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \ ; } \ + || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ ; [[ "${GENERATE_UNIQUE}" == true ]] && { \ - ./Docker-OSX/custom/generate-unique-machine-values.sh \ - --count 1 \ - --tsv ./serial.tsv \ - --bootdisks \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ - --output-env "${ENV:=/env}" || exit 1 \ - ; } \ + ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ + --count 1 \ + --tsv ./serial.tsv \ + --bootdisks \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + --output-env "${ENV:=/env}" \ + || exit 1 ; } \ ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \ - source "${ENV:=/env}" \ - || ./Docker-OSX/custom/generate-specific-bootdisk.sh \ + source "${ENV:=/env}" 2>/dev/null \ + ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ --model "${DEVICE_MODEL}" \ --serial "${SERIAL}" \ --board-serial "${BOARD_SERIAL}" \ --uuid "${UUID}" \ --mac-address "${MAC_ADDRESS}" \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \ - ; } \ - ; case "$(file --brief /bootdisk)" in \ - QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \ - ;; \ - directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \ - ;; \ - esac \ - ; ./enable-ssh.sh && envsubst < ./Launch.sh | bash + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + || exit 1 ; } \ + ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh # virt-manager mode: eta son # CMD virsh define <(envsubst < Docker-OSX.xml) && virt-manager || virt-manager diff --git a/Dockerfile.auto b/Dockerfile.auto index 8128303..5fddefa 100644 --- a/Dockerfile.auto +++ b/Dockerfile.auto @@ -3,13 +3,14 @@ # / __ \____ _____/ /_____ _____/ __ \/ ___/ |/ / # / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \| / # / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | -# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| AUTOINSTALL +# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| :AUTO # -# Title: Mac on Docker (Docker-OSX) [AUTOINSTALL] -# Author: Sick.Codes https://twitter.com/sickcodes -# Version: 4.0 +# Title: Docker-OSX (Mac on Docker) +# Author: Sick.Codes https://twitter.com/sickcodes +# Version: 4.3 # License: GPLv3+ # Repository: https://github.com/sickcodes/Docker-OSX +# Website: https://sick.codes # # This Dockerfile is a pre-installed naked installation of Docker-OSX! # @@ -72,7 +73,7 @@ RUN if [[ "${RANKMIRRORS}" ]]; then \ RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \ && if [[ "${SCROT}" ]]; then \ pacman -Syu scrot base-devel --noconfirm \ - && git clone https://github.com/stolk/imcat.git \ + && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \ && cd imcat \ && make \ && sudo cp imcat /usr/bin/imcat \ @@ -86,6 +87,19 @@ RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noc ; fi \ ; yes | pacman -Scc +# TEMP-FIX for pacman issue +RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for pacman issue + +# TEMP-FIX for file 5.40 libguestfs issue +RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \ + && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for file 5.40 libguestfs issue + USER arch WORKDIR /home/arch/OSX-KVM @@ -102,30 +116,65 @@ RUN mkdir -p ~/.ssh \ ARG COMPLETE=true -# Feel free to take a copy of this image and then host it internally -ARG IMAGE_URL='https://images2.sick.codes/mac_hdd_ng_auto.img' - # use the COMPLETE arg, for a complete image, ready to boot. # otherwise use your own image: -v "$PWD/disk.img":/image ARG WGET_OPTIONS= # ARG WGET_OPTIONS='--no-verbose' +# Feel free to take a copy of this image and then host it internally +ARG IMAGE_URL='https://images.sick.codes/mac_hdd_ng_auto.img' +# ARG IMAGE_URL='https://images.sick.codes/mac_hdd_ng_auto_big_sur.img' + RUN if [[ "${COMPLETE}" ]]; then \ - echo "Downloading 20GB+ image... This step might take a while... Press Ctrl+C if you want to abort." \ + echo "Downloading 20GB image... This step might take a while... Press Ctrl+C if you want to abort." \ ; rm -f /home/arch/OSX-KVM/mac_hdd_ng.img \ && wget ${WGET_OPTIONS} -O /home/arch/OSX-KVM/mac_hdd_ng.img "${IMAGE_URL}" \ ; fi -ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 +#### SPECIAL RUNTIME ARGUMENTS BELOW + +ENV ADDITIONAL_PORTS= + +ENV BOOTDISK= ENV DISPLAY=:99 +ENV HEADLESS=false + ENV ENV=/env +# Boolean for generating a bootdisk with new random serials. +ENV GENERATE_UNIQUE=false + +# Boolean for generating a bootdisk with specific serials. +ENV GENERATE_SPECIFIC=false + ENV IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img +ENV IMAGE_FORMAT=qcow2 + +ENV KVM='accel=kvm:tcg' + +# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist" + +# ENV NETWORKING=e1000-82545em +ENV NETWORKING=vmxnet3 ENV NOPICKER=true +# dynamic RAM options for runtime +ENV RAM=3 +# ENV RAM=max +# ENV RAM=half + +# The x and y coordinates for resolution. +# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true. +ENV WIDTH=1920 +ENV HEIGHT=1080 + +# libguestfs verbose +ENV LIBGUESTFS_DEBUG=1 +ENV LIBGUESTFS_TRACE=1 + ENV TERMS_OF_USE=i_agree ENV BOILERPLATE="By using this Dockerfile, you hereby agree that you are a security reseacher or developer and agree to use this Dockerfile to make the world a safer place. Examples include: making your apps safer, finding your mobile phone, compiling security products, etc. You understand that Docker-OSX is an Open Source project, which is released to the public under the GNU Pulic License version 3 and above. You acknowledge that the Open Source project is absolutely unaffiliated with any third party, in any form whatsoever. Any trademarks or intelectual property which happen to be mentioned anywhere in or around the project are owned by their respective owners. By using this Dockerfile, you agree to agree to the EULA of each piece of upstream or downstream software. The following code is released for the sole purpose of security research, under the GNU Public License version 3. If you are concerned about the licensing, please note that this project is not AGPL. A copy of the license is available online: https://github.com/sickcodes/Docker-OSX/blob/master/LICENSE. In order to use the following Dockerfile you must read and understand the terms. Once you have read the terms, use the -e TERMS_OF_USE=i_agree or -e TERMS_OF_USE=i_disagree" @@ -133,44 +182,41 @@ ENV BOILERPLATE="By using this Dockerfile, you hereby agree that you are a secur CMD echo "${BOILERPLATE}" \ ; [[ "${TERMS_OF_USE}" = i_agree ]] || exit 1 \ ; echo "Disk is being copied between layers... Please wait a minute..." \ - ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ + ; sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ + ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \ ; [[ "${NOPICKER}" == true ]] && { \ sed -i '/^.*InstallMedia.*/d' Launch.sh \ - && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \ + && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \ ; } \ + || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ ; [[ "${GENERATE_UNIQUE}" == true ]] && { \ - ./Docker-OSX/custom/generate-unique-machine-values.sh \ - --count 1 \ - --tsv ./serial.tsv \ - --bootdisks \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ - --output-env "${ENV:=/env}" || exit 1 \ - ; } \ + ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ + --count 1 \ + --tsv ./serial.tsv \ + --bootdisks \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + --output-env "${ENV:=/env}" \ + || exit 1 ; } \ ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \ - source "${ENV:=/env}" \ - || ./Docker-OSX/custom/generate-specific-bootdisk.sh \ + source "${ENV:=/env}" 2>/dev/null \ + ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ --model "${DEVICE_MODEL}" \ --serial "${SERIAL}" \ --board-serial "${BOARD_SERIAL}" \ --uuid "${UUID}" \ --mac-address "${MAC_ADDRESS}" \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \ - ; } \ - ; case "$(file --brief /bootdisk)" in \ - QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \ - ;; \ - directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \ - ;; \ - esac \ - ; [[ "${DISPLAY}" = ':99' ]] && { \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + || exit 1 ; } \ + ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \ nohup Xvfb :99 -screen 0 1920x1080x16 \ - & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 0.1 ; done \ + & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \ ; } \ - ; echo "Checking whether /image is a directory or a QEMU disk." \ - ; case "$(file --brief /image)" in \ - QEMU*) export IMAGE_PATH=/image;; \ - directory*) export IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img;; \ - esac \ ; stat "${IMAGE_PATH}" \ ; echo "Large image is being copied between layers, please wait a minute..." \ ; ./enable-ssh.sh \ @@ -178,7 +224,7 @@ CMD echo "${BOILERPLATE}" \ /usr/bin/ssh-keygen -t rsa -f ~/.ssh/id_docker_osx -q -N "" \ && chmod 600 ~/.ssh/id_docker_osx \ ; } \ - ; envsubst < ./Launch.sh | bash \ + ; /bin/bash -c ./Launch.sh \ & echo "Booting Docker-OSX in the background. Please wait..." \ ; until [[ "$(sshpass -palpine ssh-copy-id -f -i ~/.ssh/id_docker_osx.pub -p 10022 user@127.0.0.1)" ]]; do \ echo "Disk is being copied between layers. Repeating until able to copy SSH key into OSX..." \ diff --git a/Dockerfile.naked b/Dockerfile.naked index 897ca0d..c1b897b 100644 --- a/Dockerfile.naked +++ b/Dockerfile.naked @@ -3,13 +3,14 @@ # / __ \____ _____/ /_____ _____/ __ \/ ___/ |/ / # / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \| / # / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | -# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| NAKED/SUPPLY_YOUR_OWN +# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| :NAKED # -# Title: Mac on Docker (Docker-OSX) [AUTOINSTALL] -# Author: Sick.Codes https://twitter.com/sickcodes -# Version: 4.0 +# Title: Docker-OSX (Mac on Docker) +# Author: Sick.Codes https://twitter.com/sickcodes +# Version: 4.3 # License: GPLv3+ # Repository: https://github.com/sickcodes/Docker-OSX +# Website: https://sick.codes # # This image won't run unless you supply a disk image using: # -v ${PWD}/mac_hdd_ng.img:/image @@ -61,7 +62,7 @@ ARG SCROT RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \ && if [[ "${SCROT}" ]]; then \ pacman -Syu scrot base-devel --noconfirm \ - && git clone https://github.com/stolk/imcat.git \ + && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \ && cd imcat \ && make \ && sudo cp imcat /usr/bin/imcat \ @@ -75,6 +76,19 @@ RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noc ; fi \ ; yes | pacman -Scc +# TEMP-FIX for pacman issue +RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for pacman issue + +# TEMP-FIX for file 5.40 libguestfs issue +RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \ + && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for file 5.40 libguestfs issue + USER arch WORKDIR /home/arch/OSX-KVM @@ -89,47 +103,83 @@ RUN mkdir -p ~/.ssh \ && tee -a ~/.ssh/config <<< ' StrictHostKeyChecking no' \ && tee -a ~/.ssh/config <<< ' UserKnownHostsFile=/dev/null' -ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 +#### SPECIAL RUNTIME ARGUMENTS BELOW + +ENV ADDITIONAL_PORTS= + +ENV BOOTDISK= ENV DISPLAY=:99 +ENV HEADLESS=false + ENV ENV=/env +# Boolean for generating a bootdisk with new random serials. +ENV GENERATE_UNIQUE=false + +# Boolean for generating a bootdisk with specific serials. +ENV GENERATE_SPECIFIC=false + ENV IMAGE_PATH=/image +ENV IMAGE_FORMAT=qcow2 + +ENV KVM='accel=kvm:tcg' + +# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist" + +# ENV NETWORKING=e1000-82545em +ENV NETWORKING=vmxnet3 ENV NOPICKER=true -CMD sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ - ; [[ "${DISPLAY}" = ':99' ]] && { \ +# dynamic RAM options for runtime +ENV RAM=3 +# ENV RAM=max +# ENV RAM=half + +# The x and y coordinates for resolution. +# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true. +ENV WIDTH=1920 +ENV HEIGHT=1080 + +# libguestfs verbose +ENV LIBGUESTFS_DEBUG=1 +ENV LIBGUESTFS_TRACE=1 + +CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \ + ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \ + ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \ nohup Xvfb :99 -screen 0 1920x1080x16 \ & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \ ; } \ ; [[ "${NOPICKER}" == true ]] && { \ sed -i '/^.*InstallMedia.*/d' Launch.sh \ - && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \ + && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \ ; } \ + || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ ; [[ "${GENERATE_UNIQUE}" == true ]] && { \ - ./Docker-OSX/custom/generate-unique-machine-values.sh \ - --count 1 \ - --tsv ./serial.tsv \ - --bootdisks \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ - --output-env "${ENV:=/env}" || exit 1 \ - ; } \ + ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ + --count 1 \ + --tsv ./serial.tsv \ + --bootdisks \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + --output-env "${ENV:=/env}" \ + || exit 1 ; } \ ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \ - source "${ENV:=/env}" \ - || ./Docker-OSX/custom/generate-specific-bootdisk.sh \ + source "${ENV:=/env}" 2>/dev/null \ + ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ --model "${DEVICE_MODEL}" \ --serial "${SERIAL}" \ --board-serial "${BOARD_SERIAL}" \ --uuid "${UUID}" \ --mac-address "${MAC_ADDRESS}" \ - --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \ - ; } \ - ; case "$(file --brief /bootdisk)" in \ - QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \ - ;; \ - directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \ - ;; \ - esac \ - ; ./enable-ssh.sh && envsubst < ./Launch.sh | bash + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + || exit 1 ; } \ + ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh diff --git a/README.md b/README.md index 3daf0ee..bcb3eb8 100644 --- a/README.md +++ b/README.md @@ -1,342 +1,165 @@ -# Docker-OSX -## [Follow @sickcodes on Twitter](https://twitter.com/sickcodes) +# Docker-OSX · [Follow @sickcodes on Twitter](https://twitter.com/sickcodes) -![Running mac osx in a docker container](/running-mac-inside-docker-qemu.png?raw=true "OSX KVM DOCKER") +![Running Mac OS X in a Docker container](/running-mac-inside-docker-qemu.png?raw=true "OSX KVM DOCKER") -Run Mac in a Docker container! Run near native OSX-KVM in Docker! X11 Forwarding! iMessage security research! +Run Mac OS X in Docker with near-native performance! X11 Forwarding! iMessage security research! -Author: Sick.Codes https://sick.codes/ & https://twitter.com/sickcodes +## Author -Documentation: everything is on this page! +This project is maintained by [Sick.Codes](https://sick.codes/). [(Twitter)](https://twitter.com/sickcodes) -### PR & Contributor Credits +Additional credits can be found here: https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md -https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md +Additionally, comprehensive list of all contributors can be found here: https://github.com/sickcodes/Docker-OSX/graphs/contributors -Docker Hub: https://hub.docker.com/r/sickcodes/docker-osx +Special thanks to [@kholia](https://twitter.com/kholia) for maintaining the upstream project, which Docker-OSX is built on top of: [OSX-KVM](https://github.com/kholia/OSX-KVM). -- sickcodes/docker-osx:latest - base recovery image (10) +Big thanks to the OpenCore team over at: https://github.com/acidanthera/OpenCorePkg. Their well-maintained bootloader provides much of the great functionality that Docker-OSX users enjoy :) -- sickcodes/docker-osx:big-sur - base recovery image (11) +If you like this project, consider contributing here or upstream! -- sickcodes/docker-osx:naked - supply your own .img file +[![dockeri.co](https://dockeri.co/image/sickcodes/docker-osx)](https://hub.docker.com/r/sickcodes/docker-osx) -- sickcodes/docker-osx:auto - 17.5GB image boot to OSX shell +## Quick Start Docker-OSX -## Professional Support Available! +First time here? try [initial setup](#initial-setup), otherwise try the instructions below to use either Catalina or Big Sur. -Small questions & issues: open an issue! - -For big projects, DM on Twitter [@sickcodes on Twitter](https://twitter.com/sickcodes) or write to us at https://sick.codes/contact. - -- Enterprise support, Business support, or casual support. -- Custom images, custom scripts, consulting (per hour available!) -- One-on-one with you, or your development team. - -## Kubernetes Support - -Kubernetes Helm Chart & Documentation [available at ./helm](https://github.com/sickcodes/Docker-OSX/tree/master/helm) - -Thank you to @cephasara for this major contribution. - -[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/docker-osx)](https://artifacthub.io/packages/search?repo=docker-osx) - -#### Follow [@sickcodes on Twitter](https://twitter.com/sickcodes) for updates or feature requests! - -# How to use - -### There are 3 images: **latest**, **auto** and **naked**. - -`sickcodes/docker-osx:latest` - [I want to try it out.](https://github.com/sickcodes/Docker-OSX#quick-start-175gb-pre-made-image) - -`sickcodes/docker-osx:latest` - [I want to use Docker-OSX to develop/secure Apps in Xcode (sign into Xcode, Transporter)](https://github.com/sickcodes/Docker-OSX#quick-start-docker-osx) - -`sickcodes/docker-osx:naked` - [I want to use Docker-OSX in CI/CD (sign into Xcode, Transporter)](https://github.com/sickcodes/Docker-OSX#fully-headless-using-my-own-image-for-cicd) -Create your personal image using `:latest`. And then pull your image out. And then use duplicate that image again & again for use in `:naked`. - -`sickcodes/docker-osx:auto` - [I want to boot into command line only. (compile software, homebrew headless).](https://github.com/sickcodes/Docker-OSX#pre-built-image-arbitrary-command-line-arguments) - -`sickcodes/docker-osx:naked` - [I need iMessage/iCloud for security research.](https://github.com/sickcodes/Docker-OSX#serial-numbers) - -#### I need a screen. -**KEEP** these two lines are in your command. Works in ANY of the machines: -```dockerfile - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ -``` - -#### I need headless. -**REMOVE** these two lines from ANY of the machines: -```dockerfile - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ -``` - -#### I have used it already, and want to copy this image. -Use `docker commit`, copy the ID, and then `docker start ID` - -**OR** - -[Pull out the .img file](https://github.com/sickcodes/Docker-OSX#backup-the-disk-wheres-my-disk), and then use that [.img file with :naked](https://github.com/sickcodes/Docker-OSX#quick-start-own-image-naked-container-image) - - -# Basic Quick Start Docker-OSX +### Catalina [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest](https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) ```bash - -docker pull sickcodes/docker-osx:latest - -# catalina docker run -it \ --device /dev/kvm \ -p 50922:10022 \ -v /tmp/.X11-unix:/tmp/.X11-unix \ -e "DISPLAY=${DISPLAY:-:0.0}" \ sickcodes/docker-osx:latest +``` +### Big Sur [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur](https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) -# big sur +```bash docker run -it \ --device /dev/kvm \ -p 50922:10022 \ -v /tmp/.X11-unix:/tmp/.X11-unix \ -e "DISPLAY=${DISPLAY:-:0.0}" \ sickcodes/docker-osx:big-sur - -# Wait 2-3 minutes until you see the logo. - ``` -# Quick Start Large Pre-Made Image +## Technical details -Current large image size: 17.5GB +There currently four images, each with different use cases (explained [below](#container-images)): -This starts a container with an existing installation. This special auto image was made by @sickcodes: +[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest](https://img.shields.io/docker/image-size/sickcodes/docker-osx/latest?label=sickcodes%2Fdocker-osx%3Alatest)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) -- SSH enabled -- username is `user` -- password is `alpine` -- auto-updates off +[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked](https://img.shields.io/docker/image-size/sickcodes/docker-osx/naked?label=sickcodes%2Fdocker-osx%3Anaked)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) -You will need around *50GB* of space to run this image: half for the base image + half for your runtime image. +[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur](https://img.shields.io/docker/image-size/sickcodes/docker-osx/big-sur?label=sickcodes%2Fdocker-osx%3Abig-sur)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) -If you run out of space, you can delete all your old Docker images/history/cache by simply deleting `/var/lib/docker`, and restarting `dockerd`. +[![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) -```bash +This special set of images was developed by [Sick.Codes](https://sick.codes). -docker pull sickcodes/docker-osx:auto +The images (excluding `:naked`) launch a container with an existing installation with a couple of premade configurations: +- username: `user`, password: `alpine` +- SSH enabled (`localhost:50922`) +- VNC enabled (`localhost:8888`) if using ./vnc version +- auto-updates disabled +- [serial number generator!](https://github.com/sickcodes/osx-serial-generator) +- X11 forwarding is enabled +- runs on top of QEMU + KVM +- supports Big Sur, custom images, Xvfb headless mode +- you can clone your container with `docker commit` -# boot directly into a real OSX shell with no display (Xvfb) [HEADLESS] -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - sickcodes/docker-osx:auto +### Requirements -# Wait 2-3 minutes until you drop into the shell. -``` +- 20GB disk space for bare minimum installation +- virtualization should be enabled in your BIOS settings +- a kvm-capable host +- at least 50 GBs for `:auto` (half for the base image, half for your runtime image -```bash +### TODO -docker pull sickcodes/docker-osx:auto +- documentation for security researchers +- gpu acceleration +- support for virt-manager -# boot directly into a real OSX shell with a visual display [NOT HEADLESS] -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - sickcodes/docker-osx:auto +## Docker -``` -### Pre-built Image + Arbitrary Command Line Arguments. +Images built on top of the contents of this repository are also available on **Docker Hub** for convenience: https://hub.docker.com/r/sickcodes/docker-osx -```bash +A comprehensive list of the available Docker images and their intended purpose can be found in the [Instructions](#instructions). -docker pull sickcodes/docker-osx:auto +## Kubernetes -# boot to OSX shell + display + specify commands to run inside OSX! -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e "OSX_COMMANDS=/bin/bash -c \"pwd && uname -a\"" \ - sickcodes/docker-osx:auto +Docker-OSX supports Kubernetes. -# Boots in a minute or two! +Kubernetes Helm Chart & Documentation can be found under the [helm directory](helm/README.md). -``` -### Restart an auto container +Thanks [cephasara](https://github.com/cephasara) for contributing this major contribution. -Containers that use `sickcodes/docker-osx:auto` can be stopped at started. +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/docker-osx)](https://artifacthub.io/packages/search?repo=docker-osx) -```bash -# find last container -docker ps -a +## Support -# docker start old container with -i for interactive -docker start -i containerid +### Small questions & issues -``` +Feel free to open an [issue](https://github.com/sickcodes/Docker-OSX/issues/new/choose), should you come across minor issues with running Docker-OSX or have any questions. -# Quick Start Own Image (naked container image) +#### Resolved issues -This is my favourite container. You can supply an existing disk image as a docker command line argument. +Before you open an issue, however, please check the [closed issues](https://github.com/sickcodes/Docker-OSX/issues?q=is%3Aissue+is%3Aclosed) and confirm that you're using the latest version of this repository — your issues may have already been resolved! You might also see your answer in our questions and answers section [below](#more-questions-and-answers). -Supply your own local image with `-v "${PWD}/mac_hdd_ng.img:/image"` and use `sickcodes/docker-osx:naked` +### Feature requests and updates -- Naked image is for booting any existing .img file. -- By default, this image has a variable called `NOPICKER` which is `"true"`. This skips the disk selection menu. Use `-e NOPICKER=false` or any other string than the word `true` to enter the boot menu. This lets you use other disks instead of skipping the boot menu, e.g. recovery disk or disk utility. +Follow [@sickcodes](https://twitter.com/sickcodes)! -```bash -docker pull sickcodes/docker-osx:naked +### Professional support -# run your own image + SSH -# change mac_hdd_ng.img -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v "${PWD}/mac_hdd_ng.img:/image" \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - sickcodes/docker-osx:naked +For more sophisticated endeavours, we offer the following support services: -# run local copy of the auto image + SSH + Boot menu -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v "${PWD}/mac_hdd_ng_auto.img:/image" \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - -e "NOPICKER=false" \ - sickcodes/docker-osx:naked +- Enterprise support, business support, or casual support. +- Custom images, custom scripts, consulting (per hour available!) +- One-on-one conversations with you or your development team. -``` +In case you're interested, contact [@sickcodes on Twitter](https://twitter.com/sickcodes) or click [here](https://sick.codes/contact). -### Fully Headless, using my own image, for CI/CD +## License/Contributing -```bash -# run your own image headless + SSH -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v "${PWD}/mac_hdd_ng.img:/image" \ - sickcodes/docker-osx:naked -``` +Docker-OSX is licensed under the [GPL v3+](LICENSE). Contributions are welcomed and immensely appreciated. You are in-fact permitted to use Docker-OSX as a tool to create proprietary software. -# Features In Docker-OSX v4 -- `sickcodes/docker-osx:big-sur` - original base recovery image for latest OS (safe) -- Serial number generators. [See below or ./custom](https://github.com/sickcodes/Docker-OSX/tree/master/custom) -- Full auto mode: boot straight to OSX shell and even run commands as runtime arguments! -- `sickcodes/docker-osx:latest` - original base recovery image (safe) -- `sickcodes/docker-osx:naked` - supply your own .img file (safe) -- `sickcodes/docker-osx:auto` - Large docker image that boots to OSX shell (must trust @sickcodes) -- Supply your own image using `-v "${PWD}/disk.img:/image"` -- Kubernetes Helm Chart. [See ./helm](https://github.com/sickcodes/Docker-OSX/tree/master/helm) -- [OSX-KVM](https://github.com/kholia/OSX-KVM) inside a Docker container! -- X11 Forwarding -- SSH on `localhost:50922` -- QEMU + KVM! -- VNC version on `localhost:8888` [vnc version is inside a separate directory, there are security risks involved with using VNC, see insid the Dockerfile](https://github.com/sickcodes/Docker-OSX/blob/master/vnc-version/Dockerfile) -- Create an ARMY of the same exact container using `docker commit` -- Xfvb headless mode +### Other cool Docker/QEMU based projects -### All Pull Requests Welcome! +- [Run iOS in a Docker container with Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS) - [https://github.com/sickcodes/Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS) +- [Run iMessage relayer in Docker with Bluebubbles.app](https://bluebubbles.app/) - [Getting started wiki](https://github.com/BlueBubblesApp/BlueBubbles-Server/wiki/Running-via-Docker) -Docker-OSX is a GPLv3+ Dockerfile and we need contributors just like you :) +## Disclaimer -Upstream: https://github.com/kholia/OSX-KVM && the great guy [@kholia](https://twitter.com/kholia) +If you are serious about Apple Security, and possibly finding 6-figure bug bounties within the Apple Bug Bounty Program, then you're in the right place! Further notes: [Is Hackintosh, OSX-KVM, or Docker-OSX legal?](https://sick.codes/is-hackintosh-osx-kvm-or-docker-osx-legal/) -Upstream Credits (OSX-KVM project) among many others: https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md +Product names, logos, brands and other trademarks referred to within this project are the property of their respective trademark holders. These trademark holders are not affiliated with our repository in any capacity. They do not sponsor or endorse this project in any way. -# Download The Image for sickcodes/docker-osx:naked +# Instructions -This is the current automated image. Username is `user`, passsword is `alpine`, SSH is on, and auto-updates are off. +## Container images -If the download is slow, just get the image from `docker pull sickcodes/docker-osx:auto` and find it in `/var/lib/docker`. +### Already set up or just looking to make a container quickly? Check out our [quick start](#quick-start-docker-osx) or see a bunch more use cases under our [container creation examples](#container-creation-examples) section. -```bash -wget https://images2.sick.codes/mac_hdd_ng_auto.img +There are several different Docker-OSX images available which are suitable for different purposes. -docker run -it \ - --device /dev/kvm \ - -p 50922:10022 \ - -v "${PWD}/mac_hdd_ng_auto.img:/image" \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - sickcodes/docker-osx:naked +- `sickcodes/docker-osx:latest` - [I just want to try it out.](#quick-start-docker-osx) +- `sickcodes/docker-osx:latest` - [I want to use Docker-OSX to develop/secure apps in Xcode (sign into Xcode, Transporter)](#quick-start-your-own-image-naked-container-image) +- `sickcodes/docker-osx:naked` - [I want to use Docker-OSX for CI/CD-related purposes (sign into Xcode, Transporter)](#building-a-headless-container-from-a-custom-image) -``` +Create your personal image using `:latest`. Then, extract the image. Afterwards, you will be able to duplicate that image and import it to the `:naked` container, in order to revert the container to a previous state repeatedly. -### Other cool Docker-QEMU based projects: +- `sickcodes/docker-osx:auto` - [I'm only interested in using the command line (useful for compiling software or using Homebrew headlessly).](#prebuilt-image-with-arbitrary-command-line-arguments) +- `sickcodes/docker-osx:naked` - [I need iMessage/iCloud for security research.](#generating-serial-numbers) +- `sickcodes/docker-osx:big-sur` - [I want to run Big Sur.](#quick-start-docker-osx) -[Run iOS in a Docker with Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS) - [https://github.com/sickcodes/Docker-eyeOS](https://github.com/sickcodes/Docker-eyeOS) +## Initial setup +Before you do anything else, you will need to turn on hardware virtualization in your BIOS. Precisely how will depend on your particular machine (and BIOS), but it should be straightforward. -# Run Docker-OSX (Original Version) - -```bash - -docker pull sickcodes/docker-osx:latest - -docker run -it \ - --device /dev/kvm \ - --device /dev/snd \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - sickcodes/docker-osx:latest - -# press ctrl G if your mouse gets stuck - -# scroll down to troubleshooting if you have problems - -# need more RAM and SSH on localhost -p 50922? - -``` - -# Run but allow SSH into OSX (Original Version)! - -```bash -docker run -it \ - --device /dev/kvm \ - --device /dev/snd \ - -e RAM=4 \ - -p 50922:10022 \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -e "DISPLAY=${DISPLAY:-:0.0}" \ - sickcodes/docker-osx:latest - -# turn on SSH after you've installed OSX in the "Sharing" settings. -ssh fullname@localhost -p 50922 - -``` - -# Autoboot into OSX after you've installed everything - -You can use `-e NOPICKER=true`. - -Old machines: - -```bash -# find you containerID -docker ps - -# move the no picker script on top of the Launch script -# NEW CONTAINERS -docker exec containerID mv ./Launch-nopicker.sh ./Launch.sh - -# VNC-VERSION-CONTAINER -docker exec containerID mv ./Launch-nopicker.sh ./Launch_custom.sh - -# LEGACY CONTAINERS -docker exec containerID bash -c "grep -v InstallMedia ./Launch.sh > ./Launch-nopicker.sh -chmod +x ./Launch-nopicker.sh -sed -i -e s/OpenCore\.qcow2/OpenCore\-nopicker\.qcow2/ ./Launch-nopicker.sh -" -``` - -# Requirements: KVM on the host -Need to turn on hardware virtualization in your BIOS, very easy to do. - -Then have QEMU on the host if you haven't already +Then, you'll need QEMU and some other dependencies on your host: ```bash # ARCH @@ -347,41 +170,20 @@ sudo apt install qemu qemu-kvm libvirt-clients libvirt-daemon-system bridge-util # CENTOS RHEL FEDORA sudo yum install libvirt qemu-kvm +``` -# then run -sudo systemctl enable libvirtd.service -sudo systemctl enable virtlogd.service +Then, enable libvirt and load the KVM kernel module: + +```bash +sudo systemctl enable --now libvirtd +sudo systemctl enable --now virtlogd echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs sudo modprobe kvm - -# reboot ``` -# Start the same container later (persistent disk) - -1. You can now pull the `.img` file out of the container, which is stored in `/var/lib/docker`, and supply it as a runtime argument to the `:naked` Docker image. See above. - -2. This is for when you want to run the SAME container again later. - -If you don't run this you will have a new image every time. - -```bash -# look at your recent containers and copy the CONTAINER ID -docker ps --all - -# docker start the container ID -docker start abc123xyz567 - -# if you have many containers, you can try automate it with filters like this -# docker ps --all --filter "ancestor=sickcodes/docker-osx" -# for locally tagged/built containers -# docker ps --all --filter "ancestor=docker-osx" - -``` - -# Additional Boot Instructions +## Additional boot instructions for when you are [creating your container](#container-creation-examples) - Boot the macOS Base System @@ -394,28 +196,155 @@ docker start abc123xyz567 - Click `Reinstall macOS` +## Troubleshooting + +### Routine checks + +This is a great place to start if you are having trouble getting going, especially if you're not that familiar with Docker just yet. + +Just looking to make a container quickly? Check out our [container creation examples](#container-creation-examples) section. + +More specific/advanced troubleshooting questions and answers may be found in [More Questions and Answers](#more-questions-and-answers). You should also check out the [closed issues](https://github.com/sickcodes/Docker-OSX/issues?q=is%3Aissue+is%3Aclosed). Someone else might have gotten a question like yours answered already even if you can't find it in this document! + +#### Confirm that your CPU supports virtualization + +See [initial setup](#initial-setup). + +#### Confirm your user is part of the the Docker group, KVM group, libvirt group + +If you use `sudo dockerd` or dockerd is controlled by systemd/systemctl, then you must be in the Docker group. +If you are not in the Docker group: -## Creating images: ```bash -# You can create an image of an already configured and setup container. -# This allows you to effectively duplicate a system. -# To do this, run the following commands +sudo usermod -aG docker "${USER}" +``` +and also add yourself to the kvm and libvirt groups if needed: -# make note of your container id -docker ps --all -docker commit containerid newImageName - -# To run this image do the following -docker run \ - --device /dev/kvm \ - --device /dev/snd \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - newImageName +```bash +sudo usermod -aG libvirt "${USER}" +sudo usermod -aG kvm "${USER}" ``` -# Troubleshooting +See also: [initial setup](#initial-setup). + +#### Is the docker daemon enabled? + +```bash +# enable it in systemd (it will persist across reboots this way) +sudo systemctl enable --now docker + +# or just start it as your user with systemd instead of enabling it +systemctl start docker + +# or run ad hoc +sudo dockerd + +# or daemonize it +sudo nohup dockerd & +``` + +## More Questions and Answers + +Big thank you to our contributors who have worked out almost every conceivable issue so far! + +[https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md](https://github.com/sickcodes/Docker-OSX/blob/master/CREDITS.md) + +### The big-sur image starts slowly after installation. Is this expected? + +Automatic updates are still on in the container's settings. You may wish to turn them off. [We have future plans for development around this.](https://github.com/sickcodes/Docker-OSX/issues/227) + +### What is `${DISPLAY:-:0.0}`? + +`$DISPLAY` is the shell variable that refers to your X11 display server. + +`${DISPLAY}` is the same, but allows you to join variables like this: + +- e.g. `${DISPLAY}_${DISPLAY}` would print `:0.0_:0.0` +- e.g. `$DISPLAY_$DISPLAY` would print `:0.0` + +...because `$DISPLAY_` is not `$DISPLAY` + +`${variable:-fallback}` allows you to set a "fallback" variable to be substituted if `$variable` is not set. + +You can also use `${variable:=fallback}` to set that variable (in your current terminal). + +In Docker-OSX, we assume, `:0.0` is your default `$DISPLAY` variable. + +You can see what yours is + +```bash +echo $DISPLAY +``` + +That way, `${DISPLAY:-:0.0}` will use whatever variable your X11 server has set for you, else `:0.0` + +### What is `-v /tmp/.X11-unix:/tmp/.X11-unix`? + +`-v` is a Docker command-line option that lets you pass a volume to the container. + +The directory that we are letting the Docker container use is a X server display socket. + +`/tmp/.X11-unix` + +If we let the Docker container use the same display socket as our own environment, then any applications you run inside the Docker container will show up on your screen too! [https://www.x.org/archive/X11R6.8.0/doc/RELNOTES5.html](https://www.x.org/archive/X11R6.8.0/doc/RELNOTES5.html) + +### ALSA errors on startup or container creation + +You may when initialising or booting into a container see errors from the `(qemu)` console of the following form: +`ALSA lib blahblahblah: (function name) returned error: no such file or directory`. These are more or less expected. As long as you are able to boot into the container and everything is working, no reason to worry about these. + +See also: [here](https://github.com/sickcodes/Docker-OSX/issues/174). + +### Start the same container later (persistent disk) + +Created a container with `docker run` and want to reuse the underlying image again later? + +NB: see [container creation examples](#container-creation-examples) first for how to get to the point where this is applicable. + +This is for when you want to run the SAME container again later. You may need to use `docker commit` to save your container before you can reuse it. Check if your container is persisted with `docker ps --all`. + +If you don't run this you will have a new image every time. + +```bash +# look at your recent containers and copy the CONTAINER ID +docker ps --all + +# docker start the container ID +docker start -ai abc123xyz567 + +# if you have many containers, you can try automate it with filters like this +# docker ps --all --filter "ancestor=sickcodes/docker-osx" +# for locally tagged/built containers +# docker ps --all --filter "ancestor=docker-osx" + +``` + +You can also pull the `.img` file out of the container, which is stored in `/var/lib/docker`, and supply it as a runtime argument to the `:naked` Docker image. + +See also: [here](https://github.com/sickcodes/Docker-OSX/issues/197). + +### I have used Docker-OSX before and want to restart a container that starts automatically + +Containers that use `sickcodes/docker-osx:auto` can be stopped while being started. + +```bash +# find last container +docker ps -a + +# docker start old container with -i for interactive, -a for attach STDIN/STDOUT +docker start -ai -i +``` + +### LibGTK errors + +You may see one or more libgtk-related errors if you do not have everything set up for hardware virtualisation yet. If you have not yet done so, check out the [initial setup](#initial-setup) section and the [routine checks](#routine-checks) section as you may have missed a setup step or may not have all the needed Docker dependencies ready to go. + +See also: [here](https://github.com/sickcodes/Docker-OSX/issues/174). + +#### Permissions denied error + +If you have not yet set up xhost, try the following: -libgtk permissions denied error, thanks @raoulh + @arsham ```bash echo $DISPLAY @@ -433,7 +362,40 @@ xhost + ``` -PulseAudio for sound (note neither [AppleALC](https://github.com/acidanthera/AppleALC) and varying [`alcid`](https://dortania.github.io/OpenCore-Post-Install/universal/audio.html) or [VoodooHDA-OC](https://github.com/chris1111/VoodooHDA-OC) have [codec support](https://osy.gitbook.io/hac-mini-guide/details/hda-fix#hda-codec) though [IORegistryExplorer](https://github.com/vulgo/IORegistryExplorer) does show the controller component working): +### RAM over-allocation +You cannot allocate more RAM than your machine has. The default is 3 Gigabytes: `-e RAM=3`. + +If you are trying to allocate more RAM to the container than you currently have available, you may see an error like the following: `cannot set up guest memory 'pc.ram': Cannot allocate memory`. See also: [here](https://github.com/sickcodes/Docker-OSX/issues/188), [here](https://github.com/sickcodes/Docker-OSX/pull/189). + +For example (below) the `buff/cache` already contains 20 Gigabytes of allocated RAM: + +```console +[user@hostname ~]$ free -mh + total used free shared buff/cache available +Mem: 30Gi 3.5Gi 7.0Gi 728Mi 20Gi 26Gi +Swap: 11Gi 0B 11Gi +``` + +Clear the buffer and the cache: + +```bash +sudo tee /proc/sys/vm/drop_caches <<< 3 +``` + +Now check the RAM again: + +```console +[user@hostname ~]$ free -mh + total used free shared buff/cache available +Mem: 30Gi 3.3Gi 26Gi 697Mi 1.5Gi 26Gi +Swap: 11Gi 0B 11Gi +``` + +### PulseAudio + +#### Use PulseAudio for sound + +Note: [AppleALC](https://github.com/acidanthera/AppleALC), [`alcid`](https://dortania.github.io/OpenCore-Post-Install/universal/audio.html) and [VoodooHDA-OC](https://github.com/chris1111/VoodooHDA-OC) do not have [codec support](https://osy.gitbook.io/hac-mini-guide/details/hda-fix#hda-codec). However, [IORegistryExplorer](https://github.com/vulgo/IORegistryExplorer) does show the controller component working. ```bash docker run \ @@ -444,7 +406,8 @@ docker run \ sickcodes/docker-osx ``` -PulseAudio debugging: +#### PulseAudio debugging + ```bash docker run \ --device /dev/kvm \ @@ -455,51 +418,59 @@ docker run \ sickcodes/docker-osx pactl list ``` -Alternative run, thanks @roryrjb +### Forward additional ports (nginx hosting example) -```bash -docker run \ - --privileged \ - --net host \ - --cap-add=ALL \ - -v /tmp/.X11-unix:/tmp/.X11-unix \ - -v /dev:/dev \ - -v /lib/modules:/lib/modules \ - sickcodes/docker-osx +It's possible to forward additional ports depending on your needs. In this example, we'll use Mac OSX to host nginx: + +``` +host:10023 <-> 10023:container:10023 <-> 80:guest ``` -Check if your hardware virt is on +On the host machine, run: ```bash -egrep -c '(svm|vmx)' /proc/cpuinfo +docker run -it \ + --device /dev/kvm \ + -p 50922:10022 \ + -e ADDITIONAL_PORTS='hostfwd=tcp::10023-:80,' \ + -p 10023:10023 \ + sickcodes/docker-osx:auto ``` -Try adding yourself to the docker group +In a Terminal session running the container, run: ```bash -sudo usermod -aG docker "${USER}" +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + +brew install nginx +sudo sed -i -e 's/8080/80/' /usr/local/etc/nginx/nginx.confcd +# sudo nginx -s stop +sudo nginx ``` -Turn on docker daemon +**nginx should now be reachable on port 10023.** + +Additionally, you can string multiple statements together, for example: ```bash -# run ad hoc -sudo dockerd - -# or daemonize it -sudo nohup dockerd & - -# or enable it in systemd -sudo systemctl enable docker + -e ADDITIONAL_PORTS='hostfwd=tcp::10023-:80,hostfwd=tcp::10043-:443,' + -p 10023:10023 \ + -p 10043:10043 \ ``` -# How to Enable Network Forwarding +### Bridged networking -Allow ipv4 forwarding for bridged networking connections: +You might not need to do anything with the default setup to enable internet connectivity from inside the container. Additionally, `curl` may work even if `ping` doesn't. -This is not required for LOCAL installations and may cause containers behind [VPN's to leak host IP](https://sick.codes/cve-2020-15590/). +See discussion [here](https://github.com/sickcodes/Docker-OSX/issues/177) and [here](https://github.com/sickcodes/Docker-OSX/issues/72) and [here](https://github.com/sickcodes/Docker-OSX/issues/88). -If you are connecting to a REMOTE Docker-OSX, e.g. a "Mac Mini" in a datacenter, then this may boost networking: +### Enable IPv4 forwarding for bridged network connections for remote installations + +This is not required for LOCAL installations. + +Additionally note it may [cause the host to leak your IP, even if you're using a VPN in the container](https://sick.codes/cve-2020-15590/). + +However, if you're trying to connect to an instance of Docker-OSX remotely (e.g. an instance of Docker-OSX hosted in a datacenter), this may improve your performance: ```bash # enable for current session @@ -514,36 +485,15 @@ sudo tee -a /etc/sysctl.conf <`. For example, to kill everything, `docker ps | xargs docker kill`.** + +Native QEMU VNC example + +```bash +docker run -i \ + --device /dev/kvm \ + -p 50922:10022 \ + -p 5999:5999 \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -e "DISPLAY=${DISPLAY:-:0.0}" \ + -e EXTRA="-display none -vnc 0.0.0.0:99,password" \ + sickcodes/docker-osx:big-sur + +# type `change vnc password` into the docker terminal and set a password +# connect to localhost:5999 using VNC +``` + +**NOT TLS/HTTPS Encrypted at all!** + +Or `ssh -N root@1.1.1.1 -L 5999:127.0.0.1:5999`, where `1.1.1.1` is your remote server IP. + +(Note: if you close port 5999 and use the SSH tunnel, this becomes secure.) + +### Building a headless container to run remotely with secure VNC + +Add the following line: + +`-e EXTRA="-display none -vnc 0.0.0.0:99,password"` + +In the Docker terminal, press `enter` until you see `(qemu)`. + +Type `change vnc password` + +You also need the container IP: `docker inspect | jq -r '.[0].NetworkSettings.IPAddress'` + +Or `ip n` will usually show the container IP first. + +Now VNC connect using the Docker container IP, for example `172.17.0.2:5999` + +Remote VNC over SSH: `ssh -N root@1.1.1.1 -L 5999:172.17.0.2:5999`, where `1.1.1.1` is your remote server IP and `172.17.0.2` is your LAN container IP. + +Now you can direct connect VNC to any container built with this command! + +### I'd like to use SPICE instead of VNC + +Optionally, you can enable the SPICE protocol, which allows use of `remote-viewer` to access your OSX container rather than VNC. + +Note: `-disable-ticketing` will allow unauthenticated access to the VM. See the [spice manual](https://www.spice-space.org/spice-user-manual.html) for help setting up authenticated access ("Ticketing"). + +```bash + docker run \ + --device /dev/kvm \ + -p 50922:10022 \ + -e "DISPLAY=${DISPLAY:-:0.0}" \ + -e EXTRA="-monitor telnet::45454,server,nowait -nographic -serial null -spice disable-ticketing,port=3001" \ + mycustomimage +``` + +Then simply do `remote-viewer spice://localhost:3001` and add `--spice-debug` for debugging. + +#### Creating images based on an already configured and set up container +```bash +# You can create an image of an already configured and setup container. +# This allows you to effectively duplicate a system. +# To do this, run the following commands + +# make note of your container id +docker ps --all +docker commit containerid newImageName + +# To run this image do the following +docker run \ + --device /dev/kvm \ + --device /dev/snd \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + newImageName +``` + +#### Run Catalina Pre-Installed [![https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto](https://img.shields.io/docker/image-size/sickcodes/docker-osx/auto?label=sickcodes%2Fdocker-osx%3Aauto)](https://hub.docker.com/r/sickcodes/docker-osx/tags?page=1&ordering=last_updated) + +```bash +docker pull sickcodes/docker-osx:auto + +# boot directly into a real OS X shell with a visual display [NOT HEADLESS] +docker run -it \ + --device /dev/kvm \ + -p 50922:10022 \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -e "DISPLAY=${DISPLAY:-:0.0}" \ + sickcodes/docker-osx:auto + +# username is user +# passsword is alpine +``` + +```bash +docker pull sickcodes/docker-osx:auto + +# boot directly into a real OS X shell with no display (Xvfb) [HEADLESS] +docker run -it \ + --device /dev/kvm \ + -p 50922:10022 \ + sickcodes/docker-osx:auto + +# username is user +# passsword is alpine +# Wait 2-3 minutes until you drop into the shell. +``` + +#### Run the original version of Docker-OSX + +```bash + +docker pull sickcodes/docker-osx:latest + +docker run -it \ + --device /dev/kvm \ + --device /dev/snd \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -e "DISPLAY=${DISPLAY:-:0.0}" \ + sickcodes/docker-osx:latest + +# press CTRL + G if your mouse gets stuck +# scroll down to troubleshooting if you have problems +# need more RAM and SSH on localhost -p 50922? +``` + +#### Run but enable SSH in OS X (Original Version)! + +```bash +docker run -it \ + --device /dev/kvm \ + --device /dev/snd \ + -p 50922:10022 \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -e "DISPLAY=${DISPLAY:-:0.0}" \ + sickcodes/docker-osx:latest + +# turn on SSH after you've installed OS X in the "Sharing" settings. +ssh user@localhost -p 50922 +``` + +#### Autoboot into OS X after you've installed everything + +Add the extra option `-e NOPICKER=true`. + +Old machines: + +```bash +# find your containerID +docker ps + +# move the no picker script on top of the Launch script +# NEW CONTAINERS +docker exec containerID mv ./Launch-nopicker.sh ./Launch.sh + +# VNC-VERSION-CONTAINER +docker exec containerID mv ./Launch-nopicker.sh ./Launch_custom.sh + +# LEGACY CONTAINERS +docker exec containerID bash -c "grep -v InstallMedia ./Launch.sh > ./Launch-nopicker.sh +chmod +x ./Launch-nopicker.sh +sed -i -e s/OpenCore\.qcow2/OpenCore\-nopicker\.qcow2/ ./Launch-nopicker.sh +" ``` diff --git a/custom/README.md b/custom/README.md new file mode 100644 index 0000000..92bb97d --- /dev/null +++ b/custom/README.md @@ -0,0 +1,7 @@ +# OSX Serial Generator + +This folder has been moved to its own repository :) + +This is a temporary copy for hardlinks. + +See [https://github.com/sickcodes/osx-serial-generator](https://github.com/sickcodes/osx-serial-generator) \ No newline at end of file diff --git a/custom/config-nopicker-custom.plist b/custom/config-nopicker-custom.plist index 6166234..6602df5 100644 --- a/custom/config-nopicker-custom.plist +++ b/custom/config-nopicker-custom.plist @@ -1,4 +1,5 @@ - + + @@ -704,9 +705,7 @@ MLB {{BOARD_SERIAL}} ROM - - {{ROM}} - + {{ROM}} SpoofVendor SystemProductName @@ -816,7 +815,7 @@ ReplaceTabWithSpace Resolution - 1920x1080@32 + {{WIDTH}}x{{HEIGHT}}@32 SanitiseClearScreen TextRenderer diff --git a/custom/generate-specific-bootdisk.sh b/custom/generate-specific-bootdisk.sh index 76aff0c..386c13b 100755 --- a/custom/generate-specific-bootdisk.sh +++ b/custom/generate-specific-bootdisk.sh @@ -1,43 +1,58 @@ #!/bin/bash -# ____ __ ____ ______ __ -# / __ \____ _____/ /_____ _____/ __ \/ ___/ |/ / -# / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \| / -# / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | -# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| GEN BOOT DISK +# ___ _____ __ ___ _ _ ___ _ +# / _ \/ __\ \/ / / __| ___ _ _(_)__ _| | / __|___ _ _ ___ _ _ __ _| |_ ___ _ _ +# | (_) \__ \> < \__ \/ -_) '_| / _` | | | (_ / -_) ' \/ -_) '_/ _` | _/ _ \ '_| +# \___/|___/_/\_\ |___/\___|_| |_\__,_|_| \___\___|_||_\___|_| \__,_|\__\___/_| # -# Repo: https://github.com/sickcodes/Docker-OSX/ -# Title: Mac on Docker (Docker-OSX) +# Repo: https://github.com/sickcodes/osx-serial-generator/ +# Title: OSX Serial Generator # Author: Sick.Codes https://sick.codes/ # Version: 3.1 # License: GPLv3+ -help_text="Usage: generate-specific-bootdisk.sh +set -e -General options: +help_text="Usage: ./generate-specific-bootdisk.sh + +Required options: --model Device model, e.g. 'iMacPro1,1' - --serial Device Serial number. - --board-serial Board Serial number. - --uuid SmUUID. - --mac-address Used to set the ROM value; lowercased and without a colon. - --output-bootdisk Optionally change the bootdisk output filename. + --serial Device Serial number + --board-serial Main Logic Board Serial number (MLB) + --uuid SMBIOS UUID (SmUUID) + --mac-address Used for both the MAC address and to set ROM + ROM is lowercased sans any colons +Optional options: + --width Resolution x axis length in px, default 1920 + --height Resolution y axis length in px, default 1080 + --input-plist-url Specify an alternative master plist, via URL + --master-plist-url Same as above. --custom-plist Optionally change the input plist. - + --master-plist Same as above. + --output-bootdisk Optionally change the bootdisk filename + --output-plist Optionally change the output plist filename --help, -h, help Display this help and exit +Placeholders: {{DEVICE_MODEL}}, {{SERIAL}}, {{BOARD_SERIAL}}, {{UUID}}, + {{ROM}}, {{WIDTH}}, {{HEIGHT}} + Example: - ./generate-specific-bootdisk.sh \ - --model iMacPro1,1 \ - --serial C02TW0WAHX87 \ - --board-serial C027251024NJG36UE \ - --uuid 5CCB366D-9118-4C61-A00A-E5BAF3BED451 \ - --mac-address A8:5C:2C:9A:46:2F \ - --output-bootdisk OpenCore-nopicker.qcow2 + ./generate-specific-bootdisk.sh \\ + --model iMacPro1,1 \\ + --serial C02TW0WAHX87 \\ + --board-serial C027251024NJG36UE \\ + --uuid 5CCB366D-9118-4C61-A00A-E5BAF3BED451 \\ + --mac-address A8:5C:2C:9A:46:2F \\ + --output-bootdisk ./OpenCore-nopicker.qcow2 \\ + --width 1920 \\ + --height 1080 Author: Sick.Codes https://sick.codes/ -Project: https://github.com/sickcodes/Docker-OSX/ +Project: https://github.com/sickcodes/osx-serial-generator/ +License: GPLv3+ " -PLIST_MASTER=config-nopicker-custom.plist +OPENCORE_IMAGE_MAKER_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/opencore-image-ng.sh' +MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist' # gather arguments while (( "$#" )); do @@ -51,6 +66,7 @@ while (( "$#" )); do export DEVICE_MODEL="${1#*=}" shift ;; + --model* | -m* ) export DEVICE_MODEL="${2}" shift @@ -61,6 +77,7 @@ while (( "$#" )); do export SERIAL="${1#*=}" shift ;; + --serial* ) export SERIAL="${2}" shift @@ -71,6 +88,7 @@ while (( "$#" )); do export BOARD_SERIAL="${1#*=}" shift ;; + --board-serial* ) export BOARD_SERIAL="${2}" shift @@ -81,6 +99,7 @@ while (( "$#" )); do export UUID="${1#*=}" shift ;; + --uuid* ) export UUID="${2}" shift @@ -91,34 +110,81 @@ while (( "$#" )); do export MAC_ADDRESS="${1#*=}" shift ;; + --mac-address* ) export MAC_ADDRESS="${2}" shift shift ;; + --width=* ) + export WIDTH="${1#*=}" + shift + ;; + + --width* ) + export WIDTH="${2}" + shift + shift + ;; + + --height=* ) + export HEIGHT="${1#*=}" + shift + ;; + + --height* ) + export HEIGHT="${2}" + shift + shift + ;; + --output-bootdisk=* ) export OUTPUT_QCOW="${1#*=}" shift ;; + --output-bootdisk* ) export OUTPUT_QCOW="${2}" shift shift ;; - --custom-plist=* ) - export INPUT_PLIST="${1#*=}" + --output-plist=* ) + export OUTPUT_PLIST="${1#*=}" shift ;; - --custom-plist* ) - export INPUT_PLIST="${2}" + + --output-plist* ) + export OUTPUT_PLIST="${2}" + shift + shift + ;; + + --master-plist-url=* | --input-plist-url=* | --custom-plist-url=* ) + export MASTER_PLIST_URL="${1#*=}" + shift + ;; + + --master-plist-url* | --input-plist-url* | --custom-plist-url* ) + export MASTER_PLIST_URL="${2}" + shift + shift + ;; + + --master-plist=* | --input-plist=* | --custom-plist=* ) + export MASTER_PLIST="${1#*=}" + shift + ;; + + --master-plist* | --input-plist* | --custom-plist* ) + export MASTER_PLIST="${2}" shift shift ;; *) - echo "Invalid option. Running with default values..." + echo "Invalid option ${1}. Running with default values..." shift ;; esac @@ -126,36 +192,69 @@ done download_qcow_efi_folder () { - git clone --depth 1 https://github.com/kholia/OSX-KVM.git - cp -ra ./OSX-KVM/OpenCore-Catalina/EFI . - mkdir -p ./EFI/OC/Resources - # clone some Apple drivers - git clone --depth 1 https://github.com/acidanthera/OcBinaryData.git - # copy said drivers into EFI/OC/Resources - cp -a ./OcBinaryData/Resources/* ./EFI/OC/Resources + + export EFI_FOLDER=./OpenCore-Catalina/EFI + export RESOURCES_FOLDER=./resources/OcBinaryData/Resources + + # check if we are inside OSX-KVM already + # if not, download OSX-KVM locally + [ -d ./OpenCore-Catalina/EFI/ ] || { + [ -d ./OSX-KVM/ ] || git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git + export EFI_FOLDER="./OSX-KVM/${EFI_FOLDER}" + } + + [ -d ./resources/OcBinaryData/Resources/ ] || { + export RESOURCES_FOLDER="./OSX-KVM/${RESOURCES_FOLDER}" + } + # EFI Shell commands touch startup.nsh && echo 'fs0:\EFI\BOOT\BOOTx64.efi' > startup.nsh + + cp -a "${EFI_FOLDER}" . + + mkdir -p ./EFI/OC/Resources + + # copy Apple drivers into EFI/OC/Resources + cp -a "${RESOURCES_FOLDER}"/* ./EFI/OC/Resources } generate_bootdisk () { - [[ -e ./config-nopicker-custom.plist ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/config-nopicker-custom.plist - [[ -e ./opencore-image-ng.sh ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/opencore-image-ng.sh && chmod +x opencore-image-ng.sh + + # need a config.plist + if [ "${MASTER_PLIST}" ]; then + [ -e "${MASTER_PLIST}" ] || echo "Could not find: ${MASTER_PLIST}" + elif [ "${MASTER_PLIST}" ] && [ "${MASTER_PLIST_URL}" ]; then + echo 'You specified both a custom plist FILE & custom plist URL.' + echo 'Use only one of those options.' + elif [ "${MASTER_PLIST_URL}" ]; then + wget -O "${MASTER_PLIST:=./config-custom.plist}" "${MASTER_PLIST_URL}" + else + # default is config-nopicker-custom.plist from OSX-KVM with placeholders used in Docker-OSX + wget -O "${MASTER_PLIST:=./config-nopicker-custom.plist}" "${MASTER_PLIST_URL}" + fi + + [ -e ./opencore-image-ng.sh ] \ + || { wget "${OPENCORE_IMAGE_MAKER_URL}" \ + && chmod +x opencore-image-ng.sh ; } + # plist required for bootdisks, so create anyway. - if [[ "${DEVICE_MODEL}" ]] \ - && [[ "${SERIAL}" ]] \ - && [[ "${BOARD_SERIAL}" ]] \ - && [[ "${UUID}" ]] \ - && [[ "${MAC_ADDRESS}" ]]; then + if [ "${DEVICE_MODEL}" ] \ + && [ "${SERIAL}" ] \ + && [ "${BOARD_SERIAL}" ] \ + && [ "${UUID}" ] \ + && [ "${MAC_ADDRESS}" ]; then ROM="${MAC_ADDRESS//\:/}" ROM="${ROM,,}" - sed -e s/{{DEVICE_MODEL}}/"${DEVICE_MODEL}"/g \ - -e s/{{SERIAL}}/"${SERIAL}"/g \ - -e s/{{BOARD_SERIAL}}/"${BOARD_SERIAL}"/g \ - -e s/{{UUID}}/"${UUID}"/g \ - -e s/{{ROM}}/"${ROM}"/g \ - "${PLIST_MASTER}" > ./tmp.config.plist || exit 1 + sed -e s/\{\{DEVICE_MODEL\}\}/"${DEVICE_MODEL}"/g \ + -e s/\{\{SERIAL\}\}/"${SERIAL}"/g \ + -e s/\{\{BOARD_SERIAL\}\}/"${BOARD_SERIAL}"/g \ + -e s/\{\{UUID\}\}/"${UUID}"/g \ + -e s/\{\{ROM\}\}/"${ROM}"/g \ + -e s/\{\{WIDTH\}\}/"${WIDTH:-1920}"/g \ + -e s/\{\{HEIGHT\}\}/"${HEIGHT:-1080}"/g \ + "${MASTER_PLIST}" > ./tmp.config.plist || exit 1 else - cat < < \__ \/ -_) '_| / _` | | | (_ / -_) ' \/ -_) '_/ _` | _/ _ \ '_| +# \___/|___/_/\_\ |___/\___|_| |_\__,_|_| \___\___|_||_\___|_| \__,_|\__\___/_| # -# Repo: https://github.com/sickcodes/Docker-OSX/ -# Title: Mac on Docker (Docker-OSX) +# Repo: https://github.com/sickcodes/osx-serial-generator/ +# Title: OSX Serial Generator # Author: Sick.Codes https://sick.codes/ # Version: 3.1 # License: GPLv3+ -help_text="Usage: generate-unique-machine-values.sh +set -e + +help_text="Usage: ./generate-unique-machine-values.sh General options: --count, -n, -c Number of serials to generate --model, -m Device model, e.g. 'iMacPro1,1' - --csv Optionally change the CSV output filename. - --tsv Optionally change the TSV output filename. - --output-bootdisk Optionally change the bootdisk qcow output filename. Useless when count > 1. - --output-env Optionally change the bootdisk env filename. Useless when count > 1. - --output-dir Optionally change the script output location. - + --csv Optionally change the CSV output filename + --tsv Optionally change the TSV output filename + --output-dir Optionally change the script output location + --width Resolution x axis length in px, default 1920 + --height Resolution y axis length in px, default 1080 + --input-plist-url Specify an alternative master plist, via URL + --master-plist-url Same as above. + --custom-plist Optionally change the input plist. + --master-plist Same as above. + --output-bootdisk Optionally change the bootdisk filename + --create-envs, --envs Create all corresponding sourcable envs + --create-plists, --plists Create all corresponding config.plists + --create-bootdisks, --bootdisks Create all corresponding bootdisks [SLOW] --help, -h, help Display this help and exit - --plists Create corresponding config.plists for each serial set. - --bootdisks [SLOW] Create corresponding boot disk images for each serial set. + +Additional options only if you are creating ONE serial set: + --output-bootdisk Optionally change the bootdisk filename + --output-env Optionally change the serials env filename + +Custom plist placeholders: + {{DEVICE_MODEL}}, {{SERIAL}}, {{BOARD_SERIAL}}, + {{UUID}}, {{ROM}}, {{WIDTH}}, {{HEIGHT}} Example: - ./generate-unique-machine-values.sh --count 1 --model='iMacPro1,1' --plists --bootdisks + ./generate-unique-machine-values.sh --count 1 --plists --bootdisks --envs - The above example will generate a - - serial - - board serial - - uuid - - MAC address - - ROM value based on lowercase MAC address - - Boot disk qcow image. - - config.plist - -Notes: - - Default is 1 serial for 'iMacPro1,1' in the current working directory. - - Default output is CSV, whereas setting the TSV option will output as tab-separated. - - CSV is double quoted. - - If you do not set a CSV filename, the output will be sent to the output-dir. - - If you do not set an output-dir, the current directory will be the output directory. - - Sourcable environment variable shell files will be written to a folder, 'envs'. - - config.plist files will be written to a folder, 'plists'. +Defaults: + - One serial, for 'iMacPro1,1', in the current working directory + - CSV and TSV output + - plists in ./plists/ & bootdisks in ./bootdisks/ & envs in ./envs + - if you set --bootdisk name, --bootdisks is assumed + - if you set --custom-plist, --plists is assumed + - if you set --output-env, --envs is assumed Author: Sick.Codes https://sick.codes/ -Project: https://github.com/sickcodes/Docker-OSX/ +Project: https://github.com/sickcodes/osx-serial-generator/ +License: GPLv3+ " -MACINFOPKG_VERSION=2.1.2 -PLIST_MASTER=config-nopicker-custom.plist +OPENCORE_IMAGE_MAKER_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/opencore-image-ng.sh' +MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist' # gather arguments while (( "$#" )); do @@ -66,6 +71,7 @@ while (( "$#" )); do export SERIAL_SET_COUNT="${1#*=}" shift ;; + --count* | -c* | -n* ) export SERIAL_SET_COUNT="${2}" shift @@ -76,6 +82,7 @@ while (( "$#" )); do export CSV_OUTPUT_FILENAME="${1#*=}" shift ;; + --csv* ) export CSV_OUTPUT_FILENAME="${2}" shift @@ -86,6 +93,7 @@ while (( "$#" )); do export TSV_OUTPUT_FILENAME="${1#*=}" shift ;; + --tsv* ) export TSV_OUTPUT_FILENAME="${2}" shift @@ -96,6 +104,7 @@ while (( "$#" )); do export OUTPUT_DIRECTORY="${1#*=}" shift ;; + --output-dir* ) export OUTPUT_DIRECTORY="${2}" shift @@ -103,11 +112,12 @@ while (( "$#" )); do ;; --output-bootdisk=* ) - export OUTPUT_QCOW="${1#*=}" + export OUTPUT_BOOTDISK="${1#*=}" shift ;; + --output-bootdisk* ) - export OUTPUT_QCOW="${2}" + export OUTPUT_BOOTDISK="${2}" shift shift ;; @@ -116,6 +126,7 @@ while (( "$#" )); do export OUTPUT_ENV="${1#*=}" shift ;; + --output-env* ) export OUTPUT_ENV="${2}" shift @@ -126,18 +137,69 @@ while (( "$#" )); do export DEVICE_MODEL="${1#*=}" shift ;; + --model* | -m* ) export DEVICE_MODEL="${2}" shift shift ;; - --plists ) + --width=* ) + export WIDTH="${1#*=}" + shift + ;; + + --width* ) + export WIDTH="${2}" + shift + shift + ;; + + --height=* ) + export HEIGHT="${1#*=}" + shift + ;; + + --height* ) + export HEIGHT="${2}" + shift + shift + ;; + + --master-plist-url=* | --input-plist-url=* | --custom-plist-url=* ) + export MASTER_PLIST_URL="${1#*=}" + shift + ;; + + --master-plist-url* | --input-plist-url* | --custom-plist-url* ) + export MASTER_PLIST_URL="${2}" + shift + shift + ;; + + --master-plist=* | --input-plist=* | --custom-plist=* ) + export MASTER_PLIST="${1#*=}" + shift + ;; + + --master-plist* | --input-plist* | --custom-plist* ) + export MASTER_PLIST="${2}" + shift + shift + ;; + + --create-plists | --plists ) export CREATE_PLISTS=1 shift ;; - --bootdisks ) - export CREATE_QCOWS=1 + + --create-bootdisks | --bootdisks ) + export CREATE_BOOTDISKS=1 + shift + ;; + + --create-envs | --envs ) + export CREATE_ENVS=1 shift ;; @@ -150,124 +212,168 @@ done build_mac_serial () { - export MACINFOPKG_VERSION="${MACINFOPKG_VERSION:=2.1.2}" - wget -O "${TARBALL:=./MacInfoPkg.tar.gz}" \ - "https://github.com/acidanthera/MacInfoPkg/archive/${MACINFOPKG_VERSION}.tar.gz" - tar -xzvf "${TARBALL}" - cd "./MacInfoPkg-${MACINFOPKG_VERSION}/macserial" \ - && ./build.tool \ - && cd - - mv "./MacInfoPkg-${MACINFOPKG_VERSION}/macserial/bin/macserial" . - rm -f "${TARBALL}" - rm -rf "./MacInfoPkg-${MACINFOPKG_VERSION}/" + [ -d ./OpenCorePkg ] || git clone --depth 1 https://github.com/acidanthera/OpenCorePkg.git + make -C ./OpenCorePkg/Utilities/macserial/ + mv ./OpenCorePkg/Utilities/macserial/macserial . chmod +x ./macserial stat ./macserial } download_vendor_mac_addresses () { # download the MAC Address vendor list - [[ -e "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" ]] || wget -O "${MAC_ADDRESSES_FILE}" https://gitlab.com/wireshark/wireshark/-/raw/master/manuf + [ -e "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" ] || wget -O "${MAC_ADDRESSES_FILE}" https://gitlab.com/wireshark/wireshark/-/raw/master/manuf } download_qcow_efi_folder () { - git clone --depth 1 https://github.com/kholia/OSX-KVM.git - cp -ra ./OSX-KVM/OpenCore-Catalina/EFI . - mkdir -p ./EFI/OC/Resources - # clone some Apple drivers - git clone --depth 1 https://github.com/acidanthera/OcBinaryData.git - # copy said drivers into EFI/OC/Resources - cp -a ./OcBinaryData/Resources/* ./EFI/OC/Resources + + export EFI_FOLDER=./OpenCore-Catalina/EFI + export RESOURCES_FOLDER=./resources/OcBinaryData/Resources + + # check if we are inside OSX-KVM already + # if not, download OSX-KVM locally + [ -d ./OpenCore-Catalina/EFI/ ] || { + [ -d ./OSX-KVM/ ] || git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git + export EFI_FOLDER="./OSX-KVM/${EFI_FOLDER}" + } + + [ -d ./resources/OcBinaryData/Resources/ ] || { + export RESOURCES_FOLDER="./OSX-KVM/${RESOURCES_FOLDER}" + } + # EFI Shell commands touch startup.nsh && echo 'fs0:\EFI\BOOT\BOOTx64.efi' > startup.nsh + + cp -a "${EFI_FOLDER}" . + + mkdir -p ./EFI/OC/Resources + + # copy Apple drivers into EFI/OC/Resources + cp -a "${RESOURCES_FOLDER}"/* ./EFI/OC/Resources } generate_serial_sets () { - [[ -e ./config-nopicker-custom.plist ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/config-nopicker-custom.plist - [[ -e ./opencore-image-ng.sh ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/opencore-image-ng.sh && chmod +x opencore-image-ng.sh - mkdir -p "${OUTPUT_DIRECTORY}/envs" - export DATE_NOW="$(date +%F-%T)" - export DEVICE_MODEL="${DEVICE_MODEL:=iMacPro1,1}" - export VENDOR_REGEX="${VENDOR_REGEX:=Apple, Inc.}" - - if [[ "${CSV_OUTPUT_FILENAME}" ]] || [[ "${TSV_OUTPUT_FILENAME}" ]]; then - [[ ${CSV_OUTPUT_FILENAME} ]] && export CSV_SERIAL_SETS_FILE="${CSV_OUTPUT_FILENAME}" - [[ ${TSV_OUTPUT_FILENAME} ]] && export TSV_SERIAL_SETS_FILE="${TSV_OUTPUT_FILENAME}" - else - export SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.csv" - fi - - touch "${SERIAL_SETS_FILE}" - echo "Writing serial sets to ${SERIAL_SETS_FILE}" + + + if [ "${CSV_OUTPUT_FILENAME}" ]; then + [ "${CSV_OUTPUT_FILENAME}" ] && export CSV_SERIAL_SETS_FILE="${CSV_OUTPUT_FILENAME}" + else + export CSV_SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.csv" + fi + + if [ "${TSV_OUTPUT_FILENAME}" ]; then + [ "${TSV_OUTPUT_FILENAME}" ] && export TSV_SERIAL_SETS_FILE="${TSV_OUTPUT_FILENAME}" + else + export TSV_SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.tsv" + fi + + ./macserial \ - --num "${SERIAL_SET_COUNT:=1}" \ + --num "${SERIAL_SET_COUNT}" \ --model "${DEVICE_MODEL}" \ | while IFS='\ \|\ ' read -r SERIAL BOARD_SERIAL; do # make a uuid... UUID="$(uuidgen)" - UUID="${UUID^^}" + # bash 3-5 compatible + # UUID="${UUID^^}" + UUID="$(tr '[:lower:]' '[:upper:]' <<< "${UUID}")" # get a random vendor specific MAC address. RANDOM_MAC_PREFIX="$(grep -e "${VENDOR_REGEX}" < "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" | sort --random-sort | head -n1)" RANDOM_MAC_PREFIX="$(cut -d$'\t' -f1 <<< "${RANDOM_MAC_PREFIX}")" - MAC_ADDRESS="$(printf "${RANDOM_MAC_PREFIX}:%02X:%02X:%02X" $[RANDOM%256] $[RANDOM%256] $[RANDOM%256])" + MAC_ADDRESS="$(printf "${RANDOM_MAC_PREFIX}:%02X:%02X:%02X" "$((RANDOM%256))" "$((RANDOM%256))" "$((RANDOM%256))")" + + [ -z "${WIDTH}" ] && WIDTH=1920 + [ -z "${HEIGHT}" ] && HEIGHT=1080 # append to csv file - if [[ "${CSV_SERIAL_SETS_FILE}" ]]; then - echo "\"${DEVICE_MODEL}\",\"${SERIAL}\",\"${BOARD_SERIAL}\",\"${UUID}\",\"${MAC_ADDRESS}\"" >> "${CSV_SERIAL_SETS_FILE}" - fi + tee -a "${CSV_SERIAL_SETS_FILE}" <> "${TSV_SERIAL_SETS_FILE}" - fi + T=$'\t' + tee -a "${TSV_SERIAL_SETS_FILE}" < "${OUTPUT_ENV_FILE}" + # if any of these are on, we need the env file. + if [ "${CREATE_ENVS}" ] || [ "${CREATE_PLISTS}" ] || [ "${CREATE_BOOTDISKS}" ] || [ "${OUTPUT_BOOTDISK}" ] || [ "${OUTPUT_ENV}" ]; then + mkdir -p "${OUTPUT_DIRECTORY}/envs" + OUTPUT_ENV_FILE="${OUTPUT_ENV:-"${OUTPUT_DIRECTORY}/envs/${SERIAL}.env.sh"}" + touch "${OUTPUT_ENV_FILE}" + cat < "${OUTPUT_ENV_FILE}" export DEVICE_MODEL="${DEVICE_MODEL}" export SERIAL="${SERIAL}" export BOARD_SERIAL="${BOARD_SERIAL}" export UUID="${UUID}" export MAC_ADDRESS="${MAC_ADDRESS}" +export WIDTH="${WIDTH}" +export HEIGHT="${HEIGHT}" EOF + fi + # plist required for bootdisks, so create anyway. - if [[ "${CREATE_PLISTS}" ]] || [[ "${CREATE_QCOWS}" ]]; then + if [ "${CREATE_PLISTS}" ] || [ "${CREATE_BOOTDISKS}" ]; then + + # need a config.plist + if [ "${MASTER_PLIST}" ]; then + [ -e "${MASTER_PLIST}" ] || echo "Could not find: ${MASTER_PLIST}" + elif [ "${MASTER_PLIST}" ] && [ "${MASTER_PLIST_URL}" ]; then + echo 'You specified both a custom plist FILE & custom plist URL.' + echo 'Use only one of those options.' + elif [ "${MASTER_PLIST_URL}" ]; then + wget -O "${MASTER_PLIST:=./config-custom.plist}" "${MASTER_PLIST_URL}" + else + # default is config-nopicker-custom.plist from OSX-KVM with placeholders used in Docker-OSX + wget -O "${MASTER_PLIST:=./config-nopicker-custom.plist}" "${MASTER_PLIST_URL}" + fi + mkdir -p "${OUTPUT_DIRECTORY}/plists" source "${OUTPUT_ENV_FILE}" ROM_VALUE="${MAC_ADDRESS//\:/}" ROM_VALUE="${ROM_VALUE,,}" - sed -e s/{{DEVICE_MODEL}}/"${DEVICE_MODEL}"/g \ - -e s/{{SERIAL}}/"${SERIAL}"/g \ - -e s/{{BOARD_SERIAL}}/"${BOARD_SERIAL}"/g \ - -e s/{{UUID}}/"${UUID}"/g \ - -e s/{{ROM}}/"${ROM}"/g \ - "${PLIST_MASTER}" > "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" || exit 1 + sed -e s/\{\{DEVICE_MODEL\}\}/"${DEVICE_MODEL}"/g \ + -e s/\{\{SERIAL\}\}/"${SERIAL}"/g \ + -e s/\{\{BOARD_SERIAL\}\}/"${BOARD_SERIAL}"/g \ + -e s/\{\{UUID\}\}/"${UUID}"/g \ + -e s/\{\{ROM\}\}/"${ROM}"/g \ + -e s/\{\{WIDTH\}\}/"${WIDTH}"/g \ + -e s/\{\{HEIGHT\}\}/"${HEIGHT}"/g \ + "${MASTER_PLIST}" > "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" || exit 1 fi - if [[ "${CREATE_QCOWS}" ]]; then - mkdir -p "${OUTPUT_DIRECTORY}/qcows" + # make bootdisk qcow2 format if --bootdisks, but also if you set the bootdisk filename + if [ "${CREATE_BOOTDISKS}" ] || [ "${OUTPUT_BOOTDISK}" ]; then + [ -e ./opencore-image-ng.sh ] \ + || { wget "${OPENCORE_IMAGE_MAKER_URL}" \ + && chmod +x opencore-image-ng.sh ; } + mkdir -p "${OUTPUT_DIRECTORY}/bootdisks" ./opencore-image-ng.sh \ --cfg "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" \ - --img "${OUTPUT_QCOW:-${OUTPUT_DIRECTORY}/qcows/${SERIAL}.OpenCore-nopicker.qcow2}" || exit 1 + --img "${OUTPUT_BOOTDISK:-${OUTPUT_DIRECTORY}/bootdisks/${SERIAL}.OpenCore-nopicker.qcow2}" || exit 1 fi done - [[ -e "${CSV_SERIAL_SETS_FILE}" ]] && \ - cat <(echo "DEVICE_MODEL,SERIAL,BOARD_SERIAL,UUID,MAC_ADDRESS") "${CSV_SERIAL_SETS_FILE}" + [ -e "${CSV_SERIAL_SETS_FILE}" ] && \ + cat <(echo "DEVICE_MODEL,SERIAL,BOARD_SERIAL,UUID,MAC_ADDRESS,WIDTH,HEIGHT") "${CSV_SERIAL_SETS_FILE}" - [[ -e "${TSV_SERIAL_SETS_FILE}" ]] && \ - cat <(printf "DEVICE_MODEL\tSERIAL\tBOARD_SERIAL\tUUID\tMAC_ADDRESS\n") "${TSV_SERIAL_SETS_FILE}" - + [ -e "${TSV_SERIAL_SETS_FILE}" ] && \ + cat <(printf "DEVICE_MODEL\tSERIAL\tBOARD_SERIAL\tUUID\tMAC_ADDRESS\tWIDTH\tHEIGHT\n") "${TSV_SERIAL_SETS_FILE}" + } main () { # setting default variables if there are no options + export DATE_NOW="$(date +%F-%T)" export DEVICE_MODEL="${DEVICE_MODEL:=iMacPro1,1}" + export VENDOR_REGEX="${VENDOR_REGEX:=Apple, Inc.}" export SERIAL_SET_COUNT="${SERIAL_SET_COUNT:=1}" export OUTPUT_DIRECTORY="${OUTPUT_DIRECTORY:=.}" cat <= 9: + from types import MethodType + + def readPlist(self,filepath): + with open(filepath, 'rb') as f: + p = plistlib._PlistParser(dict) + rootObject = p.parse(f) + return rootObject + # adding the method readPlist() to plistlib + plistlib.readPlist = MethodType(readPlist, plistlib) + +# https://github.com/foxlet/macOS-Simple-KVM/blob/master/tools/FetchMacOS/fetch-macos.py (unused) +# https://github.com/munki/macadmin-scripts +catalogs = { + "CustomerSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16customerseed-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog", + "DeveloperSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16seed-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog", + "PublicSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16beta-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog", + "PublicRelease": "https://swscan.apple.com/content/catalogs/others/index-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog", + "20": "https://swscan.apple.com/content/catalogs/others/index-11-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog" +} + + +def get_default_catalog(): + '''Returns the default softwareupdate catalog for the current OS''' + return catalogs["20"] + # return catalogs["PublicRelease"] + # return catalogs["DeveloperSeed"] + + +class ReplicationError(Exception): + '''A custom error when replication fails''' + pass + + +def cmd_exists(cmd): + return subprocess.call("type " + cmd, shell=True, + stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0 + + +def replicate_url(full_url, + root_dir='/tmp', + show_progress=False, + ignore_cache=False, + attempt_resume=False, installer=False, product_title=""): + '''Downloads a URL and stores it in the same relative path on our + filesystem. Returns a path to the replicated file.''' + + # hack + print("[+] Fetching %s" % full_url) + if installer and "BaseSystem.dmg" not in full_url and "Big Sur" not in product_title: + return + if "Big Sur" in product_title and "InstallAssistant.pkg" not in full_url: + return + attempt_resume = True + # path = urllib.parse.urlsplit(full_url)[2] + path = urlstuff.urlsplit(full_url)[2] + relative_url = path.lstrip('/') + relative_url = os.path.normpath(relative_url) + # local_file_path = os.path.join(root_dir, relative_url) + local_file_path = relative_url + # print("Downloading %s..." % full_url) + + if cmd_exists('wget'): + if not installer: + download_cmd = ['wget', "-c", "--quiet", "-x", "-nH", full_url] + # this doesn't work as there are multiple metadata files with the same name! + # download_cmd = ['wget', "-c", "--quiet", full_url] + else: + download_cmd = ['wget', "-c", full_url] + else: + if not installer: + download_cmd = ['curl', "--silent", "--show-error", "-o", local_file_path, "--create-dirs", full_url] + else: + local_file_path = os.path.basename(local_file_path) + download_cmd = ['curl', "-o", local_file_path, full_url] + + try: + subprocess.check_call(download_cmd) + except subprocess.CalledProcessError as err: + raise ReplicationError(err) + return local_file_path + + +def parse_server_metadata(filename): + '''Parses a softwareupdate server metadata file, looking for information + of interest. + Returns a dictionary containing title, version, and description.''' + title = '' + vers = '' + try: + md_plist = plistlib.readPlist(filename) + except (OSError, IOError, ExpatError) as err: + print('Error reading %s: %s' % (filename, err), file=sys.stderr) + return {} + vers = md_plist.get('CFBundleShortVersionString', '') + localization = md_plist.get('localization', {}) + preferred_localization = (localization.get('English') or + localization.get('en')) + if preferred_localization: + title = preferred_localization.get('title', '') + + metadata = {} + metadata['title'] = title + metadata['version'] = vers + + """ + {'title': 'macOS Mojave', 'version': '10.14.5'} + {'title': 'macOS Mojave', 'version': '10.14.6'} + """ + return metadata + + +def get_server_metadata(catalog, product_key, workdir, ignore_cache=False): + '''Replicate ServerMetaData''' + try: + url = catalog['Products'][product_key]['ServerMetadataURL'] + try: + smd_path = replicate_url( + url, root_dir=workdir, ignore_cache=ignore_cache) + return smd_path + except ReplicationError as err: + print('Could not replicate %s: %s' % (url, err), file=sys.stderr) + return None + except KeyError: + # print('Malformed catalog.', file=sys.stderr) + return None + + +def parse_dist(filename): + '''Parses a softwareupdate dist file, returning a dict of info of + interest''' + dist_info = {} + try: + dom = minidom.parse(filename) + except ExpatError: + print('Invalid XML in %s' % filename, file=sys.stderr) + return dist_info + except IOError as err: + print('Error reading %s: %s' % (filename, err), file=sys.stderr) + return dist_info + + titles = dom.getElementsByTagName('title') + if titles: + dist_info['title_from_dist'] = titles[0].firstChild.wholeText + + auxinfos = dom.getElementsByTagName('auxinfo') + if not auxinfos: + return dist_info + auxinfo = auxinfos[0] + key = None + value = None + children = auxinfo.childNodes + # handle the possibility that keys from auxinfo may be nested + # within a 'dict' element + dict_nodes = [n for n in auxinfo.childNodes + if n.nodeType == n.ELEMENT_NODE and + n.tagName == 'dict'] + if dict_nodes: + children = dict_nodes[0].childNodes + for node in children: + if node.nodeType == node.ELEMENT_NODE and node.tagName == 'key': + key = node.firstChild.wholeText + if node.nodeType == node.ELEMENT_NODE and node.tagName == 'string': + value = node.firstChild.wholeText + if key and value: + dist_info[key] = value + key = None + value = None + return dist_info + + +def download_and_parse_sucatalog(sucatalog, workdir, ignore_cache=False): + '''Downloads and returns a parsed softwareupdate catalog''' + try: + localcatalogpath = replicate_url( + sucatalog, root_dir=workdir, ignore_cache=ignore_cache) + except ReplicationError as err: + print('Could not replicate %s: %s' % (sucatalog, err), file=sys.stderr) + exit(-1) + if os.path.splitext(localcatalogpath)[1] == '.gz': + with gzip.open(localcatalogpath) as the_file: + content = the_file.read() + try: + catalog = plistlib.readPlistFromString(content) + return catalog + except ExpatError as err: + print('Error reading %s: %s' % (localcatalogpath, err), file=sys.stderr) + exit(-1) + else: + try: + catalog = plistlib.readPlist(localcatalogpath) + return catalog + except (OSError, IOError, ExpatError) as err: + print('Error reading %s: %s' % (localcatalogpath, err), file=sys.stderr) + exit(-1) + + +def find_mac_os_installers(catalog): + '''Return a list of product identifiers for what appear to be macOS + installers''' + mac_os_installer_products = [] + if 'Products' in catalog: + for product_key in catalog['Products'].keys(): + product = catalog['Products'][product_key] + try: + if product['ExtendedMetaInfo'][ + 'InstallAssistantPackageIdentifiers']: + mac_os_installer_products.append(product_key) + except KeyError: + continue + + return mac_os_installer_products + + +def os_installer_product_info(catalog, workdir, ignore_cache=False): + '''Returns a dict of info about products that look like macOS installers''' + product_info = {} + installer_products = find_mac_os_installers(catalog) + for product_key in installer_products: + product_info[product_key] = {} + filename = get_server_metadata(catalog, product_key, workdir) + if filename: + product_info[product_key] = parse_server_metadata(filename) + else: + # print('No server metadata for %s' % product_key) + product_info[product_key]['title'] = None + product_info[product_key]['version'] = None + + product = catalog['Products'][product_key] + product_info[product_key]['PostDate'] = product['PostDate'] + distributions = product['Distributions'] + dist_url = distributions.get('English') or distributions.get('en') + try: + dist_path = replicate_url( + dist_url, root_dir=workdir, ignore_cache=ignore_cache) + except ReplicationError as err: + print('Could not replicate %s: %s' % (dist_url, err), + file=sys.stderr) + else: + dist_info = parse_dist(dist_path) + product_info[product_key]['DistributionPath'] = dist_path + product_info[product_key].update(dist_info) + if not product_info[product_key]['title']: + product_info[product_key]['title'] = dist_info.get('title_from_dist') + if not product_info[product_key]['version']: + product_info[product_key]['version'] = dist_info.get('VERSION') + + return product_info + + +def replicate_product(catalog, product_id, workdir, ignore_cache=False, product_title=""): + '''Downloads all the packages for a product''' + product = catalog['Products'][product_id] + for package in product.get('Packages', []): + # TO-DO: Check 'Size' attribute and make sure + # we have enough space on the target + # filesystem before attempting to download + if 'URL' in package: + try: + replicate_url( + package['URL'], root_dir=workdir, + show_progress=True, ignore_cache=ignore_cache, + attempt_resume=(not ignore_cache), installer=True, product_title=product_title) + except ReplicationError as err: + print('Could not replicate %s: %s' % (package['URL'], err), file=sys.stderr) + exit(-1) + if 'MetadataURL' in package: + try: + replicate_url(package['MetadataURL'], root_dir=workdir, + ignore_cache=ignore_cache, installer=True) + except ReplicationError as err: + print('Could not replicate %s: %s' % (package['MetadataURL'], err), file=sys.stderr) + exit(-1) + + +def find_installer_app(mountpoint): + '''Returns the path to the Install macOS app on the mountpoint''' + applications_dir = os.path.join(mountpoint, 'Applications') + for item in os.listdir(applications_dir): + if item.endswith('.app'): + return os.path.join(applications_dir, item) + return None + + +def determine_version(version, product_info): + if version: + if version == 'latest': + from distutils.version import StrictVersion + latest_version = StrictVersion('0.0.0') + for index, product_id in enumerate(product_info): + d = product_info[product_id]['version'] + if d > latest_version: + latest_version = d + + if latest_version == StrictVersion("0.0.0"): + print("Could not find latest version {}") + exit(1) + + version = str(latest_version) + + for index, product_id in enumerate(product_info): + v = product_info[product_id]['version'] + if v == version: + return product_id, product_info[product_id]['title'] + + print("Could not find version {}. Versions available are:".format(version)) + for _, pid in enumerate(product_info): + print("- {}".format(product_info[pid]['version'])) + + exit(1) + + # display a menu of choices (some seed catalogs have multiple installers) + print('%2s %12s %10s %11s %s' % ('#', 'ProductID', 'Version', + 'Post Date', 'Title')) + for index, product_id in enumerate(product_info): + print('%2s %12s %10s %11s %s' % ( + index + 1, + product_id, + product_info[product_id]['version'], + product_info[product_id]['PostDate'].strftime('%Y-%m-%d'), + product_info[product_id]['title'] + )) + + answer = input( + '\nChoose a product to download (1-%s): ' % len(product_info)) + try: + index = int(answer) - 1 + if index < 0: + raise ValueError + product_id = list(product_info.keys())[index] + return product_id, product_info[product_id]['title'] + except (ValueError, IndexError): + pass + + print('Invalid input provided.') + exit(0) + + +def main(): + '''Do the main thing here''' + """ + if os.getuid() != 0: + sys.exit('This command requires root (to install packages), so please ' + 'run again with sudo or as root.') + """ + parser = argparse.ArgumentParser() + parser.add_argument('--workdir', metavar='path_to_working_dir', + default='.', + help='Path to working directory on a volume with over ' + '10G of available space. Defaults to current working ' + 'directory.') + parser.add_argument('--version', metavar='version', + default=None, + help='The version to download in the format of ' + '"$major.$minor.$patch", e.g. "10.15.4". Can ' + 'be "latest" to download the latest version.') + parser.add_argument('--compress', action='store_true', + help='Output a read-only compressed disk image with ' + 'the Install macOS app at the root. This is now the ' + 'default. Use --raw to get a read-write sparse image ' + 'with the app in the Applications directory.') + parser.add_argument('--raw', action='store_true', + help='Output a read-write sparse image ' + 'with the app in the Applications directory. Requires ' + 'less available disk space and is faster.') + parser.add_argument('--ignore-cache', action='store_true', + help='Ignore any previously cached files.') + args = parser.parse_args() + + su_catalog_url = get_default_catalog() + if not su_catalog_url: + print('Could not find a default catalog url for this OS version.', file=sys.stderr) + exit(-1) + + # download sucatalog and look for products that are for macOS installers + catalog = download_and_parse_sucatalog( + su_catalog_url, args.workdir, ignore_cache=args.ignore_cache) + product_info = os_installer_product_info( + catalog, args.workdir, ignore_cache=args.ignore_cache) + + if not product_info: + print('No macOS installer products found in the sucatalog.', file=sys.stderr) + exit(-1) + + product_id, product_title = determine_version(args.version, product_info) + print(product_id, product_title) + + # download all the packages for the selected product + replicate_product(catalog, product_id, args.workdir, ignore_cache=args.ignore_cache, product_title=product_title) + + +if __name__ == '__main__': + main() diff --git a/osx-serial-generator b/osx-serial-generator new file mode 160000 index 0000000..1d7425a --- /dev/null +++ b/osx-serial-generator @@ -0,0 +1 @@ +Subproject commit 1d7425a7fa929423d965334cd78e9c75aeff2ad0 diff --git a/tests/test.sh b/tests/test.sh new file mode 100644 index 0000000..2218921 --- /dev/null +++ b/tests/test.sh @@ -0,0 +1,301 @@ +#!/usr/bin/docker +# ____ __ ____ ______ __ +# / __ \____ _____/ /_____ _____/ __ \/ ___/ |/ / +# / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \| / +# / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | +# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| TESTS +# +# Title: Docker-OSX (Mac on Docker) +# Author: Sick.Codes https://twitter.com/sickcodes +# Version: 4.2 +# License: GPLv3+ +# Repository: https://github.com/sickcodes/Docker-OSX +# Website: https://sick.codes +# +# Status: Work in progress. +# + +help_text="Usage: ./test.sh --branch --repo + +General options: + --branch, -b Git branch, default is master + --repo, -r Alternative link to build + --mirror-country, -m Two letter country code for Arch mirrors + --docker-username, -u Docker hub username + --docker-password, -p Docker hub password + --vnc-password, -v Choose a VNC passwd. + +Flags + --no-cache, -n Enable --no-cache (default already) + --no-no-cache, -nn Disable --no-cache docker builds + --help, -h, help Display this help and exit +" + +# set -xeuf -o pipefail + + +# gather arguments +while (( "$#" )); do + case "${1}" in + + --help | -h | h | help ) + echo "${help_text}" && exit 0 + ;; + + --branch=* | -b=* ) + export BRANCH="${1#*=}" + shift + ;; + --branch* | -b* ) + export BRANCH="${2}" + shift + shift + ;; + --repo=* | -r=* ) + export REPO="${1#*=}" + shift + ;; + --repo* | -r* ) + export REPO="${2}" + shift + shift + ;; + --mirror-country=* | -m=* ) + export MIRROR_COUNTRY="${1#*=}" + shift + ;; + --mirror-country* | -m* ) + export MIRROR_COUNTRY="${2}" + shift + shift + ;; + --vnc-password=* | -v=* | --vnc-passwd=* ) + export VNC_PASSWORD="${1#*=}" + shift + ;; + --vnc-password* | -v* | --vnc-passwd* ) + export VNC_PASSWORD="${2}" + shift + shift + ;; + --docker-username=* | -u=* ) + export DOCKER_USERNAME="${1#*=}" + shift + ;; + --docker-username* | -u* ) + export DOCKER_USERNAME="${2}" + shift + shift + ;; + --docker-password=* | -p=* ) + export DOCKER_PASSWORD="${1#*=}" + shift + ;; + --docker-password* | -p* ) + export DOCKER_PASSWORD="${2}" + shift + shift + ;; + --no-cache | -n ) + export NO_CACHE='--no-cache' + shift + ;; + --no-no-cache | -nn ) + export NO_CACHE= + shift + ;; + *) + echo "Invalid option: ${1}" + exit 1 + ;; + + esac +done + +BRANCH="${BRANCH:=master}" +REPO="${REPO:=https://github.com/sickcodes/Docker-OSX.git}" +VNC_PASSWORD="${VNC_PASSWORD:=testing}" +MIRROR_COUNTRY="${MIRROR_COUNTRY:=US}" +NO_CACHE="${NO_CACHE:=--no-cache}" + + +TEST_BUILDS=( +'docker-osx:latest' +'docker-osx:naked' +'docker-osx:big-sur' +'docker-osx:auto' +#'docker-osx:auto-big-sur' +) + +install_docker () { + apt remove docker docker-engine docker.io containerd runc -y \ + ; apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -y \ + && curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - \ + && apt-key fingerprint 0EBFCD88 \ + && add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" \ + && apt update -y \ + && apt install docker-ce docker-ce-cli containerd.io -y \ + && usermod -aG docker "${USER}" \ + && su hook docker run --rm hello-world +} + +install_vnc () { + apt update -y \ + && apt install xorg openbox tigervnc-standalone-server tigervnc-common tigervnc-xorg-extension tigervnc-viewer -y \ + && mkdir -p ${HOME}/.vnc \ + && touch ~/.vnc/config \ + && tee -a ~/.vnc/config <<< 'geometry=1920x1080' \ + && tee -a ~/.vnc/config <<< 'localhost' \ + && tee -a ~/.vnc/config <<< 'alwaysshared' \ + && touch ./vnc.sh \ + && printf '\n%s\n' \ + 'sudo rm -f /tmp/.X99-lock' \ + 'export DISPLAY=:99' \ + '/usr/bin/Xvnc -geometry 1920x1080 -rfbauth ~/.vnc/passwd :99 &' > ./vnc.sh \ + && tee vncpasswd_file <<< "${VNC_PASSWORD:=testing}" && echo "${VNC_PASSWORD:="$(tr -dc '[:graph:]' ${HOME}/.vnc/passwd \ + && chmod 600 ~/.vnc/passwd \ + && apt install qemu qemu-kvm libvirt-clients libvirt-daemon-system bridge-utils virt-manager -y \ + && sudo systemctl enable libvirtd.service \ + && sudo systemctl enable virtlogd.service \ + && echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs \ + && sudo modprobe kvm \ + && echo 'export DISPLAY=:99' >> ~/.bashrc \ + && printf '\n\n\n\n%s\n%s\n\n\n\n' '===========VNC_PASSWORD========== ' "$( Launch_custom.sh RUN chmod +x Launch_custom.sh -RUN tee vncpasswd_file <<< "${VNC_PASSWORD:=$(openssl rand -hex 4)}" +RUN tee vncpasswd_file <<< "${VNC_PASSWORD:="$(tr -dc '[:graph:]' ${HOME}/.vnc/passwd RUN chmod 600 ~/.vnc/passwd diff --git a/vnc-version/Dockerfile.nakedvnc b/vnc-version/Dockerfile.nakedvnc new file mode 100644 index 0000000..9203e58 --- /dev/null +++ b/vnc-version/Dockerfile.nakedvnc @@ -0,0 +1,208 @@ +#!/usr/bin/docker +# ____ __ ____ ______ __ +# / __ \____ _____/ /_____ _____/ __ \/ ___/ |/ / +# / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \| / +# / /_/ / /_/ / /__/ ,< / __/ / / /_/ /___/ / | +# /_____/\____/\___/_/|_|\___/_/ \____//____/_/|_| :NAKED +# +# Title: Docker-OSX (Mac on Docker) +# Author: Sick.Codes https://twitter.com/sickcodes +# Version: 4.3 +# License: GPLv3+ +# Repository: https://github.com/sickcodes/Docker-OSX +# Website: https://sick.codes +# +# This image won't run unless you supply a disk image using: +# -v ${PWD}/mac_hdd_ng.img:/image +# +# Take screenshots in the Arch container and display in terminal: scrotcat +# +# Build: +# +# docker build -t docker-osx:naked -f Dockerfile.naked . +# +# Run headless: +# +# docker run -it --device /dev/kvm -p 50922:10022 -v ${PWD}/mac_hdd_ng.img:/image docker-osx:naked +# +# Run with display: +# +# docker run -it --device /dev/kvm -p 50922:10022 -v ${PWD}/mac_hdd_ng.img:/image -e "DISPLAY=${DISPLAY:-:0.0}" -v /tmp/.X11-unix:/tmp/.X11-unix docker-osx:naked +# + +FROM sickcodes/docker-osx:latest + +MAINTAINER 'https://twitter.com/sickcodes' + +USER root + +WORKDIR /root + +RUN rm -f /home/arch/OSX-KVM/mac_hdd_ng.img + +# OPTIONAL: Arch Linux server mirrors for super fast builds +# set RANKMIRRORS to any value other that nothing, e.g. -e RANKMIRRORS=true +ARG RANKMIRRORS +ARG MIRROR_COUNTRY=US +ARG MIRROR_COUNT=10 +RUN if [[ "${RANKMIRRORS}" ]]; then { pacman -Sy wget --noconfirm || pacman -Syu wget --noconfirm ; } \ + ; wget -O ./rankmirrors "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/rankmirrors" \ + ; wget -O- "https://www.archlinux.org/mirrorlist/?country=${MIRROR_COUNTRY:-US}&protocol=https&use_mirror_status=on" \ + | sed -e 's/^#Server/Server/' -e '/^#/d' \ + | head -n "$((${MIRROR_COUNT:-10}+1))" \ + | bash ./rankmirrors --verbose --max-time 5 - > /etc/pacman.d/mirrorlist \ + && tee -a /etc/pacman.d/mirrorlist <<< 'Server = http://mirrors.evowise.com/archlinux/$repo/os/$arch' \ + && tee -a /etc/pacman.d/mirrorlist <<< 'Server = http://mirror.rackspace.com/archlinux/$repo/os/$arch' \ + && tee -a /etc/pacman.d/mirrorlist <<< 'Server = https://mirror.rackspace.com/archlinux/$repo/os/$arch' \ + && cat /etc/pacman.d/mirrorlist ; fi + +# TEMP-FIX for pacman issue +RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for pacman issue + +# For taking screenshots of the Xfvb screen, useful during development. +ARG SCROT + +RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \ + && if [[ "${SCROT}" ]]; then \ + pacman -Syu scrot base-devel --noconfirm \ + && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \ + && cd imcat \ + && make \ + && sudo cp imcat /usr/bin/imcat \ + && touch /usr/bin/scrotcat \ + && tee -a /usr/bin/scrotcat <<< '/usr/bin/imcat <(scrot -o /dev/stdout)' \ + && chmod +x /usr/bin/scrotcat \ + ; else \ + touch /usr/bin/scrotcat \ + && echo echo >> /usr/bin/scrotcat \ + && chmod +x /usr/bin/scrotcat \ + ; fi \ + ; yes | pacman -Scc + +# TEMP-FIX for pacman issue +RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \ + && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \ + && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine." +# TEMP-FIX for pacman issue + +USER arch + +WORKDIR /home/arch/OSX-KVM + +RUN mkdir -p ~/.ssh \ + && touch ~/.ssh/authorized_keys \ + && touch ~/.ssh/config \ + && chmod 700 ~/.ssh \ + && chmod 600 ~/.ssh/config \ + && chmod 600 ~/.ssh/authorized_keys \ + && tee -a ~/.ssh/config <<< 'Host *' \ + && tee -a ~/.ssh/config <<< ' StrictHostKeyChecking no' \ + && tee -a ~/.ssh/config <<< ' UserKnownHostsFile=/dev/null' + +#### SPECIAL RUNTIME ARGUMENTS BELOW + +ENV ADDITIONAL_PORTS= + +ENV BOOTDISK= + +ENV DISPLAY=:99 + +ENV HEADLESS=false + +ENV ENV=/env + +# Boolean for generating a bootdisk with new random serials. +ENV GENERATE_UNIQUE=false + +# Boolean for generating a bootdisk with specific serials. +ENV GENERATE_SPECIFIC=false + +ENV IMAGE_PATH=/image +ENV IMAGE_FORMAT=qcow2 + +ENV KVM='accel=kvm:tcg' + +# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist" + +# ENV NETWORKING=e1000-82545em +ENV NETWORKING=vmxnet3 + +ENV NOPICKER=true + +# dynamic RAM options for runtime +ENV RAM=8 +# ENV RAM=max +# ENV RAM=half + +# The x and y coordinates for resolution. +# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true. +ENV WIDTH=1920 +ENV HEIGHT=1080 + +CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \ + ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \ + ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \ + nohup Xvfb :99 -screen 0 1920x1080x16 \ + & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \ + ; } \ + ; [[ "${NOPICKER}" == true ]] && { \ + sed -i '/^.*InstallMedia.*/d' Launch.sh \ + && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \ + ; } \ + || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + ; [[ "${GENERATE_UNIQUE}" == true ]] && { \ + ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ + --count 1 \ + --tsv ./serial.tsv \ + --bootdisks \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + --output-env "${ENV:=/env}" \ + ; } \ + ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \ + source "${ENV:=/env}" 2>/dev/null \ + ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \ + --master-plist-url="${MASTER_PLIST_URL}" \ + --model "${DEVICE_MODEL}" \ + --serial "${SERIAL}" \ + --board-serial "${BOARD_SERIAL}" \ + --uuid "${UUID}" \ + --mac-address "${MAC_ADDRESS}" \ + --width "${WIDTH:-1920}" \ + --height "${HEIGHT:-1080}" \ + --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \ + ; } \ + # ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh + +WORKDIR /home/arch/OSX-KVM + +RUN sudo pacman -Syyuu --noconfirm \ + && sudo pacman -S tigervnc xterm xorg-xhost xdotool ufw --noconfirm \ + && mkdir -p ${HOME}/.vnc \ + && touch ~/.vnc/config \ + && tee -a ~/.vnc/config <<< 'geometry=1920x1080' \ + && tee -a ~/.vnc/config <<< 'localhost' \ + && tee -a ~/.vnc/config <<< 'alwaysshared' + +RUN printf '\n%s\n' \ +'sudo rm -f /tmp/.X99-lock' \ +'export DISPLAY=:99' \ +'/usr/bin/Xvnc -geometry 1920x1080 -rfbauth "${HOME}/.vnc/passwd" :99 &' > vnc.sh + +RUN cat vnc.sh Launch.sh > Launch_custom.sh + +RUN chmod +x Launch_custom.sh + +RUN tee vncpasswd_file <<< "${VNC_PASSWORD:="$(tr -dc '[:graph:]' ${HOME}/.vnc/passwd + +RUN chmod 600 ~/.vnc/passwd +RUN printf '\n\n\n\n%s\n%s\n\n\n\n' '===========VNC_PASSWORD========== ' "$(