SystemConfiguration.fproj/SCPreferencesKeychainPrivate.h

   1 /*
   2  * Copyright (c) 2006, 2008, 2018 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 #ifndef _SCPREFERENCESKEYCHAINPRIVATE_H
  25 #define _SCPREFERENCESKEYCHAINPRIVATE_H
  26
  27 /*
  28  * SCPreferencesKeychain.h
  29  * - routines to deal with keychain passwords
  30  */
  31
  32 #include <os/availability.h>
  33 #include <TargetConditionals.h>
  34 #include <sys/cdefs.h>
  35 #include <CoreFoundation/CoreFoundation.h>
  36 #include <SystemConfiguration/SCPreferences.h>
  37 #if     !TARGET_OS_IPHONE
  38 #include <Security/Security.h>
  39 #else   // !TARGET_OS_IPHONE
  40 typedef struct CF_BRIDGED_TYPE(id) __SecKeychain *SecKeychainRef;
  41 #endif  // !TARGET_OS_IPHONE
  42
  43 #pragma mark -
  44 #pragma mark Keychain helper APIs
  45
  46 #define kSCKeychainOptionsAllowRoot             CFSTR("AllowRoot")              // CFBoolean, allow uid==0 applications
  47 #define kSCKeychainOptionsAllowedExecutables    CFSTR("AllowedExecutables")     // CFArray[CFURL]
  48
  49 __BEGIN_DECLS
  50
  51 SecKeychainRef
  52 _SCSecKeychainCopySystemKeychain                (void)                                  API_AVAILABLE(macos(10.5), ios(2.0));
  53
  54 CFDataRef
  55 _SCSecKeychainPasswordItemCopy                  (SecKeychainRef         keychain,
  56                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  57
  58 Boolean
  59 _SCSecKeychainPasswordItemExists                (SecKeychainRef         keychain,
  60                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  61
  62 Boolean
  63 _SCSecKeychainPasswordItemRemove                (SecKeychainRef         keychain,
  64                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  65
  66 Boolean
  67 _SCSecKeychainPasswordItemSet                   (SecKeychainRef         keychain,
  68                                                  CFStringRef            unique_id,
  69                                                  CFStringRef            label,
  70                                                  CFStringRef            description,
  71                                                  CFStringRef            account,
  72                                                  CFDataRef              password,
  73                                                  CFDictionaryRef        options)        API_AVAILABLE(macos(10.5), ios(2.0));
  74
  75
  76 #pragma mark -
  77 #pragma mark "System" Keychain APIs (w/SCPreferences)
  78
  79
  80 CFDataRef
  81 _SCPreferencesSystemKeychainPasswordItemCopy    (SCPreferencesRef       prefs,
  82                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  83
  84 Boolean
  85 _SCPreferencesSystemKeychainPasswordItemExists  (SCPreferencesRef       prefs,
  86                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  87
  88 Boolean
  89 _SCPreferencesSystemKeychainPasswordItemRemove  (SCPreferencesRef       prefs,
  90                                                  CFStringRef            unique_id)      API_AVAILABLE(macos(10.5), ios(2.0));
  91
  92 Boolean
  93 _SCPreferencesSystemKeychainPasswordItemSet     (SCPreferencesRef       prefs,
  94                                                  CFStringRef            unique_id,
  95                                                  CFStringRef            label,
  96                                                  CFStringRef            description,
  97                                                  CFStringRef            account,
  98                                                  CFDataRef              password,
  99                                                  CFDictionaryRef        options)        API_AVAILABLE(macos(10.5), ios(2.0));
 100
 101 __END_DECLS
 102
 103 #endif  // _SCPREFERENCESKEYCHAINPRIVATE_H