Rename MacKeychain to AppleKeychain

crypto/mock_apple_keychain_mac.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/logging.h"
 #include "base/time.h"
-#include "crypto/mock_keychain_mac.h"
+#include "crypto/mock_apple_keychain.h"
 
 namespace crypto {
 
 // static
-const SecKeychainSearchRef MockKeychain::kDummySearchRef =
+const SecKeychainSearchRef MockAppleKeychain::kDummySearchRef =
     reinterpret_cast<SecKeychainSearchRef>(1000);
 
-MockKeychain::MockKeychain()
+MockAppleKeychain::MockAppleKeychain()
     : next_item_key_(0),
       search_copy_count_(0),
       keychain_item_copy_count_(0),
       attribute_data_copy_count_(0),
       find_generic_result_(noErr),
       called_add_generic_(false),
       password_data_count_(0) {}
 
-void MockKeychain::InitializeKeychainData(MockKeychainItemType key) const {
+void MockAppleKeychain::InitializeKeychainData(MockKeychainItemType key) const {
   UInt32 tags[] = { kSecAccountItemAttr,
                     kSecServerItemAttr,
                     kSecPortItemAttr,
                     kSecPathItemAttr,
                     kSecProtocolItemAttr,
                     kSecAuthenticationTypeItemAttr,
                     kSecSecurityDomainItemAttr,
                     kSecCreationDateItemAttr,
                     kSecNegativeItemAttr,
                     kSecCreatorItemAttr };
@@ skipping 22 matching lines @@
         data_size = sizeof(OSType);
         break;
     }
     if (data_size > 0) {
       keychain_attr_list_[key].attr[i].length = data_size;
       keychain_attr_list_[key].attr[i].data = calloc(1, data_size);
     }
   }
 }
 
