Use a Client in AuthenticationService now that the Rust one has been removed. (#2954)

* Replace Rust's Authentication service by building a Client. * Drop the Proxy from AuthenticationServiceProxy[Protocol]. * Make sure to call abortOIDCLogin. * Centralise common ClientBuilder code. * Update the SDK.
2026-11-04 01:20:12 +00:00 · 2024-06-24 15:05:00 +01:00
parent fc0573a41d
commit 3465ea4cc1
23 changed files with 489 additions and 564 deletions
@@ -0,0 +1,86 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import MatrixRustSDK
+
+/// Represents a particular authentication flow.
+enum AuthenticationFlow {
+    /// The flow for signing in to an existing account.
+    case login
+    /// The flow for creating a new account.
+    case register
+}
+
+enum AuthenticationServiceError: Error {
+    /// An error occurred during OIDC authentication.
+    case oidcError(OIDCError)
+    case invalidServer
+    case invalidCredentials
+    case invalidHomeserverAddress
+    case invalidWellKnown(String)
+    case slidingSyncNotAvailable
+    case accountDeactivated
+    case failedLoggingIn
+    case isOnWaitlist
+    case sessionTokenRefreshNotSupported
+}
+
+protocol AuthenticationServiceProtocol {
+    /// The currently configured homeserver.
+    var homeserver: CurrentValuePublisher<LoginHomeserver, Never> { get }
+        
+    /// Sets up the service for login on the specified homeserver address.
+    func configure(for homeserverAddress: String) async -> Result<Void, AuthenticationServiceError>
+    /// Performs login using OIDC for the current homeserver.
+    func urlForOIDCLogin() async -> Result<OIDCAuthorizationDataProxy, AuthenticationServiceError>
+    /// Asks the SDK to abort an ongoing OIDC login if we didn't get a callback to complete the request with.
+    func abortOIDCLogin(data: OIDCAuthorizationDataProxy) async
+    /// Completes an OIDC login that was started using ``urlForOIDCLogin``.
+    func loginWithOIDCCallback(_ callbackURL: URL, data: OIDCAuthorizationDataProxy) async -> Result<UserSessionProtocol, AuthenticationServiceError>
+    /// Performs a password login using the current homeserver.
+    func login(username: String, password: String, initialDeviceName: String?, deviceID: String?) async -> Result<UserSessionProtocol, AuthenticationServiceError>
+}
+
+// MARK: - OIDC
+
+enum OIDCError: Error {
+    /// Failed to get the URL that should be presented for login.
+    case urlFailure
+    /// The user cancelled the login.
+    case userCancellation
+    /// OIDC isn't supported on the currently configured server.
+    case notSupported
+    /// An unknown error occurred.
+    case unknown
+}
+
+struct OIDCAuthorizationDataProxy: Equatable {
+    let underlyingData: OidcAuthorizationData
+    
+    var url: URL {
+        guard let url = URL(string: underlyingData.loginUrl()) else {
+            fatalError("OIDC login URL hasn't been validated.")
+        }
+        return url
+    }
+}
+
+extension OidcAuthorizationData: Equatable {
+    public static func == (lhs: MatrixRustSDK.OidcAuthorizationData, rhs: MatrixRustSDK.OidcAuthorizationData) -> Bool {
+        lhs.loginUrl() == rhs.loginUrl()
+    }
+}