Security-59306.61.1.tar.gz

[apple/security.git] / OSX / libsecurity_keychain / lib / Keychains.h

diff --git a/OSX/libsecurity_keychain/lib/Keychains.h b/OSX/libsecurity_keychain/lib/Keychains.h
index 334cd682eac606e677d84b7ad279cf9083b8cbdb..507b270ca3a4d74618562ef5c0c8103962996793 100644 (file)
--- a/OSX/libsecurity_keychain/lib/Keychains.h
+++ b/OSX/libsecurity_keychain/lib/Keychains.h
@@ -136,9 +136,8 @@ public:
     virtual ~KeychainImpl();
 
        Mutex* getKeychainMutex();
     virtual ~KeychainImpl();
 
        Mutex* getKeychainMutex();

-       Mutex* getMutexForObject();
+       Mutex* getMutexForObject() const;

 
 

-    ReadWriteLock* getKeychainReadWriteLock();

        void aboutToDestruct();
 
        bool operator ==(const KeychainImpl &) const;
        void aboutToDestruct();
 
        bool operator ==(const KeychainImpl &) const;


@@ -184,6 +183,7 @@ public:
        KCCursor createCursor(const SecKeychainAttributeList *attrList);
        KCCursor createCursor(SecItemClass itemClass, const SecKeychainAttributeList *attrList);
        CssmClient::Db database() { StLock<Mutex>_(mDbMutex); return mDb; }
        KCCursor createCursor(const SecKeychainAttributeList *attrList);
        KCCursor createCursor(SecItemClass itemClass, const SecKeychainAttributeList *attrList);
        CssmClient::Db database() { StLock<Mutex>_(mDbMutex); return mDb; }

+    void changeDatabase(CssmClient::Db db);

        DLDbIdentifier dlDbIdentifier() const { return mDb->dlDbIdentifier(); }
 
        CssmClient::CSP csp();
        DLDbIdentifier dlDbIdentifier() const { return mDb->dlDbIdentifier(); }
 
        CssmClient::CSP csp();


@@ -222,6 +222,7 @@ public:
        void inCache(bool inCache) throw() { mInCache = inCache; }
        
        void postEvent(SecKeychainEvent kcEvent, ItemImpl* item);
        void inCache(bool inCache) throw() { mInCache = inCache; }
        
        void postEvent(SecKeychainEvent kcEvent, ItemImpl* item);

+    void postEvent(SecKeychainEvent kcEvent, ItemImpl* item, PrimaryKey pk);

        
        void addItem(const PrimaryKey &primaryKey, ItemImpl *dbItemImpl);
 
        
        void addItem(const PrimaryKey &primaryKey, ItemImpl *dbItemImpl);
 


@@ -236,8 +237,27 @@ private:
     // DO NOT hold any of the keychain locks when you call this
     bool performKeychainUpgradeIfNeeded();
 
     // DO NOT hold any of the keychain locks when you call this
     bool performKeychainUpgradeIfNeeded();
 

+    // Notify the keychain that you're accessing it. Used in conjunction with
+    // the StorageManager for time-based caching.
+    void tickle();
+
+    // Used by StorageManager to remember the timer->keychain pairing
+    dispatch_source_t mCacheTimer;
+
+    // Set this to true to make tickling do nothing.
+    bool mSuppressTickle;
+
+public:
+    // Grab the locks and then call attemptKeychainMigration
+    // The access credentials are only used when downgrading version, and will be passed along with ACL edits
+    bool keychainMigration(const string oldPath, const uint32 dbBlobVersion, const string newPath, const uint32 newBlobVersion, const AccessCredentials *cred = NULL);
+
+private:

     // Attempt to upgrade this keychain's database
     // Attempt to upgrade this keychain's database

-    uint32 attemptKeychainMigration(uint32 oldBlobVersion, uint32 newBlobVersion);
+    uint32 attemptKeychainMigration(const string oldPath, const uint32 oldBlobVersion, const string newPath, const uint32 newBlobVersion, const AccessCredentials *cred);
+
+    // Attempt to rename this keychain, if someone hasn't beaten us to it
+    void attemptKeychainRename(const string oldPath, const string newPath, uint32 blobVersion);

 
     // Remember if we've attempted to upgrade this keychain's database
     bool mAttemptedUpgrade;
 
     // Remember if we've attempted to upgrade this keychain's database
     bool mAttemptedUpgrade;


@@ -250,9 +270,18 @@ private:
     // mDbDeletedItemMapMutex when you call this function.
     void forceRemoveFromCache(ItemImpl* inItemImpl);
 
     // mDbDeletedItemMapMutex when you call this function.
     void forceRemoveFromCache(ItemImpl* inItemImpl);
 

+    // Looks up an item in the item cache.
+    //
+    // To use this in a thread-safe manner, you must hold this keychain's mutex
+    // from before you begin this operation until you have safely completed a
+    // CFRetain on the resulting ItemImpl.

        ItemImpl *_lookupItem(const PrimaryKey &primaryKey);
 
     // Looks up a deleted item in the deleted item map. Does not check the normal map.
        ItemImpl *_lookupItem(const PrimaryKey &primaryKey);
 
     // Looks up a deleted item in the deleted item map. Does not check the normal map.

+    //
+    // To use this in a thread-safe manner, you must hold this keychain's mutex
+    // from before you begin this operation until you have safely completed a
+    // CFRetain on the resulting ItemImpl.

     ItemImpl *_lookupDeletedItemOnly(const PrimaryKey &primaryKey);
 
        const AccessCredentials *makeCredentials();
     ItemImpl *_lookupDeletedItemOnly(const PrimaryKey &primaryKey);
 
        const AccessCredentials *makeCredentials();


@@ -287,17 +316,12 @@ private:
        DefaultCredentials mCustomUnlockCreds;
        bool mIsInBatchMode;
        EventBuffer *mEventBuffer;
        DefaultCredentials mCustomUnlockCreds;
        bool mIsInBatchMode;
        EventBuffer *mEventBuffer;

-       Mutex mMutex;
+    mutable Mutex mMutex;

 
     // Now that we sometimes change the database object, Db object
     // creation/returning needs a mutex. You should only hold this if you're
     // copying or changing the mDb object.
     Mutex mDbMutex;
 
     // Now that we sometimes change the database object, Db object
     // creation/returning needs a mutex. You should only hold this if you're
     // copying or changing the mDb object.
     Mutex mDbMutex;

-
-    // Used to protect mDb across calls.
-    // Grab a read lock if you expect to read from this keychain in the future.
-    // The write lock is taken if we're replacing the database wholesale with something new.
-    ReadWriteLock mRWLock;

 };
 
 
 };