Skip to content

MSUE-241: Store initial_device_ifv as device-only, non-syncing Keychain item #165

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

Open
apolwork wants to merge 1 commit into
base: master
Choose a base branch
from
Open

MSUE-241: Store initial_device_ifv as device-only, non-syncing Keychain item #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 27 additions & 5 deletions Sift/SiftKeychain.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ + (NSString *)getStoredIFVString {
(__bridge id)kSecClass: (__bridge id)kSecClassGenericPassword,
(__bridge id)kSecAttrAccount: kSiftVendorIFVKeychainKey,
(__bridge id)kSecReturnData: (__bridge id)kCFBooleanTrue,
(__bridge id)kSecReturnAttributes: (__bridge id)kCFBooleanTrue,
(__bridge id)kSecMatchLimit: (__bridge id)kSecMatchLimitOne
};

Expand All @@ -40,22 +41,43 @@ + (NSString *)getStoredIFVString {

NSString *storedIFVString = nil;
if (result) {
NSData *data = (__bridge_transfer NSData *)result;
NSDictionary *attributes = (__bridge_transfer NSDictionary *)result;
NSData *data = attributes[(__bridge id)kSecValueData];
storedIFVString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];

if (storedIFVString != nil && [self attributesNeedMigration:attributes]) {
[self storeIFVString:storedIFVString];
}
}
return storedIFVString;
}

+ (BOOL)attributesNeedMigration:(NSDictionary *)attributes {
BOOL isDeviceOnly = [attributes[(__bridge id)kSecAttrAccessible]
isEqual:(__bridge id)kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly];
BOOL isSynchronizable = [attributes[(__bridge id)kSecAttrSynchronizable] boolValue];
return !isDeviceOnly || isSynchronizable;
}

+ (void)storeIFVString:(NSString *)ifv {
NSDictionary *query = [self keychainQueryForIFV:ifv];
SecItemDelete((__bridge CFDictionaryRef)query);
SecItemAdd((__bridge CFDictionaryRef)query, NULL);
}

+ (NSDictionary *)keychainQueryForIFV:(NSString *)ifv {
NSData *data = [ifv dataUsingEncoding:NSUTF8StringEncoding];
NSDictionary *query = @{
return @{
(__bridge id)kSecClass: (__bridge id)kSecClassGenericPassword,
(__bridge id)kSecAttrAccount: kSiftVendorIFVKeychainKey,
(__bridge id)kSecValueData: data
(__bridge id)kSecValueData: data,
(__bridge id)kSecAttrAccessible: (__bridge id)kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly,
(__bridge id)kSecAttrSynchronizable: (__bridge id)kCFBooleanFalse
};
}

SecItemDelete((__bridge CFDictionaryRef)query);
SecItemAdd((__bridge CFDictionaryRef)query, NULL);
+ (NSString *)vendorIFVKeychainKey {
return kSiftVendorIFVKeychainKey;
}

@end
3 changes: 3 additions & 0 deletions SiftTests/SiftKeychain+Testing.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@
@interface SiftKeychain ()
+ (NSString *)getStoredIFVString;
+ (void)storeIFVString:(NSString *)ifv;
+ (NSString *)vendorIFVKeychainKey;
+ (NSDictionary *)keychainQueryForIFV:(NSString *)ifv;
+ (BOOL)attributesNeedMigration:(NSDictionary *)attributes;
@end
42 changes: 42 additions & 0 deletions SiftTests/SiftKeychainTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,48 @@ - (void)testProcessDeviceIFV_changedDeviceIFV {
[self swizzleMethod:mockGetStoredDeviceIFV withMethod:getStoredDeviceIFV];
}

- (void)testKeychainQueryForIFV_setsDeviceOnlyAccessibilityAndNotSynchronizable {
NSString *ifv = @"TEST-DEVICE-ONLY-IFV";
NSDictionary *query = [SiftKeychain keychainQueryForIFV:ifv];

XCTAssertEqualObjects(query[(__bridge id)kSecAttrAccount], [SiftKeychain vendorIFVKeychainKey]);
XCTAssertEqualObjects(query[(__bridge id)kSecValueData], [ifv dataUsingEncoding:NSUTF8StringEncoding]);
XCTAssertEqualObjects(query[(__bridge id)kSecAttrAccessible],
(__bridge id)kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly);
XCTAssertEqualObjects(query[(__bridge id)kSecAttrSynchronizable], @NO);
}

- (void)testAttributesNeedMigration_returnsNoWhenAlreadyDeviceOnlyAndNotSynchronizable {
NSDictionary *attributes = @{
(__bridge id)kSecAttrAccessible: (__bridge id)kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly,
(__bridge id)kSecAttrSynchronizable: @NO
};

XCTAssertFalse([SiftKeychain attributesNeedMigration:attributes]);
}

- (void)testAttributesNeedMigration_returnsYesWhenAccessibleIsMissingOrNotDeviceOnly {
NSDictionary *missingAccessible = @{
(__bridge id)kSecAttrSynchronizable: @NO
};
NSDictionary *legacyAccessible = @{
(__bridge id)kSecAttrAccessible: (__bridge id)kSecAttrAccessibleWhenUnlocked,
(__bridge id)kSecAttrSynchronizable: @NO
};

XCTAssertTrue([SiftKeychain attributesNeedMigration:missingAccessible]);
XCTAssertTrue([SiftKeychain attributesNeedMigration:legacyAccessible]);
}

- (void)testAttributesNeedMigration_returnsYesWhenSynchronizable {
NSDictionary *attributes = @{
(__bridge id)kSecAttrAccessible: (__bridge id)kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly,
(__bridge id)kSecAttrSynchronizable: @YES
};

XCTAssertTrue([SiftKeychain attributesNeedMigration:attributes]);
}

// MARK: Mocks

+ (NSString *)mockNilStoredDeviceIFV {
Expand Down