mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-30 00:02:47 +00:00
f4d223816f
Update after PR Feedback
274 lines
12 KiB
Swift
274 lines
12 KiB
Swift
// File created from ScreenTemplate
|
|
// $ createScreen.sh Onboarding Authentication
|
|
/*
|
|
Copyright 2021 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 UIKit
|
|
|
|
/// A coordinator that handles authentication, verification and setting a PIN.
|
|
final class AuthenticationCoordinator: NSObject, AuthenticationCoordinatorProtocol {
|
|
|
|
// MARK: - Properties
|
|
|
|
// MARK: Private
|
|
|
|
private let navigationRouter: NavigationRouterType
|
|
|
|
private let authenticationViewController: AuthenticationViewController
|
|
private var canPresentAdditionalScreens: Bool
|
|
private var isWaitingToPresentCompleteSecurity = false
|
|
private let crossSigningService = CrossSigningService()
|
|
|
|
/// The password entered, for use when setting up cross-signing.
|
|
private var password: String?
|
|
/// The session created when successfully authenticated.
|
|
private var session: MXSession?
|
|
|
|
// MARK: Public
|
|
|
|
// Must be used only internally
|
|
var childCoordinators: [Coordinator] = []
|
|
var completion: ((AuthenticationCoordinatorResult) -> Void)?
|
|
|
|
// MARK: - Setup
|
|
|
|
init(parameters: AuthenticationCoordinatorParameters) {
|
|
self.navigationRouter = parameters.navigationRouter
|
|
self.canPresentAdditionalScreens = parameters.canPresentAdditionalScreens
|
|
|
|
let authenticationViewController = AuthenticationViewController()
|
|
self.authenticationViewController = authenticationViewController
|
|
|
|
// Preload the view as this can a second and lock up the UI at presentation.
|
|
// The coordinator is initialised early in the onboarding flow to take advantage of this.
|
|
authenticationViewController.loadViewIfNeeded()
|
|
|
|
super.init()
|
|
}
|
|
|
|
// MARK: - Public
|
|
|
|
func start() {
|
|
// Listen to the end of the authentication flow
|
|
authenticationViewController.authVCDelegate = self
|
|
}
|
|
|
|
func toPresentable() -> UIViewController {
|
|
return self.authenticationViewController
|
|
}
|
|
|
|
func update(authenticationType: MXKAuthenticationType) {
|
|
authenticationViewController.authType = authenticationType
|
|
}
|
|
|
|
func showCustomServer() {
|
|
authenticationViewController.setCustomServerFieldsVisible(true)
|
|
}
|
|
|
|
func update(externalRegistrationParameters: [AnyHashable: Any]) {
|
|
authenticationViewController.externalRegistrationParameters = externalRegistrationParameters
|
|
}
|
|
|
|
func update(softLogoutCredentials: MXCredentials) {
|
|
authenticationViewController.softLogoutCredentials = softLogoutCredentials
|
|
}
|
|
|
|
func updateHomeserver(_ homeserver: String?, andIdentityServer identityServer: String?) {
|
|
authenticationViewController.showCustomHomeserver(homeserver, andIdentityServer: identityServer)
|
|
}
|
|
|
|
func continueSSOLogin(withToken loginToken: String, transactionID: String) -> Bool {
|
|
authenticationViewController.continueSSOLogin(withToken: loginToken, txnId: transactionID)
|
|
}
|
|
|
|
func presentPendingScreensIfNecessary() {
|
|
canPresentAdditionalScreens = true
|
|
|
|
showLoadingAnimation()
|
|
|
|
if isWaitingToPresentCompleteSecurity {
|
|
isWaitingToPresentCompleteSecurity = false
|
|
presentCompleteSecurity()
|
|
}
|
|
}
|
|
|
|
// MARK: - Private
|
|
|
|
private func showLoadingAnimation() {
|
|
let loadingViewController = LaunchLoadingViewController()
|
|
loadingViewController.modalPresentationStyle = .fullScreen
|
|
|
|
// Replace the navigation stack with the loading animation
|
|
// as there is nothing to navigate back to.
|
|
navigationRouter.setRootModule(loadingViewController)
|
|
}
|
|
|
|
private func presentCompleteSecurity() {
|
|
guard let session = session else {
|
|
MXLog.error("[AuthenticationCoordinator] presentCompleteSecurity: Unable to present security due to missing session.")
|
|
authenticationDidComplete()
|
|
return
|
|
}
|
|
|
|
let isNewSignIn = true
|
|
let keyVerificationCoordinator = KeyVerificationCoordinator(session: session, flow: .completeSecurity(isNewSignIn))
|
|
|
|
keyVerificationCoordinator.delegate = self
|
|
let presentable = keyVerificationCoordinator.toPresentable()
|
|
presentable.presentationController?.delegate = self
|
|
navigationRouter.present(presentable, animated: true)
|
|
keyVerificationCoordinator.start()
|
|
add(childCoordinator: keyVerificationCoordinator)
|
|
}
|
|
|
|
private func authenticationDidComplete() {
|
|
completion?(.didComplete)
|
|
}
|
|
|
|
private func registerSessionStateChangeNotification(for session: MXSession) {
|
|
NotificationCenter.default.addObserver(self, selector: #selector(sessionStateDidChange), name: .mxSessionStateDidChange, object: session)
|
|
}
|
|
|
|
private func unregisterSessionStateChangeNotification() {
|
|
NotificationCenter.default.removeObserver(self, name: .mxSessionStateDidChange, object: nil)
|
|
}
|
|
|
|
@objc private func sessionStateDidChange(_ notification: Notification) {
|
|
guard let session = notification.object as? MXSession else {
|
|
MXLog.error("[AuthenticationCoordinator] sessionStateDidChange: Missing session in the notification")
|
|
return
|
|
}
|
|
|
|
if session.state == .storeDataReady {
|
|
if let crypto = session.crypto, crypto.crossSigning != nil {
|
|
// Do not make key share requests while the "Complete security" is not complete.
|
|
// If the device is self-verified, the SDK will restore the existing key backup.
|
|
// Then, it will re-enable outgoing key share requests
|
|
crypto.setOutgoingKeyRequestsEnabled(false, onComplete: nil)
|
|
}
|
|
} else if session.state == .running {
|
|
unregisterSessionStateChangeNotification()
|
|
|
|
if let crypto = session.crypto, let crossSigning = crypto.crossSigning {
|
|
crossSigning.refreshState { [weak self] stateUpdated in
|
|
guard let self = self else { return }
|
|
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: crossSigning.state: \(crossSigning.state)")
|
|
|
|
switch crossSigning.state {
|
|
case .notBootstrapped:
|
|
// TODO: This is still not sure we want to disable the automatic cross-signing bootstrap
|
|
// if the admin disabled e2e by default.
|
|
// Do like riot-web for the moment
|
|
if session.vc_homeserverConfiguration().isE2EEByDefaultEnabled {
|
|
// Bootstrap cross-signing on user's account
|
|
// We do it for both registration and new login as long as cross-signing does not exist yet
|
|
if let password = self.password, !password.isEmpty {
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Bootstrap with password")
|
|
|
|
crossSigning.setup(withPassword: password) {
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Bootstrap succeeded")
|
|
self.authenticationDidComplete()
|
|
} failure: { error in
|
|
MXLog.error("[AuthenticationCoordinator] sessionStateDidChange: Bootstrap failed. Error: \(error)")
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
self.authenticationDidComplete()
|
|
}
|
|
} else {
|
|
// Try to setup cross-signing without authentication parameters in case if a grace period is enabled
|
|
self.crossSigningService.setupCrossSigningWithoutAuthentication(for: session) {
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Bootstrap succeeded without credentials")
|
|
self.authenticationDidComplete()
|
|
} failure: { error in
|
|
MXLog.error("[AuthenticationCoordinator] sessionStateDidChange: Do not know how to bootstrap cross-signing. Skip it.")
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
self.authenticationDidComplete()
|
|
}
|
|
}
|
|
} else {
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
self.authenticationDidComplete()
|
|
}
|
|
case .crossSigningExists:
|
|
guard self.canPresentAdditionalScreens else {
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Delaying presentCompleteSecurity during onboarding.")
|
|
self.isWaitingToPresentCompleteSecurity = true
|
|
return
|
|
}
|
|
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Complete security")
|
|
self.presentCompleteSecurity()
|
|
default:
|
|
MXLog.debug("[AuthenticationCoordinator] sessionStateDidChange: Nothing to do")
|
|
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
self.authenticationDidComplete()
|
|
}
|
|
} failure: { [weak self] error in
|
|
MXLog.error("[AuthenticationCoordinator] sessionStateDidChange: Fail to refresh crypto state with error: \(error)")
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
self?.authenticationDidComplete()
|
|
}
|
|
} else {
|
|
authenticationDidComplete()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - AuthenticationViewControllerDelegate
|
|
extension AuthenticationCoordinator: AuthenticationViewControllerDelegate {
|
|
func authenticationViewController(_ authenticationViewController: AuthenticationViewController!, didLoginWith session: MXSession!, andPassword password: String!) {
|
|
registerSessionStateChangeNotification(for: session)
|
|
|
|
self.session = session
|
|
self.password = password
|
|
|
|
if canPresentAdditionalScreens {
|
|
showLoadingAnimation()
|
|
}
|
|
completion?(.didLogin(session: session, authenticationType: authenticationViewController.authType))
|
|
}
|
|
}
|
|
|
|
// MARK: - KeyVerificationCoordinatorDelegate
|
|
extension AuthenticationCoordinator: KeyVerificationCoordinatorDelegate {
|
|
func keyVerificationCoordinatorDidComplete(_ coordinator: KeyVerificationCoordinatorType, otherUserId: String, otherDeviceId: String) {
|
|
if let crypto = session?.crypto,
|
|
!crypto.backup.hasPrivateKeyInCryptoStore || !crypto.backup.enabled {
|
|
MXLog.debug("[AuthenticationCoordinator][MXKeyVerification] requestAllPrivateKeys: Request key backup private keys")
|
|
crypto.setOutgoingKeyRequestsEnabled(true, onComplete: nil)
|
|
}
|
|
|
|
navigationRouter.dismissModule(animated: true) { [weak self] in
|
|
self?.authenticationDidComplete()
|
|
}
|
|
}
|
|
|
|
func keyVerificationCoordinatorDidCancel(_ coordinator: KeyVerificationCoordinatorType) {
|
|
navigationRouter.dismissModule(animated: true) { [weak self] in
|
|
self?.authenticationDidComplete()
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - UIAdaptivePresentationControllerDelegate
|
|
extension AuthenticationCoordinator: UIAdaptivePresentationControllerDelegate {
|
|
func presentationControllerShouldDismiss(_ presentationController: UIPresentationController) -> Bool {
|
|
// Prevent Key Verification from using swipe to dismiss
|
|
return false
|
|
}
|
|
}
|