]> git.saurik.com Git - apple/security.git/blob - supd/supd.h
Security-58286.251.4.tar.gz
[apple/security.git] / supd / supd.h
1 /*
2 * Copyright (c) 2017 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 #import "supdProtocol.h"
26
27 @interface SFAnalyticsClient: NSObject
28 @property (nonatomic) NSString* storePath;
29 @property (nonatomic) NSString* name;
30 @property (atomic) BOOL requireDeviceAnalytics;
31 @property (atomic) BOOL requireiCloudAnalytics;
32 @end
33
34 @interface SFAnalyticsTopic : NSObject <NSURLSessionDelegate>
35 @property NSString* splunkTopicName;
36 @property NSURL* splunkBagURL;
37 @property NSString *internalTopicName;
38
39 @property NSArray<SFAnalyticsClient*>* topicClients;
40
41 // --------------------------------
42 // Things below are for unit testing
43 - (instancetype)initWithDictionary:(NSDictionary *)dictionary name:(NSString *)topicName samplingRates:(NSDictionary *)rates;
44 - (BOOL)haveEligibleClients;
45 + (NSString*)databasePathForCKKS;
46 + (NSString*)databasePathForSOS;
47 + (NSString*)databasePathForPCS;
48 + (NSString*)databasePathForLocal;
49 + (NSString*)databasePathForTrust;
50 + (NSString*)databasePathForTrustdHealth;
51 + (NSString*)databasePathForTLS;
52 @end
53
54 @interface SFAnalyticsReporter : NSObject
55 - (BOOL)saveReport:(NSData *)reportData fileName:(NSString *)fileName;
56 @end
57
58 @interface supd : NSObject <supdProtocol>
59 + (instancetype)instance;
60 + (void)removeInstance;
61 + (void)instantiate;
62 - (instancetype)initWithReporter:(SFAnalyticsReporter *)reporter;
63
64 // --------------------------------
65 // Things below are for unit testing
66 @property (readonly) dispatch_queue_t queue;
67 @property (readonly) NSArray<SFAnalyticsTopic*>* analyticsTopics;
68 @property (readonly) SFAnalyticsReporter *reporter;
69 - (void)sendNotificationForOncePerReportSamplers;
70 @end
71
72 // --------------------------------
73 // Things below are for unit testing
74 extern BOOL runningTests; // Do not use 'force' when obtaining logging json
75 extern BOOL deviceAnalyticsOverride;
76 extern BOOL deviceAnalyticsEnabled;
77 extern BOOL iCloudAnalyticsOverride;
78 extern BOOL iCloudAnalyticsEnabled;