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