packet.go 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. package dhcp4
  2. import (
  3. "net"
  4. "time"
  5. )
  6. // A DHCP packet
  7. type Packet []byte
  8. func (p Packet) OpCode() OpCode { return OpCode(p[0]) }
  9. func (p Packet) HType() byte { return p[1] }
  10. func (p Packet) HLen() byte { return p[2] }
  11. func (p Packet) Hops() byte { return p[3] }
  12. func (p Packet) XId() []byte { return p[4:8] }
  13. func (p Packet) Secs() []byte { return p[8:10] } // Never Used?
  14. func (p Packet) Flags() []byte { return p[10:12] }
  15. func (p Packet) CIAddr() net.IP { return net.IP(p[12:16]) }
  16. func (p Packet) YIAddr() net.IP { return net.IP(p[16:20]) }
  17. func (p Packet) SIAddr() net.IP { return net.IP(p[20:24]) }
  18. func (p Packet) GIAddr() net.IP { return net.IP(p[24:28]) }
  19. func (p Packet) CHAddr() net.HardwareAddr {
  20. hLen := p.HLen()
  21. if hLen > 16 { // Prevent chaddr exceeding p boundary
  22. hLen = 16
  23. }
  24. return net.HardwareAddr(p[28 : 28+hLen]) // max endPos 44
  25. }
  26. // 192 bytes of zeros BOOTP legacy
  27. func (p Packet) Cookie() []byte { return p[236:240] }
  28. func (p Packet) Options() []byte {
  29. if len(p) > 240 {
  30. return p[240:]
  31. }
  32. return nil
  33. }
  34. func (p Packet) Broadcast() bool { return p.Flags()[0] > 127 }
  35. func (p Packet) SetBroadcast(broadcast bool) {
  36. if p.Broadcast() != broadcast {
  37. p.Flags()[0] ^= 128
  38. }
  39. }
  40. func (p Packet) SetOpCode(c OpCode) { p[0] = byte(c) }
  41. func (p Packet) SetCHAddr(a net.HardwareAddr) {
  42. copy(p[28:44], a)
  43. p[2] = byte(len(a))
  44. }
  45. func (p Packet) SetHType(hType byte) { p[1] = hType }
  46. func (p Packet) SetCookie(cookie []byte) { copy(p.Cookie(), cookie) }
  47. func (p Packet) SetHops(hops byte) { p[3] = hops }
  48. func (p Packet) SetXId(xId []byte) { copy(p.XId(), xId) }
  49. func (p Packet) SetSecs(secs []byte) { copy(p.Secs(), secs) }
  50. func (p Packet) SetFlags(flags []byte) { copy(p.Flags(), flags) }
  51. func (p Packet) SetCIAddr(ip net.IP) { copy(p.CIAddr(), ip.To4()) }
  52. func (p Packet) SetYIAddr(ip net.IP) { copy(p.YIAddr(), ip.To4()) }
  53. func (p Packet) SetSIAddr(ip net.IP) { copy(p.SIAddr(), ip.To4()) }
  54. func (p Packet) SetGIAddr(ip net.IP) { copy(p.GIAddr(), ip.To4()) }
  55. // Parses the packet's options into an Options map
  56. func (p Packet) ParseOptions() Options {
  57. opts := p.Options()
  58. options := make(Options, 10)
  59. for len(opts) >= 2 && OptionCode(opts[0]) != End {
  60. if OptionCode(opts[0]) == Pad {
  61. opts = opts[1:]
  62. continue
  63. }
  64. size := int(opts[1])
  65. if len(opts) < 2+size {
  66. break
  67. }
  68. options[OptionCode(opts[0])] = opts[2 : 2+size]
  69. opts = opts[2+size:]
  70. }
  71. return options
  72. }
  73. func NewPacket(opCode OpCode) Packet {
  74. p := make(Packet, 241)
  75. p.SetOpCode(opCode)
  76. p.SetHType(1) // Ethernet
  77. p.SetCookie([]byte{99, 130, 83, 99})
  78. p[240] = byte(End)
  79. return p
  80. }
  81. // Appends a DHCP option to the end of a packet
  82. func (p *Packet) AddOption(o OptionCode, value []byte) {
  83. *p = append((*p)[:len(*p)-1], []byte{byte(o), byte(len(value))}...) // Strip off End, Add OptionCode and Length
  84. *p = append(*p, value...) // Add Option Value
  85. *p = append(*p, byte(End)) // Add on new End
  86. }
  87. // Removes all options from packet.
  88. func (p *Packet) StripOptions() {
  89. *p = append((*p)[:240], byte(End))
  90. }
  91. // Creates a request packet that a Client would send to a server.
  92. func RequestPacket(mt MessageType, chAddr net.HardwareAddr, cIAddr net.IP, xId []byte, broadcast bool, options []Option) Packet {
  93. p := NewPacket(BootRequest)
  94. p.SetCHAddr(chAddr)
  95. p.SetXId(xId)
  96. if cIAddr != nil {
  97. p.SetCIAddr(cIAddr)
  98. }
  99. p.SetBroadcast(broadcast)
  100. p.AddOption(OptionDHCPMessageType, []byte{byte(mt)})
  101. for _, o := range options {
  102. p.AddOption(o.Code, o.Value)
  103. }
  104. p.PadToMinSize()
  105. return p
  106. }
  107. // ReplyPacket creates a reply packet that a Server would send to a client.
  108. // It uses the req Packet param to copy across common/necessary fields to
  109. // associate the reply the request.
  110. func ReplyPacket(req Packet, mt MessageType, serverId, yIAddr net.IP, leaseDuration time.Duration, options []Option) Packet {
  111. p := NewPacket(BootReply)
  112. p.SetXId(req.XId())
  113. p.SetFlags(req.Flags())
  114. p.SetYIAddr(yIAddr)
  115. p.SetGIAddr(req.GIAddr())
  116. p.SetCHAddr(req.CHAddr())
  117. p.AddOption(OptionDHCPMessageType, []byte{byte(mt)})
  118. p.AddOption(OptionServerIdentifier, []byte(serverId))
  119. if leaseDuration > 0 {
  120. p.AddOption(OptionIPAddressLeaseTime, OptionsLeaseTime(leaseDuration))
  121. }
  122. for _, o := range options {
  123. p.AddOption(o.Code, o.Value)
  124. }
  125. p.PadToMinSize()
  126. return p
  127. }
  128. // PadToMinSize pads a packet so that when sent over UDP, the entire packet,
  129. // is 300 bytes (BOOTP min), to be compatible with really old devices.
  130. var padder [272]byte
  131. func (p *Packet) PadToMinSize() {
  132. if n := len(*p); n < 272 {
  133. *p = append(*p, padder[:272-n]...)
  134. }
  135. }