SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS控制代码

项目
06/12/2023

说明

SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS控制代码将重定向记录设置为用于连接到最终目标的新 TCP 套接字，供 Windows 筛选平台 (WFP) 重定向服务使用。

若要执行此操作，请使用以下参数调用 WSAIoctl 或 WSPIoctl 函数。

int WSAIoctl(
  (socket) s,                              // descriptor identifying a socket
  SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS, // dwIoControlCode
  (LPVOID) lpvInputBuffer,                 // lpvInBuffer
  (DWORD) cbInputBuffer,                   // cbInBuffer
  NULL,                                    // output buffer
  0,                                       // 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_SET_WFP_CONNECTION_REDIRECT_RECORDS, // dwIoControlCode
  (LPVOID) lpvInputBuffer,                 // lpvInBuffer
  (DWORD) cbInputBuffer,                   // cbInBuffer
  NULL,                                    // output buffer
  0,                                       // 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_SET_WFP_CONNECTION_REDIRECT_RECORDS 。

lpvInBuffer

指向输入缓冲区的指针。此参数包含指向与套接字关联的 WFP 重定向记录的指针。

cbInBuffer

输入缓冲区的大小（以字节为单位）。

lpvOutBuffer

指向输出缓冲区的指针。此参数未用于此操作。

cbOutBuffer

输出缓冲区的大小（以字节为单位）。该参数必须设置为零。

lpcbBytesReturned

指向变量的指针，该变量接收存储在输出缓冲区中的数据的大小（以字节为单位）。

如果输出缓冲区太小，则调用失败， WSAGetLastError 返回 WSAEINVAL， lBytesReturned 参数指向 DWORD 值零。

如果 lpOverlapped 为 NULL，则成功调用时返回的 lpcbBytesReturned 参数指向的 DWORD 值不能为零。

如果对于重叠套接字， lpOverlapped 参数不是 NULL ，则将启动无法立即完成的操作，并在以后的时间指示完成。返回的 lpcbBytesReturned 参数指向的 DWORD 值可能为零，因为在重叠操作完成之前无法确定存储的数据的大小。当操作完成时发出相应的完成方法信号时，可以检索最终完成状态。

lpvOverlapped

指向 WSAOVERLAPPED 结构的指针。

如果套接字是在不使用重叠属性的情况下创建的，则忽略 lpOverlapped 参数。

如果已使用重叠属性打开，并且 lpOverlapped 参数不是 NULL，则该操作将作为重叠 (异步) 操作执行。在这种情况下， lpOverlapped 参数必须指向有效的 WSAOVERLAPPED 结构。

对于重叠操作， WSAIoctl 或 WSPIoctl 函数将立即返回，并在操作完成时发出相应的完成方法的信号。否则，函数在操作完成或发生错误之前不会返回。

lpCompletionRoutine

类型：_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE

指向完成操作时调用的完成例程的指针， (忽略非重叠套接字) 。

lpThreadId

指向 WSATHREADID 结构的指针，供提供程序在后续调用 WPUQueueApc 时使用。在 WPUQueueApc 函数返回之前，提供程序应存储引用的 WSATHREADID 结构 (而不是指向同一) 的指针。

注意此参数仅适用于 WSPIoctl 函数。

lpErrno

指向错误代码的指针。

注意此参数仅适用于 WSPIoctl 函数。

返回值

如果操作成功完成， WSAIoctl 或 WSPIoctl 函数将返回零。

如果操作失败或挂起， WSAIoctl 或 WSPIoctl 函数将返回 SOCKET_ERROR。若要获取扩展错误信息，请调用 WSAGetLastError。

错误代码	含义
WSA_IO_PENDING	重叠的 I/O 操作正在进行中。如果已成功启动重叠操作，并且稍后将指示完成，则返回此值。
WSA_OPERATION_ABORTED	由于发生线程退出或应用程序请求，I/O 操作已中止。如果由于套接字关闭或执行 SIO_FLUSH IOCTL 命令而取消了重叠操作，则返回此错误。
WSAEACCES	尝试以被其访问权限禁止的方式访问套接字。此错误在以下几种情况下返回：用户在本地计算机上缺少所需的管理权限，或者应用程序没有作为内置管理员 (`RunAs administrator`) 在增强的 shell 中运行。
WSAEFAULT	系统在尝试在调用中使用指针参数时检测到指针地址无效。此错误返回的 lpvInBuffer、 lpvoutBuffer、 lpvbytesReturned、 lpOverlapped 或 lpCompletionRoutine 参数未完全包含在用户地址空间的有效部分。
WSAEINPROGRESS	阻止操作当前正在执行。如果在回调正在进行时调用函数，则返回此错误。
WSAEINTR	调用 WSACancelBlockingCall 中断了阻止操作。如果阻止操作中断，则返回此错误。
WSAEINVAL	提供了无效的参数。如果 dwIoControlCode 参数不是有效的命令，或者指定的输入参数不可接受，或者命令不适用于指定的套接字类型，则返回此错误。
WSAENETDOWN	套接字操作遇到了一个已死的网络。如果网络子系统发生故障，则返回此错误。
WSAENOTSOCK	尝试对不是套接字的内容执行操作。如果描述符不是套接字，则返回此错误。
WSAEOPNOTSUPP	引用的对象类型不支持尝试的操作。如果不支持指定的 IOCTL 命令，则返回此错误。如果传输提供程序不支持 SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL，也会返回此错误。

备注

Windows 8、Windows Server 2012及更高版本的操作系统支持SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL。

WFP 允许访问 TCP/IP 数据包处理路径，在允许进一步处理之前，可以检查或更改传出和传入数据包。通过利用 TCP/IP 处理路径，独立软件供应商 (ISV) 可以更轻松地创建防火墙、防病毒软件、诊断软件以及其他类型的应用程序和服务。 WFP 提供用户模式和内核模式组件，以便第三方 ISV 可以参与在 TCP/IP 协议堆栈中的多个层以及整个操作系统中发生的筛选决策。 WFP 连接重定向功能允许 WFP 标注内核驱动程序在本地将连接重定向到用户模式进程，在用户模式下执行内容检查，并使用其他连接将检查的内容转发到原始目标。

SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 和其他几个相关的 IOCTLS 是用户模式组件，用于允许多个基于 WFP 的连接代理应用程序以协作方式检查相同的流量流。每个检查代理可以安全地重新检查已由另一个检查代理检查的网络流量。如果存在多个代理， (由不同的 ISV 开发，例如) 一个代理用来与最终目标通信的连接又可由另一个代理重定向，并且新连接可以再次由原始代理重定向。如果没有连接跟踪，原始连接可能永远不会到达其最终目标，因为它会卡在无限代理循环中。

SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 用于在重定向的套接字连接上提供代理连接跟踪。此 WFP 功能有助于跟踪从连接的初始重定向到目标的最终连接的重定向记录。

SIO_QUERY_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 由基于 WFP 的重定向服务用于从 TCP 套接字或 UDP 套接字的连接套接字 (接受的 TCP/IP 数据包连接检索重定向记录，例如，) 在内核模式驱动程序的 ALE_CONNECT_REDIRECT 层注册的配套内核模式标注重定向到它。 SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT IOCTL 检索所使用的重定向记录的重定向上下文。重定向上下文是可选的，如果连接的当前重定向状态是连接已由调用重定向服务重定向，或者连接以前由调用重定向服务重定向，但后来又由其他重定向服务重定向，则使用重定向上下文。重定向服务将检索到的重定向记录传输到 TCP 套接字，以使用 SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 代理原始内容。

调用 SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS IOCTL 的应用程序不需要了解包含所设置的重定向记录的 Blob。这是应用程序需要传递回新套接字的不透明数据 blob。