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/CKKSTLKShare.h"
  30
  31
  32 #if OCTAGON
  33
  34 @interface CKKSCurrentKeyPointer : CKKSCKRecordHolder
  35
  36 @property CKKSKeyClass* keyclass;
  37 @property NSString* currentKeyUUID;
  38
  39 - (instancetype)initForClass:(CKKSKeyClass*)keyclass
  40               currentKeyUUID:(NSString*)currentKeyUUID
  41                       zoneID:(CKRecordZoneID*)zoneID
  42              encodedCKRecord:(NSData*)encodedrecord;
  43
  44 + (instancetype)fromDatabase:(CKKSKeyClass*)keyclass zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  45 + (instancetype)tryFromDatabase:(CKKSKeyClass*)keyclass zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  46
  47 + (instancetype)forKeyClass:(CKKSKeyClass*)keyclass
  48                 withKeyUUID:(NSString*)keyUUID
  49                      zoneID:(CKRecordZoneID*)zoneID
  50                       error:(NSError* __autoreleasing*)error;
  51
  52 + (NSArray<CKKSCurrentKeyPointer*>*)all:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  53 + (bool)deleteAll:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  54
  55 @end
  56
  57 @interface CKKSCurrentKeySet : NSObject
  58 @property NSError* error;
  59 @property CKKSKey* tlk;
  60 @property CKKSKey* classA;
  61 @property CKKSKey* classC;
  62 @property CKKSCurrentKeyPointer* currentTLKPointer;
  63 @property CKKSCurrentKeyPointer* currentClassAPointer;
  64 @property CKKSCurrentKeyPointer* currentClassCPointer;
  65
  66 @property NSArray<CKKSTLKShare*>* tlkShares;
  67
  68 - (instancetype)init;
  69 - (instancetype)initForZone:(CKRecordZoneID*)zoneID;
  70 @end
  71
  72 #endif