keychain/ckks/CKKSZoneStateEntry.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 #include "keychain/securityd/SecDbItem.h"
  25 #include <utilities/SecDb.h>
  26 #import "CKKSSQLDatabaseObject.h"
  27
  28 #ifndef CKKSZoneStateEntry_h
  29 #define CKKSZoneStateEntry_h
  30
  31 #if OCTAGON
  32
  33 #import <CloudKit/CloudKit.h>
  34 #import "keychain/ckks/CKKSFixups.h"
  35
  36 NS_ASSUME_NONNULL_BEGIN
  37
  38 /*
  39  * This class hold the state for a particular zone: has the zone been created, have we subscribed to it,
  40  * what's the current change token, etc.
  41  *
  42  * It also holds the zone's current "rate limiter" state. Currently, though, there is only a single, global
  43  * rate limiter. Therefore, each individual zone's state will have no data in the rate limiter slot, and we'll
  44  * create a global zone state entry holding the global rate limiter state. This split behavior allows us to bring
  45  * up zone-specific rate limiters under the global rate limiter later without database changes, if we decide
  46  * that's useful.
  47  */
  48
  49 @class CKKSRateLimiter;
  50
  51 @interface CKKSZoneStateEntry : CKKSSQLDatabaseObject
  52
  53 @property NSString* ckzone;
  54 @property bool ckzonecreated;
  55 @property bool ckzonesubscribed;
  56 @property (nullable, getter=getChangeToken, setter=setChangeToken:) CKServerChangeToken* changeToken;
  57 @property (nullable) NSData* encodedChangeToken;
  58 @property BOOL moreRecordsInCloudKit;
  59 @property (nullable) NSDate* lastFetchTime;
  60
  61 @property CKKSFixup lastFixup;
  62
  63 @property (nullable) CKKSRateLimiter* rateLimiter;
  64 @property (nullable) NSData* encodedRateLimiter;
  65
  66 + (instancetype)state:(NSString*)ckzone;
  67
  68 + (instancetype)fromDatabase:(NSString*)ckzone error:(NSError* __autoreleasing*)error;
  69 + (instancetype)tryFromDatabase:(NSString*)ckzone error:(NSError* __autoreleasing*)error;
  70
  71 - (instancetype)initWithCKZone:(NSString*)ckzone
  72                    zoneCreated:(bool)ckzonecreated
  73                 zoneSubscribed:(bool)ckzonesubscribed
  74                    changeToken:(NSData* _Nullable)changetoken
  75          moreRecordsInCloudKit:(BOOL)moreRecords
  76                      lastFetch:(NSDate* _Nullable)lastFetch
  77                      lastFixup:(CKKSFixup)lastFixup
  78             encodedRateLimiter:(NSData* _Nullable)encodedRateLimiter;
  79
  80 - (CKServerChangeToken*)getChangeToken;
  81 - (void)setChangeToken:(CKServerChangeToken* _Nullable)token;
  82
  83 - (BOOL)isEqual:(id)object;
  84 @end
  85
  86 NS_ASSUME_NONNULL_END
  87 #endif
  88 #endif /* CKKSZoneStateEntry_h */