christopherbilg / ri2p

Rust implementation of the i2p client/server/router protocols

ri2p

Rust implementation of the i2p client/server/router protocols

Status

Common Commands

• cargo build: Builds the ri2p binary

• cargo run: Runs the ri2p binary

• cargo test: Runs all test functions, in the ./tests directory, that contain the #[test] attribute

• cargo doc [--open]: Builds the automatically generated ri2p Rust documentation, and optionally opens it in a web browser

• cargo fmt: Standard formatter for Rust codestyle

• cargo clippy [--fix]: Standard linter for Rust, and optionally will automatically fix linted issues

• mdbook build: Builds the ri2p mdbook locally

• mdbook serve: Serves the ri2p mdbook at http://localhost:3000, and rebuilds it on changes

CI/CD Information

GitHub is the central CI/CD platform for the ri2p project. CI/CD will occur only when modifications are made (pull-requests) to the master branch.

Additional Important Information

• Code of Conduct Guidelines
• Contributing Guidelines
• Open Source License
• Security (Vulnerability) Policy
• Major Authors & Contributors
• Changelog (SemVer)

Developers

If you would like to work on this project, please feel free to check the issues for a list of the current items that we need to be worked on. If you would like to work on any of them, please contact ri2p in the discussions area and I will mark a task for you.

Documentation

Developers can find documentation for ri2p in the docs/ directory, or hosted online at chrisbilger.com/ri2p/.

The cargo doc documentation that is automatically generated by Cargo can be viewed by running cargo doc --open, or hosted online at chrisbilger.com/ri2p/doc/doc/ri2p.

Roadmap & Goals

v1.0.0

Minimally viable i2p router.

v2.0.0

Add in router UI. (This will probably be a web server that serves a static site and periodic data refreshes.)

v3.0.0

Remove all unnecessary dependencies in order to reduce attack-surface. This also includes re-reading all source code in order to pinpoint potential security vulnerabilities.

v4.0.0+

TBD. Versions at this level will be feature additions and possibly a "module" system that allows the addition of external modules for additional/enhanced features and functionality.

ri2p's Issues

Initial documentation (learning material) for mdbook

Sections such as:

1. Introduction
2. Network stack
3. Protocols
4. Data Structures

Convert old URL domain to new URL domain

Add initial documentation for i2np

https://geti2p.net/spec/i2np

Add dependabot github file targetting cargo ecosystem

Add "cargo docs" build output to "gh-pages/docs" as a GitHub Action

Link to GH Pages "./docs/" directory in README.md file and on the GH Pages mdBook

Add initial documentation for SSU

Secure Semireliable UDP

https://geti2p.net/en/docs/transport/ssu

Update references and workflows from "chrisbilger.com" to new domain name

Also in this issue, update README.md with "pages-build-deployment" GitHub status badge, and remove "quick link" that I manually added onto the introduction mdBook documentation page.

Add cross-compilation build outputs for major OS distributions

This issue should also create a bash script to automatically output the cross-compiled builds.

Add initial documentation for NTCP2

Don't bother with NTCP (v1) as it is deprecated and unused. ri2p will (probably) only implement NTCP2.

https://geti2p.net/spec/ntcp2

Basic MVP implementation of NetDB

Automate cross-compiled build outputs as a GitHub Action

This issue should also publish the cross-compiled build outputs to GitHub.

This issue is dependent on issue #64.

Update README.md file with relevant metadata badges

https://shields.io/
https://dev.to/envoy_/150-badges-for-github-pnk
https://github.com/badges

Initial setup to begin implementing protocols (logging, configs, CLI, crypto, etc.)

Overview NetDB specification and documentation; then plan out issues needed to create NetDB

Also: Add notes to the mdBook regarding NetDB and associated topics.