go-ios

The restapi package is organized as follows:

• api/routes.go: Defines all available API routes.
• api/middleware.go: Contains all middleware implementations.
• api/*_endpoints.go: Contains the endpoint logic, which largely mirrors the go-ios docopt commands.
• api/server.go: Handles the server configuration.

After extracting the runner, use ./config.sh to register the runner with your repository. You must provide the --url of the repository and a registration --token. Once configured, start the runner using ./run.sh.

# Create the runner and start the configuration experience
$ ./config.sh --url https://github.com/danielpaulus/go-ios --token ABBBQZJD7WV2MU6VWFLDE6DJ56XUQ

# Last step, run it!
$ ./run.sh

To develop or run the Go-iOS REST API, follow these steps:

1. Open the restapi directory in your editor (e.g., VS Code).
2. Install the swag CLI tool to generate Swagger documentation: go install github.com/swaggo/swag/cmd/swag@latest.
3. Initialize Swagger documentation with dependency parsing: swag init --parseDependency.
4. Start the server: go run main.go.
5. Connect an iOS device to your machine.
6. Access the API at localhost:8080.

To install the go-ios CLI globally on your system, use the following command:

npm install -g go-ios

After installation, you can verify it by running ios --help.

To set up a GitHub Actions runner on macOS (x64), create a dedicated directory, download the runner package using curl, and extract the contents using tar. You can optionally validate the integrity of the downloaded archive using shasum.

# Create a folder
$ mkdir actions-runner && cd actions-runner

# Download the latest runner package
$ curl -o actions-runner-osx-x64-2.334.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.334.0/actions-runner-osx-x64-2.334.0.tar.gz

# Optional: Validate the hash
$ echo "73a979ff7e9ce8a70244f3a959d896870be486fac92bb08ed90684f961474e0d  actions-runner-osx-x64-2.334.0.tar.gz" | shasum -a 256 -c

# Extract the installer
$ tar xzf ./actions-runner-osx-x64-2.334.0.tar.gz

For devices running iOS 17 or newer, you must start a tunnel daemon to enable communication. Run the following command with administrative privileges:

sudo ios tunnel start

Windows Users: You must download the latest wintun.dll from https://git.zx2c4.com/wintun and copy it to C:/Windows/system32 for the tunnel to function correctly.

When running WebDriverAgent (WDA) via testmanagerd.RunTestWithConfig, you must provide specific bundle identifiers. If they are not provided, the system attempts to fall back to these defaults:

• Bundle ID: com.facebook.WebDriverAgentRunner.xctrunner
• Test Runner Bundle ID: com.facebook.WebDriverAgentRunner.xctrunner
• XCTest Config: WebDriverAgentRunner.xctest

Requirement: You must specify either none of the following or all of them. If you provide one but not the others, the command will fail:

• --bundleid
• --testrunnerbundleid
• --xctestconfig

NCM (Network Control Model) allows a device and host to transfer multiple Ethernet frames within a single USB transfer using a structured format called an NCM Transfer Block (NTB).

An NTB consists of several layers:

1. ntbHeader: Contains the Signature (must be 0x484D434E), HeaderLen, SequenceNum, BlockLen, and NdpIndex.
2. datagramPointerHeader: Located at the NdpIndex offset. It contains a Signature (0x304D434E), the total Length of the pointer section, and the NextNpdIndex.
3. Datagram Pointers: A list of (Index, Length) pairs that point to the actual locations of the Ethernet frames within the block.
4. Payload: The actual Ethernet frames located at the offsets specified by the pointers.

The ListIcons method returns Icon interfaces. Depending on the underlying type, you can access different metadata:

To access the iOS file system, you must create a new Client. You can initialize it using a ios.DeviceEntry which handles the service connection automatically, or by providing an existing ios.DeviceConnectionInterface using NewFromConn.

Always remember to call Close() on the client when finished to release the connection.