WsRequestSecurityToken, fonction (webservices.h)

Obtenez un jeton de sécurité à partir d’un service de jeton de sécurité (STS) qui agit en tant qu’émetteur de jeton dans un scénario de fédération. Cette fonction est utilisée côté client et effectue les étapes de négociation basées sur les WS-Trust avec sts jusqu’à ce que le jeton de sécurité soit obtenu ou que le processus de négociation échoue.

Syntaxe

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
);

Paramètres

[in] channel

Canal sur lequel la négociation pour obtenir le jeton de sécurité doit avoir lieu.

Le canal fourni doit avoir été créé avec les WS_SECURITY_DESCRIPTION appropriés pour répondre aux exigences de sécurité de l’émetteur, puis ouvert au WS_ENDPOINT_ADDRESS de l’émetteur. L’appelant est également responsable de la fermeture et de la libération du canal une fois cette fonction terminée.

Par conséquent, le canal doit être à l’état WS_CHANNEL_STATE_OPEN lorsque cette fonction est appelée. Une fois cette fonction terminée, le canal est dans l’état WS_CHANNEL_STATE_OPEN. Après un échec d’exécution, il est à l’état WS_CHANNEL_STATE_OPEN ou WS_CHANNEL_STATE_FAULTED d’état.

properties

Groupe facultatif de paramètres à utiliser dans le processus de négociation avec l’émetteur.

[in] propertyCount

Nombre d’éléments dans le tableau de propriétés.

token

Jeton de sécurité XML obtenu. Cette valeur est définie lors de l’exécution réussie de l’appel de fonction et n’est pas modifiée si une défaillance se produit pendant l’exécution de la fonction.

Le jeton de sécurité retourné peut être utilisé avec WS_XML_TOKEN_MESSAGE_SECURITY_BINDING s’il doit être présenté à un service. Le jeton doit être libéré à l’aide de WsFreeSecurityToken lorsqu’il n’est plus nécessaire.

[in, optional] asyncContext

Informations sur la façon d’appeler la fonction de manière asynchrone, ou NULL en cas d’appel synchrone.

[in, optional] error

Spécifie l’emplacement où des informations d’erreur supplémentaires doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Remarques

Windows 7 et Windows Server 2008 R2 : WWSAPI prend uniquement en charge Ws-Trust et Ws-SecureConversation tels que définis par le profil de sécurité des services Web légers (LWSSP). Pour plus d’informations sur l’implémentation de Microsoft, consultez la section Syntaxe message de LWSSP.

Configuration requise