cbor.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592
  1. // Copyright (c) 2012-2015 Ugorji Nwoke. All rights reserved.
  2. // Use of this source code is governed by a MIT license found in the LICENSE file.
  3. package codec
  4. import (
  5. "math"
  6. "reflect"
  7. )
  8. const (
  9. cborMajorUint byte = iota
  10. cborMajorNegInt
  11. cborMajorBytes
  12. cborMajorText
  13. cborMajorArray
  14. cborMajorMap
  15. cborMajorTag
  16. cborMajorOther
  17. )
  18. const (
  19. cborBdFalse byte = 0xf4 + iota
  20. cborBdTrue
  21. cborBdNil
  22. cborBdUndefined
  23. cborBdExt
  24. cborBdFloat16
  25. cborBdFloat32
  26. cborBdFloat64
  27. )
  28. const (
  29. cborBdIndefiniteBytes byte = 0x5f
  30. cborBdIndefiniteString = 0x7f
  31. cborBdIndefiniteArray = 0x9f
  32. cborBdIndefiniteMap = 0xbf
  33. cborBdBreak = 0xff
  34. )
  35. const (
  36. CborStreamBytes byte = 0x5f
  37. CborStreamString = 0x7f
  38. CborStreamArray = 0x9f
  39. CborStreamMap = 0xbf
  40. CborStreamBreak = 0xff
  41. )
  42. const (
  43. cborBaseUint byte = 0x00
  44. cborBaseNegInt = 0x20
  45. cborBaseBytes = 0x40
  46. cborBaseString = 0x60
  47. cborBaseArray = 0x80
  48. cborBaseMap = 0xa0
  49. cborBaseTag = 0xc0
  50. cborBaseSimple = 0xe0
  51. )
  52. // -------------------
  53. type cborEncDriver struct {
  54. noBuiltInTypes
  55. encNoSeparator
  56. e *Encoder
  57. w encWriter
  58. h *CborHandle
  59. x [8]byte
  60. }
  61. func (e *cborEncDriver) EncodeNil() {
  62. e.w.writen1(cborBdNil)
  63. }
  64. func (e *cborEncDriver) EncodeBool(b bool) {
  65. if b {
  66. e.w.writen1(cborBdTrue)
  67. } else {
  68. e.w.writen1(cborBdFalse)
  69. }
  70. }
  71. func (e *cborEncDriver) EncodeFloat32(f float32) {
  72. e.w.writen1(cborBdFloat32)
  73. bigenHelper{e.x[:4], e.w}.writeUint32(math.Float32bits(f))
  74. }
  75. func (e *cborEncDriver) EncodeFloat64(f float64) {
  76. e.w.writen1(cborBdFloat64)
  77. bigenHelper{e.x[:8], e.w}.writeUint64(math.Float64bits(f))
  78. }
  79. func (e *cborEncDriver) encUint(v uint64, bd byte) {
  80. if v <= 0x17 {
  81. e.w.writen1(byte(v) + bd)
  82. } else if v <= math.MaxUint8 {
  83. e.w.writen2(bd+0x18, uint8(v))
  84. } else if v <= math.MaxUint16 {
  85. e.w.writen1(bd + 0x19)
  86. bigenHelper{e.x[:2], e.w}.writeUint16(uint16(v))
  87. } else if v <= math.MaxUint32 {
  88. e.w.writen1(bd + 0x1a)
  89. bigenHelper{e.x[:4], e.w}.writeUint32(uint32(v))
  90. } else { // if v <= math.MaxUint64 {
  91. e.w.writen1(bd + 0x1b)
  92. bigenHelper{e.x[:8], e.w}.writeUint64(v)
  93. }
  94. }
  95. func (e *cborEncDriver) EncodeInt(v int64) {
  96. if v < 0 {
  97. e.encUint(uint64(-1-v), cborBaseNegInt)
  98. } else {
  99. e.encUint(uint64(v), cborBaseUint)
  100. }
  101. }
  102. func (e *cborEncDriver) EncodeUint(v uint64) {
  103. e.encUint(v, cborBaseUint)
  104. }
  105. func (e *cborEncDriver) encLen(bd byte, length int) {
  106. e.encUint(uint64(length), bd)
  107. }
  108. func (e *cborEncDriver) EncodeExt(rv interface{}, xtag uint64, ext Ext, en *Encoder) {
  109. e.encUint(uint64(xtag), cborBaseTag)
  110. if v := ext.ConvertExt(rv); v == nil {
  111. e.EncodeNil()
  112. } else {
  113. en.encode(v)
  114. }
  115. }
  116. func (e *cborEncDriver) EncodeRawExt(re *RawExt, en *Encoder) {
  117. e.encUint(uint64(re.Tag), cborBaseTag)
  118. if re.Data != nil {
  119. en.encode(re.Data)
  120. } else if re.Value == nil {
  121. e.EncodeNil()
  122. } else {
  123. en.encode(re.Value)
  124. }
  125. }
  126. func (e *cborEncDriver) EncodeArrayStart(length int) {
  127. e.encLen(cborBaseArray, length)
  128. }
  129. func (e *cborEncDriver) EncodeMapStart(length int) {
  130. e.encLen(cborBaseMap, length)
  131. }
  132. func (e *cborEncDriver) EncodeString(c charEncoding, v string) {
  133. e.encLen(cborBaseString, len(v))
  134. e.w.writestr(v)
  135. }
  136. func (e *cborEncDriver) EncodeSymbol(v string) {
  137. e.EncodeString(c_UTF8, v)
  138. }
  139. func (e *cborEncDriver) EncodeStringBytes(c charEncoding, v []byte) {
  140. if c == c_RAW {
  141. e.encLen(cborBaseBytes, len(v))
  142. } else {
  143. e.encLen(cborBaseString, len(v))
  144. }
  145. e.w.writeb(v)
  146. }
  147. // ----------------------
  148. type cborDecDriver struct {
  149. d *Decoder
  150. h *CborHandle
  151. r decReader
  152. b [scratchByteArrayLen]byte
  153. br bool // bytes reader
  154. bdRead bool
  155. bd byte
  156. noBuiltInTypes
  157. decNoSeparator
  158. }
  159. func (d *cborDecDriver) readNextBd() {
  160. d.bd = d.r.readn1()
  161. d.bdRead = true
  162. }
  163. func (d *cborDecDriver) uncacheRead() {
  164. if d.bdRead {
  165. d.r.unreadn1()
  166. d.bdRead = false
  167. }
  168. }
  169. func (d *cborDecDriver) ContainerType() (vt valueType) {
  170. if d.bd == cborBdNil {
  171. return valueTypeNil
  172. } else if d.bd == cborBdIndefiniteBytes || (d.bd >= cborBaseBytes && d.bd < cborBaseString) {
  173. return valueTypeBytes
  174. } else if d.bd == cborBdIndefiniteString || (d.bd >= cborBaseString && d.bd < cborBaseArray) {
  175. return valueTypeString
  176. } else if d.bd == cborBdIndefiniteArray || (d.bd >= cborBaseArray && d.bd < cborBaseMap) {
  177. return valueTypeArray
  178. } else if d.bd == cborBdIndefiniteMap || (d.bd >= cborBaseMap && d.bd < cborBaseTag) {
  179. return valueTypeMap
  180. } else {
  181. // d.d.errorf("isContainerType: unsupported parameter: %v", vt)
  182. }
  183. return valueTypeUnset
  184. }
  185. func (d *cborDecDriver) TryDecodeAsNil() bool {
  186. if !d.bdRead {
  187. d.readNextBd()
  188. }
  189. // treat Nil and Undefined as nil values
  190. if d.bd == cborBdNil || d.bd == cborBdUndefined {
  191. d.bdRead = false
  192. return true
  193. }
  194. return false
  195. }
  196. func (d *cborDecDriver) CheckBreak() bool {
  197. if !d.bdRead {
  198. d.readNextBd()
  199. }
  200. if d.bd == cborBdBreak {
  201. d.bdRead = false
  202. return true
  203. }
  204. return false
  205. }
  206. func (d *cborDecDriver) decUint() (ui uint64) {
  207. v := d.bd & 0x1f
  208. if v <= 0x17 {
  209. ui = uint64(v)
  210. } else {
  211. if v == 0x18 {
  212. ui = uint64(d.r.readn1())
  213. } else if v == 0x19 {
  214. ui = uint64(bigen.Uint16(d.r.readx(2)))
  215. } else if v == 0x1a {
  216. ui = uint64(bigen.Uint32(d.r.readx(4)))
  217. } else if v == 0x1b {
  218. ui = uint64(bigen.Uint64(d.r.readx(8)))
  219. } else {
  220. d.d.errorf("decUint: Invalid descriptor: %v", d.bd)
  221. return
  222. }
  223. }
  224. return
  225. }
  226. func (d *cborDecDriver) decCheckInteger() (neg bool) {
  227. if !d.bdRead {
  228. d.readNextBd()
  229. }
  230. major := d.bd >> 5
  231. if major == cborMajorUint {
  232. } else if major == cborMajorNegInt {
  233. neg = true
  234. } else {
  235. d.d.errorf("invalid major: %v (bd: %v)", major, d.bd)
  236. return
  237. }
  238. return
  239. }
  240. func (d *cborDecDriver) DecodeInt(bitsize uint8) (i int64) {
  241. neg := d.decCheckInteger()
  242. ui := d.decUint()
  243. // check if this number can be converted to an int without overflow
  244. var overflow bool
  245. if neg {
  246. if i, overflow = chkOvf.SignedInt(ui + 1); overflow {
  247. d.d.errorf("cbor: overflow converting %v to signed integer", ui+1)
  248. return
  249. }
  250. i = -i
  251. } else {
  252. if i, overflow = chkOvf.SignedInt(ui); overflow {
  253. d.d.errorf("cbor: overflow converting %v to signed integer", ui)
  254. return
  255. }
  256. }
  257. if chkOvf.Int(i, bitsize) {
  258. d.d.errorf("cbor: overflow integer: %v", i)
  259. return
  260. }
  261. d.bdRead = false
  262. return
  263. }
  264. func (d *cborDecDriver) DecodeUint(bitsize uint8) (ui uint64) {
  265. if d.decCheckInteger() {
  266. d.d.errorf("Assigning negative signed value to unsigned type")
  267. return
  268. }
  269. ui = d.decUint()
  270. if chkOvf.Uint(ui, bitsize) {
  271. d.d.errorf("cbor: overflow integer: %v", ui)
  272. return
  273. }
  274. d.bdRead = false
  275. return
  276. }
  277. func (d *cborDecDriver) DecodeFloat(chkOverflow32 bool) (f float64) {
  278. if !d.bdRead {
  279. d.readNextBd()
  280. }
  281. if bd := d.bd; bd == cborBdFloat16 {
  282. f = float64(math.Float32frombits(halfFloatToFloatBits(bigen.Uint16(d.r.readx(2)))))
  283. } else if bd == cborBdFloat32 {
  284. f = float64(math.Float32frombits(bigen.Uint32(d.r.readx(4))))
  285. } else if bd == cborBdFloat64 {
  286. f = math.Float64frombits(bigen.Uint64(d.r.readx(8)))
  287. } else if bd >= cborBaseUint && bd < cborBaseBytes {
  288. f = float64(d.DecodeInt(64))
  289. } else {
  290. d.d.errorf("Float only valid from float16/32/64: Invalid descriptor: %v", bd)
  291. return
  292. }
  293. if chkOverflow32 && chkOvf.Float32(f) {
  294. d.d.errorf("cbor: float32 overflow: %v", f)
  295. return
  296. }
  297. d.bdRead = false
  298. return
  299. }
  300. // bool can be decoded from bool only (single byte).
  301. func (d *cborDecDriver) DecodeBool() (b bool) {
  302. if !d.bdRead {
  303. d.readNextBd()
  304. }
  305. if bd := d.bd; bd == cborBdTrue {
  306. b = true
  307. } else if bd == cborBdFalse {
  308. } else {
  309. d.d.errorf("Invalid single-byte value for bool: %s: %x", msgBadDesc, d.bd)
  310. return
  311. }
  312. d.bdRead = false
  313. return
  314. }
  315. func (d *cborDecDriver) ReadMapStart() (length int) {
  316. d.bdRead = false
  317. if d.bd == cborBdIndefiniteMap {
  318. return -1
  319. }
  320. return d.decLen()
  321. }
  322. func (d *cborDecDriver) ReadArrayStart() (length int) {
  323. d.bdRead = false
  324. if d.bd == cborBdIndefiniteArray {
  325. return -1
  326. }
  327. return d.decLen()
  328. }
  329. func (d *cborDecDriver) decLen() int {
  330. return int(d.decUint())
  331. }
  332. func (d *cborDecDriver) decAppendIndefiniteBytes(bs []byte) []byte {
  333. d.bdRead = false
  334. for {
  335. if d.CheckBreak() {
  336. break
  337. }
  338. if major := d.bd >> 5; major != cborMajorBytes && major != cborMajorText {
  339. d.d.errorf("cbor: expect bytes or string major type in indefinite string/bytes; got: %v, byte: %v", major, d.bd)
  340. return nil
  341. }
  342. n := d.decLen()
  343. oldLen := len(bs)
  344. newLen := oldLen + n
  345. if newLen > cap(bs) {
  346. bs2 := make([]byte, newLen, 2*cap(bs)+n)
  347. copy(bs2, bs)
  348. bs = bs2
  349. } else {
  350. bs = bs[:newLen]
  351. }
  352. d.r.readb(bs[oldLen:newLen])
  353. // bs = append(bs, d.r.readn()...)
  354. d.bdRead = false
  355. }
  356. d.bdRead = false
  357. return bs
  358. }
  359. func (d *cborDecDriver) DecodeBytes(bs []byte, isstring, zerocopy bool) (bsOut []byte) {
  360. if !d.bdRead {
  361. d.readNextBd()
  362. }
  363. if d.bd == cborBdNil || d.bd == cborBdUndefined {
  364. d.bdRead = false
  365. return nil
  366. }
  367. if d.bd == cborBdIndefiniteBytes || d.bd == cborBdIndefiniteString {
  368. if bs == nil {
  369. return d.decAppendIndefiniteBytes(nil)
  370. }
  371. return d.decAppendIndefiniteBytes(bs[:0])
  372. }
  373. clen := d.decLen()
  374. d.bdRead = false
  375. if zerocopy {
  376. if d.br {
  377. return d.r.readx(clen)
  378. } else if len(bs) == 0 {
  379. bs = d.b[:]
  380. }
  381. }
  382. return decByteSlice(d.r, clen, bs)
  383. }
  384. func (d *cborDecDriver) DecodeString() (s string) {
  385. return string(d.DecodeBytes(d.b[:], true, true))
  386. }
  387. func (d *cborDecDriver) DecodeExt(rv interface{}, xtag uint64, ext Ext) (realxtag uint64) {
  388. if !d.bdRead {
  389. d.readNextBd()
  390. }
  391. u := d.decUint()
  392. d.bdRead = false
  393. realxtag = u
  394. if ext == nil {
  395. re := rv.(*RawExt)
  396. re.Tag = realxtag
  397. d.d.decode(&re.Value)
  398. } else if xtag != realxtag {
  399. d.d.errorf("Wrong extension tag. Got %b. Expecting: %v", realxtag, xtag)
  400. return
  401. } else {
  402. var v interface{}
  403. d.d.decode(&v)
  404. ext.UpdateExt(rv, v)
  405. }
  406. d.bdRead = false
  407. return
  408. }
  409. func (d *cborDecDriver) DecodeNaked() {
  410. if !d.bdRead {
  411. d.readNextBd()
  412. }
  413. n := &d.d.n
  414. var decodeFurther bool
  415. switch d.bd {
  416. case cborBdNil:
  417. n.v = valueTypeNil
  418. case cborBdFalse:
  419. n.v = valueTypeBool
  420. n.b = false
  421. case cborBdTrue:
  422. n.v = valueTypeBool
  423. n.b = true
  424. case cborBdFloat16, cborBdFloat32:
  425. n.v = valueTypeFloat
  426. n.f = d.DecodeFloat(true)
  427. case cborBdFloat64:
  428. n.v = valueTypeFloat
  429. n.f = d.DecodeFloat(false)
  430. case cborBdIndefiniteBytes:
  431. n.v = valueTypeBytes
  432. n.l = d.DecodeBytes(nil, false, false)
  433. case cborBdIndefiniteString:
  434. n.v = valueTypeString
  435. n.s = d.DecodeString()
  436. case cborBdIndefiniteArray:
  437. n.v = valueTypeArray
  438. decodeFurther = true
  439. case cborBdIndefiniteMap:
  440. n.v = valueTypeMap
  441. decodeFurther = true
  442. default:
  443. switch {
  444. case d.bd >= cborBaseUint && d.bd < cborBaseNegInt:
  445. if d.h.SignedInteger {
  446. n.v = valueTypeInt
  447. n.i = d.DecodeInt(64)
  448. } else {
  449. n.v = valueTypeUint
  450. n.u = d.DecodeUint(64)
  451. }
  452. case d.bd >= cborBaseNegInt && d.bd < cborBaseBytes:
  453. n.v = valueTypeInt
  454. n.i = d.DecodeInt(64)
  455. case d.bd >= cborBaseBytes && d.bd < cborBaseString:
  456. n.v = valueTypeBytes
  457. n.l = d.DecodeBytes(nil, false, false)
  458. case d.bd >= cborBaseString && d.bd < cborBaseArray:
  459. n.v = valueTypeString
  460. n.s = d.DecodeString()
  461. case d.bd >= cborBaseArray && d.bd < cborBaseMap:
  462. n.v = valueTypeArray
  463. decodeFurther = true
  464. case d.bd >= cborBaseMap && d.bd < cborBaseTag:
  465. n.v = valueTypeMap
  466. decodeFurther = true
  467. case d.bd >= cborBaseTag && d.bd < cborBaseSimple:
  468. n.v = valueTypeExt
  469. n.u = d.decUint()
  470. n.l = nil
  471. // d.bdRead = false
  472. // d.d.decode(&re.Value) // handled by decode itself.
  473. // decodeFurther = true
  474. default:
  475. d.d.errorf("decodeNaked: Unrecognized d.bd: 0x%x", d.bd)
  476. return
  477. }
  478. }
  479. if !decodeFurther {
  480. d.bdRead = false
  481. }
  482. return
  483. }
  484. // -------------------------
  485. // CborHandle is a Handle for the CBOR encoding format,
  486. // defined at http://tools.ietf.org/html/rfc7049 and documented further at http://cbor.io .
  487. //
  488. // CBOR is comprehensively supported, including support for:
  489. // - indefinite-length arrays/maps/bytes/strings
  490. // - (extension) tags in range 0..0xffff (0 .. 65535)
  491. // - half, single and double-precision floats
  492. // - all numbers (1, 2, 4 and 8-byte signed and unsigned integers)
  493. // - nil, true, false, ...
  494. // - arrays and maps, bytes and text strings
  495. //
  496. // None of the optional extensions (with tags) defined in the spec are supported out-of-the-box.
  497. // Users can implement them as needed (using SetExt), including spec-documented ones:
  498. // - timestamp, BigNum, BigFloat, Decimals, Encoded Text (e.g. URL, regexp, base64, MIME Message), etc.
  499. //
  500. // To encode with indefinite lengths (streaming), users will use
  501. // (Must)Encode methods of *Encoder, along with writing CborStreamXXX constants.
  502. //
  503. // For example, to encode "one-byte" as an indefinite length string:
  504. // var buf bytes.Buffer
  505. // e := NewEncoder(&buf, new(CborHandle))
  506. // buf.WriteByte(CborStreamString)
  507. // e.MustEncode("one-")
  508. // e.MustEncode("byte")
  509. // buf.WriteByte(CborStreamBreak)
  510. // encodedBytes := buf.Bytes()
  511. // var vv interface{}
  512. // NewDecoderBytes(buf.Bytes(), new(CborHandle)).MustDecode(&vv)
  513. // // Now, vv contains the same string "one-byte"
  514. //
  515. type CborHandle struct {
  516. binaryEncodingType
  517. BasicHandle
  518. }
  519. func (h *CborHandle) SetInterfaceExt(rt reflect.Type, tag uint64, ext InterfaceExt) (err error) {
  520. return h.SetExt(rt, tag, &setExtWrapper{i: ext})
  521. }
  522. func (h *CborHandle) newEncDriver(e *Encoder) encDriver {
  523. return &cborEncDriver{e: e, w: e.w, h: h}
  524. }
  525. func (h *CborHandle) newDecDriver(d *Decoder) decDriver {
  526. return &cborDecDriver{d: d, r: d.r, h: h, br: d.bytes}
  527. }
  528. func (e *cborEncDriver) reset() {
  529. e.w = e.e.w
  530. }
  531. func (d *cborDecDriver) reset() {
  532. d.r = d.d.r
  533. d.bd, d.bdRead = 0, false
  534. }
  535. var _ decDriver = (*cborDecDriver)(nil)
  536. var _ encDriver = (*cborEncDriver)(nil)