keychain/ckks/CKKSRecordHolder.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 #include <utilities/SecDb.h>
  25 #include <securityd/SecDbItem.h>
  26
  27 #ifndef CKKSRecordHolder_h
  28 #define CKKSRecordHolder_h
  29
  30 #if OCTAGON
  31
  32 #import "keychain/ckks/CKKSSQLDatabaseObject.h"
  33 #import <CloudKit/CloudKit.h>
  34
  35 @class CKKSWrappedAESSIVKey;
  36
  37 // Helper class that includes a single encoded CKRecord
  38 @interface CKKSCKRecordHolder : CKKSSQLDatabaseObject {
  39 }
  40
  41 - (instancetype)initWithCKRecord: (CKRecord*) record;
  42 - (instancetype)initWithCKRecordType: (NSString*) recordType encodedCKRecord: (NSData*) encodedCKRecord zoneID:(CKRecordZoneID*)zoneID;
  43
  44 @property (copy) CKRecordZoneID* zoneID;
  45 @property (copy) NSString* ckRecordType;
  46 @property (copy) NSData* encodedCKRecord;
  47 @property (getter=storedCKRecord,setter=setStoredCKRecord:) CKRecord* storedCKRecord;
  48
  49 - (CKRecord*) CKRecordWithZoneID: (CKRecordZoneID*) zoneID;
  50
  51 // All of the following are virtual: you must override to use
  52 - (NSString*) CKRecordName;
  53 - (CKRecord*) updateCKRecord: (CKRecord*) record zoneID: (CKRecordZoneID*) zoneID;
  54 - (void) setFromCKRecord: (CKRecord*) record; // When you override this, make sure to call [setStoredCKRecord]
  55 - (bool) matchesCKRecord: (CKRecord*) record;
  56
  57 @end
  58
  59 #endif
  60 #endif /* CKKSRecordHolder_h */