keychain/ckks/CKKSCurrentKeyPointer.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 <Foundation/Foundation.h>
  25
  26 #import "keychain/ckks/CKKS.h"
  27 #import "keychain/ckks/CKKSItem.h"
  28 #import "keychain/ckks/CKKSKey.h"
  29 #import "keychain/ckks/CKKSTLKShareRecord.h"
  30 #import "keychain/ckks/CKKSResultOperation.h"
  31
  32 #if OCTAGON
  33
  34 NS_ASSUME_NONNULL_BEGIN
  35
  36 @interface CKKSCurrentKeyPointer : CKKSCKRecordHolder
  37
  38 @property CKKSKeyClass* keyclass;
  39 @property NSString* currentKeyUUID;
  40
  41 - (instancetype)initForClass:(CKKSKeyClass*)keyclass
  42               currentKeyUUID:(NSString* _Nullable)currentKeyUUID
  43                       zoneID:(CKRecordZoneID*)zoneID
  44              encodedCKRecord:(NSData* _Nullable)encodedrecord;
  45
  46 + (instancetype)fromDatabase:(CKKSKeyClass*)keyclass zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  47 + (instancetype)tryFromDatabase:(CKKSKeyClass*)keyclass zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  48
  49 + (instancetype)forKeyClass:(CKKSKeyClass*)keyclass
  50                 withKeyUUID:(NSString*)keyUUID
  51                      zoneID:(CKRecordZoneID*)zoneID
  52                       error:(NSError* __autoreleasing*)error;
  53
  54 + (NSArray<CKKSCurrentKeyPointer*>*)all:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  55 + (bool)deleteAll:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  56
  57 @end
  58
  59 @interface CKKSCurrentKeySet : NSObject
  60
  61 @property NSString* viewName;
  62 @property (nullable) NSError* error;
  63 @property (nullable) CKKSKey* tlk;
  64 @property (nullable) CKKSKey* classA;
  65 @property (nullable) CKKSKey* classC;
  66 @property (nullable) CKKSCurrentKeyPointer* currentTLKPointer;
  67 @property (nullable) CKKSCurrentKeyPointer* currentClassAPointer;
  68 @property (nullable) CKKSCurrentKeyPointer* currentClassCPointer;
  69
  70 // Set to true if this is a 'proposed' key set, i.e., not yet uploaded to CloudKit
  71 @property BOOL proposed;
  72
  73 // The tlkShares property holds all existing tlkShares for this key
  74 @property NSArray<CKKSTLKShareRecord*>* tlkShares;
  75
  76 // This array (if present) holds any new TLKShares that should be uploaded
  77 @property (nullable) NSArray<CKKSTLKShareRecord*>* pendingTLKShares;
  78
  79 - (instancetype)initForZoneName:(NSString*)zoneName;
  80
  81 + (CKKSCurrentKeySet*)loadForZone:(CKRecordZoneID*)zoneID;
  82
  83 - (CKKSKeychainBackedKeySet* _Nullable)asKeychainBackedSet:(NSError**)error;
  84 @end
  85
  86 NS_ASSUME_NONNULL_END
  87
  88 #endif