]> git.saurik.com Git - apple/security.git/blame - OSX/sec/SOSCircle/SecureObjectSync/SOSViews.h
Security-57337.60.2.tar.gz
[apple/security.git] / OSX / sec / SOSCircle / SecureObjectSync / SOSViews.h
CommitLineData
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.
38extern const CFStringRef kSOSViewKeychainV0_tomb;
39extern const CFStringRef kSOSViewBackupBagV0_tomb;
40extern const CFStringRef kSOSViewWiFi_tomb;
41extern const CFStringRef kSOSViewAutofillPasswords_tomb;
42extern const CFStringRef kSOSViewSafariCreditCards_tomb;
43extern const CFStringRef kSOSViewiCloudIdentity_tomb;
44extern const CFStringRef kSOSViewOtherSyncable_tomb;
45
46typedef struct __OpaqueSOSView {
47 CFRuntimeBase _base;
48 CFStringRef label;
49 CFMutableDictionaryRef ringnames;
50} *SOSViewRef;
51
52
53CFSetRef SOSViewsGetV0ViewSet(void);
54CFSetRef SOSViewsGetV0SubviewSet(void);
55CFSetRef SOSViewsGetV0BackupViewSet(void);
56CFSetRef SOSViewsGetV0BackupBagViewSet(void);
57
58bool SOSViewsIsV0Subview(CFStringRef viewName);
59
60CFMutableSetRef SOSViewsCreateDefault(bool includeLegacy, CFErrorRef *error);
61
62// Basic interfaces to change and query views
63SOSViewResultCode SOSViewsEnable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
64bool SOSViewSetEnable(SOSPeerInfoRef pi, CFSetRef viewSet);
65SOSViewResultCode SOSViewsDisable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
66bool SOSViewSetDisable(SOSPeerInfoRef pi, CFSetRef viewSet);
67SOSViewResultCode SOSViewsQuery(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
68
69CFSetRef SOSViewsGetAllCurrent(void);
70void SOSViewsForEachDefaultEnabledViewName(void (^operation)(CFStringRef viewName));
71
72// Test constraints
73void SOSViewsSetTestViewsSet(CFSetRef testViewNames);
74
75
76static inline bool SOSPeerInfoIsViewPermitted(SOSPeerInfoRef peerInfo, CFStringRef viewName) {
77 SOSViewResultCode viewResult = SOSViewsQuery(peerInfo, viewName, NULL);
78
79 return kSOSCCViewMember == viewResult || kSOSCCViewPending == viewResult || kSOSCCViewNotMember == viewResult;
80}
81
82
83__END_DECLS
84
85#endif /* defined(_sec_SOSViews_) */