client.go

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