OSX/libsecurity_keychain/lib/SecKeychainPriv.h

   1 /*
   2  * Copyright (c) 2003-2004,2011-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 #ifndef _SECURITY_SECKEYCHAINPRIV_H_
  25 #define _SECURITY_SECKEYCHAINPRIV_H_
  26
  27 #include <Security/Security.h>
  28 #include <Security/SecBasePriv.h>
  29 #include <Security/SecKeychain.h>
  30 #include <CoreFoundation/CoreFoundation.h>
  31
  32 #if defined(__cplusplus)
  33 extern "C" {
  34 #endif
  35
  36 enum {kSecKeychainEnteredBatchModeEvent = 14,
  37           kSecKeychainLeftBatchModeEvent = 15};
  38 enum {kSecKeychainEnteredBatchModeEventMask = 1 << kSecKeychainEnteredBatchModeEvent,
  39           kSecKeychainLeftBatchModeEventMask = 1 << kSecKeychainLeftBatchModeEvent};
  40
  41
  42 /* Keychain management */
  43 OSStatus SecKeychainCreateNew(SecKeychainRef keychainRef, UInt32 passwordLength, const char* inPassword)
  44     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  45 OSStatus SecKeychainMakeFromFullPath(const char *fullPathName, SecKeychainRef *keychainRef)
  46     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  47 OSStatus SecKeychainIsValid(SecKeychainRef keychainRef, Boolean* isValid)
  48     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  49 OSStatus SecKeychainChangePassword(SecKeychainRef keychainRef, UInt32 oldPasswordLength, const void *oldPassword,  UInt32 newPasswordLength, const void *newPassword)
  50     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  51 OSStatus SecKeychainSetBatchMode (SecKeychainRef kcRef, Boolean mode, Boolean rollback)
  52     __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA);
  53
  54 /* Keychain list management */
  55 UInt16 SecKeychainListGetCount(void)
  56     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  57 OSStatus SecKeychainListCopyKeychainAtIndex(UInt16 index, SecKeychainRef *keychainRef)
  58     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  59 OSStatus SecKeychainListRemoveKeychain(SecKeychainRef *keychainRef)
  60     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  61 OSStatus SecKeychainRemoveFromSearchList(SecKeychainRef keychainRef)
  62     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  63
  64 /* Login keychain support */
  65 OSStatus SecKeychainLogin(UInt32 nameLength, const void* name, UInt32 passwordLength, const void* password)
  66     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  67 OSStatus SecKeychainStash(void)
  68     __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_NA);
  69 OSStatus SecKeychainLogout(void)
  70     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  71 OSStatus SecKeychainCopyLogin(SecKeychainRef *keychainRef)
  72     __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
  73 OSStatus SecKeychainResetLogin(UInt32 passwordLength, const void* password, Boolean resetSearchList)
  74     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
  75
  76 OSStatus SecKeychainVerifyKeyStorePassphrase(uint32_t retries)
  77     __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_NA);
  78 OSStatus SecKeychainChangeKeyStorePassphrase(void)
  79     __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_NA);
  80
  81 /* Keychain synchronization */
  82 enum {
  83   kSecKeychainNotSynchronized = 0,
  84   kSecKeychainSynchronizedWithDotMac = 1
  85 };
  86 typedef UInt32 SecKeychainSyncState;
  87
  88 OSStatus SecKeychainCopySignature(SecKeychainRef keychainRef, CFDataRef *keychainSignature)
  89     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  90 OSStatus SecKeychainCopyBlob(SecKeychainRef keychainRef, CFDataRef *dbBlob)
  91     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  92 OSStatus SecKeychainRecodeKeychain(SecKeychainRef keychainRef, CFArrayRef dbBlobArray, CFDataRef extraData)
  93     __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_NA);
  94 OSStatus SecKeychainCreateWithBlob(const char* fullPathName, CFDataRef dbBlob, SecKeychainRef *kcRef)
  95     __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_NA);
  96
  97 /* Keychain list manipulation */
  98 OSStatus SecKeychainAddDBToKeychainList (SecPreferencesDomain domain, const char* dbName, const CSSM_GUID *guid, uint32 subServiceType)
  99     API_DEPRECATED("CSSM_GUID is deprecated", macos(10.4,10.14)) API_UNAVAILABLE(ios, watchos, tvos, bridgeos, macCatalyst);
 100 OSStatus SecKeychainDBIsInKeychainList (SecPreferencesDomain domain, const char* dbName, const CSSM_GUID *guid, uint32 subServiceType)
 101     API_DEPRECATED("CSSM_GUID is deprecated", macos(10.4,10.14)) API_UNAVAILABLE(ios, watchos, tvos, bridgeos, macCatalyst);
 102 OSStatus SecKeychainRemoveDBFromKeychainList (SecPreferencesDomain domain, const char* dbName, const CSSM_GUID *guid, uint32 subServiceType)
 103     API_DEPRECATED("CSSM_GUID is deprecated", macos(10.4,10.14)) API_UNAVAILABLE(ios, watchos, tvos, bridgeos, macCatalyst);
 104
 105 /* server operation (keychain inhibit) */
 106 void SecKeychainSetServerMode(void)
 107     __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA);
 108
 109 /* special calls */
 110 OSStatus SecKeychainCleanupHandles(void)
 111     __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA);
 112 OSStatus SecKeychainSystemKeychainCheckWouldDeadlock(void)
 113     __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
 114 OSStatus SecKeychainStoreUnlockKey(SecKeychainRef userKeychainRef, SecKeychainRef systemKeychainRef, CFStringRef username, CFStringRef password)
 115     __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_NA);
 116
 117 /* Token login support */
 118 OSStatus SecKeychainStoreUnlockKeyWithPubKeyHash(CFDataRef pubKeyHash, CFStringRef tokenID, CFDataRef wrapPubKeyHash, SecKeychainRef userKeychain, CFStringRef password)
 119     __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_NA);
 120 OSStatus SecKeychainEraseUnlockKeyWithPubKeyHash(CFDataRef pubKeyHash)
 121     __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_NA);
 122
 123 /* calls to interact with keychain versions */
 124 OSStatus SecKeychainGetKeychainVersion(SecKeychainRef keychain, UInt32* version)
 125     __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_NA);
 126
 127 OSStatus SecKeychainAttemptMigrationWithMasterKey(SecKeychainRef keychain, UInt32 version, const char* masterKeyFilename)
 128     __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_NA);
 129
 130 /* calls for testing only */
 131 OSStatus SecKeychainGetUserPromptAttempts(uint32_t* attempts)
 132     __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_NA);
 133
 134 /*!
 135  @function SecKeychainMDSInstall
 136  Set up MDS.
 137  */
 138 OSStatus SecKeychainMDSInstall(void);
 139
 140 #if defined(__cplusplus)
 141 }
 142 #endif
 143
 144 #endif /* !_SECURITY_SECKEYCHAINPRIV_H_ */