SpUnsealMessageFn callback function (ntsecpkg.h)

Decrypts a message that was previously encrypted with the SpSealMessage function.

The SpUnsealMessage function is the dispatch function for the DecryptMessage (General) function of the Security Support Provider Interface.

Syntax

SpUnsealMessageFn Spunsealmessagefn;

NTSTATUS Spunsealmessagefn(
  LSA_SEC_HANDLE ContextHandle,
  PSecBufferDesc MessageBuffers,
  ULONG MessageSequenceNumber,
  PULONG QualityOfProtection
)
{...}

Parameters

ContextHandle

Handle of the security context used to seal the message.

MessageBuffers

Pointer to a SecBufferDesc structure that contains the message buffers and a signature buffer.

MessageSequenceNumber

Sequence number to assign to the message. Sequence numbers are optional and are used as protection against loss and insertion of messages. A value of zero indicates that sequence numbers are not in use.

QualityOfProtection

Not used.

Return value

If the function succeeds, return STATUS_SUCCESS.

If the function fails, return an NTSTATUS code that indicates the reason it failed.

Remarks

SSP/APs must implement the SpUnsealMessage function; however, the actual name given to the implementation is up to the developer.

A pointer to the SpUnsealMessage function is available in the SECPKG_USER_FUNCTION_TABLE structure received from the SpUserModeInitialize function.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header ntsecpkg.h

See also

DecryptMessage (General)

SECPKG_USER_FUNCTION_TABLE

SpSealMessage

SpUserModeInitialize