Add Hysteria2 Protocol #2721

JimmyHuang454 · 2023-10-22T06:49:17Z

Use hysteria's quic-go to support BBR and brutal congestion algorithm

Same as hysteria, BBR and Brutal congestion algorithm can improve performance.

Usage:

send_mbps is needed when congestion's type is brutal, meaning the max bandwidth of current network can use to send.

{
  "transport":"quic",
  "transportSettings":{
      "congestion": {"type":"brutal", "send_mbps": 200}
  },
  "security":"tls",
  "securitySettings":{}
}

If user don't know how to config brutal, it's just ok to use bbr in both client and server side.

{
  "transport":"quic",
  "transportSettings":{
      "congestion": {"type":"bbr"}
  },
  "security":"tls",
  "securitySettings":{}
}

Fix `vprotogen` bug and update all Protobuf data

vprotogen can not work, because it failed to recognize new version of protoc, so that we can not add new feature to v2ray.

Update go version to 1.21

fix #2701 #2644

codecov-commenter · 2023-10-24T03:27:43Z

Codecov Report

Attention: 1048 lines in your changes are missing coverage. Please review.

Comparison is base (cb84b28) 37.79% compared to head (0b7f037) 36.78%.
Report is 5 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2721      +/-   ##
==========================================
- Coverage   37.79%   36.78%   -1.01%     
==========================================
  Files         654      664      +10     
  Lines       38723    39771    +1048     
==========================================
- Hits        14636    14631       -5     
- Misses      22477    23524    +1047     
- Partials     1610     1616       +6

Files	Coverage Δ
app/dns/nameserver_quic.go	`70.94% <ø> (ø)`
common/protocol/quic/sniff.go	`44.87% <ø> (ø)`
config.pb.go	`29.34% <ø> (ø)`
transport/internet/quic/conn.go	`58.00% <ø> (ø)`
transport/internet/quic/hub.go	`75.34% <100.00%> (+2.61%)`	⬆️
...ransport/internet/quic/congestion/bbr/bandwidth.go	`0.00% <0.00%> (ø)`
transport/internet/quic/congestion/bbr/clock.go	`0.00% <0.00%> (ø)`
transport/internet/grpc/dial.go	`3.27% <0.00%> (-0.06%)`	⬇️
transport/internet/quic/congestion/utils.go	`0.00% <0.00%> (ø)`
transport/internet/quic/dialer.go	`55.72% <63.33%> (-2.40%)`	⬇️
... and 8 more

... and 6 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JimmyHuang454 · 2023-10-26T04:00:58Z

I had merged newest commit and fixed go-lint.

xiaokangwang · 2023-10-28T19:06:32Z

Hi! Thanks for your contribution. Since this merge request includes switching the dependency, it will be a longer review process, however I will try my best to expatiate the process.

xiaokangwang · 2023-10-29T14:45:25Z

Hi, after some interal discuss, it seems there is no active maintainer within V2Ray could take over the maintaince of hysteria transport. Is it possible for you to refactor this code, so that the original quic transport is left as is, and make the necessary change to make hysteria a new transport that can be disabled when something goes wrong by removing the import line in https://github.com/v2fly/v2ray-core/blob/master/main/distro/all/all.go .

xiaokangwang · 2023-10-29T14:46:16Z

I am happy to merge it after the usage of forked quic from hysteria is isolated from main quic.

JimmyHuang454 · 2023-10-30T11:13:26Z

I am happy to merge it after the usage of forked quic from hysteria is isolated from main quic.

Thanks. I will dig into it later. But I have been very busy lately, and I may reply very late. Anyway, I will try my best.

JimmyHuang454 · 2024-04-08T17:24:56Z

Hi @xiaokangwang,

Apologies for the delay. I'm ready for the code review.

Here's what I've accomplished:

Added Hysteria2 transport to V2ray, utilizing QUIC and HTTP3

Now, any proxy protocol in V2ray can utilize Hy2 as a transport layer, such as trojan + hysteria2. You can review some transport tests for further details.

Implemented Hysteria2 proxy compatible with the official version

