Export (0) Print
Expand All
Expand Minimize

PFN_CMSG_CNG_IMPORT_KEY_AGREE function pointer

The PFN_CMSG_CNG_IMPORT_KEY_AGREE callback function decrypts a content encryption key (CEK) that is intended for a key agreement recipient. PFN_CMSG_CNG_IMPORT_KEY_AGREE can be installed by using a Cryptography API: Next Generation (CNG) object identifier (OID).

Syntax


typedef BOOL ( WINAPI *PFN_CMSG_CNG_IMPORT_KEY_AGREE)(
  _Inout_     PCMSG_CNG_CONTENT_DECRYPT_INFO pCNGContentDecryptInfo,
  _In_        PCMSG_CTRL_KEY_AGREE_DECRYPT_PARA pKeyAgreeDecryptPara,
  _In_        DWORD dwFlags,
  _Reserved_  void *pvReserved
);

Parameters

pCNGContentDecryptInfo [in, out]

A pointer to a CMSG_CNG_CONTENT_DECRYPT_INFO structure to be updated with the decrypted CEK bytes. This parameter contains the key used to decrypt the CEK. The following pKeyTransDecryptPara parameter contains the CEK bytes to be decrypted.

pKeyAgreeDecryptPara [in]

A pointer to a CMSG_CTRL_KEY_AGREE_DECRYPT_PARA structure that contains the key agreement information passed to the CryptMsgControl function in the CMSG_CTRL_KEY_AGREE_DECRYPT case.

The EncryptedKey member of the pKeyAgree member contains the CEK bytes to be decrypted. Because a CMSG_CTRL_KEY_AGREE_DECRYPT_PARA structure might contain an HCRYPTPROV choice, its hNCryptKey member must not be used to decrypt EncryptedKey. Instead, you must use the hNCryptKey member specified in the pCNGContentDecryptInfo parameter.

This function must not update members of the CMSG_CTRL_KEY_AGREE_DECRYPT_PARA structure.

dwFlags [in]

This parameter is reserved. Set it to zero.

pvReserved

This parameter is reserved. Set it to NULL.

Return value

If the function succeeds, the return value is nonzero (TRUE).

If the function fails, the return value is zero (FALSE). For extended error information, call GetLastError.

If this callback function does not support the key encryption algorithm, it must return FALSE and call SetLastError with ERROR_NOT_SUPPORTED.

Remarks

The CryptMsgControl function calls this function for the following operations specified by the dwCtrlType parameter:

CMSG_CTRL_KEY_AGREE_DECRYPT

You can use OID Support Functions to deploy this callback function. Wincrypt.h defines the following constant for this purpose.

ConstantDefinition
CMSG_OID_CNG_IMPORT_KEY_AGREE_FUNC"CryptMsgDllCNGImportKeyAgree"

 

Examples

For an example that deploys an OID-installable callback function, see Extending CryptoAPI Functionality.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wincrypt.h

See also

Decoding Enveloped Data

 

 

Community Additions

ADD
Show:
© 2014 Microsoft