mirror of
https://github.com/google/santa.git
synced 2026-01-14 00:37:56 -05:00
70474aba3e
* WIP Clean syncs now leave non-transitive rules by default * WIP Get existing tests compiling and passing * Remove clean all sync server key. Basic tests. * Add SNTConfiguratorTest, test deprecated key migration * Revert changes to santactl status output * Add new preflight response sync type key, lots of tests * Rework configurator flow a bit so calls cannot be made out of order * Comment clean sync states. Test all permutations. * Update docs for new sync keys * Doc updates as requested in PR
84 lines
3.1 KiB
Objective-C
84 lines
3.1 KiB
Objective-C
/// Copyright 2020 Google Inc. All rights reserved.
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <MOLXPCConnection/MOLXPCConnection.h>
|
|
|
|
#import "Source/common/SNTCommonEnums.h"
|
|
|
|
@class SNTStoredEvent;
|
|
|
|
///
|
|
/// Protocol implemented by syncservice and utilized by daemon and ctl for communication with a
|
|
/// sync server.
|
|
///
|
|
@protocol SNTSyncServiceXPC
|
|
- (void)postEventsToSyncServer:(NSArray<SNTStoredEvent *> *)events fromBundle:(BOOL)fromBundle;
|
|
- (void)postBundleEventToSyncServer:(SNTStoredEvent *)event
|
|
reply:(void (^)(SNTBundleEventAction))reply;
|
|
- (void)isFCMListening:(void (^)(BOOL))reply;
|
|
|
|
// The syncservice regularly syncs with a configured sync server. Use this method to sync out of
|
|
// band. The syncservice ensures syncs do not run concurrently.
|
|
//
|
|
// Pass an NSXPCListenerEndpoint whose associated NSXPCListener exports an object that implements
|
|
// the SNTSyncServiceLogReceiverXPC protocol. The caller will receive sync logs over this listener.
|
|
// This is required.
|
|
//
|
|
// Syncs are enqueued in order and executed serially. kMaxEnqueuedSyncs limits the number of syncs
|
|
// in the queue. If the queue is full calls to this method will be dropped and
|
|
// SNTSyncStatusTypeTooManySyncsInProgress will be passed into the reply block.
|
|
//
|
|
// Pass true to isClean to perform a clean sync, defaults to false.
|
|
//
|
|
- (void)syncWithLogListener:(NSXPCListenerEndpoint *)logListener
|
|
syncType:(SNTSyncType)syncType
|
|
reply:(void (^)(SNTSyncStatusType))reply;
|
|
|
|
// Spindown the syncservice. The syncservice will not automatically start back up.
|
|
// A new connection to the syncservice will bring it back up. This allows us to avoid running
|
|
// the syncservice needlessly when there is no configured sync server.
|
|
- (void)spindown;
|
|
@end
|
|
|
|
@interface SNTXPCSyncServiceInterface : NSObject
|
|
|
|
///
|
|
/// Returns an initialized NSXPCInterface for the SNTSyncServiceXPC protocol.
|
|
/// Ensures any methods that accept custom classes as arguments are set-up before returning.
|
|
///
|
|
+ (NSXPCInterface *)syncServiceInterface;
|
|
|
|
///
|
|
/// Returns the MachService ID for this service.
|
|
///
|
|
+ (NSString *)serviceID;
|
|
|
|
///
|
|
/// Retrieve a pre-configured MOLXPCConnection for communicating with syncservice.
|
|
/// Connections just needs any handlers set and then can be resumed and used.
|
|
///
|
|
+ (MOLXPCConnection *)configuredConnection;
|
|
|
|
@end
|
|
|
|
///
|
|
/// Protocol implemented by santactl sync and used to receive log messages from
|
|
/// the syncservice during a user initiated sync.
|
|
///
|
|
@protocol SNTSyncServiceLogReceiverXPC
|
|
- (void)didReceiveLog:(NSString *)log;
|
|
@end
|