client.go

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