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