9 "github.com/anacrolix/dht"
10 "golang.org/x/time/rate"
12 "github.com/anacrolix/torrent/iplist"
13 "github.com/anacrolix/torrent/storage"
16 var DefaultHTTPClient = &http.Client{
17 Timeout: time.Second * 15,
18 Transport: &http.Transport{
20 Timeout: 15 * time.Second,
22 TLSHandshakeTimeout: 15 * time.Second,
23 TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
26 var DefaultHTTPUserAgent = "Go-Torrent/1.0"
28 // Override Client defaults.
30 // Store torrent file data in this directory unless .DefaultStorage is
32 DataDir string `long:"data-dir" description:"directory to store downloaded torrent data"`
33 // The address to listen for new uTP and TCP bittorrent protocol
34 // connections. DHT shares a UDP socket with uTP unless configured
36 ListenAddr string `long:"listen-addr" value-name:"HOST:PORT"`
37 NoDefaultPortForwarding bool
38 // Don't announce to trackers. This only leaves DHT to discover peers.
39 DisableTrackers bool `long:"disable-trackers"`
40 DisablePEX bool `long:"disable-pex"`
41 // Don't create a DHT.
42 NoDHT bool `long:"disable-dht"`
43 // Overrides the default DHT configuration.
44 DHTConfig dht.ServerConfig
46 // Never send chunks to peers.
47 NoUpload bool `long:"no-upload"`
48 // Disable uploading even when it isn't fair.
49 DisableAggressiveUpload bool `long:"disable-aggressive-upload"`
50 // Upload even after there's nothing in it for us. By default uploading is
51 // not altruistic, we'll upload slightly more than we download from each
53 Seed bool `long:"seed"`
54 // Only applies to chunks uploaded to peers, to maintain responsiveness
55 // communicating local Client state to peers. Each limiter token
56 // represents one byte. The Limiter's burst must be large enough to fit a
57 // whole chunk, which is usually 16 KiB (see TorrentSpec.ChunkSize).
58 UploadRateLimiter *rate.Limiter
59 // Rate limits all reads from connections to peers. Each limiter token
60 // represents one byte. The Limiter's burst must be bigger than the
61 // largest Read performed on a the underlying rate-limiting io.Reader
62 // minus one. This is likely to be the larger of the main read loop buffer
63 // (~4096), and the requested chunk size (~16KiB, see
64 // TorrentSpec.ChunkSize).
65 DownloadRateLimiter *rate.Limiter
67 // User-provided Client peer ID. If not present, one is generated automatically.
69 // For the bittorrent protocol.
71 // For the bittorrent protocol.
72 DisableTCP bool `long:"disable-tcp"`
73 // Called to instantiate storage for each added torrent. Builtin backends
74 // are in the storage package. If not set, the "file" implementation is
76 DefaultStorage storage.ClientImpl
80 IPBlocklist iplist.Ranger
81 DisableIPv6 bool `long:"disable-ipv6"`
84 // Perform logging and any other behaviour that will help debug.
85 Debug bool `help:"enable debugging"`
87 // HTTP client used to query the tracker endpoint. Default is DefaultHTTPClient
89 // HTTPUserAgent changes default UserAgent for HTTP requests
90 HTTPUserAgent string `long:"http-user-agent"`
91 // Updated occasionally to when there's been some changes to client
92 // behaviour in case other clients are assuming anything of us. See also
94 ExtendedHandshakeClientVersion string // default "go.torrent dev 20150624"
95 // Peer ID client identifier prefix. We'll update this occasionally to
96 // reflect changes to client behaviour that other clients may depend on.
97 // Also see `extendedHandshakeClientVersion`.
98 Bep20 string // default "-GT0001-"
100 NominalDialTimeout time.Duration // default time.Second * 30
101 MinDialTimeout time.Duration // default 5 * time.Second
102 EstablishedConnsPerTorrent int // default 80
103 HalfOpenConnsPerTorrent int // default 80
104 TorrentPeersHighWater int // default 200
105 TorrentPeersLowWater int // default 50
107 // Limit how long handshake can take. This is to reduce the lingering
108 // impact of a few bad apples. 4s loses 1% of successful handshakes that
109 // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
110 HandshakesTimeout time.Duration // default 20 * time.Second
113 func (cfg *Config) setDefaults() {
115 cfg.HTTP = DefaultHTTPClient
117 if cfg.HTTPUserAgent == "" {
118 cfg.HTTPUserAgent = DefaultHTTPUserAgent
120 if cfg.ExtendedHandshakeClientVersion == "" {
121 cfg.ExtendedHandshakeClientVersion = "go.torrent dev 20150624"
124 cfg.Bep20 = "-GT0001-"
126 if cfg.NominalDialTimeout == 0 {
127 cfg.NominalDialTimeout = 30 * time.Second
129 if cfg.MinDialTimeout == 0 {
130 cfg.MinDialTimeout = 5 * time.Second
132 if cfg.EstablishedConnsPerTorrent == 0 {
133 cfg.EstablishedConnsPerTorrent = 50
135 if cfg.HalfOpenConnsPerTorrent == 0 {
136 cfg.HalfOpenConnsPerTorrent = (cfg.EstablishedConnsPerTorrent + 1) / 2
138 if cfg.TorrentPeersHighWater == 0 {
139 // Memory and freshness are the concern here.
140 cfg.TorrentPeersHighWater = 500
142 if cfg.TorrentPeersLowWater == 0 {
143 cfg.TorrentPeersLowWater = 2 * cfg.HalfOpenConnsPerTorrent
145 if cfg.HandshakesTimeout == 0 {
146 cfg.HandshakesTimeout = 20 * time.Second
150 type EncryptionPolicy struct {
151 DisableEncryption bool
152 ForceEncryption bool // Don't allow unobfuscated connections.
153 PreferNoEncryption bool