Tox

This library is an implementation of toxcore in [Rust] - P2P, distributed, encrypted, easy to use DHT-based network.

Reference

The Tox Reference should be used for implementing toxcore in Rust. [Reference source repository].

If existing documentation appears to not be complete, or is not clear enough, issue / pull request should be filled on the reference repository.

Contributions

... are welcome :smile:. For details, look at CONTRIBUTING.md.

Dependencies

| Name | Version | |----------|-------------| | libsodium | >=1.0.13 |

Building

Fairly simple. You'll need [Rust] >= 1.26.0 and [libsodium].

When you'll have deps, build debug version with bash cargo build

To run tests: bash cargo test To build docs: bash cargo doc They will be located under target/doc/

With clippy

To check for clippy warnings (linting), you need nightly Rust with clippy-preview component.

To check: bash cargo clippy --all

To check with tests: bash cargo clippy --all --tests

Goals

• improved toxcore implementation in Rust
• Rust API
• documentation
• tests
• more

Progress

Not listed items are on TODO. If you're interested in them arriving sooner, consider helping :wink:

• [ ] implementing toxcore
  • [ ] DHT Node
    • [x] ping requests & responses
    • [x] nodes requests & responses
    • [x] CookieRequest
    • [x] CookieResponse
    • [x] CryptoHandshake
    • [x] CryptoData
    • [x] LanDiscovery
    • [x] OnionRequest[0,1,2]
    • [x] OnionResponse[3,2,1]
    • [x] OnionAnnounceRequest & OnionDataRequest
    • [ ] OnionAnnounceResponse & OnionDataResponse (need onion client)
    • [x] BootstrapInfo
    • [x] NAT ping requests & responses
  • [ ] TCP Relay
    • [x] Handshake
    • [x] RouteRequest
    • [x] RouteResponse
    • [x] ConnectNotification
    • [x] DisconnectNotification
    • [x] PingRequest
    • [x] PongResponse
    • [x] OobSend
    • [x] OobReceive
    • [x] OnionRequest
    • [x] OnionResponse
    • [x] Data
  • [x] toxencryptsave (aka TES)

• [x] Rust API

  It will be a subject to changes, and most likely parts that are currently public will at later point become hidden. That though depends on the needs.

• [x] Documentation
  • [x] Simply great. Further improvements in progress.
• [x] tests
  • [x] tests cover almost all functionality

License

Dual licensed under the MIT or GPLv3+ licenses. You may use this project under the terms of either the MIT License or the GNU General Public License (GPL) Version 3+.

For details, see LICENSE-MIT and LICENSE-GPL.