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