client.go

   1 package torrent
   2
   3 import (
   4         "bufio"
   5         "context"
   6         "crypto/rand"
   7         "crypto/sha1"
   8         "encoding/binary"
   9         "errors"
  10         "expvar"
  11         "fmt"
  12         "io"
  13         "math"
  14         "net"
  15         "net/http"
  16         "net/netip"
  17         "sort"
  18         "strconv"
  19         "strings"
  20         "time"
  21
  22         "github.com/anacrolix/chansync"
  23         "github.com/anacrolix/chansync/events"
  24         "github.com/anacrolix/dht/v2"
  25         "github.com/anacrolix/dht/v2/krpc"
  26         "github.com/anacrolix/generics"
  27         . "github.com/anacrolix/generics"
  28         "github.com/anacrolix/log"
  29         "github.com/anacrolix/missinggo/perf"
  30         "github.com/anacrolix/missinggo/v2"
  31         "github.com/anacrolix/missinggo/v2/bitmap"
  32         "github.com/anacrolix/missinggo/v2/pproffd"
  33         "github.com/anacrolix/sync"
  34         "github.com/davecgh/go-spew/spew"
  35         "github.com/dustin/go-humanize"
  36         gbtree "github.com/google/btree"
  37         "github.com/pion/datachannel"
  38         "golang.org/x/time/rate"
  39
  40         "github.com/anacrolix/torrent/bencode"
  41         "github.com/anacrolix/torrent/internal/limiter"
  42         "github.com/anacrolix/torrent/iplist"
  43         "github.com/anacrolix/torrent/metainfo"
  44         "github.com/anacrolix/torrent/mse"
  45         pp "github.com/anacrolix/torrent/peer_protocol"
  46         request_strategy "github.com/anacrolix/torrent/request-strategy"
  47         "github.com/anacrolix/torrent/storage"
  48         "github.com/anacrolix/torrent/tracker"
  49         "github.com/anacrolix/torrent/types/infohash"
  50         "github.com/anacrolix/torrent/webtorrent"
  51 )
  52
  53 // Clients contain zero or more Torrents. A Client manages a blocklist, the
  54 // TCP/UDP protocol ports, and DHT as desired.
  55 type Client struct {
  56         // An aggregate of stats over all connections. First in struct to ensure 64-bit alignment of
  57         // fields. See #262.
  58         stats ConnStats
  59
  60         _mu    lockWithDeferreds
  61         event  sync.Cond
  62         closed chansync.SetOnce
  63
  64         config *ClientConfig
  65         logger log.Logger
  66
  67         peerID         PeerID
  68         defaultStorage *storage.Client
  69         onClose        []func()
  70         dialers        []Dialer
  71         listeners      []Listener
  72         dhtServers     []DhtServer
  73         ipBlockList    iplist.Ranger
  74
  75         // Set of addresses that have our client ID. This intentionally will
  76         // include ourselves if we end up trying to connect to our own address
  77         // through legitimate channels.
  78         dopplegangerAddrs map[string]struct{}
  79         badPeerIPs        map[netip.Addr]struct{}
  80         torrents          map[InfoHash]*Torrent
  81         pieceRequestOrder map[interface{}]*request_strategy.PieceRequestOrder
  82
  83         acceptLimiter   map[ipStr]int
  84         dialRateLimiter *rate.Limiter
  85         numHalfOpen     int
  86
  87         websocketTrackers websocketTrackers
  88
  89         activeAnnounceLimiter limiter.Instance
  90         httpClient            *http.Client
  91 }
  92
  93 type ipStr string
  94
  95 func (cl *Client) BadPeerIPs() (ips []string) {
  96         cl.rLock()
  97         ips = cl.badPeerIPsLocked()
  98         cl.rUnlock()
  99         return
 100 }
 101
 102 func (cl *Client) badPeerIPsLocked() (ips []string) {
 103         ips = make([]string, len(cl.badPeerIPs))
 104         i := 0
 105         for k := range cl.badPeerIPs {
 106                 ips[i] = k.String()
 107                 i += 1
 108         }
 109         return
 110 }
 111
 112 func (cl *Client) PeerID() PeerID {
 113         return cl.peerID
 114 }
 115
 116 // Returns the port number for the first listener that has one. No longer assumes that all port
 117 // numbers are the same, due to support for custom listeners. Returns zero if no port number is
 118 // found.
 119 func (cl *Client) LocalPort() (port int) {
 120         for i := 0; i < len(cl.listeners); i += 1 {
 121                 if port = addrPortOrZero(cl.listeners[i].Addr()); port != 0 {
 122                         return
 123                 }
 124         }
 125         return
 126 }
 127
 128 func writeDhtServerStatus(w io.Writer, s DhtServer) {
 129         dhtStats := s.Stats()
 130         fmt.Fprintf(w, " ID: %x\n", s.ID())
 131         spew.Fdump(w, dhtStats)
 132 }
 133
 134 // Writes out a human readable status of the client, such as for writing to a
 135 // HTTP status page.
 136 func (cl *Client) WriteStatus(_w io.Writer) {
 137         cl.rLock()
 138         defer cl.rUnlock()
 139         w := bufio.NewWriter(_w)
 140         defer w.Flush()
 141         fmt.Fprintf(w, "Listen port: %d\n", cl.LocalPort())
 142         fmt.Fprintf(w, "Peer ID: %+q\n", cl.PeerID())
 143         fmt.Fprintf(w, "Extension bits: %v\n", cl.config.Extensions)
 144         fmt.Fprintf(w, "Announce key: %x\n", cl.announceKey())
 145         fmt.Fprintf(w, "Banned IPs: %d\n", len(cl.badPeerIPsLocked()))
 146         cl.eachDhtServer(func(s DhtServer) {
 147                 fmt.Fprintf(w, "%s DHT server at %s:\n", s.Addr().Network(), s.Addr().String())
 148                 writeDhtServerStatus(w, s)
 149         })
 150         spew.Fdump(w, &cl.stats)
 151         torrentsSlice := cl.torrentsAsSlice()
 152         fmt.Fprintf(w, "# Torrents: %d\n", len(torrentsSlice))
 153         fmt.Fprintln(w)
 154         sort.Slice(torrentsSlice, func(l, r int) bool {
 155                 return torrentsSlice[l].infoHash.AsString() < torrentsSlice[r].infoHash.AsString()
 156         })
 157         for _, t := range torrentsSlice {
 158                 if t.name() == "" {
 159                         fmt.Fprint(w, "<unknown name>")
 160                 } else {
 161                         fmt.Fprint(w, t.name())
 162                 }
 163                 fmt.Fprint(w, "\n")
 164                 if t.info != nil {
 165                         fmt.Fprintf(
 166                                 w,
 167                                 "%f%% of %d bytes (%s)",
 168                                 100*(1-float64(t.bytesMissingLocked())/float64(t.info.TotalLength())),
 169                                 t.length(),
 170                                 humanize.Bytes(uint64(t.length())))
 171                 } else {
 172                         w.WriteString("<missing metainfo>")
 173                 }
 174                 fmt.Fprint(w, "\n")
 175                 t.writeStatus(w)
 176                 fmt.Fprintln(w)
 177         }
 178 }
 179
 180 func (cl *Client) initLogger() {
 181         logger := cl.config.Logger
 182         if logger.IsZero() {
 183                 logger = log.Default
 184         }
 185         if cl.config.Debug {
 186                 logger = logger.FilterLevel(log.Debug)
 187         }
 188         cl.logger = logger.WithValues(cl)
 189 }
 190
 191 func (cl *Client) announceKey() int32 {
 192         return int32(binary.BigEndian.Uint32(cl.peerID[16:20]))
 193 }
 194
 195 // Initializes a bare minimum Client. *Client and *ClientConfig must not be nil.
 196 func (cl *Client) init(cfg *ClientConfig) {
 197         cl.config = cfg
 198         generics.MakeMap(&cl.dopplegangerAddrs)
 199         cl.torrents = make(map[metainfo.Hash]*Torrent)
 200         cl.dialRateLimiter = rate.NewLimiter(10, 10)
 201         cl.activeAnnounceLimiter.SlotsPerKey = 2
 202         cl.event.L = cl.locker()
 203         cl.ipBlockList = cfg.IPBlocklist
 204         cl.httpClient = &http.Client{
 205                 Transport: &http.Transport{
 206                         Proxy:       cfg.HTTPProxy,
 207                         DialContext: cfg.HTTPDialContext,
 208                         // I think this value was observed from some webseeds. It seems reasonable to extend it
 209                         // to other uses of HTTP from the client.
 210                         MaxConnsPerHost: 10,
 211                 },
 212         }
 213 }
 214
 215 func NewClient(cfg *ClientConfig) (cl *Client, err error) {
 216         if cfg == nil {
 217                 cfg = NewDefaultClientConfig()
 218                 cfg.ListenPort = 0
 219         }
 220         var client Client
 221         client.init(cfg)
 222         cl = &client
 223         go cl.acceptLimitClearer()
 224         cl.initLogger()
 225         defer func() {
 226                 if err != nil {
 227                         cl.Close()
 228                         cl = nil
 229                 }
 230         }()
 231
 232         storageImpl := cfg.DefaultStorage
 233         if storageImpl == nil {
 234                 // We'd use mmap by default but HFS+ doesn't support sparse files.
 235                 storageImplCloser := storage.NewFile(cfg.DataDir)
 236                 cl.onClose = append(cl.onClose, func() {
 237                         if err := storageImplCloser.Close(); err != nil {
 238                                 cl.logger.Printf("error closing default storage: %s", err)
 239                         }
 240                 })
 241                 storageImpl = storageImplCloser
 242         }
 243         cl.defaultStorage = storage.NewClient(storageImpl)
 244
 245         if cfg.PeerID != "" {
 246                 missinggo.CopyExact(&cl.peerID, cfg.PeerID)
 247         } else {
 248                 o := copy(cl.peerID[:], cfg.Bep20)
 249                 _, err = rand.Read(cl.peerID[o:])
 250                 if err != nil {
 251                         panic("error generating peer id")
 252                 }
 253         }
 254
 255         sockets, err := listenAll(cl.listenNetworks(), cl.config.ListenHost, cl.config.ListenPort, cl.firewallCallback, cl.logger)
 256         if err != nil {
 257                 return
 258         }
 259
 260         // Check for panics.
 261         cl.LocalPort()
 262
 263         for _, _s := range sockets {
 264                 s := _s // Go is fucking retarded.
 265                 cl.onClose = append(cl.onClose, func() { go s.Close() })
 266                 if peerNetworkEnabled(parseNetworkString(s.Addr().Network()), cl.config) {
 267                         cl.dialers = append(cl.dialers, s)
 268                         cl.listeners = append(cl.listeners, s)
 269                         if cl.config.AcceptPeerConnections {
 270                                 go cl.acceptConnections(s)
 271                         }
 272                 }
 273         }
 274
 275         go cl.forwardPort()
 276         if !cfg.NoDHT {
 277                 for _, s := range sockets {
 278                         if pc, ok := s.(net.PacketConn); ok {
 279                                 ds, err := cl.NewAnacrolixDhtServer(pc)
 280                                 if err != nil {
 281                                         panic(err)
 282                                 }
 283                                 cl.dhtServers = append(cl.dhtServers, AnacrolixDhtServerWrapper{ds})
 284                                 cl.onClose = append(cl.onClose, func() { ds.Close() })
 285                         }
 286                 }
 287         }
 288
 289         cl.websocketTrackers = websocketTrackers{
 290                 PeerId: cl.peerID,
 291                 Logger: cl.logger,
 292                 GetAnnounceRequest: func(event tracker.AnnounceEvent, infoHash [20]byte) (tracker.AnnounceRequest, error) {
 293                         cl.lock()
 294                         defer cl.unlock()
 295                         t, ok := cl.torrents[infoHash]
 296                         if !ok {
 297                                 return tracker.AnnounceRequest{}, errors.New("torrent not tracked by client")
 298                         }
 299                         return t.announceRequest(event), nil
 300                 },
 301                 Proxy:                      cl.config.HTTPProxy,
 302                 WebsocketTrackerHttpHeader: cl.config.WebsocketTrackerHttpHeader,
 303                 DialContext:                cl.config.TrackerDialContext,
 304                 OnConn: func(dc datachannel.ReadWriteCloser, dcc webtorrent.DataChannelContext) {
 305                         cl.lock()
 306                         defer cl.unlock()
 307                         t, ok := cl.torrents[dcc.InfoHash]
 308                         if !ok {
 309                                 cl.logger.WithDefaultLevel(log.Warning).Printf(
 310                                         "got webrtc conn for unloaded torrent with infohash %x",
 311                                         dcc.InfoHash,
 312                                 )
 313                                 dc.Close()
 314                                 return
 315                         }
 316                         go t.onWebRtcConn(dc, dcc)
 317                 },
 318         }
 319
 320         return
 321 }
 322
 323 func (cl *Client) AddDhtServer(d DhtServer) {
 324         cl.dhtServers = append(cl.dhtServers, d)
 325 }
 326
 327 // Adds a Dialer for outgoing connections. All Dialers are used when attempting to connect to a
 328 // given address for any Torrent.
 329 func (cl *Client) AddDialer(d Dialer) {
 330         cl.lock()
 331         defer cl.unlock()
 332         cl.dialers = append(cl.dialers, d)
 333         for _, t := range cl.torrents {
 334                 t.openNewConns()
 335         }
 336 }
 337
 338 func (cl *Client) Listeners() []Listener {
 339         return cl.listeners
 340 }
 341
 342 // Registers a Listener, and starts Accepting on it. You must Close Listeners provided this way
 343 // yourself.
 344 func (cl *Client) AddListener(l Listener) {
 345         cl.listeners = append(cl.listeners, l)
 346         if cl.config.AcceptPeerConnections {
 347                 go cl.acceptConnections(l)
 348         }
 349 }
 350
 351 func (cl *Client) firewallCallback(net.Addr) bool {
 352         cl.rLock()
 353         block := !cl.wantConns() || !cl.config.AcceptPeerConnections
 354         cl.rUnlock()
 355         if block {
 356                 torrent.Add("connections firewalled", 1)
 357         } else {
 358                 torrent.Add("connections not firewalled", 1)
 359         }
 360         return block
 361 }
 362
 363 func (cl *Client) listenOnNetwork(n network) bool {
 364         if n.Ipv4 && cl.config.DisableIPv4 {
 365                 return false
 366         }
 367         if n.Ipv6 && cl.config.DisableIPv6 {
 368                 return false
 369         }
 370         if n.Tcp && cl.config.DisableTCP {
 371                 return false
 372         }
 373         if n.Udp && cl.config.DisableUTP && cl.config.NoDHT {
 374                 return false
 375         }
 376         return true
 377 }
 378
 379 func (cl *Client) listenNetworks() (ns []network) {
 380         for _, n := range allPeerNetworks {
 381                 if cl.listenOnNetwork(n) {
 382                         ns = append(ns, n)
 383                 }
 384         }
 385         return
 386 }
 387
 388 // Creates an anacrolix/dht Server, as would be done internally in NewClient, for the given conn.
 389 func (cl *Client) NewAnacrolixDhtServer(conn net.PacketConn) (s *dht.Server, err error) {
 390         logger := cl.logger.WithNames("dht", conn.LocalAddr().String())
 391         cfg := dht.ServerConfig{
 392                 IPBlocklist:    cl.ipBlockList,
 393                 Conn:           conn,
 394                 OnAnnouncePeer: cl.onDHTAnnouncePeer,
 395                 PublicIP: func() net.IP {
 396                         if connIsIpv6(conn) && cl.config.PublicIp6 != nil {
 397                                 return cl.config.PublicIp6
 398                         }
 399                         return cl.config.PublicIp4
 400                 }(),
 401                 StartingNodes: cl.config.DhtStartingNodes(conn.LocalAddr().Network()),
 402                 OnQuery:       cl.config.DHTOnQuery,
 403                 Logger:        logger,
 404         }
 405         if f := cl.config.ConfigureAnacrolixDhtServer; f != nil {
 406                 f(&cfg)
 407         }
 408         s, err = dht.NewServer(&cfg)
 409         if err == nil {
 410                 go s.TableMaintainer()
 411         }
 412         return
 413 }
 414
 415 func (cl *Client) Closed() events.Done {
 416         return cl.closed.Done()
 417 }
 418
 419 func (cl *Client) eachDhtServer(f func(DhtServer)) {
 420         for _, ds := range cl.dhtServers {
 421                 f(ds)
 422         }
 423 }
 424
 425 // Stops the client. All connections to peers are closed and all activity will come to a halt.
 426 func (cl *Client) Close() (errs []error) {
 427         var closeGroup sync.WaitGroup // For concurrent cleanup to complete before returning
 428         cl.lock()
 429         for _, t := range cl.torrents {
 430                 err := t.close(&closeGroup)
 431                 if err != nil {
 432                         errs = append(errs, err)
 433                 }
 434         }
 435         for i := range cl.onClose {
 436                 cl.onClose[len(cl.onClose)-1-i]()
 437         }
 438         cl.closed.Set()
 439         cl.unlock()
 440         cl.event.Broadcast()
 441         closeGroup.Wait() // defer is LIFO. We want to Wait() after cl.unlock()
 442         return
 443 }
 444
 445 func (cl *Client) ipBlockRange(ip net.IP) (r iplist.Range, blocked bool) {
 446         if cl.ipBlockList == nil {
 447                 return
 448         }
 449         return cl.ipBlockList.Lookup(ip)
 450 }
 451
 452 func (cl *Client) ipIsBlocked(ip net.IP) bool {
 453         _, blocked := cl.ipBlockRange(ip)
 454         return blocked
 455 }
 456
 457 func (cl *Client) wantConns() bool {
 458         if cl.config.AlwaysWantConns {
 459                 return true
 460         }
 461         for _, t := range cl.torrents {
 462                 if t.wantConns() {
 463                         return true
 464                 }
 465         }
 466         return false
 467 }
 468
 469 // TODO: Apply filters for non-standard networks, particularly rate-limiting.
 470 func (cl *Client) rejectAccepted(conn net.Conn) error {
 471         if !cl.wantConns() {
 472                 return errors.New("don't want conns right now")
 473         }
 474         ra := conn.RemoteAddr()
 475         if rip := addrIpOrNil(ra); rip != nil {
 476                 if cl.config.DisableIPv4Peers && rip.To4() != nil {
 477                         return errors.New("ipv4 peers disabled")
 478                 }
 479                 if cl.config.DisableIPv4 && len(rip) == net.IPv4len {
 480                         return errors.New("ipv4 disabled")
 481                 }
 482                 if cl.config.DisableIPv6 && len(rip) == net.IPv6len && rip.To4() == nil {
 483                         return errors.New("ipv6 disabled")
 484                 }
 485                 if cl.rateLimitAccept(rip) {
 486                         return errors.New("source IP accepted rate limited")
 487                 }
 488                 if cl.badPeerIPPort(rip, missinggo.AddrPort(ra)) {
 489                         return errors.New("bad source addr")
 490                 }
 491         }
 492         return nil
 493 }
 494
 495 func (cl *Client) acceptConnections(l Listener) {
 496         for {
 497                 conn, err := l.Accept()
 498                 torrent.Add("client listener accepts", 1)
 499                 conn = pproffd.WrapNetConn(conn)
 500                 cl.rLock()
 501                 closed := cl.closed.IsSet()
 502                 var reject error
 503                 if !closed && conn != nil {
 504                         reject = cl.rejectAccepted(conn)
 505                 }
 506                 cl.rUnlock()
 507                 if closed {
 508                         if conn != nil {
 509                                 conn.Close()
 510                         }
 511                         return
 512                 }
 513                 if err != nil {
 514                         log.Fmsg("error accepting connection: %s", err).LogLevel(log.Debug, cl.logger)
 515                         continue
 516                 }
 517                 go func() {
 518                         if reject != nil {
 519                                 torrent.Add("rejected accepted connections", 1)
 520                                 cl.logger.LazyLog(log.Debug, func() log.Msg {
 521                                         return log.Fmsg("rejecting accepted conn: %v", reject)
 522                                 })
 523                                 conn.Close()
 524                         } else {
 525                                 go cl.incomingConnection(conn)
 526                         }
 527                         cl.logger.LazyLog(log.Debug, func() log.Msg {
 528                                 return log.Fmsg("accepted %q connection at %q from %q",
 529                                         l.Addr().Network(),
 530                                         conn.LocalAddr(),
 531                                         conn.RemoteAddr(),
 532                                 )
 533                         })
 534                         torrent.Add(fmt.Sprintf("accepted conn remote IP len=%d", len(addrIpOrNil(conn.RemoteAddr()))), 1)
 535                         torrent.Add(fmt.Sprintf("accepted conn network=%s", conn.RemoteAddr().Network()), 1)
 536                         torrent.Add(fmt.Sprintf("accepted on %s listener", l.Addr().Network()), 1)
 537                 }()
 538         }
 539 }
 540
 541 // Creates the PeerConn.connString for a regular net.Conn PeerConn.
 542 func regularNetConnPeerConnConnString(nc net.Conn) string {
 543         return fmt.Sprintf("%s-%s", nc.LocalAddr(), nc.RemoteAddr())
 544 }
 545
 546 func (cl *Client) incomingConnection(nc net.Conn) {
 547         defer nc.Close()
 548         if tc, ok := nc.(*net.TCPConn); ok {
 549                 tc.SetLinger(0)
 550         }
 551         remoteAddr, _ := tryIpPortFromNetAddr(nc.RemoteAddr())
 552         c := cl.newConnection(
 553                 nc,
 554                 newConnectionOpts{
 555                         outgoing:        false,
 556                         remoteAddr:      nc.RemoteAddr(),
 557                         localPublicAddr: cl.publicAddr(remoteAddr.IP),
 558                         network:         nc.RemoteAddr().Network(),
 559                         connString:      regularNetConnPeerConnConnString(nc),
 560                 })
 561         defer func() {
 562                 cl.lock()
 563                 defer cl.unlock()
 564                 c.close()
 565         }()
 566         c.Discovery = PeerSourceIncoming
 567         cl.runReceivedConn(c)
 568 }
 569
 570 // Returns a handle to the given torrent, if it's present in the client.
 571 func (cl *Client) Torrent(ih metainfo.Hash) (t *Torrent, ok bool) {
 572         cl.rLock()
 573         defer cl.rUnlock()
 574         t, ok = cl.torrents[ih]
 575         return
 576 }
 577
 578 func (cl *Client) torrent(ih metainfo.Hash) *Torrent {
 579         return cl.torrents[ih]
 580 }
 581
 582 type DialResult struct {
 583         Conn   net.Conn
 584         Dialer Dialer
 585 }
 586
 587 func countDialResult(err error) {
 588         if err == nil {
 589                 torrent.Add("successful dials", 1)
 590         } else {
 591                 torrent.Add("unsuccessful dials", 1)
 592         }
 593 }
 594
 595 func reducedDialTimeout(minDialTimeout, max time.Duration, halfOpenLimit, pendingPeers int) (ret time.Duration) {
 596         ret = max / time.Duration((pendingPeers+halfOpenLimit)/halfOpenLimit)
 597         if ret < minDialTimeout {
 598                 ret = minDialTimeout
 599         }
 600         return
 601 }
 602
 603 // Returns whether an address is known to connect to a client with our own ID.
 604 func (cl *Client) dopplegangerAddr(addr string) bool {
 605         _, ok := cl.dopplegangerAddrs[addr]
 606         return ok
 607 }
 608
 609 // Returns a connection over UTP or TCP, whichever is first to connect.
 610 func (cl *Client) dialFirst(ctx context.Context, addr string) (res DialResult) {
 611         return DialFirst(ctx, addr, cl.dialers)
 612 }
 613
 614 // Returns a connection over UTP or TCP, whichever is first to connect.
 615 func DialFirst(ctx context.Context, addr string, dialers []Dialer) (res DialResult) {
 616         {
 617                 t := perf.NewTimer(perf.CallerName(0))
 618                 defer func() {
 619                         if res.Conn == nil {
 620                                 t.Mark(fmt.Sprintf("returned no conn (context: %v)", ctx.Err()))
 621                         } else {
 622                                 t.Mark("returned conn over " + res.Dialer.DialerNetwork())
 623                         }
 624                 }()
 625         }
 626         ctx, cancel := context.WithCancel(ctx)
 627         // As soon as we return one connection, cancel the others.
 628         defer cancel()
 629         left := 0
 630         resCh := make(chan DialResult, left)
 631         for _, _s := range dialers {
 632                 left++
 633                 s := _s
 634                 go func() {
 635                         resCh <- DialResult{
 636                                 dialFromSocket(ctx, s, addr),
 637                                 s,
 638                         }
 639                 }()
 640         }
 641         // Wait for a successful connection.
 642         func() {
 643                 defer perf.ScopeTimer()()
 644                 for ; left > 0 && res.Conn == nil; left-- {
 645                         res = <-resCh
 646                 }
 647         }()
 648         // There are still incompleted dials.
 649         go func() {
 650                 for ; left > 0; left-- {
 651                         conn := (<-resCh).Conn
 652                         if conn != nil {
 653                                 conn.Close()
 654                         }
 655                 }
 656         }()
 657         if res.Conn != nil {
 658                 go torrent.Add(fmt.Sprintf("network dialed first: %s", res.Conn.RemoteAddr().Network()), 1)
 659         }
 660         return res
 661 }
 662
 663 func dialFromSocket(ctx context.Context, s Dialer, addr string) net.Conn {
 664         c, err := s.Dial(ctx, addr)
 665         // This is a bit optimistic, but it looks non-trivial to thread this through the proxy code. Set
 666         // it now in case we close the connection forthwith.
 667         if tc, ok := c.(*net.TCPConn); ok {
 668                 tc.SetLinger(0)
 669         }
 670         countDialResult(err)
 671         return c
 672 }
 673
 674 func forgettableDialError(err error) bool {
 675         return strings.Contains(err.Error(), "no suitable address found")
 676 }
 677
 678 func (cl *Client) noLongerHalfOpen(t *Torrent, addr string) {
 679         if _, ok := t.halfOpen[addr]; !ok {
 680                 panic("invariant broken")
 681         }
 682         delete(t.halfOpen, addr)
 683         cl.numHalfOpen--
 684         for _, t := range cl.torrents {
 685                 t.openNewConns()
 686         }
 687 }
 688
 689 // Performs initiator handshakes and returns a connection. Returns nil *connection if no connection
 690 // for valid reasons.
 691 func (cl *Client) initiateProtocolHandshakes(
 692         ctx context.Context,
 693         nc net.Conn,
 694         t *Torrent,
 695         encryptHeader bool,
 696         newConnOpts newConnectionOpts,
 697 ) (
 698         c *PeerConn, err error,
 699 ) {
 700         c = cl.newConnection(nc, newConnOpts)
 701         c.headerEncrypted = encryptHeader
 702         ctx, cancel := context.WithTimeout(ctx, cl.config.HandshakesTimeout)
 703         defer cancel()
 704         dl, ok := ctx.Deadline()
 705         if !ok {
 706                 panic(ctx)
 707         }
 708         err = nc.SetDeadline(dl)
 709         if err != nil {
 710                 panic(err)
 711         }
 712         err = cl.initiateHandshakes(c, t)
 713         return
 714 }
 715
 716 // Returns nil connection and nil error if no connection could be established for valid reasons.
 717 func (cl *Client) establishOutgoingConnEx(t *Torrent, addr PeerRemoteAddr, obfuscatedHeader bool) (*PeerConn, error) {
 718         dialCtx, cancel := context.WithTimeout(context.Background(), func() time.Duration {
 719                 cl.rLock()
 720                 defer cl.rUnlock()
 721                 return t.dialTimeout()
 722         }())
 723         defer cancel()
 724         dr := cl.dialFirst(dialCtx, addr.String())
 725         nc := dr.Conn
 726         if nc == nil {
 727                 if dialCtx.Err() != nil {
 728                         return nil, fmt.Errorf("dialing: %w", dialCtx.Err())
 729                 }
 730                 return nil, errors.New("dial failed")
 731         }
 732         addrIpPort, _ := tryIpPortFromNetAddr(addr)
 733         c, err := cl.initiateProtocolHandshakes(context.Background(), nc, t, obfuscatedHeader, newConnectionOpts{
 734                 outgoing:   true,
 735                 remoteAddr: addr,
 736                 // It would be possible to retrieve a public IP from the dialer used here?
 737                 localPublicAddr: cl.publicAddr(addrIpPort.IP),
 738                 network:         dr.Dialer.DialerNetwork(),
 739                 connString:      regularNetConnPeerConnConnString(nc),
 740         })
 741         if err != nil {
 742                 nc.Close()
 743         }
 744         return c, err
 745 }
 746
 747 // Returns nil connection and nil error if no connection could be established
 748 // for valid reasons.
 749 func (cl *Client) establishOutgoingConn(t *Torrent, addr PeerRemoteAddr) (c *PeerConn, err error) {
 750         torrent.Add("establish outgoing connection", 1)
 751         obfuscatedHeaderFirst := cl.config.HeaderObfuscationPolicy.Preferred
 752         c, err = cl.establishOutgoingConnEx(t, addr, obfuscatedHeaderFirst)
 753         if err == nil {
 754                 torrent.Add("initiated conn with preferred header obfuscation", 1)
 755                 return
 756         }
 757         // cl.logger.Printf("error establishing connection to %s (obfuscatedHeader=%t): %v", addr, obfuscatedHeaderFirst, err)
 758         if cl.config.HeaderObfuscationPolicy.RequirePreferred {
 759                 // We should have just tried with the preferred header obfuscation. If it was required,
 760                 // there's nothing else to try.
 761                 return
 762         }
 763         // Try again with encryption if we didn't earlier, or without if we did.
 764         c, err = cl.establishOutgoingConnEx(t, addr, !obfuscatedHeaderFirst)
 765         if err == nil {
 766                 torrent.Add("initiated conn with fallback header obfuscation", 1)
 767         }
 768         // cl.logger.Printf("error establishing fallback connection to %v: %v", addr, err)
 769         return
 770 }
 771
 772 // Called to dial out and run a connection. The addr we're given is already
 773 // considered half-open.
 774 func (cl *Client) outgoingConnection(t *Torrent, addr PeerRemoteAddr, ps PeerSource, trusted bool) {
 775         cl.dialRateLimiter.Wait(context.Background())
 776         c, err := cl.establishOutgoingConn(t, addr)
 777         if err == nil {
 778                 c.conn.SetWriteDeadline(time.Time{})
 779         }
 780         cl.lock()
 781         defer cl.unlock()
 782         // Don't release lock between here and addPeerConn, unless it's for
 783         // failure.
 784         cl.noLongerHalfOpen(t, addr.String())
 785         if err != nil {
 786                 if cl.config.Debug {
 787                         cl.logger.Levelf(log.Debug, "error establishing outgoing connection to %v: %v", addr, err)
 788                 }
 789                 return
 790         }
 791         defer c.close()
 792         c.Discovery = ps
 793         c.trusted = trusted
 794         t.runHandshookConnLoggingErr(c)
 795 }
 796
 797 // The port number for incoming peer connections. 0 if the client isn't listening.
 798 func (cl *Client) incomingPeerPort() int {
 799         return cl.LocalPort()
 800 }
 801
 802 func (cl *Client) initiateHandshakes(c *PeerConn, t *Torrent) error {
 803         if c.headerEncrypted {
 804                 var rw io.ReadWriter
 805                 var err error
 806                 rw, c.cryptoMethod, err = mse.InitiateHandshake(
 807                         struct {
 808                                 io.Reader
 809                                 io.Writer
 810                         }{c.r, c.w},
 811                         t.infoHash[:],
 812                         nil,
 813                         cl.config.CryptoProvides,
 814                 )
 815                 c.setRW(rw)
 816                 if err != nil {
 817                         return fmt.Errorf("header obfuscation handshake: %w", err)
 818                 }
 819         }
 820         ih, err := cl.connBtHandshake(c, &t.infoHash)
 821         if err != nil {
 822                 return fmt.Errorf("bittorrent protocol handshake: %w", err)
 823         }
 824         if ih != t.infoHash {
 825                 return errors.New("bittorrent protocol handshake: peer infohash didn't match")
 826         }
 827         return nil
 828 }
 829
 830 // Calls f with any secret keys. Note that it takes the Client lock, and so must be used from code
 831 // that won't also try to take the lock. This saves us copying all the infohashes everytime.
 832 func (cl *Client) forSkeys(f func([]byte) bool) {
 833         cl.rLock()
 834         defer cl.rUnlock()
 835         if false { // Emulate the bug from #114
 836                 var firstIh InfoHash
 837                 for ih := range cl.torrents {
 838                         firstIh = ih
 839                         break
 840                 }
 841                 for range cl.torrents {
 842                         if !f(firstIh[:]) {
 843                                 break
 844                         }
 845                 }
 846                 return
 847         }
 848         for ih := range cl.torrents {
 849                 if !f(ih[:]) {
 850                         break
 851                 }
 852         }
 853 }
 854
 855 func (cl *Client) handshakeReceiverSecretKeys() mse.SecretKeyIter {
 856         if ret := cl.config.Callbacks.ReceiveEncryptedHandshakeSkeys; ret != nil {
 857                 return ret
 858         }
 859         return cl.forSkeys
 860 }
 861
 862 // Do encryption and bittorrent handshakes as receiver.
 863 func (cl *Client) receiveHandshakes(c *PeerConn) (t *Torrent, err error) {
 864         defer perf.ScopeTimerErr(&err)()
 865         var rw io.ReadWriter
 866         rw, c.headerEncrypted, c.cryptoMethod, err = handleEncryption(c.rw(), cl.handshakeReceiverSecretKeys(), cl.config.HeaderObfuscationPolicy, cl.config.CryptoSelector)
 867         c.setRW(rw)
 868         if err == nil || err == mse.ErrNoSecretKeyMatch {
 869                 if c.headerEncrypted {
 870                         torrent.Add("handshakes received encrypted", 1)
 871                 } else {
 872                         torrent.Add("handshakes received unencrypted", 1)
 873                 }
 874         } else {
 875                 torrent.Add("handshakes received with error while handling encryption", 1)
 876         }
 877         if err != nil {
 878                 if err == mse.ErrNoSecretKeyMatch {
 879                         err = nil
 880                 }
 881                 return
 882         }
 883         if cl.config.HeaderObfuscationPolicy.RequirePreferred && c.headerEncrypted != cl.config.HeaderObfuscationPolicy.Preferred {
 884                 err = errors.New("connection does not have required header obfuscation")
 885                 return
 886         }
 887         ih, err := cl.connBtHandshake(c, nil)
 888         if err != nil {
 889                 return nil, fmt.Errorf("during bt handshake: %w", err)
 890         }
 891         cl.lock()
 892         t = cl.torrents[ih]
 893         cl.unlock()
 894         return
 895 }
 896
 897 var successfulPeerWireProtocolHandshakePeerReservedBytes expvar.Map
 898
 899 func init() {
 900         torrent.Set(
 901                 "successful_peer_wire_protocol_handshake_peer_reserved_bytes",
 902                 &successfulPeerWireProtocolHandshakePeerReservedBytes)
 903 }
 904
 905 func (cl *Client) connBtHandshake(c *PeerConn, ih *metainfo.Hash) (ret metainfo.Hash, err error) {
 906         res, err := pp.Handshake(c.rw(), ih, cl.peerID, cl.config.Extensions)
 907         if err != nil {
 908                 return
 909         }
 910         successfulPeerWireProtocolHandshakePeerReservedBytes.Add(res.PeerExtensionBits.String(), 1)
 911         ret = res.Hash
 912         c.PeerExtensionBytes = res.PeerExtensionBits
 913         c.PeerID = res.PeerID
 914         c.completedHandshake = time.Now()
 915         if cb := cl.config.Callbacks.CompletedHandshake; cb != nil {
 916                 cb(c, res.Hash)
 917         }
 918         return
 919 }
 920
 921 func (cl *Client) runReceivedConn(c *PeerConn) {
 922         err := c.conn.SetDeadline(time.Now().Add(cl.config.HandshakesTimeout))
 923         if err != nil {
 924                 panic(err)
 925         }
 926         t, err := cl.receiveHandshakes(c)
 927         if err != nil {
 928                 cl.logger.LazyLog(log.Debug, func() log.Msg {
 929                         return log.Fmsg(
 930                                 "error receiving handshakes on %v: %s", c, err,
 931                         ).Add(
 932                                 "network", c.Network,
 933                         )
 934                 })
 935                 torrent.Add("error receiving handshake", 1)
 936                 cl.lock()
 937                 cl.onBadAccept(c.RemoteAddr)
 938                 cl.unlock()
 939                 return
 940         }
 941         if t == nil {
 942                 torrent.Add("received handshake for unloaded torrent", 1)
 943                 cl.logger.LazyLog(log.Debug, func() log.Msg {
 944                         return log.Fmsg("received handshake for unloaded torrent")
 945                 })
 946                 cl.lock()
 947                 cl.onBadAccept(c.RemoteAddr)
 948                 cl.unlock()
 949                 return
 950         }
 951         torrent.Add("received handshake for loaded torrent", 1)
 952         c.conn.SetWriteDeadline(time.Time{})
 953         cl.lock()
 954         defer cl.unlock()
 955         t.runHandshookConnLoggingErr(c)
 956 }
 957
 958 // Client lock must be held before entering this.
 959 func (cl *Client) runHandshookConn(c *PeerConn, t *Torrent) error {
 960         c.setTorrent(t)
 961         for i, b := range cl.config.MinPeerExtensions {
 962                 if c.PeerExtensionBytes[i]&b != b {
 963                         return fmt.Errorf("peer did not meet minimum peer extensions: %x", c.PeerExtensionBytes[:])
 964                 }
 965         }
 966         if c.PeerID == cl.peerID {
 967                 if c.outgoing {
 968                         connsToSelf.Add(1)
 969                         addr := c.RemoteAddr.String()
 970                         cl.dopplegangerAddrs[addr] = struct{}{}
 971                 } /* else {
 972                         // Because the remote address is not necessarily the same as its client's torrent listen
 973                         // address, we won't record the remote address as a doppleganger. Instead, the initiator
 974                         // can record *us* as the doppleganger.
 975                 } */
 976                 t.logger.Levelf(log.Debug, "local and remote peer ids are the same")
 977                 return nil
 978         }
 979         c.r = deadlineReader{c.conn, c.r}
 980         completedHandshakeConnectionFlags.Add(c.connectionFlags(), 1)
 981         if connIsIpv6(c.conn) {
 982                 torrent.Add("completed handshake over ipv6", 1)
 983         }
 984         if err := t.addPeerConn(c); err != nil {
 985                 return fmt.Errorf("adding connection: %w", err)
 986         }
 987         defer t.dropConnection(c)
 988         c.startMessageWriter()
 989         cl.sendInitialMessages(c, t)
 990         c.initUpdateRequestsTimer()
 991         err := c.mainReadLoop()
 992         if err != nil {
 993                 return fmt.Errorf("main read loop: %w", err)
 994         }
 995         return nil
 996 }
 997
 998 const check = false
 999
