OSX/include/security_keychain/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 private:
  55         StorageManager::KeychainList mSearchList;
  56         StorageManager::KeychainList::iterator mCurrent;
  57         CssmClient::DbCursor mDbCursor;
  58         bool mAllFailed;
  59
  60 protected:
  61         Mutex mMutex;
  62 };
  63
  64
  65 class KCCursor : public SecPointer<KCCursorImpl>
  66 {
  67 public:
  68     KCCursor() {}
  69
  70     KCCursor(KCCursorImpl *impl) : SecPointer<KCCursorImpl>(impl) {}
  71
  72     KCCursor(const StorageManager::KeychainList &searchList, const SecKeychainAttributeList *attrList)
  73         : SecPointer<KCCursorImpl>(new KCCursorImpl(searchList, attrList)) {}
  74
  75     KCCursor(const StorageManager::KeychainList &searchList, SecItemClass itemClass, const SecKeychainAttributeList *attrList, CSSM_DB_CONJUNCTIVE dbConjunctive=CSSM_DB_AND, CSSM_DB_OPERATOR dbOperator=CSSM_DB_EQUAL)
  76         : SecPointer<KCCursorImpl>(new KCCursorImpl(searchList, itemClass, attrList, dbConjunctive, dbOperator)) {}
  77
  78         typedef KCCursorImpl Impl;
  79 };
  80
  81
  82 } // end namespace KeychainCore
  83
  84 } // end namespace Security
  85
  86 #endif // !_SECURITY_KCCURSOR_H_