9 "github.com/anacrolix/dht"
10 "github.com/anacrolix/missinggo"
11 "github.com/anacrolix/missinggo/expect"
12 "golang.org/x/time/rate"
14 "github.com/anacrolix/torrent/iplist"
15 "github.com/anacrolix/torrent/storage"
18 var DefaultHTTPUserAgent = "Go-Torrent/1.0"
20 // Probably not safe to modify this after it's given to a Client.
21 type ClientConfig struct {
22 // Store torrent file data in this directory unless .DefaultStorage is
24 DataDir string `long:"data-dir" description:"directory to store downloaded torrent data"`
25 // The address to listen for new uTP and TCP bittorrent protocol
26 // connections. DHT shares a UDP socket with uTP unless configured
28 ListenHost func(network string) string
30 NoDefaultPortForwarding bool
31 // Don't announce to trackers. This only leaves DHT to discover peers.
32 DisableTrackers bool `long:"disable-trackers"`
33 DisablePEX bool `long:"disable-pex"`
35 // Don't create a DHT.
36 NoDHT bool `long:"disable-dht"`
37 DhtStartingNodes dht.StartingNodesGetter
38 // Never send chunks to peers.
39 NoUpload bool `long:"no-upload"`
40 // Disable uploading even when it isn't fair.
41 DisableAggressiveUpload bool `long:"disable-aggressive-upload"`
42 // Upload even after there's nothing in it for us. By default uploading is
43 // not altruistic, we'll only upload to encourage the peer to reciprocate.
44 Seed bool `long:"seed"`
45 // Only applies to chunks uploaded to peers, to maintain responsiveness
46 // communicating local Client state to peers. Each limiter token
47 // represents one byte. The Limiter's burst must be large enough to fit a
48 // whole chunk, which is usually 16 KiB (see TorrentSpec.ChunkSize).
49 UploadRateLimiter *rate.Limiter
50 // Rate limits all reads from connections to peers. Each limiter token
51 // represents one byte. The Limiter's burst must be bigger than the
52 // largest Read performed on a the underlying rate-limiting io.Reader
53 // minus one. This is likely to be the larger of the main read loop buffer
54 // (~4096), and the requested chunk size (~16KiB, see
55 // TorrentSpec.ChunkSize).
56 DownloadRateLimiter *rate.Limiter
58 // User-provided Client peer ID. If not present, one is generated automatically.
60 // For the bittorrent protocol.
62 // For the bittorrent protocol.
63 DisableTCP bool `long:"disable-tcp"`
64 // Called to instantiate storage for each added torrent. Builtin backends
65 // are in the storage package. If not set, the "file" implementation is
67 DefaultStorage storage.ClientImpl
71 // Sets usage of Socks5 Proxy. Authentication should be included in the url if needed.
72 // Example of setting: "socks5://demo:demo@192.168.99.100:1080"
75 IPBlocklist iplist.Ranger
76 DisableIPv6 bool `long:"disable-ipv6"`
79 // Perform logging and any other behaviour that will help debug.
80 Debug bool `help:"enable debugging"`
82 // For querying HTTP trackers.
83 TrackerHttpClient *http.Client
84 // HTTPUserAgent changes default UserAgent for HTTP requests
86 // Updated occasionally to when there's been some changes to client
87 // behaviour in case other clients are assuming anything of us. See also
89 ExtendedHandshakeClientVersion string // default "go.torrent dev 20150624"
90 // Peer ID client identifier prefix. We'll update this occasionally to
91 // reflect changes to client behaviour that other clients may depend on.
92 // Also see `extendedHandshakeClientVersion`.
93 Bep20 string // default "-GT0001-"
95 // Peer dial timeout to use when there are limited peers.
96 NominalDialTimeout time.Duration
97 // Minimum peer dial timeout to use (even if we have lots of peers).
98 MinDialTimeout time.Duration
99 EstablishedConnsPerTorrent int
100 HalfOpenConnsPerTorrent int
101 TorrentPeersHighWater int
102 TorrentPeersLowWater int
104 // Limit how long handshake can take. This is to reduce the lingering
105 // impact of a few bad apples. 4s loses 1% of successful handshakes that
106 // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
107 HandshakesTimeout time.Duration
112 DisableAcceptRateLimiting bool
113 dropDuplicatePeerIds bool
116 func (cfg *ClientConfig) SetListenAddr(addr string) *ClientConfig {
117 host, port, err := missinggo.ParseHostPort(addr)
119 cfg.ListenHost = func(string) string { return host }
120 cfg.ListenPort = port
124 func NewDefaultClientConfig() *ClientConfig {
125 return &ClientConfig{
126 TrackerHttpClient: &http.Client{
127 Timeout: time.Second * 15,
128 Transport: &http.Transport{
130 Timeout: 15 * time.Second,
132 TLSHandshakeTimeout: 15 * time.Second,
133 TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
135 HTTPUserAgent: DefaultHTTPUserAgent,
136 ExtendedHandshakeClientVersion: "go.torrent dev 20150624",
138 NominalDialTimeout: 20 * time.Second,
139 MinDialTimeout: 3 * time.Second,
140 EstablishedConnsPerTorrent: 50,
141 HalfOpenConnsPerTorrent: 25,
142 TorrentPeersHighWater: 500,
143 TorrentPeersLowWater: 50,
144 HandshakesTimeout: 4 * time.Second,
145 DhtStartingNodes: dht.GlobalBootstrapAddrs,
146 ListenHost: func(string) string { return "" },
147 UploadRateLimiter: unlimited,
148 DownloadRateLimiter: unlimited,
152 type EncryptionPolicy struct {
153 DisableEncryption bool
154 ForceEncryption bool // Don't allow unobfuscated connections.
155 PreferNoEncryption bool