Skip to content

fix passkey name caching issue #12681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 2, 2024
Merged

fix passkey name caching issue #12681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f80b1a3
fix passkey name caching issue
Xiaoshouzi-gh Apr 2, 2024
a35b791
ran check.sh
Xiaoshouzi-gh Apr 2, 2024
f4497cd
fix the unit tests
Xiaoshouzi-gh Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions FirebaseAuth/Sources/User/FIRUser.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,12 +611,19 @@ - (void)startPasskeyEnrollmentWithName:(nullable NSString *)name
callback:^(FIRStartPasskeyEnrollmentResponse *_Nullable response,
NSError *_Nullable error) {
if (error) {
// reset the passkey name cache.
self.passkeyName = nil;
completion(nil, error);
return;
} else {
// cached the passkey name. This is needed when calling
// finalizePasskeyEnrollment
self.passkeyName = name;
// If passkey name is not provided, we will provide a firebase formatted
// default name.
if (self.passkeyName == nil || [self.passkeyName isEqual:@""]) {
self.passkeyName = @"Unnamed account (Apple)";
}
NSData *challengeInData =
[[NSData alloc] initWithBase64EncodedString:response.challenge
options:0];
Expand All @@ -629,7 +636,7 @@ - (void)startPasskeyEnrollmentWithName:(nullable NSString *)name
ASAuthorizationPlatformPublicKeyCredentialRegistrationRequest *request =
[provider
createCredentialRegistrationRequestWithChallenge:challengeInData
name:name
name:self.passkeyName
userID:userIdInData];
completion(request, nil);
}
Expand All @@ -651,11 +658,7 @@ - (void)finalizePasskeyEnrollmentWithPlatformCredential:
[platformCredential.rawClientDataJSON base64EncodedStringWithOptions:0];
NSString *attestationObject =
[platformCredential.rawAttestationObject base64EncodedStringWithOptions:0];
// If passkey name is not provided, we will provide a firebase formatted default name.

if (self.passkeyName != nil || [self.passkeyName isEqual:@""]) {
self.passkeyName = @"Unnamed account (Apple)";
}
FIRFinalizePasskeyEnrollmentRequest *request =
[[FIRFinalizePasskeyEnrollmentRequest alloc] initWithIDToken:self.rawAccessToken
name:self.passkeyName
Expand Down
126 changes: 126 additions & 0 deletions FirebaseAuth/Tests/Unit/FIRUserTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,11 @@
*/
static NSString *const kPasskeyName = @"mockPasskeyName";

/** @var kDefaultPasskeyName
@brief default passkey name.
*/
static NSString *const kDefaultPasskeyName = @"Unnamed account (Apple)";

/** @var kRpId
@brief The fake passkey relying party identifier.
*/
Expand Down Expand Up @@ -988,6 +993,125 @@ - (void)testStartPasskeyEnrollmentSuccess {
}
}

/** @fn testStartPasskeyEnrollmentWithNilNameSuccess
@brief Tests the flow of a successful @c startPasskeyEnrollmentWithName:completion: call
*/
- (void)testStartPasskeyEnrollmentWithNilNameSuccess {
if (@available(iOS 15.0, tvOS 16.0, macOS 12.0, *)) {
OCMExpect([_mockBackend startPasskeyEnrollment:[OCMArg any] callback:[OCMArg any]])
.andCallBlock2(^(FIRStartPasskeyEnrollmentRequest *_Nullable request,
FIRStartPasskeyEnrollmentResponseCallback callback) {
XCTAssertEqualObjects(request.APIKey, kAPIKey);
dispatch_async(FIRAuthGlobalWorkQueue(), ^() {
id mockStartPasskeyEnrollmentResponse =
OCMClassMock([FIRStartPasskeyEnrollmentResponse class]);
OCMStub([mockStartPasskeyEnrollmentResponse rpID]).andReturn(kRpId);
OCMStub([mockStartPasskeyEnrollmentResponse challenge]).andReturn(kChallenge);
OCMStub([mockStartPasskeyEnrollmentResponse userID]).andReturn(kUserID);
callback(mockStartPasskeyEnrollmentResponse, nil);
});
});
XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
id mockGetAccountInfoResponseUser = OCMClassMock([FIRGetAccountInfoResponseUser class]);
[self
signInAnonymouslyWithMockGetAccountInfoResponse:mockGetAccountInfoResponseUser
completion:^(FIRUser *_Nonnull user) {
[user
startPasskeyEnrollmentWithName:nil
completion:^(
ASAuthorizationPlatformPublicKeyCredentialRegistrationRequest
*_Nullable request,
NSError
*_Nullable error) {
XCTAssertNil(error);
XCTAssertEqualObjects(
user.passkeyName,
kDefaultPasskeyName);
XCTAssertEqualObjects(
request.name,
kDefaultPasskeyName);
XCTAssertEqualObjects(
[[request challenge]
base64EncodedStringWithOptions:
0],
kChallenge);
XCTAssertEqualObjects(
[request
relyingPartyIdentifier],
kRpId);
XCTAssertEqualObjects(
[[request userID]
base64EncodedStringWithOptions:
0],
kUserID);
[expectation fulfill];
}];
}];
[self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
OCMVerifyAll(_mockBackend);
}
}

/** @fn testStartPasskeyEnrollmentWithEmptyNameSuccess
@brief Tests the flow of a successful @c startPasskeyEnrollmentWithName:completion: call
*/
- (void)testStartPasskeyEnrollmentWithEmptyNameSuccess {
if (@available(iOS 15.0, tvOS 16.0, macOS 12.0, *)) {
OCMExpect([_mockBackend startPasskeyEnrollment:[OCMArg any] callback:[OCMArg any]])
.andCallBlock2(^(FIRStartPasskeyEnrollmentRequest *_Nullable request,
FIRStartPasskeyEnrollmentResponseCallback callback) {
XCTAssertEqualObjects(request.APIKey, kAPIKey);
dispatch_async(FIRAuthGlobalWorkQueue(), ^() {
id mockStartPasskeyEnrollmentResponse =
OCMClassMock([FIRStartPasskeyEnrollmentResponse class]);
OCMStub([mockStartPasskeyEnrollmentResponse rpID]).andReturn(kRpId);
OCMStub([mockStartPasskeyEnrollmentResponse challenge]).andReturn(kChallenge);
OCMStub([mockStartPasskeyEnrollmentResponse userID]).andReturn(kUserID);
callback(mockStartPasskeyEnrollmentResponse, nil);
});
});
XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
id mockGetAccountInfoResponseUser = OCMClassMock([FIRGetAccountInfoResponseUser class]);
[self
signInAnonymouslyWithMockGetAccountInfoResponse:mockGetAccountInfoResponseUser
completion:^(FIRUser *_Nonnull user) {
[user
startPasskeyEnrollmentWithName:@""
completion:^(
ASAuthorizationPlatformPublicKeyCredentialRegistrationRequest
*_Nullable request,
NSError
*_Nullable error) {
XCTAssertNil(error);
XCTAssertEqualObjects(
user.passkeyName,
kDefaultPasskeyName);
XCTAssertEqualObjects(
request.name,
kDefaultPasskeyName);
XCTAssertEqualObjects(
[[request challenge]
base64EncodedStringWithOptions:
0],
kChallenge);

XCTAssertEqualObjects(
[request
relyingPartyIdentifier],
kRpId);
XCTAssertEqualObjects(
[[request userID]
base64EncodedStringWithOptions:
0],
kUserID);
[expectation fulfill];
}];
}];
[self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
OCMVerifyAll(_mockBackend);
}
}

/** @fn testStartPasskeyEnrollmentFailure
@brief Tests the flow of a failed @c startPasskeyEnrollmentWithName:completion: call
*/
Expand All @@ -1008,6 +1132,8 @@ - (void)testStartPasskeyEnrollmentFailure {
NSError
*_Nullable error) {
XCTAssertNil(request);
XCTAssertNil(
user.passkeyName);
XCTAssertEqual(
error.code,
FIRAuthErrorCodeOperationNotAllowed);
Expand Down