Wire

This repository is part of the source code of Wire. You can find more information at wire.com or by contacting [email protected].

You can find the published source code at github.com/wireapp/wire.

For licensing information, see the attached LICENSE file and the list of third-party licenses at wire.com/legal/licenses/.

If you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and cause that application to connect to our servers for any purposes, we refer to that resulting application as an Open Source App. All Open Source Apps are subject to, and may only be used and/or commercialized in accordance with, the Terms of Use applicable to the Wire Application, which can be found at https://wire.com/legal/#terms. Additionally, if you choose to build an Open Source App, certain restrictions apply, as follows:

a. You agree not to change the way the Open Source App connects and interacts with our servers; b. You agree not to weaken any of the security features of the Open Source App; c. You agree not to use our servers to store data for purposes other than the intended and original functionality of the Open Source App; d. You acknowledge that you are solely responsible for any and all updates to your Open Source App.

For clarity, if you compile the open source software that we make available from time to time to develop your own mobile, desktop or web application, and do not cause that application to connect to our servers for any purposes, then that application will not be deemed an Open Source App and the foregoing will not apply to that application.

No license is granted to the Wire trademark and its associated logos, all of which will continue to be owned exclusively by Wire Swiss GmbH. Any use of the Wire trademark and/or its associated logos is expressly prohibited without the express prior written consent of Wire Swiss GmbH.

Wire iOS

The Wire mobile app has an architectural layer that we call sync engine. It is the client-side layer that processes all the data that is displayed in the mobile app. It handles network communication and authentication with the backend, push notifications, local caching of data, client-side business logic, signaling with the audio-video libraries, encryption and decryption (using encryption libraries from a lower level) and other bits and pieces.

The user interface layer of the mobile app is built on top of the sync engine, which provides the data to display to the UI. The sync engine itself is built on top of a few third-party frameworks, and uses Wire components that are shared between platforms for cryptography (Proteus/Cryptobox) and audio-video signaling (AVS).

Documentation

Additional documentation is available in the Wire iOS wiki.

How to build the open source client

What is included in the open source client

The project in this repository contains the Wire iOS client project. You can build the project yourself. However, there are some differences with the binary Wire iOS client available on the App Store. These differences are:

• the open source project does not include the API keys of Vimeo, Localytics, HockeyApp and other 3rd party services.
• the open source project links against the open source Wire audio-video-signaling (AVS) library. The binary App Store client links against an AVS version that contains proprietary improvements for the call quality.

Prerequisites

In order to build Wire for iOS locally, it is necessary to install and setup the following tools on the local machine:

• macOS 13.5 (Ventura) or newer
• Xcode 15.0.0
• Carthage 0.38 or newer (Carthage/Carthage)
• gem must be setup to use ruby without admin permissions. One way to achieve this is to use rbenv, install the latest ruby version and set it as global version.
• SSH key for git. Generate a new key, add it locally and add it to GitHub.

You can run brew bundle to install all development tools on your local machine, the list is given in Brewfile.

The setup script will automatically check for you that you satisfy these requirements.

How to build locally

1. Check out the wire-ios-mono repository.
2. From the checkout folder, run ./setup.sh. This will pull in all the necessary dependencies with Carthage and verify that you have the right version of the tools installed.
3. Open the project wire-ios-mono.xcworkspace in Xcode
4. Make sure the Wire-iOS app scheme is selected.
5. Click the "Run" button in Xcode

These steps allow you to build only the Wire umbrella project, pulling in all other Wire frameworks with Carthage. If you want to modify the source/debug other Wire frameworks, you can open the Carthage/Checkouts subfolder and open the individual projects for each dependency there.

You can then use carthage bootstrap --platform ios --use-xcframeworks to rebuild the dependency and use it in the umbrella project.

Known limitations

Notifications send through Apple Push Notification service can only be received by the App Store Wire client, which is code signed with Wire's own certificate. This is a security feature enforced by Apple, as documented in Apple's Local and Remote Notification Programming Guide. Any client build from source will not be able to receive notifications.

Translations

All Wire translations are crowdsourced via CrowdIn: https://crowdin.com/projects/wire

Running security tests

To run all the security tests, you will first need to be able to build the app locally. To do this, see the "How to build locally" section above. Then, from the command line, you can run the security tests with the following commands:

xcodebuild test \
  -workspace wire-ios-mono.xcworkspace \
  -scheme Wire-iOS \
  -testPlan SecurityTests \
  -destination 'platform=iOS Simulator,name=iPhone 14,OS=17.0.1'

  xcodebuild test \
  -workspace wire-ios-mono.xcworkspace \
  -scheme WireSyncEngine \
  -testPlan SecurityTests \
  -destination 'platform=iOS Simulator,name=iPhone 14,OS=17.0.1'

  xcodebuild test \
  -workspace wire-ios-mono.xcworkspace \
  -scheme WireDataModel \
  -testPlan SecurityTests \
  -destination 'platform=iOS Simulator,name=iPhone 14,OS=17.0.1'

xcodebuild will print the test results to the console. It will also log the location of the test result (in .xcresult format), which you can open with Xcode to see the test results in a more friendly format.