Element-R iOS

[Anderas]

An epic with all the task required to build and release Element-R iOS, an element client using Rust crypto crate. The epic serves as an overview and should be updated regularly with missing tasks and concrete implementation tickets.

Phases

The phases are chosen to align with pre-existing breakdowns for Element-R on other platforms

Phase 0 - Setup / Bingings (Done)

• Compile Rust Crypto SDK as Apple framework
• Publish MatrixSDKCrypto in CocoaPods
• Integrate MatrixSDKCrypto under build flag
• Compile MatrixSDKCrypto for macOS

Phrase 1 - Integration (Done)

• 1.1 Process Sync
  • Integrate olm machine class
  • Expose Rust Logs
  • Process Sync loop
  • Request Sender
  • Process output of receiveSyncChanges
• 1.2 Decrypt Events
  • Decrypt messages
  • Decrypt media and attachment
• 1.3 Encrypt Events And Share keys
  • Establish olm sessions
  • Encrypt messages
  • Discard room key
  • Room encryption state
• 1.4 Key Backup
  • Enable / Disable backup #6768
  • Backup / Restore room keys #6769
  • Backup / Restore cross-signing keys
  • Manual keys export / import
  • Display correctly whether secrets stored locally
  • Share backup key as secret
• 1.5 Cross Signing
  • User identity
  • Bootstrap cross-signing
  • General verification flow
  • SAS verification
  • SAS decimals
  • QR verification #6859
  • Self-verification #6589
  • Manual / local verification
  • Incoming verification requests #6809
  • In-room verification #6810
  • To-device verification
  • Cancel and timeout verification
  • Verification in unencrypted rooms
  • Pending requests after restart
  • Device-to-device verification
• 1.6 Gossiping
  • Request room keys #6773
  • Forward room keys #6774
• 1.7 Shields / Device Manager
  • Trust shields
  • Device management
  • Blocked user / device
  • Untrusted vs unverified user / device
  • Refresh verification status immediately on any update
  • Trust own device after restoring cross-signing keys
  • Update tracked users / device keys

Phase 2 - Alpha version

• 2.1 Alpha TF build without migration by 1/Nov
• 2.2 Migration from libolm to rust
  • Migrate from libolm to Rust
  • Migrate encryption settings
  • Migrate remaining data from group container
  • Migration UX
• 2.3 Notifications
• 2.4 Backup import progress
• 2.5 Stable verifications
• 2.6 Analytics
  • Sentry performance measuring
  • Setry error logging
  • Posthog error logging
  • Rageshakes debug info (sync response, encryption/decryption content etc)
  • Sentry dashboards
• 2.7 Tech debt / Refactors
  • Remaining "not yet implemented" (especially MXCrypto vs MXCryptoV2)
  • Top level / non-silent error handling
  • iOS - Android implementation parity
  • Protocols instead of subclasses (MXCrypto, MXCrossSigning)
  • Strong type checking (log / throw if data is missing)
  • Remove all references to concrete implementations of requests / transactions

Phase 3 - Unit / Integration tests

• MXAes256KeyBackupTests
• MXCrossSigningTests
• MXCrossSigningVerificationTests
• MXCryptoKeyVerificationTests
• MXCryptoMigrationTests
• MXCryptoRecoveryServiceTests
• MXCryptoSecretShareTests
• MXCryptoSecretStorageTests
• MXCryptoShareTests
• MXCryptoTests
• MXCurve25519KeyBackupTests
• MXMegolmEncryptionTests
• All non-crypto integration tests
• All polyjuice tests pass
• New tests for MXKeyVerificationManagerV2 and MXCryptoV2

Phase 4 - Rust crypto crate updates

• 4.1 https://github.com/matrix-org/matrix-rust-sdk/milestone/1
• 4.2 New proposals (TBC)
• 4.3 Historical key sharing
• 4.4 Strong types for event formats in Request (eg needing to manually construct event json)

Phase 5 - Publlic TestFlight

• 5.1 Release as public TestFlight build
• 5.2 Target xxx Users, xxx Weeks => Check posthog UTDs
• 5.3 Benchmark legacy vs rust crypto performance

Phase 6 - Release

• 6.1 Ensure production stability
• 6.2 Remove build flag
• 6.3 Remove legacy crypto code

[Anderas]

This epic is no longer suitable to track further progress: Element-R is currently available to all users as an Opt-in labs option, and users will be automatically migrated using a phased release. All remaning work will be tracked individually on the crypto sprint board