TunnelForgeCoreNet 3.0.1

TunnelForgeCoreNet

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

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

Русский

TunnelForgeCoreNet — это кроссплатформенная библиотека на .NET Standard 2.1 для работы с виртуальными сетевыми интерфейсами TUN/TAP в Windows и Linux. Она предоставляет единый удобный API для создания, управления и настройки туннелей VPN, позволяя читать и записывать сетевые пакеты с минимальными усилиями.

Быстрый обзор

• AdapterManagerBuilder — класс-конструктор для создания и настройки менеджера туннельного адаптера.
• ITunAdapterManager — интерфейс управления жизненным циклом туннельного адаптера и передачей пакетов.
• NetworkConfigurator — набор высокоуровневых методов для настройки сетевого окружения VPN-клиента и сервера.

Детали и возможности

1. AdapterManagerBuilder — просто создать адаптер

Удобный билдер для задания имени интерфейса и размера буфера.

Пример:

var adapterManager = new AdapterManagerBuilder()
    .WithName("tun0")
    .WithCapacity(1024 * 1024)
    .Build();

2. ITunAdapterManager — управляй туннелем

Основные методы и события:

• event Action<byte[]> OnPacketReceived
• byte[]? ReadPacket()
• Task<byte[]?> ReadPacketAsync(CancellationToken)
• void WritePacket(ReadOnlySpan<byte>)
• Task WritePacketAsync(ReadOnlyMemory<byte>, CancellationToken)
• Task StartReceivingAsync(CancellationToken)
• void StopReceiving()
• bool IsRunning

3. NetworkConfigurator — настройка сети VPN

• Клиентская настройка: IP, поднятие интерфейса, маршрут по умолчанию.
• Серверная настройка: IP внешнего интерфейса, IP-форвардинг, NAT.

Пример клиента:

await NetworkConfigurator.ConfigureClientSideAsync(
    iface: "tun0",
    ip: "10.0.0.2",
    prefixLength: 24,
    serverTunnelIp: "10.0.0.1"
);

Пример сервера:

await NetworkConfigurator.ConfigureServerSideAsync(
    externalIface: "eth0",
    externalIp: "192.168.1.10",
    externalPrefix: 24,
    internalIface: "tun0"
);

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

• Поддержка только Windows и Linux.
• Необходимы права администратора.
• Управляйте жизненным циклом адаптера.

English

TunnelForgeCoreNet is a cross-platform .NET Standard 2.1 library for working with virtual TUN/TAP network interfaces on Windows and Linux. It provides a unified and convenient API for creating, managing, and configuring VPN tunnels, enabling easy reading and writing of network packets.

Quick overview

• AdapterManagerBuilder — builder class to create and configure a tunnel adapter manager.
• ITunAdapterManager — interface for managing tunnel lifecycle and packet transmission.
• NetworkConfigurator — high-level methods for VPN client/server network configuration.

Features

1. AdapterManagerBuilder — easy adapter creation

Example:

var adapterManager = new AdapterManagerBuilder()
    .WithName("tun0")
    .WithCapacity(1024 * 1024)
    .Build();

2. ITunAdapterManager — manage your tunnel

Main members:

• event Action<byte[]> OnPacketReceived
• byte[]? ReadPacket()
• Task<byte[]?> ReadPacketAsync(CancellationToken)
• void WritePacket(ReadOnlySpan<byte>)
• Task WritePacketAsync(ReadOnlyMemory<byte>, CancellationToken)
• Task StartReceivingAsync(CancellationToken)
• void StopReceiving()
• bool IsRunning

3. NetworkConfigurator — VPN network setup

• Client setup: assign IP, bring interface UP, add default route.
• Server setup: assign IP to external iface, enable IP forwarding, configure NAT.

Client example:

await NetworkConfigurator.ConfigureClientSideAsync(
    iface: "tun0",
    ip: "10.0.0.2",
    prefixLength: 24,
    serverTunnelIp: "10.0.0.1"
);

Server example:

await NetworkConfigurator.ConfigureServerSideAsync(
    externalIface: "eth0",
    externalIp: "192.168.1.10",
    externalPrefix: 24,
    internalIface: "tun0"
);

Important notes

• Supported platforms: Windows and Linux only.
• Administrator privileges required.
• Proper lifecycle management of the adapter is necessary.

Deutsch

