Add Steam OTP support (#71)

bitwarden · Apr 27, 2024 · b3976de · b3976de
1 parent c3510e2
commit b3976de
Show file tree

Hide file tree

Showing 15 changed files with 279 additions and 104 deletions.
diff --git a/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPKey.swift b/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPKey.swift
@@ -45,8 +45,13 @@ enum TOTPKey: Equatable {
     /// The issuer for the TOTP code.
     /// Only works for `otpAuthUri` types.
     var issuer: String? {
-        guard case let .otpAuthUri(model) = self else { return nil }
-        return model.issuer
+        switch self {
+        case .base32,
+             .steamUri:
+            nil
+        case let .otpAuthUri(model):
+            model.issuer
+        }
     }
 
     /// The key used for generating the TOTP code.

diff --git a/...nticatorShared/UI/Platform/Application/Support/Localizations/en.lproj/Localizable.strings b/...nticatorShared/UI/Platform/Application/Support/Localizations/en.lproj/Localizable.strings
@@ -910,3 +910,5 @@
 "KeyReadError" = "Cannot read key.";
 "CannotAddKey" = "Cannot add key?";
 "OnceTheKeyIsSuccessfullyEnteredAddCode" = "Once the key is successfully entered,\nselect Add code to store the key safely";
+"Steam" = "Steam";
+"OtpAuthentication" = "OTP Authentication";
diff --git a/AuthenticatorShared/UI/Platform/Application/Views/FormFields/StepperFieldView.swift b/AuthenticatorShared/UI/Platform/Application/Views/FormFields/StepperFieldView.swift
@@ -64,8 +64,6 @@ struct StepperFieldView<State>: View {
             }
             .padding(.top, 4)
             .accessibilityIdentifier(field.accessibilityId ?? field.id)
-
-            Divider()
         }
     }
 

diff --git a/AuthenticatorShared/UI/Vault/AuthenticatorItem/AuthenticatorItemCoordinator.swift b/AuthenticatorShared/UI/Vault/AuthenticatorItem/AuthenticatorItemCoordinator.swift
@@ -59,7 +59,6 @@ class AuthenticatorItemCoordinator: NSObject, Coordinator, HasStackNavigator {
                 onDismiss?.action()
             })
         case let .editAuthenticatorItem(authenticatorItemView):
-            Logger.application.log("Edit item \(authenticatorItemView.id)")
             showEditAuthenticatorItem(
                 for: authenticatorItemView,
                 delegate: context as? AuthenticatorItemOperationDelegate

diff --git a/AuthenticatorShared/UI/Vault/AuthenticatorItem/AuthenticatorItemState.swift b/AuthenticatorShared/UI/Vault/AuthenticatorItem/AuthenticatorItemState.swift
@@ -64,6 +64,9 @@ struct AuthenticatorItemState: Equatable {
     /// The TOTP key/code state.
     var totpState: LoginTOTPState
 
+    /// The TOTP type.
+    var totpType: TotpTypeOptions
+
     // MARK: Initialization
 
     init(
@@ -77,7 +80,8 @@ struct AuthenticatorItemState: Equatable {
         name: String,
         period: TotpPeriodOptions,
         secret: String,
-        totpState: LoginTOTPState
+        totpState: LoginTOTPState,
+        totpType: TotpTypeOptions
     ) {
         self.accountName = accountName
         self.algorithm = algorithm
@@ -90,23 +94,33 @@ struct AuthenticatorItemState: Equatable {
         self.period = period
         self.secret = secret
         self.totpState = totpState
+        self.totpType = totpType
     }
 
     init?(existing authenticatorItemView: AuthenticatorItemView) {
         guard let keyModel = TOTPKeyModel(authenticatorKey: authenticatorItemView.totpKey) else {
             return nil
         }
+        let type: TotpTypeOptions
+        switch keyModel.totpKey {
+        case .base32, .otpAuthUri:
+            type = .totp
+        case .steamUri:
+            type = .steam
+        }
+
         self.init(
-            accountName: keyModel.accountName ?? "",
+            accountName: keyModel.accountName ?? authenticatorItemView.username ?? "",
             algorithm: keyModel.algorithm,
             configuration: .existing(authenticatorItemView: authenticatorItemView),
             digits: keyModel.digits,
             id: authenticatorItemView.id,
-            issuer: keyModel.issuer ?? "",
+            issuer: keyModel.issuer ?? authenticatorItemView.name,
             name: keyModel.issuer ?? authenticatorItemView.name,
             period: TotpPeriodOptions(rawValue: keyModel.period) ?? .thirty,
             secret: keyModel.base32Key,
-            totpState: LoginTOTPState(authenticatorItemView.totpKey)
+            totpState: LoginTOTPState(authenticatorItemView.totpKey),
+            totpType: type
         )
     }
 }
@@ -148,3 +162,17 @@ enum TotpPeriodOptions: Int, Menuable, CaseIterable {
         }
     }
 }
+
+enum TotpTypeOptions: Menuable, CaseIterable {
+    case steam
+    case totp
+
+    var localizedName: String {
+        switch self {
+        case .steam:
+            Localizations.steam
+        case .totp:
+            Localizations.totp
+        }
+    }
+}
diff --git a/...Shared/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemAction.swift b/...Shared/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemAction.swift
@@ -34,4 +34,7 @@ enum EditAuthenticatorItemAction: Equatable {
 
     /// The toggle secret visibility button was changed.
     case toggleSecretVisibilityChanged(Bool)
+
+    /// The OTP type was changed.
+    case totpTypeChanged(TotpTypeOptions)
 }
diff --git a/...red/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemProcessor.swift b/...red/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemProcessor.swift
@@ -97,6 +97,8 @@ final class EditAuthenticatorItemProcessor: StateProcessor<
             state.isSecretVisible = isVisible
         case let .toastShown(toast):
             state.toast = toast
+        case let .totpTypeChanged(type):
+            state.totpType = type
         }
     }
 
