OSX/sec/Security/SecItemInternal.h

   1 /*
   2  * Copyright (c) 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 SecItemInternal
  26     SecItemInternal defines SPI functions dealing with persistent refs
  27 */
  28
  29 #ifndef _SECURITY_SECITEMINTERNAL_H_
  30 #define _SECURITY_SECITEMINTERNAL_H_
  31
  32 #include <CoreFoundation/CFData.h>
  33 #include <sqlite3.h>
  34 #include <ipc/securityd_client.h>
  35 #include <ctkclient.h>
  36
  37 __BEGIN_DECLS
  38
  39 #define kSecServerKeychainChangedNotification "com.apple.security.keychainchanged"
  40
  41 CF_RETURNS_RETAINED CFDataRef _SecItemMakePersistentRef(CFTypeRef class, sqlite_int64 rowid);
  42
  43 bool _SecItemParsePersistentRef(CFDataRef persistent_ref, CFStringRef *return_class,
  44     sqlite_int64 *return_rowid);
  45
  46 OSStatus _SecRestoreKeychain(const char *path);
  47
  48 OSStatus SecOSStatusWith(bool (^perform)(CFErrorRef *error));
  49
  50 bool cftype_ag_to_bool_cftype_error_request(enum SecXPCOperation op, CFTypeRef attributes, __unused CFArrayRef accessGroups, CFTypeRef *result, CFErrorRef *error);
  51
  52 /* Structure representing copy-on-write dictionary.  Typical use is:
  53  int bar(CFDictionaryRef input);
  54  int foo(CFDictionaryRef input) {
  55      SecCFDictionaryCOW in = { input };
  56      if (condition) {
  57          CFDictionarySetValue(SecCFDictionaryCOWGetMutable(&in), key, value);
  58      }
  59      bar(in.dictionary);
  60      CFReleaseSafe(in.mutable_dictionary);
  61  }
  62  */
  63 typedef struct {
  64     // Real dictionary, not owned by this structure, should be accessed directly for read-only access.
  65     CFDictionaryRef dictionary;
  66
  67     // On-demand created (and possibly modified), owned writable copy of dictionary.
  68     CFMutableDictionaryRef mutable_dictionary;
  69 } SecCFDictionaryCOW;
  70
  71 CFMutableDictionaryRef SecCFDictionaryCOWGetMutable(SecCFDictionaryCOW *cow_dictionary);
  72
  73 typedef enum {
  74     kSecItemAuthResultOK,
  75     kSecItemAuthResultError,
  76     kSecItemAuthResultNeedAuth
  77 } SecItemAuthResult;
  78
  79 bool SecItemAuthDo(SecCFDictionaryCOW *auth_params, CFErrorRef *error, SecItemAuthResult (^perform)(CFDictionaryRef auth_params, CFArrayRef *ac_pairs, CFErrorRef *error));
  80
  81 void SecItemAuthCopyParams(SecCFDictionaryCOW *auth_params, SecCFDictionaryCOW *query);
  82
  83 TKTokenRef SecTokenCreate(CFStringRef token_id, CFDictionaryRef auth_params, CFErrorRef *error);
  84
  85 __END_DECLS
  86
  87 #endif /* !_SECURITY_SECITEMINTERNAL_H_ */