1  /*
 2   * Copyright (c) 2020 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  #import <Foundation/Foundation.h>
25  
26  #import "keychain/ckks/CKKSKey.h"
27  
28  #if OCTAGON
29  
30  NS_ASSUME_NONNULL_BEGIN
31  
32  //
33  // Usage Note:
34  //
35  //  This object transparently caches CKKSKey objects, with their key material
36  //  intact. Since those keys are loaded from the database, they remain
37  //  valid while you're in the database transaction where you loaded them.
38  //  To preverve this property, this cache must be destroyed before the end
39  //  of the database transaction in which it is created.
40  //
41  
42  @interface CKKSMemoryKeyCache : NSObject
43  
44  // An instance of a CKKSItemEncrypter also contains a cache of (loaded and ready) CKKSKeys
45  // Use these to access the cache
46  - (instancetype)init;
47  - (CKKSKey* _Nullable)loadKeyForUUID:(NSString*)keyUUID
48                                zoneID:(CKRecordZoneID*)zoneID
49                                 error:(NSError**)error;
50  - (CKKSKey* _Nullable)currentKeyForClass:(CKKSKeyClass*)keyclass
51                                    zoneID:(CKRecordZoneID*)zoneID
52                                     error:(NSError *__autoreleasing*)error;
53  
54  @end
55  
56  NS_ASSUME_NONNULL_END
57  
58  #endif