Fungsi WsRequestSecurityToken (webservices.h)

Artikel
08/27/2023

Dapatkan token keamanan dari layanan token keamanan (STS) yang bertindak sebagai penerbit token dalam skenario federasi. Fungsi ini digunakan di sisi klien, dan melakukan langkah-langkah negosiasi berbasis WS-Trust dengan STS sampai token keamanan diperoleh atau proses negosiasi gagal.

Sintaks

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

Saluran tempat negosiasi untuk mendapatkan token keamanan harus berlangsung.

Saluran yang disediakan seharusnya dibuat dengan WS_SECURITY_DESCRIPTION yang sesuai untuk memenuhi persyaratan keamanan penerbit, dan kemudian dibuka untuk WS_ENDPOINT_ADDRESS penerbit. Pemanggil juga bertanggung jawab untuk menutup dan membebaskan saluran setelah penyelesaian fungsi ini.

Dengan demikian, saluran harus dalam status WS_CHANNEL_STATE_OPEN ketika fungsi ini dipanggil. Setelah berhasil menyelesaikan fungsi ini, saluran akan berada dalam status WS_CHANNEL_STATE_OPEN. Setelah penyelesaian yang gagal, itu akan berada dalam status WS_CHANNEL_STATE_OPEN atau status WS_CHANNEL_STATE_FAULTED.

properties

Grup pengaturan opsional yang akan digunakan dalam proses negosiasi dengan penerbit.

[in] propertyCount

Jumlah item dalam array properti.

token

Token keamanan XML diperoleh. Ini diatur setelah berhasil menyelesaikan panggilan fungsi, dan tidak dimodifikasi jika terjadi kegagalan selama eksekusi fungsi.

Token keamanan yang dikembalikan dapat digunakan dengan WS_XML_TOKEN_MESSAGE_SECURITY_BINDING jika akan disajikan ke layanan. Token harus dibebaskan menggunakan WsFreeSecurityToken ketika tidak lagi diperlukan.

[in, optional] asyncContext

Informasi tentang cara memanggil fungsi secara asinkron, atau NULL jika memanggil secara sinkron.

[in, optional] error

Menentukan tempat informasi kesalahan tambahan harus disimpan jika fungsi gagal.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_S_ASYNC	Operasi asinkron masih tertunda.

Keterangan

Windows 7 dan Windows Server 2008 R2: WWSAPI hanya mendukung Ws-Trust dan Ws-SecureConversation sebagaimana didefinisikan oleh Lightweight Web Services Security Profile (LWSSP). Untuk detail mengenai implementasi Microsoft, silakan lihat bagian Sintaks MESSAGE LWSSP.

Persyaratan


Klien minimum yang didukung	Windows 7 [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	webservices.h
Pustaka	WebServices.lib
DLL	WebServices.dll

Bagikan melalui