/ keychain / securityd / SecDbKeychainMetadataKeyStore.h
SecDbKeychainMetadataKeyStore.h
 1  /*
 2   * Copyright (c) 2018 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 <TargetConditionals.h>
25  #import <Foundation/Foundation.h>
26  #import "SecKeybagSupport.h"
27  #import <SecurityFoundation/SFKey.h>
28  
29  NS_ASSUME_NONNULL_BEGIN
30  
31  // This class is intended for SecDbKeychainItemV7, db resets and SecDbKeychainManager _only_
32  
33  @interface SecDbKeychainMetadataKeyStore : NSObject
34  
35  + (bool)cachingEnabled;
36  
37  + (void)resetSharedStore;
38  + (instancetype)sharedStore;
39  
40  - (instancetype)init NS_UNAVAILABLE;
41  
42  - (void)dropClassAKeys;
43  
44  - (SFAESKey* _Nullable)keyForKeyclass:(keyclass_t)keyClass
45                                 keybag:(keybag_handle_t)keybag
46                           keySpecifier:(SFAESKeySpecifier*)keySpecifier
47                            allowWrites:(BOOL)allowWrites		// (re)create keys if missing, corrupt or outdated format
48                                  error:(NSError**)error;
49  
50  @end
51  
52  NS_ASSUME_NONNULL_END