Função ApplyControlToken (sspi.h)

Artigo
08/26/2023

A função ApplyControlToken fornece uma maneira de aplicar um token de controle a um contexto de segurança. Um token pode ser recebido quando o contexto de segurança está sendo estabelecido por uma chamada para a função InitializeSecurityContext (Schannel) ou com um serviço de segurança por mensagem, como verificar ou desmarcar.

Essa função tem suporte apenas pelo SSP ( provedor de suporte de segurança ) do Schannel.

Não há suporte para essa função no modo kernel.

Essa função permite que tokens adicionais ou de substituição sejam aplicados a um contexto.

Sintaxe

KSECDDDECLSPEC SECURITY_STATUS SEC_ENTRY ApplyControlToken(
  [in] PCtxtHandle    phContext,
  [in] PSecBufferDesc pInput
);

Parâmetros

[in] phContext

Um identificador para o contexto ao qual o token é aplicado.

Para obter informações sobre como o SSP do Schannel notifica a parte remota do desligamento, consulte a seção Comentários de DecryptMessage (Schannel). Para obter informações adicionais sobre o uso dessa função, consulte Desligando uma conexão Schannel.

[in] pInput

Um ponteiro para uma estrutura SecBufferDesc que contém um ponteiro para uma estrutura SecBuffer que contém o token de entrada a ser aplicado ao contexto.

Retornar valor

Se a função for bem-sucedida, a função retornará SEC_E_OK.

Se a função falhar, ela retornará um código de erro diferente de zero. O código de erro a seguir é um dos códigos de erro possíveis que podem ser retornados.

Código de retorno	Descrição
SEC_E_UNSUPPORTED_FUNCTION	Esse valor é retornado pelo modo kernel Schannel para indicar que essa função não tem suporte.

Comentários

A função ApplyControlToken pode modificar o contexto com base nesse token. Entre os tokens que essa função pode adicionar ao contexto do cliente estão SCHANNEL_ALERT_TOKEN e SCHANNEL_SESSION_TOKEN.

Essa função pode ser usada para desligar o contexto de segurança subjacente a uma conexão Schannel existente. Para obter informações sobre como fazer isso, consulte Desligando uma conexão Schannel.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	sspi.h (inclua Security.h)
Biblioteca	Secur32.lib
DLL	Secur32.dll