keychain/ckks/CKKSManifestLeafRecord.h

   1 /*
   2  * Copyright (c) 2016 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 #if OCTAGON
  25
  26 #import <Foundation/Foundation.h>
  27 #import "CKKSRecordHolder.h"
  28
  29 @class CKRecord;
  30 @class CKKSItem;
  31
  32 NS_ASSUME_NONNULL_BEGIN
  33
  34 @interface CKKSManifestLeafRecord : CKKSCKRecordHolder
  35
  36 + (BOOL)recordExistsForID:(NSString*)recordID;
  37 + (instancetype)leafRecordForID:(NSString*)recordID error:(NSError* __autoreleasing*)error;
  38 + (instancetype)tryLeafRecordForID:(NSString*)recordID error:(NSError* __autoreleasing*)error;
  39 + (NSString*)leafUUIDForRecordID:(NSString*)recordID;
  40
  41 @property (nonatomic, readonly) NSString* uuid;
  42 @property (nonatomic, readonly) NSData* digestValue;
  43 @property (nonatomic, readonly) NSDictionary<NSString*, NSData*>* recordDigestDict;  // keyed by record UUID
  44
  45 @end
  46
  47 @interface CKKSManifestPendingLeafRecord : CKKSManifestLeafRecord
  48
  49 - (nullable CKKSManifestLeafRecord*)commitToDatabaseWithError:(NSError**)error;
  50
  51 @end
  52
  53 @interface CKKSEgoManifestLeafRecord : CKKSManifestLeafRecord
  54
  55 + (instancetype)newLeafRecordInZone:(NSString*)zone;
  56
  57 - (void)addOrUpdateRecordUUID:(NSString*)uuid withEncryptedItemData:(NSData*)itemData;
  58 - (void)addOrUpdateRecord:(CKRecord*)record;
  59 - (void)deleteItemWithUUID:(NSString*)uuid;
  60
  61 @end
  62
  63 NS_ASSUME_NONNULL_END
  64
  65 #endif