Merge pull request #56 from dimitribouniol/dimitri/error-enum

Author: 0xTim

Sources/WebAuthn/WebAuthnError.swift

@@ -12,57 +12,119 @@
 //
 //===----------------------------------------------------------------------===//
 
-public enum WebAuthnError: Error, Equatable {
+/// An error that occured preparing or processing WebAuthn-related requests.
+public struct WebAuthnError: Error, Hashable {
+    enum Reason: Error {
+        // MARK: Shared
+        case attestedCredentialDataMissing
+        case relyingPartyIDHashDoesNotMatch
+        case userPresentFlagNotSet
+        case invalidSignature
+
+        // MARK: AttestationObject
+        case userVerificationRequiredButFlagNotSet
+        case attestationStatementMustBeEmpty
+        case attestationVerificationNotSupported
+
+        // MARK: WebAuthnManager
+        case invalidUserID
+        case unsupportedCredentialPublicKeyAlgorithm
+        case credentialIDAlreadyExists
+        case invalidRelyingPartyID
+        case userVerifiedFlagNotSet
+        case potentialReplayAttack
+        case invalidAssertionCredentialType
+
+        // MARK: ParsedAuthenticatorAttestationResponse
+        case invalidAttestationObject
+        case invalidAuthData
+        case invalidFmt
+        case missingAttStmt
+        case attestationFormatNotSupported
+
+        // MARK: ParsedCredentialCreationResponse
+        case invalidCredentialCreationType
+        case credentialRawIDTooLong
+
+        // MARK: AuthenticatorData
+        case authDataTooShort
+        case attestedCredentialFlagNotSet
+        case extensionDataMissing
+        case leftOverBytesInAuthenticatorData
+        case credentialIDTooLong
+        case credentialIDTooShort
+
+        // MARK: CredentialPublicKey
+        case badPublicKeyBytes
+        case invalidKeyType
+        case invalidAlgorithm
+        case invalidCurve
+        case invalidXCoordinate
+        case invalidYCoordinate
+        case unsupportedCOSEAlgorithm
+        case unsupportedCOSEAlgorithmForEC2PublicKey
+        case invalidModulus
+        case invalidExponent
+        case unsupportedCOSEAlgorithmForRSAPublicKey
+        case unsupported
+    }
+    
+    let reason: Reason
+    
+    init(reason: Reason) {
+        self.reason = reason
+    }
+    
     // MARK: Shared
-    case attestedCredentialDataMissing
-    case relyingPartyIDHashDoesNotMatch
-    case userPresentFlagNotSet
-    case invalidSignature
+    public static let attestedCredentialDataMissing = Self(reason: .attestedCredentialDataMissing)
+    public static let relyingPartyIDHashDoesNotMatch = Self(reason: .relyingPartyIDHashDoesNotMatch)
+    public static let userPresentFlagNotSet = Self(reason: .userPresentFlagNotSet)
+    public static let invalidSignature = Self(reason: .invalidSignature)
 
     // MARK: AttestationObject
-    case userVerificationRequiredButFlagNotSet
-    case attestationStatementMustBeEmpty
-    case attestationVerificationNotSupported
+    public static let userVerificationRequiredButFlagNotSet = Self(reason: .userVerificationRequiredButFlagNotSet)
+    public static let attestationStatementMustBeEmpty = Self(reason: .attestationStatementMustBeEmpty)
+    public static let attestationVerificationNotSupported = Self(reason: .attestationVerificationNotSupported)
 
     // MARK: WebAuthnManager
-    case invalidUserID
-    case unsupportedCredentialPublicKeyAlgorithm
-    case credentialIDAlreadyExists
-    case invalidRelyingPartyID
-    case userVerifiedFlagNotSet
-    case potentialReplayAttack
-    case invalidAssertionCredentialType
+    public static let invalidUserID = Self(reason: .invalidUserID)
+    public static let unsupportedCredentialPublicKeyAlgorithm = Self(reason: .unsupportedCredentialPublicKeyAlgorithm)
+    public static let credentialIDAlreadyExists = Self(reason: .credentialIDAlreadyExists)
+    public static let invalidRelyingPartyID = Self(reason: .invalidRelyingPartyID)
+    public static let userVerifiedFlagNotSet = Self(reason: .userVerifiedFlagNotSet)
+    public static let potentialReplayAttack = Self(reason: .potentialReplayAttack)
+    public static let invalidAssertionCredentialType = Self(reason: .invalidAssertionCredentialType)
 
     // MARK: ParsedAuthenticatorAttestationResponse
-    case invalidAttestationObject
-    case invalidAuthData
-    case invalidFmt
-    case missingAttStmt
-    case attestationFormatNotSupported
+    public static let invalidAttestationObject = Self(reason: .invalidAttestationObject)
+    public static let invalidAuthData = Self(reason: .invalidAuthData)
+    public static let invalidFmt = Self(reason: .invalidFmt)
+    public static let missingAttStmt = Self(reason: .missingAttStmt)
+    public static let attestationFormatNotSupported = Self(reason: .attestationFormatNotSupported)
 
     // MARK: ParsedCredentialCreationResponse
-    case invalidCredentialCreationType
-    case credentialRawIDTooLong
+    public static let invalidCredentialCreationType = Self(reason: .invalidCredentialCreationType)
+    public static let credentialRawIDTooLong = Self(reason: .credentialRawIDTooLong)
 
     // MARK: AuthenticatorData
-    case authDataTooShort
-    case attestedCredentialFlagNotSet
-    case extensionDataMissing
-    case leftOverBytesInAuthenticatorData
-    case credentialIDTooLong
-    case credentialIDTooShort
+    public static let authDataTooShort = Self(reason: .authDataTooShort)
+    public static let attestedCredentialFlagNotSet = Self(reason: .attestedCredentialFlagNotSet)
+    public static let extensionDataMissing = Self(reason: .extensionDataMissing)
+    public static let leftOverBytesInAuthenticatorData = Self(reason: .leftOverBytesInAuthenticatorData)
+    public static let credentialIDTooLong = Self(reason: .credentialIDTooLong)
+    public static let credentialIDTooShort = Self(reason: .credentialIDTooShort)
 
     // MARK: CredentialPublicKey
-    case badPublicKeyBytes
-    case invalidKeyType
-    case invalidAlgorithm
-    case invalidCurve
-    case invalidXCoordinate
-    case invalidYCoordinate
-    case unsupportedCOSEAlgorithm
-    case unsupportedCOSEAlgorithmForEC2PublicKey
-    case invalidModulus
-    case invalidExponent
-    case unsupportedCOSEAlgorithmForRSAPublicKey
-    case unsupported
+    public static let badPublicKeyBytes = Self(reason: .badPublicKeyBytes)
+    public static let invalidKeyType = Self(reason: .invalidKeyType)
+    public static let invalidAlgorithm = Self(reason: .invalidAlgorithm)
+    public static let invalidCurve = Self(reason: .invalidCurve)
+    public static let invalidXCoordinate = Self(reason: .invalidXCoordinate)
+    public static let invalidYCoordinate = Self(reason: .invalidYCoordinate)
+    public static let unsupportedCOSEAlgorithm = Self(reason: .unsupportedCOSEAlgorithm)
+    public static let unsupportedCOSEAlgorithmForEC2PublicKey = Self(reason: .unsupportedCOSEAlgorithmForEC2PublicKey)
+    public static let invalidModulus = Self(reason: .invalidModulus)
+    public static let invalidExponent = Self(reason: .invalidExponent)
+    public static let unsupportedCOSEAlgorithmForRSAPublicKey = Self(reason: .unsupportedCOSEAlgorithmForRSAPublicKey)
+    public static let unsupported = Self(reason: .unsupported)
 }