Expand Minimize

CryptEncryptMessage function

The CryptEncryptMessage function encrypts and encodes a message.

Syntax


BOOL WINAPI CryptEncryptMessage(
  _In_     PCRYPT_ENCRYPT_MESSAGE_PARA pEncryptPara,
  _In_     DWORD cRecipientCert,
  _In_     PCCERT_CONTEXT rgpRecipientCert[],
  _In_     const BYTE *pbToBeEncrypted,
  _In_     DWORD cbToBeEncrypted,
  _Out_    BYTE *pbEncryptedBlob,
  _Inout_  DWORD *pcbEncryptedBlob
);

Parameters

pEncryptPara [in]

A pointer to a CRYPT_ENCRYPT_MESSAGE_PARA structure that contains the encryption parameters.

The CryptEncryptMessage function does not support the SHA2 OIDs, szOID_DH_SINGLE_PASS_STDDH_SHA256_KDF and szOID_DH_SINGLE_PASS_STDDH_SHA384_KDF.

cRecipientCert [in]

Number of elements in the rgpRecipientCert array.

rgpRecipientCert [in]

Array of pointers to CERT_CONTEXT structures that contain the certificates of intended recipients of the message.

pbToBeEncrypted [in]

A pointer to a buffer that contains the message that is to be encrypted.

cbToBeEncrypted [in]

The size, in bytes, of the message that is to be encrypted.

pbEncryptedBlob [out]

A pointer to BLOB that contains a buffer that receives the encrypted and encoded message.

To set the size of this information for memory allocation purposes, this parameter can be NULL. For more information, see Retrieving Data of Unknown Length.

pcbEncryptedBlob [in, out]

A pointer to a DWORD that specifies the size, in bytes, of the buffer pointed to by the pbEncryptedBlob parameter. When the function returns, this variable contains the size, in bytes, of the encrypted and encoded message copied to pbEncryptedBlob.

Note  When processing the data returned in the buffer of the pbEncryptedBlob, applications need to use the actual size of the data returned. The actual size can be slightly smaller than the size of the buffer specified on input. (On input, buffer sizes are usually specified large enough to ensure that the largest possible output data will fit in the buffer.) On output, the variable pointed to by this parameter is updated to reflect the actual size of the data copied to the buffer.

Return value

If the function succeeds, the function returns nonzero (TRUE).

If the function fails, it returns zero (FALSE). For extended error information, call GetLastError.

Note  Errors from calls to CryptGenKey, CryptEncrypt, CryptImportKey, and CryptExportKey can be propagated to this function.

The GetLastError function returns the following error codes most often.

Return codeDescription
ERROR_MORE_DATA

If the buffer specified by the pbEncryptedBlob parameter is not large enough to hold the returned data, the function sets the ERROR_MORE_DATA code and stores the required buffer size, in bytes, in the variable pointed to by pcbEncryptedBlob.

E_INVALIDARG

The message encoding type is not valid. Currently only PKCS_7_ASN_ENCODING is supported. The cbSize in *pEncryptPara is not valid.

 

If the function fails, GetLastError may return an Abstract Syntax Notation One (ASN.1) encoding/decoding error. For information about these errors, see ASN.1 Encoding/Decoding Return Values.

Examples

For an example that uses this function, see Example C Program: Using CryptEncryptMessage and CryptDecryptMessage.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Wincrypt.h

Library

Crypt32.lib

DLL

Crypt32.dll

See also

Simplified Message Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft