SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT控制項程式碼

發行項
06/12/2023

Description

SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT控制程式代碼會擷取 Windows 篩選平台所使用之重新導向記錄的重新導向內容， () 重新導向服務。

若要執行這項作業，請使用下列參數呼叫 WSAIoctl 或 WSPIoctl 函 式。

  (socket) s,             // descriptor identifying a socket
  SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT, // dwIoControlCode
  NULL,                         // lpvInBuffer
  0,                            // cbInBuffer
  (LPVOID) lpvOutBuffer,         // output buffer
  (DWORD) cbOutBuffer,       // size of output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
);

int WSPIoctl(
  (socket) s,             // descriptor identifying a socket
  SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT, // dwIoControlCode
  NULL,                         // lpvInBuffer
  0,                            // cbInBuffer
  (LPVOID) lpvOutBuffer,         // output buffer
  (DWORD) cbOutBuffer,       // size of output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
  (LPWSATHREADID) lpThreadId,   // a WSATHREADID structure 
  (LPINT) lpErrno   // a pointer to the error code.
);

參數

s

識別通訊端的描述項。

dwIoControlCode

作業的控制程式代碼。針對此作業使用 SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT 。

lpvInBuffer

輸入緩衝區的指標。這個作業未使用此參數。

cbInBuffer

輸入緩衝區的大小，以位元組為單位。這個作業未使用此參數。

lpvOutBuffer

輸出緩衝區的指標。如果lpOverlapped和lpCompletionRoutine參數為Null，此參數應該指向ULONG資料類型。

cbOutBuffer

輸出緩衝區的大小，以位元組為單位。此參數至少必須是 ULONG 資料類型的大小。

lmicrosoftBytesReturned

變數的指標，接收儲存在輸出緩衝區中的資料大小，以位元組為單位。

如果輸出緩衝區太小，則呼叫會失敗， WSAGetLastError 會傳回 WSAEINVAL，而 lBytesReturned 參數會指向 零的 DWORD 值。

如果lpOverlapped為Null，則成功呼叫時所傳回之lBytesReturned參數所指向的DWORD值不能為零。

如果重迭通訊端的 lpOverlapped 參數不是 Null ，則無法立即完成的作業將會起始，且稍後會指出完成。由傳回之lBytesReturned參數所指向的DWORD值可能是零，因為儲存的資料大小在重迭作業完成之前無法判斷。當作業完成完成時，可以擷取適當的完成方法時，擷取最終完成狀態。

lpvOverlapped

WSAOVERLAPPED結構的指標。

如果 建立的 通訊端沒有重迭屬性，則會忽略 lpOverlapped 參數。

如果已使用重迭屬性開啟，且 lpOverlapped 參數不是 Null，則會以重迭 (非同步) 作業來執行作業。在此情況下， lpOverlapped 參數必須指向有效的 WSAOVERLAPPED 結構。

對於重迭的作業， WSAIoctl 或 WSPIoctl 函式會立即傳回，並在作業完成時發出適當的完成方法訊號。否則，函式不會在作業完成或發生錯誤之前傳回。

lpCompletionRoutine

類型：_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE

當作業完成時呼叫的完成常式指標， (忽略非重迭通訊端) 。

lpThreadId

提供者後續呼叫WPUQueueApc時要使用的WSATHREADID結構的指標。提供者應該儲存參考的 WSATHREADID 結構， (直到 WPUQueueApc 函式傳回之後，才儲存相同) 的指標。

注意此參數僅適用于 WSPIoctl 函 式。

lpErrno

錯誤碼的指標。

注意此參數僅適用于 WSPIoctl 函 式。

傳回值

如果作業順利完成， WSAIoctl 或 WSPIoctl 函式會傳回零。

如果作業失敗或擱置中， WSAIoctl 或 WSPIoctl 函式會 傳回SOCKET_ERROR。若要取得擴充的錯誤資訊，請呼叫 WSAGetLastError。

錯誤碼	意義
WSA_IO_PENDING	已成功起始重迭的作業，且稍後將會指出完成。
WSA_OPERATION_ABORTED	因為通訊端關閉或SIO_FLUSH IOCTL 命令的執行而取消重迭的作業。
WSAEFAULT	lpvOutBuffer、lHTTPBytesReturned、lpOverlapped或lpCompletionRoutine參數並未完全包含在使用者位址空間的有效部分中。
WSAEINPROGRESS	當回呼正在進行時，就會叫用函式。
WSAEINTR	封鎖作業已中斷。
WSAEINVAL	dwIoControlCode參數不是有效的命令，或無法接受指定的輸入參數，或命令不適用於指定的通訊端類型。如果 cbOutBuffer 參數小於 ULONG 資料類型的大小，就會傳回此錯誤。
WSAENETDOWN	網路子系統失敗。
WSAENOPROTOOPT	指定的通訊協定不支援通訊端選項。
WSAENOTCONN	通訊端未連接。
WSAENOTSOCK	描述項 s 不是通訊端。
WSAEOPNOTSUPP	不支援指定的 IOCTL 命令。如果傳輸提供者不支援 SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL，就會傳回此錯誤。

