OSX/libsecurity_cssm/lib/emmspi.h

   1 /*
   2  * Copyright (c) 1999-2001,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  * emmspi.h -- Service Provider Interface for Elective Module Managers
  24  */
  25
  26 #ifndef _EMMSPI_H_
  27 #define _EMMSPI_H_  1
  28
  29 #include <Security/cssmtype.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #pragma clang diagnostic push
  36 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  37
  38 typedef struct cssm_state_funcs {
  39     CSSM_RETURN (CSSMAPI *cssm_GetAttachFunctions)
  40         (CSSM_MODULE_HANDLE hAddIn,
  41          CSSM_SERVICE_MASK AddinType,
  42          void **SPFunctions,
  43          CSSM_GUID_PTR Guid,
  44          CSSM_BOOL *Serialized);
  45     CSSM_RETURN (CSSMAPI *cssm_ReleaseAttachFunctions)
  46         (CSSM_MODULE_HANDLE hAddIn);
  47     CSSM_RETURN (CSSMAPI *cssm_GetAppMemoryFunctions)
  48         (CSSM_MODULE_HANDLE hAddIn,
  49          CSSM_UPCALLS_PTR UpcallTable);
  50     CSSM_RETURN (CSSMAPI *cssm_IsFuncCallValid)
  51         (CSSM_MODULE_HANDLE hAddin,
  52          CSSM_PROC_ADDR SrcAddress,
  53          CSSM_PROC_ADDR DestAddress,
  54          CSSM_PRIVILEGE InPriv,
  55          CSSM_PRIVILEGE *OutPriv,
  56          CSSM_BITMASK Hints,
  57          CSSM_BOOL *IsOK);
  58     CSSM_RETURN (CSSMAPI *cssm_DeregisterManagerServices)
  59         (const CSSM_GUID *GUID);
  60     CSSM_RETURN (CSSMAPI *cssm_DeliverModuleManagerEvent)
  61         (const CSSM_MANAGER_EVENT_NOTIFICATION *EventDescription);
  62 } CSSM_STATE_FUNCS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER, *CSSM_STATE_FUNCS_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
  63
  64 typedef struct cssm_manager_registration_info {
  65     /* loading, unloading, dispatch table, and event notification */
  66     CSSM_RETURN (CSSMAPI *Initialize)
  67         (uint32 VerMajor,
  68          uint32 VerMinor);
  69     CSSM_RETURN (CSSMAPI *Terminate) (void);
  70     CSSM_RETURN (CSSMAPI *RegisterDispatchTable)
  71         (CSSM_STATE_FUNCS_PTR CssmStateCallTable);
  72     CSSM_RETURN (CSSMAPI *DeregisterDispatchTable) (void);
  73     CSSM_RETURN (CSSMAPI *EventNotifyManager)
  74         (const CSSM_MANAGER_EVENT_NOTIFICATION *EventDescription);
  75     CSSM_RETURN (CSSMAPI *RefreshFunctionTable)
  76         (CSSM_FUNC_NAME_ADDR_PTR FuncNameAddrPtr,
  77          uint32 NumOfFuncNameAddr);
  78 } CSSM_MANAGER_REGISTRATION_INFO DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER, *CSSM_MANAGER_REGISTRATION_INFO_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
  79
  80 enum {
  81         CSSM_HINT_NONE =                        0,
  82         CSSM_HINT_ADDRESS_APP =         1 << 0,
  83         CSSM_HINT_ADDRESS_SP =          1 << 1
  84 };
  85
  86 CSSM_RETURN CSSMAPI
  87 ModuleManagerAuthenticate (CSSM_KEY_HIERARCHY KeyHierarchy,
  88                            const CSSM_GUID *CssmGuid,
  89                            const CSSM_GUID *AppGuid,
  90                            CSSM_MANAGER_REGISTRATION_INFO_PTR FunctionTable)
  91                                                 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
  92
  93 #pragma clang diagnostic pop
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* _EMMSPI_H_ */