config.go

   1 package torrent
   2
   3 import (
   4         "crypto/tls"
   5         "net"
   6         "net/http"
   7         "time"
   8
   9         "github.com/anacrolix/dht"
  10         "golang.org/x/time/rate"
  11
  12         "github.com/anacrolix/torrent/iplist"
  13         "github.com/anacrolix/torrent/storage"
  14 )
  15
  16 var DefaultHTTPClient = &http.Client{
  17         Timeout: time.Second * 15,
  18         Transport: &http.Transport{
  19                 Dial: (&net.Dialer{
  20                         Timeout: 15 * time.Second,
  21                 }).Dial,
  22                 TLSHandshakeTimeout: 15 * time.Second,
  23                 TLSClientConfig:     &tls.Config{InsecureSkipVerify: true},
  24         },
  25 }
  26 var DefaultHTTPUserAgent = "Go-Torrent/1.0"
  27
  28 // Override Client defaults.
  29 type Config struct {
  30         // Store torrent file data in this directory unless .DefaultStorage is
  31         // specified.
  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
  35         // otherwise.
  36         ListenAddr string `long:"listen-addr" value-name:"HOST:PORT"`
  37         // Don't announce to trackers. This only leaves DHT to discover peers.
  38         DisableTrackers bool `long:"disable-trackers"`
  39         DisablePEX      bool `long:"disable-pex"`
  40         // Don't create a DHT.
  41         NoDHT bool `long:"disable-dht"`
  42         // Overrides the default DHT configuration.
  43         DHTConfig dht.ServerConfig
  44
  45         // Never send chunks to peers.
  46         NoUpload bool `long:"no-upload"`
  47         // Disable uploading even when it isn't fair.
  48         DisableAggressiveUpload bool `long:"disable-aggressive-upload"`
  49         // Upload even after there's nothing in it for us. By default uploading is
  50         // not altruistic, we'll upload slightly more than we download from each
  51         // peer.
  52         Seed bool `long:"seed"`
  53         // Only applies to chunks uploaded to peers, to maintain responsiveness
  54         // communicating local Client state to peers. Each limiter token
  55         // represents one byte. The Limiter's burst must be large enough to fit a
  56         // whole chunk, which is usually 16 KiB (see TorrentSpec.ChunkSize).
  57         UploadRateLimiter *rate.Limiter
  58         // Rate limits all reads from connections to peers. Each limiter token
  59         // represents one byte. The Limiter's burst must be bigger than the
  60         // largest Read performed on a the underlying rate-limiting io.Reader
  61         // minus one. This is likely to be the larger of the main read loop buffer
  62         // (~4096), and the requested chunk size (~16KiB, see
  63         // TorrentSpec.ChunkSize).
  64         DownloadRateLimiter *rate.Limiter
  65
  66         // User-provided Client peer ID. If not present, one is generated automatically.
  67         PeerID string
  68         // For the bittorrent protocol.
  69         DisableUTP bool
  70         // For the bittorrent protocol.
  71         DisableTCP bool `long:"disable-tcp"`
  72         // Called to instantiate storage for each added torrent. Builtin backends
  73         // are in the storage package. If not set, the "file" implementation is
  74         // used.
  75         DefaultStorage storage.ClientImpl
  76
  77         EncryptionPolicy
  78
  79         IPBlocklist iplist.Ranger
  80         DisableIPv6 bool `long:"disable-ipv6"`
  81         // Perform logging and any other behaviour that will help debug.
  82         Debug bool `help:"enable debugging"`
  83
  84         // HTTP client used to query the tracker endpoint. Default is DefaultHTTPClient
  85         HTTP *http.Client
  86         // HTTPUserAgent changes default UserAgent for HTTP requests
  87         HTTPUserAgent string `long:"http-user-agent"`
  88         // Updated occasionally to when there's been some changes to client
  89         // behaviour in case other clients are assuming anything of us. See also
  90         // `bep20`.
  91         ExtendedHandshakeClientVersion string // default  "go.torrent dev 20150624"
  92         // Peer ID client identifier prefix. We'll update this occasionally to
  93         // reflect changes to client behaviour that other clients may depend on.
  94         // Also see `extendedHandshakeClientVersion`.
  95         Bep20 string // default "-GT0001-"
  96
  97         NominalDialTimeout         time.Duration // default  time.Second * 30
  98         MinDialTimeout             time.Duration // default  5 * time.Second
  99         EstablishedConnsPerTorrent int           // default 80
 100         HalfOpenConnsPerTorrent    int           // default  80
 101         TorrentPeersHighWater      int           // default 200
 102         TorrentPeersLowWater       int           // default 50
 103
 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 // default  20 * time.Second
 108 }
 109
 110 func (cfg *Config) setDefaults() {
 111         if cfg.HTTP == nil {
 112                 cfg.HTTP = DefaultHTTPClient
 113         }
 114         if cfg.HTTPUserAgent == "" {
 115                 cfg.HTTPUserAgent = DefaultHTTPUserAgent
 116         }
 117         if cfg.ExtendedHandshakeClientVersion == "" {
 118                 cfg.ExtendedHandshakeClientVersion = "go.torrent dev 20150624"
 119         }
 120         if cfg.Bep20 == "" {
 121                 cfg.Bep20 = "-GT0001-"
 122         }
 123         if cfg.NominalDialTimeout == 0 {
 124                 cfg.NominalDialTimeout = 30 * time.Second
 125         }
 126         if cfg.MinDialTimeout == 0 {
 127                 cfg.MinDialTimeout = 5 * time.Second
 128         }
 129         if cfg.EstablishedConnsPerTorrent == 0 {
 130                 cfg.EstablishedConnsPerTorrent = 80
 131         }
 132         if cfg.HalfOpenConnsPerTorrent == 0 {
 133                 cfg.HalfOpenConnsPerTorrent = 80
 134         }
 135         if cfg.TorrentPeersHighWater == 0 {
 136                 cfg.TorrentPeersHighWater = 200
 137         }
 138         if cfg.TorrentPeersLowWater == 0 {
 139                 cfg.TorrentPeersLowWater = 50
 140         }
 141         if cfg.HandshakesTimeout == 0 {
 142                 cfg.HandshakesTimeout = 20 * time.Second
 143         }
 144 }
 145
 146 type EncryptionPolicy struct {
 147         DisableEncryption  bool
 148         ForceEncryption    bool // Don't allow unobfuscated connections.
 149         PreferNoEncryption bool
 150 }