OSX/libsecurity_keychain/lib/KCCursor.h

   1 /*
   2  * Copyright (c) 2000-2004,2011,2013-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 //
  25 // KCCursor.h
  26 //
  27 #ifndef _SECURITY_KCCURSOR_H_
  28 #define _SECURITY_KCCURSOR_H_
  29
  30 #include <security_keychain/StorageManager.h>
  31
  32 namespace Security
  33 {
  34
  35 namespace KeychainCore
  36 {
  37
  38 class KCCursorImpl : public SecCFObject, public CssmAutoQuery
  39 {
  40     NOCOPY(KCCursorImpl)
  41 public:
  42         SECCFFUNCTIONS(KCCursorImpl, SecKeychainSearchRef, errSecInvalidSearchRef, gTypes().KCCursorImpl)
  43
  44     friend class KCCursor;
  45 protected:
  46         KCCursorImpl(const StorageManager::KeychainList &searchList, SecItemClass itemClass, const SecKeychainAttributeList *attrList, CSSM_DB_CONJUNCTIVE dbConjunctive, CSSM_DB_OPERATOR dbOperator);
  47         KCCursorImpl(const StorageManager::KeychainList &searchList, const SecKeychainAttributeList *attrList);
  48
  49 public:
  50         virtual ~KCCursorImpl() throw();
  51         bool next(Item &item);
  52     bool mayDelete();
  53
  54     // Occasionally, you might end up with a keychain where finding a record
  55     // might return CSSMERR_DL_RECORD_NOT_FOUND. This is usually due to having a
  56     // existing SSGroup element whose matching SSGroup key has been deleted.
  57     //
  58     // You might also have invalid ACLs or records with bad MACs.
  59     //
  60     // If you set this to true, this KCCursor will silently suppress errors when
  61     // creating items, and try to delete these corrupt records.
  62     void setDeleteInvalidRecords(bool deleteRecord);
  63
  64 private:
  65         StorageManager::KeychainList mSearchList;
  66         StorageManager::KeychainList::iterator mCurrent;
  67         CssmClient::DbCursor mDbCursor;
  68         bool mAllFailed;
  69     bool mDeleteInvalidRecords;
  70
  71     // Remembers if we've called newKeychain() on mCurrent.
  72     bool mIsNewKeychain;
  73
  74 protected:
  75         Mutex mMutex;
  76
  77     // Call this every time we switch to a new keychain
  78     // Will:
  79     //  1. handle the read locks on the new keychain and the old one
  80     //  2. Try to upgrade the new keychain if needed and possible
  81     // Handles the end iterator.
  82     void newKeychain(StorageManager::KeychainList::iterator kcIter);
  83
  84     // Try to delete a record. Silently swallow any RECORD_NOT_FOUND exceptions,
  85     // but throw others upward.
  86     void deleteInvalidRecord(DbUniqueRecord& uniqueId);
  87 };
  88
  89
  90 class KCCursor : public SecPointer<KCCursorImpl>
  91 {
  92 public:
  93     KCCursor() {}
  94
  95     KCCursor(KCCursorImpl *impl) : SecPointer<KCCursorImpl>(impl) {}
  96
  97     KCCursor(const StorageManager::KeychainList &searchList, const SecKeychainAttributeList *attrList)
  98         : SecPointer<KCCursorImpl>(new KCCursorImpl(searchList, attrList)) {}
  99
 100     KCCursor(const StorageManager::KeychainList &searchList, SecItemClass itemClass, const SecKeychainAttributeList *attrList, CSSM_DB_CONJUNCTIVE dbConjunctive=CSSM_DB_AND, CSSM_DB_OPERATOR dbOperator=CSSM_DB_EQUAL)
 101         : SecPointer<KCCursorImpl>(new KCCursorImpl(searchList, itemClass, attrList, dbConjunctive, dbOperator)) {}
 102
 103         typedef KCCursorImpl Impl;
 104 };
 105
 106
 107 } // end namespace KeychainCore
 108
 109 } // end namespace Security
 110
 111 #endif // !_SECURITY_KCCURSOR_H_