備註

Windows 8和Windows Server 2012和更新版本的作業系統都支援SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL。

其允許存取 TCP/IP 封包處理路徑，其中可以檢查或變更連出和傳入封包，再進一步處理。藉由點選 TCP/IP 處理路徑，獨立軟體廠商 (ISV) 可以更輕鬆地建立防火牆、防毒軟體、診斷軟體，以及其他類型的應用程式和服務。其提供使用者模式和核心模式元件，讓協力廠商 ISV 可以參與 TCP/IP 通訊協定堆疊和整個作業系統中數層發生的篩選決策。「儲存空間連線重新導向」功能可讓一個一個一開始的一個圖說文字核心驅動程式，將連線重新導向到使用者模式程式、在使用者模式中執行內容檢查，以及使用不同的連線將檢查的內容轉送到原始目的地。

SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL 和數個其他相關的 IOCTLS 是使用者模式元件，可用來允許以合作方式來檢查相同流量的多個以一組方式進行多個以一個以一致方式運作的連線 Proxy 應用程式。每個檢查代理程式都可以安全地重新檢查已由另一個檢查代理程式檢查的網路流量。因為有多個 Proxy (由不同的 ISV 所開發，例如) 一個 Proxy 用來與最終目的地通訊的連線可能會由第二個 Proxy 重新導向，而且原始 Proxy 可以再次重新導向新的連線。如果沒有連線追蹤，原始連線可能不會到達其最終目的地，因為它卡在無限 Proxy 迴圈中。

SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL 是用來允許多個一個以一個一致方式檢查相同流量流量的一個以一致方式運作的一個以一種方式運作的以一個方式建立的多個一個以一個的一個以一個方式運作的連線 Proxy 應用程式。每個檢查代理程式都可以安全地重新檢查已由另一個檢查代理程式檢查的網路流量。因為有多個 Proxy (由不同的 ISV 所開發，例如) 一個 Proxy 用來與最終目的地通訊的連線可能會由第二個 Proxy 重新導向，而且原始 Proxy 可以再次重新導向新的連線。如果沒有連線追蹤，原始連線可能不會到達其最終目的地，因為它卡在無限 Proxy 迴圈中。 SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL 可用來提供重新導向通訊端連線的 Proxy 連線追蹤。此一個「儲存機制」功能可協助追蹤從連線的初始重新導向到目的地最終連線的重新導向記錄。

SIO_QUERY_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 是由一個以一個群組為基礎的重新導向服務用來從已接受的 TCP/IP 封包連線擷取重新導向記錄， (TCP 通訊端或 UDP 通訊端的連線通訊端，例如，) 由在核心模式驅動程式的ALE_CONNECT_REDIRECT層註冊的隨附核心模式圖說文字來重新導向。 SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL 是由一個以一個以一個內含的重新導向服務所使用，從接受的 TCP/IP 封包 (連線擷取重新導向記錄的重新導向內容，例如) 由其隨附圖說文字登錄在ALE_CONNECT_REDIRECT層。 重新導向內容是選擇性的，如果連線的目前重新導向狀態是呼叫重新導向服務重新導向連線，或先前由呼叫重新導向服務重新導向連線，但稍後會由不同的重新導向服務重新導向。重新導向服務會將擷取的重新導向記錄傳輸至 TCP 通訊端，以使用 SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 來 Proxy 原始內容。

由於一個由重新導向服務所設定的可變長度資料 Blob，因此呼叫端可以提供大型輸出緩衝區， (lpvOutBuffer 參數所指向的 1K 緩衝區，例如) 或可以當做 0 cbOutBuffer 參數中的輸出緩衝區大小傳遞，以查詢保存傳回 Blob 所需的緩衝區大小。如果輸出緩衝區大小不足以保存資料， WSAIoctl 或 WSPIoctl 函式會 傳回ERROR_INSUFFICIENT_BUFFER ，而所需的緩衝區大小將會以 lHTTPBytesReturned 參數所指向的值傳回。

呼叫 SIO_QUERY_WF\P_CONNECTION_REDIRECT_RECORDS IOCTL 的應用程式不需要瞭解包含所擷取之重新導向記錄的 Blob。這是應用程式擷取並傳回新通訊端所需的不透明資料 Blob。