msg_helpers.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631
  1. package dns
  2. import (
  3. "encoding/base32"
  4. "encoding/base64"
  5. "encoding/binary"
  6. "encoding/hex"
  7. "net"
  8. "strconv"
  9. )
  10. // helper functions called from the generated zmsg.go
  11. // These function are named after the tag to help pack/unpack, if there is no tag it is the name
  12. // of the type they pack/unpack (string, int, etc). We prefix all with unpackData or packData, so packDataA or
  13. // packDataDomainName.
  14. func unpackDataA(msg []byte, off int) (net.IP, int, error) {
  15. if off+net.IPv4len > len(msg) {
  16. return nil, len(msg), &Error{err: "overflow unpacking a"}
  17. }
  18. a := append(make(net.IP, 0, net.IPv4len), msg[off:off+net.IPv4len]...)
  19. off += net.IPv4len
  20. return a, off, nil
  21. }
  22. func packDataA(a net.IP, msg []byte, off int) (int, error) {
  23. // It must be a slice of 4, even if it is 16, we encode only the first 4
  24. if off+net.IPv4len > len(msg) {
  25. return len(msg), &Error{err: "overflow packing a"}
  26. }
  27. switch len(a) {
  28. case net.IPv4len, net.IPv6len:
  29. copy(msg[off:], a.To4())
  30. off += net.IPv4len
  31. case 0:
  32. // Allowed, for dynamic updates.
  33. default:
  34. return len(msg), &Error{err: "overflow packing a"}
  35. }
  36. return off, nil
  37. }
  38. func unpackDataAAAA(msg []byte, off int) (net.IP, int, error) {
  39. if off+net.IPv6len > len(msg) {
  40. return nil, len(msg), &Error{err: "overflow unpacking aaaa"}
  41. }
  42. aaaa := append(make(net.IP, 0, net.IPv6len), msg[off:off+net.IPv6len]...)
  43. off += net.IPv6len
  44. return aaaa, off, nil
  45. }
  46. func packDataAAAA(aaaa net.IP, msg []byte, off int) (int, error) {
  47. if off+net.IPv6len > len(msg) {
  48. return len(msg), &Error{err: "overflow packing aaaa"}
  49. }
  50. switch len(aaaa) {
  51. case net.IPv6len:
  52. copy(msg[off:], aaaa)
  53. off += net.IPv6len
  54. case 0:
  55. // Allowed, dynamic updates.
  56. default:
  57. return len(msg), &Error{err: "overflow packing aaaa"}
  58. }
  59. return off, nil
  60. }
  61. // unpackHeader unpacks an RR header, returning the offset to the end of the header and a
  62. // re-sliced msg according to the expected length of the RR.
  63. func unpackHeader(msg []byte, off int) (rr RR_Header, off1 int, truncmsg []byte, err error) {
  64. hdr := RR_Header{}
  65. if off == len(msg) {
  66. return hdr, off, msg, nil
  67. }
  68. hdr.Name, off, err = UnpackDomainName(msg, off)
  69. if err != nil {
  70. return hdr, len(msg), msg, err
  71. }
  72. hdr.Rrtype, off, err = unpackUint16(msg, off)
  73. if err != nil {
  74. return hdr, len(msg), msg, err
  75. }
  76. hdr.Class, off, err = unpackUint16(msg, off)
  77. if err != nil {
  78. return hdr, len(msg), msg, err
  79. }
  80. hdr.Ttl, off, err = unpackUint32(msg, off)
  81. if err != nil {
  82. return hdr, len(msg), msg, err
  83. }
  84. hdr.Rdlength, off, err = unpackUint16(msg, off)
  85. if err != nil {
  86. return hdr, len(msg), msg, err
  87. }
  88. msg, err = truncateMsgFromRdlength(msg, off, hdr.Rdlength)
  89. return hdr, off, msg, nil
  90. }
  91. // pack packs an RR header, returning the offset to the end of the header.
  92. // See PackDomainName for documentation about the compression.
  93. func (hdr RR_Header) pack(msg []byte, off int, compression map[string]int, compress bool) (off1 int, err error) {
  94. if off == len(msg) {
  95. return off, nil
  96. }
  97. off, err = PackDomainName(hdr.Name, msg, off, compression, compress)
  98. if err != nil {
  99. return len(msg), err
  100. }
  101. off, err = packUint16(hdr.Rrtype, msg, off)
  102. if err != nil {
  103. return len(msg), err
  104. }
  105. off, err = packUint16(hdr.Class, msg, off)
  106. if err != nil {
  107. return len(msg), err
  108. }
  109. off, err = packUint32(hdr.Ttl, msg, off)
  110. if err != nil {
  111. return len(msg), err
  112. }
  113. off, err = packUint16(hdr.Rdlength, msg, off)
  114. if err != nil {
  115. return len(msg), err
  116. }
  117. return off, nil
  118. }
  119. // helper helper functions.
  120. // truncateMsgFromRdLength truncates msg to match the expected length of the RR.
  121. // Returns an error if msg is smaller than the expected size.
  122. func truncateMsgFromRdlength(msg []byte, off int, rdlength uint16) (truncmsg []byte, err error) {
  123. lenrd := off + int(rdlength)
  124. if lenrd > len(msg) {
  125. return msg, &Error{err: "overflowing header size"}
  126. }
  127. return msg[:lenrd], nil
  128. }
  129. func fromBase32(s []byte) (buf []byte, err error) {
  130. buflen := base32.HexEncoding.DecodedLen(len(s))
  131. buf = make([]byte, buflen)
  132. n, err := base32.HexEncoding.Decode(buf, s)
  133. buf = buf[:n]
  134. return
  135. }
  136. func toBase32(b []byte) string { return base32.HexEncoding.EncodeToString(b) }
  137. func fromBase64(s []byte) (buf []byte, err error) {
  138. buflen := base64.StdEncoding.DecodedLen(len(s))
  139. buf = make([]byte, buflen)
  140. n, err := base64.StdEncoding.Decode(buf, s)
  141. buf = buf[:n]
  142. return
  143. }
  144. func toBase64(b []byte) string { return base64.StdEncoding.EncodeToString(b) }
  145. // dynamicUpdate returns true if the Rdlength is zero.
  146. func noRdata(h RR_Header) bool { return h.Rdlength == 0 }
  147. func unpackUint8(msg []byte, off int) (i uint8, off1 int, err error) {
  148. if off+1 > len(msg) {
  149. return 0, len(msg), &Error{err: "overflow unpacking uint8"}
  150. }
  151. return uint8(msg[off]), off + 1, nil
  152. }
  153. func packUint8(i uint8, msg []byte, off int) (off1 int, err error) {
  154. if off+1 > len(msg) {
  155. return len(msg), &Error{err: "overflow packing uint8"}
  156. }
  157. msg[off] = byte(i)
  158. return off + 1, nil
  159. }
  160. func unpackUint16(msg []byte, off int) (i uint16, off1 int, err error) {
  161. if off+2 > len(msg) {
  162. return 0, len(msg), &Error{err: "overflow unpacking uint16"}
  163. }
  164. return binary.BigEndian.Uint16(msg[off:]), off + 2, nil
  165. }
  166. func packUint16(i uint16, msg []byte, off int) (off1 int, err error) {
  167. if off+2 > len(msg) {
  168. return len(msg), &Error{err: "overflow packing uint16"}
  169. }
  170. binary.BigEndian.PutUint16(msg[off:], i)
  171. return off + 2, nil
  172. }
  173. func unpackUint32(msg []byte, off int) (i uint32, off1 int, err error) {
  174. if off+4 > len(msg) {
  175. return 0, len(msg), &Error{err: "overflow unpacking uint32"}
  176. }
  177. return binary.BigEndian.Uint32(msg[off:]), off + 4, nil
  178. }
  179. func packUint32(i uint32, msg []byte, off int) (off1 int, err error) {
  180. if off+4 > len(msg) {
  181. return len(msg), &Error{err: "overflow packing uint32"}
  182. }
  183. binary.BigEndian.PutUint32(msg[off:], i)
  184. return off + 4, nil
  185. }
  186. func unpackUint48(msg []byte, off int) (i uint64, off1 int, err error) {
  187. if off+6 > len(msg) {
  188. return 0, len(msg), &Error{err: "overflow unpacking uint64 as uint48"}
  189. }
  190. // Used in TSIG where the last 48 bits are occupied, so for now, assume a uint48 (6 bytes)
  191. i = (uint64(uint64(msg[off])<<40 | uint64(msg[off+1])<<32 | uint64(msg[off+2])<<24 | uint64(msg[off+3])<<16 |
  192. uint64(msg[off+4])<<8 | uint64(msg[off+5])))
  193. off += 6
  194. return i, off, nil
  195. }
  196. func packUint48(i uint64, msg []byte, off int) (off1 int, err error) {
  197. if off+6 > len(msg) {
  198. return len(msg), &Error{err: "overflow packing uint64 as uint48"}
  199. }
  200. msg[off] = byte(i >> 40)
  201. msg[off+1] = byte(i >> 32)
  202. msg[off+2] = byte(i >> 24)
  203. msg[off+3] = byte(i >> 16)
  204. msg[off+4] = byte(i >> 8)
  205. msg[off+5] = byte(i)
  206. off += 6
  207. return off, nil
  208. }
  209. func unpackUint64(msg []byte, off int) (i uint64, off1 int, err error) {
  210. if off+8 > len(msg) {
  211. return 0, len(msg), &Error{err: "overflow unpacking uint64"}
  212. }
  213. return binary.BigEndian.Uint64(msg[off:]), off + 8, nil
  214. }
  215. func packUint64(i uint64, msg []byte, off int) (off1 int, err error) {
  216. if off+8 > len(msg) {
  217. return len(msg), &Error{err: "overflow packing uint64"}
  218. }
  219. binary.BigEndian.PutUint64(msg[off:], i)
  220. off += 8
  221. return off, nil
  222. }
  223. func unpackString(msg []byte, off int) (string, int, error) {
  224. if off+1 > len(msg) {
  225. return "", off, &Error{err: "overflow unpacking txt"}
  226. }
  227. l := int(msg[off])
  228. if off+l+1 > len(msg) {
  229. return "", off, &Error{err: "overflow unpacking txt"}
  230. }
  231. s := make([]byte, 0, l)
  232. for _, b := range msg[off+1 : off+1+l] {
  233. switch b {
  234. case '"', '\\':
  235. s = append(s, '\\', b)
  236. case '\t', '\r', '\n':
  237. s = append(s, b)
  238. default:
  239. if b < 32 || b > 127 { // unprintable
  240. var buf [3]byte
  241. bufs := strconv.AppendInt(buf[:0], int64(b), 10)
  242. s = append(s, '\\')
  243. for i := 0; i < 3-len(bufs); i++ {
  244. s = append(s, '0')
  245. }
  246. for _, r := range bufs {
  247. s = append(s, r)
  248. }
  249. } else {
  250. s = append(s, b)
  251. }
  252. }
  253. }
  254. off += 1 + l
  255. return string(s), off, nil
  256. }
  257. func packString(s string, msg []byte, off int) (int, error) {
  258. txtTmp := make([]byte, 256*4+1)
  259. off, err := packTxtString(s, msg, off, txtTmp)
  260. if err != nil {
  261. return len(msg), err
  262. }
  263. return off, nil
  264. }
  265. func unpackStringBase32(msg []byte, off, end int) (string, int, error) {
  266. if end > len(msg) {
  267. return "", len(msg), &Error{err: "overflow unpacking base32"}
  268. }
  269. s := toBase32(msg[off:end])
  270. return s, end, nil
  271. }
  272. func packStringBase32(s string, msg []byte, off int) (int, error) {
  273. b32, err := fromBase32([]byte(s))
  274. if err != nil {
  275. return len(msg), err
  276. }
  277. if off+len(b32) > len(msg) {
  278. return len(msg), &Error{err: "overflow packing base32"}
  279. }
  280. copy(msg[off:off+len(b32)], b32)
  281. off += len(b32)
  282. return off, nil
  283. }
  284. func unpackStringBase64(msg []byte, off, end int) (string, int, error) {
  285. // Rest of the RR is base64 encoded value, so we don't need an explicit length
  286. // to be set. Thus far all RR's that have base64 encoded fields have those as their
  287. // last one. What we do need is the end of the RR!
  288. if end > len(msg) {
  289. return "", len(msg), &Error{err: "overflow unpacking base64"}
  290. }
  291. s := toBase64(msg[off:end])
  292. return s, end, nil
  293. }
  294. func packStringBase64(s string, msg []byte, off int) (int, error) {
  295. b64, err := fromBase64([]byte(s))
  296. if err != nil {
  297. return len(msg), err
  298. }
  299. if off+len(b64) > len(msg) {
  300. return len(msg), &Error{err: "overflow packing base64"}
  301. }
  302. copy(msg[off:off+len(b64)], b64)
  303. off += len(b64)
  304. return off, nil
  305. }
  306. func unpackStringHex(msg []byte, off, end int) (string, int, error) {
  307. // Rest of the RR is hex encoded value, so we don't need an explicit length
  308. // to be set. NSEC and TSIG have hex fields with a length field.
  309. // What we do need is the end of the RR!
  310. if end > len(msg) {
  311. return "", len(msg), &Error{err: "overflow unpacking hex"}
  312. }
  313. s := hex.EncodeToString(msg[off:end])
  314. return s, end, nil
  315. }
  316. func packStringHex(s string, msg []byte, off int) (int, error) {
  317. h, err := hex.DecodeString(s)
  318. if err != nil {
  319. return len(msg), err
  320. }
  321. if off+(len(h)) > len(msg) {
  322. return len(msg), &Error{err: "overflow packing hex"}
  323. }
  324. copy(msg[off:off+len(h)], h)
  325. off += len(h)
  326. return off, nil
  327. }
  328. func unpackStringTxt(msg []byte, off int) ([]string, int, error) {
  329. txt, off, err := unpackTxt(msg, off)
  330. if err != nil {
  331. return nil, len(msg), err
  332. }
  333. return txt, off, nil
  334. }
  335. func packStringTxt(s []string, msg []byte, off int) (int, error) {
  336. txtTmp := make([]byte, 256*4+1) // If the whole string consists out of \DDD we need this many.
  337. off, err := packTxt(s, msg, off, txtTmp)
  338. if err != nil {
  339. return len(msg), err
  340. }
  341. return off, nil
  342. }
  343. func unpackDataOpt(msg []byte, off int) ([]EDNS0, int, error) {
  344. var edns []EDNS0
  345. Option:
  346. code := uint16(0)
  347. if off+4 > len(msg) {
  348. return nil, len(msg), &Error{err: "overflow unpacking opt"}
  349. }
  350. code = binary.BigEndian.Uint16(msg[off:])
  351. off += 2
  352. optlen := binary.BigEndian.Uint16(msg[off:])
  353. off += 2
  354. if off+int(optlen) > len(msg) {
  355. return nil, len(msg), &Error{err: "overflow unpacking opt"}
  356. }
  357. switch code {
  358. case EDNS0NSID:
  359. e := new(EDNS0_NSID)
  360. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  361. return nil, len(msg), err
  362. }
  363. edns = append(edns, e)
  364. off += int(optlen)
  365. case EDNS0SUBNET, EDNS0SUBNETDRAFT:
  366. e := new(EDNS0_SUBNET)
  367. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  368. return nil, len(msg), err
  369. }
  370. edns = append(edns, e)
  371. off += int(optlen)
  372. if code == EDNS0SUBNETDRAFT {
  373. e.DraftOption = true
  374. }
  375. case EDNS0COOKIE:
  376. e := new(EDNS0_COOKIE)
  377. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  378. return nil, len(msg), err
  379. }
  380. edns = append(edns, e)
  381. off += int(optlen)
  382. case EDNS0UL:
  383. e := new(EDNS0_UL)
  384. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  385. return nil, len(msg), err
  386. }
  387. edns = append(edns, e)
  388. off += int(optlen)
  389. case EDNS0LLQ:
  390. e := new(EDNS0_LLQ)
  391. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  392. return nil, len(msg), err
  393. }
  394. edns = append(edns, e)
  395. off += int(optlen)
  396. case EDNS0DAU:
  397. e := new(EDNS0_DAU)
  398. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  399. return nil, len(msg), err
  400. }
  401. edns = append(edns, e)
  402. off += int(optlen)
  403. case EDNS0DHU:
  404. e := new(EDNS0_DHU)
  405. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  406. return nil, len(msg), err
  407. }
  408. edns = append(edns, e)
  409. off += int(optlen)
  410. case EDNS0N3U:
  411. e := new(EDNS0_N3U)
  412. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  413. return nil, len(msg), err
  414. }
  415. edns = append(edns, e)
  416. off += int(optlen)
  417. default:
  418. e := new(EDNS0_LOCAL)
  419. e.Code = code
  420. if err := e.unpack(msg[off : off+int(optlen)]); err != nil {
  421. return nil, len(msg), err
  422. }
  423. edns = append(edns, e)
  424. off += int(optlen)
  425. }
  426. if off < len(msg) {
  427. goto Option
  428. }
  429. return edns, off, nil
  430. }
  431. func packDataOpt(options []EDNS0, msg []byte, off int) (int, error) {
  432. for _, el := range options {
  433. b, err := el.pack()
  434. if err != nil || off+3 > len(msg) {
  435. return len(msg), &Error{err: "overflow packing opt"}
  436. }
  437. binary.BigEndian.PutUint16(msg[off:], el.Option()) // Option code
  438. binary.BigEndian.PutUint16(msg[off+2:], uint16(len(b))) // Length
  439. off += 4
  440. if off+len(b) > len(msg) {
  441. copy(msg[off:], b)
  442. off = len(msg)
  443. continue
  444. }
  445. // Actual data
  446. copy(msg[off:off+len(b)], b)
  447. off += len(b)
  448. }
  449. return off, nil
  450. }
  451. func unpackStringOctet(msg []byte, off int) (string, int, error) {
  452. s := string(msg[off:])
  453. return s, len(msg), nil
  454. }
  455. func packStringOctet(s string, msg []byte, off int) (int, error) {
  456. txtTmp := make([]byte, 256*4+1)
  457. off, err := packOctetString(s, msg, off, txtTmp)
  458. if err != nil {
  459. return len(msg), err
  460. }
  461. return off, nil
  462. }
  463. func unpackDataNsec(msg []byte, off int) ([]uint16, int, error) {
  464. var nsec []uint16
  465. length, window, lastwindow := 0, 0, -1
  466. for off < len(msg) {
  467. if off+2 > len(msg) {
  468. return nsec, len(msg), &Error{err: "overflow unpacking nsecx"}
  469. }
  470. window = int(msg[off])
  471. length = int(msg[off+1])
  472. off += 2
  473. if window <= lastwindow {
  474. // RFC 4034: Blocks are present in the NSEC RR RDATA in
  475. // increasing numerical order.
  476. return nsec, len(msg), &Error{err: "out of order NSEC block"}
  477. }
  478. if length == 0 {
  479. // RFC 4034: Blocks with no types present MUST NOT be included.
  480. return nsec, len(msg), &Error{err: "empty NSEC block"}
  481. }
  482. if length > 32 {
  483. return nsec, len(msg), &Error{err: "NSEC block too long"}
  484. }
  485. if off+length > len(msg) {
  486. return nsec, len(msg), &Error{err: "overflowing NSEC block"}
  487. }
  488. // Walk the bytes in the window and extract the type bits
  489. for j := 0; j < length; j++ {
  490. b := msg[off+j]
  491. // Check the bits one by one, and set the type
  492. if b&0x80 == 0x80 {
  493. nsec = append(nsec, uint16(window*256+j*8+0))
  494. }
  495. if b&0x40 == 0x40 {
  496. nsec = append(nsec, uint16(window*256+j*8+1))
  497. }
  498. if b&0x20 == 0x20 {
  499. nsec = append(nsec, uint16(window*256+j*8+2))
  500. }
  501. if b&0x10 == 0x10 {
  502. nsec = append(nsec, uint16(window*256+j*8+3))
  503. }
  504. if b&0x8 == 0x8 {
  505. nsec = append(nsec, uint16(window*256+j*8+4))
  506. }
  507. if b&0x4 == 0x4 {
  508. nsec = append(nsec, uint16(window*256+j*8+5))
  509. }
  510. if b&0x2 == 0x2 {
  511. nsec = append(nsec, uint16(window*256+j*8+6))
  512. }
  513. if b&0x1 == 0x1 {
  514. nsec = append(nsec, uint16(window*256+j*8+7))
  515. }
  516. }
  517. off += length
  518. lastwindow = window
  519. }
  520. return nsec, off, nil
  521. }
  522. func packDataNsec(bitmap []uint16, msg []byte, off int) (int, error) {
  523. if len(bitmap) == 0 {
  524. return off, nil
  525. }
  526. var lastwindow, lastlength uint16
  527. for j := 0; j < len(bitmap); j++ {
  528. t := bitmap[j]
  529. window := t / 256
  530. length := (t-window*256)/8 + 1
  531. if window > lastwindow && lastlength != 0 { // New window, jump to the new offset
  532. off += int(lastlength) + 2
  533. lastlength = 0
  534. }
  535. if window < lastwindow || length < lastlength {
  536. return len(msg), &Error{err: "nsec bits out of order"}
  537. }
  538. if off+2+int(length) > len(msg) {
  539. return len(msg), &Error{err: "overflow packing nsec"}
  540. }
  541. // Setting the window #
  542. msg[off] = byte(window)
  543. // Setting the octets length
  544. msg[off+1] = byte(length)
  545. // Setting the bit value for the type in the right octet
  546. msg[off+1+int(length)] |= byte(1 << (7 - (t % 8)))
  547. lastwindow, lastlength = window, length
  548. }
  549. off += int(lastlength) + 2
  550. return off, nil
  551. }
  552. func unpackDataDomainNames(msg []byte, off, end int) ([]string, int, error) {
  553. var (
  554. servers []string
  555. s string
  556. err error
  557. )
  558. if end > len(msg) {
  559. return nil, len(msg), &Error{err: "overflow unpacking domain names"}
  560. }
  561. for off < end {
  562. s, off, err = UnpackDomainName(msg, off)
  563. if err != nil {
  564. return servers, len(msg), err
  565. }
  566. servers = append(servers, s)
  567. }
  568. return servers, off, nil
  569. }
  570. func packDataDomainNames(names []string, msg []byte, off int, compression map[string]int, compress bool) (int, error) {
  571. var err error
  572. for j := 0; j < len(names); j++ {
  573. off, err = PackDomainName(names[j], msg, off, compression, false && compress)
  574. if err != nil {
  575. return len(msg), err
  576. }
  577. }
  578. return off, nil
  579. }