1000 func (p *Peer) initUpdateRequestsTimer() {
1001         if check {
1002                 if p.updateRequestsTimer != nil {
1003                         panic(p.updateRequestsTimer)
1004                 }
1005         }
1006         if enableUpdateRequestsTimer {
1007                 p.updateRequestsTimer = time.AfterFunc(math.MaxInt64, p.updateRequestsTimerFunc)
1008         }
1009 }
1010
1011 const peerUpdateRequestsTimerReason = "updateRequestsTimer"
1012
1013 func (c *Peer) updateRequestsTimerFunc() {
1014         c.locker().Lock()
1015         defer c.locker().Unlock()
1016         if c.closed.IsSet() {
1017                 return
1018         }
1019         if c.isLowOnRequests() {
1020                 // If there are no outstanding requests, then a request update should have already run.
1021                 return
1022         }
1023         if d := time.Since(c.lastRequestUpdate); d < updateRequestsTimerDuration {
1024                 // These should be benign, Timer.Stop doesn't guarantee that its function won't run if it's
1025                 // already been fired.
1026                 torrent.Add("spurious timer requests updates", 1)
1027                 return
1028         }
1029         c.updateRequests(peerUpdateRequestsTimerReason)
1030 }
1031
1032 // Maximum pending requests we allow peers to send us. If peer requests are buffered on read, this
1033 // instructs the amount of memory that might be used to cache pending writes. Assuming 512KiB
1034 // (1<<19) cached for sending, for 16KiB (1<<14) chunks.
1035 const localClientReqq = 1024
1036
1037 // See the order given in Transmission's tr_peerMsgsNew.
1038 func (cl *Client) sendInitialMessages(conn *PeerConn, torrent *Torrent) {
1039         if conn.PeerExtensionBytes.SupportsExtended() && cl.config.Extensions.SupportsExtended() {
1040                 conn.write(pp.Message{
1041                         Type:       pp.Extended,
1042                         ExtendedID: pp.HandshakeExtendedID,
1043                         ExtendedPayload: func() []byte {
1044                                 msg := pp.ExtendedHandshakeMessage{
1045                                         M: map[pp.ExtensionName]pp.ExtensionNumber{
1046                                                 pp.ExtensionNameMetadata: metadataExtendedId,
1047                                         },
1048                                         V:            cl.config.ExtendedHandshakeClientVersion,
1049                                         Reqq:         localClientReqq,
1050                                         YourIp:       pp.CompactIp(conn.remoteIp()),
1051                                         Encryption:   cl.config.HeaderObfuscationPolicy.Preferred || !cl.config.HeaderObfuscationPolicy.RequirePreferred,
1052                                         Port:         cl.incomingPeerPort(),
1053                                         MetadataSize: torrent.metadataSize(),
1054                                         // TODO: We can figure these out specific to the socket used.
1055                                         Ipv4: pp.CompactIp(cl.config.PublicIp4.To4()),
1056                                         Ipv6: cl.config.PublicIp6.To16(),
1057                                 }
1058                                 if !cl.config.DisablePEX {
1059                                         msg.M[pp.ExtensionNamePex] = pexExtendedId
1060                                 }
1061                                 return bencode.MustMarshal(msg)
1062                         }(),
1063                 })
1064         }
1065         func() {
1066                 if conn.fastEnabled() {
1067                         if torrent.haveAllPieces() {
1068                                 conn.write(pp.Message{Type: pp.HaveAll})
1069                                 conn.sentHaves.AddRange(0, bitmap.BitRange(conn.t.NumPieces()))
1070                                 return
1071                         } else if !torrent.haveAnyPieces() {
1072                                 conn.write(pp.Message{Type: pp.HaveNone})
1073                                 conn.sentHaves.Clear()
1074                                 return
1075                         }
1076                 }
1077                 conn.postBitfield()
1078         }()
1079         if conn.PeerExtensionBytes.SupportsDHT() && cl.config.Extensions.SupportsDHT() && cl.haveDhtServer() {
1080                 conn.write(pp.Message{
1081                         Type: pp.Port,
1082                         Port: cl.dhtPort(),
1083                 })
1084         }
1085 }
1086
1087 func (cl *Client) dhtPort() (ret uint16) {
1088         if len(cl.dhtServers) == 0 {
1089                 return
1090         }
1091         return uint16(missinggo.AddrPort(cl.dhtServers[len(cl.dhtServers)-1].Addr()))
1092 }
1093
1094 func (cl *Client) haveDhtServer() bool {
1095         return len(cl.dhtServers) > 0
1096 }
1097
1098 // Process incoming ut_metadata message.
1099 func (cl *Client) gotMetadataExtensionMsg(payload []byte, t *Torrent, c *PeerConn) error {
1100         var d pp.ExtendedMetadataRequestMsg
1101         err := bencode.Unmarshal(payload, &d)
1102         if _, ok := err.(bencode.ErrUnusedTrailingBytes); ok {
1103         } else if err != nil {
1104                 return fmt.Errorf("error unmarshalling bencode: %s", err)
1105         }
1106         piece := d.Piece
1107         switch d.Type {
1108         case pp.DataMetadataExtensionMsgType:
1109                 c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.MetadataChunksRead }))
1110                 if !c.requestedMetadataPiece(piece) {
1111                         return fmt.Errorf("got unexpected piece %d", piece)
1112                 }
1113                 c.metadataRequests[piece] = false
1114                 begin := len(payload) - d.PieceSize()
1115                 if begin < 0 || begin >= len(payload) {
1116                         return fmt.Errorf("data has bad offset in payload: %d", begin)
1117                 }
1118                 t.saveMetadataPiece(piece, payload[begin:])
1119                 c.lastUsefulChunkReceived = time.Now()
1120                 err = t.maybeCompleteMetadata()
1121                 if err != nil {
1122                         // Log this at the Torrent-level, as we don't partition metadata by Peer yet, so we
1123                         // don't know who to blame. TODO: Also errors can be returned here that aren't related
1124                         // to verifying metadata, which should be fixed. This should be tagged with metadata, so
1125                         // log consumers can filter for this message.
1126                         t.logger.WithDefaultLevel(log.Warning).Printf("error completing metadata: %v", err)
1127                 }
1128                 return err
1129         case pp.RequestMetadataExtensionMsgType:
1130                 if !t.haveMetadataPiece(piece) {
1131                         c.write(t.newMetadataExtensionMessage(c, pp.RejectMetadataExtensionMsgType, d.Piece, nil))
1132                         return nil
1133                 }
1134                 start := (1 << 14) * piece
1135                 c.logger.WithDefaultLevel(log.Debug).Printf("sending metadata piece %d", piece)
1136                 c.write(t.newMetadataExtensionMessage(c, pp.DataMetadataExtensionMsgType, piece, t.metadataBytes[start:start+t.metadataPieceSize(piece)]))
1137                 return nil
1138         case pp.RejectMetadataExtensionMsgType:
1139                 return nil
1140         default:
1141                 return errors.New("unknown msg_type value")
1142         }
1143 }
1144
1145 func (cl *Client) badPeerAddr(addr PeerRemoteAddr) bool {
1146         if ipa, ok := tryIpPortFromNetAddr(addr); ok {
1147                 return cl.badPeerIPPort(ipa.IP, ipa.Port)
1148         }
1149         return false
1150 }
1151
1152 // Returns whether the IP address and port are considered "bad".
1153 func (cl *Client) badPeerIPPort(ip net.IP, port int) bool {
1154         if port == 0 || ip == nil {
1155                 return true
1156         }
1157         if cl.dopplegangerAddr(net.JoinHostPort(ip.String(), strconv.FormatInt(int64(port), 10))) {
1158                 return true
1159         }
1160         if _, ok := cl.ipBlockRange(ip); ok {
1161                 return true
1162         }
1163         ipAddr, ok := netip.AddrFromSlice(ip)
1164         if !ok {
1165                 panic(ip)
1166         }
1167         if _, ok := cl.badPeerIPs[ipAddr]; ok {
1168                 return true
1169         }
1170         return false
1171 }
1172
1173 // Return a Torrent ready for insertion into a Client.
1174 func (cl *Client) newTorrent(ih metainfo.Hash, specStorage storage.ClientImpl) (t *Torrent) {
1175         return cl.newTorrentOpt(AddTorrentOpts{
1176                 InfoHash: ih,
1177                 Storage:  specStorage,
1178         })
1179 }
1180
1181 // Return a Torrent ready for insertion into a Client.
1182 func (cl *Client) newTorrentOpt(opts AddTorrentOpts) (t *Torrent) {
1183         // use provided storage, if provided
1184         storageClient := cl.defaultStorage
1185         if opts.Storage != nil {
1186                 storageClient = storage.NewClient(opts.Storage)
1187         }
1188
1189         t = &Torrent{
1190                 cl:       cl,
1191                 infoHash: opts.InfoHash,
1192                 peers: prioritizedPeers{
1193                         om: gbtree.New(32),
1194                         getPrio: func(p PeerInfo) peerPriority {
1195                                 ipPort := p.addr()
1196                                 return bep40PriorityIgnoreError(cl.publicAddr(ipPort.IP), ipPort)
1197                         },
1198                 },
1199                 conns: make(map[*PeerConn]struct{}, 2*cl.config.EstablishedConnsPerTorrent),
1200
1201                 halfOpen: make(map[string]PeerInfo),
1202
1203                 storageOpener:       storageClient,
1204                 maxEstablishedConns: cl.config.EstablishedConnsPerTorrent,
1205
1206                 metadataChanged: sync.Cond{
1207                         L: cl.locker(),
1208                 },
1209                 webSeeds:     make(map[string]*Peer),
1210                 gotMetainfoC: make(chan struct{}),
1211         }
1212         t.smartBanCache.Hash = sha1.Sum
1213         t.smartBanCache.Init()
1214         t.networkingEnabled.Set()
1215         t.logger = cl.logger.WithContextValue(t).WithNames("torrent", t.infoHash.HexString())
1216         t.sourcesLogger = t.logger.WithNames("sources")
1217         if opts.ChunkSize == 0 {
1218                 opts.ChunkSize = defaultChunkSize
1219         }
1220         t.setChunkSize(opts.ChunkSize)
1221         return
1222 }
1223
1224 // A file-like handle to some torrent data resource.
1225 type Handle interface {
1226         io.Reader
1227         io.Seeker
1228         io.Closer
1229         io.ReaderAt
1230 }
1231
1232 func (cl *Client) AddTorrentInfoHash(infoHash metainfo.Hash) (t *Torrent, new bool) {
1233         return cl.AddTorrentInfoHashWithStorage(infoHash, nil)
1234 }
1235
1236 // Adds a torrent by InfoHash with a custom Storage implementation.
1237 // If the torrent already exists then this Storage is ignored and the
1238 // existing torrent returned with `new` set to `false`
1239 func (cl *Client) AddTorrentInfoHashWithStorage(infoHash metainfo.Hash, specStorage storage.ClientImpl) (t *Torrent, new bool) {
1240         cl.lock()
1241         defer cl.unlock()
1242         t, ok := cl.torrents[infoHash]
1243         if ok {
1244                 return
1245         }
1246         new = true
1247
1248         t = cl.newTorrent(infoHash, specStorage)
1249         cl.eachDhtServer(func(s DhtServer) {
1250                 if cl.config.PeriodicallyAnnounceTorrentsToDht {
1251                         go t.dhtAnnouncer(s)
1252                 }
1253         })
1254         cl.torrents[infoHash] = t
1255         cl.clearAcceptLimits()
1256         t.updateWantPeersEvent()
1257         // Tickle Client.waitAccept, new torrent may want conns.
1258         cl.event.Broadcast()
1259         return
1260 }
1261
1262 // Adds a torrent by InfoHash with a custom Storage implementation.
1263 // If the torrent already exists then this Storage is ignored and the
1264 // existing torrent returned with `new` set to `false`
1265 func (cl *Client) AddTorrentOpt(opts AddTorrentOpts) (t *Torrent, new bool) {
1266         infoHash := opts.InfoHash
1267         cl.lock()
1268         defer cl.unlock()
1269         t, ok := cl.torrents[infoHash]
1270         if ok {
1271                 return
1272         }
1273         new = true
1274
1275         t = cl.newTorrentOpt(opts)
1276         cl.eachDhtServer(func(s DhtServer) {
1277                 if cl.config.PeriodicallyAnnounceTorrentsToDht {
1278                         go t.dhtAnnouncer(s)
1279                 }
1280         })
1281         cl.torrents[infoHash] = t
1282         cl.clearAcceptLimits()
1283         t.updateWantPeersEvent()
1284         // Tickle Client.waitAccept, new torrent may want conns.
1285         cl.event.Broadcast()
1286         return
1287 }
1288
1289 type AddTorrentOpts struct {
1290         InfoHash  infohash.T
1291         Storage   storage.ClientImpl
1292         ChunkSize pp.Integer
1293 }
1294
1295 // Add or merge a torrent spec. Returns new if the torrent wasn't already in the client. See also
1296 // Torrent.MergeSpec.
1297 func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (t *Torrent, new bool, err error) {
1298         t, new = cl.AddTorrentOpt(AddTorrentOpts{
1299                 InfoHash:  spec.InfoHash,
1300                 Storage:   spec.Storage,
1301                 ChunkSize: spec.ChunkSize,
1302         })
1303         modSpec := *spec
1304         if new {
1305                 // ChunkSize was already applied by adding a new Torrent, and MergeSpec disallows changing
1306                 // it.
1307                 modSpec.ChunkSize = 0
1308         }
1309         err = t.MergeSpec(&modSpec)
1310         if err != nil && new {
1311                 t.Drop()
1312         }
1313         return
1314 }
1315
1316 type stringAddr string
1317
1318 var _ net.Addr = stringAddr("")
1319
1320 func (stringAddr) Network() string   { return "" }
1321 func (me stringAddr) String() string { return string(me) }
1322
1323 // The trackers will be merged with the existing ones. If the Info isn't yet known, it will be set.
1324 // spec.DisallowDataDownload/Upload will be read and applied
1325 // The display name is replaced if the new spec provides one. Note that any `Storage` is ignored.
1326 func (t *Torrent) MergeSpec(spec *TorrentSpec) error {
1327         if spec.DisplayName != "" {
1328                 t.SetDisplayName(spec.DisplayName)
1329         }
1330         if spec.InfoBytes != nil {
1331                 err := t.SetInfoBytes(spec.InfoBytes)
1332                 if err != nil {
1333                         return err
1334                 }
1335         }
1336         cl := t.cl
1337         cl.AddDhtNodes(spec.DhtNodes)
1338         t.UseSources(spec.Sources)
1339         cl.lock()
1340         defer cl.unlock()
1341         t.initialPieceCheckDisabled = spec.DisableInitialPieceCheck
1342         for _, url := range spec.Webseeds {
1343                 t.addWebSeed(url)
1344         }
1345         for _, peerAddr := range spec.PeerAddrs {
1346                 t.addPeer(PeerInfo{
1347                         Addr:    stringAddr(peerAddr),
1348                         Source:  PeerSourceDirect,
1349                         Trusted: true,
1350                 })
1351         }
1352         if spec.ChunkSize != 0 {
1353                 panic("chunk size cannot be changed for existing Torrent")
1354         }
1355         t.addTrackers(spec.Trackers)
1356         t.maybeNewConns()
1357         t.dataDownloadDisallowed.SetBool(spec.DisallowDataDownload)
1358         t.dataUploadDisallowed = spec.DisallowDataUpload
1359         return nil
1360 }
1361
1362 func (cl *Client) dropTorrent(infoHash metainfo.Hash, wg *sync.WaitGroup) (err error) {
1363         t, ok := cl.torrents[infoHash]
1364         if !ok {
1365                 err = fmt.Errorf("no such torrent")
1366                 return
1367         }
1368         err = t.close(wg)
1369         delete(cl.torrents, infoHash)
1370         return
1371 }
1372
1373 func (cl *Client) allTorrentsCompleted() bool {
1374         for _, t := range cl.torrents {
1375                 if !t.haveInfo() {
1376                         return false
1377                 }
1378                 if !t.haveAllPieces() {
1379                         return false
1380                 }
1381         }
1382         return true
1383 }
1384
1385 // Returns true when all torrents are completely downloaded and false if the
1386 // client is stopped before that.
1387 func (cl *Client) WaitAll() bool {
1388         cl.lock()
1389         defer cl.unlock()
1390         for !cl.allTorrentsCompleted() {
1391                 if cl.closed.IsSet() {
1392                         return false
1393                 }
1394                 cl.event.Wait()
1395         }
1396         return true
1397 }
1398
1399 // Returns handles to all the torrents loaded in the Client.
1400 func (cl *Client) Torrents() []*Torrent {
1401         cl.rLock()
1402         defer cl.rUnlock()
1403         return cl.torrentsAsSlice()
1404 }
1405
1406 func (cl *Client) torrentsAsSlice() (ret []*Torrent) {
1407         for _, t := range cl.torrents {
1408                 ret = append(ret, t)
1409         }
1410         return
1411 }
1412
1413 func (cl *Client) AddMagnet(uri string) (T *Torrent, err error) {
1414         spec, err := TorrentSpecFromMagnetUri(uri)
1415         if err != nil {
1416                 return
1417         }
1418         T, _, err = cl.AddTorrentSpec(spec)
1419         return
1420 }
1421
1422 func (cl *Client) AddTorrent(mi *metainfo.MetaInfo) (T *Torrent, err error) {
1423         ts, err := TorrentSpecFromMetaInfoErr(mi)
1424         if err != nil {
1425                 return
1426         }
1427         T, _, err = cl.AddTorrentSpec(ts)
1428         return
1429 }
1430
1431 func (cl *Client) AddTorrentFromFile(filename string) (T *Torrent, err error) {
1432         mi, err := metainfo.LoadFromFile(filename)
1433         if err != nil {
1434                 return
1435         }
1436         return cl.AddTorrent(mi)
1437 }
1438
1439 func (cl *Client) DhtServers() []DhtServer {
1440         return cl.dhtServers
1441 }
1442
1443 func (cl *Client) AddDhtNodes(nodes []string) {
1444         for _, n := range nodes {
1445                 hmp := missinggo.SplitHostMaybePort(n)
1446                 ip := net.ParseIP(hmp.Host)
1447                 if ip == nil {
1448                         cl.logger.Printf("won't add DHT node with bad IP: %q", hmp.Host)
1449                         continue
1450                 }
1451                 ni := krpc.NodeInfo{
1452                         Addr: krpc.NodeAddr{
1453                                 IP:   ip,
1454                                 Port: hmp.Port,
1455                         },
1456                 }
1457                 cl.eachDhtServer(func(s DhtServer) {
1458                         s.AddNode(ni)
1459                 })
1460         }
1461 }
1462
1463 func (cl *Client) banPeerIP(ip net.IP) {
1464         // We can't take this from string, because it will lose netip's v4on6. net.ParseIP parses v4
1465         // addresses directly to v4on6, which doesn't compare equal with v4.
1466         ipAddr, ok := netip.AddrFromSlice(ip)
1467         if !ok {
1468                 panic(ip)
1469         }
1470         generics.MakeMapIfNilAndSet(&cl.badPeerIPs, ipAddr, struct{}{})
1471         for _, t := range cl.torrents {
1472                 t.iterPeers(func(p *Peer) {
1473                         if p.remoteIp().Equal(ip) {
1474                                 t.logger.Levelf(log.Warning, "dropping peer %v with banned ip %v", p, ip)
1475                                 // Should this be a close?
1476                                 p.drop()
1477                         }
1478                 })
1479         }
1480 }
1481
1482 type newConnectionOpts struct {
1483         outgoing        bool
1484         remoteAddr      PeerRemoteAddr
1485         localPublicAddr peerLocalPublicAddr
1486         network         string
1487         connString      string
1488 }
1489
1490 func (cl *Client) newConnection(nc net.Conn, opts newConnectionOpts) (c *PeerConn) {
1491         if opts.network == "" {
1492                 panic(opts.remoteAddr)
1493         }
1494         c = &PeerConn{
1495                 Peer: Peer{
1496                         outgoing:        opts.outgoing,
1497                         choking:         true,
1498                         peerChoking:     true,
1499                         PeerMaxRequests: 250,
1500
1501                         RemoteAddr:      opts.remoteAddr,
1502                         localPublicAddr: opts.localPublicAddr,
1503                         Network:         opts.network,
1504                         callbacks:       &cl.config.Callbacks,
1505                 },
1506                 connString: opts.connString,
1507                 conn:       nc,
1508         }
1509         c.peerRequestDataAllocLimiter.Max = cl.config.MaxAllocPeerRequestDataPerConn
1510         c.initRequestState()
1511         // TODO: Need to be much more explicit about this, including allowing non-IP bannable addresses.
1512         if opts.remoteAddr != nil {
1513                 netipAddrPort, err := netip.ParseAddrPort(opts.remoteAddr.String())
1514                 if err == nil {
1515                         c.bannableAddr = Some(netipAddrPort.Addr())
1516                 }
1517         }
1518         c.peerImpl = c
1519         c.logger = cl.logger.WithDefaultLevel(log.Warning).WithContextValue(c)
1520         c.setRW(connStatsReadWriter{nc, c})
1521         c.r = &rateLimitedReader{
1522                 l: cl.config.DownloadRateLimiter,
1523                 r: c.r,
1524         }
1525         c.logger.WithDefaultLevel(log.Debug).Printf("initialized with remote %v over network %v (outgoing=%t)", opts.remoteAddr, opts.network, opts.outgoing)
1526         for _, f := range cl.config.Callbacks.NewPeer {
1527                 f(&c.Peer)
1528         }
1529         return
1530 }
1531
1532 func (cl *Client) onDHTAnnouncePeer(ih metainfo.Hash, ip net.IP, port int, portOk bool) {
1533         cl.lock()
1534         defer cl.unlock()
1535         t := cl.torrent(ih)
1536         if t == nil {
1537                 return
1538         }
1539         t.addPeers([]PeerInfo{{
1540                 Addr:   ipPortAddr{ip, port},
1541                 Source: PeerSourceDhtAnnouncePeer,
1542         }})
1543 }
1544
1545 func firstNotNil(ips ...net.IP) net.IP {
1546         for _, ip := range ips {
1547                 if ip != nil {
1548                         return ip
1549                 }
1550         }
1551         return nil
1552 }
1553
1554 func (cl *Client) eachListener(f func(Listener) bool) {
1555         for _, s := range cl.listeners {
1556                 if !f(s) {
1557                         break
1558                 }
1559         }
1560 }
1561
1562 func (cl *Client) findListener(f func(Listener) bool) (ret Listener) {
1563         for i := 0; i < len(cl.listeners); i += 1 {
1564                 if ret = cl.listeners[i]; f(ret) {
1565                         return
1566                 }
1567         }
1568         return nil
1569 }
1570
1571 func (cl *Client) publicIp(peer net.IP) net.IP {
1572         // TODO: Use BEP 10 to determine how peers are seeing us.
1573         if peer.To4() != nil {
1574                 return firstNotNil(
1575                         cl.config.PublicIp4,
1576                         cl.findListenerIp(func(ip net.IP) bool { return ip.To4() != nil }),
1577                 )
1578         }
1579
1580         return firstNotNil(
1581                 cl.config.PublicIp6,
1582                 cl.findListenerIp(func(ip net.IP) bool { return ip.To4() == nil }),
1583         )
1584 }
1585
1586 func (cl *Client) findListenerIp(f func(net.IP) bool) net.IP {
1587         l := cl.findListener(
1588                 func(l Listener) bool {
1589                         return f(addrIpOrNil(l.Addr()))
1590                 },
1591         )
1592         if l == nil {
1593                 return nil
1594         }
1595         return addrIpOrNil(l.Addr())
1596 }
1597
1598 // Our IP as a peer should see it.
1599 func (cl *Client) publicAddr(peer net.IP) IpPort {
1600         return IpPort{IP: cl.publicIp(peer), Port: uint16(cl.incomingPeerPort())}
1601 }
1602
1603 // ListenAddrs addresses currently being listened to.
1604 func (cl *Client) ListenAddrs() (ret []net.Addr) {
1605         cl.lock()
1606         ret = make([]net.Addr, len(cl.listeners))
1607         for i := 0; i < len(cl.listeners); i += 1 {
1608                 ret[i] = cl.listeners[i].Addr()
1609         }
1610         cl.unlock()
1611         return
1612 }
1613
1614 func (cl *Client) PublicIPs() (ips []net.IP) {
1615         if ip := cl.config.PublicIp4; ip != nil {
1616                 ips = append(ips, ip)
1617         }
1618         if ip := cl.config.PublicIp6; ip != nil {
1619                 ips = append(ips, ip)
1620         }
1621         return
1622 }
1623
1624 func (cl *Client) onBadAccept(addr PeerRemoteAddr) {
1625         ipa, ok := tryIpPortFromNetAddr(addr)
1626         if !ok {
1627                 return
1628         }
1629         ip := maskIpForAcceptLimiting(ipa.IP)
1630         if cl.acceptLimiter == nil {
1631                 cl.acceptLimiter = make(map[ipStr]int)
1632         }
1633         cl.acceptLimiter[ipStr(ip.String())]++
1634 }
1635
1636 func maskIpForAcceptLimiting(ip net.IP) net.IP {
1637         if ip4 := ip.To4(); ip4 != nil {
1638                 return ip4.Mask(net.CIDRMask(24, 32))
1639         }
1640         return ip
1641 }
1642
1643 func (cl *Client) clearAcceptLimits() {
1644         cl.acceptLimiter = nil
1645 }
1646
1647 func (cl *Client) acceptLimitClearer() {
1648         for {
1649                 select {
1650                 case <-cl.closed.Done():
1651                         return
1652                 case <-time.After(15 * time.Minute):
1653                         cl.lock()
1654                         cl.clearAcceptLimits()
1655                         cl.unlock()
1656                 }
1657         }
1658 }
1659
1660 func (cl *Client) rateLimitAccept(ip net.IP) bool {
1661         if cl.config.DisableAcceptRateLimiting {
1662                 return false
1663         }
1664         return cl.acceptLimiter[ipStr(maskIpForAcceptLimiting(ip).String())] > 0
1665 }
1666
1667 func (cl *Client) rLock() {
1668         cl._mu.RLock()
1669 }
1670
1671 func (cl *Client) rUnlock() {
1672         cl._mu.RUnlock()
1673 }
1674
1675 func (cl *Client) lock() {
1676         cl._mu.Lock()
1677 }
1678
1679 func (cl *Client) unlock() {
1680         cl._mu.Unlock()
1681 }
1682
1683 func (cl *Client) locker() *lockWithDeferreds {
1684         return &cl._mu
1685 }
1686
1687 func (cl *Client) String() string {
1688         return fmt.Sprintf("<%[1]T %[1]p>", cl)
1689 }
1690
1691 // Returns connection-level aggregate stats at the Client level. See the comment on
1692 // TorrentStats.ConnStats.
1693 func (cl *Client) ConnStats() ConnStats {
1694         return cl.stats.Copy()
1695 }