Função WsRequestSecurityToken (webservices.h)

Obtenha um token de segurança de um STS (serviço de token de segurança) que atua como emissor de token em um cenário de federação. Essa função é usada no lado do cliente e executa as etapas de negociação baseadas em WS-Trust com o STS até que o token de segurança seja obtido ou o processo de negociação falhe.

Sintaxe

HRESULT WsRequestSecurityToken(
  [in]           WS_CHANNEL                               *channel,
                 const WS_REQUEST_SECURITY_TOKEN_PROPERTY *properties,
  [in]           ULONG                                    propertyCount,
                 WS_SECURITY_TOKEN                        **token,
  [in, optional] const WS_ASYNC_CONTEXT                   *asyncContext,
  [in, optional] WS_ERROR                                 *error
);

Parâmetros

[in] channel

O canal no qual a negociação para obter o token de segurança deve ocorrer.

O canal fornecido deveria ter sido criado com o WS_SECURITY_DESCRIPTION apropriado para atender aos requisitos de segurança do emissor e, em seguida, aberto para o WS_ENDPOINT_ADDRESS do emissor. O chamador também é responsável por fechar e liberar o canal após a conclusão dessa função.

Portanto, o canal deve estar no estado WS_CHANNEL_STATE_OPEN quando essa função for chamada. Após a conclusão bem-sucedida dessa função, o canal estará no estado WS_CHANNEL_STATE_OPEN. Após uma conclusão com falha, ele estará no estado WS_CHANNEL_STATE_OPEN ou WS_CHANNEL_STATE_FAULTED de estado.

properties

Um grupo opcional de configurações a serem usadas no processo de negociação com o emissor.

[in] propertyCount

O número de itens na matriz de propriedades.

token

O token de segurança XML obtido. Isso é definido após a conclusão bem-sucedida da chamada de função e não é modificado se ocorrer alguma falha durante a execução da função.

O token de segurança retornado poderá ser usado com WS_XML_TOKEN_MESSAGE_SECURITY_BINDING se for para ser apresentado a um serviço. O token deve ser liberado usando WsFreeSecurityToken quando ele não for mais necessário.

[in, optional] asyncContext

Informações sobre como invocar a função de forma assíncrona ou NULL se estiver invocando de forma síncrona.

[in, optional] error

Especifica onde informações adicionais de erro devem ser armazenadas se a função falhar.

Valor retornado

Essa função pode retornar um desses valores.

Comentários

Windows 7 e Windows Server 2008 R2: o WWSAPI só dá suporte a Ws-Trust e Ws-SecureConversation , conforme definido pelo LWSSP (Lightweight Web Services Security Profile) . Para obter detalhes sobre a implementação da Microsoft, consulte a seção Sintaxe MESSAGE do LWSSP.

Requisitos