Función WsRequestSecurityToken (webservices.h)

Obtenga un token de seguridad de un servicio de token de seguridad (STS) que actúa como emisor de tokens en un escenario de federación. Esta función se usa en el lado cliente y realiza los pasos de negociación basados en WS-Trust con el STS hasta que se obtiene el token de seguridad o se produce un error en el proceso de negociación.

Sintaxis

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

Canal en el que debe realizarse la negociación para obtener el token de seguridad.

El canal proporcionado debe haberse creado con el WS_SECURITY_DESCRIPTION adecuado para cumplir los requisitos de seguridad del emisor y, a continuación, abrirse a la WS_ENDPOINT_ADDRESS del emisor. El autor de la llamada también es responsable de cerrar y liberar el canal después de la finalización de esta función.

Por lo tanto, el canal debe estar en estado WS_CHANNEL_STATE_OPEN cuando se llama a esta función. Después de completar correctamente esta función, el canal estará en estado WS_CHANNEL_STATE_OPEN. Después de una finalización con error, estará en estado WS_CHANNEL_STATE_OPEN o WS_CHANNEL_STATE_FAULTED de estado.

properties

Un grupo opcional de configuraciones que se usará en el proceso de negociación con el emisor.

[in] propertyCount

Número de elementos de la matriz de propiedades.

token

Token de seguridad XML obtenido. Esto se establece tras la finalización correcta de la llamada de función y no se modifica si se produce algún error durante la ejecución de la función.

El token de seguridad devuelto se puede usar con WS_XML_TOKEN_MESSAGE_SECURITY_BINDING si se va a presentar a un servicio. El token debe liberarse mediante WsFreeSecurityToken cuando ya no sea necesario.

[in, optional] asyncContext

Información sobre cómo invocar la función de forma asincrónica o NULL si invoca sincrónicamente.

[in, optional] error

Especifica dónde se debe almacenar información de error adicional si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
WS_S_ASYNC	La operación asincrónica sigue pendiente.

Comentarios

Windows 7 y Windows Server 2008 R2: WWSAPI solo admite Ws-Trust y Ws-SecureConversation tal y como se define en El perfil de seguridad de servicios web ligeros (LWSSP). Para obtener más información sobre la implementación de Microsoft, consulte la sección Sintaxis message de LWSSP.

Requisitos

Cliente mínimo compatible	Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	webservices.h
Library	WebServices.lib
Archivo DLL	WebServices.dll