2019-05-28 13:03:08 +00:00
|
|
|
/*
|
|
|
|
* 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 "FIRInstanceIDTokenInfo.h"
|
|
|
|
|
2020-02-19 19:43:47 +00:00
|
|
|
#import "FIRInstanceIDConstants.h"
|
2019-05-28 13:03:08 +00:00
|
|
|
#import "FIRInstanceIDLogger.h"
|
|
|
|
#import "FIRInstanceIDUtilities.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @enum Token Info Dictionary Key Constants
|
|
|
|
* @discussion The keys that are checked when a token info is
|
|
|
|
* created from a dictionary. The same keys are used
|
|
|
|
* when decoding/encoding an archive.
|
|
|
|
*/
|
|
|
|
/// Specifies a dictonary key whose value represents the authorized entity, or
|
|
|
|
/// Sender ID for the token.
|
|
|
|
static NSString *const kFIRInstanceIDAuthorizedEntityKey = @"authorized_entity";
|
|
|
|
/// Specifies a dictionary key whose value represents the scope of the token,
|
|
|
|
/// typically "*".
|
|
|
|
static NSString *const kFIRInstanceIDScopeKey = @"scope";
|
|
|
|
/// Specifies a dictionary key which represents the token value itself.
|
|
|
|
static NSString *const kFIRInstanceIDTokenKey = @"token";
|
|
|
|
/// Specifies a dictionary key which represents the app version associated
|
|
|
|
/// with the token.
|
|
|
|
static NSString *const kFIRInstanceIDAppVersionKey = @"app_version";
|
|
|
|
/// Specifies a dictionary key which represents the GMP App ID associated with
|
|
|
|
/// the token.
|
|
|
|
static NSString *const kFIRInstanceIDFirebaseAppIDKey = @"firebase_app_id";
|
|
|
|
/// Specifies a dictionary key representing an archive for a
|
|
|
|
/// `FIRInstanceIDAPNSInfo` object.
|
|
|
|
static NSString *const kFIRInstanceIDAPNSInfoKey = @"apns_info";
|
|
|
|
/// Specifies a dictionary key representing the "last cached" time for the token.
|
|
|
|
static NSString *const kFIRInstanceIDCacheTimeKey = @"cache_time";
|
|
|
|
/// Default interval that token stays fresh.
|
|
|
|
const NSTimeInterval kDefaultFetchTokenInterval = 7 * 24 * 60 * 60; // 7 days.
|
|
|
|
|
|
|
|
@implementation FIRInstanceIDTokenInfo
|
|
|
|
|
|
|
|
- (instancetype)initWithAuthorizedEntity:(NSString *)authorizedEntity
|
|
|
|
scope:(NSString *)scope
|
|
|
|
token:(NSString *)token
|
|
|
|
appVersion:(NSString *)appVersion
|
|
|
|
firebaseAppID:(NSString *)firebaseAppID {
|
|
|
|
self = [super init];
|
|
|
|
if (self) {
|
|
|
|
_authorizedEntity = [authorizedEntity copy];
|
|
|
|
_scope = [scope copy];
|
|
|
|
_token = [token copy];
|
|
|
|
_appVersion = [appVersion copy];
|
|
|
|
_firebaseAppID = [firebaseAppID copy];
|
|
|
|
}
|
|
|
|
return self;
|
|
|
|
}
|
|
|
|
|
2020-02-19 19:43:47 +00:00
|
|
|
- (BOOL)isFreshWithIID:(NSString *)IID {
|
2019-05-28 13:03:08 +00:00
|
|
|
// Last fetch token cache time could be null if token is from legacy storage format. Then token is
|
|
|
|
// considered not fresh and should be refreshed and overwrite with the latest storage format.
|
2020-02-19 19:43:47 +00:00
|
|
|
if (!IID) {
|
|
|
|
return NO;
|
|
|
|
}
|
2019-05-28 13:03:08 +00:00
|
|
|
if (!_cacheTime) {
|
|
|
|
return NO;
|
|
|
|
}
|
|
|
|
|
2020-02-19 19:43:47 +00:00
|
|
|
// Check if it's consistent with IID
|
|
|
|
if (![self.token hasPrefix:IID]) {
|
|
|
|
return NO;
|
|
|
|
}
|
|
|
|
|
2019-05-28 13:03:08 +00:00
|
|
|
// Check if app has just been updated to a new version.
|
|
|
|
NSString *currentAppVersion = FIRInstanceIDCurrentAppVersion();
|
|
|
|
if (!_appVersion || ![_appVersion isEqualToString:currentAppVersion]) {
|
|
|
|
FIRInstanceIDLoggerDebug(kFIRInstanceIDMessageCodeTokenManager004,
|
|
|
|
@"Invalidating cached token for %@ (%@) due to app version change.",
|
|
|
|
_authorizedEntity, _scope);
|
|
|
|
return NO;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check if GMP App ID has changed
|
|
|
|
NSString *currentFirebaseAppID = FIRInstanceIDFirebaseAppID();
|
|
|
|
if (!_firebaseAppID || ![_firebaseAppID isEqualToString:currentFirebaseAppID]) {
|
|
|
|
FIRInstanceIDLoggerDebug(
|
|
|
|
kFIRInstanceIDMessageCodeTokenInfoFirebaseAppIDChanged,
|
|
|
|
@"Invalidating cached token due to Firebase App IID change from %@ to %@", _firebaseAppID,
|
|
|
|
currentFirebaseAppID);
|
|
|
|
return NO;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check whether locale has changed, if yes, token needs to be updated with server for locale
|
|
|
|
// information.
|
|
|
|
if (FIRInstanceIDHasLocaleChanged()) {
|
|
|
|
FIRInstanceIDLoggerDebug(kFIRInstanceIDMessageCodeTokenInfoLocaleChanged,
|
|
|
|
@"Invalidating cached token due to locale change");
|
|
|
|
return NO;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Locale is not changed, check whether token has been fetched within 7 days.
|
|
|
|
NSTimeInterval lastFetchTokenTimestamp = [_cacheTime timeIntervalSince1970];
|
|
|
|
NSTimeInterval currentTimestamp = FIRInstanceIDCurrentTimestampInSeconds();
|
|
|
|
NSTimeInterval timeSinceLastFetchToken = currentTimestamp - lastFetchTokenTimestamp;
|
|
|
|
return (timeSinceLastFetchToken < kDefaultFetchTokenInterval);
|
|
|
|
}
|
2020-02-19 19:43:47 +00:00
|
|
|
|
|
|
|
- (BOOL)isDefaultToken {
|
|
|
|
return [self.scope isEqualToString:kFIRInstanceIDDefaultTokenScope];
|
|
|
|
}
|
|
|
|
|
2019-05-28 13:03:08 +00:00
|
|
|
#pragma mark - NSCoding
|
|
|
|
|
|
|
|
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder {
|
|
|
|
// These value cannot be nil
|
|
|
|
|
|
|
|
id authorizedEntity = [aDecoder decodeObjectForKey:kFIRInstanceIDAuthorizedEntityKey];
|
|
|
|
if (![authorizedEntity isKindOfClass:[NSString class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
id scope = [aDecoder decodeObjectForKey:kFIRInstanceIDScopeKey];
|
|
|
|
if (![scope isKindOfClass:[NSString class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
id token = [aDecoder decodeObjectForKey:kFIRInstanceIDTokenKey];
|
|
|
|
if (![token isKindOfClass:[NSString class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
// These values are nullable, so only fail the decode if the type does not match
|
|
|
|
|
|
|
|
id appVersion = [aDecoder decodeObjectForKey:kFIRInstanceIDAppVersionKey];
|
|
|
|
if (appVersion && ![appVersion isKindOfClass:[NSString class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
id firebaseAppID = [aDecoder decodeObjectForKey:kFIRInstanceIDFirebaseAppIDKey];
|
|
|
|
if (firebaseAppID && ![firebaseAppID isKindOfClass:[NSString class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
id rawAPNSInfo = [aDecoder decodeObjectForKey:kFIRInstanceIDAPNSInfoKey];
|
|
|
|
if (rawAPNSInfo && ![rawAPNSInfo isKindOfClass:[NSData class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
FIRInstanceIDAPNSInfo *APNSInfo = nil;
|
|
|
|
if (rawAPNSInfo) {
|
2019-08-20 19:24:22 +00:00
|
|
|
// TODO(chliangGoogle: Use the new API and secureCoding protocol.
|
2019-05-28 13:03:08 +00:00
|
|
|
@try {
|
2019-08-20 19:24:22 +00:00
|
|
|
#pragma clang diagnostic push
|
|
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
2019-05-28 13:03:08 +00:00
|
|
|
APNSInfo = [NSKeyedUnarchiver unarchiveObjectWithData:rawAPNSInfo];
|
2019-08-20 19:24:22 +00:00
|
|
|
#pragma clang diagnostic pop
|
2019-05-28 13:03:08 +00:00
|
|
|
} @catch (NSException *exception) {
|
|
|
|
FIRInstanceIDLoggerInfo(kFIRInstanceIDMessageCodeTokenInfoBadAPNSInfo,
|
|
|
|
@"Could not parse raw APNS Info while parsing archived token info.");
|
|
|
|
APNSInfo = nil;
|
|
|
|
} @finally {
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
id cacheTime = [aDecoder decodeObjectForKey:kFIRInstanceIDCacheTimeKey];
|
|
|
|
if (cacheTime && ![cacheTime isKindOfClass:[NSDate class]]) {
|
|
|
|
return nil;
|
|
|
|
}
|
|
|
|
|
|
|
|
self = [super init];
|
|
|
|
if (self) {
|
|
|
|
_authorizedEntity = authorizedEntity;
|
|
|
|
_scope = scope;
|
|
|
|
_token = token;
|
|
|
|
_appVersion = appVersion;
|
|
|
|
_firebaseAppID = firebaseAppID;
|
|
|
|
_APNSInfo = APNSInfo;
|
|
|
|
_cacheTime = cacheTime;
|
|
|
|
}
|
|
|
|
return self;
|
|
|
|
}
|
|
|
|
|
|
|
|
- (void)encodeWithCoder:(NSCoder *)aCoder {
|
|
|
|
[aCoder encodeObject:self.authorizedEntity forKey:kFIRInstanceIDAuthorizedEntityKey];
|
|
|
|
[aCoder encodeObject:self.scope forKey:kFIRInstanceIDScopeKey];
|
|
|
|
[aCoder encodeObject:self.token forKey:kFIRInstanceIDTokenKey];
|
|
|
|
[aCoder encodeObject:self.appVersion forKey:kFIRInstanceIDAppVersionKey];
|
|
|
|
[aCoder encodeObject:self.firebaseAppID forKey:kFIRInstanceIDFirebaseAppIDKey];
|
2019-08-20 19:24:22 +00:00
|
|
|
NSData *rawAPNSInfo;
|
2019-05-28 13:03:08 +00:00
|
|
|
if (self.APNSInfo) {
|
2019-08-20 19:24:22 +00:00
|
|
|
// TODO(chliangGoogle: Use the new API and secureCoding protocol.
|
|
|
|
#pragma clang diagnostic push
|
|
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
|
|
rawAPNSInfo = [NSKeyedArchiver archivedDataWithRootObject:self.APNSInfo];
|
|
|
|
#pragma clang diagnostic pop
|
|
|
|
|
2019-05-28 13:03:08 +00:00
|
|
|
[aCoder encodeObject:rawAPNSInfo forKey:kFIRInstanceIDAPNSInfoKey];
|
|
|
|
}
|
|
|
|
[aCoder encodeObject:self.cacheTime forKey:kFIRInstanceIDCacheTimeKey];
|
|
|
|
}
|
|
|
|
|
|
|
|
@end
|