pktkit 0.1.2

Zero-copy L2/L3 packet handling toolkit. Frames, packets, hubs, adapters, NAT, virtual TCP/IP, WireGuard, OpenVPN, QEMU networking, TUN/TAP, AF_XDP — all gated behind opt-in cargo features.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

[package]
name = "pktkit"
version = "0.1.2"
edition = "2021"
rust-version = "1.75"
authors = ["Karpeles Lab Inc."]
license = "MIT"
description = "Zero-copy L2/L3 packet handling toolkit. Frames, packets, hubs, adapters, NAT, virtual TCP/IP, WireGuard, OpenVPN, QEMU networking, TUN/TAP, AF_XDP — all gated behind opt-in cargo features."
repository = "https://github.com/KarpelesLab/pktkit-rs"
homepage = "https://github.com/KarpelesLab/pktkit-rs"
documentation = "https://docs.rs/pktkit"
readme = "README.md"
keywords = ["networking", "packet", "tcp", "wireguard", "tun"]
categories = ["network-programming", "virtualization"]

[features]
# By default we ship only the core: Frame, Packet, hubs, pipes, traits.
# Every other capability is opt-in so users only pull the dependencies they need.
default = []

# Bridging an L3 device onto an L2 network (ARP, NDP, gateway routing).
l2adapter = []

# DHCP client codec + DHCPServer. The client is also used by l2adapter
# when StartDHCP() is called.
dhcp = []

# QEMU userspace network socket protocol (client + listener).
qemu = []

# Linux/macOS TUN/TAP device support.
tuntap = ["dep:libc"]

# Linux AF_XDP zero-copy sockets.
afxdp = ["dep:libc"]

# Pure-Rust virtual TCP engine.
vtcp = []

# Userspace NAT stack (L3Device) routing to real OS sockets.
slirp = ["vtcp"]

# High-level virtual client (Dial / Listen / DNS / minimal HTTP).
vclient = ["vtcp"]

# Packet-level IPv4 NAT, NAT64, ALGs, defrag, UPnP.
# UPnP terminates its SOAP control port with the virtual TCP engine (vtcp).
nat = ["vtcp"]

# WireGuard tunnel (Noise IK handshake + transport).
wg = [
    "dep:curve25519-dalek",
    "dep:chacha20poly1305",
    "dep:blake2",
    "dep:hmac",
    "dep:zeroize",
    "dep:rand_core",
    "dep:getrandom",
]

# OpenVPN server (TLS control channel + AES-CBC/GCM data channel).
ovpn = [
    "dep:aes",
    "dep:aes-gcm",
    "dep:cbc",
    "dep:hmac",
    "dep:sha1",
    "dep:sha2",
    "dep:rsa",
    "dep:rand_core",
    "dep:getrandom",
    # TLS for the OpenVPN control channel. The data channel still uses the
    # RustCrypto primitives above (AES-CBC/GCM keyed via PRF 1.2). rustls is
    # accepted here as an opt-in exception to the "minimal third-party" rule
    # because hand-rolling TLS 1.2 + X.509 is not worth the risk.
    "dep:rustls",
    "dep:rustls-rustcrypto",
    "dep:rustls-pemfile",
]

# Convenience: enable everything (matches the Go upstream featureset).
full = [
    "l2adapter",
    "dhcp",
    "qemu",
    "tuntap",
    "afxdp",
    "vtcp",
    "slirp",
    "vclient",
    "nat",
    "wg",
    "ovpn",
]

[dependencies]
# libc is the only OS-FFI shim we use, gated behind features that need it.
libc = { version = "0.2", optional = true }

# Vetted RustCrypto crates, only pulled in by the crypto-using features.
# We do not write our own primitives.
curve25519-dalek    = { version = "4", optional = true, default-features = false, features = ["alloc", "zeroize"] }
chacha20poly1305    = { version = "0.10", optional = true, default-features = false, features = ["alloc"] }
aes                 = { version = "0.8", optional = true }
aes-gcm             = { version = "0.10", optional = true, default-features = false, features = ["alloc", "aes"] }
cbc                 = { version = "0.1", optional = true, features = ["alloc"] }
blake2              = { version = "0.10", optional = true }
sha1                = { version = "0.10", optional = true }
sha2                = { version = "0.10", optional = true }
hmac                = { version = "0.12", optional = true }
rsa                 = { version = "0.9", optional = true, default-features = false }
zeroize             = { version = "1", optional = true, default-features = false, features = ["zeroize_derive"] }
rand_core           = { version = "0.6", optional = true }
getrandom           = { version = "0.2", optional = true }
# TLS for OpenVPN's control channel only (ovpn feature). We deliberately
# disable rustls's built-in crypto backends (no `ring`, no `aws-lc-rs` — both
# vendor C/assembly and run a build script) and supply a pure-Rust provider
# from rustls-rustcrypto, which is backed by the same RustCrypto primitives the
# data channel already uses. TLS 1.2 is required (OpenVPN negotiates it).
rustls              = { version = "0.23", optional = true, default-features = false, features = ["std", "tls12"] }
rustls-rustcrypto   = { version = "=0.0.2-alpha", optional = true }
rustls-pemfile      = { version = "2", optional = true }

[dev-dependencies]
# Tests may exercise OS sockets; nothing extra needed beyond std.

[lib]
name = "pktkit"
path = "src/lib.rs"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]