@@ -139,22 +141,34 @@ final class EditAuthenticatorItemProcessor: StateProcessor<
                 return
             case let .existing(authenticatorItemView: authenticatorItemView):
                 guard let secret = state.totpState.authKeyModel?.base32Key else { return }
-                let newOtpUri = OTPAuthModel(
-                    accountName: state.accountName.nilIfEmpty,
-                    algorithm: state.algorithm,
-                    digits: state.digits,
-                    issuer: state.issuer.nilIfEmpty,
-                    period: state.period.rawValue,
-                    secret: secret
-                )
-
-                let newAuthenticatorItemView = AuthenticatorItemView(
-                    favorite: authenticatorItemView.favorite,
-                    id: authenticatorItemView.id,
-                    name: state.issuer,
-                    totpKey: newOtpUri.otpAuthUri,
-                    username: state.accountName
-                )
+                let newAuthenticatorItemView: AuthenticatorItemView
+                switch state.totpType {
+                case .steam:
+                    newAuthenticatorItemView = AuthenticatorItemView(
+                        favorite: false,
+                        id: authenticatorItemView.id,
+                        name: state.issuer,
+                        totpKey: "steam://\(secret)",
+                        username: state.accountName
+                    )
+                case .totp:
+                    let newOtpUri = OTPAuthModel(
+                        accountName: state.accountName.nilIfEmpty,
+                        algorithm: state.algorithm,
+                        digits: state.digits,
+                        issuer: state.issuer.nilIfEmpty,
+                        period: state.period.rawValue,
+                        secret: secret
+                    )
+
+                    newAuthenticatorItemView = AuthenticatorItemView(
+                        favorite: authenticatorItemView.favorite,
+                        id: authenticatorItemView.id,
+                        name: state.issuer,
+                        totpKey: newOtpUri.otpAuthUri,
+                        username: state.accountName
+                    )
+                }
                 try await updateAuthenticatorItem(authenticatorItem: newAuthenticatorItemView)
             }
         } catch let error as InputValidationError {

diff --git a/...rShared/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemState.swift b/...rShared/UI/Vault/AuthenticatorItem/EditAuthenticatorItem/EditAuthenticatorItemState.swift
@@ -1,6 +1,8 @@
 import BitwardenSdk
 import Foundation
 
+// MARK: - EditAuthenticatorItemState
+
 /// The state of an `EditAuthenticatorItemView`
 /// and `EditAdvancedAuthenticatorItemView`
 protocol EditAuthenticatorItemState: Sendable {
@@ -44,4 +46,7 @@ protocol EditAuthenticatorItemState: Sendable {
 
     /// The TOTP key/code state.
     var totpState: LoginTOTPState { get set }
+
+    /// The currently selected TOTP type.
+    var totpType: TotpTypeOptions { get set }
 }