client.go

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