mirror of
https://github.com/soypat/lneto.git
synced 2026-08-11 18:33:46 +00:00
soypat
37 lines
2.5 KiB
Markdown
37 lines
2.5 KiB
Markdown
# lneto
|
|
[](https://pkg.go.dev/github.com/soypat/lneto)
|
|
[](https://goreportcard.com/report/github.com/soypat/lneto)
|
|
[](https://codecov.io/gh/soypat/lneto)
|
|
[](https://github.com/soypat/lneto/actions/workflows/go.yml)
|
|
[](https://sourcegraph.com/github.com/soypat/lneto?badge)
|
|
|
|
Userspace networking primitives.
|
|
|
|
`lneto` is pronounced "L-net-oh", a.k.a. "El Neto"; a.k.a. "Don Networkio"; a.k.a "Neto, connector of worlds".
|
|
|
|
## Packages
|
|
- `lneto`: Low-level Networking Operations, or "El Neto", the networking package. Zero copy network frame marshalling and unmarshalling.
|
|
- [`lneto/frames.go`](./frames.go): Ethernet, IPv4/IPv6, ARP, TCP, UDP packet marshalling/unmarshalling.
|
|
|
|
- [`lneto/tcp`](./ntp): TCP implementation and low level logic.
|
|
- [`lneto/dhcpv4`](./dhcpv4): DHCP version 4 protocol implementation and low level logic.
|
|
- [`lneto/dns`](./dns): DNS protocol implementation and low level logic.
|
|
- [`lneto/ntp`](./ntp): NTP implementation and low level logic. Includes NTP time primitives manipulation and conversion to Go native types.
|
|
- [`lneto/internal`](./internal): Lightweight and flexible ring buffer implementation and debugging primitives.
|
|
|
|
|
|
## Install
|
|
How to install package with newer versions of Go (+1.16):
|
|
```sh
|
|
go mod download github.com/soypat/lneto@latest
|
|
```
|
|
|
|
|
|
## Developing (linux)
|
|
|
|
- [`tap`](./examples/tap) (linux only, root privilidges required) Program opens a TAP interface and assigns an IP address to it and exposes the interface via a HTTP interface. This program is run with root privilidges to facilitate debugging of lneto since no root privilidges are required to interact with the HTTP interface exposed.
|
|
- `POST http://127.0.0.1:7070/send`: Receives a POST with request body containing JSON string of data to send over TAP interface. Response contains only status code.
|
|
- `GET http://127.0.0.1:7070/recv`: Receives a GET request. Response contains a JSON string of oldest unread TAP interface packet. If string is empty then there is no more data to read.
|
|
|
|
- [`stack`](./examples/stack) Contains stack implementation which can interact with `tap` program. No root privilidges required.
|
|
- Can expose a HTTP server. |