]> git.saurik.com Git - apple/security.git/blame - libsecurity_cssm/lib/cssmapple.h
Security-55471.14.18.tar.gz
[apple/security.git] / libsecurity_cssm / lib / cssmapple.h
CommitLineData
b1ab9ed8 1/*
427c49bc
A
2 * Copyright (c) 2000-2013 Apple Inc. All Rights Reserved.
3 *
b1ab9ed8 4 * @APPLE_LICENSE_HEADER_START@
427c49bc 5 *
b1ab9ed8
A
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.
427c49bc 12 *
b1ab9ed8
A
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.
427c49bc 20 *
b1ab9ed8
A
21 * @APPLE_LICENSE_HEADER_END@
22 *
23 * cssmapple.h -- CSSM features specific to Apple's Implementation
24 */
25
26#ifndef _CSSMAPPLE_H_
27#define _CSSMAPPLE_H_ 1
28
29#include <Security/cssmerr.h>
30#include <Security/cssmtype.h>
31#include <Security/x509defs.h> /* for CSSM_APPLE_TP_CERT_REQUEST fields */
32#include <Security/certextensions.h> /* ditto */
33#include <sys/types.h> /* for the BSD *_t types */
34#include <stdbool.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/* Guids for standard Apple addin modules. */
41
42/* CSSM itself: {87191ca0-0fc9-11d4-849a-000502b52122} */
43extern const CSSM_GUID gGuidCssm;
44
45/* File based DL (aka "Keychain DL"): {87191ca1-0fc9-11d4-849a-000502b52122} */
46extern const CSSM_GUID gGuidAppleFileDL;
47
48/* Core CSP (local space): {87191ca2-0fc9-11d4-849a-000502b52122} */
49extern const CSSM_GUID gGuidAppleCSP;
50
51/* Secure CSP/DL (aka "Keychain CSPDL): {87191ca3-0fc9-11d4-849a-000502b52122} */
52extern const CSSM_GUID gGuidAppleCSPDL;
53
54/* X509 Certificate CL: {87191ca4-0fc9-11d4-849a-000502b52122} */
55extern const CSSM_GUID gGuidAppleX509CL;
56
57/* X509 Certificate TP: {87191ca5-0fc9-11d4-849a-000502b52122} */
58extern const CSSM_GUID gGuidAppleX509TP;
59
60/* DLAP/OpenDirectory access DL: {87191ca6-0fc9-11d4-849a-000502b52122} */
61extern const CSSM_GUID gGuidAppleLDAPDL;
62
63/* TP for ".mac" related policies: {87191ca7-0fc9-11d4-849a-000502b52122} */
64extern const CSSM_GUID gGuidAppleDotMacTP;
65
66/* Smartcard CSP/DL: {87191ca8-0fc9-11d4-849a-000502b52122} */
67extern const CSSM_GUID gGuidAppleSdCSPDL;
68
69/* DL for ".mac" certificate access: {87191ca9-0fc9-11d4-849a-000502b52122} */
70extern const CSSM_GUID gGuidAppleDotMacDL;
71
72
73/* Apple defined WORDID values */
74enum
75{
76 CSSM_WORDID_KEYCHAIN_PROMPT = CSSM_WORDID_VENDOR_START,
77 CSSM_WORDID_KEYCHAIN_LOCK,
78 CSSM_WORDID_KEYCHAIN_CHANGE_LOCK,
79 CSSM_WORDID_PROCESS,
80 CSSM_WORDID__RESERVED_1, /* was used in 10.2 test seeds; no longer in use */
81 CSSM_WORDID_SYMMETRIC_KEY,
82 CSSM_WORDID_SYSTEM,
83 CSSM_WORDID_KEY,
84 CSSM_WORDID_PIN,
85 CSSM_WORDID_PREAUTH,
86 CSSM_WORDID_PREAUTH_SOURCE,
87 CSSM_WORDID_ASYMMETRIC_KEY,
88 CSSM_WORDID__FIRST_UNUSED
89};
90
91/* Apple defined ACL subject and credential types */
92enum
93{
94 CSSM_ACL_SUBJECT_TYPE_KEYCHAIN_PROMPT = CSSM_WORDID_KEYCHAIN_PROMPT,
95 CSSM_ACL_SUBJECT_TYPE_PROCESS = CSSM_WORDID_PROCESS,
96 CSSM_ACL_SUBJECT_TYPE_CODE_SIGNATURE = CSSM_WORDID_SIGNATURE,
97 CSSM_ACL_SUBJECT_TYPE_COMMENT = CSSM_WORDID_COMMENT,
98 CSSM_ACL_SUBJECT_TYPE_SYMMETRIC_KEY = CSSM_WORDID_SYMMETRIC_KEY,
99 CSSM_ACL_SUBJECT_TYPE_PREAUTH = CSSM_WORDID_PREAUTH,
100 CSSM_ACL_SUBJECT_TYPE_PREAUTH_SOURCE = CSSM_WORDID_PREAUTH_SOURCE,
101 CSSM_ACL_SUBJECT_TYPE_ASYMMETRIC_KEY = CSSM_WORDID_ASYMMETRIC_KEY
102};
103
104enum
105{
106 CSSM_SAMPLE_TYPE_KEYCHAIN_PROMPT = CSSM_WORDID_KEYCHAIN_PROMPT,
107 CSSM_SAMPLE_TYPE_KEYCHAIN_LOCK = CSSM_WORDID_KEYCHAIN_LOCK,
108 CSSM_SAMPLE_TYPE_KEYCHAIN_CHANGE_LOCK = CSSM_WORDID_KEYCHAIN_CHANGE_LOCK,
109 CSSM_SAMPLE_TYPE_PROCESS = CSSM_WORDID_PROCESS,
110 CSSM_SAMPLE_TYPE_COMMENT = CSSM_WORDID_COMMENT,
111 CSSM_SAMPLE_TYPE_RETRY_ID = CSSM_WORDID_PROPAGATE,
112 CSSM_SAMPLE_TYPE_SYMMETRIC_KEY = CSSM_WORDID_SYMMETRIC_KEY,
113 CSSM_SAMPLE_TYPE_PREAUTH = CSSM_WORDID_PREAUTH,
114 CSSM_SAMPLE_TYPE_ASYMMETRIC_KEY = CSSM_WORDID_ASYMMETRIC_KEY
115 // there is no CSSM_SAMPLE_TYPE_PREAUTH_SOURCE
116};
117
118
119/* Apple-defined ACL authorization tags */
120enum {
121 CSSM_ACL_AUTHORIZATION_CHANGE_ACL = CSSM_ACL_AUTHORIZATION_TAG_VENDOR_DEFINED_START,
122 CSSM_ACL_AUTHORIZATION_CHANGE_OWNER,
427c49bc 123
b1ab9ed8
A
124 // the "pre-auth" tags form a contiguous range of (up to) 64K pre-authorizations
125 CSSM_ACL_AUTHORIZATION_PREAUTH_BASE =
126 CSSM_ACL_AUTHORIZATION_TAG_VENDOR_DEFINED_START + 0x1000000,
127 CSSM_ACL_AUTHORIZATION_PREAUTH_END = CSSM_ACL_AUTHORIZATION_PREAUTH_BASE + 0x10000
128};
129
130/* pre-authorization conversions (auth-tag to slot and back) */
131#define CSSM_ACL_AUTHORIZATION_PREAUTH(slot) \
132 (CSSM_ACL_AUTHORIZATION_PREAUTH_BASE + (slot))
133#define CSSM_ACL_AUTHORIZATION_PREAUTH_SLOT(auth) \
134 ((auth) - CSSM_ACL_AUTHORIZATION_PREAUTH_BASE)
135#define CSSM_ACL_AUTHORIZATION_IS_PREAUTH(auth) \
136 ((auth) >= CSSM_ACL_AUTHORIZATION_PREAUTH_BASE && \
137 (auth) < CSSM_ACL_AUTHORIZATION_PREAUTH_END)
138
139
140/* Parameters and structures for Apple-defined ACL subjects and samples */
141
142enum { /* types of code signatures - item 1 of CSSM_ACL_SUBJECT_TYPE_CODE_SIGNATURE subjects */
143 CSSM_ACL_CODE_SIGNATURE_INVALID = 0, /* standard OS X code signature */
144 CSSM_ACL_CODE_SIGNATURE_OSX = 1 /* standard OS X code signature */
145};
146
147/* ACL subjects of type PROCESS */
148
149enum { /* PROCESS_SUBJECT mask fields */
150 CSSM_ACL_MATCH_UID = 0x01, /* match userid against uid field */
151 CSSM_ACL_MATCH_GID = 0x02, /* match groupid against gid field */
152 CSSM_ACL_MATCH_HONOR_ROOT = 0x100, /* let root (uid 0) match any userid */
153 CSSM_ACL_MATCH_BITS = CSSM_ACL_MATCH_UID | CSSM_ACL_MATCH_GID
154};
155
156enum { /* PROCESS_SUBJECT structure version field */
157 CSSM_ACL_PROCESS_SELECTOR_CURRENT_VERSION = 0x101
158};
159
160typedef struct cssm_acl_process_subject_selector { /* PROCESS_SUBJECT selector */
161 uint16 version; /* version of this selector */
162 uint16 mask; /* active fields mask */
163 uint32 uid; /* effective user id match */
164 uint32 gid; /* effective group id match */
165} CSSM_ACL_PROCESS_SUBJECT_SELECTOR;
166
167/* ACL subjects of type KEYCHAIN_PROMPT */
168
169enum { /* KEYCHAIN_PROMPT structure version field */
170 CSSM_ACL_KEYCHAIN_PROMPT_CURRENT_VERSION = 0x101
171};
172
173enum { /* KEYCHAIN_PROMPT operational flags */
174 CSSM_ACL_KEYCHAIN_PROMPT_REQUIRE_PASSPHRASE = 0x0001, /* require re-entering of passphrase */
175 /* the following bits are ignored by 10.4 and earlier */
176 CSSM_ACL_KEYCHAIN_PROMPT_UNSIGNED = 0x0010, /* prompt for unsigned clients */
177 CSSM_ACL_KEYCHAIN_PROMPT_UNSIGNED_ACT = 0x0020, /* UNSIGNED bit overrides system default */
178 CSSM_ACL_KEYCHAIN_PROMPT_INVALID = 0x0040, /* prompt for invalid signed clients */
179 CSSM_ACL_KEYCHAIN_PROMPT_INVALID_ACT = 0x0080, /* INVALID bit overrides system default */
180};
181
182typedef struct cssm_acl_keychain_prompt_selector { /* KEYCHAIN_PROMPT selector */
183 uint16 version; /* version of this selector */
184 uint16 flags; /* flag bits */
185} CSSM_ACL_KEYCHAIN_PROMPT_SELECTOR;
186
187/* ACL subjects of type CSSM_ACL_SUBJECT_TYPE_PREAUTH_SOURCE */
188typedef uint32 CSSM_ACL_PREAUTH_TRACKING_STATE;
189enum { /* preauth tracking state */
190 CSSM_ACL_PREAUTH_TRACKING_COUNT_MASK = 0xff, /* mask for count status */
191 CSSM_ACL_PREAUTH_TRACKING_BLOCKED = 0, /* retries exhausted; the slot is blocked */
192 /* 0 .. 255 is a count of (re)tries remaining */
427c49bc 193
b1ab9ed8
A
194 /* bits or'ed into any count given */
195 CSSM_ACL_PREAUTH_TRACKING_UNKNOWN = 0x40000000, /* status of slot is unknown (ignore count) */
196 CSSM_ACL_PREAUTH_TRACKING_AUTHORIZED = 0x80000000 /* the slot is currently authorized (or'ed in) */
197};
198
199
200/* Apple defined values of a CSSM_DB_ACCESS_TYPE */
201enum {
202 CSSM_DB_ACCESS_RESET = 0x10000 /* clear pre-authentications (or'ed bit) */
203};
204
205
206/* Apple defined algorithm IDs */
207enum
208{
209 CSSM_ALGID_APPLE_YARROW = CSSM_ALGID_VENDOR_DEFINED,
210 CSSM_ALGID_AES, /* RijnDael */
427c49bc 211 CSSM_ALGID_FEE, /* FEE Key Generation */
b1ab9ed8
A
212 CSSM_ALGID_FEE_MD5, /* FEE/ElGamal signature w/ MD5 hash */
213 CSSM_ALGID_FEE_SHA1, /* FEE/ElGamal signature w/ SHA1 hash */
214 CSSM_ALGID_FEED, /* 1:1 FEE asymmetric encryption */
215 CSSM_ALGID_FEEDEXP, /* 2:1 FEE asymmetric encryption */
216 CSSM_ALGID_ASC, /* Apple Secure Compression */
217 CSSM_ALGID_SHA1HMAC_LEGACY, /* HMAC/SHA1, legacy compatible */
218 CSSM_ALGID_KEYCHAIN_KEY, /* derive or manipulate keychain master keys */
219 CSSM_ALGID_PKCS12_PBE_ENCR, /* PKCS12, encrypt/decrypt key */
220 CSSM_ALGID_PKCS12_PBE_MAC, /* PKCS12, MAC key */
221 CSSM_ALGID_SECURE_PASSPHRASE, /* passphrase acquired by SecurityServer */
222 CSSM_ALGID_PBE_OPENSSL_MD5, /* traditional openssl key derivation */
223 CSSM_ALGID_SHA256, /* 256-bit SHA2 */
224 CSSM_ALGID_SHA384, /* 384-bit SHA2 */
225 CSSM_ALGID_SHA512, /* 512-bit SHA2 */
226 CSSM_ALGID_ENTROPY_DEFAULT, /* default entropy source of (CSP) device, if any */
227 CSSM_ALGID_SHA224, /* SHA2, 224 bit */
228 CSSM_ALGID_SHA224WithRSA, /* RSA signature on SHA224 digest */
229 CSSM_ALGID_SHA256WithRSA, /* RSA signature on SHA256 digest */
230 CSSM_ALGID_SHA384WithRSA, /* RSA signature on SHA384 digest */
231 CSSM_ALGID_SHA512WithRSA, /* RSA signature on SHA512 digest */
232 CSSM_ALGID_OPENSSH1, /* OpenSSH v1 RSA key wrapping */
233 CSSM_ALGID_SHA224WithECDSA, /* ECDSA signature on SHA224 digest */
234 CSSM_ALGID_SHA256WithECDSA, /* ECDSA signature on SHA256 digest */
235 CSSM_ALGID_SHA384WithECDSA, /* ECDSA signature on SHA384 digest */
236 CSSM_ALGID_SHA512WithECDSA, /* ECDSA signature on SHA512 digest */
237 CSSM_ALGID_ECDSA_SPECIFIED, /* ECDSA with separate digest algorithm specifier */
238 CSSM_ALGID_ECDH_X963_KDF, /* ECDH with X9.63 key derivation */
239 CSSM_ALGID__FIRST_UNUSED
240};
241
242/* Apple defined padding */
243enum
244{
245 /* RFC 2246 section E.2 for SSLv2 rollback detection */
246 CSSM_PADDING_APPLE_SSLv2 = CSSM_PADDING_VENDOR_DEFINED
247};
248
249
250/* Apple defined keyblob formats */
251enum {
252 CSSM_KEYBLOB_RAW_FORMAT_VENDOR_DEFINED = 0x80000000
253};
254enum {
255 /* X509 SubjectPublicKeyInfo */
256 CSSM_KEYBLOB_RAW_FORMAT_X509 = CSSM_KEYBLOB_RAW_FORMAT_VENDOR_DEFINED,
257 /* OpenSSH v1 */
427c49bc 258 CSSM_KEYBLOB_RAW_FORMAT_OPENSSH,
b1ab9ed8
A
259 /* openssl-style DSA private key */
260 CSSM_KEYBLOB_RAW_FORMAT_OPENSSL,
261 /* OpenSSH v2 */
262 CSSM_KEYBLOB_RAW_FORMAT_OPENSSH2
263};
264
265/* Apple adds some "common" error codes. CDSA does not define an official start value for this. */
266enum
267{
268 CSSM_CUSTOM_COMMON_ERROR_EXTENT = 0x00e0,
427c49bc 269
b1ab9ed8
A
270 CSSM_ERRCODE_NO_USER_INTERACTION = 0x00e0,
271 CSSM_ERRCODE_USER_CANCELED = 0x00e1,
272 CSSM_ERRCODE_SERVICE_NOT_AVAILABLE = 0x00e2,
273 CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION = 0x00e3,
274 CSSM_ERRCODE_DEVICE_RESET = 0x00e4,
275 CSSM_ERRCODE_DEVICE_FAILED = 0x00e5,
276 CSSM_ERRCODE_IN_DARK_WAKE = 0x00e6
277};
278
279enum {
280 CSSMERR_CSSM_NO_USER_INTERACTION = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
281 CSSMERR_AC_NO_USER_INTERACTION = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
282 CSSMERR_CSP_NO_USER_INTERACTION = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
283 CSSMERR_CL_NO_USER_INTERACTION = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
284 CSSMERR_DL_NO_USER_INTERACTION = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
285 CSSMERR_TP_NO_USER_INTERACTION = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_NO_USER_INTERACTION,
427c49bc 286
b1ab9ed8
A
287 CSSMERR_CSSM_USER_CANCELED = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
288 CSSMERR_AC_USER_CANCELED = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
289 CSSMERR_CSP_USER_CANCELED = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
290 CSSMERR_CL_USER_CANCELED = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
291 CSSMERR_DL_USER_CANCELED = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
292 CSSMERR_TP_USER_CANCELED = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_USER_CANCELED,
293
294 CSSMERR_CSSM_SERVICE_NOT_AVAILABLE = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
295 CSSMERR_AC_SERVICE_NOT_AVAILABLE = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
296 CSSMERR_CSP_SERVICE_NOT_AVAILABLE = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
297 CSSMERR_CL_SERVICE_NOT_AVAILABLE = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
298 CSSMERR_DL_SERVICE_NOT_AVAILABLE = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
299 CSSMERR_TP_SERVICE_NOT_AVAILABLE = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_SERVICE_NOT_AVAILABLE,
300
301 CSSMERR_CSSM_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
302 CSSMERR_AC_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
303 CSSMERR_CSP_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
304 CSSMERR_CL_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
305 CSSMERR_DL_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
306 CSSMERR_TP_INSUFFICIENT_CLIENT_IDENTIFICATION = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_INSUFFICIENT_CLIENT_IDENTIFICATION,
307
308 CSSMERR_CSSM_DEVICE_RESET = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
309 CSSMERR_AC_DEVICE_RESET = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
310 CSSMERR_CSP_DEVICE_RESET = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
311 CSSMERR_CL_DEVICE_RESET = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
312 CSSMERR_DL_DEVICE_RESET = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
313 CSSMERR_TP_DEVICE_RESET = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_DEVICE_RESET,
314
315 CSSMERR_CSSM_DEVICE_FAILED = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
316 CSSMERR_AC_DEVICE_FAILED = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
317 CSSMERR_CSP_DEVICE_FAILED = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
318 CSSMERR_CL_DEVICE_FAILED = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
319 CSSMERR_DL_DEVICE_FAILED = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
320 CSSMERR_TP_DEVICE_FAILED = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_DEVICE_FAILED,
321
322 CSSMERR_CSSM_IN_DARK_WAKE = CSSM_CSSM_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE,
323 CSSMERR_AC_IN_DARK_WAKE = CSSM_AC_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE,
324 CSSMERR_CSP_IN_DARK_WAKE = CSSM_CSP_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE,
325 CSSMERR_CL_IN_DARK_WAKE = CSSM_CL_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE,
326 CSSMERR_DL_IN_DARK_WAKE = CSSM_DL_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE,
327 CSSMERR_TP_IN_DARK_WAKE = CSSM_TP_BASE_ERROR + CSSM_ERRCODE_IN_DARK_WAKE
328};
329
330/* AppleCSPDL, AppleCSP private error codes. */
331enum {
332 CSSMERR_CSP_APPLE_ADD_APPLICATION_ACL_SUBJECT = CSSM_CSP_PRIVATE_ERROR + 0,
333 /*
427c49bc 334 * An attempt was made to use a public key which is incomplete due to
b1ab9ed8
A
335 * the lack of algorithm-specific parameters.
336 */
337 CSSMERR_CSP_APPLE_PUBLIC_KEY_INCOMPLETE = CSSM_CSP_PRIVATE_ERROR + 1,
427c49bc 338
b1ab9ed8
A
339 /* a code signature match failed */
340 CSSMERR_CSP_APPLE_SIGNATURE_MISMATCH = CSSM_CSP_PRIVATE_ERROR + 2,
427c49bc 341
b1ab9ed8
A
342 /* Key StartDate/EndDate invalid */
343 CSSMERR_CSP_APPLE_INVALID_KEY_START_DATE = CSSM_CSP_PRIVATE_ERROR + 3,
344 CSSMERR_CSP_APPLE_INVALID_KEY_END_DATE = CSSM_CSP_PRIVATE_ERROR + 4,
427c49bc 345
b1ab9ed8
A
346 /* Keychain Syncing error codes */
347 CSSMERR_CSPDL_APPLE_DL_CONVERSION_ERROR = CSSM_CSP_PRIVATE_ERROR + 5,
348
349 /* SSLv2 padding check: rollback attack detected */
350 CSSMERR_CSP_APPLE_SSLv2_ROLLBACK = CSSM_CSP_PRIVATE_ERROR + 6
351};
352
353
354/* AppleFileDL record types. */
355enum
356{
357 CSSM_DL_DB_RECORD_GENERIC_PASSWORD = CSSM_DB_RECORDTYPE_APP_DEFINED_START + 0,
358 CSSM_DL_DB_RECORD_INTERNET_PASSWORD = CSSM_DB_RECORDTYPE_APP_DEFINED_START + 1,
359 CSSM_DL_DB_RECORD_APPLESHARE_PASSWORD = CSSM_DB_RECORDTYPE_APP_DEFINED_START + 2,
360
361 CSSM_DL_DB_RECORD_X509_CERTIFICATE = CSSM_DB_RECORDTYPE_APP_DEFINED_START + 0x1000,
362 CSSM_DL_DB_RECORD_USER_TRUST,
363 CSSM_DL_DB_RECORD_X509_CRL,
364 CSSM_DL_DB_RECORD_UNLOCK_REFERRAL,
365 CSSM_DL_DB_RECORD_EXTENDED_ATTRIBUTE,
366 CSSM_DL_DB_RECORD_METADATA = CSSM_DB_RECORDTYPE_APP_DEFINED_START + 0x8000
367};
368
369/* AppleFileDL extentions: passthrough ids */
370enum {
371 // Toggle whether or not to autocommit after modifying the database.
372 // The input parameter is a CSSM_BOOL, where TRUE turns autocommit on
373 // and FALSE turns it off.
374 CSSM_APPLEFILEDL_TOGGLE_AUTOCOMMIT,
427c49bc 375
b1ab9ed8
A
376 // Commit any pending changes to the database.
377 CSSM_APPLEFILEDL_COMMIT,
427c49bc 378
b1ab9ed8
A
379 // Rollback and discard any pending changes to the database.
380 CSSM_APPLEFILEDL_ROLLBACK
381};
382
383/* UNLOCK_REFERRAL "type" attribute values */
384enum {
385 CSSM_APPLE_UNLOCK_TYPE_KEY_DIRECT = 1, // master secret key stored directly
386 CSSM_APPLE_UNLOCK_TYPE_WRAPPED_PRIVATE = 2 // master key wrapped by public key
387};
388
389/* Apple DL private error codes. */
390enum
391{
392 /* The OpenParameters argument passed to CSSM_DL_DbCreate or CSSM_DL_DbOpen
393 was neither NULL nor a pointer to a valid CSSM_APPLEDL_OPEN_PARAMETERS
394 structure. */
395 CSSMERR_APPLEDL_INVALID_OPEN_PARAMETERS = CSSM_DL_PRIVATE_ERROR + 0,
427c49bc 396
b1ab9ed8
A
397 /* an operation failed because the disk was full */
398 CSSMERR_APPLEDL_DISK_FULL = CSSM_DL_PRIVATE_ERROR + 1,
427c49bc 399
b1ab9ed8
A
400 /* an operation failed because a disk quota was exceeded */
401 CSSMERR_APPLEDL_QUOTA_EXCEEDED = CSSM_DL_PRIVATE_ERROR + 2,
427c49bc 402
b1ab9ed8
A
403 /* an operation failed because a file was too large */
404 CSSMERR_APPLEDL_FILE_TOO_BIG = CSSM_DL_PRIVATE_ERROR + 3,
427c49bc 405
b1ab9ed8
A
406 /* a keychain database's internal information ("blob") is invalid */
407 CSSMERR_APPLEDL_INVALID_DATABASE_BLOB = CSSM_DL_PRIVATE_ERROR + 4,
408 CSSMERR_APPLEDL_INVALID_KEY_BLOB = CSSM_DL_PRIVATE_ERROR + 5,
427c49bc 409
b1ab9ed8
A
410 /* the internal data format version for a database's internal information ("blob") is invalid */
411 CSSMERR_APPLEDL_INCOMPATIBLE_DATABASE_BLOB = CSSM_DL_PRIVATE_ERROR + 6,
427c49bc 412 CSSMERR_APPLEDL_INCOMPATIBLE_KEY_BLOB = CSSM_DL_PRIVATE_ERROR + 7,
b1ab9ed8
A
413};
414
415/* Apple X509TP private error codes. */
427c49bc 416enum
b1ab9ed8
A
417{
418 /* Host name mismatch */
419 CSSMERR_APPLETP_HOSTNAME_MISMATCH = CSSM_TP_PRIVATE_ERROR + 0,
420 /* Non-understood extension with Critical flag true */
421 CSSMERR_APPLETP_UNKNOWN_CRITICAL_EXTEN = CSSM_TP_PRIVATE_ERROR + 1,
422 /* Basic Constraints extension required per policy, but not present */
423 CSSMERR_APPLETP_NO_BASIC_CONSTRAINTS = CSSM_TP_PRIVATE_ERROR + 2,
424 /* Invalid BasicConstraints.CA */
425 CSSMERR_APPLETP_INVALID_CA = CSSM_TP_PRIVATE_ERROR + 3,
426 /* Invalid Authority Key ID */
427 CSSMERR_APPLETP_INVALID_AUTHORITY_ID = CSSM_TP_PRIVATE_ERROR + 4,
428 /* Invalid Subject Key ID */
429 CSSMERR_APPLETP_INVALID_SUBJECT_ID = CSSM_TP_PRIVATE_ERROR + 5,
430 /* Invalid Key Usage for policy */
431 CSSMERR_APPLETP_INVALID_KEY_USAGE = CSSM_TP_PRIVATE_ERROR + 6,
432 /* Invalid Extended Key Usage for policy */
433 CSSMERR_APPLETP_INVALID_EXTENDED_KEY_USAGE = CSSM_TP_PRIVATE_ERROR + 7,
434 /* Invalid Subject/Authority Key ID Linkage */
435 CSSMERR_APPLETP_INVALID_ID_LINKAGE = CSSM_TP_PRIVATE_ERROR + 8,
436 /* PathLengthConstraint exceeded */
437 CSSMERR_APPLETP_PATH_LEN_CONSTRAINT = CSSM_TP_PRIVATE_ERROR + 9,
438 /* Cert group terminated at a root cert which did not self-verify */
439 CSSMERR_APPLETP_INVALID_ROOT = CSSM_TP_PRIVATE_ERROR + 10,
440 /* CRL expired/not valid yet */
441 CSSMERR_APPLETP_CRL_EXPIRED = CSSM_TP_PRIVATE_ERROR + 11,
442 CSSMERR_APPLETP_CRL_NOT_VALID_YET = CSSM_TP_PRIVATE_ERROR + 12,
443 /* Cannot find appropriate CRL */
444 CSSMERR_APPLETP_CRL_NOT_FOUND = CSSM_TP_PRIVATE_ERROR + 13,
445 /* specified CRL server down */
446 CSSMERR_APPLETP_CRL_SERVER_DOWN = CSSM_TP_PRIVATE_ERROR + 14,
447 /* illegible CRL distribution point URL */
448 CSSMERR_APPLETP_CRL_BAD_URI = CSSM_TP_PRIVATE_ERROR + 15,
449 /* Unknown critical cert/CRL extension */
450 CSSMERR_APPLETP_UNKNOWN_CERT_EXTEN = CSSM_TP_PRIVATE_ERROR + 16,
451 CSSMERR_APPLETP_UNKNOWN_CRL_EXTEN = CSSM_TP_PRIVATE_ERROR + 17,
452 /* CRL not verifiable to anchor or root */
453 CSSMERR_APPLETP_CRL_NOT_TRUSTED = CSSM_TP_PRIVATE_ERROR + 18,
454 /* CRL verified to untrusted root */
455 CSSMERR_APPLETP_CRL_INVALID_ANCHOR_CERT = CSSM_TP_PRIVATE_ERROR + 19,
456 /* CRL failed policy verification */
457 CSSMERR_APPLETP_CRL_POLICY_FAIL = CSSM_TP_PRIVATE_ERROR + 20,
458 /* IssuingDistributionPoint extension violation */
459 CSSMERR_APPLETP_IDP_FAIL = CSSM_TP_PRIVATE_ERROR + 21,
460 /* Cert not found at specified issuerAltName */
461 CSSMERR_APPLETP_CERT_NOT_FOUND_FROM_ISSUER = CSSM_TP_PRIVATE_ERROR + 22,
462 /* Bad cert obtained from specified issuerAltName */
463 CSSMERR_APPLETP_BAD_CERT_FROM_ISSUER = CSSM_TP_PRIVATE_ERROR + 23,
464 /* S/MIME Email address mismatch */
465 CSSMERR_APPLETP_SMIME_EMAIL_ADDRS_NOT_FOUND = CSSM_TP_PRIVATE_ERROR + 24,
466 /* Appropriate S/MIME ExtendedKeyUsage not found */
467 CSSMERR_APPLETP_SMIME_BAD_EXT_KEY_USE = CSSM_TP_PRIVATE_ERROR + 25,
468 /* S/MIME KeyUsage incompatibility */
469 CSSMERR_APPLETP_SMIME_BAD_KEY_USE = CSSM_TP_PRIVATE_ERROR + 26,
470 /* S/MIME, cert with KeyUsage flagged !critical */
471 CSSMERR_APPLETP_SMIME_KEYUSAGE_NOT_CRITICAL = CSSM_TP_PRIVATE_ERROR + 27,
472 /* S/MIME, leaf with empty subject name and no email addrs
473 * in SubjectAltName */
474 CSSMERR_APPLETP_SMIME_NO_EMAIL_ADDRS = CSSM_TP_PRIVATE_ERROR + 28,
427c49bc 475 /* S/MIME, leaf with empty subject name, SubjectAltName
b1ab9ed8
A
476 * not critical */
477 CSSMERR_APPLETP_SMIME_SUBJ_ALT_NAME_NOT_CRIT = CSSM_TP_PRIVATE_ERROR + 29,
478 /* Appropriate SSL ExtendedKeyUsage not found */
479 CSSMERR_APPLETP_SSL_BAD_EXT_KEY_USE = CSSM_TP_PRIVATE_ERROR + 30,
480 /* unparseable OCSP response */
481 CSSMERR_APPLETP_OCSP_BAD_RESPONSE = CSSM_TP_PRIVATE_ERROR + 31,
482 /* unparseable OCSP request */
483 CSSMERR_APPLETP_OCSP_BAD_REQUEST = CSSM_TP_PRIVATE_ERROR + 32,
484 /* OCSP service unavailable */
485 CSSMERR_APPLETP_OCSP_UNAVAILABLE = CSSM_TP_PRIVATE_ERROR + 33,
486 /* OCSP status: cert unrecognized */
487 CSSMERR_APPLETP_OCSP_STATUS_UNRECOGNIZED = CSSM_TP_PRIVATE_ERROR + 34,
488 /* revocation check not successful for each cert */
489 CSSMERR_APPLETP_INCOMPLETE_REVOCATION_CHECK = CSSM_TP_PRIVATE_ERROR + 35,
490 /* general network error */
491 CSSMERR_APPLETP_NETWORK_FAILURE = CSSM_TP_PRIVATE_ERROR + 36,
492 /* OCSP response not verifiable to anchor or root */
493 CSSMERR_APPLETP_OCSP_NOT_TRUSTED = CSSM_TP_PRIVATE_ERROR + 37,
494 /* OCSP response verified to untrusted root */
495 CSSMERR_APPLETP_OCSP_INVALID_ANCHOR_CERT = CSSM_TP_PRIVATE_ERROR + 38,
496 /* OCSP response signature error */
497 CSSMERR_APPLETP_OCSP_SIG_ERROR = CSSM_TP_PRIVATE_ERROR + 39,
498 /* No signer for OCSP response found */
499 CSSMERR_APPLETP_OCSP_NO_SIGNER = CSSM_TP_PRIVATE_ERROR + 40,
500 /* OCSP responder status: malformed request */
501 CSSMERR_APPLETP_OCSP_RESP_MALFORMED_REQ = CSSM_TP_PRIVATE_ERROR + 41,
502 /* OCSP responder status: internal error */
503 CSSMERR_APPLETP_OCSP_RESP_INTERNAL_ERR = CSSM_TP_PRIVATE_ERROR + 42,
504 /* OCSP responder status: try later */
505 CSSMERR_APPLETP_OCSP_RESP_TRY_LATER = CSSM_TP_PRIVATE_ERROR + 43,
506 /* OCSP responder status: signature required */
507 CSSMERR_APPLETP_OCSP_RESP_SIG_REQUIRED = CSSM_TP_PRIVATE_ERROR + 44,
508 /* OCSP responder status: unauthorized */
509 CSSMERR_APPLETP_OCSP_RESP_UNAUTHORIZED = CSSM_TP_PRIVATE_ERROR + 45,
510 /* OCSP response nonce did not match request */
511 CSSMERR_APPLETP_OCSP_NONCE_MISMATCH = CSSM_TP_PRIVATE_ERROR + 46,
512 /* Illegal cert chain length for Code Signing */
513 CSSMERR_APPLETP_CS_BAD_CERT_CHAIN_LENGTH = CSSM_TP_PRIVATE_ERROR + 47,
514 /* Missing Basic Constraints for Code Signing */
515 CSSMERR_APPLETP_CS_NO_BASIC_CONSTRAINTS = CSSM_TP_PRIVATE_ERROR + 48,
516 /* Bad PathLengthConstraint for Code Signing */
517 CSSMERR_APPLETP_CS_BAD_PATH_LENGTH = CSSM_TP_PRIVATE_ERROR + 49,
518 /* Missing ExtendedKeyUsage for Code Signing */
519 CSSMERR_APPLETP_CS_NO_EXTENDED_KEY_USAGE = CSSM_TP_PRIVATE_ERROR + 50,
520 /* Development style Code Signing Cert Detected */
521 CSSMERR_APPLETP_CODE_SIGN_DEVELOPMENT = CSSM_TP_PRIVATE_ERROR + 51,
522 /* Illegal cert chain length for Resource Signing */
523 CSSMERR_APPLETP_RS_BAD_CERT_CHAIN_LENGTH = CSSM_TP_PRIVATE_ERROR + 52,
427c49bc 524 /* Bad extended key usage for Resource Signing */
b1ab9ed8
A
525 CSSMERR_APPLETP_RS_BAD_EXTENDED_KEY_USAGE = CSSM_TP_PRIVATE_ERROR + 53,
526 /* Trust Setting: deny */
527 CSSMERR_APPLETP_TRUST_SETTING_DENY = CSSM_TP_PRIVATE_ERROR + 54,
427c49bc 528 /* Invalid empty SubjectName */
b1ab9ed8 529 CSSMERR_APPLETP_INVALID_EMPTY_SUBJECT = CSSM_TP_PRIVATE_ERROR + 55,
427c49bc 530 /* Unknown critical Qualified Cert Statement ID */
b1ab9ed8
A
531 CSSMERR_APPLETP_UNKNOWN_QUAL_CERT_STATEMENT = CSSM_TP_PRIVATE_ERROR + 56,
532 /* Missing required extension */
533 CSSMERR_APPLETP_MISSING_REQUIRED_EXTENSION = CSSM_TP_PRIVATE_ERROR + 57,
534 /* Extended key usage not marked critical */
427c49bc
A
535 CSSMERR_APPLETP_EXT_KEYUSAGE_NOT_CRITICAL = CSSM_TP_PRIVATE_ERROR + 58,
536 /* Required name or identifier not present */
537 CSSMERR_APPLETP_IDENTIFIER_MISSING = CSSM_TP_PRIVATE_ERROR + 59
b1ab9ed8
A
538};
539
540/* Apple .mac TP private error codes. */
427c49bc 541enum
b1ab9ed8
A
542{
543 /* cert request queued */
544 CSSMERR_APPLE_DOTMAC_REQ_QUEUED = CSSM_TP_PRIVATE_ERROR + 100,
545 /* cert request redirected */
546 CSSMERR_APPLE_DOTMAC_REQ_REDIRECT = CSSM_TP_PRIVATE_ERROR + 101,
547 /* general server-reported error */
548 CSSMERR_APPLE_DOTMAC_REQ_SERVER_ERR = CSSM_TP_PRIVATE_ERROR + 102,
549 /* server-reported parameter error */
550 CSSMERR_APPLE_DOTMAC_REQ_SERVER_PARAM = CSSM_TP_PRIVATE_ERROR + 103,
551 /* server-reported authorization error */
552 CSSMERR_APPLE_DOTMAC_REQ_SERVER_AUTH = CSSM_TP_PRIVATE_ERROR + 104,
553 /* server-reported unimplemented */
554 CSSMERR_APPLE_DOTMAC_REQ_SERVER_UNIMPL = CSSM_TP_PRIVATE_ERROR + 105,
555 /* server-reported not available */
556 CSSMERR_APPLE_DOTMAC_REQ_SERVER_NOT_AVAIL = CSSM_TP_PRIVATE_ERROR + 106,
557 /* server-reported already exists */
558 CSSMERR_APPLE_DOTMAC_REQ_SERVER_ALREADY_EXIST = CSSM_TP_PRIVATE_ERROR + 107,
559 /* server-reported service error */
560 CSSMERR_APPLE_DOTMAC_REQ_SERVER_SERVICE_ERROR = CSSM_TP_PRIVATE_ERROR + 108,
561 /* request already pending for specified user */
562 CSSMERR_APPLE_DOTMAC_REQ_IS_PENDING = CSSM_TP_PRIVATE_ERROR + 109,
563 /* no request pending for specified user */
564 CSSMERR_APPLE_DOTMAC_NO_REQ_PENDING = CSSM_TP_PRIVATE_ERROR + 110,
565 /* CSR failed to verify */
566 CSSMERR_APPLE_DOTMAC_CSR_VERIFY_FAIL = CSSM_TP_PRIVATE_ERROR + 111,
567 /* server reported failed consistency check */
568 CSSMERR_APPLE_DOTMAC_FAILED_CONSISTENCY_CHECK = CSSM_TP_PRIVATE_ERROR + 112
569};
570
571enum
572{
573 CSSM_APPLEDL_OPEN_PARAMETERS_VERSION = 1
574};
575
576enum cssm_appledl_open_parameters_mask
577{
578 kCSSM_APPLEDL_MASK_MODE = (1 << 0)
579};
580
581/* Pass a CSSM_APPLEDL_OPEN_PARAMETERS_PTR as the OpenParameters argument to
582 CSSM_DL_DbCreate or CSSM_DL_DbOpen. When using this struct, you must zero
583 out the entire struct before setting any additional parameters to ensure
584 forward compatibility. */
585typedef struct cssm_appledl_open_parameters
586{
587 uint32 length; /* Should be sizeof(CSSM_APPLEDL_OPEN_PARAMETERS). */
588 uint32 version; /* Should be CSSM_APPLEDL_OPEN_PARAMETERS_VERSION. */
589
590 /* If no OpenParameters are specified, autoCommit is on (!CSSM_FALSE) by default.
591 When autoCommit is on (!CSSM_FALSE), changes made to the Db are written to disk
592 before returning from each function.
593 When autoCommit is off (CSSM_FALSE), changes made to the database are not guaranteed
594 to be written to disk until the Db is closed. This is useful for bulk writes.
595 Be aware that if autoCommit is off, changes made in previous calls to the DL might
596 get rolled back if a new modification operation fails. */
597 CSSM_BOOL autoCommit;
598
599 /* Mask marking which of the following fields are to be used. */
600 uint32 mask;
601
602 /* When calling DbCreate, the initial mode to create the database file with; ignored on DbOpen. You must set the kCSSM_APPLEDL_MASK_MODE bit in mask or mode is ignored. */
603 mode_t mode;
604} CSSM_APPLEDL_OPEN_PARAMETERS, *CSSM_APPLEDL_OPEN_PARAMETERS_PTR;
605
606
607/* AppleCSPDL passthough ids */
608enum
609{
610 /* Tell the SecurityServer to lock the database specified by the DLDBHandle argument.
611 The InputParams and OutputParams arguments are ignored. */
612 CSSM_APPLECSPDL_DB_LOCK = 0,
613
614 /* Tell the SecurityServer to unlock the database specified by the DLDBHandle argument.
615 The InputParameters argument is a CSSM_DATA_PTR containing the password, or NULL if
616 the SecurityServer should prompt for the password.
617 The OutputParams argument is ignored.
618 The SecurityServer will put up UI (though the SecurityAgent) when this function is called
619 iff InputParameters is NULL. */
620 CSSM_APPLECSPDL_DB_UNLOCK = 1,
621
622 /* Ask the SecurityServer to get the db settings specified for the database
623 specified by the DLDBHandle argument. The settings are returned in the OutputParameters argument.
624 The OutputParameters argument is a pointer to a CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS_PTR.
625 Upon successful completion, the AppleCSPDL will have allocated a
626 CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS structure using the application-specified
627 allocators for the DL attachment specified by the DLDBHandle argument. The structure will contain
628 the current database settings for the specified database. The client should free the
629 CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS_PTR after it has finished using it.
630 The InputParameters argument is ignored.
631 The SecurityServer might put up UI (though the SecurityAgent) when this function is called. */
632 CSSM_APPLECSPDL_DB_GET_SETTINGS = 2,
633
634 /* Tell the SecurityServer to set the db settings specified in InputParameters on the database
635 specified by the DLDBHandle argument.
636 The InputParameters argument is a const CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS * containing
637 the new settings for the specified database.
638 The OutputParams argument is ignored.
639 The SecurityServer might put up UI (though the SecurityAgent) when this function is called. */
640 CSSM_APPLECSPDL_DB_SET_SETTINGS = 3,
641
642 /* Ask the SecurityServer whether the database specified by the DLDBHandle argument is locked.
643 The InputParameters argument is ignored.
644 The OutputParameters argument is a pointer to a CSSM_APPLECSPDL_DB_IS_LOCKED_PARAMETERS_PTR.
645 Upon successful completion, the AppleCSPDL will have allocated a
646 CSSM_APPLECSPDL_DB_IS_LOCKED_PARAMETERS structure using the application-specified
647 allocators for the DL attachment specified by the DLDBHandle argument. The structure will contain
648 the current lock status for the specified database. The client should free the
649 CSSM_APPLECSPDL_DB_IS_LOCKED_PARAMETERS_PTR after it has finished using it.
650 The SecurityServer will put up UI (though the SecurityAgent) when this function is called. */
651 CSSM_APPLECSPDL_DB_IS_LOCKED = 4,
652
653 /* Tell the SecurityServer to change the password for the database specified by
654 the DLDBHandle.
655
656 The InputParameters argument is a const CSSM_APPLECSPDL_DB_CHANGE_PASSWORD_PARAMETERS * containing
657 a CSSM_ACCESS_CREDENTIALS * which determines how the password will be changed. If the
658 accessCredentials are NULL, the SecurityAgent will prompt for the old and the new password for the
659 specified database. If credentials are specified, there should be 2 entries:
660 1. a 3-element list containing:
661 CSSM_WORDID_KEYCHAIN_LOCK, CSSM_SAMPLE_TYPE_PASSWORD, and the old password.
662 2. a 3-element list containing:
663 CSSM_WORDID_KEYCHAIN_CHANGE_LOCK, CSSM_SAMPLE_TYPE_PASSWORD, and the new password.
664
665 The OutputParams argument is ignored.
666 The SecurityServer might put up UI (though the SecurityAgent) when this function is called. */
667 CSSM_APPLECSPDL_DB_CHANGE_PASSWORD =5,
427c49bc 668
b1ab9ed8
A
669 /* Return the SecurityServer database handle for the database specified by the DLDBHandle */
670 CSSM_APPLECSPDL_DB_GET_HANDLE = 6,
427c49bc 671
b1ab9ed8
A
672 /* Given a CSSM_KEY for the CSPDL, return the SecurityServer key handle */
673 CSSM_APPLESCPDL_CSP_GET_KEYHANDLE = 7,
427c49bc 674
b1ab9ed8
A
675 CSSM_APPLE_PRIVATE_CSPDL_CODE_8 = 8,
676 CSSM_APPLE_PRIVATE_CSPDL_CODE_9 = 9,
677 CSSM_APPLE_PRIVATE_CSPDL_CODE_10 = 10,
678 CSSM_APPLE_PRIVATE_CSPDL_CODE_11 = 11,
679 CSSM_APPLE_PRIVATE_CSPDL_CODE_12 = 12,
680 CSSM_APPLE_PRIVATE_CSPDL_CODE_13 = 13,
681 CSSM_APPLE_PRIVATE_CSPDL_CODE_14 = 14,
682 CSSM_APPLE_PRIVATE_CSPDL_CODE_15 = 15,
683 CSSM_APPLE_PRIVATE_CSPDL_CODE_16 = 16,
427c49bc
A
684 CSSM_APPLE_PRIVATE_CSPDL_CODE_17 = 17,
685 CSSM_APPLE_PRIVATE_CSPDL_CODE_18 = 18,
686
687 /* Given a CSSM_KEY_PTR in any format, obtain the SHA-1 hash of the
688 * associated key blob.
b1ab9ed8
A
689 * Key is specified in CSSM_CSP_CreatePassThroughContext.
690 * Hash is allocated bythe CSP, in the App's memory, and returned
691 * in *outData. */
427c49bc 692 CSSM_APPLECSP_KEYDIGEST = 0x100
b1ab9ed8
A
693};
694
695
696
697/* AppleCSPDL passthough parameters */
698typedef struct cssm_applecspdl_db_settings_parameters
699{
700 uint32 idleTimeout; // seconds idle timeout lock
701 uint8 lockOnSleep; // lock database when system sleeps
702} CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS, *CSSM_APPLECSPDL_DB_SETTINGS_PARAMETERS_PTR;
703
704/* AppleCSPDL passthough parameters */
705typedef struct cssm_applecspdl_db_is_locked_parameters
706{
707 uint8 isLocked; // True iff the database is locked
708} CSSM_APPLECSPDL_DB_IS_LOCKED_PARAMETERS, *CSSM_APPLECSPDL_DB_IS_LOCKED_PARAMETERS_PTR;
709
710/* AppleCSPDL passthough parameters */
711typedef struct cssm_applecspdl_db_change_password_parameters
712{
713 CSSM_ACCESS_CREDENTIALS *accessCredentials;
714} CSSM_APPLECSPDL_DB_CHANGE_PASSWORD_PARAMETERS, *CSSM_APPLECSPDL_DB_CHANGE_PASSWORD_PARAMETERS_PTR;
715
716/* Custom wrapped key formats */
717enum {
718 CSSM_KEYBLOB_WRAPPED_FORMAT_APPLE_CUSTOM = 100,
427c49bc 719 CSSM_KEYBLOB_WRAPPED_FORMAT_OPENSSL, // traditional openssl
b1ab9ed8
A
720 CSSM_KEYBLOB_WRAPPED_FORMAT_OPENSSH1 // OpenSSH v1
721};
722
723/*
724 * Custom context attributes for AppleCSP.
725 */
726enum {
727 CSSM_ATTRIBUTE_VENDOR_DEFINED = 0x800000
728};
729
730enum {
427c49bc 731 /*
b1ab9ed8
A
732 * Public Key attribute for use with CSSM_ALGID_FEED.
733 */
427c49bc 734 CSSM_ATTRIBUTE_PUBLIC_KEY =
b1ab9ed8 735 (CSSM_ATTRIBUTE_DATA_KEY | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 0)),
427c49bc 736
b1ab9ed8
A
737 /*
738 * FEE key attributes.
739 * See CSSM_FEE_PRIME_TYPE_xxx, CSSM_FEE_CURVE_TYPE_xxx enums, below.
740 */
427c49bc 741 CSSM_ATTRIBUTE_FEE_PRIME_TYPE =
b1ab9ed8 742 (CSSM_ATTRIBUTE_DATA_UINT32 | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 1)),
427c49bc 743 CSSM_ATTRIBUTE_FEE_CURVE_TYPE =
b1ab9ed8 744 (CSSM_ATTRIBUTE_DATA_UINT32 | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 2)),
427c49bc 745
b1ab9ed8
A
746 /*
747 * Apple Secure Compression (ComCryption) optimization.
748 * See CSSM_ASC_OPTIMIZE_xxx, enums, below.
749 */
427c49bc 750 CSSM_ATTRIBUTE_ASC_OPTIMIZATION =
b1ab9ed8 751 (CSSM_ATTRIBUTE_DATA_UINT32 | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 3)),
427c49bc 752
b1ab9ed8
A
753 /*
754 * RSA blinding. Value is integer, nonzero (blinding on) or zero.
755 */
427c49bc 756 CSSM_ATTRIBUTE_RSA_BLINDING =
b1ab9ed8 757 (CSSM_ATTRIBUTE_DATA_UINT32 | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 4)),
427c49bc 758
b1ab9ed8
A
759 /*
760 * Additional public key from which to obtain algorithm-specific
761 * parameters.
762 */
427c49bc 763 CSSM_ATTRIBUTE_PARAM_KEY =
b1ab9ed8 764 (CSSM_ATTRIBUTE_DATA_KEY | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 5)),
427c49bc 765
b1ab9ed8
A
766 /*
767 * Prompt string for CSSM_ALGID_SECURE_PASSPHRASE key acquisition.
427c49bc 768 * Data is a UTF8-encoded external representation of a CFString.
b1ab9ed8 769 */
427c49bc 770 CSSM_ATTRIBUTE_PROMPT =
b1ab9ed8
A
771 (CSSM_ATTRIBUTE_DATA_CSSM_DATA | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 6)),
772
773 /*
774 * Alert panel title for CSSM_ALGID_SECURE_PASSPHRASE key acquisition.
427c49bc 775 * Data is a UTF8-encoded external representation of a CFString.
b1ab9ed8 776 */
427c49bc 777 CSSM_ATTRIBUTE_ALERT_TITLE =
b1ab9ed8
A
778 (CSSM_ATTRIBUTE_DATA_CSSM_DATA | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 7)),
779
780 /*
427c49bc
A
781 * Boolean to specify whether secure passphrase is being used to encrypt or to
782 * recover data. In the former case the user will be prompted to enter the
b1ab9ed8
A
783 * passphrase twice. Value is integer, nonzero (verify passphrase) or zero.
784 */
427c49bc 785 CSSM_ATTRIBUTE_VERIFY_PASSPHRASE =
b1ab9ed8
A
786 (CSSM_ATTRIBUTE_DATA_UINT32 | (CSSM_ATTRIBUTE_VENDOR_DEFINED + 8))
787
788};
789
790/*
791 * FEE key pair prime modulus types.
792 */
793enum {
794 CSSM_FEE_PRIME_TYPE_DEFAULT = 0, /* default per key size */
795