mirror of
https://github.com/dortania/OpenCore-Legacy-Patcher.git
synced 2026-04-11 16:27:19 +10:00
Add Privileged Helper Tool Documentation
This commit is contained in:
34
ci_tooling/privileged_helper_tool/README.md
Normal file
34
ci_tooling/privileged_helper_tool/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# OpenCore Legacy Patcher Privileged Helper Tool
|
||||
|
||||
`com.dortania.opencore-legacy-patcher.privileged-helper` is OpenCore Legacy Patcher's Privileged Helper Tool.
|
||||
|
||||
The architecture is as such:
|
||||
1. The main application (OpenCore-Patcher.app) will send arguments to the privileged helper tool to execute.
|
||||
2. The privileged helper tool will check the code signature of the main application to ensure it is signed by Dortania.
|
||||
3. The privileged helper tool will then execute the command and return the output to the main application.
|
||||
|
||||
The helper tool is able to execute code as root by using the "Set UID" bit present on the file.
|
||||
|
||||
|
||||
## Running from source
|
||||
|
||||
Since running OpenCore Legacy Patcher from source will lack Dortania's code signature, you will need to disable code signature verification in the privileged helper tool otherwise root commands will fail.
|
||||
|
||||
To do so, compile the privileged helper tool with debug:
|
||||
```
|
||||
make debug
|
||||
```
|
||||
|
||||
Then when you build OpenCore-Patcher.pkg, the debug version of the helper tool will be used.
|
||||
|
||||
|
||||
### Security Considerations
|
||||
|
||||
When using the Privileged Helper Tool from source, you are now adding a security risk to your system. By disabling the code signature checks, any malicious application is given ability to execute code as root.
|
||||
|
||||
If possible, we highly recommend creating a developer account with Apple and signing the application with your own ["Developer ID Application" certificate](https://developer.apple.com/help/account/create-certificates/create-developer-id-certificates/). This will allow you to run the application without disabling code signature checks.
|
||||
|
||||
* Note that Dortania's Team ID will need to be replaced in main.m with your own Team ID (`S74BDJXQMD` -> `YOUR_TEAM`)
|
||||
* Additionally you will be required to compile OpenCore-Patcher.app with your own Developer ID Application certificate
|
||||
|
||||
If this is not possible, we recommend using [OpenCore Legacy Patcher's prebuilt binaries](../../SOURCE.md) instead.
|
||||
Reference in New Issue
Block a user