cbor.go 14 KB

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