Merge 'release/2024.10-rc1' into 'main'

.github/workflows/_version.yml

@@ -1,4 +1,3 @@
----
 name: Calculate Version Name and Number
 
 

.github/workflows/build.yml

@@ -23,7 +23,6 @@ on:
       compiler-flags:
         description: "Compiler Flags - e.g. 'DEBUG_MENU FEATURE2'"
         type: string
-        default: "DEBUG_MENU"
       base_version_number:
         description: "Base Version Number - Will be added to the calculated version number"
         type: number

.xcode-version

@@ -0,0 +1 @@
+15.4

BitwardenShared/Core/Auth/Models/Response/CreateAccountResponseModel.swift

@@ -6,8 +6,6 @@ import Networking
 /// The response returned from the API upon creating an account.
 ///
 struct CreateAccountResponseModel: JSONResponse {
-    static let decoder = JSONDecoder()
-
     // MARK: Properties
 
     /// The captcha bypass token returned in this response.

BitwardenShared/Core/Auth/Models/Response/IdentityTokenResponseModel.swift

@@ -9,7 +9,7 @@ struct IdentityTokenResponseModel: Equatable, JSONResponse, KdfConfigProtocol {
     // MARK: Account Properties
 
     /// Whether the app needs to force a password reset.
-    let forcePasswordReset: Bool
+    @DefaultFalse var forcePasswordReset: Bool
 
     /// The type of KDF algorithm to use.
     let kdf: KdfType

BitwardenShared/Core/Auth/Models/Response/KnownDeviceResponseModel.swift

@@ -5,8 +5,6 @@ import Networking
 
 /// An object containing a value defining if this device has previously logged into this account or not.
 struct KnownDeviceResponseModel: JSONResponse {
-    static let decoder = JSONDecoder()
-
     // MARK: Properties
 
     /// A flag indicating if this device is known or not.

BitwardenShared/Core/Auth/Models/Response/PreLoginResponseModel.swift

@@ -8,10 +8,6 @@ import Networking
 /// Contains information necessary for encrypting the user's password for login.
 ///
 struct PreLoginResponseModel: Equatable, JSONResponse, KdfConfigProtocol {
-    // MARK: Static Properties
-
-    static let decoder = JSONDecoder()
-
     // MARK: Properties
 
     /// The type of kdf algorithm to use for encryption.

BitwardenShared/Core/Auth/Models/Response/PreValidateSingleSignOnResponse.swift

@@ -6,8 +6,6 @@ import Networking
 /// The response returned from the API upon pre-validating the single-sign on.
 ///
 struct PreValidateSingleSignOnResponse: JSONResponse, Equatable {
-    static let decoder = JSONDecoder()
-
     // MARK: Properties
 
     /// The token returned in this response.

BitwardenShared/Core/Auth/Models/Response/RegisterFinishResponseModel.swift

@@ -6,8 +6,6 @@ import Networking
 /// The response returned from the API upon creating an account.
 ///
 struct RegisterFinishResponseModel: JSONResponse {
-    static let decoder = JSONDecoder()
-
     // MARK: Properties
 
     /// The captcha bypass token returned in this response.

BitwardenShared/Core/Auth/Services/AuthService.swift

@@ -407,11 +407,11 @@ class DefaultAuthService: AuthService { // swiftlint:disable:this type_body_leng
             minNumber: 1,
             minSpecial: 0
         )
-        codeVerifier = try await clientService.generators().password(settings: passwordSettings)
+        codeVerifier = try await clientService.generators(isPreAuth: true).password(settings: passwordSettings)
         let codeChallenge = Data(codeVerifier.utf8)
             .generatedHashBase64Encoded(using: SHA256.self)
             .urlEncoded()
-        let state = try await clientService.generators().password(settings: passwordSettings)
+        let state = try await clientService.generators(isPreAuth: true).password(settings: passwordSettings)
 
         let queryItems = [
             URLQueryItem(name: "client_id", value: Constants.clientType),
@@ -504,7 +504,7 @@ class DefaultAuthService: AuthService { // swiftlint:disable:this type_body_leng
         let appId = await appIdService.getOrCreateAppId()
 
         // Initiate the login request and cache the result.
-        let loginWithDeviceData = try await clientService.auth().newAuthRequest(email: email)
+        let loginWithDeviceData = try await clientService.auth(isPreAuth: true).newAuthRequest(email: email)
         let loginRequest = try await authAPIService.initiateLoginWithDevice(LoginWithDeviceRequestModel(
             email: email,
             publicKey: loginWithDeviceData.publicKey,

BitwardenShared/Core/Auth/Services/AuthServiceTests.swift

@@ -272,6 +272,7 @@ class AuthServiceTests: BitwardenTestCase { // swiftlint:disable:this type_body_
         // Verify the results.
         XCTAssertEqual(client.requests.count, 1)
         XCTAssertEqual(clientService.mockAuth.newAuthRequestEmail, "email@example.com")
+        XCTAssertTrue(clientService.mockAuthIsPreAuth)
         XCTAssertEqual(result.authRequestResponse, authRequestResponse)
         XCTAssertEqual(result.requestId, LoginRequest.fixture().id)
     }

BitwardenShared/Core/Platform/Models/Domain/EnvironmentUrls.swift

@@ -42,6 +42,13 @@ extension EnvironmentUrls {
     /// - Parameter environmentUrlData: The environment URLs used to initialize `EnvironmentUrls`.
     ///
     init(environmentUrlData: EnvironmentUrlData) {
+        // Use the default URLs if the region matches US or EU.
+        let environmentUrlData: EnvironmentUrlData = switch environmentUrlData.region {
+        case .europe: .defaultEU
+        case .unitedStates: .defaultUS
+        case .selfHosted: environmentUrlData
+        }
+
         if environmentUrlData.region == .selfHosted, let base = environmentUrlData.base {
             apiURL = base.appendingPathComponent("api")
             baseURL = base

BitwardenShared/Core/Platform/Models/Domain/EnvironmentUrlsTests.swift

@@ -72,6 +72,50 @@ class EnvironmentUrlsTests: BitwardenTestCase {
         )
     }
 
+    /// `init(environmentUrlData:)` defaults to the pre-defined EU URLs if the base URL matches the EU environment.
+    func test_init_environmentUrlData_baseUrl_europe() {
+        let subject = EnvironmentUrls(
+            environmentUrlData: EnvironmentUrlData(base: URL(string: "https://vault.bitwarden.eu")!)
+        )
+        XCTAssertEqual(
+            subject,
+            EnvironmentUrls(
+                apiURL: URL(string: "https://api.bitwarden.eu")!,
+                baseURL: URL(string: "https://vault.bitwarden.eu")!,
+                eventsURL: URL(string: "https://events.bitwarden.eu")!,
+                iconsURL: URL(string: "https://icons.bitwarden.eu")!,
+                identityURL: URL(string: "https://identity.bitwarden.eu")!,
+                importItemsURL: URL(string: "https://vault.bitwarden.eu/#/tools/import")!,
+                recoveryCodeURL: URL(string: "https://vault.bitwarden.eu/#/recover-2fa")!,
+                sendShareURL: URL(string: "https://vault.bitwarden.eu/#/send")!,
+                settingsURL: URL(string: "https://vault.bitwarden.eu/#/settings")!,
+                webVaultURL: URL(string: "https://vault.bitwarden.eu")!
+            )
+        )
+    }
+
+    /// `init(environmentUrlData:)` defaults to the pre-defined US URLs if the base URL matches the US environment.
+    func test_init_environmentUrlData_baseUrl_unitedStates() {
+        let subject = EnvironmentUrls(
+            environmentUrlData: EnvironmentUrlData(base: URL(string: "https://vault.bitwarden.com")!)
+        )
+        XCTAssertEqual(
+            subject,
+            EnvironmentUrls(
+                apiURL: URL(string: "https://api.bitwarden.com")!,
+                baseURL: URL(string: "https://vault.bitwarden.com")!,
+                eventsURL: URL(string: "https://events.bitwarden.com")!,
+                iconsURL: URL(string: "https://icons.bitwarden.net")!,
+                identityURL: URL(string: "https://identity.bitwarden.com")!,
+                importItemsURL: URL(string: "https://vault.bitwarden.com/#/tools/import")!,
+                recoveryCodeURL: URL(string: "https://vault.bitwarden.com/#/recover-2fa")!,
+                sendShareURL: URL(string: "https://send.bitwarden.com/#")!,
+                settingsURL: URL(string: "https://vault.bitwarden.com/#/settings")!,
+                webVaultURL: URL(string: "https://vault.bitwarden.com")!
+            )
+        )
+    }
+
     /// `init(environmentUrlData:)` sets the URLs from the base URL which includes a trailing slash.
     func test_init_environmentUrlData_baseUrlWithTrailingSlash() {
         let subject = EnvironmentUrls(

BitwardenShared/Core/Platform/Models/Domain/ServerConfig.swift

@@ -29,10 +29,10 @@ struct ServerConfig: Equatable, Codable, Sendable {
         environment = responseModel.environment.map(EnvironmentServerConfig.init)
         self.date = date
         let features: [(FeatureFlag, AnyCodable)]
-        features = responseModel.featureStates.compactMap { key, value in
+        features = responseModel.featureStates?.compactMap { key, value in
             guard let flag = FeatureFlag(rawValue: key) else { return nil }
             return (flag, value)
-        }
+        } ?? []
         featureStates = Dictionary(uniqueKeysWithValues: features)
 
         gitHash = responseModel.gitHash
@@ -43,7 +43,9 @@ struct ServerConfig: Equatable, Codable, Sendable {
     // MARK: Methods
 
     /// Whether the server supports cipher key encryption.
+    ///
     /// - Returns: `true` if it's supported, `false` otherwise.
+    ///
     func supportsCipherKeyEncryption() -> Bool {
         guard let minVersion = ServerVersion(Constants.cipherKeyEncryptionMinServerVersion),
               let serverVersion = ServerVersion(version),
@@ -52,6 +54,14 @@ struct ServerConfig: Equatable, Codable, Sendable {
         }
         return true
     }
+
+    /// Checks if the server is an official Bitwarden server.
+    ///
+    /// - Returns: `true` if the server is `nil`, indicating an official Bitwarden server, otherwise `false`.
+    ///
+    func isOfficialBitwardenServer() -> Bool {
+        server == nil
+    }
 }
 
 // MARK: - ThirdPartyServerConfig

BitwardenShared/Core/Platform/Services/API/Extensions/JSONResponse+Bitwarden.swift

@@ -3,5 +3,5 @@ import Networking
 
 extension JSONResponse {
     /// The decoder used by default to decode JSON responses from the API.
-    static var decoder: JSONDecoder { .defaultDecoder }
+    static var decoder: JSONDecoder { .pascalOrSnakeCaseDecoder }
 }

BitwardenShared/Core/Platform/Services/API/Response/ConfigResponseModel.swift

@@ -12,7 +12,7 @@ struct ConfigResponseModel: Equatable, JSONResponse {
     let environment: EnvironmentServerConfigResponseModel?
 
     /// Feature flags to configure the client.
-    let featureStates: [String: AnyCodable]
+    let featureStates: [String: AnyCodable]?
 
     /// The git hash of the server.
     let gitHash: String

BitwardenShared/Core/Platform/Services/ClientService.swift

@@ -32,10 +32,13 @@ protocol ClientService {
 
     /// Returns a `ClientGeneratorsProtocol` for generator data tasks.
     ///
-    /// - Parameter userId: The user ID mapped to the client instance.
+    /// - Parameters:
+    ///   - userId: The user ID mapped to the client instance.
+    ///   - isPreAuth: Whether the client is being used for a user prior to authentication (when
+    ///     the user's ID doesn't yet exist).
     /// - Returns: A `ClientGeneratorsProtocol` for generator data tasks.
     ///
-    func generators(for userId: String?) async throws -> ClientGeneratorsProtocol
+    func generators(for userId: String?, isPreAuth: Bool) async throws -> ClientGeneratorsProtocol
 
     /// Returns a `ClientPlatformService` for client platform tasks.
     ///
@@ -68,18 +71,12 @@ protocol ClientService {
 // MARK: Extension
 
 extension ClientService {
-    /// Returns a `ClientAuthProtocol` for auth data tasks.
-    ///
-    func auth() async throws -> ClientAuthProtocol {
-        try await auth(for: nil, isPreAuth: false)
-    }
-
     /// Returns a `ClientAuthProtocol` for auth data tasks.
     ///
     /// - Parameter isPreAuth: Whether the client is being used for a user prior to authentication
     ///     (when the user's ID doesn't yet exist).
     ///
-    func auth(isPreAuth: Bool) async throws -> ClientAuthProtocol {
+    func auth(isPreAuth: Bool = false) async throws -> ClientAuthProtocol {
         try await auth(for: nil, isPreAuth: isPreAuth)
     }
 
@@ -97,8 +94,11 @@ extension ClientService {
 
     /// Returns a `ClientGeneratorsProtocol` for generator data tasks.
     ///
-    func generators() async throws -> ClientGeneratorsProtocol {
-        try await generators(for: nil)
+    /// - Parameter isPreAuth: Whether the client is being used for a user prior to authentication
+    ///     (when the user's ID doesn't yet exist). This primarily will happen in SSO flows.
+    ///
+    func generators(isPreAuth: Bool = false) async throws -> ClientGeneratorsProtocol {
+        try await generators(for: nil, isPreAuth: isPreAuth)
     }
 
     /// Returns a `ClientPlatformService` for client platform tasks.
@@ -203,8 +203,8 @@ actor DefaultClientService: ClientService {
         try await client(for: userId).exporters()
     }
 
-    func generators(for userId: String?) async throws -> ClientGeneratorsProtocol {
-        try await client(for: userId).generators()
+    func generators(for userId: String?, isPreAuth: Bool = false) async throws -> ClientGeneratorsProtocol {
+        try await client(for: userId, isPreAuth: isPreAuth).generators()
     }
 
     func platform(for userId: String?) async throws -> ClientPlatformService {

BitwardenShared/Core/Platform/Services/ClientServiceTests.swift

@@ -352,7 +352,7 @@ final class ClientServiceTests: BitwardenTestCase { // swiftlint:disable:this ty
     func test_generators() async throws {
         stateService.activeAccount = .fixture(profile: .fixture(userId: "1"))
 
-        let generators = try await subject.generators()
+        let generators = try await subject.generators(isPreAuth: false)
         XCTAssertIdentical(generators, clientBuilder.clients.first?.clientGenerators)
 
         let user2Generators = try await subject.generators(for: "2")

BitwardenShared/Core/Platform/Services/TestHelpers/MockClientService.swift

@@ -9,6 +9,8 @@ class MockClientService: ClientService {
     var mockCrypto: MockClientCrypto
     var mockExporters: MockClientExporters
     var mockGenerators: MockClientGenerators
+    var mockGeneratorsIsPreAuth = false
+    var mockGeneratorsUserId: String?
     var mockPlatform: MockClientPlatformService
     var mockSends: MockClientSends
     var mockVault: MockClientVaultService
@@ -46,8 +48,10 @@ class MockClientService: ClientService {
         mockExporters
     }
 
-    func generators(for userId: String?) -> ClientGeneratorsProtocol {
-        mockGenerators
+    func generators(for userId: String?, isPreAuth: Bool) -> ClientGeneratorsProtocol {
+        mockGeneratorsIsPreAuth = isPreAuth
+        mockGeneratorsUserId = userId
+        return mockGenerators
     }
 
     func platform(for userId: String?) -> ClientPlatformService {

BitwardenShared/Core/Platform/Utilities/DefaultFalse.swift

@@ -0,0 +1,47 @@
+/// A property wrapper that will default the wrapped value to `false` if decoding fails. This is
+/// useful for decoding a boolean value which may not be present in the response.
+///
+@propertyWrapper
+struct DefaultFalse: Codable, Hashable {
+    // MARK: Properties
+
+    /// The wrapped value.
+    let wrappedValue: Bool
+
+    // MARK: Initialization
+
+    /// Initialize a `DefaultFalse` with a wrapped value.
+    ///
+    /// - Parameter wrappedValue: The value that is contained in the property wrapper.
+    ///
+    init(wrappedValue: Bool) {
+        self.wrappedValue = wrappedValue
+    }
+
+    // MARK: Decodable
+
+    init(from decoder: any Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        wrappedValue = try container.decode(Bool.self)
+    }
+
+    // MARK: Encodable
+
+    func encode(to encoder: Encoder) throws {
+        try wrappedValue.encode(to: encoder)
+    }
+}
+
+// MARK: - KeyedDecodingContainer
+
+extension KeyedDecodingContainer {
+    /// When decoding a `DefaultFalse` wrapped value, if the property doesn't exist, default to `false`.
+    ///
+    /// - Parameters:
+    ///   - type: The type of value to attempt to decode.
+    ///   - key: The key used to decode the value.
+    ///
+    func decode(_ type: DefaultFalse.Type, forKey key: Key) throws -> DefaultFalse {
+        try decodeIfPresent(type, forKey: key) ?? DefaultFalse(wrappedValue: false)
+    }
+}