]>
Commit | Line | Data |
---|---|---|
5c19dc3a A |
1 | /* |
2 | * Copyright (c) 2015 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 | /*! | |
25 | @header SOSViews.h - views | |
26 | */ | |
27 | ||
28 | #ifndef _sec_SOSViews_ | |
29 | #define _sec_SOSViews_ | |
30 | ||
31 | #include <CoreFoundation/CFRuntime.h> | |
32 | #include <CoreFoundation/CoreFoundation.h> | |
33 | #include <Security/SecureObjectSync/SOSPeerInfo.h> | |
34 | ||
35 | __BEGIN_DECLS | |
36 | ||
37 | // Internal only views, do not export. | |
fa7225c8 | 38 | extern const CFStringRef kSOSViewKeychainV0; |
5c19dc3a A |
39 | extern const CFStringRef kSOSViewKeychainV0_tomb; |
40 | extern const CFStringRef kSOSViewBackupBagV0_tomb; | |
41 | extern const CFStringRef kSOSViewWiFi_tomb; | |
42 | extern const CFStringRef kSOSViewAutofillPasswords_tomb; | |
43 | extern const CFStringRef kSOSViewSafariCreditCards_tomb; | |
44 | extern const CFStringRef kSOSViewiCloudIdentity_tomb; | |
45 | extern const CFStringRef kSOSViewOtherSyncable_tomb; | |
46 | ||
47 | typedef struct __OpaqueSOSView { | |
48 | CFRuntimeBase _base; | |
49 | CFStringRef label; | |
50 | CFMutableDictionaryRef ringnames; | |
51 | } *SOSViewRef; | |
52 | ||
53 | ||
fa7225c8 A |
54 | typedef enum { |
55 | kViewSetAll, | |
56 | kViewSetDefault, | |
57 | kViewSetInitial, | |
58 | kViewSetAlwaysOn, | |
59 | kViewSetV0, | |
60 | kViewSetRequiredForBackup | |
61 | } ViewSetKind; | |
62 | ||
63 | CFMutableSetRef SOSViewCopyViewSet(ViewSetKind setKind); | |
64 | ||
65 | ||
66 | ||
5c19dc3a A |
67 | CFSetRef SOSViewsGetV0ViewSet(void); |
68 | CFSetRef SOSViewsGetV0SubviewSet(void); | |
69 | CFSetRef SOSViewsGetV0BackupViewSet(void); | |
70 | CFSetRef SOSViewsGetV0BackupBagViewSet(void); | |
71 | ||
72 | bool SOSViewsIsV0Subview(CFStringRef viewName); | |
73 | ||
5c19dc3a A |
74 | // Basic interfaces to change and query views |
75 | SOSViewResultCode SOSViewsEnable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error); | |
76 | bool SOSViewSetEnable(SOSPeerInfoRef pi, CFSetRef viewSet); | |
77 | SOSViewResultCode SOSViewsDisable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error); | |
78 | bool SOSViewSetDisable(SOSPeerInfoRef pi, CFSetRef viewSet); | |
79 | SOSViewResultCode SOSViewsQuery(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error); | |
80 | ||
81 | CFSetRef SOSViewsGetAllCurrent(void); | |
82 | void SOSViewsForEachDefaultEnabledViewName(void (^operation)(CFStringRef viewName)); | |
83 | ||
84 | // Test constraints | |
85 | void SOSViewsSetTestViewsSet(CFSetRef testViewNames); | |
86 | ||
87 | ||
88 | static inline bool SOSPeerInfoIsViewPermitted(SOSPeerInfoRef peerInfo, CFStringRef viewName) { | |
89 | SOSViewResultCode viewResult = SOSViewsQuery(peerInfo, viewName, NULL); | |
90 | ||
91 | return kSOSCCViewMember == viewResult || kSOSCCViewPending == viewResult || kSOSCCViewNotMember == viewResult; | |
92 | } | |
93 | ||
fa7225c8 | 94 | const char *SOSViewsXlateAction(SOSViewActionCode action); |
5c19dc3a A |
95 | __END_DECLS |
96 | ||
97 | #endif /* defined(_sec_SOSViews_) */ |