Windows Dev Center

IPSEC_KEY_MANAGER_DICTATE_KEY0 function pointer

The IPSEC_KEY_MANAGER_DICTATE_KEY0 function is used by the Trusted Intermediary Agent (TIA) to dictate keys for the SA being negotiated.

Syntax


typedef DWORD ( CALLBACK *IPSEC_KEY_MANAGER_DICTATE_KEY0)(
  _Inout_ IPSEC_SA_DETAILS1 *inboundSa,
  _Inout_ IPSEC_SA_DETAILS1 *outboundSa,
  _Out_   BOOL              *generateRandomKey
);

Parameters

inboundSa [in, out]

Type: IPSEC_SA_DETAILS1*

Information about the inbound SA.

outboundSa [in, out]

Type: IPSEC_SA_DETAILS1*

Information about the outbound SA.

generateRandomKey [out]

Type: BOOL*

True if the keying module should randomly generate keys in the event that the TIA is unable to supply keys; otherwise, false.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The keys were successfully dictated

FWP_E_* error code
0x80320001—0x80320039

A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.

RPC_* error code
0x80010001—0x80010122

Failure to communicate with the remote or local firewall engine.

 

Remarks

Call IPsecKeyManagerAddAndRegister0 to invoke this function pointer. If the weight specified in IPSEC_KEY_MANAGER_KEY_DICTATION_CHECK0 for a TIA is higher than that of any peer, IPSEC_KEY_MANAGER_DICTATE_KEY0 will be invoked.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Fwpmu.h

See also

WFP Functions
IPSEC_SA_DETAILS1
IPsecKeyManagerAddAndRegister0
IPSEC_KEY_MANAGER_KEY_DICTATION_CHECK0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft