Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n3d1117/cook
macOS command line tool to automate common iOS development tasks
https://github.com/n3d1117/cook
altstore apple commandline-tool iosdevelopment provisioning-profiles swift xcode
Last synced: 3 months ago
JSON representation
macOS command line tool to automate common iOS development tasks
- Host: GitHub
- URL: https://github.com/n3d1117/cook
- Owner: n3d1117
- License: gpl-3.0
- Created: 2019-12-11T19:55:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-21T11:23:19.000Z (over 2 years ago)
- Last Synced: 2024-10-10T19:23:56.541Z (4 months ago)
- Topics: altstore, apple, commandline-tool, iosdevelopment, provisioning-profiles, swift, xcode
- Language: Swift
- Homepage:
- Size: 3.27 MB
- Stars: 85
- Watchers: 7
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cook 👨🏻🍳
Cook is a macOS command line tool wrapped around [Riley Testut's AltSign](https://github.com/rileytestut/AltSign) to automate common iOS development tasks, such as managing iOS certificates, app identifiers, devices, provisioning profiles and resigning `.ipa` files. It works with free Apple IDs (not enrolled in the developer program).
## Usage
```
./cook [AUTHENTICATION] [RECIPE] [RECIPE_ARGUMENTS]
```
### Generic arguments
`-h, --help` prints usage information
`-v, --verbose` enables verbose mode
`-j, --json` use json output (all --output-* args are ignored in this mode)
### Authentication
To authenticate you can pass the following arguments to any recipe:
`--appleId` (your Apple ID's email) and `--password` (Apple ID's Password).
If you prefer, you can set these environment variables instead: `COOK_APPLEID_EMAIL` and `COOK_APPLEID_PASSWORD`.
Pass `--2fa-code` to specify the six-digit two factor authentication code.
You can also specify `--base64-anisette-data` to use custom base64 encoded anisette data in your requests (for example, generated with `anisette_server` recipe).
**NOTE:** Your Apple ID is **never** sent to anyone but Apple. Feel free to create a new Apple ID account to test it.
### Recipes
- **`create_certificate`** Create certificate (`.pem` or `.p12`) with arguments:
```
--machine-name Optional machine name (defaults to 'cook')
--input-csr Optional path to an existing CSR file
--output-pem Path/Directory where to save output PEM file
--output-p12 Path/Directory where to save output p12 file
--p12-password Optional P12 password, defaults to blank
-f Force certificate revocation if needed
```
- **`register_app`** Register a new app with arguments:
```
--app-name App name to register
--app-bundle-id Bundle identifier to register
-f Force removal of previous app if needed
```
- **`register_device`** Register device with arguments:
```
--name Device name (use quotes if it contains spaces)
--udid Device udid
```
- **`update_profile`** Update & download provisioning profile with arguments:
```
--bundle-id Bundle identifier of the app
--output-profile Path/Directory where to save updated profile
-f Force remove app ID and then readd it
```
- **`download_profiles`** Download provisioning profiles with arguments:
```
--bundle-id Optional, to specify an app's identifier (defaults to all apps)
--output-folder Directory where to save the profiles
```
- **`resign`** Resign ipa file with arguments:
```
--ipa Path to .ipa file to resign
--output-ipa Optional path to resigned ipa (if not specified, original is overwritten)
--p12 Optional path to P12 certificate to use for resigning
--p12-password Optional P12 password
--machine-name Optional machine name to use when adding certificate (defaults to 'cook', ignored if --p12 is specified)
-f Revoke certificate (if --p12 is not specified) if needed, register app id if needed
```
- **`anisette_server`** Listen to a specific port and respond with freshly generated base64 encoded anisette data. Arguments:
```
--port Server port (defaults to 8080)
--secret Secret path (the url will be 127.0.0.1:{PORT}/{SECRET})
```
### JSON Mode
In JSON mode (`-j, --json` flag), command output is formatted as JSON.
See possible JSON responses
```
'success': '0' or '1'
'error': Error description (if success is 0)
- create_certificate recipe
'pem_cert': Plain text PEM cert
'base64_p12_cert': Base 64 encoded P12 cert
'p12_password': Plain text P12 password
- update_profile recipe
'base_64_profile': Base 64 encoded mobileprovision
- download_profiles recipe
'profiles_count': Number of profiles downloaded
'base64_profile_i': i-th base 64 encoded mobileprovision (0
### Sample usage
Here are some real world examples on how to use cook (authentication part is omitted):
See examples
- Export `.pem` certificate generated using an existing `.csr` file:
```bash
./cook create_certificate --input-csr ~/desktop/req.csr --output-pem ~/desktop/cert.pem
```
- Export `.p12` certificate with password `123`:
```bash
./cook create_certificate --output-p12 ~/desktop/cert.p12 -—p12-password "123"
```
- Register app named `My Fancy App` with bundle identifier `my.fancy.app`:
```bash
./cook register_app --app-name "My Fancy App" --app-bundle-id my.fancy.app
```
- Register a device named `My iPhone 11 Pro` with udid `DEVICE_UDID`:
```bash
./cook register_device --name "My iPhone 11 Pro" --udid "DEVICE_UDID"
```
- Update and export a provisioning profile for app with bundle identifier `my.fancy.app`:
```bash
./cook update_profile --bundle-id my.fancy.app --output-profile ~/desktop/profile.mobileprovision
```
- Download all existing provisioning profiles:
```bash
./cook download_profiles --output-folder ~/desktop/profiles/
```
- Resign `.ipa` file using a local p12 certificate (obtained with `create_certificate` recipe):
```bash
./cook resign --ipa ./app.ipa --p12 ./cert.p12 --p12-password "123"
```
- Resign `.ipa` file using a new certificate (`-f` revokes current one if necessary)
```bash
./cook resign --ipa ./app.ipa --output-ipa ./app_signed.ipa -f
```
## Installation
Download latest `cook.zip` release from the [releases page](https://github.com/n3d1117/cook/releases/latest) to your downloads folder and unzip it (or build manually from Xcode).
If you haven't already, you should install and enable the `Mail.app` plugin called `CookMailPlugin` (this is needed to fetch the correct headers to communicate with Apple's servers).
See steps to install CookMailPlugin (only once):
Run the following commands:
```bash
$ cd ~/downloads/cook/
$ sudo codesign -f -s - CookMailPlugin.mailbundle
$ sudo mkdir -p /Library/Mail/Bundles
$ sudo cp -R CookMailPlugin.mailbundle /Library/Mail/Bundles
$ sudo defaults write "/Library/Preferences/com.apple.mail" EnableBundles 1
```
Then enable the plugin:
* Open `Mail.app` and from the Menu bar go to `Mail` -> `Preferences`
* Click on `Manage Plug-ins...`
* Enable `CookMailPlugin.mailbundle`
* Click `Apply and Restart Mail`
* Done!
Once the plugin is installed and enabled, you can use cook from the command line:
```bash
$ cd ~/downloads/cook/
$ ./cook -h
```
## Build manually
Run the following commands:
```bash
$ cd ~/downloads
$ git clone https://github.com/n3d1117/cook.git
$ cd cook/
$ open cook.xcodeproj
```
## Credits
* Riley Testut's [AltSign](https://github.com/rileytestut/AltSign) framework (part of [AltStore](https://altstore.io/))
* Riley Testut's `AltPlugin.mailbundle` (part of [AltServer](https://github.com/rileytestut/AltStore/tree/master/AltServer))
* [Kabir Oberai](https://twitter.com/kabiroberai) for the authentication code in AltSign
* [appdb](https://appdb.to/) for the idea!
* [Zond80](https://github.com/ZonD80/) for handling 2FA code
## License
Licensed under GNU General Public License v3.0. See [LICENSE](LICENSE) file for further information.