keychain/SecureObjectSync/SOSViews.h

   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 #include <xpc/xpc.h>
  35
  36 __BEGIN_DECLS
  37
  38 // Internal only views, do not export.
  39 extern const CFStringRef kSOSViewKeychainV0;
  40 extern const CFStringRef kSOSViewKeychainV0_tomb;
  41 extern const CFStringRef kSOSViewBackupBagV0_tomb;
  42 extern const CFStringRef kSOSViewWiFi_tomb;
  43 extern const CFStringRef kSOSViewAutofillPasswords_tomb;
  44 extern const CFStringRef kSOSViewSafariCreditCards_tomb;
  45 extern const CFStringRef kSOSViewiCloudIdentity_tomb;
  46 extern const CFStringRef kSOSViewOtherSyncable_tomb;
  47
  48 typedef struct __OpaqueSOSView {
  49     CFRuntimeBase _base;
  50     CFStringRef label;
  51     CFMutableDictionaryRef ringnames;
  52 } *SOSViewRef;
  53
  54
  55 typedef enum {
  56     kViewSetAll, // Note that this is not All, but is All SOS views.
  57     kViewSetDefault,
  58     kViewSetInitial,
  59     kViewSetAlwaysOn,
  60     kViewSetV0,
  61     kViewSetRequiredForBackup,
  62     kViewSetCKKS,
  63 } ViewSetKind;
  64
  65 CFMutableSetRef SOSViewCopyViewSet(ViewSetKind setKind);
  66
  67
  68
  69 CFSetRef SOSViewsGetV0ViewSet(void);
  70 CFSetRef SOSViewsGetV0SubviewSet(void);
  71 CFSetRef SOSViewsGetV0BackupViewSet(void);
  72 CFSetRef SOSViewsGetV0BackupBagViewSet(void);
  73
  74 bool SOSViewsIsV0Subview(CFStringRef viewName);
  75
  76 bool SOSViewInSOSSystem(CFStringRef view);
  77 bool SOSViewHintInSOSSystem(CFStringRef viewHint);
  78 bool SOSViewHintInCKKSSystem(CFStringRef viewHint);
  79
  80 // Basic interfaces to change and query views
  81 SOSViewResultCode SOSViewsEnable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
  82 bool SOSViewSetEnable(SOSPeerInfoRef pi, CFSetRef viewSet);
  83 SOSViewResultCode SOSViewsDisable(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
  84 bool SOSViewSetDisable(SOSPeerInfoRef pi, CFSetRef viewSet);
  85 SOSViewResultCode SOSViewsQuery(SOSPeerInfoRef pi, CFStringRef viewname, CFErrorRef *error);
  86
  87 CFSetRef SOSViewsGetAllCurrent(void);
  88 void SOSViewsForEachDefaultEnabledViewName(void (^operation)(CFStringRef viewName));
  89
  90 CFSetRef SOSViewCreateSetFromBitmask(uint64_t bitmask);
  91
  92 // Test constraints
  93 void SOSViewsSetTestViewsSet(CFSetRef testViewNames);
  94
  95
  96 static inline bool SOSPeerInfoIsViewPermitted(SOSPeerInfoRef peerInfo, CFStringRef viewName) {
  97     SOSViewResultCode viewResult = SOSViewsQuery(peerInfo, viewName, NULL);
  98
  99     return kSOSCCViewMember == viewResult || kSOSCCViewPending == viewResult || kSOSCCViewNotMember == viewResult;
 100 }
 101
 102 const char *SOSViewsXlateAction(SOSViewActionCode action);
 103 /* CFSet <-> XPC functions */
 104 xpc_object_t CreateXPCObjectWithCFSetRef(CFSetRef setref, CFErrorRef *error);
 105
 106 __END_DECLS
 107
 108 #endif /* defined(_sec_SOSViews_) */