It functions well with the ordinary server I use. However, UDP requires additional testing. You can also examine some proxy tests for more insight.

Provided some real configuration examples

I'm uncertain about the appropriate location for these examples. They're mainly for testing purposes, so they might be subject to change.

Added documentation

For more detailed information, including special features, you can refer to the documentation.

dyhkwong · 2024-04-10T09:20:31Z

proxy/hysteria2/client.go

+	}
+	newError("tunneling request to ", destination, " via ", server.Destination().NetAddr()).WriteToLog(session.ExportIDToError(ctx))
+
+	hyConn, IsHy2Transport := conn.(*hy2_transport.HyConn)


If traffic stat is enabled, conn is *internet.StatCouterConnection but not *hysteria2.HyConn, this type assertion will fail.

Sorry, I don't handle any traffic statistics. Is it necessary? Because I need to expose the WritePacket() method of the transport connection to the proxy layer. If so, I believe I'll need to implement it more aggressively.

This is just a reminder and I don't know how widely it is used. Maybe usually some GUIs have traffic stats function?

By doing this

iConn := conn if statConn, ok := conn.(*internet.StatCouterConnection); ok { iConn = statConn.Connection } hyConn, IsHy2Transport := iConn.(*hy2_transport.HyConn)

I don't know if maintainers will consider it "overfit".

OK, I will figure out a better solution, any other comments？ Thanks.

dyhkwong · 2024-04-10T09:21:16Z

proxy/hysteria2/server.go