TunnelForgeCoreNet ist eine plattformübergreifende .NET Standard 2.1-Bibliothek zur Arbeit mit virtuellen TUN/TAP-Netzwerkschnittstellen unter Windows und Linux. Sie bietet eine einheitliche und einfache API zum Erstellen, Verwalten und Konfigurieren von VPN-Tunneln, mit der Sie Netzwerkpakete einfach lesen und schreiben können.

Kurzübersicht

• AdapterManagerBuilder — Builder-Klasse zum Erstellen und Konfigurieren eines Tunnel-Adapter-Managers.
• ITunAdapterManager — Schnittstelle zur Verwaltung des Tunnel-Lebenszyklus und der Paketübertragung.
• NetworkConfigurator — Hochrangige Methoden zur VPN-Client-/Server-Netzwerkkonfiguration.

Funktionen

1. AdapterManagerBuilder — einfacher Adapteraufbau

Beispiel:

var adapterManager = new AdapterManagerBuilder()
    .WithName("tun0")
    .WithCapacity(1024 * 1024)
    .Build();

2. ITunAdapterManager — Tunnelverwaltung

Wichtige Mitglieder:

• event Action<byte[]> OnPacketReceived
• byte[]? ReadPacket()
• Task<byte[]?> ReadPacketAsync(CancellationToken)
• void WritePacket(ReadOnlySpan<byte>)
• Task WritePacketAsync(ReadOnlyMemory<byte>, CancellationToken)
• Task StartReceivingAsync(CancellationToken)
• void StopReceiving()
• bool IsRunning

3. NetworkConfigurator — VPN-Netzwerkeinrichtung

• Client: IP zuweisen, Interface hochfahren, Standardroute hinzufügen.
• Server: IP externer Schnittstelle zuweisen, IP-Forwarding aktivieren, NAT konfigurieren.

Client-Beispiel:

await NetworkConfigurator.ConfigureClientSideAsync(
    iface: "tun0",
    ip: "10.0.0.2",
    prefixLength: 24,
    serverTunnelIp: "10.0.0.1"
);

Server-Beispiel:

await NetworkConfigurator.ConfigureServerSideAsync(
    externalIface: "eth0",
    externalIp: "192.168.1.10",
    externalPrefix: 24,
    internalIface: "tun0"
);

Wichtige Hinweise

• Unterstützte Plattformen: Nur Windows und Linux.
• Administratorrechte erforderlich.
• Lebenszyklus des Adapters korrekt verwalten.

简体中文

TunnelForgeCoreNet 是一个基于 .NET Standard 2.1 的跨平台库，用于在 Windows 和 Linux 上操作虚拟 TUN/TAP 网络接口。它提供了统一且方便的 API，用于创建、管理和配置 VPN 隧道，轻松读取和写入网络数据包。

快速概览

• AdapterManagerBuilder — 用于创建和配置隧道适配器管理器的构建类。
• ITunAdapterManager — 管理隧道生命周期和数据包传输的接口。
• NetworkConfigurator — 用于 VPN 客户端/服务器网络配置的高级方法集。

功能详情

1. AdapterManagerBuilder — 简单创建适配器

示例：

var adapterManager = new AdapterManagerBuilder()
    .WithName("tun0")
    .WithCapacity(1024 * 1024)
    .Build();

2. ITunAdapterManager — 管理隧道

主要成员：

• event Action<byte[]> OnPacketReceived
• byte[]? ReadPacket()
• Task<byte[]?> ReadPacketAsync(CancellationToken)
• void WritePacket(ReadOnlySpan<byte>)
• Task WritePacketAsync(ReadOnlyMemory<byte>, CancellationToken)
• Task StartReceivingAsync(CancellationToken)
• void StopReceiving()
• bool IsRunning

3. NetworkConfigurator — VPN 网络配置

• 客户端配置：分配 IP，启用接口，添加默认路由。
• 服务器配置：为外部接口分配 IP，启用 IP 转发，配置 NAT。

客户端示例：

await NetworkConfigurator.ConfigureClientSideAsync(
    iface: "tun0",
    ip: "10.0.0.2",
    prefixLength: 24,
    serverTunnelIp: "10.0.0.1"
);

服务器示例：

await NetworkConfigurator.ConfigureServerSideAsync(
    externalIface: "eth0",
    externalIp: "192.168.1.10",
    externalPrefix: 24,
    internalIface: "tun0"
);

重要注意事项

• 仅支持 Windows 和 Linux。
• 需要管理员权限。
• 需正确管理适配器生命周期。