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