peer_protocol/handshake.go

   1 package peer_protocol
   2
   3 import (
   4         "encoding/hex"
   5         "fmt"
   6         "io"
   7
   8         "github.com/anacrolix/missinggo"
   9
  10         "github.com/anacrolix/torrent/metainfo"
  11 )
  12
  13 type ExtensionBit uint
  14
  15 const (
  16         ExtensionBitDHT      = 0  // http://www.bittorrent.org/beps/bep_0005.html
  17         ExtensionBitExtended = 20 // http://www.bittorrent.org/beps/bep_0010.html
  18         ExtensionBitFast     = 2  // http://www.bittorrent.org/beps/bep_0006.html
  19 )
  20
  21 func handshakeWriter(w io.Writer, bb <-chan []byte, done chan<- error) {
  22         var err error
  23         for b := range bb {
  24                 _, err = w.Write(b)
  25                 if err != nil {
  26                         break
  27                 }
  28         }
  29         done <- err
  30 }
  31
  32 type (
  33         PeerExtensionBits [8]byte
  34 )
  35
  36 func (me PeerExtensionBits) String() string {
  37         return hex.EncodeToString(me[:])
  38 }
  39
  40 func NewPeerExtensionBytes(bits ...ExtensionBit) (ret PeerExtensionBits) {
  41         for _, b := range bits {
  42                 ret.SetBit(b)
  43         }
  44         return
  45 }
  46
  47 func (pex PeerExtensionBits) SupportsExtended() bool {
  48         return pex.GetBit(ExtensionBitExtended)
  49 }
  50
  51 func (pex PeerExtensionBits) SupportsDHT() bool {
  52         return pex.GetBit(ExtensionBitDHT)
  53 }
  54
  55 func (pex PeerExtensionBits) SupportsFast() bool {
  56         return pex.GetBit(ExtensionBitFast)
  57 }
  58
  59 func (pex *PeerExtensionBits) SetBit(bit ExtensionBit) {
  60         pex[7-bit/8] |= 1 << (bit % 8)
  61 }
  62
  63 func (pex PeerExtensionBits) GetBit(bit ExtensionBit) bool {
  64         return pex[7-bit/8]&(1<<(bit%8)) != 0
  65 }
  66
  67 type HandshakeResult struct {
  68         PeerExtensionBits
  69         PeerID [20]byte
  70         metainfo.Hash
  71 }
  72
  73 // ih is nil if we expect the peer to declare the InfoHash, such as when the
  74 // peer initiated the connection. Returns ok if the Handshake was successful,
  75 // and err if there was an unexpected condition other than the peer simply
  76 // abandoning the Handshake.
  77 func Handshake(sock io.ReadWriter, ih *metainfo.Hash, peerID [20]byte, extensions PeerExtensionBits) (res HandshakeResult, ok bool, err error) {
  78         // Bytes to be sent to the peer. Should never block the sender.
  79         postCh := make(chan []byte, 4)
  80         // A single error value sent when the writer completes.
  81         writeDone := make(chan error, 1)
  82         // Performs writes to the socket and ensures posts don't block.
  83         go handshakeWriter(sock, postCh, writeDone)
  84
  85         defer func() {
  86                 close(postCh) // Done writing.
  87                 if !ok {
  88                         return
  89                 }
  90                 if err != nil {
  91                         panic(err)
  92                 }
  93                 // Wait until writes complete before returning from handshake.
  94                 err = <-writeDone
  95                 if err != nil {
  96                         err = fmt.Errorf("error writing: %s", err)
  97                 }
  98         }()
  99
 100         post := func(bb []byte) {
 101                 select {
 102                 case postCh <- bb:
 103                 default:
 104                         panic("mustn't block while posting")
 105                 }
 106         }
 107
 108         post([]byte(Protocol))
 109         post(extensions[:])
 110         if ih != nil { // We already know what we want.
 111                 post(ih[:])
 112                 post(peerID[:])
 113         }
 114         var b [68]byte
 115         _, err = io.ReadFull(sock, b[:68])
 116         if err != nil {
 117                 err = nil
 118                 return
 119         }
 120         if string(b[:20]) != Protocol {
 121                 return
 122         }
 123         missinggo.CopyExact(&res.PeerExtensionBits, b[20:28])
 124         missinggo.CopyExact(&res.Hash, b[28:48])
 125         missinggo.CopyExact(&res.PeerID, b[48:68])
 126         // peerExtensions.Add(res.PeerExtensionBits.String(), 1)
 127
 128         // TODO: Maybe we can just drop peers here if we're not interested. This
 129         // could prevent them trying to reconnect, falsely believing there was
 130         // just a problem.
 131         if ih == nil { // We were waiting for the peer to tell us what they wanted.
 132                 post(res.Hash[:])
 133                 post(peerID[:])
 134         }
 135
 136         ok = true
 137         return
 138 }