FirebaseInstallation: send IID checkin data on IID migration. (#4114)

* FIRInstallationsIIDCheckinStore with tests introduced.

* FIRInstallationsIIDCheckinStore implementation and tests.

* Store IID checkin data.

* FIRInstallationsIDControllerTests: IID checkin migration tests.

* FIRInstallationsIDController: IID checkin migration logic.

* style.sh

* FIRInstallationsAPIServiceTests: IID migration header test.

* FIRInstallationsAPIService: send IID checkin data in CreateInstallation API request.

* FIRInstallationsIIDCheckinStoreTests: fix FIRInstanceIDCheckinStore subDirectoryName.

* FIRInstallationsIIDCheckinStoreTests: fix missing sub directory.

* Disable FIRInstallationsIntegrationTests for macOS.

* FIRInstallationsIntegrationTests: properly disable all tests on macOS.

* Fix.

Author: maksymmalyhin

FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.h

@@ -39,6 +39,8 @@ void FIRInstallationsItemSetErrorToPointer(NSError *error, NSError **pointer);
 
 + (NSError *)FIDRegistrationErrorWithResponseMissingField:(NSString *)missingFieldName;
 
++ (NSError *)corruptedIIDCheckingData;
+
 + (FIRInstallationsHTTPError *)APIErrorWithHTTPResponse:(NSHTTPURLResponse *)HTTPResponse
                                                    data:(nullable NSData *)data;
 + (BOOL)isAPIError:(NSError *)error withHTTPCode:(NSInteger)HTTPCode;

FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.m

@@ -59,6 +59,14 @@ + (NSError *)installationItemNotFoundForAppID:(NSString *)appID appName:(NSStrin
                           underlyingError:nil];
 }
 
