SpAcceptCredentialsFn callback function (ntsecpkg.h)

Article
02/22/2024

Called by the Local Security Authority (LSA) to pass the security package any credentials stored for the authenticated security principal. This function is called once for each set of credentials stored by the LSA.

Syntax

SpAcceptCredentialsFn Spacceptcredentialsfn;

NTSTATUS Spacceptcredentialsfn(
  [in] SECURITY_LOGON_TYPE LogonType,
  [in] PUNICODE_STRING AccountName,
  [in] PSECPKG_PRIMARY_CRED PrimaryCredentials,
  [in] PSECPKG_SUPPLEMENTAL_CRED SupplementalCredentials
)
{...}

Parameters

[in] LogonType

A SECURITY_LOGON_TYPE value indicating the type of logon.

[in] AccountName

Pointer to a UNICODE_STRING structure specifying the name of the logged-on account.

[in] PrimaryCredentials

Pointer to a SECPKG_PRIMARY_CRED structure containing the credentials used to logon. This structure can have NULL members.

[in] SupplementalCredentials

Pointer to a SECPKG_SUPPLEMENTAL_CRED structure containing package-specific supplemental credentials.

Return value

If the function succeeds, return STATUS_SUCCESS.

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

Remarks

The security package should save the credentials so that it can service requests for credentials. For additional information, see the SpAcquireCredentialsHandle function.

SSP/APs must implement the SpAcceptCredentials function; unlike other SSP/AP functions the name of the function must be SpAcceptCredentials.

The LSA accesses the SpAcceptCredentials function through the SECPKG_FUNCTION_TABLE structure received from the SpLsaModeInitialize function.

Requirements

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