Skip to content
This repository has been archived by the owner on Sep 24, 2023. It is now read-only.

Latest commit

 

History

History
42 lines (28 loc) · 2.18 KB

README.md

File metadata and controls

42 lines (28 loc) · 2.18 KB
Raw

TUIC

Delicately-TUICed 0-RTT proxy protocol

Warning: TUIC's dev branch is under heavy development. For end-user, please check out the latest released tag

Introduction

TUIC is a proxy protocol focusing on minimize the additional handshake latency caused by relaying as much as possible, as well as keeping the protocol itself being simple and easy to implement

TUIC is originally designed to be used on top of the QUIC protocol, but you can use it with any other protocol, e.g. TCP, in theory

When paired with QUIC, TUIC can achieve:

  • 0-RTT TCP proxying
  • 0-RTT UDP proxying with NAT type Full Cone
  • 0-RTT authentication
  • Two UDP proxying modes:
    • native: Having characteristics of native UDP mechanism
    • quic: Transferring UDP packets losslessly using QUIC streams
  • Fully multiplexed
  • All the advantages of QUIC, including but not limited to:
    • Bidirectional user-space congestion control
    • Optional 0-RTT connection handshake
    • Connection migration

Fully-detailed TUIC protocol specification can be found in SPEC.md

Overview

There are 4 crates provided in this repository:

  • tuic - Library. The protocol itself, protocol & model abstraction, synchronous / asynchronous marshalling
  • tuic-quinn - Library. A thin layer on top of quinn to provide functions of TUIC
  • tuic-server - Binary. Minimalistic TUIC server implementation as a reference
  • tuic-client - Binary. Minimalistic TUIC client implementation as a reference

License

Code in this repository is licensed under GNU General Public License v3.0

However, the concept of the TUIC protocol is license-free. You can implement, modify, and redistribute the protocol without any restrictions, even for commercial use