CryptSignMessageWithKey (Compact 2013)

3/28/2014

This function signs a message by using a cryptographic service provider's (CSP's) private key specified in the parameters. A placeholder SignerId is created and stored in the message.

Syntax

BOOL WINAPI CryptSignMessageWithKey(
    __in PCRYPT_KEY_SIGN_MESSAGE_PARA pSignPara,
    __in const BYTE *pbToBeSigned,
    __in DWORD cToBeSigned,
    __out BYTE *pbSignedBlob,
    __inout DWORD *pcbSignedBlob
);

Parameters

• pSignPara
  [in] A pointer to a CRYPT_KEY_SIGN_MESSAGE_PARA structure that contains the signature parameters.

• pbToBeSigned
  [in] A pointer to a buffer array that contains the message to be signed.

• cbToBeSigned
  [in] The number of array elements in the pbToBeSigned buffer array.

• pbSignedBlob
  [out] A pointer to a buffer to receive the encoded signed message.

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

• pcbSignedBlob
  [in, out] A pointer to a DWORD value that indicates the size, in bytes, of the pbSignedBlob buffer. When the function returns, this variable contains the size, in bytes, of the signed and encoded message.

  Note

  When processing the data returned, applications must 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 return value is nonzero (TRUE).

If the function fails, the return value is zero (FALSE).

For extended error information, call GetLastError.

The following lists the error codes most commonly returned by the GetLastError function.

Error code	Description
ERROR_MORE_DATA	If the buffer specified by the pbSignedBlob 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, into the variable pointed to by pcbSignedBlob.
E_INVALIDARG	The message encoding type is not valid. Currently only PKCS_7_ASN_ENCODING is supported. The cbSize in *pSignPara is not valid.
CRYPT_E_NO_KEY_PROPERTY	The pSigningCert in *pSignPara does not have a CERT_KEY_PROV_INFO_PROP_ID or CERT_KEY_CONTEXT_PROP_ID property.

Requirements

Header	wincrypt.h
Library	crypt32.lib

See Also

Reference

Certificates Functions