Merge pull request #64 from swift-server/sendable

0xTim · web-flow · commit 996e101b192a · 2024-05-07T10:19:19.000-05:00
Add Sendable Annotations
diff --git a/Package.swift b/Package.swift
@@ -37,10 +37,15 @@ let package = Package(
                 .product(name: "Crypto", package: "swift-crypto"),
                 .product(name: "_CryptoExtras", package: "swift-crypto"),
                 .product(name: "Logging", package: "swift-log"),
-            ]
+            ],
+            swiftSettings: [.enableExperimentalFeature("StrictConcurrency=complete")]
         ),
-        .testTarget(name: "WebAuthnTests", dependencies: [
-            .target(name: "WebAuthn")
-        ])
+        .testTarget(
+            name: "WebAuthnTests",
+            dependencies: [
+                .target(name: "WebAuthn")
+            ],
+            swiftSettings: [.enableExperimentalFeature("StrictConcurrency=complete")]
+        )
     ]
 )
diff --git a/Sources/WebAuthn/Ceremonies/Authentication/AuthenticationCredential.swift b/Sources/WebAuthn/Ceremonies/Authentication/AuthenticationCredential.swift
@@ -17,7 +17,7 @@ import Foundation
 /// The unprocessed response received from `navigator.credentials.get()`.
 ///
 /// When decoding using `Decodable`, the `rawID` is decoded from base64url to bytes.
