mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-10-31 16:24:11 +00:00
Stefan Ceriu
df3bdb992a
The legacy restoration token formats store the passphrase as a base64 string whereas the current one exposes Data, so keep both representations of the same value in one place instead of repeating the conversions in every test.
204 lines
11 KiB
Swift
204 lines
11 KiB
Swift
//
|
|
// Copyright 2025 Element Creations Ltd.
|
|
// Copyright 2024-2025 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
|
|
// Please see LICENSE files in the repository root for full details.
|
|
//
|
|
|
|
@testable import ElementX
|
|
import Foundation
|
|
import MatrixRustSDK
|
|
import Testing
|
|
|
|
struct RestorationTokenTests {
|
|
@Test
|
|
func decodeTokenWithSlidingSyncProxy() throws {
|
|
// Given an encoded restoration token that contains a session with a sliding sync proxy.
|
|
let originalToken = RestorationTokenV4(session: SessionV1(accessToken: "1234",
|
|
refreshToken: "5678",
|
|
userId: "@user:example.com",
|
|
deviceId: "D3V1C3",
|
|
homeserverUrl: "https://matrix.example.com",
|
|
oidcData: "data-from-mas",
|
|
slidingSyncVersion: .proxy(url: "https://sync.example.com")),
|
|
sessionDirectory: .sessionsBaseDirectory.appending(component: UUID().uuidString),
|
|
passphrase: RestorationTokenFixtures.base64Passphrase,
|
|
pusherNotificationClientIdentifier: "pusher-identifier")
|
|
let data = try JSONEncoder().encode(originalToken)
|
|
|
|
// When decoding the data to the current restoration token format.
|
|
// Then an error should be thrown as it is no longer supported.
|
|
#expect(throws: RestorationTokenError.slidingSyncProxyNotSupported) {
|
|
try JSONDecoder().decode(RestorationToken.self, from: data)
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func decodeFromTokenV4() throws {
|
|
// Given an encoded restoration token in the 4th format that contains a stored session directory.
|
|
let sessionDirectoryName = UUID().uuidString
|
|
let originalToken = RestorationTokenV4(session: SessionV1(accessToken: "1234",
|
|
refreshToken: "5678",
|
|
userId: "@user:example.com",
|
|
deviceId: "D3V1C3",
|
|
homeserverUrl: "https://matrix.example.com",
|
|
oidcData: "data-from-mas",
|
|
slidingSyncVersion: .native),
|
|
sessionDirectory: .sessionsBaseDirectory.appending(component: sessionDirectoryName),
|
|
passphrase: RestorationTokenFixtures.base64Passphrase,
|
|
pusherNotificationClientIdentifier: "pusher-identifier")
|
|
let data = try JSONEncoder().encode(originalToken)
|
|
|
|
// When decoding the data to the current restoration token format.
|
|
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
|
|
|
// Then the output should be a valid token with the expected store directories.
|
|
assertEqual(session: decodedToken.session, originalSession: originalToken.session)
|
|
#expect(decodedToken.passphrase.base64EncodedString() == originalToken.passphrase, "The passphrase should not be changed.")
|
|
#expect(decodedToken.pusherNotificationClientIdentifier == originalToken.pusherNotificationClientIdentifier,
|
|
"The push notification client identifier should not be changed.")
|
|
#expect(decodedToken.sessionDirectories.dataDirectory == originalToken.sessionDirectory,
|
|
"The session directory should not be changed.")
|
|
#expect(decodedToken.sessionDirectories.cacheDirectory == .sessionCachesBaseDirectory.appending(component: sessionDirectoryName),
|
|
"The cache directory should be derived from the session directory but in the caches directory.")
|
|
}
|
|
|
|
@Test
|
|
func decodeFromTokenV5() throws {
|
|
// Given an encoded restoration token in the 5th format that contains separate directories for session data and caches.
|
|
let sessionDirectoryName = UUID().uuidString
|
|
let originalToken = RestorationTokenV5(session: SessionV1(accessToken: "1234",
|
|
refreshToken: "5678",
|
|
userId: "@user:example.com",
|
|
deviceId: "D3V1C3",
|
|
homeserverUrl: "https://matrix.example.com",
|
|
oidcData: "data-from-mas",
|
|
slidingSyncVersion: .native),
|
|
sessionDirectory: .sessionsBaseDirectory.appending(component: sessionDirectoryName),
|
|
cacheDirectory: .sessionCachesBaseDirectory.appending(component: sessionDirectoryName),
|
|
passphrase: RestorationTokenFixtures.base64Passphrase,
|
|
pusherNotificationClientIdentifier: "pusher-identifier")
|
|
let data = try JSONEncoder().encode(originalToken)
|
|
|
|
// When decoding the data.
|
|
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
|
|
|
// Then the output should be a valid token.
|
|
assertEqual(session: decodedToken.session, originalSession: originalToken.session)
|
|
#expect(decodedToken.passphrase.base64EncodedString() == originalToken.passphrase, "The passphrase should not be changed.")
|
|
#expect(decodedToken.pusherNotificationClientIdentifier == originalToken.pusherNotificationClientIdentifier,
|
|
"The push notification client identifier should not be changed.")
|
|
#expect(decodedToken.sessionDirectories.dataDirectory == originalToken.sessionDirectory,
|
|
"The session directory should not be changed.")
|
|
#expect(decodedToken.sessionDirectories.cacheDirectory == originalToken.cacheDirectory,
|
|
"The cache directory should not be changed.")
|
|
}
|
|
|
|
@Test
|
|
func decodeFromCurrentToken() throws {
|
|
// Given an encoded restoration token in the current format.
|
|
let originalToken = RestorationToken(session: Session(accessToken: "1234",
|
|
refreshToken: "5678",
|
|
userId: "@user:example.com",
|
|
deviceId: "D3V1C3",
|
|
homeserverUrl: "https://matrix.example.com",
|
|
oauthData: "data-from-mas",
|
|
slidingSyncVersion: .native),
|
|
sessionDirectories: .init(),
|
|
passphrase: RestorationTokenFixtures.passphrase,
|
|
pusherNotificationClientIdentifier: "pusher-identifier")
|
|
let data = try JSONEncoder().encode(originalToken)
|
|
|
|
// When decoding the data.
|
|
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
|
|
|
// Then the output should be a valid token.
|
|
#expect(decodedToken == originalToken, "The token should remain identical.")
|
|
}
|
|
|
|
func assertEqual(session: Session, originalSession: SessionV1) {
|
|
#expect(session.accessToken == originalSession.accessToken, "The access token should not be changed.")
|
|
#expect(session.refreshToken == originalSession.refreshToken, "The refresh token should not be changed.")
|
|
#expect(session.userId == originalSession.userId, "The user ID should not be changed.")
|
|
#expect(session.deviceId == originalSession.deviceId, "The device ID should not be changed.")
|
|
#expect(session.homeserverUrl == originalSession.homeserverUrl, "The homeserver URL should not be changed.")
|
|
#expect(session.oauthData == originalSession.oidcData, "The OAuth data should not be changed.")
|
|
}
|
|
}
|
|
|
|
// MARK: - Token formats
|
|
|
|
enum RestorationTokenFixtures {
|
|
static let passphrase = Data("passphrase".utf8)
|
|
static let base64Passphrase = passphrase.base64EncodedString()
|
|
}
|
|
|
|
struct RestorationTokenV4: Equatable, Codable {
|
|
let session: SessionV1
|
|
let sessionDirectory: URL
|
|
let passphrase: String? // Optional but has always been encoded for sessions that use native sliding sync.
|
|
let pusherNotificationClientIdentifier: String?
|
|
}
|
|
|
|
struct RestorationTokenV5: Equatable, Codable {
|
|
let session: SessionV1
|
|
let sessionDirectory: URL
|
|
let cacheDirectory: URL
|
|
let passphrase: String? // Optional but has always been encoded for sessions that use native sliding sync.
|
|
let pusherNotificationClientIdentifier: String?
|
|
}
|
|
|
|
// MARK: - Session formats
|
|
|
|
struct SessionV1: Equatable {
|
|
var accessToken: String
|
|
var refreshToken: String?
|
|
var userId: String
|
|
var deviceId: String
|
|
var homeserverUrl: String
|
|
var oidcData: String?
|
|
var slidingSyncVersion: SlidingSyncVersionV1
|
|
}
|
|
|
|
enum SlidingSyncVersionV1: Equatable {
|
|
// periphery:ignore - documents a structure the app used to write
|
|
case none
|
|
case proxy(url: String)
|
|
case native
|
|
|
|
var proxyURL: String? {
|
|
guard case let .proxy(url) = self else { return nil }
|
|
return url
|
|
}
|
|
}
|
|
|
|
extension SessionV1: Codable {
|
|
init(from decoder: Decoder) throws {
|
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
|
let slidingSyncProxy = try container.decodeIfPresent(String.self, forKey: .slidingSyncProxy)
|
|
self = try .init(accessToken: container.decode(String.self, forKey: .accessToken),
|
|
refreshToken: container.decodeIfPresent(String.self, forKey: .refreshToken),
|
|
userId: container.decode(String.self, forKey: .userId),
|
|
deviceId: container.decode(String.self, forKey: .deviceId),
|
|
homeserverUrl: container.decode(String.self, forKey: .homeserverUrl),
|
|
oidcData: container.decodeIfPresent(String.self, forKey: .oidcData),
|
|
slidingSyncVersion: slidingSyncProxy.map { .proxy(url: $0) } ?? .native)
|
|
}
|
|
|
|
func encode(to encoder: Encoder) throws {
|
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
|
try container.encode(accessToken, forKey: .accessToken)
|
|
try container.encode(refreshToken, forKey: .refreshToken)
|
|
try container.encode(userId, forKey: .userId)
|
|
try container.encode(deviceId, forKey: .deviceId)
|
|
try container.encode(homeserverUrl, forKey: .homeserverUrl)
|
|
try container.encode(oidcData, forKey: .oidcData)
|
|
try container.encode(slidingSyncVersion.proxyURL, forKey: .slidingSyncProxy)
|
|
}
|
|
|
|
enum CodingKeys: String, CodingKey {
|
|
case accessToken, refreshToken, userId, deviceId, homeserverUrl, oidcData, slidingSyncProxy
|
|
}
|
|
}
|