Merge pull request #43 from dimitribouniol/dimitri/configuration

Author: 0xTim

README.md

@@ -25,11 +25,10 @@ Configure your Relying Party with a `WebAuthnManager` instance:
 
 ```swift
 let webAuthnManager = WebAuthnManager(
-    config: WebAuthnConfig(
-        relyingPartyDisplayName: "My Fancy Web App",
+    configuration: WebAuthnManager.Configuration(
         relyingPartyID: "example.com",
-        relyingPartyOrigin: "https://example.com",
-        timeout: 600
+        relyingPartyName: "My Fancy Web App",
+        relyingPartyOrigin: "https://example.com"
     )
 )
 ```

Sources/WebAuthn/Docs.docc/Example Implementation.md

@@ -36,7 +36,7 @@ Configure your backend with a ``WebAuthnManager`` instance:
 
 ```swift
 let webAuthnManager = WebAuthnManager(
-    config: .init(
+    configuration: .init(
         relyingPartyID: "example.com",
         relyingPartyName: "My Fancy Web App",
         relyingPartyOrigin: "https://example.com"
@@ -160,4 +160,4 @@ authSessionRoutes.post("authenticate") { req -> HTTPStatus in
 
     return .ok
 }
-```
+```

Sources/WebAuthn/Docs.docc/index.md

@@ -23,7 +23,7 @@ the corresponding user in a database.
 ### Essentials
 
 - ``WebAuthnManager``
-- ``WebAuthnManager/Config``
+- ``WebAuthnManager/Configuration``
 - ``PublicKeyCredentialUserEntity``
 
 ### Responses

Sources/WebAuthn/WebAuthnManager+Config.swift renamed to Sources/WebAuthn/WebAuthnManager+Configuration.swift

@@ -15,8 +15,8 @@
 import Foundation
 
 extension WebAuthnManager {
-    /// Config represents the WebAuthn configuration.
-    public struct Config {
+    /// Configuration represents the WebAuthn configuration.
+    public struct Configuration {
         /// 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
@@ -29,7 +29,7 @@ extension WebAuthnManager {
         /// The domain, with HTTP protocol (e.g. "https://example.com")
         public let relyingPartyOrigin: String
 
-        /// Creates a new `WebAuthnConfig` with information about the Relying Party
+        /// Creates a new ``WebAuthnManager.Configuration`` with information about the Relying Party
         /// - Parameters:
         ///   - relyingPartyID: The relying party id is based on the host's domain. (e.g. _login.example.com_)
         ///   - relyingPartyName: Name for the Relying Party. Can be any string.

Sources/WebAuthn/WebAuthnManager.swift

@@ -28,23 +28,23 @@ import Foundation
 /// When the client has received the response from the authenticator, pass the response to
 /// `finishAuthentication()`.
 public struct WebAuthnManager {
-    private let config: Config
+    private let configuration: Configuration
 
     private let challengeGenerator: ChallengeGenerator
 
     /// Create a new WebAuthnManager using the given configuration and challenge generator.
     ///
     /// - Parameters:
-    ///   - config: The configuration to use for this manager.
+    ///   - configuration: The configuration to use for this manager.
     ///   - challengeGenerator: The challenge generator to use for this manager. Defaults to a live generator.
-    public init(config: Config, challengeGenerator: ChallengeGenerator = .live) {
-        self.config = config
+    public init(configuration: Configuration, challengeGenerator: ChallengeGenerator = .live) {
+        self.configuration = configuration
         self.challengeGenerator = challengeGenerator
     }
 
     /// Generate a new set of registration data to be sent to the client.
     ///
-    /// This method will use the Relying Party information from the WebAuthnManager's config  to create ``PublicKeyCredentialCreationOptions``
+    /// This method will use the Relying Party information from the WebAuthnManager's configuration  to create ``PublicKeyCredentialCreationOptions``
     /// - Parameters:
     ///   - user: The user to register.
     ///   - timeout: How long the browser should give the user to choose an authenticator. This value
@@ -64,7 +64,7 @@ public struct WebAuthnManager {
         return PublicKeyCredentialCreationOptions(
             challenge: challenge,
             user: user,
-            relyingParty: .init(id: config.relyingPartyID, name: config.relyingPartyName),
+            relyingParty: .init(id: configuration.relyingPartyID, name: configuration.relyingPartyName),
             publicKeyCredentialParameters: publicKeyCredentialParameters,
             timeout: timeout,
             attestation: attestation
@@ -98,8 +98,8 @@ public struct WebAuthnManager {
         let attestedCredentialData = try await parsedData.verify(
             storedChallenge: challenge,
             verifyUser: requireUserVerification,
-            relyingPartyID: config.relyingPartyID,
-            relyingPartyOrigin: config.relyingPartyOrigin,
+            relyingPartyID: configuration.relyingPartyID,
+            relyingPartyOrigin: configuration.relyingPartyOrigin,
             supportedPublicKeyAlgorithms: supportedPublicKeyAlgorithms,
             pemRootCertificatesByFormat: pemRootCertificatesByFormat
         )
@@ -143,7 +143,7 @@ public struct WebAuthnManager {
         return PublicKeyCredentialRequestOptions(
             challenge: challenge,
             timeout: timeout,
-            rpId: config.relyingPartyID,
+            rpId: configuration.relyingPartyID,
             allowCredentials: allowCredentials,
             userVerification: userVerification
         )
@@ -172,8 +172,8 @@ public struct WebAuthnManager {
         let parsedAssertion = try ParsedAuthenticatorAssertionResponse(from: credential.response)
         try parsedAssertion.verify(
             expectedChallenge: expectedChallenge,
-            relyingPartyOrigin: config.relyingPartyOrigin,
-            relyingPartyID: config.relyingPartyID,
+            relyingPartyOrigin: configuration.relyingPartyOrigin,
+            relyingPartyID: configuration.relyingPartyID,
             requireUserVerification: requireUserVerification,
             credentialPublicKey: credentialPublicKey,
             credentialCurrentSignCount: credentialCurrentSignCount

Tests/WebAuthnTests/WebAuthnManagerAuthenticationTests.swift

@@ -26,12 +26,12 @@ final class WebAuthnManagerAuthenticationTests: XCTestCase {
     let relyingPartyOrigin = "https://example.com"
 
     override func setUp() {
-        let config = WebAuthnManager.Config(
+        let configuration = WebAuthnManager.Configuration(
             relyingPartyID: relyingPartyID,
             relyingPartyName: relyingPartyName,
             relyingPartyOrigin: relyingPartyOrigin
         )
-        webAuthnManager = .init(config: config, challengeGenerator: .mock(generate: challenge))
+        webAuthnManager = .init(configuration: configuration, challengeGenerator: .mock(generate: challenge))
     }
 
     func testBeginAuthentication() async throws {

Tests/WebAuthnTests/WebAuthnManagerIntegrationTests.swift

@@ -19,15 +19,15 @@ import Crypto
 final class WebAuthnManagerIntegrationTests: XCTestCase {
     // swiftlint:disable:next function_body_length
     func testRegistrationAndAuthenticationSucceeds() async throws {
-        let config = WebAuthnManager.Config(
+        let configuration = WebAuthnManager.Configuration(
             relyingPartyID: "example.com",
             relyingPartyName: "Example RP",
             relyingPartyOrigin: "https://example.com"
         )
 
         let mockChallenge = [UInt8](repeating: 0, count: 5)
         let challengeGenerator = ChallengeGenerator(generate: { mockChallenge })
-        let webAuthnManager = WebAuthnManager(config: config, challengeGenerator: challengeGenerator)
+        let webAuthnManager = WebAuthnManager(configuration: configuration, challengeGenerator: challengeGenerator)
 
         // Step 1.: Begin Registration
         let mockUser = PublicKeyCredentialUserEntity.mock
@@ -47,8 +47,8 @@ final class WebAuthnManagerIntegrationTests: XCTestCase {
         XCTAssertEqual(registrationOptions.user.name, mockUser.name)
         XCTAssertEqual(registrationOptions.user.displayName, mockUser.displayName)
         XCTAssertEqual(registrationOptions.attestation, attestationPreference)
-        XCTAssertEqual(registrationOptions.relyingParty.id, config.relyingPartyID)
-        XCTAssertEqual(registrationOptions.relyingParty.name, config.relyingPartyName)
+        XCTAssertEqual(registrationOptions.relyingParty.id, configuration.relyingPartyID)
+        XCTAssertEqual(registrationOptions.relyingParty.name, configuration.relyingPartyName)
         XCTAssertEqual(registrationOptions.timeout, timeout)
         XCTAssertEqual(registrationOptions.publicKeyCredentialParameters, publicKeyCredentialParameters)
 
@@ -106,7 +106,7 @@ final class WebAuthnManagerIntegrationTests: XCTestCase {
             userVerification: userVerification
         )
 
-        XCTAssertEqual(authenticationOptions.rpId, config.relyingPartyID)
+        XCTAssertEqual(authenticationOptions.rpId, configuration.relyingPartyID)
         XCTAssertEqual(authenticationOptions.timeout, authenticationTimeout)
         XCTAssertEqual(authenticationOptions.challenge, mockChallenge)
         XCTAssertEqual(authenticationOptions.userVerification, userVerification)
@@ -115,7 +115,7 @@ final class WebAuthnManagerIntegrationTests: XCTestCase {
         // Now send `authenticationOptions` to client, which in turn will send the authenticator's response back to us:
         // The following lines reflect what an authenticator normally produces
         let authenticatorData = TestAuthDataBuilder().validAuthenticationMock()
-            .rpIDHash(fromRpID: config.relyingPartyID)
+            .rpIDHash(fromRpID: configuration.relyingPartyID)
             .counter([0, 0, 0, 1]) // we authenticated once now, so authenticator likely increments the sign counter
             .build()
             .byteArrayRepresentation

Tests/WebAuthnTests/WebAuthnManagerRegistrationTests.swift

@@ -26,12 +26,12 @@ final class WebAuthnManagerRegistrationTests: XCTestCase {
     let relyingPartyOrigin = "https://example.com"
 
     override func setUp() {
-        let config = WebAuthnManager.Config(
+        let configuration = WebAuthnManager.Configuration(
             relyingPartyID: relyingPartyID,
             relyingPartyName: relyingPartyDisplayName,
             relyingPartyOrigin: relyingPartyOrigin
         )
-        webAuthnManager = .init(config: config, challengeGenerator: .mock(generate: challenge))
+        webAuthnManager = .init(configuration: configuration, challengeGenerator: .mock(generate: challenge))
     }
 
     // MARK: - beginRegistration()