go-i2p

A pure Go implementation of the I2P router.

Status

go-i2p is in early development. The master branch is being refactored and API’s are definitely going to change. If you choose to use any part of this code right now, please keep up with these changes, as they will not be backward compatible and require Fundamentally changing any code that treats this as a dependency.

Implemented Features

• Clients
  • [ ] I2CP
  • [ ] Message routing
  • [ ] Datagrams
  • [ ] Streaming
• Cryptographic primitives(see also: https://github.com/go-i2p/crypto)
  • Signing
    • [X] ECDSA_SHA256_P256
    • [X] ECDSA_SHA384_P384
    • [X] ECDSA_SHA512_P521
    • [X] Ed25519
  • Verifying
    • [X] DSA
    • [X] ECDSA_SHA256_P256
    • [X] ECDSA_SHA384_P384
    • [X] ECDSA_SHA512_P521
    • [X] RSA_SHA256_2048
    • [X] RSA_SHA384_3072
    • [X] RSA_SHA512_4096
    • [X] Ed25519
    • [ ] Red25519
  • [X] ElGamal
  • [X] AES256
  • [X] X25519
  • [X] ChaCha20/Poly1305
  • [ ] Elligator2
  • [X] HKDF
  • [X] HMAC
  • [X] Noise subsystem
• End-to-End Crypto
  • [ ] Garlic messages
  • [ ] ElGamal/AES+SessionTag
  • [ ] Ratchet/X25519
• I2NP
  • [X] Message parsing and serialization
  • [X] Message interfaces and factory patterns
  • [X] Database Store/Lookup message structures
  • [X] Tunnel Build message structures
  • [X] Data, DeliveryStatus, TunnelData messages
  • [X] Build Request/Response Record parsing
  • [ ] Message routing and handling
• NetDB
  • [X] Local storage interface
  • [X] Reseed functionality (basic implementation)
  • [~] Persistence to disk
  • [ ] RouterInfo management
  • [ ] LeaseSet management
  • [X] Lookups
  • [ ] Expiry
  • [ ] Exploration
  • [ ] Publishing
  • [ ] Floodfill
  • [ ] LS2 and Encrypted Leasesets
• Transport Layer
  • [X] Transport manager and interfaces
  • NTCP2
    • [X] Session handshake using noise protocol
    • [X] Connection management
    • [X] I2NP message framing and unframing
    • [X] Session lifecycle management
    • [X] Message queuing and worker threads
  • SSU2
    • [ ] Session handshake
    • [ ] Connection management
    • [ ] Peer Tests
    • [ ] Introducers
  • Noise Subsystem (see also https://github.com/go-i2p/go-noise)
    • [X] Noise Socket Framework
    • [X] NTCP2 Socket Framework
    • [ ] SSU2 Socket Framework
• Tunnels
  • [X] Message structure parsing (delivery instructions)
  • [X] Fragment handling and reassembly
  • [X] Build Request/Response record interfaces
  • [ ] Tunnel building and management
  • [ ] Tunnel cryptography (layered encryption)
  • [ ] Gateway and endpoint implementation
  • [ ] Participant functionality
• Common Data Structures(see also: https://github.com/go-i2p/common
  • [X] Keys and Cert
  • [X] Key Certificates
  • [X] Certificate
  • [X] Lease
  • [X] Lease Set
  • [X] Router Info
  • [X] Router Identity
  • [X] Router Address
  • [X] Session Key
  • [X] Signature Types
  • [X] Destination
  • [X] Data Types
  • [X] Session Tag

Verbosity

Logging can be enabled and configured using the DEBUG_I2P environment variable. By default, logging is disabled.

There are three available log levels:

• Debug

export DEBUG_I2P=debug

• Warn

export DEBUG_I2P=warn

• Error

export DEBUG_I2P=error

If DEBUG_I2P is set to an unrecognized variable, it will fall back to “debug”.

Fast-Fail mode

Fast-Fail mode can be activated by setting WARNFAIL_I2P to any non-empty value. When set, every warning or error is Fatal. It is unsafe for production use, and intended only for debugging and testing purposes.

export WARNFAIL_I2P=true

If WARNFAIL_I2P is set and DEBUG_I2P is unset, DEBUG_I2P will be set to debug.

Contributing

See CONTRIBUTING.md for more information.

License

This project is licensed under the MIT license, see LICENSE for more information.