Renamed PublicKeyCredentialRequestOptions.rpId to relyingPartyID

Author: dimitribouniol

Sources/WebAuthn/Ceremonies/Authentication/PublicKeyCredentialRequestOptions.swift

@@ -32,8 +32,11 @@ public struct PublicKeyCredentialRequestOptions: Encodable {
     /// See https://www.w3.org/TR/webauthn-2/#dictionary-assertion-options
     public let timeout: Duration?
 
-    /// The Relying Party ID.
-    public let rpId: String?
+    /// The ID of the Relying Party making the request.
+    ///
+    /// This is configured on ``WebAuthnManager`` before its ``WebAuthnManager/beginAuthentication(timeout:allowCredentials:userVerification:)`` method is called.
+    /// - Note: When encoded, this field appears as `rpId` to match the expectations of `navigator.credentials.get()`.
+    public let relyingPartyID: String?
 
     /// Optionally used by the client to find authenticators eligible for this authentication ceremony.
     public let allowCredentials: [PublicKeyCredentialDescriptor]?
@@ -48,15 +51,15 @@ public struct PublicKeyCredentialRequestOptions: Encodable {
 
         try container.encode(challenge.base64URLEncodedString(), forKey: .challenge)
         try container.encodeIfPresent(timeout?.milliseconds, forKey: .timeout)
-        try container.encodeIfPresent(rpId, forKey: .rpId)
+        try container.encodeIfPresent(relyingPartyID, forKey: .rpID)
         try container.encodeIfPresent(allowCredentials, forKey: .allowCredentials)
         try container.encodeIfPresent(userVerification, forKey: .userVerification)
     }
 
     private enum CodingKeys: String, CodingKey {
         case challenge
         case timeout
-        case rpId
+        case rpID = "rpId"
         case allowCredentials
         case userVerification
     }

Sources/WebAuthn/WebAuthnManager.swift

@@ -143,7 +143,7 @@ public struct WebAuthnManager {
         return PublicKeyCredentialRequestOptions(
             challenge: challenge,
             timeout: timeout,
-            rpId: configuration.relyingPartyID,
+            relyingPartyID: configuration.relyingPartyID,
             allowCredentials: allowCredentials,
             userVerification: userVerification
         )

Tests/WebAuthnTests/WebAuthnManagerAuthenticationTests.swift

@@ -44,7 +44,7 @@ final class WebAuthnManagerAuthenticationTests: XCTestCase {
 
         XCTAssertEqual(options.challenge, challenge)
         XCTAssertEqual(options.timeout, .seconds(1234))
-        XCTAssertEqual(options.rpId, relyingPartyID)
+        XCTAssertEqual(options.relyingPartyID, relyingPartyID)
         XCTAssertEqual(options.allowCredentials, allowCredentials)
         XCTAssertEqual(options.userVerification, .preferred)
     }

Tests/WebAuthnTests/WebAuthnManagerIntegrationTests.swift

@@ -106,7 +106,7 @@ final class WebAuthnManagerIntegrationTests: XCTestCase {
             userVerification: userVerification
         )
 
-        XCTAssertEqual(authenticationOptions.rpId, configuration.relyingPartyID)
+        XCTAssertEqual(authenticationOptions.relyingPartyID, configuration.relyingPartyID)
         XCTAssertEqual(authenticationOptions.timeout, authenticationTimeout)
         XCTAssertEqual(authenticationOptions.challenge, mockChallenge)
         XCTAssertEqual(authenticationOptions.userVerification, userVerification)