cbor.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585
  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) ContainerType() (vt valueType) {
  164. if d.bd == cborBdNil {
  165. return valueTypeNil
  166. } else if d.bd == cborBdIndefiniteBytes || (d.bd >= cborBaseBytes && d.bd < cborBaseString) {
  167. return valueTypeBytes
  168. } else if d.bd == cborBdIndefiniteString || (d.bd >= cborBaseString && d.bd < cborBaseArray) {
  169. return valueTypeString
  170. } else if d.bd == cborBdIndefiniteArray || (d.bd >= cborBaseArray && d.bd < cborBaseMap) {
  171. return valueTypeArray
  172. } else if d.bd == cborBdIndefiniteMap || (d.bd >= cborBaseMap && d.bd < cborBaseTag) {
  173. return valueTypeMap
  174. } else {
  175. // d.d.errorf("isContainerType: unsupported parameter: %v", vt)
  176. }
  177. return valueTypeUnset
  178. }
  179. func (d *cborDecDriver) TryDecodeAsNil() bool {
  180. if !d.bdRead {
  181. d.readNextBd()
  182. }
  183. // treat Nil and Undefined as nil values
  184. if d.bd == cborBdNil || d.bd == cborBdUndefined {
  185. d.bdRead = false
  186. return true
  187. }
  188. return false
  189. }
  190. func (d *cborDecDriver) CheckBreak() bool {
  191. if !d.bdRead {
  192. d.readNextBd()
  193. }
  194. if d.bd == cborBdBreak {
  195. d.bdRead = false
  196. return true
  197. }
  198. return false
  199. }
  200. func (d *cborDecDriver) decUint() (ui uint64) {
  201. v := d.bd & 0x1f
  202. if v <= 0x17 {
  203. ui = uint64(v)
  204. } else {
  205. if v == 0x18 {
  206. ui = uint64(d.r.readn1())
  207. } else if v == 0x19 {
  208. ui = uint64(bigen.Uint16(d.r.readx(2)))
  209. } else if v == 0x1a {
  210. ui = uint64(bigen.Uint32(d.r.readx(4)))
  211. } else if v == 0x1b {
  212. ui = uint64(bigen.Uint64(d.r.readx(8)))
  213. } else {
  214. d.d.errorf("decUint: Invalid descriptor: %v", d.bd)
  215. return
  216. }
  217. }
  218. return
  219. }
  220. func (d *cborDecDriver) decCheckInteger() (neg bool) {
  221. if !d.bdRead {
  222. d.readNextBd()
  223. }
  224. major := d.bd >> 5
  225. if major == cborMajorUint {
  226. } else if major == cborMajorNegInt {
  227. neg = true
  228. } else {
  229. d.d.errorf("invalid major: %v (bd: %v)", major, d.bd)
  230. return
  231. }
  232. return
  233. }
  234. func (d *cborDecDriver) DecodeInt(bitsize uint8) (i int64) {
  235. neg := d.decCheckInteger()
  236. ui := d.decUint()
  237. // check if this number can be converted to an int without overflow
  238. var overflow bool
  239. if neg {
  240. if i, overflow = chkOvf.SignedInt(ui + 1); overflow {
  241. d.d.errorf("cbor: overflow converting %v to signed integer", ui+1)
  242. return
  243. }
  244. i = -i
  245. } else {
  246. if i, overflow = chkOvf.SignedInt(ui); overflow {
  247. d.d.errorf("cbor: overflow converting %v to signed integer", ui)
  248. return
  249. }
  250. }
  251. if chkOvf.Int(i, bitsize) {
  252. d.d.errorf("cbor: overflow integer: %v", i)
  253. return
  254. }
  255. d.bdRead = false
  256. return
  257. }
  258. func (d *cborDecDriver) DecodeUint(bitsize uint8) (ui uint64) {
  259. if d.decCheckInteger() {
  260. d.d.errorf("Assigning negative signed value to unsigned type")
  261. return
  262. }
  263. ui = d.decUint()
  264. if chkOvf.Uint(ui, bitsize) {
  265. d.d.errorf("cbor: overflow integer: %v", ui)
  266. return
  267. }
  268. d.bdRead = false
  269. return
  270. }
  271. func (d *cborDecDriver) DecodeFloat(chkOverflow32 bool) (f float64) {
  272. if !d.bdRead {
  273. d.readNextBd()
  274. }
  275. if bd := d.bd; bd == cborBdFloat16 {
  276. f = float64(math.Float32frombits(halfFloatToFloatBits(bigen.Uint16(d.r.readx(2)))))
  277. } else if bd == cborBdFloat32 {
  278. f = float64(math.Float32frombits(bigen.Uint32(d.r.readx(4))))
  279. } else if bd == cborBdFloat64 {
  280. f = math.Float64frombits(bigen.Uint64(d.r.readx(8)))
  281. } else if bd >= cborBaseUint && bd < cborBaseBytes {
  282. f = float64(d.DecodeInt(64))
  283. } else {
  284. d.d.errorf("Float only valid from float16/32/64: Invalid descriptor: %v", bd)
  285. return
  286. }
  287. if chkOverflow32 && chkOvf.Float32(f) {
  288. d.d.errorf("cbor: float32 overflow: %v", f)
  289. return
  290. }
  291. d.bdRead = false
  292. return
  293. }
  294. // bool can be decoded from bool only (single byte).
  295. func (d *cborDecDriver) DecodeBool() (b bool) {
  296. if !d.bdRead {
  297. d.readNextBd()
  298. }
  299. if bd := d.bd; bd == cborBdTrue {
  300. b = true
  301. } else if bd == cborBdFalse {
  302. } else {
  303. d.d.errorf("Invalid single-byte value for bool: %s: %x", msgBadDesc, d.bd)
  304. return
  305. }
  306. d.bdRead = false
  307. return
  308. }
  309. func (d *cborDecDriver) ReadMapStart() (length int) {
  310. d.bdRead = false
  311. if d.bd == cborBdIndefiniteMap {
  312. return -1
  313. }
  314. return d.decLen()
  315. }
  316. func (d *cborDecDriver) ReadArrayStart() (length int) {
  317. d.bdRead = false
  318. if d.bd == cborBdIndefiniteArray {
  319. return -1
  320. }
  321. return d.decLen()
  322. }
  323. func (d *cborDecDriver) decLen() int {
  324. return int(d.decUint())
  325. }
  326. func (d *cborDecDriver) decAppendIndefiniteBytes(bs []byte) []byte {
  327. d.bdRead = false
  328. for {
  329. if d.CheckBreak() {
  330. break
  331. }
  332. if major := d.bd >> 5; major != cborMajorBytes && major != cborMajorText {
  333. d.d.errorf("cbor: expect bytes or string major type in indefinite string/bytes; got: %v, byte: %v", major, d.bd)
  334. return nil
  335. }
  336. n := d.decLen()
  337. oldLen := len(bs)
  338. newLen := oldLen + n
  339. if newLen > cap(bs) {
  340. bs2 := make([]byte, newLen, 2*cap(bs)+n)
  341. copy(bs2, bs)
  342. bs = bs2
  343. } else {
  344. bs = bs[:newLen]
  345. }
  346. d.r.readb(bs[oldLen:newLen])
  347. // bs = append(bs, d.r.readn()...)
  348. d.bdRead = false
  349. }
  350. d.bdRead = false
  351. return bs
  352. }
  353. func (d *cborDecDriver) DecodeBytes(bs []byte, isstring, zerocopy bool) (bsOut []byte) {
  354. if !d.bdRead {
  355. d.readNextBd()
  356. }
  357. if d.bd == cborBdNil || d.bd == cborBdUndefined {
  358. d.bdRead = false
  359. return nil
  360. }
  361. if d.bd == cborBdIndefiniteBytes || d.bd == cborBdIndefiniteString {
  362. if bs == nil {
  363. return d.decAppendIndefiniteBytes(nil)
  364. }
  365. return d.decAppendIndefiniteBytes(bs[:0])
  366. }
  367. clen := d.decLen()
  368. d.bdRead = false
  369. if zerocopy {
  370. if d.br {
  371. return d.r.readx(clen)
  372. } else if len(bs) == 0 {
  373. bs = d.b[:]
  374. }
  375. }
  376. return decByteSlice(d.r, clen, bs)
  377. }
  378. func (d *cborDecDriver) DecodeString() (s string) {
  379. return string(d.DecodeBytes(d.b[:], true, true))
  380. }
  381. func (d *cborDecDriver) DecodeExt(rv interface{}, xtag uint64, ext Ext) (realxtag uint64) {
  382. if !d.bdRead {
  383. d.readNextBd()
  384. }
  385. u := d.decUint()
  386. d.bdRead = false
  387. realxtag = u
  388. if ext == nil {
  389. re := rv.(*RawExt)
  390. re.Tag = realxtag
  391. d.d.decode(&re.Value)
  392. } else if xtag != realxtag {
  393. d.d.errorf("Wrong extension tag. Got %b. Expecting: %v", realxtag, xtag)
  394. return
  395. } else {
  396. var v interface{}
  397. d.d.decode(&v)
  398. ext.UpdateExt(rv, v)
  399. }
  400. d.bdRead = false
  401. return
  402. }
  403. func (d *cborDecDriver) DecodeNaked() {
  404. if !d.bdRead {
  405. d.readNextBd()
  406. }
  407. n := &d.d.n
  408. var decodeFurther bool
  409. switch d.bd {
  410. case cborBdNil:
  411. n.v = valueTypeNil
  412. case cborBdFalse:
  413. n.v = valueTypeBool
  414. n.b = false
  415. case cborBdTrue:
  416. n.v = valueTypeBool
  417. n.b = true
  418. case cborBdFloat16, cborBdFloat32:
  419. n.v = valueTypeFloat
  420. n.f = d.DecodeFloat(true)
  421. case cborBdFloat64:
  422. n.v = valueTypeFloat
  423. n.f = d.DecodeFloat(false)
  424. case cborBdIndefiniteBytes:
  425. n.v = valueTypeBytes
  426. n.l = d.DecodeBytes(nil, false, false)
  427. case cborBdIndefiniteString:
  428. n.v = valueTypeString
  429. n.s = d.DecodeString()
  430. case cborBdIndefiniteArray:
  431. n.v = valueTypeArray
  432. decodeFurther = true
  433. case cborBdIndefiniteMap:
  434. n.v = valueTypeMap
  435. decodeFurther = true
  436. default:
  437. switch {
  438. case d.bd >= cborBaseUint && d.bd < cborBaseNegInt:
  439. if d.h.SignedInteger {
  440. n.v = valueTypeInt
  441. n.i = d.DecodeInt(64)
  442. } else {
  443. n.v = valueTypeUint
  444. n.u = d.DecodeUint(64)
  445. }
  446. case d.bd >= cborBaseNegInt && d.bd < cborBaseBytes:
  447. n.v = valueTypeInt
  448. n.i = d.DecodeInt(64)
  449. case d.bd >= cborBaseBytes && d.bd < cborBaseString:
  450. n.v = valueTypeBytes
  451. n.l = d.DecodeBytes(nil, false, false)
  452. case d.bd >= cborBaseString && d.bd < cborBaseArray:
  453. n.v = valueTypeString
  454. n.s = d.DecodeString()
  455. case d.bd >= cborBaseArray && d.bd < cborBaseMap:
  456. n.v = valueTypeArray
  457. decodeFurther = true
  458. case d.bd >= cborBaseMap && d.bd < cborBaseTag:
  459. n.v = valueTypeMap
  460. decodeFurther = true
  461. case d.bd >= cborBaseTag && d.bd < cborBaseSimple:
  462. n.v = valueTypeExt
  463. n.u = d.decUint()
  464. n.l = nil
  465. // d.bdRead = false
  466. // d.d.decode(&re.Value) // handled by decode itself.
  467. // decodeFurther = true
  468. default:
  469. d.d.errorf("decodeNaked: Unrecognized d.bd: 0x%x", d.bd)
  470. return
  471. }
  472. }
  473. if !decodeFurther {
  474. d.bdRead = false
  475. }
  476. return
  477. }
  478. // -------------------------
  479. // CborHandle is a Handle for the CBOR encoding format,
  480. // defined at http://tools.ietf.org/html/rfc7049 and documented further at http://cbor.io .
  481. //
  482. // CBOR is comprehensively supported, including support for:
  483. // - indefinite-length arrays/maps/bytes/strings
  484. // - (extension) tags in range 0..0xffff (0 .. 65535)
  485. // - half, single and double-precision floats
  486. // - all numbers (1, 2, 4 and 8-byte signed and unsigned integers)
  487. // - nil, true, false, ...
  488. // - arrays and maps, bytes and text strings
  489. //
  490. // None of the optional extensions (with tags) defined in the spec are supported out-of-the-box.
  491. // Users can implement them as needed (using SetExt), including spec-documented ones:
  492. // - timestamp, BigNum, BigFloat, Decimals, Encoded Text (e.g. URL, regexp, base64, MIME Message), etc.
  493. //
  494. // To encode with indefinite lengths (streaming), users will use
  495. // (Must)Encode methods of *Encoder, along with writing CborStreamXXX constants.
  496. //
  497. // For example, to encode "one-byte" as an indefinite length string:
  498. // var buf bytes.Buffer
  499. // e := NewEncoder(&buf, new(CborHandle))
  500. // buf.WriteByte(CborStreamString)
  501. // e.MustEncode("one-")
  502. // e.MustEncode("byte")
  503. // buf.WriteByte(CborStreamBreak)
  504. // encodedBytes := buf.Bytes()
  505. // var vv interface{}
  506. // NewDecoderBytes(buf.Bytes(), new(CborHandle)).MustDecode(&vv)
  507. // // Now, vv contains the same string "one-byte"
  508. //
  509. type CborHandle struct {
  510. binaryEncodingType
  511. BasicHandle
  512. }
  513. func (h *CborHandle) SetInterfaceExt(rt reflect.Type, tag uint64, ext InterfaceExt) (err error) {
  514. return h.SetExt(rt, tag, &setExtWrapper{i: ext})
  515. }
  516. func (h *CborHandle) newEncDriver(e *Encoder) encDriver {
  517. return &cborEncDriver{e: e, w: e.w, h: h}
  518. }
  519. func (h *CborHandle) newDecDriver(d *Decoder) decDriver {
  520. return &cborDecDriver{d: d, r: d.r, h: h, br: d.bytes}
  521. }
  522. func (e *cborEncDriver) reset() {
  523. e.w = e.e.w
  524. }
  525. func (d *cborDecDriver) reset() {
  526. d.r = d.d.r
  527. d.bd, d.bdRead = 0, false
  528. }
  529. var _ decDriver = (*cborDecDriver)(nil)
  530. var _ encDriver = (*cborEncDriver)(nil)