TunnelForge.WinTun 3.0.2

TunnelForge.WinTun

Поддерживаемые языки / Supported languages / Unterstützte Sprachen / 支持的语言:

• Русский
• English
• Deutsch
• 简体中文

Русский

TunnelForge.WinTun — это обёртка на C# для взаимодействия с нативным драйвером Wintun (Microsoft), который предоставляет высокопроизводительные виртуальные TUN-интерфейсы в Windows. Библиотека позволяет создавать адаптеры, открывать сессии для передачи сетевых пакетов и управлять их жизненным циклом с помощью удобного и низкоуровневого API.

Основные возможности

• Создание и открытие адаптеров Wintun.
• Управление сессиями чтения и записи сетевых пакетов.
• Настройка логгирования нативных вызовов.
• Получение событий готовности к чтению.
• Полный контроль над памятью пакетов для минимизации копирований.

Быстрый старт — пример создания адаптера и сессии

using TunnelForge.WinTun;

var adapterName = "MyTunnelAdapter";
var tunnelType = "MyTunnelType"; // Обычно "Wintun"
var guid = new Guid(); // Можно передать пустой

// Создание адаптера
var adapter = WinTunNative.WintunCreateAdapter(adapterName, tunnelType, ref guid);
if (adapter == IntPtr.Zero)
{
    throw new Exception("Failed to create adapter");
}

// Запуск сессии с буфером на 1Мб
var session = WinTunNative.WintunStartSession(adapter, 1024 * 1024);
if (session == IntPtr.Zero)
{
    WinTunNative.WintunCloseAdapter(adapter);
    throw new Exception("Failed to start session");
}

// Получение события для ожидания данных
var waitEvent = WinTunNative.WintunGetReadWaitEvent(session);

// Получение пакета (если есть)
uint packetSize;
var packetPtr = WinTunNative.WintunReceivePacket(session, out packetSize);
if (packetPtr != IntPtr.Zero)
{
    byte[] packet = new byte[packetSize];
    Marshal.Copy(packetPtr, packet, 0, (int)packetSize);

    // Обработка пакета ...

    // Освобождение памяти пакета
    WinTunNative.WintunReleaseReceivePacket(session, packetPtr);
}

// Завершение сессии и закрытие адаптера
WinTunNative.WintunEndSession(session);
WinTunNative.WintunCloseAdapter(adapter);

Важные замечания

• Работает только на Windows.
• Требуются права администратора для создания адаптеров.
• Следите за корректным освобождением ресурсов.
• Размеры буферов влияют на производительность.

English

TunnelForge.WinTun is a C# wrapper for the native Wintun driver (by Microsoft), providing high-performance virtual TUN interfaces on Windows. This library allows creating adapters, opening sessions for packet transmission, and managing their lifecycle through a simple low-level API.

Key Features

• Create and open Wintun adapters.
• Manage read/write sessions for network packets.
• Configure native logging callbacks.
• Obtain read wait events for efficient async I/O.
• Full control of packet memory to minimize copying.

Quick start example: create adapter and session

using TunnelForge.WinTun;

string adapterName = "MyTunnelAdapter";
string tunnelType = "MyTunnelType"; // Usually "Wintun"
Guid guid = new Guid(); // Empty GUID

// Create adapter
var adapter = WinTunNative.WintunCreateAdapter(adapterName, tunnelType, ref guid);
if (adapter == IntPtr.Zero)
{
    throw new Exception("Failed to create adapter");
}

// Start session with 1MB capacity
var session = WinTunNative.WintunStartSession(adapter, 1024 * 1024);
if (session == IntPtr.Zero)
{
    WinTunNative.WintunCloseAdapter(adapter);
    throw new Exception("Failed to start session");
}

// Get read wait event handle
var waitEvent = WinTunNative.WintunGetReadWaitEvent(session);

// Receive packet if available
uint packetSize;
var packetPtr = WinTunNative.WintunReceivePacket(session, out packetSize);
if (packetPtr != IntPtr.Zero)
{
    byte[] packet = new byte[packetSize];
    Marshal.Copy(packetPtr, packet, 0, (int)packetSize);

    // Process packet ...

    // Release packet memory
    WinTunNative.WintunReleaseReceivePacket(session, packetPtr);
}

// End session and close adapter
WinTunNative.WintunEndSession(session);
WinTunNative.WintunCloseAdapter(adapter);

Important Notes

• Windows only.
• Administrator privileges required to create adapters.
• Proper resource cleanup is mandatory.
• Buffer sizes affect performance.

Deutsch

