SpAddCredentialsFn callback function (ntsecpkg.h)

Article
10/13/2021

Used to add credentials for a security principal.

Syntax

SpAddCredentialsFn Spaddcredentialsfn;

NTSTATUS Spaddcredentialsfn(
  [in]  LSA_SEC_HANDLE CredentialHandle,
  [in]  PUNICODE_STRING PrincipalName,
  [in]  PUNICODE_STRING Package,
  [in]  ULONG CredentialUseFlags,
  [in]  PVOID AuthorizationData,
        PVOID GetKeyFunciton,
  [in]  PVOID GetKeyArgument,
  [out] PTimeStamp ExpirationTime
)
{...}

Parameters

[in] CredentialHandle

A handle to the credential to add.

[in] PrincipalName

Optional. Pointer to a UNICODE_STRING structure containing the name of the security principal whose credentials are being added.

[in] Package

Pointer to a UNICODE_STRING structure containing the name of the authenticating package.

[in] CredentialUseFlags

Flags indicating how the credentials will be used. The following values are valid.

Value	Meaning
SECPKG_CRED_INBOUND	Credentials will be used with the AcceptSecurityContext (General) function.
SECPKG_CRED_OUTBOUND	Credentials will be used with the InitializeSecurityContext (General) function.

[in] AuthorizationData

Optional. Pointer to supplemental authentication data.

GetKeyFunciton

[in] GetKeyArgument

Pointer to the argument used with the GetKeyFunction function.

[out] ExpirationTime

Pointer to a TimeStamp that receives the time the credentials handle expires.

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 SpAddCredentials function; however, the actual name given to the implementation is up to the developer.

A pointer to the SpAddCredentials function is available in 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