Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disorder strategy from byeDPI #323

Merged
merged 8 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions x/configurl/disorder.go
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Copyright 2024 The Outline Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package configurl

import (
"context"
"fmt"
"strconv"

"github.com/Jigsaw-Code/outline-sdk/transport"
"github.com/Jigsaw-Code/outline-sdk/x/disorder"
)

func registerDisorderDialer(r TypeRegistry[transport.StreamDialer], typeID string, newSD BuildFunc[transport.StreamDialer]) {
r.RegisterType(typeID, func(ctx context.Context, config *Config) (transport.StreamDialer, error) {
sd, err := newSD(ctx, config.BaseConfig)
if err != nil {
return nil, err
}
disorderPacketNStr := config.URL.Opaque
disorderPacketN, err := strconv.Atoi(disorderPacketNStr)
if err != nil {
return nil, fmt.Errorf("disoder: could not parse splice position: %v", err)
}
return disorder.NewStreamDialer(sd, disorderPacketN)
})
}
23 changes: 23 additions & 0 deletions x/configurl/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,35 @@ For more details, refer to [github.com/Jigsaw-Code/outline-sdk/transport/tlsfrag

tlsfrag:[LENGTH]

Disorder transport (streams only, package [github.com/Jigsaw-Code/outline-sdk/x/disorder])
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved

The disorder strategy sends TCP packets out of order by manipulating the
socket's Time To Live (TTL) or Hop Limit. It temporarily sets the TTL to a low
value, causing specific packets to be dropped early in the network (like at the
first router). These dropped packets are then re-transmitted later by the TCP
stack, resulting in the receiver getting packets out of order. This can help
bypass network filters that rely on inspecting the initial packets of a TCP
connection.

disorder:[PACKET_NUMBER]

PACKET_NUMBER: The number of writes before the disorder action occurs. The
disorder action triggers when the number of writes equals PACKET_NUMBER. If set
to 0 (default), the disorder happens on the first write. If set to 1, it happens
on the second write, and so on.

# Examples

Packet splitting - To split outgoing streams on bytes 2 and 123, you can use:

split:2|split:123

Disorder transport - Send some of the packets out of order
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Disorder transport - Send some of the packets out of order
Disorder transport - Send some of the packets out of order:


disorder:0|split:123

Split at position 123, then send packet 0 of 123 bytes (from splitting) out of order. The network filter will first receive packet 1, only then packet 0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Split at position 123, then send packet 0 of 123 bytes (from splitting) out of order. The network filter will first receive packet 1, only then packet 0.
Split at position 123, then send packet 0 of 123 bytes (from splitting) out of order. The network filter will first receive packet 1, only then packet 0. This is done by setting the hop limit for the write to 1, and then restoring it. It will be sent with its original hop limit on retransmission.


Evading DNS and SNI blocking - You can use Cloudflare's DNS-over-HTTPS to protect against DNS disruption.
The DoH resolver cloudflare-dns.com is accessible from any cloudflare.net IP, so you can specify the address to avoid blocking
of the resolver itself. This can be combines with a TCP split or TLS Record Fragmentation to bypass SNI-based blocking:
Expand Down
1 change: 1 addition & 0 deletions x/configurl/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func NewProviderContainer() *ProviderContainer {
// RegisterDefaultProviders registers a set of default providers with the providers in [ProviderContainer].
func RegisterDefaultProviders(c *ProviderContainer) *ProviderContainer {
// Please keep the list in alphabetical order.
registerDisorderDialer(&c.StreamDialers, "disorder", c.StreamDialers.NewInstance)
registerDO53StreamDialer(&c.StreamDialers, "do53", c.StreamDialers.NewInstance, c.PacketDialers.NewInstance)
registerDOHStreamDialer(&c.StreamDialers, "doh", c.StreamDialers.NewInstance)

Expand Down
71 changes: 71 additions & 0 deletions x/disorder/stream_dialer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright 2024 The Outline Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package disorder

import (
"context"
"errors"
"fmt"
"net"

"github.com/Jigsaw-Code/outline-sdk/transport"
"github.com/Jigsaw-Code/outline-sdk/x/sockopt"
)

type disorderDialer struct {
dialer transport.StreamDialer
disorderPacketN int
}

var _ transport.StreamDialer = (*disorderDialer)(nil)

// NewStreamDialer creates a [transport.StreamDialer]
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
// It work almost the same as the other split dialer, however, it also manipulates socket TTL:
// * Before sending the first prefixBytes TTL is set to 1
// * This packet is dropped somewhere in the network and never reaches the server
// * TTL is restored
// * The next part of data is sent normally
// * Server notices the lost fragment and requests re-transmission
// Currently this only works with Linux kernel (for Windows/Mac a different implementation is required)
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
func NewStreamDialer(dialer transport.StreamDialer, disorderPacketN int) (transport.StreamDialer, error) {
if dialer == nil {
return nil, errors.New("argument dialer must not be nil")
}
if disorderPacketN < 0 {
return nil, fmt.Errorf("disorder argument must be >= 0, got %d", disorderPacketN)
}
return &disorderDialer{dialer: dialer, disorderPacketN: disorderPacketN}, nil
}

// DialStream implements [transport.StreamDialer].DialStream.
func (d *disorderDialer) DialStream(ctx context.Context, remoteAddr string) (transport.StreamConn, error) {
innerConn, err := d.dialer.DialStream(ctx, remoteAddr)
if err != nil {
return nil, err
}

tcpInnerConn, ok := innerConn.(*net.TCPConn)
if !ok {
return nil, fmt.Errorf("disorder strategy: expected base dialer to return TCPConn")
}
tcpOptions, err := sockopt.NewTCPOptions(tcpInnerConn)
if err != nil {
return nil, err
}

dw := NewWriter(innerConn, tcpOptions, d.disorderPacketN)

return transport.WrapConn(innerConn, innerConn, dw), nil
}
76 changes: 76 additions & 0 deletions x/disorder/writer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
// Copyright 2024 The Outline Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package disorder

import (
"fmt"
"io"

"github.com/Jigsaw-Code/outline-sdk/x/sockopt"
)

type disorderWriter struct {
conn io.Writer
tcpOptions sockopt.TCPOptions
writesToDisorder int
}

var _ io.Writer = (*disorderWriter)(nil)

// Setting number of hops to 1 will lead to data to get lost on host
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
var disorderHopN = 1

func NewWriter(conn io.Writer, tcpOptions sockopt.TCPOptions, runAtPacketN int) io.Writer {
// TODO: Support ReadFrom.
return &disorderWriter{
conn: conn,
tcpOptions: tcpOptions,
writesToDisorder: runAtPacketN,
}
}

func (w *disorderWriter) Write(data []byte) (written int, err error) {
if w.writesToDisorder == 0 {
defaultHopLimit, err := w.tcpOptions.HopLimit()
if err != nil {
return 0, fmt.Errorf("failed to get the hop limit: %w", err)
}

err = w.tcpOptions.SetHopLimit(disorderHopN)
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
fortuna marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return 0, fmt.Errorf("failed to set the hop limit to %d: %w", disorderHopN, err)
fortuna marked this conversation as resolved.
Show resolved Hide resolved
}

defer func() {
// The packet with low hop limit was sent
// Make next calls send data normally
//
// The packet with the low hop limit will get resent by the kernel later
// The network filters will receive data out of order
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
err = w.tcpOptions.SetHopLimit(defaultHopLimit)
if err != nil {
err = fmt.Errorf("failed to set the hop limit error %d: %w", defaultHopLimit, err)
fortuna marked this conversation as resolved.
Show resolved Hide resolved
}
}()
}

// The packet will get lost at the first send, since the hop limit is too low
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// The packet will get lost at the first send, since the hop limit is too low
// The packet will get lost at the first send, since the hop limit is too low.

n, err := w.conn.Write(data)

// TODO: Wait for queued data to be sent by the kernel to the socket
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if the OS will respect the splits if we change options between writes.

PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved

w.writesToDisorder -= 1
PeterZhizhin marked this conversation as resolved.
Show resolved Hide resolved
return n, err
}