keychain/ckks/OctagonAPSReceiver.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 #import <Foundation/Foundation.h>
  25
  26 #if OCTAGON
  27 #import <ApplePushService/ApplePushService.h>
  28 #import <CloudKit/CloudKit.h>
  29 #import "keychain/ckks/CKKSCondition.h"
  30 #import "keychain/ckks/CloudKitDependencies.h"
  31
  32
  33 NS_ASSUME_NONNULL_BEGIN
  34
  35 // APS is giving us a tracingUUID and a tracingEnabled bool, but our interfaces take a CKRecordZoneNotification. Add them to that class, then.
  36 @interface CKRecordZoneNotification (CKKSPushTracing)
  37 @property (nonatomic, assign) BOOL ckksPushTracingEnabled;
  38 @property (nonatomic, strong, nullable) NSString* ckksPushTracingUUID;
  39 @property (nonatomic, strong, nullable) NSDate* ckksPushReceivedDate;
  40 @end
  41
  42 @protocol CKKSZoneUpdateReceiverProtocol <NSObject>
  43 - (void)notifyZoneChange:(CKRecordZoneNotification* _Nullable)notification;
  44 @end
  45
  46 @protocol OctagonCuttlefishUpdateReceiver <NSObject>
  47 - (void)notifyContainerChange:(APSIncomingMessage* _Nullable)notification;
  48 @end
  49
  50 @interface OctagonAPSReceiver : NSObject <APSConnectionDelegate>
  51
  52 // class dependencies (for injection)
  53 @property (readonly) Class<OctagonAPSConnection> apsConnectionClass;
  54 @property (nullable) id<OctagonAPSConnection> apsConnection;
  55
  56 @property (readonly) BOOL haveStalePushes;
  57
  58 + (instancetype)receiverForNamedDelegatePort:(NSString*)namedDelegatePort
  59                           apsConnectionClass:(Class<OctagonAPSConnection>)apsConnectionClass;
  60 + (void)resetGlobalDelegatePortMap;
  61
  62 - (void)registerForEnvironment:(NSString*)environmentName;
  63
  64 - (CKKSCondition*)registerCKKSReceiver:(id<CKKSZoneUpdateReceiverProtocol>)receiver;
  65
  66 // APS reserves the right to coalesce pushes by topic. So, any cuttlefish container push might hide pushes for other cuttlefish containers.
  67 // This is okay for now, as we only have one active cuttlefish container per device, but if we start to have multiple accounts, this handling might need to change.
  68 - (CKKSCondition*)registerCuttlefishReceiver:(id<OctagonCuttlefishUpdateReceiver>)receiver forContainerName:(NSString*)containerName;
  69
  70 // Test support:
  71 - (instancetype)initWithNamedDelegatePort:(NSString*)namedDelegatePort
  72                      apsConnectionClass:(Class<OctagonAPSConnection>)apsConnectionClass;
  73 - (instancetype)initWithNamedDelegatePort:(NSString*)namedDelegatePort
  74                      apsConnectionClass:(Class<OctagonAPSConnection>)apsConnectionClass
  75                        stalePushTimeout:(uint64_t)stalePushTimeout;
  76
  77 // This is the queue that APNS will use send the notifications to us
  78 + (dispatch_queue_t)apsDeliveryQueue;
  79 - (NSArray<NSString *>*)registeredPushEnvironments;
  80 @end
  81
  82 @interface OctagonAPSReceiver (Testing)
  83 - (void)reportDroppedPushes:(NSSet<CKRecordZoneNotification*>*)notifications;
  84 @end
  85
  86 NS_ASSUME_NONNULL_END
  87 #endif  // OCTAGON