tinI2P

tini2p is designed to be a header-only, minimal, modular C++ I2P libary.

See the design document for details on design decisions and project goals.

Prerequisites

• Catch2: https://github.com/catchorg/Catch2
• CMake 3.10+: https://cmake.org
• libSodium: https://github.com/jedisct1/libsodium
• LibreSSL: https://github.com/libressl-portable/portable
• Should work on hosts with OpenSSL, because LibreSSL is drop-in :)
• May require adding as a submodule pending requirement of Sha3 (Keccak1600)

Submodules

• NoiseC : https://github.com/tini2p/noise-c
• Currently using local fork with modifications for NTCP2
• Possible long-term refactor plans:
  • reimplement in C++ with wrappers around libSodium
  • maintain local refactored NoiseC with only needed components for I2P

Cloning tini2p

git clone --recursive https://github.com/tini2p/tini2p.git

Building tini2p

cd /path/to/tini2p

make tests
./build/tini2p-tests

make net-tests
./build/tini2p-net-tests

make coverage

Project layout

A brief overview of the project file structure (beware somewhat volatile):

• build: Build directory
• cmake: CMake build scripts
• src: Project source code
• crypto: Cryptographic implementations/wrappers
• data: Common data structures
• exception: Exception handling
• ntcp2: NTCP2 implementation
• tests: Project test suite
• unit_tests: Unit tests
• net_tests: Networking tests

tini2p follows a header-only library design, enabling developers to interact with the I2P network without needing a separate binary.

All test code also serves as examples for how to use/integrate tini2p.

One of the project goals is to release a reference router for users that prefer to run a binary without integrating into another project.

WIP

This project is in its earliest stages, and SHOULD NOT be used when strong anonymity is needed (yet).

Core components:

• [x] NTCP2 transport
• [x] SessionRequest crypto + message processing
• [x] SessionCreated crypto + message processing
• [x] SessionConfirmed crypto + message processing
• [x] DataPhase crypto + message processing
• [x] I2NP message processing
• [ ] I2CP message processing
• [x] Garlic encryption
• [x] NetDb
• [x] LeaseSet
• [x] LeaseSet2
• [ ] EncryptedLeaseSet2 (optional, highly desired)
• [ ] MetaLeaseSet (optional)
• [ ] ServiceList (optional)
• [x] RouterInfo
• [x] RouterIdentity
• [x] RouterAddress
• [x] Mapping
• [x] Tunnels
• [x] RouterContext

Client components:

• [ ] ClientContext
• [ ] ClientDestination
• [ ] ClientTunnels
• [ ] AddressBook
• [ ] I2CP message processing
• [ ] Reseed
• [ ] Key + config storage
• [ ] Proxies
• [ ] SOCKS 4a/5
• [ ] HTTP(S)
• [ ] WebSockets
• [ ] ZMQ
• [ ] SAMv3 API

Crypto components:

• [x] X25519 key generation
• [x] X3DH Diffie-Hellman exchange
• [x] Ed25519 key generation, signing/verification
• [x] Base32/64 en/decoding
• [x] Blake2b hashing
• [x] SHA256 hashing + HMAC
• [x] HKDF key derivation
• [x] SipHash obfuscation
• [x] AES key generation, CBC-256 en/decryption
• [ ] Ed25519ph key generation, signing/verification
• [x] Ecies-X25519-AEAD-Ratchet
• [x] Basic experimental implementation
• full implementation pending on finalized Proposal 144
• [ ] RedDSA key generation, signing/verification
• [ ] XEdDSA key generation, signing/verification

Only one of Ed25519ph or RedDSA need to be implemented for reseed signature processing.

Since RedDSA may also be needed for key blinding, Ed25519ph may be extraneous and unwanted. Ed25519ph has the advantange of standardization, so TBD.

Global components:

• [ ] Logging
• [ ] Storage: LMDB (AddressBook, NetDb storage)

Unlicense

This project is in the public domain, see the UNLICENSE file for more information.

Any contributors must be willing to release their contribution(s) into the public domain as well, to have merge requests considered.

Of course, you can just fork the project, and do whatever you want :)

Donate

Contributions to the tini2p project fund can be made at the cryptocurrency addresses listed below.

Updates to the donation addresses, and their location in the repository will be made with a signed commit.

Users should verify the signature on the latest revisions of donation addresses before donating.

Funds contribute to continued development expenses, obtaining/maintaining infrastructure (hosting, etc.), and potentially outreach projects.

XMR:

• 8ACEQ1HiziMafAnyEdmzL2G99vKNSvRMLDdrmDNCRVczRFpShZA7YvAGzvGH1g8WMQd2iH5REkcwTKMjKCwJWdxHNoUFcGH

BTC:

• 1MNLhCnKpagruVkcGQY4z3GvUN7r4mRdwj

Grin:

• Eepsite: coming soon
• Onion address: coming soon