6 releases

0.3.0 Mar 14, 2024
0.2.1 Jan 23, 2024
0.2.0 Nov 24, 2023
0.1.2 Nov 24, 2023

#1230 in Network programming

Download history 10/week @ 2024-02-19 82/week @ 2024-02-26 94/week @ 2024-03-04 310/week @ 2024-03-11 160/week @ 2024-03-18 61/week @ 2024-03-25 110/week @ 2024-04-01 207/week @ 2024-04-08 67/week @ 2024-04-15 118/week @ 2024-04-22 22/week @ 2024-04-29 37/week @ 2024-05-06 65/week @ 2024-05-13 38/week @ 2024-05-20 23/week @ 2024-05-27 37/week @ 2024-06-03

166 downloads per month

Apache-2.0

330KB
6K SLoC

Juliet protocol implementation

This crate implements the Juliet multiplexing protocol version 1.0.1 as laid out in the Juliet RFC. It aims to be a secure, simple, easy to verify/review implementation that is still reasonably performant.

Benefits

The Juliet protocol comes with a core set of features, such as

  • carefully designed with security and DoS resilience as its foremoast goal,
  • customizable frame sizes,
  • up to 256 multiplexed, interleaved channels,
  • backpressure support fully baked in, and
  • low overhead (4 bytes per frame + 1-5 bytes depending on payload length).

This crate's implementation includes benefits such as

  • a side-effect-free implementation of the Juliet protocol,
  • an async IO layer integrated with the bytes crate to use it, and
  • a type-safe RPC layer built on top.

Examples

For a quick usage example, see examples/fizzbuzz.rs.

tracing support

The crate has an optional dependency on the tracing crate, which, if enabled, allows detailed insights through logs. If the feature is not enabled, no log statements are compiled in.

Log levels in general are used as follows:

  • ERROR and WARN: Actual issues that are not protocol level errors -- peer errors are expected and do not warrant a WARN level.
  • INFO: Insights into received high level events (e.g. connection, disconnection, etc), except information concerning individual requests/messages.
  • DEBUG: Detailed insights down to the level of individual requests, but not frames. A multi-megabyte single message transmission will NOT clog the logs.
  • TRACE: Like DEBUG, but also including frame and wire-level information, as well as local functions being called.

At INFO, it is thus conceivable for a peer to maliciously spam local logs, although with some effort if connection attempts are rate limited. At DEBUG or lower, this becomes trivial.

Dependencies

~3.5–5.5MB
~89K SLoC