-public struct AuthenticationCredential {
+public struct AuthenticationCredential: Sendable {
     /// The credential ID of the newly created credential.
     public let id: URLEncodedBase64
 
diff --git a/Sources/WebAuthn/Ceremonies/Authentication/AuthenticatorAssertionResponse.swift b/Sources/WebAuthn/Ceremonies/Authentication/AuthenticatorAssertionResponse.swift
@@ -18,7 +18,7 @@ import Crypto
 /// This is what the authenticator device returned after we requested it to authenticate a user.
 ///
 /// When decoding using `Decodable`, byte arrays are decoded from base64url to bytes.
-public struct AuthenticatorAssertionResponse {
+public struct AuthenticatorAssertionResponse: Sendable {
     /// Representation of what we passed to `navigator.credentials.get()`
     ///
     /// When decoding using `Decodable`, this is decoded from base64url to bytes.
@@ -69,7 +69,7 @@ extension AuthenticatorAssertionResponse: Decodable {
     }
 }
 
-struct ParsedAuthenticatorAssertionResponse {
+struct ParsedAuthenticatorAssertionResponse: Sendable {
     let rawClientData: [UInt8]
     let clientData: CollectedClientData
     let rawAuthenticatorData: [UInt8]
diff --git a/Sources/WebAuthn/Ceremonies/Authentication/PublicKeyCredentialRequestOptions.swift b/Sources/WebAuthn/Ceremonies/Authentication/PublicKeyCredentialRequestOptions.swift
@@ -19,7 +19,7 @@ import Foundation
 /// When encoding using `Encodable`, the byte arrays are encoded as base64url.
 ///
 /// - SeeAlso: https://www.w3.org/TR/webauthn-2/#dictionary-assertion-options
-public struct PublicKeyCredentialRequestOptions: Encodable {
+public struct PublicKeyCredentialRequestOptions: Encodable, Sendable {
     /// A challenge that the authenticator signs, along with other data, when producing an authentication assertion
     ///
     /// When encoding using `Encodable` this is encoded as base64url.
@@ -68,10 +68,10 @@ public struct PublicKeyCredentialRequestOptions: Encodable {
 /// Information about a generated credential.
 ///
 /// When encoding using `Encodable`, `id` is encoded as base64url.
-public struct PublicKeyCredentialDescriptor: Equatable, Encodable {
+public struct PublicKeyCredentialDescriptor: Equatable, Encodable, Sendable {
     /// Defines hints as to how clients might communicate with a particular authenticator in order to obtain an
     /// assertion for a specific credential
-    public enum AuthenticatorTransport: String, Equatable, Encodable {
+    public enum AuthenticatorTransport: String, Equatable, Encodable, Sendable {
         /// Indicates the respective authenticator can be contacted over removable USB.
         case usb
         /// Indicates the respective authenticator can be contacted over Near Field Communication (NFC).
@@ -125,7 +125,7 @@ public struct PublicKeyCredentialDescriptor: Equatable, Encodable {
 
 /// The Relying Party may require user verification for some of its operations but not for others, and may use this
 /// type to express its needs.
-public enum UserVerificationRequirement: String, Encodable {
+public enum UserVerificationRequirement: String, Encodable, Sendable {
     /// The Relying Party requires user verification for the operation and will fail the overall ceremony if the
     /// user wasn't verified.
     case required
diff --git a/Sources/WebAuthn/Ceremonies/Authentication/VerifiedAuthentication.swift b/Sources/WebAuthn/Ceremonies/Authentication/VerifiedAuthentication.swift
@@ -15,8 +15,8 @@
 import Foundation
 
 /// On successful authentication, this structure contains a summary of the authentication flow
-public struct VerifiedAuthentication {
-    public enum CredentialDeviceType: String {
+public struct VerifiedAuthentication: Sendable {
+    public enum CredentialDeviceType: String, Sendable {
         case singleDevice = "single_device"
         case multiDevice = "multi_device"
     }
diff --git a/Sources/WebAuthn/Ceremonies/Registration/PublicKeyCredentialCreationOptions.swift b/Sources/WebAuthn/Ceremonies/Registration/PublicKeyCredentialCreationOptions.swift
@@ -119,7 +119,7 @@ public struct PublicKeyCredentialRelyingPartyEntity: Encodable {
  /// creating a new credential.
  ///
  /// When encoding using `Encodable`, `id` is base64url encoded.
-public struct PublicKeyCredentialUserEntity: Encodable {
+public struct PublicKeyCredentialUserEntity: Encodable, Sendable {
     /// Generated by the Relying Party, unique to the user account, and must not contain personally identifying
     /// information about the user.
     ///
diff --git a/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorAttachment.swift b/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorAttachment.swift
@@ -18,7 +18,7 @@
 /// - SeeAlso: [WebAuthn Level 3 Editor's Draft §5.4.5. Authenticator Attachment Enumeration (enum AuthenticatorAttachment)](https://w3c.github.io/webauthn/#enum-attachment)
 /// - SeeAlso: [WebAuthn Level 3 Editor's Draft §6.2.1. Authenticator Attachment Modality](https://w3c.github.io/webauthn/#sctn-authenticator-attachment-modality)
 ///
-public struct AuthenticatorAttachment: UnreferencedStringEnumeration {
+public struct AuthenticatorAttachment: UnreferencedStringEnumeration, Sendable {
     public var rawValue: String
     public init(_ rawValue: String) {
         self.rawValue = rawValue
diff --git a/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorData.swift b/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorData.swift
@@ -18,7 +18,7 @@ import SwiftCBOR
 
 /// Data created and/ or used by the authenticator during authentication/ registration.
 /// The data contains, for example, whether a user was present or verified.
-struct AuthenticatorData: Equatable {
+struct AuthenticatorData: Equatable, Sendable {
     let relyingPartyIDHash: [UInt8]
     let flags: AuthenticatorFlags
     let counter: UInt32
diff --git a/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorFlags.swift b/Sources/WebAuthn/Ceremonies/Shared/AuthenticatorFlags.swift
@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-struct AuthenticatorFlags: Equatable {
+struct AuthenticatorFlags: Equatable, Sendable {
 
     /**
      Taken from https://w3c.github.io/webauthn/#sctn-authenticator-data
diff --git a/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEAlgorithmIdentifier.swift b/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEAlgorithmIdentifier.swift
@@ -18,7 +18,7 @@ import Crypto
 /// COSEAlgorithmIdentifier From §5.10.5. A number identifying a cryptographic algorithm. The algorithm
 /// identifiers SHOULD be values registered in the IANA COSE Algorithms registry
 /// [https://www.w3.org/TR/webauthn/#biblio-iana-cose-algs-reg], for instance, -7 for "ES256" and -257 for "RS256".
-public enum COSEAlgorithmIdentifier: Int, RawRepresentable, CaseIterable, Encodable {
+public enum COSEAlgorithmIdentifier: Int, RawRepresentable, CaseIterable, Encodable, Sendable {
     /// AlgES256 ECDSA with SHA-256
 	case algES256 = -7
 	/// AlgES384 ECDSA with SHA-384
diff --git a/Sources/WebAuthn/Ceremonies/Shared/COSE/COSECurve.swift b/Sources/WebAuthn/Ceremonies/Shared/COSE/COSECurve.swift
@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-enum COSECurve: UInt64 {
+enum COSECurve: UInt64, Sendable {
     /// EC2, NIST P-256 also known as secp256r1
     case p256 = 1
     /// EC2, NIST P-384 also known as secp384r1
diff --git a/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEKey.swift b/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEKey.swift
@@ -14,7 +14,7 @@
 
 import SwiftCBOR
 
-enum COSEKey {
+enum COSEKey: Sendable {
     // swiftlint:disable identifier_name
     case kty
     case alg
diff --git a/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEKeyType.swift b/Sources/WebAuthn/Ceremonies/Shared/COSE/COSEKeyType.swift
@@ -15,7 +15,7 @@
 import Foundation
 
 /// The Key Type derived from the IANA COSE AuthData
-enum COSEKeyType: UInt64, RawRepresentable {
+enum COSEKeyType: UInt64, RawRepresentable, Sendable {
     /// OctetKey is an Octet Key
 	case octetKey = 1
 	/// EllipticKey is an Elliptic Curve Public Key
diff --git a/Sources/WebAuthn/Ceremonies/Shared/CollectedClientData.swift b/Sources/WebAuthn/Ceremonies/Shared/CollectedClientData.swift
@@ -16,14 +16,14 @@ import Foundation
 
 /// A parsed version of the `clientDataJSON` received from the authenticator. The `clientDataJSON` is a
 /// representation of the options we passed to the WebAuthn API (`.get()`/ `.create()`).
-public struct CollectedClientData: Codable, Hashable {
+public struct CollectedClientData: Codable, Hashable, Sendable {
     enum CollectedClientDataVerifyError: Error {
         case ceremonyTypeDoesNotMatch
         case challengeDoesNotMatch
         case originDoesNotMatch
     }
 
-    public enum CeremonyType: String, Codable {
+    public enum CeremonyType: String, Codable, Sendable {
         case create = "webauthn.create"
         case assert = "webauthn.get"
     }
diff --git a/Sources/WebAuthn/Ceremonies/Shared/CredentialPublicKey.swift b/Sources/WebAuthn/Ceremonies/Shared/CredentialPublicKey.swift
@@ -17,13 +17,13 @@ import _CryptoExtras
 import Foundation
 import SwiftCBOR
 
-protocol PublicKey {
+protocol PublicKey: Sendable {
     var algorithm: COSEAlgorithmIdentifier { get }
     /// Verify a signature was signed with the private key corresponding to the public key.
     func verify(signature: some DataProtocol, data: some DataProtocol) throws
 }
 
-enum CredentialPublicKey {
+enum CredentialPublicKey: Sendable {
     case okp(OKPPublicKey)
     case ec2(EC2PublicKey)
     case rsa(RSAPublicKeyData)
@@ -91,7 +91,7 @@ enum CredentialPublicKey {
     }
 }
 
-struct EC2PublicKey: PublicKey {
+struct EC2PublicKey: PublicKey, Sendable {
     let algorithm: COSEAlgorithmIdentifier
     /// The curve on which we derive the signature from.
     let curve: COSECurve
@@ -159,7 +159,7 @@ struct EC2PublicKey: PublicKey {
 }
 
 /// Currently not in use
-struct RSAPublicKeyData: PublicKey {
+struct RSAPublicKeyData: PublicKey, Sendable {
     let algorithm: COSEAlgorithmIdentifier
     // swiftlint:disable:next identifier_name
     let n: [UInt8]
@@ -209,7 +209,7 @@ struct RSAPublicKeyData: PublicKey {
 }
 
 /// Currently not in use
-struct OKPPublicKey: PublicKey {
+struct OKPPublicKey: PublicKey, Sendable {
     let algorithm: COSEAlgorithmIdentifier
     let curve: UInt64
     let xCoordinate: [UInt8]
diff --git a/Sources/WebAuthn/Ceremonies/Shared/CredentialType.swift b/Sources/WebAuthn/Ceremonies/Shared/CredentialType.swift
@@ -17,7 +17,7 @@
 /// Only ``CredentialType/publicKey`` is supported by WebAuthn.
 /// - SeeAlso: [Credential Management Level 1 Editor's Draft §2.1.2. Credential Type Registry](https://w3c.github.io/webappsec-credential-management/#sctn-cred-type-registry)
 /// - SeeAlso: [WebAuthn Level 3 Editor's Draft §5.1. PublicKeyCredential Interface](https://w3c.github.io/webauthn/#iface-pkcredential)
-public struct CredentialType: UnreferencedStringEnumeration {
+public struct CredentialType: UnreferencedStringEnumeration, Sendable {
     public var rawValue: String
     public init(_ rawValue: String) {
         self.rawValue = rawValue
diff --git a/Sources/WebAuthn/Helpers/Base64Utilities.swift b/Sources/WebAuthn/Helpers/Base64Utilities.swift
@@ -16,7 +16,7 @@ import Foundation
 import Logging
 
 /// Container for base64 encoded data
-public struct EncodedBase64: ExpressibleByStringLiteral, Codable, Hashable, Equatable {
+public struct EncodedBase64: ExpressibleByStringLiteral, Codable, Hashable, Equatable, Sendable {
     private let base64: String
 
     public init(_ string: String) {
@@ -58,7 +58,7 @@ public struct EncodedBase64: ExpressibleByStringLiteral, Codable, Hashable, Equa
 }
 
 /// Container for URL encoded base64 data
-public struct URLEncodedBase64: ExpressibleByStringLiteral, Codable, Hashable, Equatable {
+public struct URLEncodedBase64: ExpressibleByStringLiteral, Codable, Hashable, Equatable, Sendable {
     let base64URL: String
 
     /// Decodes Base64URL string and transforms result into `[UInt8]`
diff --git a/Sources/WebAuthn/Helpers/ChallengeGenerator.swift b/Sources/WebAuthn/Helpers/ChallengeGenerator.swift
@@ -12,8 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-package struct ChallengeGenerator {
-    var generate: () -> [UInt8]
+package struct ChallengeGenerator: Sendable {
+    var generate: @Sendable () -> [UInt8]
 
     package static var live: Self {
         .init(generate: { [UInt8].random(count: 32) })
diff --git a/Sources/WebAuthn/Helpers/UnreferencedStringEnumeration.swift b/Sources/WebAuthn/Helpers/UnreferencedStringEnumeration.swift
@@ -14,7 +14,7 @@
 
 /// An enumeration type that is not referenced by other parts of the Web IDL because that would preclude other values from being used without updating the specification and its implementations.
 /// - SeeAlso: [WebAuthn Level 3 Editor's Draft §2.1.1. Enumerations as DOMString types](https://w3c.github.io/webauthn/#sct-domstring-backwards-compatibility)
-public protocol UnreferencedStringEnumeration: RawRepresentable, Codable, ExpressibleByStringLiteral, Hashable, Comparable where RawValue == String {
+public protocol UnreferencedStringEnumeration: RawRepresentable, Codable, Sendable, ExpressibleByStringLiteral, Hashable, Comparable where RawValue == String {
     init(_ rawValue: RawValue)
 }
 
diff --git a/Sources/WebAuthn/WebAuthnError.swift b/Sources/WebAuthn/WebAuthnError.swift
@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 /// An error that occured preparing or processing WebAuthn-related requests.
-public struct WebAuthnError: Error, Hashable {
+public struct WebAuthnError: Error, Hashable, Sendable {
     enum Reason: Error {
         // MARK: Shared
         case attestedCredentialDataMissing
diff --git a/Sources/WebAuthn/WebAuthnManager+Configuration.swift b/Sources/WebAuthn/WebAuthnManager+Configuration.swift
@@ -16,7 +16,7 @@ import Foundation
 
 extension WebAuthnManager {
     /// Configuration represents the WebAuthn configuration.
-    public struct Configuration {
+    public struct Configuration: Sendable {
         /// The relying party id is based on the host's domain.
         /// It does not include a scheme or port (like the `relyingPartyOrigin`).
         /// For example, if the origin is https://login.example.com:1337, then _login.example.com_ or _example.com_ are
diff --git a/Sources/WebAuthn/WebAuthnManager.swift b/Sources/WebAuthn/WebAuthnManager.swift
@@ -27,7 +27,7 @@ import Foundation
 /// ``PublicKeyCredentialRequestOptions`` to the client.
 /// When the client has received the response from the authenticator, pass the response to
 /// `finishAuthentication()`.
-public struct WebAuthnManager {
+public struct WebAuthnManager: Sendable {
     private let configuration: Configuration
 
     private let challengeGenerator: ChallengeGenerator
diff --git a/Tests/WebAuthnTests/Utils/TestModels/TestConstants.swift b/Tests/WebAuthnTests/Utils/TestModels/TestConstants.swift
@@ -16,6 +16,6 @@ import WebAuthn
 
 struct TestConstants {
     /// Byte representation of string "randomStringFromServer"
-    static var mockChallenge: [UInt8] = "72616e646f6d537472696e6746726f6d536572766572".hexadecimal!
-    static var mockCredentialID: [UInt8] = [0, 1, 2, 3, 4]
+    static let mockChallenge: [UInt8] = "72616e646f6d537472696e6746726f6d536572766572".hexadecimal!
+    static let mockCredentialID: [UInt8] = [0, 1, 2, 3, 4]
 }