++ (NSError *)corruptedIIDCheckingData {
+  NSString *failureReason =
+      @"IID checking data stored in Keychain is corrupted or in an incompatible format.";
+  return [self installationsErrorWithCode:FIRInstallationsErrorCodeUnknown
+                            failureReason:failureReason
+                          underlyingError:nil];
+}
+
 + (FIRInstallationsHTTPError *)APIErrorWithHTTPResponse:(NSHTTPURLResponse *)HTTPResponse
                                                    data:(nullable NSData *)data {
   return [[FIRInstallationsHTTPError alloc] initWithHTTPResponse:HTTPResponse data:data];

FirebaseInstallations/Source/Library/FIRInstallationsItem.h

@@ -22,6 +22,7 @@
 @class FIRInstallationsStoredAuthToken;
 @class FIRInstallationsStoredRegistrationError;
 @class FIRInstallationsStoredRegistrationParameters;
+@class FIRInstallationsStoredIIDCheckin;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -47,6 +48,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property(nonatomic, nullable) FIRInstallationsStoredRegistrationError *registrationError;
 
+/// Instance ID checkin data imported from IID checkin store as a part of IID migration.
+@property(nonatomic, nullable) FIRInstallationsStoredIIDCheckin *IIDCheckin;
+
 - (instancetype)initWithAppID:(NSString *)appID firebaseAppName:(NSString *)firebaseAppName;
 
 /**

FirebaseInstallations/Source/Library/FIRInstallationsItem.m

@@ -48,6 +48,7 @@ - (void)updateWithStoredItem:(FIRInstallationsStoredItem *)item {
   self.authToken = item.authToken;
   self.registrationStatus = item.registrationStatus;
   self.registrationError = item.registrationError;
+  self.IIDCheckin = item.IIDCheckin;
 }
 
 - (FIRInstallationsStoredItem *)storedItem {
@@ -57,6 +58,7 @@ - (FIRInstallationsStoredItem *)storedItem {
   storedItem.authToken = self.authToken;
   storedItem.registrationStatus = self.registrationStatus;
   storedItem.registrationError = self.registrationError;
+  storedItem.IIDCheckin = self.IIDCheckin;
   return storedItem;
 }
 

FirebaseInstallations/Source/Library/FIRInstallationsLogger.h

@@ -49,3 +49,7 @@ extern NSString *const kFIRInstallationsMessageCodeRegistrationErrorFailedToDeco
 
 // FIRInstallationsStoredRegistrationParameters.m
 extern NSString *const kFIRInstallationsMessageCodeRegistrationParametersCoderVersionMismatch;
+
+// FIRInstallationsStoredIIDCheckin.m
+extern NSString *const kFIRInstallationsMessageCodeIIDCheckinCoderVersionMismatch;
+extern NSString *const kFIRInstallationsMessageCodeIIDCheckinFailedToDecode;

FirebaseInstallations/Source/Library/FIRInstallationsLogger.m

@@ -48,3 +48,7 @@
 // FIRInstallationsStoredRegistrationParameters.m
 NSString *const kFIRInstallationsMessageCodeRegistrationParametersCoderVersionMismatch =
     @"I-FIS006000";
+
+// FIRInstallationsStoredIIDCheckin.m
+NSString *const kFIRInstallationsMessageCodeIIDCheckinCoderVersionMismatch = @"I-FIS007000";
+NSString *const kFIRInstallationsMessageCodeIIDCheckinFailedToDecode = @"I-FIS007001";

FirebaseInstallations/Source/Library/IIDMigration/FIRInstallationsIIDCheckinStore.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+@class FIRInstallationsStoredIIDCheckin;
+@class FBLPromise<ValueType>;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FIRInstallationsIIDCheckinStore : NSObject
+
+/*
+ * Tries to read IID checking from the Keychain (see also `FIRInstanceIDCheckinStore`).
+ * @return Returns a promise that is resolved with the checkin object when all required data found
+ * in the Keychain. The promise is rejected when the data is missing.
+ */
+- (FBLPromise<FIRInstallationsStoredIIDCheckin *> *)existingCheckin;
+
+@end
+
+NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/IIDMigration/FIRInstallationsIIDCheckinStore.m

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRInstallationsIIDCheckinStore.h"
+
+#if __has_include(<FBLPromises/FBLPromises.h>)
+#import <FBLPromises/FBLPromises.h>
+#else
+#import "FBLPromises.h"
+#endif
+
+#import "FIRInstallationsErrorUtil.h"
+#import "FIRInstallationsKeychainUtils.h"
+#import "FIRInstallationsStoredIIDCheckin.h"
+
+NSString *const kFIRInstallationsIIDCheckinKeychainGeneric = @"com.google.iid";
+NSString *const kFIRFIRInstallationsIIDCheckinKeychainService = @"com.google.iid.checkin";
+
+@implementation FIRInstallationsIIDCheckinStore
+
+- (FBLPromise<FIRInstallationsStoredIIDCheckin *> *)existingCheckin {
+  return [[FBLPromise onQueue:dispatch_get_global_queue(QOS_CLASS_UTILITY, 0)
+                           do:^id _Nullable {
+                             return [self IIDCheckinData];
+                           }] onQueue:dispatch_get_global_queue(QOS_CLASS_UTILITY, 0)
+                                 then:^id _Nullable(NSData *_Nullable keychainData) {
+                                   return [self IIDCheckinWithData:keychainData];
+                                 }];
+}
+
+- (FBLPromise<FIRInstallationsStoredIIDCheckin *> *)IIDCheckinWithData:(NSData *)data {
+  FBLPromise<FIRInstallationsStoredIIDCheckin *> *resultPromise = [FBLPromise pendingPromise];
+
+  NSString *checkinKeychainContent = [[NSString alloc] initWithData:data
+                                                           encoding:NSUTF8StringEncoding];
+  NSArray<NSString *> *checkinComponents =
+      [checkinKeychainContent componentsSeparatedByString:@"|"];
+
+  if (checkinComponents.count < 2) {
+    [resultPromise reject:[FIRInstallationsErrorUtil corruptedIIDCheckingData]];
+    return resultPromise;
+  }
+
+  NSString *deviceID = checkinComponents[0];
+  NSString *secret = checkinComponents[1];
+
+  if (deviceID.length < 1 || secret.length < 1) {
+    [resultPromise reject:[FIRInstallationsErrorUtil corruptedIIDCheckingData]];
+    return resultPromise;
+  }
+
+  __auto_type checkin = [[FIRInstallationsStoredIIDCheckin alloc] initWithDeviceID:deviceID
+                                                                       secretToken:secret];
+  [resultPromise fulfill:checkin];
+
+  return resultPromise;
+}
+
+- (FBLPromise<NSData *> *)IIDCheckinData {
+  FBLPromise<NSData *> *resultPromise = [FBLPromise pendingPromise];
+
+  NSMutableDictionary *keychainQuery = [self IIDCheckinDataKeychainQuery];
+  NSError *error;
+  NSData *data = [FIRInstallationsKeychainUtils getItemWithQuery:keychainQuery error:&error];
+
+  if (data) {
+    [resultPromise fulfill:data];
+    return resultPromise;
+  } else if (error) {
+    [resultPromise reject:error];
+    return resultPromise;
+  } else {
+    [resultPromise reject:[FIRInstallationsErrorUtil corruptedIIDCheckingData]];
+    return resultPromise;
+  }
+}
+
+- (NSMutableDictionary *)IIDCheckinDataKeychainQuery {
+  NSDictionary *query = @{(__bridge id)kSecClass : (__bridge id)kSecClassGenericPassword};
+
+  NSMutableDictionary *finalQuery = [NSMutableDictionary dictionaryWithDictionary:query];
+  finalQuery[(__bridge NSString *)kSecAttrGeneric] = kFIRInstallationsIIDCheckinKeychainGeneric;
+
+  NSString *account = [self IIDAppIdentifier];
+  if ([account length]) {
+    finalQuery[(__bridge NSString *)kSecAttrAccount] = account;
+  }
+
+  finalQuery[(__bridge NSString *)kSecAttrService] = kFIRFIRInstallationsIIDCheckinKeychainService;
+  return finalQuery;
+}
+
+- (NSString *)IIDAppIdentifier {
+  return [[NSBundle mainBundle] bundleIdentifier] ?: @"";
+}
+
+@end

FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.m

@@ -27,9 +27,11 @@
 #import "FIRInstallationsErrorUtil.h"
 #import "FIRInstallationsItem+RegisterInstallationAPI.h"
 #import "FIRInstallationsLogger.h"
+#import "FIRInstallationsStoredIIDCheckin.h"
 
 NSString *const kFIRInstallationsAPIBaseURL = @"https://firebaseinstallations.googleapis.com";
 NSString *const kFIRInstallationsAPIKey = @"X-Goog-Api-Key";
+NSString *const kFIRInstallationsIIDMigrationAuthHeader = @"x-goog-fis-ios-iid-migration-auth";
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -128,7 +130,20 @@ - (NSURLRequest *)registerRequestWithInstallation:(FIRInstallationsItem *)instal
     @"sdkVersion" : [self SDKVersion]
   };
 