-MockKeychain::~MockKeychain() {
-  for (std::map<MockKeychainItemType, SecKeychainAttributeList>::iterator it =
-       keychain_attr_list_.begin(); it != keychain_attr_list_.end(); ++it) {
+MockAppleKeychain::~MockAppleKeychain() {
+  typedef std::map<MockKeychainItemType, SecKeychainAttributeList> mockMap;

[Ryan Sleevi, 2012/08/23 22:22:58]

style nit: typedefs follow class naming rules

MockMap

And perhaps this should be a typedef that is part of the .h file, rather than
localized to this method, so that things are kept in sync.

See all other instances in this class.

[msarda, 2012/08/27 14:24:07]

Done.

+  for (mockMap::iterator it = keychain_attr_list_.begin();
+       it != keychain_attr_list_.end();
+       ++it) {
     for (unsigned int i = 0; i < it->second.count; ++i) {
       if (it->second.attr[i].data)
         free(it->second.attr[i].data);
     }
     free(it->second.attr);
     if (keychain_data_[it->first].data)
       free(keychain_data_[it->first].data);
   }
   keychain_attr_list_.clear();
   keychain_data_.clear();
 }
 
-SecKeychainAttribute* MockKeychain::AttributeWithTag(
+SecKeychainAttribute* MockAppleKeychain::AttributeWithTag(
     const SecKeychainAttributeList& attribute_list,
     UInt32 tag) {
   int attribute_index = -1;
   for (unsigned int i = 0; i < attribute_list.count; ++i) {
     if (attribute_list.attr[i].tag == tag) {
       attribute_index = i;
       break;
     }
   }
   if (attribute_index == -1) {
     NOTREACHED() << "Unsupported attribute: " << tag;
     return NULL;
   }
   return &(attribute_list.attr[attribute_index]);
 }
 
-void MockKeychain::SetTestDataBytes(MockKeychainItemType item,
-                                    UInt32 tag,
-                                    const void* data,
-                                    size_t length) {
+void MockAppleKeychain::SetTestDataBytes(MockKeychainItemType item,
+                                         UInt32 tag,
+                                         const void* data,
+                                         size_t length) {
   SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[item],
                                                      tag);
   attribute->length = length;
   if (length > 0) {
     if (attribute->data)
       free(attribute->data);
     attribute->data = malloc(length);
     CHECK(attribute->data);
     memcpy(attribute->data, data, length);
   } else {
     attribute->data = NULL;
   }
 }
 
-void MockKeychain::SetTestDataString(
-    MockKeychainItemType item,
-    UInt32 tag,
-    const char* value) {
+void MockAppleKeychain::SetTestDataString(MockKeychainItemType item,
+                                          UInt32 tag,
+                                          const char* value) {
   SetTestDataBytes(item, tag, value, value ? strlen(value) : 0);
 }
 
-void MockKeychain::SetTestDataPort(MockKeychainItemType item, UInt32 value) {
+void MockAppleKeychain::SetTestDataPort(MockKeychainItemType item,
+                                        UInt32 value) {
   SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[item],
                                                      kSecPortItemAttr);
   UInt32* data = static_cast<UInt32*>(attribute->data);
   *data = value;
 }
 
-void MockKeychain::SetTestDataProtocol(MockKeychainItemType item,
-                                       SecProtocolType value) {
+void MockAppleKeychain::SetTestDataProtocol(MockKeychainItemType item,
+                                            SecProtocolType value) {
   SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[item],
                                                      kSecProtocolItemAttr);
   SecProtocolType* data = static_cast<SecProtocolType*>(attribute->data);
   *data = value;
 }
 
-void MockKeychain::SetTestDataAuthType(
-    MockKeychainItemType item,
-    SecAuthenticationType value) {
+void MockAppleKeychain::SetTestDataAuthType(MockKeychainItemType item,
+                                            SecAuthenticationType value) {
   SecKeychainAttribute* attribute = AttributeWithTag(
       keychain_attr_list_[item], kSecAuthenticationTypeItemAttr);
   SecAuthenticationType* data = static_cast<SecAuthenticationType*>(
       attribute->data);
   *data = value;
 }
 
-void MockKeychain::SetTestDataNegativeItem(MockKeychainItemType item,
-                                           Boolean value) {
+void MockAppleKeychain::SetTestDataNegativeItem(MockKeychainItemType item,
+                                                Boolean value) {
   SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[item],
                                                      kSecNegativeItemAttr);
   Boolean* data = static_cast<Boolean*>(attribute->data);
   *data = value;
 }
 
-void MockKeychain::SetTestDataCreator(MockKeychainItemType item, OSType value) {
+void MockAppleKeychain::SetTestDataCreator(MockKeychainItemType item,
+                                           OSType value) {
   SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[item],
                                                      kSecCreatorItemAttr);
   OSType* data = static_cast<OSType*>(attribute->data);
   *data = value;
 }
 
-void MockKeychain::SetTestDataPasswordBytes(MockKeychainItemType item,
-                                            const void* data,
-                                            size_t length) {
+void MockAppleKeychain::SetTestDataPasswordBytes(MockKeychainItemType item,
+                                                 const void* data,
+                                                 size_t length) {
   keychain_data_[item].length = length;
   if (length > 0) {
     if (keychain_data_[item].data)
       free(keychain_data_[item].data);
     keychain_data_[item].data = malloc(length);
     memcpy(keychain_data_[item].data, data, length);
   } else {
     keychain_data_[item].data = NULL;
   }
 }
 
-void MockKeychain::SetTestDataPasswordString(
-    MockKeychainItemType item,
-    const char* value) {
+void MockAppleKeychain::SetTestDataPasswordString(MockKeychainItemType item,
+                                                  const char* value) {
   SetTestDataPasswordBytes(item, value, value ? strlen(value) : 0);
 }
 
-OSStatus MockKeychain::ItemCopyAttributesAndData(
+OSStatus MockAppleKeychain::ItemCopyAttributesAndData(
     SecKeychainItemRef itemRef,
     SecKeychainAttributeInfo* info,
     SecItemClass* itemClass,
     SecKeychainAttributeList** attrList,
     UInt32* length,
     void** outData) const {
   DCHECK(itemRef);
   MockKeychainItemType key =
       reinterpret_cast<MockKeychainItemType>(itemRef) - 1;
   if (keychain_attr_list_.find(key) == keychain_attr_list_.end())
     return errSecInvalidItemRef;
 
   DCHECK(!itemClass);  // itemClass not implemented in the Mock.
   if (attrList)
     *attrList  = &(keychain_attr_list_[key]);
   if (outData) {
     *outData = keychain_data_[key].data;
     DCHECK(length);
     *length = keychain_data_[key].length;
   }
 
   ++attribute_data_copy_count_;
   return noErr;
 }
 
-OSStatus MockKeychain::ItemModifyAttributesAndData(
+OSStatus MockAppleKeychain::ItemModifyAttributesAndData(
     SecKeychainItemRef itemRef,
     const SecKeychainAttributeList* attrList,
     UInt32 length,
     const void* data) const {
   DCHECK(itemRef);
   const char* fail_trigger = "fail_me";
   if (length == strlen(fail_trigger) &&
       memcmp(data, fail_trigger, length) == 0) {
     return errSecAuthFailed;
   }
 
   MockKeychainItemType key =
       reinterpret_cast<MockKeychainItemType>(itemRef) - 1;
   if (keychain_attr_list_.find(key) == keychain_attr_list_.end())
     return errSecInvalidItemRef;
 
-  MockKeychain* mutable_this = const_cast<MockKeychain*>(this);
+  MockAppleKeychain* mutable_this = const_cast<MockAppleKeychain*>(this);
   if (attrList) {
     for (UInt32 change_attr = 0; change_attr < attrList->count; ++change_attr) {
       if (attrList->attr[change_attr].tag == kSecCreatorItemAttr) {
         void* data = attrList->attr[change_attr].data;
         mutable_this->SetTestDataCreator(key, *(static_cast<OSType*>(data)));
       } else {
         NOTIMPLEMENTED();
       }
     }
   }
   if (data)
     mutable_this->SetTestDataPasswordBytes(key, data, length);
   return noErr;
 }
 
-OSStatus MockKeychain::ItemFreeAttributesAndData(
+OSStatus MockAppleKeychain::ItemFreeAttributesAndData(
     SecKeychainAttributeList* attrList,
     void* data) const {
   --attribute_data_copy_count_;
   return noErr;
 }
 
-OSStatus MockKeychain::ItemDelete(SecKeychainItemRef itemRef) const {
+OSStatus MockAppleKeychain::ItemDelete(SecKeychainItemRef itemRef) const {
   MockKeychainItemType key =
       reinterpret_cast<MockKeychainItemType>(itemRef) - 1;
 
   for (unsigned int i = 0; i < keychain_attr_list_[key].count; ++i) {
     if (keychain_attr_list_[key].attr[i].data)
       free(keychain_attr_list_[key].attr[i].data);
   }
   free(keychain_attr_list_[key].attr);
   if (keychain_data_[key].data)
     free(keychain_data_[key].data);
 
   keychain_attr_list_.erase(key);
   keychain_data_.erase(key);
   added_via_api_.erase(key);
   return noErr;
 }
 
-OSStatus MockKeychain::SearchCreateFromAttributes(
+OSStatus MockAppleKeychain::SearchCreateFromAttributes(
     CFTypeRef keychainOrArray,
     SecItemClass itemClass,
     const SecKeychainAttributeList* attrList,
     SecKeychainSearchRef* searchRef) const {
   // Figure out which of our mock items matches, and set up the array we'll use
   // to generate results out of SearchCopyNext.
   remaining_search_results_.clear();
-  for (std::map<MockKeychainItemType, SecKeychainAttributeList>::const_iterator
-           it = keychain_attr_list_.begin();
+  typedef std::map<MockKeychainItemType, SecKeychainAttributeList> mockMap;
+  for (mockMap::const_iterator it = keychain_attr_list_.begin();
        it != keychain_attr_list_.end();
        ++it) {
     bool mock_item_matches = true;
     for (UInt32 search_attr = 0; search_attr < attrList->count; ++search_attr) {
       SecKeychainAttribute* mock_attribute =
           AttributeWithTag(it->second, attrList->attr[search_attr].tag);
       if (mock_attribute->length != attrList->attr[search_attr].length ||
           memcmp(mock_attribute->data, attrList->attr[search_attr].data,
                  attrList->attr[search_attr].length) != 0) {
         mock_item_matches = false;
         break;
       }
     }
     if (mock_item_matches)
       remaining_search_results_.push_back(it->first);
   }
 
   DCHECK(searchRef);
   *searchRef = kDummySearchRef;
   ++search_copy_count_;
   return noErr;
 }
 
-bool MockKeychain::AlreadyContainsInternetPassword(
+bool MockAppleKeychain::AlreadyContainsInternetPassword(
     UInt32 serverNameLength,
     const char* serverName,
     UInt32 securityDomainLength,
     const char* securityDomain,
     UInt32 accountNameLength,
     const char* accountName,
     UInt32 pathLength,
     const char* path,
     UInt16 port,
     SecProtocolType protocol,
     SecAuthenticationType authenticationType) const {
-  for (std::map<MockKeychainItemType, SecKeychainAttributeList>::const_iterator
-           it = keychain_attr_list_.begin();
+  typedef std::map<MockKeychainItemType, SecKeychainAttributeList> mockMap;
+  for (mockMap::const_iterator it = keychain_attr_list_.begin();
        it != keychain_attr_list_.end();
        ++it) {
     SecKeychainAttribute* attribute;
     attribute = AttributeWithTag(it->second, kSecServerItemAttr);
     if ((attribute->length != serverNameLength) ||
         (attribute->data == NULL && *serverName != '\0') ||
         (attribute->data != NULL && *serverName == '\0') ||
         strncmp(serverName,
                 (const char*) attribute->data,
                 serverNameLength) != 0) {
@@ skipping 42 matching lines @@
             *(static_cast<SecAuthenticationType*>(attribute->data)))) {
       continue;
     }
     // The keychain already has this item, since all fields other than the
     // password match.
     return true;
   }
   return false;
 }
 
-OSStatus MockKeychain::AddInternetPassword(
+OSStatus MockAppleKeychain::AddInternetPassword(
     SecKeychainRef keychain,
     UInt32 serverNameLength,
     const char* serverName,
     UInt32 securityDomainLength,
     const char* securityDomain,
     UInt32 accountNameLength,
     const char* accountName,
     UInt32 pathLength,
     const char* path,
     UInt16 port,
@@ skipping 16 matching lines @@
                                       authenticationType)) {
     return errSecDuplicateItem;
   }
 
   // Pick the next unused slot.
   MockKeychainItemType key = next_item_key_++;
 
   // Initialize keychain data storage at the target location.
   InitializeKeychainData(key);
 
-  MockKeychain* mutable_this = const_cast<MockKeychain*>(this);
+  MockAppleKeychain* mutable_this = const_cast<MockAppleKeychain*>(this);
   mutable_this->SetTestDataBytes(key, kSecServerItemAttr, serverName,
                                  serverNameLength);
   mutable_this->SetTestDataBytes(key, kSecSecurityDomainItemAttr,
                                  securityDomain, securityDomainLength);
   mutable_this->SetTestDataBytes(key, kSecAccountItemAttr, accountName,
                                  accountNameLength);
   mutable_this->SetTestDataBytes(key, kSecPathItemAttr, path, pathLength);
   mutable_this->SetTestDataPort(key, port);
   mutable_this->SetTestDataProtocol(key, protocol);
   mutable_this->SetTestDataAuthType(key, authenticationType);
   mutable_this->SetTestDataPasswordBytes(key, passwordData,
                                          passwordLength);
   base::Time::Exploded exploded_time;
   base::Time::Now().UTCExplode(&exploded_time);
   char time_string[128];
   snprintf(time_string, sizeof(time_string), "%04d%02d%02d%02d%02d%02dZ",
            exploded_time.year, exploded_time.month, exploded_time.day_of_month,
            exploded_time.hour, exploded_time.minute, exploded_time.second);
   mutable_this->SetTestDataString(key, kSecCreationDateItemAttr, time_string);
 
   added_via_api_.insert(key);
 
   if (itemRef) {
     *itemRef = reinterpret_cast<SecKeychainItemRef>(key + 1);
     ++keychain_item_copy_count_;
   }
   return noErr;
 }
 
-OSStatus MockKeychain::SearchCopyNext(SecKeychainSearchRef searchRef,
-                                      SecKeychainItemRef* itemRef) const {
+OSStatus MockAppleKeychain::SearchCopyNext(SecKeychainSearchRef searchRef,
+                                           SecKeychainItemRef* itemRef) const {
   if (remaining_search_results_.empty())
     return errSecItemNotFound;
   MockKeychainItemType key = remaining_search_results_.front();
   remaining_search_results_.erase(remaining_search_results_.begin());
   *itemRef = reinterpret_cast<SecKeychainItemRef>(key + 1);
   ++keychain_item_copy_count_;
   return noErr;
 }
 
-OSStatus MockKeychain::FindGenericPassword(CFTypeRef keychainOrArray,
-                                           UInt32 serviceNameLength,
-                                           const char* serviceName,
-                                           UInt32 accountNameLength,
-                                           const char* accountName,
-                                           UInt32* passwordLength,
-                                           void** passwordData,
-                                           SecKeychainItemRef* itemRef) const {
-  // When simulating |noErr| we return canned |passwordData| and
-  // |passwordLenght|.  Otherwise, just return given code.
-  if (find_generic_result_ == noErr) {
-    static char password[] = "my_password";
-
-    DCHECK(passwordData);
-    *passwordData = static_cast<void*>(password);
-    DCHECK(passwordLength);
-    *passwordLength = strlen(password);
-    password_data_count_++;
-  }
-
-  return find_generic_result_;
-}
-
-OSStatus MockKeychain::ItemFreeContent(SecKeychainAttributeList* attrList,
-                                       void* data) const {
-  // No-op.
-  password_data_count_--;
-  return noErr;
-}
-
-OSStatus MockKeychain::AddGenericPassword(SecKeychainRef keychain,
-                                          UInt32 serviceNameLength,
-                                          const char* serviceName,
-                                          UInt32 accountNameLength,
-                                          const char* accountName,
-                                          UInt32 passwordLength,
-                                          const void* passwordData,
-                                          SecKeychainItemRef* itemRef) const {
-  called_add_generic_ = true;
-
-  DCHECK(passwordLength > 0);
-  DCHECK(passwordData);
-  add_generic_password_ =
-      std::string(const_cast<char*>(static_cast<const char*>(passwordData)),
-                  passwordLength);
-  return noErr;
-}
-
-void MockKeychain::Free(CFTypeRef ref) const {
+void MockAppleKeychain::Free(CFTypeRef ref) const {
   if (!ref)
     return;
 
   if (ref == kDummySearchRef) {
     --search_copy_count_;
   } else {
     --keychain_item_copy_count_;
   }
 }
 
-int MockKeychain::UnfreedSearchCount() const {
+int MockAppleKeychain::UnfreedSearchCount() const {
   return search_copy_count_;
 }
 
-int MockKeychain::UnfreedKeychainItemCount() const {
+int MockAppleKeychain::UnfreedKeychainItemCount() const {
   return keychain_item_copy_count_;
 }
 
-int MockKeychain::UnfreedAttributeDataCount() const {
+int MockAppleKeychain::UnfreedAttributeDataCount() const {
   return attribute_data_copy_count_;
 }
 
-bool MockKeychain::CreatorCodesSetForAddedItems() const {
+bool MockAppleKeychain::CreatorCodesSetForAddedItems() const {
   for (std::set<MockKeychainItemType>::const_iterator
            i = added_via_api_.begin();
        i != added_via_api_.end();
        ++i) {
     SecKeychainAttribute* attribute = AttributeWithTag(keychain_attr_list_[*i],
                                                        kSecCreatorItemAttr);
     OSType* data = static_cast<OSType*>(attribute->data);
     if (*data == 0)
       return false;
   }
   return true;
 }
 
-void MockKeychain::AddTestItem(const KeychainTestData& item_data) {
+void MockAppleKeychain::AddTestItem(const KeychainTestData& item_data) {
   MockKeychainItemType key = next_item_key_++;
 
   InitializeKeychainData(key);
   SetTestDataAuthType(key, item_data.auth_type);
   SetTestDataString(key, kSecServerItemAttr, item_data.server);
   SetTestDataProtocol(key, item_data.protocol);
   SetTestDataString(key, kSecPathItemAttr, item_data.path);
   SetTestDataPort(key, item_data.port);
   SetTestDataString(key, kSecSecurityDomainItemAttr,
                     item_data.security_domain);
   SetTestDataString(key, kSecCreationDateItemAttr, item_data.creation_date);
   SetTestDataString(key, kSecAccountItemAttr, item_data.username);
   SetTestDataPasswordString(key, item_data.password);
   SetTestDataNegativeItem(key, item_data.negative_item);
 }
 
 }  // namespace crypto