SecureTransport/ModuleAttacher.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /*
  20  * ModuleAttacher.h
  21  *
  22  * Process-wide class which loads and attaches to {CSP, TP, CL} at most
  23  * once, and detaches and unloads the modules when this code is unloaded.
  24  */
  25
  26 #ifndef _MODULE_ATTACHER_H_
  27 #define _MODULE_ATTACHER_H_
  28
  29 #include <Security/cssmtype.h>
  30 #include "sslBuildFlags.h"
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /*
  37  * Load and attach to all three modules.
  38  * Returns CSSMERR_CSSM_ADDIN_LOAD_FAILED or CSSM_OK.
  39  */
  40 extern CSSM_RETURN attachToModules(
  41         CSSM_CSP_HANDLE         *cspHand,
  42         CSSM_CL_HANDLE          *clHand,
  43         CSSM_TP_HANDLE          *tpHand
  44         #if ST_FAKE_KEYCHAIN || ST_FAKE_GET_CSPDL_HANDLE
  45         ,
  46         /* manually attach to secure CSP/DL; eventually we get this from
  47          * SecKeychainAPI */
  48         CSSM_CSP_HANDLE         *cspDlHandle
  49         #endif
  50         );
  51
  52 #ifdef  __cplusplus
  53 }
  54 #endif
  55
  56 #endif  /* _CSP_ATTACHER_H_ */