mk6i-open-oscar-server/docs/CLIENT_IOS.md

AIM for iOS Client Setup

This guide explains how to connect AIM for iOS 5.1.3 to Open OSCAR Server. The client talks to the server's Web API, so setup consists of pointing the app's server URLs at your Open OSCAR Server instance and installing the modified app on your device.

The SSL-enabled examples in this guide assume your server's hostname is ras.dev, the hostname passed to make docker-run. If you use a different hostname, substitute it wherever ras.dev appears.

[!NOTE] Open OSCAR Server is not affiliated with or endorsed by AOL or Yahoo. AIM and AIM for iOS are trademarks of their respective owners. This project does not distribute the AIM for iOS app; you are responsible for ensuring that obtaining and using it complies with the laws that apply to you.

Prerequisites

1. Compatible iOS Device

AIM 5.1.3 is a 32-bit app, so it requires a device running iOS 5 through 10. iOS 11 and later do not run 32-bit apps.

1. Ability to Sideload Apps

Your device must be jailbroken, with a package such as AppSync Unified installed so that it can run a modified, unsigned app. You also need to know how to modify an IPA file and install it onto your device.

1. Open OSCAR Server Instance

Configure and run an Open OSCAR Server instance using one of the available guides.

- For a simple **unencrypted** installation, follow the release setup guide for your operating system.
    - [Windows](./WINDOWS.md)
    - [Linux](./LINUX.md)
    - [macOS (Intel & Apple Silicon)](./MACOS.md)
- For an advanced **SSL-enabled** installation, follow the [Docker Setup Guide](./DOCKER.md).

The Web API must be enabled (WEBAPI_ENABLED=true, the default), and your device must be able to reach the server over the network.

Setup Procedure

1. Acquire the AIM IPA

Download AIM 5.1.3 from archive.org by searching for AOL Instant Messenger iOS.

1. Configure Server URLs

Modify the following production parameters in the IPA's aim_servers.plist file, replacing {BASE} with your server's base URL:

- **Unencrypted:** `http://<server-ip>:8081/`, where `<server-ip>` is the LAN IP address or hostname of the
  machine running Open OSCAR Server, and `8081` is the default Web API port (`WEBAPI_LISTENERS`). Do not use
  `127.0.0.1`, which refers to the device itself.
- **SSL-enabled:** `https://ras.dev/`, where `ras.dev` is the hostname you passed to `make docker-run`. The
  device must be able to resolve this hostname, either through DNS or its hosts file.

| Param | Value | |----------------------------|-------------------------------------------| | api_base_url | {BASE} | | api_secure_base_url | {BASE} | | auth_base_url | {BASE} | | sns_auth_url | {BASE}_cqr/login/login.psp | | lifestream_settings_url | {BASE}lifestream/settings | | lifestream_photo_api_url | {BASE}lifestream/ | | registration_api_url | {BASE}rsp-websvc-3.0/reg/ | | services_settings_url | {BASE}.settings/mobile/accounts | | social_notification_url | {BASE}.settings/mobile/notifications |

For example, an unencrypted server at 192.168.1.10:8081 gives sns_auth_url the value http://192.168.1.10:8081/_cqr/login/login.psp.

1. Install the IPA

Install the modified IPA onto your device.

1. Install the Root CA Certificate (SSL only)

The device must trust your server's root CA certificate. In Safari on the device, open http://ras.dev/certs/ca.crt and install the profile when prompted.

  <img width="320" alt="iOS Certificate Installation Screenshot" src="https://github.com/user-attachments/assets/b62aeb01-4d2a-4262-a602-d772f26b94b5" />

On iOS 10.3 and later, you must also enable full trust for the certificate under Settings → General → About → Certificate Trust Settings.

1. Sign In

Open the AIM app and sign in with your Open OSCAR Server screen name and password.

Troubleshooting

The client can't connect

Open https://ras.dev/ in Safari on the device. If you're running an unencrypted setup or a different hostname, adjust the URL to match the base URL you configured in step 2 (for example, http://192.168.1.10:8081/). If successful, you should see the following payload:

{"response":{"statusCode":200,"statusText":"Ok","data":{}}}

If the page fails to load, the device can't reach the server: check the URL, confirm the server is running, and make sure the device and server are on the same network (guest Wi-Fi networks often block traffic between devices).