https://github.com/named-data/ndnd
Golang implementation of the Named Data Networking protocol stack
https://github.com/named-data/ndnd
forwarding golang ndn networking routing
Last synced: 4 months ago
JSON representation
Golang implementation of the Named Data Networking protocol stack
- Host: GitHub
- URL: https://github.com/named-data/ndnd
- Owner: named-data
- License: mit
- Created: 2020-11-05T05:50:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-12T00:15:48.000Z (5 months ago)
- Last Synced: 2026-01-15T07:11:35.280Z (5 months ago)
- Topics: forwarding, golang, ndn, networking, routing
- Language: Go
- Homepage: https://named-data.net
- Size: 3.39 MB
- Stars: 27
- Watchers: 3
- Forks: 25
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Citation: CITATION.cff
- Security: docs/security-util.md
Awesome Lists containing this project
README
Named Data Networking Daemon
[](https://github.com/named-data/ndnd/actions/workflows/build.yml)
[](https://github.com/named-data/ndnd/actions/workflows/test.yml)
[](https://goreportcard.com/report/github.com/named-data/ndnd)
[](https://named-data.github.io/ndnd/dev/bench/index.html)
[](https://github.com/named-data/ndnd/releases)
[](./LICENSE.md)
[](https://pkg.go.dev/github.com/named-data/ndnd)
NDNd is a Golang implementation of the Named Data Networking (NDN) [protocol](https://named-data.net) stack.
See the project [overview](https://named-data.net/project/), architecture [details](https://named-data.net/project/archoverview/) and the [tutorial](https://101.named-data.net/) for more info on NDN.
## 🏗️ Installation
Pre-built static binaries for all supported platforms are available on the [releases](https://github.com/named-data/ndnd/releases) page. Linux-based systems may also utilize the provided [Docker images](https://github.com/named-data/ndnd/pkgs/container/ndnd).
NDNd is written in pure Go and requires [Go 1.23](https://go.dev/doc/install) or later to build from source.
Once Go is installed, run `make` to build the `ndnd` executable, followed by `make install` to install it globally.
# 🌟 Usage
NDNd provides several independent modules that can be used separately or together.
You can use the `ndnd` CLI to list available modules and get more info on their usage.
A tutorial example for running a simple NDN network can be found [here](docs/daemon-example.md).
```text
root@0037b98ec2ac:~# ndnd
_ _ ____ _ _ _
| \ | | _ \| \ | | __| |
| \| | | | | \| |/ _ |
| |\ | |_| | |\ | (_| |
|_| \_|____/|_| \_|\____|
Named Data Networking Daemon
Usage:
ndnd [command]
NDN Daemons
fw NDN Forwarding Daemon
dv NDN Distance Vector Daemon
daemon NDN Combined Daemon
Security Tools
sec NDN Security Utilities
certcli NDNCERT Certificate Client
Debug Tools
ping Send Interests to a ping server
pingserver Start a ping server under a name prefix
cat Retrieve object under a name prefix
put Publish data under a name prefix
Additional Commands:
help Help about any command
Flags:
-v, --version version for ndnd
```
## 🔀 Network Forwarder
The `ndnd/fw` package implements YaNFD, a packet forwarder for the NDN platform.
It is compatible with the management tools and protocols developed for the [NFD](https://github.com/named-data/NFD) forwarder.
To start the forwarder locally, run the following:
```bash
ndnd fw run yanfd.config.yml
```
A full configuration example can be found in [fw/yanfd.sample.yml](fw/yanfd.sample.yml).
Note that the default configuration may require root privileges to bind to multicast interfaces.
Once started, you can use the [forwarder control](docs/fw-control.md) tool to manage faces and routes.
## 📡 Distance Vector Router
The `ndnd/dv` package implements `ndn-dv`, an NDN Distance Vector routing daemon.
To start the routing daemon bound to the local forwarder, run the following:
```bash
ndnd dv run dv.config.yml
```
A full configuration example can be found in [dv/dv.sample.yml](dv/dv.sample.yml).
Make sure the network and router name are correctly configured and the forwarder is running.
Once started, you can use the [router control](docs/dv-control.md) tool to create and destroy neighbor links.
## 📚 Standard Library
The `ndnd/std` package implements `go-ndn`, a standard library for NDN applications.
You can use this package to build your own NDN applications.
Several examples are provided in the [std/examples](std/examples) directory.
The standard library supports the [Light VerSec](https://python-ndn.readthedocs.io/en/latest/src/lvs/lvs.html) binary format for trust schema specification.
## 🛠️ Tools
The `ndnd/tools` package provides basic utilities for NDN networks.
These can be used directly using the `ndnd` CLI.
- `sec`: security utilities for generating keys and certificates ([docs](docs/security-util.md))
- `certcli`: interactive [NDNCERT](https://github.com/named-data/ndncert) client ([docs](docs/certcli.md))
- `ping`/`pingserver`: test reachability between two NDN nodes
- `cat`/`put`: segmented file transfer between a consumer and a producer
# Contributing & License
Contributions to NDNd are greatly appreciated and can be made through GitHub pull requests and issues.
NDNd is free software distributed under the permissive [MIT license](LICENSE.md).