2 * Copyright (c) 1999-2001,2004,2011,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@
23 * cssmkrspi.h -- Service Provider Interface for Key Recovery Modules
27 #define _CSSMKRSPI_H_ 1
29 #include <Security/cssmtype.h>
35 #pragma clang diagnostic push
36 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
38 /* Data types for Key Recovery SPI */
40 typedef struct cssm_spi_kr_funcs
{
41 CSSM_RETURN (CSSMKRI
*RegistrationRequest
)
42 (CSSM_KRSP_HANDLE KRSPHandle
,
43 CSSM_CC_HANDLE KRRegistrationContextHandle
,
44 const CSSM_CONTEXT
*KRRegistrationContext
,
45 const CSSM_DATA
*KRInData
,
46 const CSSM_ACCESS_CREDENTIALS
*AccessCredentials
,
47 CSSM_KR_POLICY_FLAGS KRFlags
,
48 sint32
*EstimatedTime
,
49 CSSM_HANDLE_PTR ReferenceHandle
);
50 CSSM_RETURN (CSSMKRI
*RegistrationRetrieve
)
51 (CSSM_KRSP_HANDLE KRSPHandle
,
52 CSSM_HANDLE ReferenceHandle
,
53 sint32
*EstimatedTime
,
54 CSSM_KR_PROFILE_PTR KRProfile
);
55 CSSM_RETURN (CSSMKRI
*GenerateRecoveryFields
)
56 (CSSM_KRSP_HANDLE KRSPHandle
,
57 CSSM_CC_HANDLE KREnablementContextHandle
,
58 const CSSM_CONTEXT
*KREnablementContext
,
59 CSSM_CC_HANDLE CryptoContextHandle
,
60 const CSSM_CONTEXT
*CryptoContext
,
61 const CSSM_DATA
*KRSPOptions
,
62 CSSM_KR_POLICY_FLAGS KRFlags
,
63 CSSM_DATA_PTR KRFields
);
64 CSSM_RETURN (CSSMKRI
*ProcessRecoveryFields
)
65 (CSSM_KRSP_HANDLE KRSPHandle
,
66 CSSM_CC_HANDLE KREnablementContextHandle
,
67 const CSSM_CONTEXT
*KREnablementContext
,
68 CSSM_CC_HANDLE CryptoContextHandle
,
69 const CSSM_CONTEXT
*CryptoContext
,
70 const CSSM_DATA
*KRSPOptions
,
71 CSSM_KR_POLICY_FLAGS KRFlags
,
72 const CSSM_DATA
*KRFields
);
73 CSSM_RETURN (CSSMKRI
*RecoveryRequest
)
74 (CSSM_KRSP_HANDLE KRSPHandle
,
75 CSSM_CC_HANDLE KRRequestContextHandle
,
76 const CSSM_CONTEXT
*KRRequestContext
,
77 const CSSM_DATA
*KRInData
,
78 const CSSM_ACCESS_CREDENTIALS
*AccessCredentials
,
79 sint32
*EstimatedTime
,
80 CSSM_HANDLE_PTR ReferenceHandle
);
81 CSSM_RETURN (CSSMKRI
*RecoveryRetrieve
)
82 (CSSM_KRSP_HANDLE KRSPHandle
,
83 CSSM_HANDLE ReferenceHandle
,
84 sint32
*EstimatedTime
,
85 CSSM_HANDLE_PTR CacheHandle
,
86 uint32
*NumberOfRecoveredKeys
);
87 CSSM_RETURN (CSSMKRI
*GetRecoveredObject
)
88 (CSSM_KRSP_HANDLE KRSPHandle
,
89 CSSM_HANDLE CacheHandle
,
90 uint32 IndexInResults
,
91 CSSM_CSP_HANDLE CSPHandle
,
92 const CSSM_RESOURCE_CONTROL_CONTEXT
*CredAndAclEntry
,
94 CSSM_KEY_PTR RecoveredKey
,
95 CSSM_DATA_PTR OtherInfo
);
96 CSSM_RETURN (CSSMKRI
*RecoveryRequestAbort
)
97 (CSSM_KRSP_HANDLE KRSPHandle
,
98 CSSM_HANDLE ResultsHandle
);
99 CSSM_RETURN (CSSMKRI
*PassThrough
)
100 (CSSM_KRSP_HANDLE KRSPHandle
,
101 CSSM_CC_HANDLE KeyRecoveryContextHandle
,
102 const CSSM_CONTEXT
*KeyRecoveryContext
,
103 CSSM_CC_HANDLE CryptoContextHandle
,
104 const CSSM_CONTEXT
*CryptoContext
,
105 uint32 PassThroughId
,
106 const void *InputParams
,
107 void **OutputParams
);
108 } CSSM_SPI_KR_FUNCS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER
, *CSSM_SPI_KR_FUNCS_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER
;
110 #pragma clang diagnostic pop
116 #endif /* _CSSMKRSPI_H_ */