Skip to content

Run a virtual iPhone on an Apple Silicon Mac.

Swift

Describe the open-source boot ROMs in the READMEs

Lakrf9da24d45d0e
diff --git a/Documents/README_ja.md b/Documents/README_ja.md
index eb322960..abf01d15 100644
--- a/Documents/README_ja.md
+++ b/Documents/README_ja.md
@@ -105,6 +105,24 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/health
token は起動のたびに新しく生成されます。token を固定するには、環境変数 `VPHONE_API_TOKEN` を設定してください。token のないリクエストと Web ページからのリクエストは、どちらも拒否されます。インターフェースの説明は [API ドキュメント](../Research/vphoned_http_api.md)をご覧ください。
+## ブート ROM
+
+新しく作成した仮想マシンは、Virtualization.framework に含まれるクローズドな ROM ではなく、2 つのオープンソース ROM から起動します。
+
+- [OpenAVB](https://github.com/owngoal-dev/OpenAVB) はブート ROM の AVPBooter の代わりです。パッチが不要なので、`fw patch` は変更しません。
+- [OpenSEP](https://github.com/owngoal-dev/OpenSEP) は SEP ブート ROM の AVPSEPBooter の代わりです。
+
+両方を使うと、iBoot と SEPOS より前に実行されるコードに Apple が書いたものはなくなります。どちらもビルド済みの状態で `VPhone.bundle` に含まれており、固定した上流のコミットからビルドされています。それぞれの説明([OpenAVB](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenAVB/README.md)、[OpenSEP](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenSEP/README.md))に、ソースからビルドし直してバイト単位で照合する方法があります。
+
+以前のバージョンで作成した仮想マシンは Apple の ROM のままです。どちらの ROM にも、システムを復元し直さずに切り替えられます。次回の起動から反映されます。
+
+```sh
+vphone-cli vm config myphone --rom openavb --seprom opensep # オープンソース ROM
+vphone-cli vm config myphone --rom apple --seprom apple # Apple の ROM
+```
+
+`vphone-cli vm info myphone` で仮想マシンが使っている ROM を確認できます。OpenAVB で起動する仮想マシンを復元するには、`VPhone.bundle` 2.10.1 以降が必要です。詳しくは研究記録の [OpenAVB](../Research/Firmware/openavb_boot_rom.md) と [OpenSEP](../Research/Firmware/opensep_sep_rom.md) をご覧ください。
+
## 問題が起きたら
まず[トラブルシューティング](Guides/troubleshooting.md)をご覧ください。仮想マシン用プログラムがシステムに拒否される、復元に失敗する、「Press home to continue」で止まる、といった状況を扱っています。それでも解決しない場合は、[issue を送信](https://github.com/Lakr233/vphone-cli/issues)してください。
@@ -142,3 +160,4 @@ token は起動のたびに新しく生成されます。token を固定する
## 謝辞
- [wh1te4ever/super-tart-vphone-writeup](https://github.com/wh1te4ever/super-tart-vphone-writeup)
+- [owngoal-dev/OpenAVB](https://github.com/owngoal-dev/OpenAVB) と [owngoal-dev/OpenSEP](https://github.com/owngoal-dev/OpenSEP):新しい仮想マシンが起動に使うブート ROM
diff --git a/Documents/README_ko.md b/Documents/README_ko.md
index a7222bc9..65185d74 100644
--- a/Documents/README_ko.md
+++ b/Documents/README_ko.md
@@ -104,6 +104,24 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/health
시작할 때마다 새 token이 생성됩니다. 고정된 token을 사용하려면 환경 변수 `VPHONE_API_TOKEN`을 설정하세요. token이 없는 요청과 웹 페이지에서 온 요청은 모두 거부됩니다. 인터페이스 설명은 [API 문서](../Research/vphoned_http_api.md)를 참고하세요.
+## 부트 ROM
+
+새로 만든 가상 머신은 Virtualization.framework에 포함된 비공개 ROM 대신 두 가지 오픈 소스 ROM으로 부팅합니다.
+
+- [OpenAVB](https://github.com/owngoal-dev/OpenAVB)는 부트 ROM인 AVPBooter를 대신합니다. 패치가 필요 없으므로 `fw patch`가 건드리지 않습니다.
+- [OpenSEP](https://github.com/owngoal-dev/OpenSEP)는 SEP 부트 ROM인 AVPSEPBooter를 대신합니다.
+
+둘을 함께 쓰면 iBoot와 SEPOS 이전에 실행되는 코드 중 Apple이 작성한 것은 없습니다. 두 ROM 모두 미리 빌드된 상태로 `VPhone.bundle`에 포함되며, 고정된 업스트림 커밋에서 빌드됩니다. 각각의 설명([OpenAVB](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenAVB/README.md), [OpenSEP](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenSEP/README.md))에 소스에서 다시 빌드하고 바이트 단위로 대조하는 방법이 있습니다.
+
+이전 버전에서 만든 가상 머신은 Apple의 ROM을 그대로 사용합니다. 시스템을 다시 복원하지 않고 어느 쪽으로든 전환할 수 있으며, 다음 시작부터 적용됩니다.
+
+```sh
+vphone-cli vm config myphone --rom openavb --seprom opensep # 오픈 소스 ROM
+vphone-cli vm config myphone --rom apple --seprom apple # Apple의 ROM
+```
+
+`vphone-cli vm info myphone`으로 가상 머신이 사용하는 ROM을 확인할 수 있습니다. OpenAVB로 부팅하는 가상 머신을 복원하려면 `VPhone.bundle` 2.10.1 이상이 필요합니다. 자세한 내용은 연구 기록의 [OpenAVB](../Research/Firmware/openavb_boot_rom.md)와 [OpenSEP](../Research/Firmware/opensep_sep_rom.md)를 참고하세요.
+
## 문제가 생기면
먼저 [문제 해결](Guides/troubleshooting.md)을 확인하세요. 시스템이 가상 머신 프로그램을 거부하는 경우, 복원 실패, “Press home to continue”에서 멈추는 경우 등을 다룹니다. 그래도 해결되지 않으면 [이슈를 등록](https://github.com/Lakr233/vphone-cli/issues)해 주세요.
@@ -141,3 +159,4 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/health
## 감사의 말
- [wh1te4ever/super-tart-vphone-writeup](https://github.com/wh1te4ever/super-tart-vphone-writeup)
+- [owngoal-dev/OpenAVB](https://github.com/owngoal-dev/OpenAVB)와 [owngoal-dev/OpenSEP](https://github.com/owngoal-dev/OpenSEP): 새 가상 머신이 부팅에 쓰는 부트 ROM
diff --git a/Documents/README_zh.md b/Documents/README_zh.md
index 61710875..020cc24b 100644
--- a/Documents/README_zh.md
+++ b/Documents/README_zh.md
@@ -103,6 +103,24 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/health
每次启动都会生成新的 token。要使用固定的 token,请设置环境变量 `VPHONE_API_TOKEN`。不带 token 的请求和来自网页的请求都会被拒绝。接口说明见 [API 文档](../Research/vphoned_http_api.md)。
+## 启动 ROM
+
+新建的虚拟机不再使用 Virtualization.framework 自带的闭源 ROM,而是从两个开源 ROM 启动:
+
+- [OpenAVB](https://github.com/owngoal-dev/OpenAVB) 替代启动 ROM AVPBooter。它不需要打补丁,`fw patch` 不会改动它。
+- [OpenSEP](https://github.com/owngoal-dev/OpenSEP) 替代 SEP 启动 ROM AVPSEPBooter。
+
+两个一起用时,iBoot 和 SEPOS 之前运行的代码都不再出自 Apple。两个 ROM 都以预编译形式随 `VPhone.bundle` 发布,构建自固定的上游 commit。各自的说明([OpenAVB](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenAVB/README.md)、[OpenSEP](../VPhoneExecutable/VPhoneVirtualization/Resources/OpenSEP/README.md))写了如何从源码重新构建并逐字节核对。
+
+旧版本创建的虚拟机仍使用 Apple 的 ROM。两种 ROM 可以随时切换,不需要重新恢复系统,下次启动时生效:
+
+```sh
+vphone-cli vm config myphone --rom openavb --seprom opensep # 开源 ROM
+vphone-cli vm config myphone --rom apple --seprom apple # Apple 的 ROM
+```
+
+`vphone-cli vm info myphone` 会显示虚拟机使用的 ROM。恢复使用 OpenAVB 启动的虚拟机,需要 `VPhone.bundle` 2.10.1 或更新版本。详细内容见研究记录中的 [OpenAVB](../Research/Firmware/openavb_boot_rom.md) 和 [OpenSEP](../Research/Firmware/opensep_sep_rom.md)。
+
## 遇到问题
请先查看[故障排查](Guides/troubleshooting.md),其中包括虚拟机程序被系统拒绝、恢复失败、停在 “Press home to continue” 等情况。如果仍未解决,请[提交 issue](https://github.com/Lakr233/vphone-cli/issues)。
@@ -140,3 +158,4 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/health
## 致谢
- [wh1te4ever/super-tart-vphone-writeup](https://github.com/wh1te4ever/super-tart-vphone-writeup)
+- [owngoal-dev/OpenAVB](https://github.com/owngoal-dev/OpenAVB) 和 [owngoal-dev/OpenSEP](https://github.com/owngoal-dev/OpenSEP):新虚拟机使用的启动 ROM
diff --git a/README.md b/README.md
index cb3f86ec..252ea20d 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,24 @@ VMs are stored in `~/.vphone/`. Run `vphone-cli <group> --help` to see all comma
To turn on the automation API, add `--api-listen 127.0.0.1:8765` at launch and use the token it prints. See the [API documentation](Research/vphoned_http_api.md).
+## Boot ROMs
+
+New VMs start from two open-source ROMs instead of the closed ones in Virtualization.framework:
+
+- [OpenAVB](https://github.com/owngoal-dev/OpenAVB) replaces AVPBooter, the boot ROM. It needs no patch, so `fw patch` leaves it alone.
+- [OpenSEP](https://github.com/owngoal-dev/OpenSEP) replaces AVPSEPBooter, the SEP boot ROM.
+
+With both, nothing Apple wrote runs before iBoot and SEPOS. Both ship in `VPhone.bundle`, prebuilt from pinned upstream commits. Each one's README ([OpenAVB](VPhoneExecutable/VPhoneVirtualization/Resources/OpenAVB/README.md), [OpenSEP](VPhoneExecutable/VPhoneVirtualization/Resources/OpenSEP/README.md)) says how to rebuild it and check it byte for byte.
+
+VMs created by earlier versions keep Apple's ROMs. A VM switches either way without a restore, from its next start:
+
+```sh
+vphone-cli vm config myphone --rom openavb --seprom opensep # open-source ROMs
+vphone-cli vm config myphone --rom apple --seprom apple # Apple's ROMs
+```
+
+`vphone-cli vm info myphone` shows which ROMs a VM uses. Restoring a VM that boots OpenAVB needs `VPhone.bundle` 2.10.1 or newer. For the details, see [OpenAVB](Research/Firmware/openavb_boot_rom.md) and [OpenSEP](Research/Firmware/opensep_sep_rom.md) in the research notes.
+
## Documentation
| Document | Contents |
@@ -90,3 +108,4 @@ If these do not solve your problem, [open an issue](https://github.com/Lakr233/v
## Acknowledgements
- [wh1te4ever/super-tart-vphone-writeup](https://github.com/wh1te4ever/super-tart-vphone-writeup)
+- [owngoal-dev/OpenAVB](https://github.com/owngoal-dev/OpenAVB) and [owngoal-dev/OpenSEP](https://github.com/owngoal-dev/OpenSEP), the boot ROMs new VMs start from