+func (s *Server) Process(ctx context.Context, network net.Network, conn internet.Connection, dispatcher routing.Dispatcher) error {
+	sid := session.ExportIDToError(ctx)
+
+	hyConn, IsHy2Transport := conn.(*hy2_transport.HyConn)


If traffic stat is enabled, conn is *internet.StatCouterConnection but not *hysteria2.HyConn, this type assertion will fail.

dyhkwong · 2024-04-10T17:11:21Z

proxy/hysteria2/protocol.go

+
+// ReadMultiBufferWithMetadata reads udp packet with destination
+func (r *PacketReader) ReadMultiBufferWithMetadata() (*PacketPayload, error) {
+	_, data, dest, _ := r.HyConn.ReadPacket()


Suggested change

_, data, dest, _ := r.HyConn.ReadPacket()

_, data, dest, err := r.HyConn.ReadPacket()

if err != nil {

return nil, err

}

Catch this error otherwise udp-disabled client will panic.

P.S. The whole code derived from trojan has many leftover that can be deleted.

I will fix it as you said. Thanks for the thorough review.

dyhkwong · 2024-04-25T04:50:27Z

Can you let hy2 transport's client use v2ray system dialer? I think implementing a custom ConnFactory with v2ray's function (internet.ListenSystemPacket or internet.DialSystem) is enough.

JimmyHuang454 · 2024-04-25T10:17:49Z

Can you let hy2 transport's client use v2ray system dialer? I think implementing a custom ConnFactory with v2ray's function (internet.ListenSystemPacket or internet.DialSystem) is enough.

I don't really get you, please elaborate it. In my opinion, this PR will not use "net.ListenUDP()" in JimmyHuang454/hysteria, it will hijack all traffic into v2ray.

dyhkwong · 2024-04-25T11:25:43Z

Android clients may use internet.UseAlternativeSystemDialer to replace v2ray system dialer (internet.DialSystem) to protect socket and prevent VPN traffic loopback. Currently hy2 does not comply with this.
~~(Nevermind I found QUIC transport doesn't comply with this too, see #1510. V2Ray just lacks a similar API for PacketConn. Maybe ignore this for now...)~~ QUIC transport uses internet.ListenSystemPacket instead. It seems that internet.ListenSystemPacket can be protected by internet.RegisterListenerController.

I mean something like the below.

(I don't know why context.Background() is used here, just copy from QUIC code as is.)

--- a/transport/internet/hysteria2/dialer.go
+++ b/transport/internet/hysteria2/dialer.go
@@ -52,6 +52,14 @@ func InitAddress(dest net.Destination) (net.Addr, error) {
        return destAddr, nil
 }

+type connFactory struct {
+       NewFunc func(addr net.Addr) (net.PacketConn, error)
+}
+
+func (f *connFactory) New(addr net.Addr) (net.PacketConn, error) {
+       return f.NewFunc(addr)
+}
+
 func NewHyClient(dest net.Destination, streamSettings *internet.MemoryStreamConfig) (hy_client.Client, error) {
        tlsConfig, err := InitTLSConifg(streamSettings)
        if err != nil {
@@ -68,6 +76,18 @@ func NewHyClient(dest net.Destination, streamSettings *internet.MemoryStreamConf
                TLSConfig:  *tlsConfig,
                Auth:       config.GetPassword(),
                ServerAddr: serverAddr,
+               ConnFactory: &connFactory{
+                       NewFunc: func(addr net.Addr) (net.PacketConn, error) {
+                               rawConn, err := internet.ListenSystemPacket(context.Background(), &net.UDPAddr{
+                                       IP:   []byte{0, 0, 0, 0},
+                                       Port: 0,
+                               }, streamSettings.SocketSettings)
+                               if err != nil {
+                                       return nil, err
+                               }
+                               return rawConn.(*net.UDPConn), nil
+                       },
+               },
        })
        if err != nil {
                return nil, err

JimmyHuang454 · 2024-05-09T09:20:58Z

Android clients may use internet.UseAlternativeSystemDialer to replace v2ray system dialer (internet.DialSystem) to protect socket and prevent VPN traffic loopback. Currently hy2 does not comply with this. ~~(Nevermind I found QUIC transport doesn't comply with this too, see #1510. V2Ray just lacks a similar API for PacketConn. Maybe ignore this for now...)~~ QUIC transport uses internet.ListenSystemPacket instead. It seems that internet.ListenSystemPacket can be protected by internet.RegisterListenerController.

I mean something like the below.

Thanks, you are right. I forgot to handle that on the client side.

CodingMoeButa · 2024-05-10T16:47:50Z

建议保留brutal作为quic的一种流控算法选择，不必考虑它与hysteria的兼容性，反正hysteria已经被作为新的协议和传输层实现了。多一种选择不是坏事。

dyhkwong · 2024-05-11T02:57:12Z

proxy/hysteria2/protocol.go

+	return int(quicvarint.Len(uint64(s)))
+}
+
+func (c *ConnWriter) writeTcpHeader() error {


Can this be replaced by hyProtocol.WriteTCPRequest?

dyhkwong · 2024-05-11T02:57:19Z

proxy/hysteria2/server.go

+		return newError("failed to send response").Base(err)
+	}
+
+	address := strings.Split(reqAddr, ":")


This doesn't work for IPv6. Maybe use net.SplitHostPort instead.

dyhkwong · 2024-05-11T03:00:16Z

transport/internet/hysteria2/dialer.go

+func InitTLSConifg(streamSettings *internet.MemoryStreamConfig) (*hyClient.TLSConfig, error) {
+	tlsSetting := CheckTLSConfig(streamSettings, true)
+	if tlsSetting == nil {
+		tlsSetting = &tls.Config{


There are ConfigFromStreamSettings and GetTLSConfig in github.com/v2fly/v2ray-core/v5/transport/internet/tls.

JimmyHuang454 added 18 commits October 3, 2023 10:18

Update Protobuf

671e06c

fix vprotogen check version

257cb9f

update README

11f6704

triger test

5d89c28

fix deprecated ReadFile()

b6a0f00

fix deprecated grpc.WithInsecure()

55cfdeb

use DialEarly and rename conns

2d4f7f0

replace quic-go with apernet/quic-go

e46987d

go mode tidy

b8768ed

add quic congestion

96a1e63

fix brutal congestion setting

b912374

add congestion to quic server

5daf391

try fix quic timeout

d789bfa

fix test

be6e364

Merge branch 'master' of github.com:v2fly/v2ray-core into dev

6478c8a

update vprotogen

ecfc7f4

fix BBR test

ea84415

go mod tidy

9327ddf

JimmyHuang454 added 4 commits October 26, 2023 10:52

Merge branch 'master' of github.com:v2fly/v2ray-core into dev

44e011f

update vprotogen

07478e6

add test and fix golint

150132d

go mod tidy

0b7f037

xiaokangwang added the Extensive Review Required Require an extensive review from organization owner, cannot be merged without owner approval label Oct 28, 2023

Merge branch 'master' of github.com:v2fly/v2ray-core into dev

a7b0ef4

JimmyHuang454 added 15 commits April 4, 2024 18:17

hysteria2 udp can not apply on others transport

860af00

other proxy protocol can use udpExtension

f5d3ba9

add udp test

3e133d1

remove fmt

b3c31b6

udp test ok

76f44b6

change test name and add udp test

a7399cd

need to fix addr

70071f8

add address to udp

c6dc7e0

test udp ok

50bc1f2

change config name

cde121f

change config name

6b0b561

Merge branch 'dev' of github.com:JimmyHuang454/v2ray-core into dev

63b5d2b

add example config

49ab4eb

update go mod

ab0f81b

fix test

78f563a

dyhkwong reviewed Apr 10, 2024

View reviewed changes

remove legacy code, add traffic counter(Only TCP), add err checker

cdbd68d

JimmyHuang454 added 4 commits May 6, 2024 10:45

update example

91c2d87

Merge branch 'master' of github.com:v2fly/v2ray-core into dev

76051df

fix hysteria2OnTCP and use ListenSystemPacket

08ea4ef

Merge branch 'master' of github.com:v2fly/v2ray-core into dev

725e120

rename

09e1776

dyhkwong suggested changes May 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Hysteria2 Protocol #2721

Add Hysteria2 Protocol #2721

JimmyHuang454 commented Oct 22, 2023

codecov-commenter commented Oct 24, 2023 •

edited

JimmyHuang454 commented Oct 26, 2023

xiaokangwang commented Oct 28, 2023

xiaokangwang commented Oct 29, 2023

xiaokangwang commented Oct 29, 2023

JimmyHuang454 commented Oct 30, 2023

JimmyHuang454 commented Apr 8, 2024

dyhkwong Apr 10, 2024

JimmyHuang454 Apr 10, 2024

dyhkwong Apr 10, 2024

JimmyHuang454 Apr 10, 2024

dyhkwong Apr 10, 2024

dyhkwong Apr 10, 2024

dyhkwong Apr 10, 2024

JimmyHuang454 Apr 10, 2024

dyhkwong commented Apr 25, 2024

JimmyHuang454 commented Apr 25, 2024

dyhkwong commented Apr 25, 2024 •

edited

JimmyHuang454 commented May 9, 2024

CodingMoeButa commented May 10, 2024

dyhkwong May 11, 2024

dyhkwong May 11, 2024

dyhkwong May 11, 2024

Add Hysteria2 Protocol #2721

Are you sure you want to change the base?

Add Hysteria2 Protocol #2721

Conversation

JimmyHuang454 commented Oct 22, 2023

Use hysteria's quic-go to support BBR and brutal congestion algorithm

Fix vprotogen bug and update all Protobuf data

Update go version to 1.21

codecov-commenter commented Oct 24, 2023 • edited

Codecov Report

JimmyHuang454 commented Oct 26, 2023

xiaokangwang commented Oct 28, 2023

xiaokangwang commented Oct 29, 2023

xiaokangwang commented Oct 29, 2023

JimmyHuang454 commented Oct 30, 2023

JimmyHuang454 commented Apr 8, 2024

Added Hysteria2 transport to V2ray, utilizing QUIC and HTTP3

Implemented Hysteria2 proxy compatible with the official version

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dyhkwong commented Apr 25, 2024

JimmyHuang454 commented Apr 25, 2024

dyhkwong commented Apr 25, 2024 • edited

JimmyHuang454 commented May 9, 2024

CodingMoeButa commented May 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fix `vprotogen` bug and update all Protobuf data

codecov-commenter commented Oct 24, 2023 •

edited

dyhkwong commented Apr 25, 2024 •

edited