9 "github.com/anacrolix/dht"
10 "github.com/anacrolix/dht/krpc"
11 "github.com/anacrolix/missinggo"
12 "github.com/anacrolix/missinggo/conntrack"
13 "github.com/anacrolix/missinggo/expect"
14 "github.com/anacrolix/torrent/iplist"
15 "github.com/anacrolix/torrent/mse"
16 "github.com/anacrolix/torrent/storage"
17 "golang.org/x/time/rate"
20 var DefaultHTTPUserAgent = "Go-Torrent/1.0"
22 // Probably not safe to modify this after it's given to a Client.
23 type ClientConfig struct {
24 // Store torrent file data in this directory unless .DefaultStorage is
26 DataDir string `long:"data-dir" description:"directory to store downloaded torrent data"`
27 // The address to listen for new uTP and TCP bittorrent protocol
28 // connections. DHT shares a UDP socket with uTP unless configured
30 ListenHost func(network string) string
32 NoDefaultPortForwarding bool
33 // Don't announce to trackers. This only leaves DHT to discover peers.
34 DisableTrackers bool `long:"disable-trackers"`
35 DisablePEX bool `long:"disable-pex"`
37 // Don't create a DHT.
38 NoDHT bool `long:"disable-dht"`
39 DhtStartingNodes dht.StartingNodesGetter
40 // Never send chunks to peers.
41 NoUpload bool `long:"no-upload"`
42 // Disable uploading even when it isn't fair.
43 DisableAggressiveUpload bool `long:"disable-aggressive-upload"`
44 // Upload even after there's nothing in it for us. By default uploading is
45 // not altruistic, we'll only upload to encourage the peer to reciprocate.
46 Seed bool `long:"seed"`
47 // Only applies to chunks uploaded to peers, to maintain responsiveness
48 // communicating local Client state to peers. Each limiter token
49 // represents one byte. The Limiter's burst must be large enough to fit a
50 // whole chunk, which is usually 16 KiB (see TorrentSpec.ChunkSize).
51 UploadRateLimiter *rate.Limiter
52 // Rate limits all reads from connections to peers. Each limiter token
53 // represents one byte. The Limiter's burst must be bigger than the
54 // largest Read performed on a the underlying rate-limiting io.Reader
55 // minus one. This is likely to be the larger of the main read loop buffer
56 // (~4096), and the requested chunk size (~16KiB, see
57 // TorrentSpec.ChunkSize).
58 DownloadRateLimiter *rate.Limiter
60 // User-provided Client peer ID. If not present, one is generated automatically.
62 // For the bittorrent protocol.
64 // For the bittorrent protocol.
65 DisableTCP bool `long:"disable-tcp"`
66 // Called to instantiate storage for each added torrent. Builtin backends
67 // are in the storage package. If not set, the "file" implementation is
69 DefaultStorage storage.ClientImpl
71 HeaderObfuscationPolicy HeaderObfuscationPolicy
72 // The crypto methods to offer when initiating connections with header obfuscation.
73 CryptoProvides mse.CryptoMethod
74 // Chooses the crypto method to use when receiving connections with header obfuscation.
75 CryptoSelector mse.CryptoSelector
77 // Sets usage of Socks5 Proxy. Authentication should be included in the url if needed.
78 // Examples: socks5://demo:demo@192.168.99.100:1080
79 // http://proxy.domain.com:3128
82 IPBlocklist iplist.Ranger
83 DisableIPv6 bool `long:"disable-ipv6"`
86 // Perform logging and any other behaviour that will help debug.
87 Debug bool `help:"enable debugging"`
89 // HTTPProxy defines proxy for HTTP requests.
90 // Format: func(*Request) (*url.URL, error),
91 // or result of http.ProxyURL(HTTPProxy).
92 // By default, it is composed from ClientConfig.ProxyURL,
93 // if not set explicitly in ClientConfig struct
94 HTTPProxy func(*http.Request) (*url.URL, error)
95 // HTTPUserAgent changes default UserAgent for HTTP requests
97 // Updated occasionally to when there's been some changes to client
98 // behaviour in case other clients are assuming anything of us. See also
100 ExtendedHandshakeClientVersion string
101 // Peer ID client identifier prefix. We'll update this occasionally to
102 // reflect changes to client behaviour that other clients may depend on.
103 // Also see `extendedHandshakeClientVersion`.
106 // Peer dial timeout to use when there are limited peers.
107 NominalDialTimeout time.Duration
108 // Minimum peer dial timeout to use (even if we have lots of peers).
109 MinDialTimeout time.Duration
110 EstablishedConnsPerTorrent int
111 HalfOpenConnsPerTorrent int
112 // Maximum number of peer addresses in reserve.
113 TorrentPeersHighWater int
114 // Minumum number of peers before effort is made to obtain more peers.
115 TorrentPeersLowWater int
117 // Limit how long handshake can take. This is to reduce the lingering
118 // impact of a few bad apples. 4s loses 1% of successful handshakes that
119 // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
120 HandshakesTimeout time.Duration
122 // The IP addresses as our peers should see them. May differ from the
123 // local interfaces due to NAT or other network configurations.
127 DisableAcceptRateLimiting bool
128 // Don't add connections that have the same peer ID as an existing
129 // connection for a given Torrent.
130 dropDuplicatePeerIds bool
132 ConnTracker *conntrack.Instance
135 DHTOnQuery func(query *krpc.Msg, source net.Addr) (propagate bool)
138 func (cfg *ClientConfig) SetListenAddr(addr string) *ClientConfig {
139 host, port, err := missinggo.ParseHostPort(addr)
141 cfg.ListenHost = func(string) string { return host }
142 cfg.ListenPort = port
146 func NewDefaultClientConfig() *ClientConfig {
148 HTTPUserAgent: DefaultHTTPUserAgent,
149 ExtendedHandshakeClientVersion: "go.torrent dev 20181121",
151 NominalDialTimeout: 20 * time.Second,
152 MinDialTimeout: 3 * time.Second,
153 EstablishedConnsPerTorrent: 50,
154 HalfOpenConnsPerTorrent: 25,
155 TorrentPeersHighWater: 500,
156 TorrentPeersLowWater: 50,
157 HandshakesTimeout: 4 * time.Second,
158 DhtStartingNodes: dht.GlobalBootstrapAddrs,
159 ListenHost: func(string) string { return "" },
160 UploadRateLimiter: unlimited,
161 DownloadRateLimiter: unlimited,
162 ConnTracker: conntrack.NewInstance(),
163 HeaderObfuscationPolicy: HeaderObfuscationPolicy{
165 RequirePreferred: false,
167 CryptoSelector: mse.DefaultCryptoSelector,
168 CryptoProvides: mse.AllSupportedCrypto,
171 cc.ConnTracker.SetNoMaxEntries()
172 cc.ConnTracker.Timeout = func(conntrack.Entry) time.Duration { return 0 }
176 type HeaderObfuscationPolicy struct {
177 RequirePreferred bool // Whether the value of Preferred is a strict requirement.
178 Preferred bool // Whether header obfuscation is preferred.