Repository Public
1// SP Notes Core2// File: Tests/SPNotesAPITests/PasskeyAndAuthTests.swift3// Description: WebAuthn JSON: options decoding, byte-for-byte verify bodies, error mapping; and the AuthService flows4// (sign-in, step-up, add passkey, sign-out) with a scripted authorizer on the stub transport.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import AuthenticationServices9import Foundation10import XCTest11@testable import SPNotesAPI1213/// A scripted device: returns fixed credentials and records what it was asked.14@MainActor15final class FakeAuthorizer: PasskeyAuthorizing {16 var assertionRequests: [PasskeyRequestOptions] = []17 var registrationRequests: [PasskeyCreationOptions] = []18 var failure: PasskeyError?1920 nonisolated static let assertion = PasskeyCeremony.assertionCredential(21 credentialID: Data([0xFB, 0xFF, 0xFE, 0x01]), clientDataJSON: Data(#"{"type":"webauthn.get"}"#.utf8),22 authenticatorData: Data([0x49, 0x96, 0x0D, 0xE5, 0x88]), signature: Data([0x30, 0x45, 0x02, 0x21]), userHandle: Data([0x63, 0xB6, 0x09])23 )24 nonisolated static let registration = PasskeyCeremony.registrationCredential(25 credentialID: Data([0x01, 0x02, 0x03]), clientDataJSON: Data(#"{"type":"webauthn.create"}"#.utf8), attestationObject: Data([0xA3, 0x63, 0x66, 0x6D, 0x74])26 )2728 func assertion(for options: PasskeyRequestOptions) async throws -> PasskeyAssertionCredential {29 assertionRequests.append(options)30 if let failure { throw failure }31 return Self.assertion32 }3334 func registration(for options: PasskeyCreationOptions) async throws -> PasskeyRegistrationCredential {35 registrationRequests.append(options)36 if let failure { throw failure }37 return Self.registration38 }39}4041final class PasskeyAndAuthTests: XCTestCase {42 /// Captured from the test server on 2026-11-18.43 static let requestOptionsJSON = #"{"options":{"rpId":"localhost","challenge":"_M3GdzYSGRAz9UKQG76PoBSG00Fb_PRglWQ9LL2Ai7c","allowCredentials":[],"timeout":120000,"userVerification":"required"}}"#44 static let creationOptionsJSON = #"{"options":{"challenge":"lEG_C9sKeNd1TZon1U4Pp6eG-iBSspfKN08hkhz5GP0","rp":{"name":"Note SPBoucher AI","id":"localhost"},"user":{"id":"Y7YJdRanTpaoJPAQrQGesg","name":"simon","displayName":"Simon-Pierre Boucher"},"pubKeyCredParams":[{"alg":-48,"type":"public-key"},{"alg":-8,"type":"public-key"},{"alg":-7,"type":"public-key"},{"alg":-257,"type":"public-key"}],"timeout":120000,"attestation":"none","excludeCredentials":[{"id":"AQID","type":"public-key","transports":["internal","hybrid"]}],"authenticatorSelection":{"residentKey":"required","requireResidentKey":true,"userVerification":"required"},"extensions":{"credProps":true},"hints":[]}}"#4546 // MARK: options4748 func testRequestOptionsDecoding() throws {49 let options = try PasskeyCeremony.decodeRequestOptions(Data(Self.requestOptionsJSON.utf8))50 XCTAssertEqual(options.rpId, "localhost")51 XCTAssertEqual(options.challenge.count, 32)52 XCTAssertEqual(Base64URL.encode(options.challenge), "_M3GdzYSGRAz9UKQG76PoBSG00Fb_PRglWQ9LL2Ai7c")53 XCTAssertEqual(options.allowCredentials, [])54 XCTAssertEqual(options.userVerification, "required")55 XCTAssertEqual(options.timeout, 120_000)5657 // Without the envelope, with padding, with plain base64 and with allowed credentials.58 let bare = try PasskeyCeremony.decodeRequestOptions(Data(#"{"challenge":"+/+/AQ==","rpId":"note.spboucher.ai","allowCredentials":[{"id":"-__-","type":"public-key","transports":["internal"]},{"id":"AQI=","type":"public-key"}]}"#.utf8))59 XCTAssertEqual(bare.challenge, Data([0xFB, 0xFF, 0xBF, 0x01]))60 XCTAssertEqual(bare.rpId, "note.spboucher.ai")61 XCTAssertEqual(bare.allowCredentials, [PasskeyCredentialDescriptor(id: Data([0xFB, 0xFF, 0xFE]), transports: ["internal"]), PasskeyCredentialDescriptor(id: Data([1, 2]))])62 XCTAssertNil(bare.userVerification)63 }6465 func testCreationOptionsDecoding() throws {66 let options = try PasskeyCeremony.decodeCreationOptions(Data(Self.creationOptionsJSON.utf8))67 XCTAssertEqual(options.rp, .init(id: "localhost", name: "Note SPBoucher AI"))68 XCTAssertEqual(options.user.name, "simon")69 XCTAssertEqual(options.user.displayName, "Simon-Pierre Boucher")70 XCTAssertEqual(options.user.id.count, 16)71 XCTAssertEqual(Base64URL.encode(options.user.id), "Y7YJdRanTpaoJPAQrQGesg")72 XCTAssertEqual(options.challenge.count, 32)73 XCTAssertEqual(options.excludeCredentials, [PasskeyCredentialDescriptor(id: Data([1, 2, 3]), transports: ["internal", "hybrid"])])74 XCTAssertEqual(options.attestation, "none")75 }7677 func testInvalidOptionsAreTyped() {78 for json in [#"{"options":{"rpId":"x"}}"#, #"{"challenge":"***"}"#, "[]", "not json"] {79 XCTAssertThrowsError(try PasskeyCeremony.decodeRequestOptions(Data(json.utf8)), json) { error in80 guard case PasskeyError.invalidOptions = error else { return XCTFail("\(error)") }81 }82 }83 XCTAssertThrowsError(try PasskeyCeremony.decodeCreationOptions(Data(#"{"challenge":"AQ","rp":{"name":"n"},"user":{"id":"!!","name":"n"}}"#.utf8)))84 }8586 // MARK: verify bodies, byte for byte8788 func testAssertionVerifyBodyIsExact() throws {89 let body = try PasskeyCeremony.assertionVerifyBody(FakeAuthorizer.assertion)90 let expected = #"{"response":{"authenticatorAttachment":"platform","clientExtensionResults":{},"id":"-__-AQ","rawId":"-__-AQ","response":{"authenticatorData":"SZYN5Yg","clientDataJSON":"eyJ0eXBlIjoid2ViYXV0aG4uZ2V0In0","signature":"MEUCIQ","userHandle":"Y7YJ"},"type":"public-key"}}"#91 XCTAssertEqual(String(decoding: body, as: UTF8.self), expected)92 XCTAssertEqual(body, Data(expected.utf8))93 }9495 func testAssertionVerifyBodyOmitsMissingUserHandle() throws {96 for handle in [nil, Data()] as [Data?] {97 let credential = PasskeyCeremony.assertionCredential(credentialID: Data([0xFF]), clientDataJSON: Data([0x7B, 0x7D]), authenticatorData: Data([0x00]), signature: Data([0xFE, 0xFF]), userHandle: handle)98 let body = try PasskeyCeremony.assertionVerifyBody(credential)99 XCTAssertEqual(100 String(decoding: body, as: UTF8.self),101 #"{"response":{"authenticatorAttachment":"platform","clientExtensionResults":{},"id":"_w","rawId":"_w","response":{"authenticatorData":"AA","clientDataJSON":"e30","signature":"_v8"},"type":"public-key"}}"#102 )103 }104 }105106 func testRegistrationVerifyBodyIsExact() throws {107 let expectedCredential = #"{"authenticatorAttachment":"platform","clientExtensionResults":{},"id":"AQID","rawId":"AQID","response":{"attestationObject":"o2NmbXQ","clientDataJSON":"eyJ0eXBlIjoid2ViYXV0aG4uY3JlYXRlIn0","transports":["internal","hybrid"]},"type":"public-key"}"#108 XCTAssertEqual(109 String(decoding: try PasskeyCeremony.registrationVerifyBody(FakeAuthorizer.registration, label: " iPhone de Simon "), as: UTF8.self),110 #"{"label":"iPhone de Simon","response":\#(expectedCredential)}"#111 )112 for label in [nil, "", " "] as [String?] {113 XCTAssertEqual(String(decoding: try PasskeyCeremony.registrationVerifyBody(FakeAuthorizer.registration, label: label), as: UTF8.self), #"{"response":\#(expectedCredential)}"#)114 }115 let long = try PasskeyCeremony.registrationVerifyBody(FakeAuthorizer.registration, label: String(repeating: "x", count: 200))116 XCTAssertTrue(String(decoding: long, as: UTF8.self).hasPrefix(#"{"label":"\#(String(repeating: "x", count: 60))","response""#))117 }118119 func testEncodedFieldsNeverCarryPaddingOrStandardAlphabet() throws {120 var generator = SystemRandomNumberGenerator()121 for length in 1...40 {122 let data = Data((0..<length).map { _ in UInt8.random(in: 0...255, using: &generator) })123 let credential = PasskeyCeremony.assertionCredential(credentialID: data, clientDataJSON: data, authenticatorData: data, signature: data, userHandle: data)124 let object = try XCTUnwrap(jsonObject(try PasskeyCeremony.assertionVerifyBody(credential)) as? [String: Any])125 let outer = try XCTUnwrap(object["response"] as? [String: Any])126 let inner = try XCTUnwrap(outer["response"] as? [String: String])127 for value in [outer["id"] as? String, outer["rawId"] as? String, inner["clientDataJSON"], inner["authenticatorData"], inner["signature"], inner["userHandle"]] {128 let text = try XCTUnwrap(value)129 XCTAssertNotNil(text.range(of: "^[A-Za-z0-9_-]+$", options: .regularExpression), text)130 XCTAssertEqual(Base64URL.decode(text), data)131 }132 XCTAssertEqual(outer["type"] as? String, "public-key")133 XCTAssertEqual((outer["clientExtensionResults"] as? [String: Any])?.count, 0)134 }135 }136137 // MARK: device errors138139 func testAuthorizationErrorMapping() {140 func asError(_ code: ASAuthorizationError.Code, _ userInfo: [String: Any] = [:]) -> NSError {141 NSError(domain: ASAuthorizationError.errorDomain, code: code.rawValue, userInfo: userInfo)142 }143 XCTAssertEqual(PasskeyError.from(asError(.canceled)), .cancelled)144 XCTAssertEqual(PasskeyError.from(asError(.canceled, [NSLocalizedFailureReasonErrorKey: "No credentials available for login."])), .noCredentials)145 XCTAssertEqual(PasskeyError.from(asError(.notInteractive)), .notInteractive)146 XCTAssertEqual(PasskeyError.from(asError(.matchedExcludedCredential)), .alreadyRegistered)147 guard case .notAssociated = PasskeyError.from(asError(.failed, [NSLocalizedFailureReasonErrorKey: "Application with identifier X is not associated with domain note.spboucher.ai"])) else { return XCTFail("notAssociated") }148 guard case .failed(let code, _) = PasskeyError.from(asError(.failed)) else { return XCTFail("failed") }149 XCTAssertEqual(code, ASAuthorizationError.Code.failed.rawValue)150 XCTAssertEqual(PasskeyError.from(CancellationError()), .cancelled)151 XCTAssertEqual(PasskeyError.from(PasskeyError.inProgress), .inProgress)152 XCTAssertTrue(PasskeyError.cancelled.isCancelled)153 XCTAssertNotNil(PasskeyError.noCredentials.errorDescription)154 }155156 // MARK: AuthService157158 private static let sessionCookie = "__Host-note_session=tok_signed_in; Path=/; HttpOnly; Secure; SameSite=Lax, __Host-note_wa=; Path=/; Max-Age=0"159160 private func service(token: String?) async -> (AuthService, HTTPClient, InMemoryTokenStore, FakeAuthorizer) {161 let (api, client, store) = TestEnv.api(token: token)162 let authorizer = FakeAuthorizer()163 return (AuthService(api: api, authorizer: authorizer), client, store, authorizer)164 }165166 func testSignInRunsTheWholeCeremony() async throws {167 StubServer.shared.reset { request in168 switch request.path {169 case "/api/auth/login/options": return .json(Self.requestOptionsJSON, headers: ["Set-Cookie": "__Host-note_wa=wa-login-1; Path=/; Max-Age=300; HttpOnly; SameSite=Strict; Secure"])170 case "/api/auth/login/verify": return .json(#"{"ok":true,"next":"/"}"#, headers: ["Set-Cookie": Self.sessionCookie])171 default: return .json("{}", status: 404)172 }173 }174 let (auth, client, store, authorizer) = await service(token: nil)175 var events = await client.sessionEvents().makeAsyncIterator()176 var signedIn = await auth.isSignedIn177 XCTAssertFalse(signedIn)178179 let result = try await auth.signIn()180 XCTAssertEqual(result, LoginResult(ok: true, next: "/"))181 signedIn = await auth.isSignedIn182 XCTAssertTrue(signedIn)183 XCTAssertEqual(store.load(), "tok_signed_in")184 let event = await events.next()185 XCTAssertEqual(event, .signedIn)186187 let asked = await authorizer.assertionRequests188 XCTAssertEqual(asked.count, 1)189 XCTAssertEqual(asked.first?.rpId, "localhost")190 XCTAssertEqual(asked.first.map { Base64URL.encode($0.challenge) }, "_M3GdzYSGRAz9UKQG76PoBSG00Fb_PRglWQ9LL2Ai7c")191192 let requests = StubServer.shared.requests193 XCTAssertEqual(requests.map(\.path), ["/api/auth/login/options", "/api/auth/login/verify"])194 XCTAssertEqual(requests.map(\.method), ["POST", "POST"])195 XCTAssertNil(requests[0].header("Cookie"))196 XCTAssertEqual(requests[0].header("Origin"), "https://notes.test")197 XCTAssertTrue(requests[0].body.isEmpty)198 XCTAssertEqual(requests[1].header("Cookie"), "__Host-note_wa=wa-login-1")199 XCTAssertEqual(requests[1].header("Content-Type"), "application/json")200 XCTAssertEqual(requests[1].body, try PasskeyCeremony.assertionVerifyBody(FakeAuthorizer.assertion))201 }202203 func testSignInWithoutSessionCookieIsAnError() async {204 StubServer.shared.reset { request in205 request.path.hasSuffix("options") ? .json(Self.requestOptionsJSON) : .json(#"{"ok":true}"#)206 }207 let (auth, _, _, _) = await service(token: nil)208 let error = await captureAPIError { try await auth.signIn() }209 XCTAssertEqual(error, .invalidResponse)210 }211212 func testSignInFailuresAreTyped() async {213 // No passkey on the account.214 StubServer.shared.reset { _ in .json(#"{"error":"No passkey is registered yet.","code":"not_enrolled"}"#, status: 409) }215 var (auth, _, _, authorizer) = await service(token: nil)216 let error = await captureAPIError { try await auth.signIn() }217 XCTAssertEqual(error?.code, "not_enrolled")218 var asked = await authorizer.assertionRequests219 XCTAssertTrue(asked.isEmpty)220221 // The person dismisses the sheet: no verify call.222 StubServer.shared.reset { _ in .json(Self.requestOptionsJSON, headers: ["Set-Cookie": "__Host-note_wa=wa-2; Path=/"]) }223 (auth, _, _, authorizer) = await service(token: nil)224 await MainActor.run { authorizer.failure = .cancelled }225 do { _ = try await auth.signIn(); XCTFail("expected a cancellation") } catch { XCTAssertEqual(error as? PasskeyError, .cancelled) }226 asked = await authorizer.assertionRequests227 XCTAssertEqual(asked.count, 1)228 XCTAssertEqual(StubServer.shared.requests.map(\.path), ["/api/auth/login/options"])229 let signedIn = await auth.isSignedIn230 XCTAssertFalse(signedIn)231 }232233 func testStepUpRotatesTheToken() async throws {234 StubServer.shared.reset { request in235 switch request.path {236 case "/api/auth/reauth/options": return .json(Self.requestOptionsJSON, headers: ["Set-Cookie": "__Host-note_wa=wa-reauth; Path=/; Max-Age=300"])237 case "/api/auth/reauth/verify": return .json(#"{"ok":true,"freshForMs":300000}"#, headers: ["Set-Cookie": "__Host-note_session=tok_rotated; Path=/; HttpOnly; Secure, __Host-note_wa=; Path=/; Max-Age=0"])238 default: return .json("{}")239 }240 }241 let (auth, client, store, _) = await service(token: TestEnv.token)242 var events = await client.sessionEvents().makeAsyncIterator()243 let result = try await auth.stepUp()244 XCTAssertEqual(result.freshForMs, 300_000)245 XCTAssertEqual(store.load(), "tok_rotated")246 let event = await events.next()247 XCTAssertEqual(event, .tokenRotated)248 let requests = StubServer.shared.requests249 XCTAssertEqual(requests[0].header("Cookie"), "__Host-note_session=\(TestEnv.token)")250 XCTAssertEqual(requests[1].header("Cookie"), "__Host-note_session=\(TestEnv.token); __Host-note_wa=wa-reauth")251 _ = try await client.send(.get("/api/sync"))252 XCTAssertEqual(StubServer.shared.last?.header("Cookie"), "__Host-note_session=tok_rotated")253 }254255 func testAddPasskeyStepsUpWhenTheSessionIsNotFresh() async throws {256 let counter = EndlessCounter()257 StubServer.shared.reset { request in258 switch request.path {259 case "/api/auth/passkeys/options":260 if counter.next() == 1 { return .json(#"{"error":"Verify with your passkey","code":"reauth_required"}"#, status: 403) }261 return .json(Self.creationOptionsJSON, headers: ["Set-Cookie": "__Host-note_wa=wa-register; Path=/; Max-Age=300"])262 case "/api/auth/reauth/options": return .json(Self.requestOptionsJSON, headers: ["Set-Cookie": "__Host-note_wa=wa-reauth; Path=/; Max-Age=300"])263 case "/api/auth/reauth/verify": return .json(#"{"ok":true,"freshForMs":300000}"#, headers: ["Set-Cookie": "__Host-note_session=tok_fresh; Path=/"])264 case "/api/auth/passkeys/verify": return .json(#"{"ok":true,"id":"AQID","label":"iPhone"}"#)265 default: return .json("{}", status: 404)266 }267 }268 let (auth, _, _, authorizer) = await service(token: TestEnv.token)269 let added = try await auth.addPasskey(label: "iPhone")270 XCTAssertEqual(added, PasskeyAdded(ok: true, id: "AQID", label: "iPhone"))271 let requests = StubServer.shared.requests272 XCTAssertEqual(requests.map(\.path), ["/api/auth/passkeys/options", "/api/auth/reauth/options", "/api/auth/reauth/verify", "/api/auth/passkeys/options", "/api/auth/passkeys/verify"])273 XCTAssertEqual(requests[2].header("Cookie"), "__Host-note_session=\(TestEnv.token); __Host-note_wa=wa-reauth")274 XCTAssertEqual(requests[4].header("Cookie"), "__Host-note_session=tok_fresh; __Host-note_wa=wa-register")275 XCTAssertEqual(requests[4].body, try PasskeyCeremony.registrationVerifyBody(FakeAuthorizer.registration, label: "iPhone"))276 let registrations = await authorizer.registrationRequests277 XCTAssertEqual(registrations.first?.user.name, "simon")278 XCTAssertEqual(registrations.first?.rp.id, "localhost")279280 // Without the automatic step-up the typed error comes back.281 let again = EndlessCounter()282 StubServer.shared.reset { _ in again.next() > 0 ? .json(#"{"error":"Verify","code":"reauth_required"}"#, status: 403) : .json("{}") }283 let error = await captureAPIError { try await auth.addPasskey(stepUpIfNeeded: false) }284 XCTAssertEqual(error?.needsReauth, true)285 }286287 func testWithFreshSessionRetriesOnceAfterStepUp() async throws {288 let counter = EndlessCounter()289 StubServer.shared.reset { request in290 switch request.path {291 case "/api/pages/p1":292 return counter.next() == 1 ? .json(#"{"error":"Verify","code":"reauth_required"}"#, status: 403) : .json(#"{"ok":true}"#)293 case "/api/auth/reauth/options": return .json(Self.requestOptionsJSON)294 case "/api/auth/reauth/verify": return .json(#"{"ok":true,"freshForMs":300000}"#)295 default: return .json("{}", status: 404)296 }297 }298 let (auth, _, _, _) = await service(token: TestEnv.token)299 let api = auth.api300 let result = try await auth.withFreshSession { try await api.purgePage(id: "p1") }301 XCTAssertTrue(result.ok)302 XCTAssertEqual(StubServer.shared.requests.map(\.path), ["/api/pages/p1", "/api/auth/reauth/options", "/api/auth/reauth/verify", "/api/pages/p1"])303 XCTAssertEqual(StubServer.shared.last?.query, "purge=1")304 }305306 func testSignOutCallsTheServerAndAlwaysForgetsTheToken() async {307 StubServer.shared.reset { _ in .json(#"{"ok":true}"#, headers: ["Set-Cookie": "__Host-note_session=; Path=/; Max-Age=0"]) }308 var (auth, client, store, _) = await service(token: TestEnv.token)309 var events = await client.sessionEvents().makeAsyncIterator()310 await auth.signOut()311 XCTAssertNil(store.load())312 XCTAssertEqual(StubServer.shared.requests.map(\.path), ["/api/auth/logout"])313 XCTAssertEqual(StubServer.shared.last?.method, "POST")314 XCTAssertEqual(StubServer.shared.last?.header("Cookie"), "__Host-note_session=\(TestEnv.token)")315 await client.setSessionToken("marker")316 let first = await events.next()317 let second = await events.next()318 XCTAssertEqual(first, .signedOut(.cookieCleared))319 XCTAssertEqual(second, .signedIn, "one sign-out event only")320321 // Offline: the token is forgotten all the same.322 StubServer.shared.reset { _ in .failure(.notConnectedToInternet) }323 (auth, client, store, _) = await service(token: TestEnv.token)324 events = await client.sessionEvents().makeAsyncIterator()325 await auth.signOut()326 XCTAssertNil(store.load())327 let offline = await events.next()328 XCTAssertEqual(offline, .signedOut(.local))329330 // Already signed out: no request at all.331 StubServer.shared.reset { _ in .json("{}") }332 (auth, _, _, _) = await service(token: nil)333 await auth.signOut()334 XCTAssertTrue(StubServer.shared.requests.isEmpty)335 }336}337338/// A thread-safe call counter for scripted answers.339final class EndlessCounter: @unchecked Sendable {340 private let lock = NSLock()341 private var value = 0342 func next() -> Int { lock.withLock { value += 1; return value } }343}344