Update log messages in BNCKeyChain

Author: echo-branch

Sources/BranchSDK/BNCKeyChain.m

@@ -20,11 +20,12 @@
 
 @implementation BNCKeyChain
 
+// Wraps OSStatus in an NSError
+// Security errors are defined in Security/SecBase.h
 + (NSError *) errorWithKey:(NSString *)key OSStatus:(OSStatus)status {
-    // Security errors are defined in Security/SecBase.h
     if (status == errSecSuccess) return nil;
     NSString *reason = (__bridge_transfer NSString*) SecCopyErrorMessageString(status, NULL);
-    NSString *description = [NSString stringWithFormat:@"Security error with key '%@': code %ld.", key, (long) status];
+    NSString *description = [NSString stringWithFormat:@"Branch Keychain error for key '%@': OSStatus %ld.", key, (long) status];
 
     if (!reason) {
         reason = @"Sec OSStatus error.";
@@ -37,7 +38,7 @@ + (NSError *) errorWithKey:(NSString *)key OSStatus:(OSStatus)status {
     return error;
 }
 
-+ (NSDate *) retrieveDateForService:(NSString *)service key:(NSString *)key error:(NSError **)error {
++ (NSDate *)retrieveDateForService:(NSString *)service key:(NSString *)key error:(NSError **)error {
     if (error) *error = nil;
     if (service == nil || key == nil) {
         NSError *localError = [self errorWithKey:key OSStatus:errSecParam];
@@ -57,7 +58,8 @@ + (NSDate *) retrieveDateForService:(NSString *)service key:(NSString *)key erro
     OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)dictionary, (CFTypeRef *)&valueData);
     if (status != errSecSuccess) {
         NSError *localError = [self errorWithKey:key OSStatus:status];
-        [[BranchLogger shared] logDebug:@"Can't retrieve key" error:localError];
+        [[BranchLogger shared] logVerbose:@"Key not found" error:localError];
+        
         if (error) *error = localError;
         if (valueData) CFRelease(valueData);
         return nil;
@@ -82,9 +84,10 @@ + (NSError *) storeDate:(NSDate *)date
                     key:(NSString *)key
        cloudAccessGroup:(NSString *)accessGroup {
 
-    if (date == nil || service == nil || key == nil)
+    if (date == nil || service == nil || key == nil) {
         return [self errorWithKey:key OSStatus:errSecParam];
-
+    }
+    
     NSData* valueData = nil;
     @try {
         valueData = [NSKeyedArchiver archivedDataWithRootObject:date requiringSecureCoding:YES error:NULL];
@@ -106,7 +109,7 @@ + (NSError *) storeDate:(NSDate *)date
     OSStatus status = SecItemDelete((__bridge CFDictionaryRef)dictionary);
     if (status != errSecSuccess && status != errSecItemNotFound) {
         NSError *error = [self errorWithKey:key OSStatus:status];
-        [[BranchLogger shared] logDebug:@"Can't clear to store key" error:error];
+        [[BranchLogger shared] logDebug:@"Failed to save key" error:error];
     }
 
     dictionary[(__bridge id)kSecValueData] = valueData;
@@ -122,7 +125,7 @@ + (NSError *) storeDate:(NSDate *)date
     status = SecItemAdd((__bridge CFDictionaryRef)dictionary, NULL);
     if (status) {
         NSError *error = [self errorWithKey:key OSStatus:status];
-        [[BranchLogger shared] logDebug:@"Can't store key" error:error];
+        [[BranchLogger shared] logDebug:@"Failed to save key" error:error];
         return error;
     }
     return nil;
@@ -140,24 +143,24 @@ + (NSError*) removeValuesForService:(NSString *)service key:(NSString *)key {
     if (status == errSecItemNotFound) status = errSecSuccess;
     if (status) {
         NSError *error = [self errorWithKey:key OSStatus:status];
-        [[BranchLogger shared] logDebug:@"Can't remove key" error:error];
+        [[BranchLogger shared] logDebug:@"Failed to remove key" error:[self errorWithKey:key OSStatus:status]];
         return error;
     }
     return nil;
 }
 
-+ (NSString * _Nullable) securityAccessGroup {
-    // https://stackoverflow.com/questions/11726672/access-app-identifier-prefix-programmatically
+// The security access group string is prefixed with the Apple Developer Team ID
++ (NSString * _Nullable)securityAccessGroup {
     @synchronized(self) {
-        static NSString*_securityAccessGroup = nil;
+        static NSString *_securityAccessGroup = nil;
         if (_securityAccessGroup) return _securityAccessGroup;
-
-        // First store a value:
+        
+        // The keychain cannot be empty prior to requesting the security access group string. Add a tmp variable.
         NSError *error = [self storeDate:[NSDate date] forService:@"BranchKeychainService" key:@"Temp" cloudAccessGroup:nil];
         if (error) {
-            [[BranchLogger shared] logDebug:@"Error storing temp value" error:error];
+            [[BranchLogger shared] logWarning:@"Failed to store temp value" error:error];
         }
-
+        
         NSDictionary* dictionary = @{
             (__bridge id)kSecClass:                 (__bridge id)kSecClassGenericPassword,
             (__bridge id)kSecAttrService:           @"BranchKeychainService",
@@ -169,12 +172,13 @@ + (NSString * _Nullable) securityAccessGroup {
         OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)dictionary, (CFTypeRef*)&resultDictionary);
         if (status == errSecItemNotFound) return nil;
         if (status != errSecSuccess) {
-            [[BranchLogger shared] logDebug:[NSString stringWithFormat:@"Get securityAccessGroup returned(%ld): %@.", (long) status, [self errorWithKey:nil OSStatus:status]] error:nil];
+            [[BranchLogger shared] logWarning:[NSString stringWithFormat:@"Failed to retrieve security access group"] error:[self errorWithKey:nil OSStatus:status]];
             return nil;
         }
-        NSString*group =
-            [(__bridge NSDictionary *)resultDictionary objectForKey:(__bridge NSString *)kSecAttrAccessGroup];
-        if (group.length > 0) _securityAccessGroup = [group copy];
+        NSString *group = [(__bridge NSDictionary *)resultDictionary objectForKey:(__bridge NSString *)kSecAttrAccessGroup];
+        if (group.length > 0) {
+            _securityAccessGroup = [group copy];
+        }
         CFRelease(resultDictionary);
         return _securityAccessGroup;
     }

Sources/BranchSDK/Private/BNCKeyChain.h

@@ -53,7 +53,9 @@
                               key:(NSString * _Nonnull)key
                  cloudAccessGroup:(NSString * _Nullable)accessGroup;
 
-/// The default security access group for the app.
-+ (NSString*_Nullable) securityAccessGroup;
+/**
+ The security access group string is prefixed with the Apple Developer Team ID
+ */
++ (NSString * _Nullable) securityAccessGroup;
 
 @end