-  return [self requestWithURL:URL HTTPMethod:@"POST" bodyDict:bodyDict refreshToken:nil];
+  NSDictionary *headers;
+  if (installation.IIDCheckin && installation.IIDCheckin.deviceID &&
+      installation.IIDCheckin.secretToken) {
+    NSString *IIDAuthHeaderValue =
+        [NSString stringWithFormat:@"%@:%@", installation.IIDCheckin.deviceID,
+                                   installation.IIDCheckin.secretToken];
+    headers = @{kFIRInstallationsIIDMigrationAuthHeader : IIDAuthHeaderValue};
+  }
+
+  return [self requestWithURL:URL
+                   HTTPMethod:@"POST"
+                     bodyDict:bodyDict
+                 refreshToken:nil
+            additionalHeaders:headers];
 }
 
 - (FBLPromise<FIRInstallationsItem *> *)
@@ -215,14 +230,33 @@ - (NSURLRequest *)requestWithURL:(NSURL *)requestURL
                       HTTPMethod:(NSString *)HTTPMethod
                         bodyDict:(NSDictionary *)bodyDict
                     refreshToken:(nullable NSString *)refreshToken {
-  NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:requestURL];
+  return [self requestWithURL:requestURL
+                   HTTPMethod:HTTPMethod
+                     bodyDict:bodyDict
+                 refreshToken:refreshToken
+            additionalHeaders:nil];
+}
+
+- (NSURLRequest *)requestWithURL:(NSURL *)requestURL
+                      HTTPMethod:(NSString *)HTTPMethod
+                        bodyDict:(NSDictionary *)bodyDict
+                    refreshToken:(nullable NSString *)refreshToken
+               additionalHeaders:
+                   (nullable NSDictionary<NSString *, NSString *> *)additionalHeaders {
+  __block NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:requestURL];
   request.HTTPMethod = HTTPMethod;
   [request addValue:self.APIKey forHTTPHeaderField:kFIRInstallationsAPIKey];
   [self setJSONHTTPBody:bodyDict forRequest:request];
   if (refreshToken) {
     NSString *authHeader = [NSString stringWithFormat:@"FIS_v2 %@", refreshToken];
     [request setValue:authHeader forHTTPHeaderField:@"Authorization"];
   }
+
+  [additionalHeaders enumerateKeysAndObjectsUsingBlock:^(
+                         NSString *_Nonnull key, NSString *_Nonnull obj, BOOL *_Nonnull stop) {
+    [request setValue:obj forHTTPHeaderField:key];
+  }];
+
   return [request copy];
 }