OSX/sec/securityd/SecItemServer.h

   1 /*
   2  * Copyright (c) 2007-2009,2012-2014 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 SecItemServer
  26     The functions provided in SecItemServer.h provide an interface to
  27     the backend for SecItem APIs in the server.
  28 */
  29
  30 #ifndef _SECURITYD_SECITEMSERVER_H_
  31 #define _SECURITYD_SECITEMSERVER_H_
  32
  33 #include <CoreFoundation/CoreFoundation.h>
  34 #include <Security/SecureObjectSync/SOSCircle.h>
  35 #include <securityd/SecDbQuery.h>
  36 #include <utilities/SecDb.h>
  37
  38 __BEGIN_DECLS
  39
  40 bool _SecItemAdd(CFDictionaryRef attributes, CFArrayRef accessGroups, CFTypeRef *result, CFErrorRef *error);
  41 bool _SecItemCopyMatching(CFDictionaryRef query, CFArrayRef accessGroups, CFTypeRef *result, CFErrorRef *error);
  42 bool _SecItemUpdate(CFDictionaryRef query, CFDictionaryRef attributesToUpdate, CFArrayRef accessGroups, CFErrorRef *error);
  43 bool _SecItemDelete(CFDictionaryRef query, CFArrayRef accessGroups, CFErrorRef *error);
  44 bool _SecItemDeleteAll(CFErrorRef *error);
  45 bool _SecServerRestoreKeychain(CFErrorRef *error);
  46 bool _SecServerMigrateKeychain(int32_t handle_in, CFDataRef data_in, int32_t *handle_out, CFDataRef *data_out, CFErrorRef *error);
  47 CF_RETURNS_RETAINED CFDataRef _SecServerKeychainBackup(CFDataRef keybag, CFDataRef passcode, CFErrorRef *error);
  48 bool _SecServerKeychainRestore(CFDataRef backup, CFDataRef keybag, CFDataRef passcode, CFErrorRef *error);
  49
  50 CF_RETURNS_RETAINED CFArrayRef _SecServerKeychainSyncUpdateMessage(CFDictionaryRef updates, CFErrorRef *error);
  51 bool _SecServerKeychainSyncUpdateIDSMessage(CFDictionaryRef updates, CFErrorRef *error);
  52 CF_RETURNS_RETAINED CFDictionaryRef _SecServerBackupSyncable(CFDictionaryRef backup, CFDataRef keybag, CFDataRef password, CFErrorRef *error);
  53
  54 int SecServerKeychainTakeOverBackupFD(CFStringRef backupName, CFErrorRef *error);
  55
  56 bool _SecServerRestoreSyncable(CFDictionaryRef backup, CFDataRef keybag, CFDataRef password, CFErrorRef *error);
  57
  58 bool _SecAddSharedWebCredential(CFDictionaryRef attributes, const audit_token_t *clientAuditToken, CFStringRef appID, CFArrayRef domains, CFTypeRef *result, CFErrorRef *error);
  59 bool _SecCopySharedWebCredential(CFDictionaryRef query, const audit_token_t *clientAuditToken, CFStringRef appID, CFArrayRef domains, CFTypeRef *result, CFErrorRef *error);
  60
  61 // Hack to log objects from inside SOS code
  62 void SecItemServerAppendItemDescription(CFMutableStringRef desc, CFDictionaryRef object);
  63
  64 SecDbRef SecKeychainDbCreate(CFStringRef path);
  65
  66 SOSDataSourceFactoryRef SecItemDataSourceFactoryGetDefault(void);
  67
  68 /* FIXME: there is a specific type for keybag handle (keybag_handle_t)
  69    but it's not defined for simulator so we just use an int32_t */
  70 void SecItemServerSetKeychainKeybag(int32_t keybag);
  71 void SecItemServerResetKeychainKeybag(void);
  72
  73 void SecItemServerSetKeychainChangedNotification(const char *notification_name);
  74
  75 CFStringRef __SecKeychainCopyPath(void);
  76
  77 bool _SecServerRollKeys(bool force, CFErrorRef *error);
  78
  79 struct _SecServerKeyStats {
  80     unsigned long items;
  81     CFIndex maxDataSize;
  82     CFIndex averageSize;
  83 };
  84
  85 bool _SecServerGetKeyStats(const SecDbClass *qclass, struct _SecServerKeyStats *stats);
  86
  87
  88
  89
  90 // Should all be blocks called from SecItemDb
  91 bool match_item(SecDbConnectionRef dbt, Query *q, CFArrayRef accessGroups, CFDictionaryRef item);
  92 bool itemInAccessGroup(CFDictionaryRef item, CFArrayRef accessGroups);
  93 void SecKeychainChanged(bool syncWithPeers);
  94
  95 extern void (*SecTaskDiagnoseEntitlements)(CFArrayRef accessGroups);
  96
  97 __END_DECLS
  98
  99 #endif /* _SECURITYD_SECITEMSERVER_H_ */