keychain/securityd/SecDbKeychainItemV7.h

   1 /*
   2  * Copyright (c) 2017 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 "SecKeybagSupport.h"
  25 #import <Foundation/Foundation.h>
  26 #import <ProtocolBuffer/PBCodable.h>
  27 #import "CheckV12DevEnabled.h"
  28
  29 NS_ASSUME_NONNULL_BEGIN
  30
  31 @interface SecDbKeychainItemV7 : NSObject
  32
  33 @property (nonatomic, readonly) keyclass_t keyclass;
  34 @property (nonatomic, readonly) NSData* backupUUID;
  35
  36 - (nullable instancetype)initWithData:(NSData*)data decryptionKeybag:(keybag_handle_t)decryptionKeybag error:(NSError**)error;
  37 - (instancetype)initWithSecretAttributes:(NSDictionary*)secretAttributes metadataAttributes:(NSDictionary*)metadataAttributes tamperCheck:(NSString*)tamperCheck keyclass:(keyclass_t)keyclass;
  38
  39 - (nullable NSDictionary*)metadataAttributesWithError:(NSError**)error;
  40 - (nullable NSDictionary*)secretAttributesWithAcmContext:(NSData*)acmContext accessControl:(SecAccessControlRef)accessControl callerAccessGroups:(NSArray*)callerAccessGroups error:(NSError**)error;
  41 - (BOOL)deleteWithAcmContext:(NSData*)acmContext accessControl:(SecAccessControlRef)accessControl callerAccessGroups:(NSArray*)callerAccessGroups error:(NSError**)error;
  42
  43 - (nullable NSData*)encryptedBlobWithKeybag:(keybag_handle_t)keybag accessControl:(SecAccessControlRef)accessControl acmContext:(nullable NSData*)acmContext error:(NSError**)error;
  44
  45 @end
  46
  47 extern NSString* const SecDbKeychainErrorDomain;
  48 extern const NSInteger SecDbKeychainErrorDeserializationFailed;
  49
  50
  51 @class SecDbKeychainSerializedMetadata;
  52 @class SecDbKeychainSerializedSecretData;
  53
  54 @interface SecDbKeychainItemV7 (UnitTesting)
  55
  56 + (bool)isKeychainUnlocked;
  57
  58 @property (readonly) NSData* encryptedMetadataBlob;
  59 @property (readonly) NSData* encryptedSecretDataBlob;
  60
  61 - (BOOL)encryptMetadataWithKeybag:(keybag_handle_t)keybag error:(NSError**)error;
  62 - (BOOL)encryptSecretDataWithKeybag:(keybag_handle_t)keybag accessControl:(SecAccessControlRef)accessControl acmContext:(nullable NSData*)acmContext error:(NSError**)error;
  63
  64 @end
  65
  66 NS_ASSUME_NONNULL_END