Sending authentication token for crashlytics and session (#12383)

Author: themiswang

Crashlytics/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Unreleased
+
+- [fixed] Force validation or rotation of FIDs for FirebaseSessions.
+
 # 10.22.0
 - [changed] Removed calls to statfs in the Crashlytics SDK to comply with Apple Privacy Manifests. This change removes support for collecting Disk Space Free in Crashlytics reports.
 - [fixed] Fixed FirebaseSessions crash on startup that occurs in release mode in Xcode 15.3 and other build configurations. (#11403)

Crashlytics/Crashlytics/Controllers/FIRCLSReportUploader.h

@@ -28,6 +28,7 @@
 @property(nonatomic, readonly) NSOperationQueue *operationQueue;
 @property(nonatomic, readonly) FIRCLSFileManager *fileManager;
 @property(nonatomic, copy) NSString *fiid;
+@property(nonatomic, copy) NSString *authToken;
 
 - (void)prepareAndSubmitReport:(FIRCLSInternalReport *)report
            dataCollectionToken:(FIRCLSDataCollectionToken *)dataCollectionToken

Crashlytics/Crashlytics/Controllers/FIRCLSReportUploader.m

@@ -95,8 +95,10 @@ - (void)prepareAndSubmitReport:(FIRCLSInternalReport *)report
         // urgent mode. Since urgent mode happens when the app is in a crash loop,
         // we can safely assume users aren't rotating their FIID, so this can be skipped.
         if (!urgent) {
-          [self.installIDModel regenerateInstallIDIfNeededWithBlock:^(NSString *_Nonnull newFIID) {
+          [self.installIDModel regenerateInstallIDIfNeededWithBlock:^(
+                                   NSString *_Nonnull newFIID, NSString *_Nonnull authToken) {
             self.fiid = [newFIID copy];
+            self.authToken = [authToken copy];
           }];
         } else {
           FIRCLSWarningLog(
@@ -186,7 +188,8 @@ - (void)uploadPackagedReportAtPath:(NSString *)path
   FIRCLSReportAdapter *adapter = [[FIRCLSReportAdapter alloc] initWithPath:path
                                                                googleAppId:self.googleAppID
                                                             installIDModel:self.installIDModel
-                                                                      fiid:self.fiid];
+                                                                      fiid:self.fiid
+                                                                 authToken:self.authToken];
 
   GDTCOREvent *event = [self.googleTransport eventForTransport];
   event.dataObject = adapter;

Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.h

@@ -44,7 +44,7 @@ NS_ASSUME_NONNULL_BEGIN
  *  - Concern 2: Whatever the FIID is, we should send it with the Crash report so we're in sync with
  * Sessions and other Firebase SDKs
  */
-- (BOOL)regenerateInstallIDIfNeededWithBlock:(void (^)(NSString *fiid))block;
+- (BOOL)regenerateInstallIDIfNeededWithBlock:(void (^)(NSString *fiid, NSString *authToken))block;
 
 @end
 

Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.m

@@ -98,33 +98,45 @@ - (NSString *)generateInstallationUUID {
 
 #pragma mark Privacy Shield
 
-- (BOOL)regenerateInstallIDIfNeededWithBlock:(void (^)(NSString *fiid))block {
+- (BOOL)regenerateInstallIDIfNeededWithBlock:(void (^)(NSString *fiid, NSString *authToken))block {
   BOOL __block didRotate = false;
+  NSString __block *authTokenComplete = @"";
+  NSString __block *currentIIDComplete = @"";
 
-  dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
+  // Installations Completions run async, so wait a reasonable amount of time for it to finish.
+  dispatch_group_t workingGroup = dispatch_group_create();
 
-  // This runs Completion async, so wait a reasonable amount of time for it to finish.
+  dispatch_group_enter(workingGroup);
   [self.installations
-      installationIDWithCompletion:^(NSString *_Nullable currentIID, NSError *_Nullable error) {
-        // Provide the IID to the callback. For this case we don't care
-        // if the FIID is null because it's the best we can do - we just want
-        // to send up the same FIID that is sent by other SDKs (eg. the Sessions SDK).
-        block(currentIID);
+      authTokenWithCompletion:^(FIRInstallationsAuthTokenResult *_Nullable tokenResult,
+                                NSError *_Nullable error) {
+        authTokenComplete = tokenResult.authToken;
+        dispatch_group_leave(workingGroup);
+      }];
 
+  dispatch_group_enter(workingGroup);
+  [self.installations
+      installationIDWithCompletion:^(NSString *_Nullable currentIID, NSError *_Nullable error) {
+        currentIIDComplete = currentIID;
         didRotate = [self rotateCrashlyticsInstallUUIDWithIID:currentIID error:error];
 
         if (didRotate) {
           FIRCLSInfoLog(@"Rotated Crashlytics Install UUID because Firebase Install ID changed");
         }
-        dispatch_semaphore_signal(semaphore);
+        dispatch_group_leave(workingGroup);
       }];
 
-  intptr_t result = dispatch_semaphore_wait(
-      semaphore, dispatch_time(DISPATCH_TIME_NOW, FIRCLSInstallationsWaitTime));
+  intptr_t result = dispatch_group_wait(
+      workingGroup, dispatch_time(DISPATCH_TIME_NOW, FIRCLSInstallationsWaitTime));
+
   if (result != 0) {
     FIRCLSErrorLog(@"Crashlytics timed out while checking for Firebase Installation ID");
   }
 
+  // Provide the IID to the callback. For this case we don't care
+  // if the FIID is null because it's the best we can do - we just want
+  // to send up the same FIID that is sent by other SDKs (eg. the Sessions SDK).
+  block(currentIIDComplete, authTokenComplete);
   return didRotate;
 }
 

Crashlytics/Crashlytics/Models/Record/FIRCLSReportAdapter.h

@@ -35,5 +35,6 @@
 - (instancetype)initWithPath:(NSString *)folderPath
                  googleAppId:(NSString *)googleAppID
               installIDModel:(FIRCLSInstallIdentifierModel *)installIDModel
-                        fiid:(NSString *)fiid;
+                        fiid:(NSString *)fiid
+                   authToken:(NSString *)authToken;
 @end

Crashlytics/Crashlytics/Models/Record/FIRCLSReportAdapter.m

@@ -30,6 +30,7 @@ @interface FIRCLSReportAdapter ()
 
 @property(nonatomic, strong) FIRCLSInstallIdentifierModel *installIDModel;
 @property(nonatomic, copy) NSString *fiid;
+@property(nonatomic, copy) NSString *authToken;
 
 @end
 
@@ -38,13 +39,15 @@ @implementation FIRCLSReportAdapter
 - (instancetype)initWithPath:(NSString *)folderPath
                  googleAppId:(NSString *)googleAppID
               installIDModel:(FIRCLSInstallIdentifierModel *)installIDModel
-                        fiid:(NSString *)fiid {
+                        fiid:(NSString *)fiid
+                   authToken:(NSString *)authToken {
   self = [super init];
   if (self) {
     _folderPath = folderPath;
     _googleAppID = googleAppID;
     _installIDModel = installIDModel;
     _fiid = [fiid copy];
+    _authToken = [authToken copy];
 
     [self loadMetaDataFile];
 
@@ -156,6 +159,7 @@ - (google_crashlytics_Report)protoReport {
   report.installation_uuid = FIRCLSEncodeString(self.installIDModel.installID);
   report.firebase_installation_id = FIRCLSEncodeString(self.fiid);
   report.app_quality_session_id = FIRCLSEncodeString(self.identity.app_quality_session_id);
+  report.firebase_authentication_token = FIRCLSEncodeString(self.authToken);
   report.build_version = FIRCLSEncodeString(self.application.build_version);
   report.display_version = FIRCLSEncodeString(self.application.display_version);
   report.apple_payload = [self protoFilesPayload];

Crashlytics/Protogen/nanopb/crashlytics.nanopb.c

@@ -26,7 +26,7 @@
 
 
 
-const pb_field_t google_crashlytics_Report_fields[10] = {
+const pb_field_t google_crashlytics_Report_fields[11] = {
     PB_FIELD(  1, BYTES   , SINGULAR, POINTER , FIRST, google_crashlytics_Report, sdk_version, sdk_version, 0),
     PB_FIELD(  3, BYTES   , SINGULAR, POINTER , OTHER, google_crashlytics_Report, gmp_app_id, sdk_version, 0),
     PB_FIELD(  4, UENUM   , SINGULAR, STATIC  , OTHER, google_crashlytics_Report, platform, gmp_app_id, 0),
@@ -36,6 +36,7 @@ const pb_field_t google_crashlytics_Report_fields[10] = {
     PB_FIELD( 10, MESSAGE , SINGULAR, STATIC  , OTHER, google_crashlytics_Report, apple_payload, display_version, &google_crashlytics_FilesPayload_fields),
     PB_FIELD( 16, BYTES   , SINGULAR, POINTER , OTHER, google_crashlytics_Report, firebase_installation_id, apple_payload, 0),
     PB_FIELD( 17, BYTES   , SINGULAR, POINTER , OTHER, google_crashlytics_Report, app_quality_session_id, firebase_installation_id, 0),
+    PB_FIELD( 19, BYTES   , SINGULAR, POINTER , OTHER, google_crashlytics_Report, firebase_authentication_token, app_quality_session_id, 0),
     PB_LAST_FIELD
 };
 

Crashlytics/Protogen/nanopb/crashlytics.nanopb.h

@@ -61,6 +61,7 @@ typedef struct _google_crashlytics_Report {
     google_crashlytics_FilesPayload apple_payload;
     pb_bytes_array_t *firebase_installation_id;
     pb_bytes_array_t *app_quality_session_id;
+    pb_bytes_array_t *firebase_authentication_token;
 /* @@protoc_insertion_point(struct:google_crashlytics_Report) */
 } google_crashlytics_Report;
 
@@ -84,12 +85,13 @@ typedef struct _google_crashlytics_Report {
 #define google_crashlytics_Report_installation_uuid_tag 5
 #define google_crashlytics_Report_firebase_installation_id_tag 16
 #define google_crashlytics_Report_app_quality_session_id_tag 17
+#define google_crashlytics_Report_firebase_authentication_token 19
 #define google_crashlytics_Report_build_version_tag 6
 #define google_crashlytics_Report_display_version_tag 7
 #define google_crashlytics_Report_apple_payload_tag 10
 
 /* Struct field encoding specification for nanopb */
-extern const pb_field_t google_crashlytics_Report_fields[10];
+extern const pb_field_t google_crashlytics_Report_fields[11];
 extern const pb_field_t google_crashlytics_FilesPayload_fields[2];
 extern const pb_field_t google_crashlytics_FilesPayload_File_fields[3];
 

Crashlytics/UnitTests/FIRCLSContextManagerTests.m

@@ -75,7 +75,8 @@ - (void)test_notSettingSessionID_protoHasNilSessionID {
   FIRCLSReportAdapter *adapter = [[FIRCLSReportAdapter alloc] initWithPath:self.report.path
                                                                googleAppId:@"TestGoogleAppID"
                                                             installIDModel:self.installIDModel
-                                                                      fiid:@"TestFIID"];
+                                                                      fiid:@"TestFIID"
+                                                                 authToken:@"TestAuthToken"];
 
   XCTAssertEqualObjects(adapter.identity.app_quality_session_id, @"");
 }
@@ -92,7 +93,8 @@ - (void)test_settingSessionIDMultipleTimes_protoHasLastSessionID {
   FIRCLSReportAdapter *adapter = [[FIRCLSReportAdapter alloc] initWithPath:self.report.path
                                                                googleAppId:@"TestGoogleAppID"
                                                             installIDModel:self.installIDModel
-                                                                      fiid:@"TestFIID"];
+                                                                      fiid:@"TestFIID"
+                                                                 authToken:@"TestAuthToken"];
   NSLog(@"reportPath: %@", self.report.path);
 
   XCTAssertEqualObjects(adapter.identity.app_quality_session_id, TestContextSessionID2);
@@ -110,7 +112,8 @@ - (void)test_settingSessionIDOutOfOrder_protoHasLastSessionID {
   FIRCLSReportAdapter *adapter = [[FIRCLSReportAdapter alloc] initWithPath:self.report.path
                                                                googleAppId:@"TestGoogleAppID"
                                                             installIDModel:self.installIDModel
-                                                                      fiid:@"TestFIID"];
+                                                                      fiid:@"TestFIID"
+                                                                 authToken:@"TestAuthToken"];
   NSLog(@"reportPath: %@", self.report.path);
 
   XCTAssertEqualObjects(adapter.identity.app_quality_session_id, TestContextSessionID2);