keychain/ckks/CKKSDeviceStateEntry.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 #ifndef CKKSDeviceStateEntry_h
  25 #define CKKSDeviceStateEntry_h
  26
  27 #if OCTAGON
  28
  29 #include "keychain/securityd/SecDbItem.h"
  30 #include <utilities/SecDb.h>
  31
  32 #import <CloudKit/CloudKit.h>
  33 #import "keychain/ckks/CKKS.h"
  34 #import "keychain/ckks/CKKSRecordHolder.h"
  35 #import "keychain/ckks/CKKSAccountStateTracker.h"
  36 #import "keychain/ckks/CKKSSQLDatabaseObject.h"
  37
  38 #import "keychain/ot/OTClique.h"
  39
  40 NS_ASSUME_NONNULL_BEGIN
  41
  42 /*
  43  * This is the backing class for "device state" records: each device in an iCloud account copies
  44  * some state about itself into each keychain view it wants to participate in.
  45  *
  46  * This shares some overlap with the CKKSZoneStateEntry, but differs in that:
  47  *   - This will be uploaded to CloudKit
  48  *   - We will have receive such records from other devices
  49  */
  50
  51 @interface CKKSDeviceStateEntry : CKKSCKRecordHolder
  52 @property NSString* device;
  53
  54 @property (nullable) NSString* osVersion;
  55 @property (nullable) NSDate* lastUnlockTime;
  56
  57 @property (nullable) NSString* circlePeerID;
  58 @property (nullable) NSString* octagonPeerID;
  59
  60 @property SOSCCStatus circleStatus;
  61
  62 // Some devices don't have Octagon, and won't upload this. Therefore, it might not be present,
  63 // and I'd rather not coerce to "error" or "absent"
  64 @property (nullable) OTCliqueStatusWrapper* octagonStatus;
  65
  66 @property (nullable) CKKSZoneKeyState* keyState;
  67
  68 @property (nullable) NSString* currentTLKUUID;
  69 @property (nullable) NSString* currentClassAUUID;
  70 @property (nullable) NSString* currentClassCUUID;
  71
  72 + (instancetype)fromDatabase:(NSString*)device zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  73 + (instancetype)tryFromDatabase:(NSString*)device zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  74 + (instancetype)tryFromDatabaseFromCKRecordID:(CKRecordID*)recordID error:(NSError* __autoreleasing*)error;
  75 + (NSArray<CKKSDeviceStateEntry*>*)allInZone:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  76
  77 - (instancetype)init NS_UNAVAILABLE;
  78 - (instancetype)initForDevice:(NSString*)device
  79                     osVersion:(NSString* _Nullable)osVersion
  80                lastUnlockTime:(NSDate* _Nullable)lastUnlockTime
  81                 octagonPeerID:(NSString* _Nullable)octagonPeerID
  82                 octagonStatus:(OTCliqueStatusWrapper* _Nullable)octagonStatus
  83                  circlePeerID:(NSString* _Nullable)circlePeerID
  84                  circleStatus:(SOSCCStatus)circleStatus
  85                      keyState:(CKKSZoneKeyState* _Nullable)keyState
  86                currentTLKUUID:(NSString* _Nullable)currentTLKUUID
  87             currentClassAUUID:(NSString* _Nullable)currentClassAUUID
  88             currentClassCUUID:(NSString* _Nullable)currentClassCUUID
  89                        zoneID:(CKRecordZoneID*)zoneID
  90               encodedCKRecord:(NSData* _Nullable)encodedrecord;
  91 @end
  92
  93 NS_ASSUME_NONNULL_END
  94
  95 #endif  // OCTAGON
  96 #endif  /* CKKSDeviceStateEntry_h */