config.go

   1 package torrent
   2
   3 import (
   4         "net"
   5         "net/http"
   6         "net/url"
   7         "time"
   8
   9         "github.com/anacrolix/dht/v2"
  10         "github.com/anacrolix/dht/v2/krpc"
  11         "github.com/anacrolix/log"
  12         "github.com/anacrolix/missinggo"
  13         "github.com/anacrolix/missinggo/expect"
  14         "github.com/anacrolix/missinggo/v2/conntrack"
  15         "golang.org/x/time/rate"
  16
  17         "github.com/anacrolix/torrent/iplist"
  18         "github.com/anacrolix/torrent/mse"
  19         "github.com/anacrolix/torrent/storage"
  20 )
  21
  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
  25         // specified.
  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 connections. DHT shares a UDP
  28         // socket with uTP unless configured otherwise.
  29         ListenHost              func(network string) string
  30         ListenPort              int
  31         NoDefaultPortForwarding bool
  32         UpnpID                  string
  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"`
  36
  37         // Don't create a DHT.
  38         NoDHT            bool `long:"disable-dht"`
  39         DhtStartingNodes func(network string) 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
  59
  60         // User-provided Client peer ID. If not present, one is generated automatically.
  61         PeerID string
  62         // For the bittorrent protocol.
  63         DisableUTP bool
  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
  68         // used (and Closed when the Client is Closed).
  69         DefaultStorage storage.ClientImpl
  70
  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
  76
  77         IPBlocklist      iplist.Ranger
  78         DisableIPv6      bool `long:"disable-ipv6"`
  79         DisableIPv4      bool
  80         DisableIPv4Peers bool
  81         // Perform logging and any other behaviour that will help debug.
  82         Debug  bool `help:"enable debugging"`
  83         Logger log.Logger
  84
  85         // Defines proxy for HTTP requests, such as for trackers. It's commonly set from the result of
  86         // "net/http".ProxyURL(HTTPProxy).
  87         HTTPProxy func(*http.Request) (*url.URL, error)
  88         // HTTPUserAgent changes default UserAgent for HTTP requests
  89         HTTPUserAgent string
  90         // Updated occasionally to when there's been some changes to client
  91         // behaviour in case other clients are assuming anything of us. See also
  92         // `bep20`.
  93         ExtendedHandshakeClientVersion string
  94         // Peer ID client identifier prefix. We'll update this occasionally to
  95         // reflect changes to client behaviour that other clients may depend on.
  96         // Also see `extendedHandshakeClientVersion`.
  97         Bep20 string
  98
  99         // Peer dial timeout to use when there are limited peers.
 100         NominalDialTimeout time.Duration
 101         // Minimum peer dial timeout to use (even if we have lots of peers).
 102         MinDialTimeout             time.Duration
 103         EstablishedConnsPerTorrent int
 104         HalfOpenConnsPerTorrent    int
 105         TotalHalfOpenConns         int
 106         // Maximum number of peer addresses in reserve.
 107         TorrentPeersHighWater int
 108         // Minumum number of peers before effort is made to obtain more peers.
 109         TorrentPeersLowWater int
 110
 111         // Limit how long handshake can take. This is to reduce the lingering
 112         // impact of a few bad apples. 4s loses 1% of successful handshakes that
 113         // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
 114         HandshakesTimeout time.Duration
 115
 116         // The IP addresses as our peers should see them. May differ from the
 117         // local interfaces due to NAT or other network configurations.
 118         PublicIp4 net.IP
 119         PublicIp6 net.IP
 120
 121         // Accept rate limiting affects excessive connection attempts from IPs that fail during
 122         // handshakes or request torrents that we don't have.
 123         DisableAcceptRateLimiting bool
 124         // Don't add connections that have the same peer ID as an existing
 125         // connection for a given Torrent.
 126         DropDuplicatePeerIds bool
 127
 128         ConnTracker *conntrack.Instance
 129
 130         // OnQuery hook func
 131         DHTOnQuery func(query *krpc.Msg, source net.Addr) (propagate bool)
 132
 133         DefaultRequestStrategy requestStrategyMaker
 134
 135         Extensions PeerExtensionBits
 136
 137         DisableWebtorrent bool
 138         DisableWebseeds   bool
 139
 140         Callbacks Callbacks
 141 }
 142
 143 func (cfg *ClientConfig) SetListenAddr(addr string) *ClientConfig {
 144         host, port, err := missinggo.ParseHostPort(addr)
 145         expect.Nil(err)
 146         cfg.ListenHost = func(string) string { return host }
 147         cfg.ListenPort = port
 148         return cfg
 149 }
 150
 151 func NewDefaultClientConfig() *ClientConfig {
 152         cc := &ClientConfig{
 153                 HTTPUserAgent:                  "Go-Torrent/1.0",
 154                 ExtendedHandshakeClientVersion: "go.torrent dev 20181121",
 155                 Bep20:                          "-GT0002-",
 156                 UpnpID:                         "anacrolix/torrent",
 157                 NominalDialTimeout:             20 * time.Second,
 158                 MinDialTimeout:                 3 * time.Second,
 159                 EstablishedConnsPerTorrent:     50,
 160                 HalfOpenConnsPerTorrent:        25,
 161                 TotalHalfOpenConns:             100,
 162                 TorrentPeersHighWater:          500,
 163                 TorrentPeersLowWater:           50,
 164                 HandshakesTimeout:              4 * time.Second,
 165                 DhtStartingNodes: func(network string) dht.StartingNodesGetter {
 166                         return func() ([]dht.Addr, error) { return dht.GlobalBootstrapAddrs(network) }
 167                 },
 168                 ListenHost:                func(string) string { return "" },
 169                 UploadRateLimiter:         unlimited,
 170                 DownloadRateLimiter:       unlimited,
 171                 ConnTracker:               conntrack.NewInstance(),
 172                 DisableAcceptRateLimiting: true,
 173                 HeaderObfuscationPolicy: HeaderObfuscationPolicy{
 174                         Preferred:        true,
 175                         RequirePreferred: false,
 176                 },
 177                 CryptoSelector: mse.DefaultCryptoSelector,
 178                 CryptoProvides: mse.AllSupportedCrypto,
 179                 ListenPort:     42069,
 180                 Logger:         log.Default,
 181
 182                 DefaultRequestStrategy: RequestStrategyDuplicateRequestTimeout(5 * time.Second),
 183
 184                 Extensions: defaultPeerExtensionBytes(),
 185         }
 186         //cc.ConnTracker.SetNoMaxEntries()
 187         //cc.ConnTracker.Timeout = func(conntrack.Entry) time.Duration { return 0 }
 188         return cc
 189 }
 190
 191 type HeaderObfuscationPolicy struct {
 192         RequirePreferred bool // Whether the value of Preferred is a strict requirement.
 193         Preferred        bool // Whether header obfuscation is preferred.
 194 }