Aftended / threema-ios

Threema App for iOS.

Threema for iOS

This repository contains the complete source code of Threema for iOS.

Table of Contents

• Bug Reports / Feature Requests / Security Issues
• Source Code Release Policy
• License Checks
• Schemes
• Building
• Testing
• Reproducible Builds
• Code Organization / Architecture
• Contributions
• License

Bug Reports / Feature Requests / Security Issues

To report bugs and request new features, please contact the Threema support team.

If you discover a security issue in Threema, please adhere to the coordinated vulnerability disclosure model. To be eligible for a bug bounty, please file a report on GObugfree (where all the details, including the bounty levels, are listed). If you're not interested in the bug bounty program, you can contact us via Threema or by email; for contact details, see threema.ch/contact (section "Security").

Source Code Release Policy

This source code repository will be updated for every public non-beta release. There will be one commit per released version.

Commits are signed using PGP. See SECURITY.md for more information.

License Checks

While the source code for Threema for iOS is published under an open source license, Threema is still a paid app. To run the app in combination with our official server infrastructure, you must have bought a license on the App Store.

The app uses two different license check types, depending on the target app:

App Store Licensing

When creating a new Threema ID using the Threema app bought on the App Store, the app sends the digitally signed App Store receipt to the directory server. This allows the server to verify that you have indeed bought the app, without being able to identify you.

This means that a self-compiled app using the Threema scheme cannot be used to create a new Threema ID. You can, however, use an app that was purchased in the App Store to create an ID and then export a backup. This backup can then be imported into the self-compiled app.

Note that the ID creation endpoint is monitored for abuse.

Threema Work

If you build the Threema Work target, credentials from the Threema Work subscription must be provided in order to use the app.

Threema OnPrem

If you build the Threema OnPrem target, credentials from the Threema OnPrem subscription must be provided in order to use the app.

Schemes

• Threema builds and tests the consumer app. (recommended for local testing)
• ThreemaWork builds and tests the enterprise version of our app.
• ThreemaOnPrem builds and tests the OnPrem version of our app.
• ThreemaRed only used for development and testing within Threema.
• ThreemaRedWork only used for development and testing within Threema.

Building

To get started you need a Mac, Xcode (14.2) and a (free) Apple Developer Account.

1. Install Dependencies

1. Install Carthage

   brew install carthage

   (If you don't have homebrew see their official install instructions.)

2. If your Xcode installation is fresh make sure that command line tools are selected

   sudo xcode-select --switch /Applications/Xcode.app

3. Install and build the dependencies

   ./scripts/build.sh --dependencies

   This checks out and builds Carthage dependencies, and downloads the WebRTC.xcframework if it is missing. (If you want to build WebRTC yourself see BUILD_WEBRTC.md.)

4. Install & intialize Rustup for building SaltyRTC. The build happens during the first compilation of the project which also installs the specific toolchain and targets needed.

   brew install rustup
   rustup-init

   (You might want to add $HOME/.cargo/bin to your PATH.)
   (If you don't have homebrew see their official install instructions.)

5. Ensure that submodules are checked out

   git submodule update --init

2. Setup Project

You can either build the Threema app (recommended) or Threema Work app.

Note: These setups are for running in the simulator.

Threema (recommended)

1. Open Threema.xcproject in Xcode
2. Repeat these steps for the Threema and ThreemaShareExtension target
   1. Check "Automatically manage signing" and confirm it ("Enable Automatic")
   2. Set "Team" to the team of your developer account
3. Choose Threema as scheme and a simulator

Threema Work

1. Open Threema.xcproject in Xcode
2. Repeat these steps for the Threema Work and ThreemaForWorkShareExtension target
   1. Check "Automatically manage signing" and confirm it ("Enable Automatic")
   2. Set "Team" to the team of your developer account
3. Choose Threema Work as scheme and a simulator

3. Build and Run

1. Build and Run
2. To create a Threema ID see "App Store Licensing" above. (You can cancel the "Sign in with Apple ID" dialogue and import a Threema ID backup.)

Testing

See "Building" for setting up a running environment. Before running the tests check if you can sucessfully build and run the app.

• Choose Threema as scheme to run the app tests.
• Choose ThreemaFramework as scheme to run the framework tests.
• Choose ThreemaWork as scheme to run Threema Work specific tests.

Reproducible Builds

Due to restrictions by Apple, it’s no easy task to offer reproducible builds for iOS, but we are currently evaluating possible ways to also support reproducible builds for this platform.

Code Organization / Architecture

Before digging into the codebase, you should read the Cryptography Whitepaper to understand the design concepts.

These are the most important groups of the Xcode project:

• ThreemaFramework: Shared code between the main app and extensions
• Threema: Code of both apps (Threema and Threema Work)
• ThreemaShareExtension: Code of share extension
• Threema{Framework}Tests: Test files

Our dependencies are manged with Carthage. Additionally we use WebRTC based on binaries hosted on our servers. If you want to build WebRTC yourself see BUILD_WEBRTC.md.

Contributions

We accept GitHub pull requests. Please refer to https://threema.ch/open-source/contributions for more information on how to contribute.

License

Threema for iOS is licensed under the GNU Affero General Public License v3.

Copyright (c) 2012-2023 Threema GmbH

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License, version 3,
as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

The full license text can be found in LICENSE.txt.

If you have questions about the use of self-compiled apps or the license in general, feel free to contact us. We are publishing the source code in good faith, with transparency being the main goal. By having users pay for the development of the app, we can ensure that our goals sustainably align with the goals of our users: Great privacy and security, no ads, no collection of user data!