2 * Copyright (c) 2006-2014 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
26 SecItemPriv defines private constants and SPI functions for access to
27 Security items (certificates, identities, keys, and keychain items.)
30 #ifndef _SECURITY_SECITEMPRIV_H_
31 #define _SECURITY_SECITEMPRIV_H_
33 #include <CoreFoundation/CFDictionary.h>
34 #include <CoreFoundation/CFData.h>
35 #include <CoreFoundation/CFError.h>
36 #include <TargetConditionals.h>
38 #if (TARGET_OS_MAC && !(TARGET_OS_EMBEDDED || TARGET_OS_IPHONE))
39 #include <Security/SecTask.h>
45 @enum Class Value Constants (Private)
46 @discussion Predefined item class constants used to get or set values in
47 a dictionary. The kSecClass constant is the key and its value is one
48 of the constants defined here.
49 @constant kSecClassAppleSharePassword Specifies AppleShare password items.
51 extern const CFStringRef kSecClassAppleSharePassword
;
55 @enum Attribute Key Constants (Private)
56 @discussion Predefined item attribute keys used to get or set values in a
57 dictionary. Not all attributes apply to each item class. The table
58 below lists the currently defined attributes for each item class:
60 kSecClassGenericPassword item attributes:
63 kSecAttrModificationDate
68 kSecAttrScriptCode (private)
70 kSecAttrAlias (private)
73 kSecAttrHasCustomIcon (private)
74 kSecAttrProtected (private)
78 kSecAttrSynchronizable
81 kSecClassInternetPassword item attributes:
84 kSecAttrModificationDate
89 kSecAttrScriptCode (private)
91 kSecAttrAlias (private)
94 kSecAttrHasCustomIcon (private)
95 kSecAttrProtected (private)
97 kSecAttrSecurityDomain
100 kSecAttrAuthenticationType
103 kSecAttrSynchronizable
106 kSecClassAppleSharePassword item attributes:
109 kSecAttrModificationDate
114 kSecAttrScriptCode (private)
116 kSecAttrAlias (private)
119 kSecAttrHasCustomIcon (private)
120 kSecAttrProtected (private)
124 kSecAttrAFPServerSignature
125 kSecAttrSynchronizable
128 kSecClassCertificate item attributes:
130 kSecAttrCertificateType
131 kSecAttrCertificateEncoding
133 kSecAttrAlias (private)
138 kSecAttrPublicKeyHash
139 kSecAttrSynchronizable
142 kSecClassKey item attributes:
146 kSecAttrAlias (private)
147 kSecAttrApplicationLabel
149 kSecAttrIsPrivate (private)
150 kSecAttrIsModifiable (private)
151 kSecAttrApplicationTag
152 kSecAttrKeyCreator (private)
154 kSecAttrKeySizeInBits
155 kSecAttrEffectiveKeySize
156 kSecAttrStartDate (private)
157 kSecAttrEndDate (private)
158 kSecAttrIsSensitive (private)
159 kSecAttrWasAlwaysSensitive (private)
160 kSecAttrIsExtractable (private)
161 kSecAttrWasNeverExtractable (private)
167 kSecAttrCanSignRecover (private)
168 kSecAttrCanVerifyRecover (private)
171 kSecAttrSynchronizable
174 kSecClassIdentity item attributes:
175 Since an identity is the combination of a private key and a
176 certificate, this class shares attributes of both kSecClassKey and
177 kSecClassCertificate.
179 @constant kSecAttrScriptCode Specifies a dictionary key whose value is the
180 item's script code attribute. You use this tag to set or get a value
181 of type CFNumberRef that represents a script code for this item's
182 strings. (Note: use of this attribute is deprecated; string attributes
183 should always be stored in UTF-8 encoding. This is currently private
184 for use by syncing; new code should not ever access this attribute.)
185 @constant kSecAttrAlias Specifies a dictionary key whose value is the
186 item's alias. You use this key to get or set a value of type CFDataRef
187 which represents an alias. For certificate items, the alias is either
188 a single email address, an array of email addresses, or the common
189 name of the certificate if it does not contain any email address.
190 (Items of class kSecClassCertificate have this attribute.)
191 @constant kSecAttrHasCustomIcon Specifies a dictionary key whose value is the
192 item's custom icon attribute. You use this tag to set or get a value
193 of type CFBooleanRef that indicates whether the item should have an
194 application-specific icon. (Note: use of this attribute is deprecated;
195 custom item icons are not supported in Mac OS X. This is currently
196 private for use by syncing; new code should not use this attribute.)
197 @constant kSecAttrVolume Specifies a dictionary key whose value is the
198 item's volume attribute. You use this key to set or get a CFStringRef
199 value that represents an AppleShare volume name. (Items of class
200 kSecClassAppleSharePassword have this attribute.)
201 @constant kSecAttrAddress Specifies a dictionary key whose value is the
202 item's address attribute. You use this key to set or get a CFStringRef
203 value that contains the AppleTalk zone name, or the IP or domain name
204 that represents the server address. (Items of class
205 kSecClassAppleSharePassword have this attribute.)
206 @constant kSecAttrAFPServerSignature Specifies a dictionary key whose value
207 is the item's AFP server signature attribute. You use this key to set
208 or get a CFDataRef value containing 16 bytes that represents the
209 server's signature block. (Items of class kSecClassAppleSharePassword
210 have this attribute.)
211 @constant kSecAttrCRLType (read-only) Specifies a dictionary key whose
212 value is the item's certificate revocation list type. You use this
213 key to get a value of type CFNumberRef that denotes the CRL type (see
214 the CSSM_CRL_TYPE enum in cssmtype.h). (Items of class
215 kSecClassCertificate have this attribute.)
216 @constant kSecAttrCRLEncoding (read-only) Specifies a dictionary key whose
217 value is the item's certificate revocation list encoding. You use
218 this key to get a value of type CFNumberRef that denotes the CRL
219 encoding (see the CSSM_CRL_ENCODING enum in cssmtype.h). (Items of
220 class kSecClassCertificate have this attribute.)
221 @constant kSecAttrKeyCreator Specifies a dictionary key whose value is a
222 CFDataRef containing a CSSM_GUID structure representing the module ID of
223 the CSP that owns this key.
224 @constant kSecAttrIsPrivate Specifies a dictionary key whose value is a
225 CFBooleanRef indicating whether the raw key material of the key in
227 @constant kSecAttrIsModifiable Specifies a dictionary key whose value is a
228 CFBooleanRef indicating whether any of the attributes of this key are
230 @constant kSecAttrStartDate Specifies a dictionary key whose value is a
231 CFDateRef indicating the earliest date on which this key may be used.
232 If kSecAttrStartDate is not present, the restriction does not apply.
233 @constant kSecAttrEndDate Specifies a dictionary key whose value is a
234 CFDateRef indicating the last date on which this key may be used.
235 If kSecAttrEndDate is not present, the restriction does not apply.
236 @constant kSecAttrIsSensitive Specifies a dictionary key whose value
237 is a CFBooleanRef indicating whether the key in question must be wrapped
238 with an algorithm other than CSSM_ALGID_NONE.
239 @constant kSecAttrWasAlwaysSensitive Specifies a dictionary key whose value
240 is a CFBooleanRef indicating that the key in question has always been
242 @constant kSecAttrIsExtractable Specifies a dictionary key whose value
243 is a CFBooleanRef indicating whether the key in question may be wrapped.
244 @constant kSecAttrWasNeverExtractable Specifies a dictionary key whose value
245 is a CFBooleanRef indicating that the key in question has never been
246 marked as extractable.
247 @constant kSecAttrCanSignRecover Specifies a dictionary key whole value is a
248 CFBooleanRef indicating whether the key in question can be used to
249 perform sign recovery.
250 @constant kSecAttrCanVerifyRecover Specifies a dictionary key whole value is
251 a CFBooleanRef indicating whether the key in question can be used to
252 perform verify recovery.
253 @constant kSecAttrTombstone Specifies a dictionary key whose value is
254 a CFBooleanRef indicating that the item in question is a tombstone.
255 @constant kSecAttrNoLegacy Specifies a dictionary key whose
256 value is a CFBooleanRef indicating that the query must be run on the
257 syncable backend even for non syncable items.
259 extern const CFStringRef kSecAttrScriptCode
;
260 extern const CFStringRef kSecAttrAlias
;
261 extern const CFStringRef kSecAttrHasCustomIcon
;
262 extern const CFStringRef kSecAttrVolume
;
263 extern const CFStringRef kSecAttrAddress
;
264 extern const CFStringRef kSecAttrAFPServerSignature
;
265 extern const CFStringRef kSecAttrCRLType
;
266 extern const CFStringRef kSecAttrCRLEncoding
;
267 extern const CFStringRef kSecAttrKeyCreator
;
268 extern const CFStringRef kSecAttrIsPrivate
;
269 extern const CFStringRef kSecAttrIsModifiable
;
270 extern const CFStringRef kSecAttrStartDate
;
271 extern const CFStringRef kSecAttrEndDate
;
272 extern const CFStringRef kSecAttrIsSensitive
;
273 extern const CFStringRef kSecAttrWasAlwaysSensitive
;
274 extern const CFStringRef kSecAttrIsExtractable
;
275 extern const CFStringRef kSecAttrWasNeverExtractable
;
276 extern const CFStringRef kSecAttrCanSignRecover
;
277 extern const CFStringRef kSecAttrCanVerifyRecover
;
278 extern const CFStringRef kSecAttrTombstone
;
279 extern const CFStringRef kSecAttrNoLegacy
280 __OSX_AVAILABLE(10.11) __IOS_AVAILABLE(9.3) __TVOS_AVAILABLE(9.3) __WATCHOS_AVAILABLE(2.3);
281 extern const CFStringRef kSecAttrSyncViewHint
282 __OSX_AVAILABLE_STARTING(__MAC_10_11
, __IPHONE_9_0
);
283 extern const CFStringRef kSecAttrTokenOID
284 __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
287 @enum kSecAttrAccessible Value Constants (Private)
288 @constant kSecAttrAccessibleAlwaysPrivate Private alias for kSecAttrAccessibleAlways,
289 which is going to be deprecated for 3rd party use.
290 @constant kSecAttrAccessibleAlwaysThisDeviceOnlyPrivate for kSecAttrAccessibleAlwaysThisDeviceOnly,
291 which is going to be deprecated for 3rd party use.
293 extern const CFStringRef kSecAttrAccessibleAlwaysPrivate
294 ;//%%% __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0);
295 extern const CFStringRef kSecAttrAccessibleAlwaysThisDeviceOnlyPrivate
296 ;//%%% __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0);
298 extern const CFStringRef kSecAttrMultiUser
299 __OSX_AVAILABLE(10.11.5) __IOS_AVAILABLE(9.3) __TVOS_AVAILABLE(9.3) __WATCHOS_AVAILABLE(2.3);
301 /* View Hint Constants */
303 extern const CFStringRef kSecAttrViewHintPCSMasterKey
;
304 extern const CFStringRef kSecAttrViewHintPCSiCloudDrive
;
305 extern const CFStringRef kSecAttrViewHintPCSPhotos
;
306 extern const CFStringRef kSecAttrViewHintPCSCloudKit
;
307 extern const CFStringRef kSecAttrViewHintPCSEscrow
;
308 extern const CFStringRef kSecAttrViewHintPCSFDE
;
309 extern const CFStringRef kSecAttrViewHintPCSMailDrop
;
310 extern const CFStringRef kSecAttrViewHintPCSiCloudBackup
;
311 extern const CFStringRef kSecAttrViewHintPCSNotes
;
312 extern const CFStringRef kSecAttrViewHintPCSiMessage
;
313 extern const CFStringRef kSecAttrViewHintFeldspar
;
314 extern const CFStringRef kSecAttrViewHintPCSSharing
;
316 extern const CFStringRef kSecAttrViewHintAppleTV
;
317 extern const CFStringRef kSecAttrViewHintHomeKit
;
318 extern const CFStringRef kSecAttrViewHintThumper
;
319 extern const CFStringRef kSecAttrViewHintContinuityUnlock
;
320 extern const CFStringRef kSecAttrViewHintAccessoryPairing
;
326 extern const CFStringRef kSecUseSystemKeychain
327 __TVOS_AVAILABLE(9.2)
328 __WATCHOS_AVAILABLE(3.0)
329 __OSX_AVAILABLE(10.11.4)
330 __IOS_AVAILABLE(9.3);
332 extern const CFStringRef kSecUseSyncBubbleKeychain
333 __TVOS_AVAILABLE(9.2)
334 __WATCHOS_AVAILABLE(3.0)
335 __OSX_AVAILABLE(10.11.4)
336 __IOS_AVAILABLE(9.3);
340 @enum Other Constants (Private)
341 @discussion Predefined constants used to set values in a dictionary.
342 @constant kSecUseTombstones Specifies a dictionary key whose value is a
343 CFBooleanRef if present this overrides the default behaviour for when
344 we make tombstones. The default being we create tombstones for
345 synchronizable items unless we are explicitly deleting or updating a
346 tombstone. Setting this to false when calling SecItemDelete or
347 SecItemUpdate will ensure no tombstones are created. Setting it to
348 true will ensure we create tombstones even when deleting or updating non
349 synchronizable items.
350 @constant kSecUseKeychain Specifies a dictionary key whose value is a
351 keychain reference. You use this key to specify a value of type
352 SecKeychainRef that indicates the keychain to which SecItemAdd
353 will add the provided item(s).
354 @constant kSecUseKeychainList Specifies a dictionary key whose value is
355 either an array of keychains to search (CFArrayRef), or a single
356 keychain (SecKeychainRef). If not provided, the user's default
357 keychain list is searched. kSecUseKeychainList is ignored if an
358 explicit kSecUseItemList is also provided. This key can be used
359 for the SecItemCopyMatching, SecItemUpdate and SecItemDelete calls.
360 @constant kSecUseCredentialReference Specifies a CFDataRef containing
361 AppleCredentialManager reference handle to be used when authorizing access
363 @constant kSecUseCallerName Specifies a dictionary key whose value
364 is a CFStringRef that represents a user-visible string describing
365 the caller name for which the application is attempting to authenticate.
366 The caller must have 'com.apple.private.LocalAuthentication.CallerName'
367 entitlement set to YES to use this feature, otherwise it is ignored.
369 extern const CFStringRef kSecUseTombstones
370 __OSX_AVAILABLE_STARTING(__MAC_10_9
, __IPHONE_7_0
);
371 extern const CFStringRef kSecUseCredentialReference
372 __OSX_AVAILABLE_STARTING(__MAC_10_10
, __IPHONE_8_0
);
373 extern const CFStringRef kSecUseCallerName
374 __OSX_AVAILABLE(10.11.4) __IOS_AVAILABLE(9.3) __TVOS_AVAILABLE(9.3) __WATCHOS_AVAILABLE(2.3);
377 @function SecItemCopyDisplayNames
378 @abstract Returns an array containing unique display names for each of the
379 certificates, keys, identities, or passwords in the provided items
381 @param items An array containing items of type SecKeychainItemRef,
382 SecKeyRef, SecCertificateRef, or SecIdentityRef. All items in the
383 array should be of the same type.
384 @param displayNames On return, an array of CFString references containing
385 unique names for the supplied items. You are responsible for releasing
386 this array reference by calling the CFRelease function.
387 @result A result code. See "Security Error Codes" (SecBase.h).
388 @discussion Use this function to obtain item names which are suitable for
389 display in a menu or list view. The returned names are guaranteed to
390 be unique across the set of provided items.
392 OSStatus
SecItemCopyDisplayNames(CFArrayRef items
, CFArrayRef
*displayNames
);
395 @function SecItemDeleteAll
396 @abstract Removes all items from the keychain and added root certificates
397 from the trust store.
398 @result A result code. See "Security Error Codes" (SecBase.h).
400 OSStatus
SecItemDeleteAll(void);
403 @function SecItemDeleteAllWithAccessGroups
404 @abstract Deletes all items for each class for the given access groups
405 @param accessGroups An array of access groups for the items
406 @result A result code. See "Security Error Codes" (SecBase.h).
407 @discussion Provided for use by MobileInstallation to allow cleanup after uninstall
408 Requires entitlement "com.apple.private.uninstall.deletion"
410 bool SecItemDeleteAllWithAccessGroups(CFArrayRef accessGroups
, CFErrorRef
*error
);
413 Ensure the escrow keybag has been used to unlock the system keybag before
414 calling either of these APIs.
415 The password argument is optional, passing NULL implies no backup password
416 was set. We're assuming there will always be a backup keybag, except in
417 the OTA case where the loaded OTA backup bag will be used.
419 CFDataRef
_SecKeychainCopyBackup(CFDataRef backupKeybag
, CFDataRef password
);
420 CFDataRef
_SecKeychainCopyOTABackup(void);
421 OSStatus
_SecKeychainRestoreBackup(CFDataRef backup
, CFDataRef backupKeybag
,
426 _SecKeychainWriteBackupToFileDescriptor(CFDataRef backupKeybag
, CFDataRef password
, int fd
, CFErrorRef
*error
);
429 _SecKeychainRestoreBackupFromFileDescriptor(int fd
, CFDataRef backupKeybag
, CFDataRef password
, CFErrorRef
*error
);
432 _SecKeychainCopyKeybagUUIDFromFileDescriptor(int fd
, CFErrorRef
*error
);
434 OSStatus
_SecKeychainBackupSyncable(CFDataRef keybag
, CFDataRef password
, CFDictionaryRef backup_in
, CFDictionaryRef
*backup_out
);
435 OSStatus
_SecKeychainRestoreSyncable(CFDataRef keybag
, CFDataRef password
, CFDictionaryRef backup_in
);
437 /* Called by clients to push sync circle and message changes to us.
438 Requires caller to have the kSecEntitlementKeychainSyncUpdates entitlement. */
439 CFArrayRef
_SecKeychainSyncUpdateMessage(CFDictionaryRef updates
, CFErrorRef
*error
);
441 #if !TARGET_OS_IPHONE
442 CFDataRef
_SecItemGetPersistentReference(CFTypeRef raw_item
);
445 /* Returns an OSStatus value for the given CFErrorRef, returns errSecInternal if the
446 domain of the provided error is not recognized. Passing NULL returns errSecSuccess (0). */
447 OSStatus
SecErrorGetOSStatus(CFErrorRef error
);
449 bool _SecKeychainRollKeys(bool force
, CFErrorRef
*error
);
451 CFDictionaryRef
_SecSecuritydCopyWhoAmI(CFErrorRef
*error
);
452 bool _SecSyncBubbleTransfer(CFArrayRef services
, uid_t uid
, CFErrorRef
*error
);
453 bool _SecSystemKeychainTransfer(CFErrorRef
*error
);
454 bool _SecSyncDeleteUserViews(uid_t uid
, CFErrorRef
*error
);
456 OSStatus
SecItemUpdateTokenItems(CFTypeRef tokenID
, CFArrayRef tokenItemsAttributes
);
459 * @function SecCopyLastError
460 * @abstract return the last CFErrorRef for this thread
461 * @param status the error code returned from the API call w/o CFErrorRef or 0
462 * @result NULL or a retained CFError of the matching error code
464 * @discussion There are plenty of API calls in Security.framework that
465 * doesn't return an CFError in case of an error, many of them actually have
466 * a CFErrorRef internally, but throw it away at the last moment.
467 * This might be your chance to get hold of it. The status code pass in is there
468 * to avoid stale copies of CFErrorRef.
470 * Note, not all interfaces support returning a CFErrorRef on the thread local
471 * storage. This is especially true when going though old CDSA style API.
475 SecCopyLastError(OSStatus status
)
476 __TVOS_AVAILABLE(10.0)
477 __WATCHOS_AVAILABLE(3.0)
478 __IOS_AVAILABLE(10.0);
482 SecItemUpdateWithError(CFDictionaryRef inQuery
,
483 CFDictionaryRef inAttributesToUpdate
,
485 __TVOS_AVAILABLE(10.0)
486 __WATCHOS_AVAILABLE(3.0)
487 __IOS_AVAILABLE(10.0);
490 #if SECTRUST_OSX && !TARGET_OS_IPHONE
492 @function SecItemCopyParentCertificates
493 @abstract Retrieve an array of possible issuing certificates for a given certificate.
494 @param certificate A reference to a certificate whose issuers are being sought.
495 @param context Pass NULL in this parameter to indicate that the default certificate
496 source(s) should be searched. The default is to search all available keychains.
497 Values of context other than NULL are currently ignored.
498 @result An array of zero or more certificates whose normalized subject matches the
499 normalized issuer of the provided certificate. Note that no cryptographic validation
500 of the signature is performed by this function; its purpose is only to provide a list
501 of candidate certificates.
503 CFArrayRef
SecItemCopyParentCertificates(SecCertificateRef certificate
, void *context
)
504 __OSX_AVAILABLE_STARTING(__MAC_10_12
, __IPHONE_NA
);
507 @function SecItemCopyStoredCertificate
508 @abstract Retrieve the first stored instance of a given certificate.
509 @param certificate A reference to a certificate.
510 @param context Pass NULL in this parameter to indicate that the default certificate
511 source(s) should be searched. The default is to search all available keychains.
512 Values of context other than NULL are currently ignored.
513 @result Returns a certificate reference if the given certificate exists in a keychain,
514 or NULL if the certificate cannot be found in any keychain. The caller is responsible
515 for releasing the returned certificate reference when finished with it.
517 SecCertificateRef
SecItemCopyStoredCertificate(SecCertificateRef certificate
, void *context
)
518 __OSX_AVAILABLE_STARTING(__MAC_10_12
, __IPHONE_NA
);
523 #endif /* !_SECURITY_SECITEMPRIV_H_ */