WsRequestSecurityToken-Funktion (webservices.h)

Artikel
08/27/2023

Rufen Sie ein Sicherheitstoken von einem Sicherheitstokendienst (Security Token Service, STS) ab, der in einem Verbundszenario als Tokenaussteller fungiert. Diese Funktion wird auf Clientseite verwendet und führt die WS-Trust basierenden Aushandlungsschritte mit dem STS aus, bis das Sicherheitstoken abgerufen wird oder der Aushandlungsprozess fehlschlägt.

Syntax

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

Parameter

[in] channel

Der Kanal, in dem die Aushandlung zum Abrufen des Sicherheitstokens erfolgen soll.

Der bereitgestellte Kanal sollte mit dem entsprechenden WS_SECURITY_DESCRIPTION erstellt worden sein, um die Sicherheitsanforderungen des Ausstellers zu erfüllen, und dann für die WS_ENDPOINT_ADDRESS des Ausstellers geöffnet werden. Der Aufrufer ist auch für das Schließen und Freigeben des Kanals nach Abschluss dieser Funktion verantwortlich.

Daher muss sich der Kanal im Zustand WS_CHANNEL_STATE_OPEN befinden, wenn diese Funktion aufgerufen wird. Nach erfolgreichem Abschluss dieser Funktion befindet sich der Kanal im Zustand WS_CHANNEL_STATE_OPEN. Nach einem fehlgeschlagenen Abschluss befindet er sich entweder im Zustand WS_CHANNEL_STATE_OPEN oder im Zustand WS_CHANNEL_STATE_FAULTED.

properties

Eine optionale Gruppe von Einstellungen, die im Aushandlungsprozess mit dem Aussteller verwendet werden soll.

[in] propertyCount

Die Anzahl der Elemente im Eigenschaftenarray.

token

Das erhaltene XML-Sicherheitstoken. Dies wird bei erfolgreichem Abschluss des Funktionsaufrufs festgelegt und ist unverändert, wenn während der Ausführung der Funktion ein Fehler auftritt.

Das zurückgegebene Sicherheitstoken kann mit WS_XML_TOKEN_MESSAGE_SECURITY_BINDING verwendet werden, wenn es einem Dienst angezeigt werden soll. Das Token muss mit WsFreeSecurityToken freigegeben werden, wenn es nicht mehr benötigt wird.

[in, optional] asyncContext

Informationen zum asynchronen Aufrufen der Funktion oder NULL beim synchronen Aufruf.

[in, optional] error

Gibt an, wo zusätzliche Fehlerinformationen gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
WS_S_ASYNC	Der asynchrone Vorgang steht noch aus.

Hinweise

Windows 7 und Windows Server 2008 R2: WWSAPI unterstützt nur Ws-Trust und Ws-SecureConversation , wie durch Lightweight Web Services Security Profile (LWSSP) definiert. Ausführliche Informationen zur Implementierung von Microsoft finden Sie im Abschnitt MESSAGE Syntax von LWSSP.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	webservices.h
Bibliothek	WebServices.lib
DLL	WebServices.dll