2022-04-27 15:02:54 +00:00
|
|
|
//
|
|
|
|
// 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
|
|
|
|
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The result returned when querying a homeserver's available login flows.
|
2022-04-27 15:02:54 +00:00
|
|
|
struct LoginFlowResult {
|
|
|
|
let supportedLoginTypes: [MXLoginFlow]
|
|
|
|
let ssoIdentityProviders: [SSOIdentityProvider]
|
|
|
|
let homeserverAddress: String
|
|
|
|
|
|
|
|
var loginMode: LoginMode {
|
|
|
|
if supportedLoginTypes.contains(where: { $0.type == kMXLoginFlowTypeSSO }),
|
|
|
|
supportedLoginTypes.contains(where: { $0.type == kMXLoginFlowTypePassword }) {
|
|
|
|
return .ssoAndPassword(ssoIdentityProviders: ssoIdentityProviders)
|
|
|
|
} else if supportedLoginTypes.contains(where: { $0.type == kMXLoginFlowTypeSSO }) {
|
|
|
|
return .sso(ssoIdentityProviders: ssoIdentityProviders)
|
|
|
|
} else if supportedLoginTypes.contains(where: { $0.type == kMXLoginFlowTypePassword }) {
|
|
|
|
return .password
|
|
|
|
} else {
|
|
|
|
return .unsupported
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The supported forms of login that a homeserver allows.
|
2022-04-27 15:02:54 +00:00
|
|
|
enum LoginMode {
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The login mode hasn't been determined yet.
|
2022-04-27 15:02:54 +00:00
|
|
|
case unknown
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The homeserver supports login with a password.
|
2022-04-27 15:02:54 +00:00
|
|
|
case password
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The homeserver supports login via one or more SSO providers.
|
2022-04-27 15:02:54 +00:00
|
|
|
case sso(ssoIdentityProviders: [SSOIdentityProvider])
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The homeserver supports login with either a password or via an SSO provider.
|
2022-04-27 15:02:54 +00:00
|
|
|
case ssoAndPassword(ssoIdentityProviders: [SSOIdentityProvider])
|
2022-05-19 11:53:46 +00:00
|
|
|
/// The homeserver only allows login with unsupported mechanisms. Use fallback instead.
|
2022-04-27 15:02:54 +00:00
|
|
|
case unsupported
|
|
|
|
|
|
|
|
var ssoIdentityProviders: [SSOIdentityProvider]? {
|
|
|
|
switch self {
|
|
|
|
case .sso(let ssoIdentityProviders), .ssoAndPassword(let ssoIdentityProviders):
|
|
|
|
return ssoIdentityProviders
|
|
|
|
default:
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
var hasSSO: Bool {
|
|
|
|
switch self {
|
|
|
|
case .sso, .ssoAndPassword:
|
|
|
|
return true
|
|
|
|
default:
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-05-19 11:53:46 +00:00
|
|
|
var supportsPasswordFlow: Bool {
|
2022-04-27 15:02:54 +00:00
|
|
|
switch self {
|
|
|
|
case .password, .ssoAndPassword:
|
|
|
|
return true
|
|
|
|
case .unknown, .unsupported, .sso:
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
2022-05-30 16:56:23 +00:00
|
|
|
|
|
|
|
var isUnsupported: Bool {
|
|
|
|
switch self {
|
|
|
|
case .unsupported:
|
|
|
|
return true
|
|
|
|
default:
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
2022-04-27 15:02:54 +00:00
|
|
|
}
|
2022-05-19 11:53:46 +00:00
|
|
|
|
|
|
|
/// Data obtained when calling `LoginWizard.resetPassword` that will be used
|
|
|
|
/// when calling `LoginWizard.checkResetPasswordMailConfirmed`.
|
|
|
|
struct ResetPasswordData {
|
|
|
|
let newPassword: String
|
|
|
|
let addThreePIDSessionID: String
|
|
|
|
}
|
|
|
|
|