X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=config.go;h=fca37e637a5d5c8a148d96fe2a1895a88133a345;hb=60db1104397f6e4eb581e6fc2dec428702d2455e;hp=5582456a0a91fec91457afaa9bd91097510266c9;hpb=1d8873552aa377ae4acb3752203fe1622686c734;p=btrtrc.git diff --git a/config.go b/config.go index 5582456a..fca37e63 100644 --- a/config.go +++ b/config.go @@ -1,42 +1,65 @@ package torrent import ( + "context" "net" "net/http" "net/url" "time" - "github.com/anacrolix/dht" - "github.com/anacrolix/dht/krpc" - "github.com/anacrolix/missinggo" - "github.com/anacrolix/missinggo/conntrack" - "github.com/anacrolix/missinggo/expect" + "github.com/anacrolix/dht/v2" + "github.com/anacrolix/dht/v2/krpc" + "github.com/anacrolix/log" + "github.com/anacrolix/missinggo/v2" + "golang.org/x/time/rate" + "github.com/anacrolix/torrent/iplist" "github.com/anacrolix/torrent/mse" "github.com/anacrolix/torrent/storage" - "golang.org/x/time/rate" + "github.com/anacrolix/torrent/version" ) -var DefaultHTTPUserAgent = "Go-Torrent/1.0" +// Contains config elements that are exclusive to tracker handling. There may be other fields in +// ClientConfig that are also relevant. +type ClientTrackerConfig struct { + // Don't announce to trackers. This only leaves DHT to discover peers. + DisableTrackers bool `long:"disable-trackers"` + // Defines DialContext func to use for HTTP tracker announcements + TrackerDialContext func(ctx context.Context, network, addr string) (net.Conn, error) + // Defines ListenPacket func to use for UDP tracker announcements + TrackerListenPacket func(network, addr string) (net.PacketConn, error) + // Takes a tracker's hostname and requests DNS A and AAAA records. + // Used in case DNS lookups require a special setup (i.e., dns-over-https) + LookupTrackerIp func(*url.URL) ([]net.IP, error) +} + +type ClientDhtConfig struct { + // Don't create a DHT. + NoDHT bool `long:"disable-dht"` + DhtStartingNodes func(network string) dht.StartingNodesGetter + // Called for each anacrolix/dht Server created for the Client. + ConfigureAnacrolixDhtServer func(*dht.ServerConfig) + PeriodicallyAnnounceTorrentsToDht bool + // OnQuery hook func + DHTOnQuery func(query *krpc.Msg, source net.Addr) (propagate bool) +} // Probably not safe to modify this after it's given to a Client. type ClientConfig struct { + ClientTrackerConfig + ClientDhtConfig + // Store torrent file data in this directory unless .DefaultStorage is // specified. DataDir string `long:"data-dir" description:"directory to store downloaded torrent data"` - // The address to listen for new uTP and TCP bittorrent protocol - // connections. DHT shares a UDP socket with uTP unless configured - // otherwise. + // The address to listen for new uTP and TCP BitTorrent protocol connections. DHT shares a UDP + // socket with uTP unless configured otherwise. ListenHost func(network string) string ListenPort int NoDefaultPortForwarding bool - // Don't announce to trackers. This only leaves DHT to discover peers. - DisableTrackers bool `long:"disable-trackers"` - DisablePEX bool `long:"disable-pex"` + UpnpID string + DisablePEX bool `long:"disable-pex"` - // Don't create a DHT. - NoDHT bool `long:"disable-dht"` - DhtStartingNodes dht.StartingNodesGetter // Never send chunks to peers. NoUpload bool `long:"no-upload"` // Disable uploading even when it isn't fair. @@ -56,6 +79,8 @@ type ClientConfig struct { // (~4096), and the requested chunk size (~16KiB, see // TorrentSpec.ChunkSize). DownloadRateLimiter *rate.Limiter + // Maximum unverified bytes across all torrents. Not used if zero. + MaxUnverifiedBytes int64 // User-provided Client peer ID. If not present, one is generated automatically. PeerID string @@ -65,33 +90,36 @@ type ClientConfig struct { DisableTCP bool `long:"disable-tcp"` // Called to instantiate storage for each added torrent. Builtin backends // are in the storage package. If not set, the "file" implementation is - // used. + // used (and Closed when the Client is Closed). DefaultStorage storage.ClientImpl HeaderObfuscationPolicy HeaderObfuscationPolicy - CryptoProvides mse.CryptoMethod - CryptoSelector mse.CryptoSelector - - // Sets usage of Socks5 Proxy. Authentication should be included in the url if needed. - // Examples: socks5://demo:demo@192.168.99.100:1080 - // http://proxy.domain.com:3128 - ProxyURL string + // The crypto methods to offer when initiating connections with header obfuscation. + CryptoProvides mse.CryptoMethod + // Chooses the crypto method to use when receiving connections with header obfuscation. + CryptoSelector mse.CryptoSelector IPBlocklist iplist.Ranger DisableIPv6 bool `long:"disable-ipv6"` DisableIPv4 bool DisableIPv4Peers bool // Perform logging and any other behaviour that will help debug. - Debug bool `help:"enable debugging"` + Debug bool `help:"enable debugging"` + Logger log.Logger - // HTTPProxy defines proxy for HTTP requests. - // Format: func(*Request) (*url.URL, error), - // or result of http.ProxyURL(HTTPProxy). - // By default, it is composed from ClientConfig.ProxyURL, - // if not set explicitly in ClientConfig struct + // Defines proxy for HTTP requests, such as for trackers. It's commonly set from the result of + // "net/http".ProxyURL(HTTPProxy). HTTPProxy func(*http.Request) (*url.URL, error) + // Defines DialContext func to use for HTTP requests, such as for fetching metainfo and webtorrent seeds + HTTPDialContext func(ctx context.Context, network, addr string) (net.Conn, error) // HTTPUserAgent changes default UserAgent for HTTP requests HTTPUserAgent string + // HttpRequestDirector modifies the request before it's sent. + // Useful for adding authentication headers, for example + HttpRequestDirector func(*http.Request) error + // WebsocketTrackerHttpHeader returns a custom header to be used when dialing a websocket connection + // to the tracker. Useful for adding authentication headers + WebsocketTrackerHttpHeader func() http.Header // Updated occasionally to when there's been some changes to client // behaviour in case other clients are assuming anything of us. See also // `bep20`. @@ -107,6 +135,7 @@ type ClientConfig struct { MinDialTimeout time.Duration EstablishedConnsPerTorrent int HalfOpenConnsPerTorrent int + TotalHalfOpenConns int // Maximum number of peer addresses in reserve. TorrentPeersHighWater int // Minumum number of peers before effort is made to obtain more peers. @@ -116,26 +145,50 @@ type ClientConfig struct { // impact of a few bad apples. 4s loses 1% of successful handshakes that // are obtained with 60s timeout, and 5% of unsuccessful handshakes. HandshakesTimeout time.Duration + // How long between writes before sending a keep alive message on a peer connection that we want + // to maintain. + KeepAliveTimeout time.Duration + // Maximum bytes to buffer per peer connection for peer request data before it is sent. + MaxAllocPeerRequestDataPerConn int64 // The IP addresses as our peers should see them. May differ from the // local interfaces due to NAT or other network configurations. PublicIp4 net.IP PublicIp6 net.IP + // Accept rate limiting affects excessive connection attempts from IPs that fail during + // handshakes or request torrents that we don't have. DisableAcceptRateLimiting bool // Don't add connections that have the same peer ID as an existing // connection for a given Torrent. - dropDuplicatePeerIds bool - - ConnTracker *conntrack.Instance - - // OnQuery hook func - DHTOnQuery func(query *krpc.Msg, source net.Addr) (propagate bool) + DropDuplicatePeerIds bool + // Drop peers that are complete if we are also complete and have no use for the peer. This is a + // bit of a special case, since a peer could also be useless if they're just not interested, or + // we don't intend to obtain all of a torrent's data. + DropMutuallyCompletePeers bool + // Whether to accept peer connections at all. + AcceptPeerConnections bool + // Whether a Client should want conns without delegating to any attached Torrents. This is + // useful when torrents might be added dynamically in callbacks for example. + AlwaysWantConns bool + + Extensions PeerExtensionBits + // Bits that peers must have set to proceed past handshakes. + MinPeerExtensions PeerExtensionBits + + DisableWebtorrent bool + DisableWebseeds bool + + Callbacks Callbacks + + DialRateLimiter *rate.Limiter } func (cfg *ClientConfig) SetListenAddr(addr string) *ClientConfig { host, port, err := missinggo.ParseHostPort(addr) - expect.Nil(err) + if err != nil { + panic(err) + } cfg.ListenHost = func(string) string { return host } cfg.ListenPort = port return cfg @@ -143,34 +196,45 @@ func (cfg *ClientConfig) SetListenAddr(addr string) *ClientConfig { func NewDefaultClientConfig() *ClientConfig { cc := &ClientConfig{ - HTTPUserAgent: DefaultHTTPUserAgent, - ExtendedHandshakeClientVersion: "go.torrent dev 20181121", - Bep20: "-GT0002-", + HTTPUserAgent: version.DefaultHttpUserAgent, + ExtendedHandshakeClientVersion: version.DefaultExtendedHandshakeClientVersion, + Bep20: version.DefaultBep20Prefix, + UpnpID: version.DefaultUpnpId, NominalDialTimeout: 20 * time.Second, MinDialTimeout: 3 * time.Second, EstablishedConnsPerTorrent: 50, HalfOpenConnsPerTorrent: 25, + TotalHalfOpenConns: 100, TorrentPeersHighWater: 500, TorrentPeersLowWater: 50, HandshakesTimeout: 4 * time.Second, - DhtStartingNodes: dht.GlobalBootstrapAddrs, + KeepAliveTimeout: time.Minute, + MaxAllocPeerRequestDataPerConn: 1 << 20, ListenHost: func(string) string { return "" }, UploadRateLimiter: unlimited, DownloadRateLimiter: unlimited, - ConnTracker: conntrack.NewInstance(), + DisableAcceptRateLimiting: true, + DropMutuallyCompletePeers: true, HeaderObfuscationPolicy: HeaderObfuscationPolicy{ Preferred: true, RequirePreferred: false, }, - CryptoSelector: mse.DefaultCryptoSelector, - CryptoProvides: mse.AllSupportedCrypto, + CryptoSelector: mse.DefaultCryptoSelector, + CryptoProvides: mse.AllSupportedCrypto, + ListenPort: 42069, + Extensions: defaultPeerExtensionBytes(), + AcceptPeerConnections: true, + MaxUnverifiedBytes: 64 << 20, + DialRateLimiter: rate.NewLimiter(10, 10), + } + cc.DhtStartingNodes = func(network string) dht.StartingNodesGetter { + return func() ([]dht.Addr, error) { return dht.GlobalBootstrapAddrs(network) } } - cc.ConnTracker.SetNoMaxEntries() - cc.ConnTracker.Timeout = func(conntrack.Entry) time.Duration { return 0 } + cc.PeriodicallyAnnounceTorrentsToDht = true return cc } type HeaderObfuscationPolicy struct { - RequirePreferred bool // Whether the value of Preferred is a strict requirement - Preferred bool // Whether header obfuscation is preferred + RequirePreferred bool // Whether the value of Preferred is a strict requirement. + Preferred bool // Whether header obfuscation is preferred. }