TunnelForge.WinTun ist eine C#-Wrapper-Bibliothek für den nativen Wintun-Treiber (von Microsoft), die leistungsstarke virtuelle TUN-Schnittstellen unter Windows bereitstellt. Die Bibliothek ermöglicht das Erstellen von Adaptern, das Öffnen von Sessions für die Paketübertragung und die Verwaltung des Lebenszyklus über eine einfache Low-Level-API.

Hauptfunktionen

• Erstellung und Öffnung von Wintun-Adaptern.
• Verwaltung von Lese- und Schreib-Sessions für Netzwerkkarten.
• Konfiguration von nativen Logger-Callbacks.
• Empfang von Warte-Events für effizientes asynchrones IO.
• Volle Kontrolle über Paket-Speicher zur Minimierung von Kopien.

Schnellstart-Beispiel: Adapter und Session erstellen

using TunnelForge.WinTun;

string adapterName = "MeinTunnelAdapter";
string tunnelType = "MeinTunnelTyp"; // Normalerweise "Wintun"
Guid guid = new Guid(); // Leerer GUID

// Adapter erstellen
var adapter = WinTunNative.WintunCreateAdapter(adapterName, tunnelType, ref guid);
if (adapter == IntPtr.Zero)
{
    throw new Exception("Adapter konnte nicht erstellt werden");
}

// Session mit 1MB Kapazität starten
var session = WinTunNative.WintunStartSession(adapter, 1024 * 1024);
if (session == IntPtr.Zero)
{
    WinTunNative.WintunCloseAdapter(adapter);
    throw new Exception("Session konnte nicht gestartet werden");
}

// Event für Lese-Wartezeit abrufen
var waitEvent = WinTunNative.WintunGetReadWaitEvent(session);

// Paket empfangen, falls vorhanden
uint packetSize;
var packetPtr = WinTunNative.WintunReceivePacket(session, out packetSize);
if (packetPtr != IntPtr.Zero)
{
    byte[] packet = new byte[packetSize];
    Marshal.Copy(packetPtr, packet, 0, (int)packetSize);

    // Paket verarbeiten ...

    // Paket-Speicher freigeben
    WinTunNative.WintunReleaseReceivePacket(session, packetPtr);
}

// Session beenden und Adapter schließen
WinTunNative.WintunEndSession(session);
WinTunNative.WintunCloseAdapter(adapter);

Wichtige Hinweise

• Nur Windows wird unterstützt.
• Administratorrechte sind zum Erstellen von Adaptern erforderlich.
• Ressourcen müssen sorgfältig freigegeben werden.
• Die Puffergrößen beeinflussen die Leistung.

简体中文

TunnelForge.WinTun 是微软 Wintun 驱动的 C# 封装库，提供高性能的虚拟 TUN 网络接口，仅限 Windows 平台。此库允许创建适配器、打开会话进行数据包传输，并通过简单的低级 API 管理其生命周期。

主要功能

• 创建和打开 Wintun 适配器。
• 管理网络数据包的读写会话。
• 配置本地日志回调。
• 获取读取等待事件，实现高效异步 IO。
• 完全控制数据包内存，减少拷贝。

快速开始示例：创建适配器和会话

using TunnelForge.WinTun;

string adapterName = "MyTunnelAdapter";
string tunnelType = "MyTunnelType"; // 通常是 "Wintun"
Guid guid = new Guid(); // 空 GUID

// 创建适配器
var adapter = WinTunNative.WintunCreateAdapter(adapterName, tunnelType, ref guid);
if (adapter == IntPtr.Zero)
{
    throw new Exception("创建适配器失败");
}

// 启动容量为1MB的会话
var session = WinTunNative.WintunStartSession(adapter, 1024 * 1024);
if (session == IntPtr.Zero)
{
    WinTunNative.WintunCloseAdapter(adapter);
    throw new Exception("启动会话失败");
}

// 获取读取等待事件句柄
var waitEvent = WinTunNative.WintunGetReadWaitEvent(session);

// 如果有数据包则接收
uint packetSize;
var packetPtr = WinTunNative.WintunReceivePacket(session, out packetSize);
if (packetPtr != IntPtr.Zero)
{
    byte[] packet = new byte[packetSize];
    Marshal.Copy(packetPtr, packet, 0, (int)packetSize);

    // 处理数据包...

    // 释放数据包内存
    WinTunNative.WintunReleaseReceivePacket(session, packetPtr);
}

// 结束会话并关闭适配器
WinTunNative.WintunEndSession(session);
WinTunNative.WintunCloseAdapter(adapter);

重要提示

• 仅支持 Windows。
• 创建适配器需要管理员权限。
• 必须正确释放资源。
• 缓冲区大小影响性能。