Added improved error handling and Open API generated code (#90)

* feat(PSG-3976): added openapi generated code * Refactor auth methods to use OpenAPI generated code (#86) * refactor(PSG-3976): otp & ml auth methods refactor * refactor(PSG-3976): refactored passkey methods * refactor(PSG-3976): remove olde MagicLink struct * refactor(PSG-3976): removed unused api client code * Finish replacing old Passage API code with generated code. (#87) * refactor(PSG-3976): otp & ml auth methods refactor * refactor(PSG-3976): refactored passkey methods * refactor(PSG-3976): remove olde MagicLink struct * refactor(PSG-3976): removed unused api client code * refactor: removed `PassageAPIClient` * refactor: cleaned up unused models * Updated integration tests (#88) * refactor(PSG-3976): otp & ml auth methods refactor * refactor(PSG-3976): refactored passkey methods * refactor(PSG-3976): remove olde MagicLink struct * refactor(PSG-3976): removed unused api client code * refactor: removed `PassageAPIClient` * refactor: cleaned up unused models * refactor: removed PassageSettings class * refactor: update app info tests * refactor: updated get user tests * refactor: updated otp tests * refactor: updated magic link tests * refactor: updated change contact tests * refactor: updated current user tests * refactor: update device tests * refactor: updated session tests * refactor: updated social auth tests * refactor: removed outdated unit tests * refactor: removed unnecessary static test data * refactor: misc test cleanup * Update Sources/Passage/PassageAuth.swift Signed-off-by: Ricky Padilla <[email protected]> --------- Signed-off-by: Ricky Padilla <[email protected]> * Added improved error enums (#89) * chore: removed old unit tests * feat: added script for fixing generated code * fix: fixed passkey login issue w user id * chore: added `CONTRIBUTING.md` and updated code gen fix script. * chore: misc cleanup * chore: misc cleanup * fix: add try safety to identifierExists method * chore: add error explanation to `identifierExists` * feat: added more auth error cases * fix: fixed auth new error cases * chore: increased mailosaur email check retry count --------- Signed-off-by: Ricky Padilla <[email protected]>
passageidentity · Jun 27, 2024 · 857245d · 857245d
1 parent aae2ac1
commit 857245d
Show file tree

Hide file tree

Showing 295 changed files with 13,394 additions and 2,817 deletions.
diff --git a/.github/workflows/test-pull-request.yml b/.github/workflows/test-pull-request.yml
@@ -10,16 +10,6 @@ env:
   MAILOSAUR_API_KEY: ${{ secrets.MAILOSAUR_API_KEY }}
 
 jobs:
-  unit-test-iOS:
-    name: Build and Unit Test
-    runs-on: macos-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Test iOS
-        run: xcodebuild clean build-for-testing test -scheme Passage -sdk iphonesimulator -destination "platform=iOS Simulator,name=iPhone 15 Pro"
-
   integration-test-iOS:
     name: Build and Integration Tests iOS
     runs-on: macos-latest

diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+## Code generation
+
+1. Run below command to update the OpenAPI generated code:
+```
+openapi-generator generate -i https://api.swaggerhub.com/apis/passage/passage-auth-api/1 -g swift5 --additional-properties=responseAs=AsyncAwait -o Sources/Passage/generated
+```
+
+2. Run script to fix known generated code issues:
+```
+python3 Sources/Passage/fix_generated_code.py
+```
diff --git a/Package.resolved b/Package.resolved
@@ -1,5 +1,14 @@
 {
   "pins" : [
+    {
+      "identity" : "anycodable",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/Flight-School/AnyCodable",
+      "state" : {
+        "revision" : "862808b2070cd908cb04f9aafe7de83d35f81b05",
+        "version" : "0.6.7"
+      }
+    },
     {
       "identity" : "swiftkeychainwrapper",
       "kind" : "remoteSourceControl",

diff --git a/Package.swift b/Package.swift
@@ -14,18 +14,15 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
+        .package(url: "https://github.com/Flight-School/AnyCodable", .upToNextMajor(from: "0.6.1")),
         .package(url: "https://github.com/jrendel/SwiftKeychainWrapper", from: "4.0.1")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "Passage",
-            dependencies: ["SwiftKeychainWrapper"], resources: [.copy("Resources/settings.json")]),
-        .testTarget(
-            name: "PassageTests",
-            dependencies: ["Passage"]),
+            dependencies: ["AnyCodable", "SwiftKeychainWrapper"], resources: [.copy("Resources/settings.json")]),
         .testTarget(
             name: "Integration",
             dependencies: ["Passage"]),

diff --git a/Sources/Passage/AuthorizationController/LoginAuthoirzationControllerProtocol.swift b/Sources/Passage/AuthorizationController/LoginAuthoirzationControllerProtocol.swift
@@ -5,7 +5,7 @@ import AuthenticationServices
 @available(iOS 16.0, *)
 protocol LoginAuthorizationControllerProtocol: NSObject, ASAuthorizationControllerDelegate {
 
-    func login(from response: WebauthnLoginStartResponse) async throws -> ASAuthorizationPublicKeyCredentialAssertion?
+    func login(from response: LoginWebAuthnStartResponse) async throws -> ASAuthorizationPublicKeyCredentialAssertion?
 
     func authorizationController(controller: ASAuthorizationController, didCompleteWithAuthorization authorization: ASAuthorization)
 

diff --git a/Sources/Passage/AuthorizationController/LoginAuthorizationController.swift b/Sources/Passage/AuthorizationController/LoginAuthorizationController.swift
@@ -11,11 +11,13 @@ class LoginAuthorizationController : NSObject, ASAuthorizationControllerDelegate
 
     static var shared: LoginAuthorizationControllerProtocol = LoginAuthorizationController()
 
-    func login(from response: WebauthnLoginStartResponse) async throws -> ASAuthorizationPublicKeyCredentialAssertion? {
+    func login(from response: LoginWebAuthnStartResponse) async throws -> ASAuthorizationPublicKeyCredentialAssertion? {
         PassageAutofillAuthorizationController.shared.cancel()
-        let rpId = response.handshake.challenge.publicKey.rpId
         let challenge = response.handshake.challenge.publicKey.challenge
-        guard let decodedChallenge = challenge.decodeBase64Url() else {
+        guard
+            let rpId = response.handshake.challenge.publicKey.rpId,
+            let decodedChallenge = challenge.decodeBase64Url()
+        else {
             return nil
         }
         // Handle platform request
@@ -80,34 +82,13 @@ class LoginAuthorizationController : NSObject, ASAuthorizationControllerDelegate
             credentialAssertionThrowingContinuation?.resume(returning: credentialAssertion)
             credentialAssertionThrowingContinuation = nil
         default:
-            credentialAssertionThrowingContinuation?.resume(throwing: PassageASAuthorizationError.unknownAuthorizationType)
+            credentialAssertionThrowingContinuation?.resume(throwing: ASAuthorizationError.init(.invalidResponse))
         }
     }
 
-
     public func authorizationController(controller: ASAuthorizationController, didCompleteWithError error: Error) {
-
-        // TODO: Implement better error handling below
-        guard let authorizationError = error as? ASAuthorizationError else {
-            credentialAssertionThrowingContinuation?.resume(throwing: PassageASAuthorizationError.unknown)
-            credentialAssertionThrowingContinuation = nil
-            return
-        }
-
-
-        if authorizationError.code == .canceled {
-            // Either the system doesn't find any credentials and the request ends silently, or the user cancels the request.
-            // This is a good time to show a traditional login form, or ask the user to create an account.
-            credentialAssertionThrowingContinuation?.resume(throwing: PassageASAuthorizationError.canceled)
-            credentialAssertionThrowingContinuation = nil
-        } else {
-            // Another ASAuthorization error.
-            // Note: The userInfo dictionary contains useful information.
-            credentialAssertionThrowingContinuation?.resume(throwing: PassageASAuthorizationError.unknownAuthorizationType)
-            credentialAssertionThrowingContinuation = nil
-        }
+        credentialAssertionThrowingContinuation?.resume(throwing: error)
+        credentialAssertionThrowingContinuation = nil
     }
 
-
-
 }
diff --git a/Sources/Passage/AuthorizationController/PassageAutofillAuthorizationController.swift b/Sources/Passage/AuthorizationController/PassageAutofillAuthorizationController.swift
@@ -8,7 +8,7 @@ public class PassageAutofillAuthorizationController : NSObject, ASAuthorizationC
     public static let shared = PassageAutofillAuthorizationController()
 
     var authController : ASAuthorizationController?
-    var startResponse : WebauthnLoginStartResponse?
+    var startResponse : LoginWebAuthnStartResponse?
     var isPerformingModalRequest : Bool = false
     var authenticationAnchor: ASPresentationAnchor?
 
@@ -47,7 +47,7 @@ public class PassageAutofillAuthorizationController : NSObject, ASAuthorizationC
         let startResponse = try await PassageAuth.autoFillStart()
         self.startResponse = startResponse
 
-        let rpId = startResponse.handshake.challenge.publicKey.rpId
+        guard let rpId = startResponse.handshake.challenge.publicKey.rpId else { return }
         let publicKeyCredentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider(relyingPartyIdentifier: rpId)
 
         let challenge = self.startResponse!.handshake.challenge.publicKey.challenge
@@ -69,7 +69,7 @@ public class PassageAutofillAuthorizationController : NSObject, ASAuthorizationC
         case let credentialAssertion as ASAuthorizationPlatformPublicKeyCredentialAssertion:
             Task {
                 guard startResponse != nil else {
-                    throw PassageASAuthorizationError.invalidStartResponse
+                    throw ASAuthorizationError.init(.invalidResponse)
                 }
                 let loginResult = try await PassageAuth.autoFillFinish(startResponse: startResponse!, credentialAssertion: credentialAssertion)
                 isPerformingModalRequest = false
@@ -80,7 +80,7 @@ public class PassageAutofillAuthorizationController : NSObject, ASAuthorizationC
         default:
             isPerformingModalRequest = false
             if let onError = onError {
-                onError(PassageASAuthorizationError.authorizationTypeUnknown)
+                onError(ASAuthorizationError.init(.invalidResponse))
             }
         }
         isPerformingModalRequest = false

diff --git a/Sources/Passage/AuthorizationController/PassageSocialAuthController.swift b/Sources/Passage/AuthorizationController/PassageSocialAuthController.swift
@@ -52,12 +52,12 @@ final internal class PassageSocialAuthController:
                 let idTokenData = appleIDCredential.identityToken,
                 let idToken = String(data: idTokenData, encoding: .utf8) else
             {
-                siwaContinuation?.resume(throwing: PassageSocialError.missingAppleCredentials)
+                siwaContinuation?.resume(throwing: SocialAuthError.missingAppleCredentials)
                 return
             }
             siwaContinuation?.resume(returning: (authCode, idToken))
         } else {
-            siwaContinuation?.resume(throwing: PassageSocialError.missingAppleCredentials)
+            siwaContinuation?.resume(throwing: SocialAuthError.missingAppleCredentials)
         }
     }
 
@@ -161,7 +161,7 @@ final internal class PassageSocialAuthController:
                 let components = NSURLComponents(url: callbackURL, resolvingAgainstBaseURL: true),
                 let authCode = components.queryItems?.filter({$0.name == "code"}).first?.value
             else {
-                continuation.resume(throwing: PassageSocialError.missingAuthCode)
+                continuation.resume(throwing: SocialAuthError.missingAuthCode)
                 return
             }
             continuation.resume(returning: authCode)

diff --git a/Sources/Passage/AuthorizationController/RegistrationAuthorizationController.swift b/Sources/Passage/AuthorizationController/RegistrationAuthorizationController.swift
@@ -14,14 +14,19 @@ class RegistrationAuthorizationController : NSObject, ASAuthorizationControllerD
     static var shared: RegistrationAuthorizationControllerProtocol = RegistrationAuthorizationController()
 
     func register(
-        from response: WebauthnRegisterStartResponse,
+        from response: RegisterWebAuthnStartResponse,
         identifier: String,
         includeSecurityKeyOption: Bool = false
     ) async throws -> ASAuthorizationPublicKeyCredentialRegistration? {
         PassageAutofillAuthorizationController.shared.cancel()
-        let rpId = response.handshake.challenge.publicKey.rp.id
-        let challenge = response.handshake.challenge.publicKey.challenge
-        let userId = response.user.id
+        guard
+            let publicKey = response.handshake.challenge.publicKey,
+            let challenge = publicKey.challenge,
+            let rpId = publicKey.rp?.id,
+            let userId = response.user?.id
+        else {
+            return nil
+        }
         guard let decodedChallenge = challenge.decodeBase64Url() else {
             return nil
         }
@@ -77,32 +82,13 @@ class RegistrationAuthorizationController : NSObject, ASAuthorizationControllerD
             credentialRegistrationCheckedThrowingContinuation?.resume(returning: credentialRegistration)
             credentialRegistrationCheckedThrowingContinuation = nil
         default:
-            credentialRegistrationCheckedThrowingContinuation?.resume(throwing: PassageASAuthorizationError.credentialRegistration)
+            credentialRegistrationCheckedThrowingContinuation?.resume(throwing: ASAuthorizationError.init(.invalidResponse))
         }
     }
 
-
     public func authorizationController(controller: ASAuthorizationController, didCompleteWithError error: Error) {
-
-        // TODO: Implement better error handling below
-        guard let authorizationError = error as? ASAuthorizationError else {
-            credentialRegistrationCheckedThrowingContinuation?.resume(throwing: PassageASAuthorizationError.unknown)
-            credentialRegistrationCheckedThrowingContinuation = nil
-            return
-        }
-
-
-        if authorizationError.code == .canceled {
-            // Either the system doesn't find any credentials and the request ends silently, or the user cancels the request.
-            // This is a good time to show a traditional login form, or ask the user to create an account.
-            credentialRegistrationCheckedThrowingContinuation?.resume(throwing: PassageASAuthorizationError.canceled)
-            credentialRegistrationCheckedThrowingContinuation = nil
-        } else {
-            // Another ASAuthorization error.
-            // Note: The userInfo dictionary contains useful information.
-            credentialRegistrationCheckedThrowingContinuation?.resume(throwing: PassageASAuthorizationError.unknownAuthorizationType)
-            credentialRegistrationCheckedThrowingContinuation = nil
-        }
+        credentialRegistrationCheckedThrowingContinuation?.resume(throwing: error)
+        credentialRegistrationCheckedThrowingContinuation = nil
     }
 
 

diff --git a/Sources/Passage/AuthorizationController/RegistrationAuthorizationControllerProtocol.swift b/Sources/Passage/AuthorizationController/RegistrationAuthorizationControllerProtocol.swift
@@ -4,7 +4,7 @@ import AuthenticationServices
 protocol RegistrationAuthorizationControllerProtocol: NSObject, ASAuthorizationControllerDelegate {
 
     func register(
-        from response: WebauthnRegisterStartResponse,
+        from response: RegisterWebAuthnStartResponse,
         identifier: String,
         includeSecurityKeyOption: Bool
     ) async throws -> ASAuthorizationPublicKeyCredentialRegistration?

diff --git a/Sources/Passage/Errors/AddDeviceError.swift b/Sources/Passage/Errors/AddDeviceError.swift
@@ -0,0 +1,40 @@
+import AuthenticationServices
+
+public enum AddDeviceError: PassageError {
+
+    case authorizationFailed
+    case canceled
+    case credentialChallengeParsingFailed
+    case inactiveUser
+    case invalidRequest
+    case unauthorized
+    case unspecified
+
+    public static func convert(error: Error) -> AddDeviceError {
+        // Check if error is already proper
+        if let addDeviceError = error as? AddDeviceError {
+            return addDeviceError
+        }
+        // Handle client error
+        if let errorResponse = error as? ErrorResponse {
+            guard let (statusCode, errorData) = PassageErrorData.getData(from: errorResponse) else {
+                return .unspecified
+            }
+            switch errorData.code {
+            case Model400Code.request.rawValue: return .invalidRequest
+            case Model403Code.userNotActive.rawValue: return .inactiveUser
+            default: ()
+            }
+            if statusCode == 401 {
+                return .unauthorized
+            }
+            return .unspecified
+        }
+        // Handle authorization error
+        if let authError = error as? ASAuthorizationError {
+            return authError.code == .canceled ? .canceled : .authorizationFailed
+        }
+        return .unspecified
+    }
+
+}
diff --git a/Sources/Passage/Errors/AppInfoError.swift b/Sources/Passage/Errors/AppInfoError.swift
@@ -0,0 +1,26 @@
+import Foundation
+
+public enum AppInfoError: PassageError {
+
+    case appNotFound
+    case unspecified
+
+    public static func convert(error: Error) -> AppInfoError {
+        // Check if error is already proper
+        if let appInfoError = error as? AppInfoError {
+            return appInfoError
+        }
+        // Handle client error
+        if let errorResponse = error as? ErrorResponse {
+            guard let (_, errorData) = PassageErrorData.getData(from: errorResponse) else {
+                return .unspecified
+            }
+            if errorData.code == Model404Code.appNotFound.rawValue {
+                return .appNotFound
+            }
+            return .unspecified
+        }
+        return .unspecified
+    }
+
+}
diff --git a/Sources/Passage/Errors/ConfigurationError.swift b/Sources/Passage/Errors/ConfigurationError.swift
@@ -0,0 +1,15 @@
+import Foundation
+
+public enum PassageConfigurationError: Error {
+    case cannotFindPassagePlist
+    case cannotFindAppId
+
+    public var description: String {
+        switch self {
+        case .cannotFindAppId:
+            return "Cannot find required Passage.plist file."
+        case .cannotFindPassagePlist:
+            return "Cannot find your Passage app id in your Passage.plist file"
+        }
+    }
+}
diff --git a/Sources/Passage/Errors/GetMagicLinkStatusError.swift b/Sources/Passage/Errors/GetMagicLinkStatusError.swift
@@ -0,0 +1,29 @@
+import Foundation
+
+public enum GetMagicLinkStatusError: PassageError {
+
+    case invalidRequest
+    case magicLinkNotFound
+    case unspecified
+
+    public static func convert(error: Error) -> GetMagicLinkStatusError {
+        // Check if error is already proper
+        if let error = error as? GetMagicLinkStatusError {
+            return error
+        }
+        // Handle client error
+        if let errorResponse = error as? ErrorResponse {
+            guard let (_, errorData) = PassageErrorData.getData(from: errorResponse) else {
+                return .unspecified
+            }
+            switch errorData.code {
+            case Model400Code.request.rawValue: return .invalidRequest
+            case Model404Code.magicLinkNotFound.rawValue: return .magicLinkNotFound
+            default: ()
+            }
+            return .unspecified
+        }
+        return .unspecified
+    }
+
+}