15 // The default bencode string length limit. This is a poor attempt to prevent excessive memory
16 // allocation when parsing, but also leaves the window open to implement a better solution.
17 const DefaultDecodeMaxStrLen = 1<<27 - 1 // ~128MiB
19 type MaxStrLen = int64
22 // Maximum parsed bencode string length. Defaults to DefaultMaxStrLen if zero.
29 // Sum of bytes used to Decode values.
34 func (d *Decoder) Decode(v interface{}) (err error) {
43 _, ok := r.(runtime.Error)
47 if err, ok = r.(error); !ok {
50 // Errors thrown from deeper in parsing are unexpected. At value boundaries, errors should
51 // be returned directly (at least until all the panic nonsense is removed entirely).
53 err = io.ErrUnexpectedEOF
57 pv := reflect.ValueOf(v)
58 if pv.Kind() != reflect.Ptr || pv.IsNil() {
59 return &UnmarshalInvalidArgError{reflect.TypeOf(v)}
62 ok, err := d.parseValue(pv.Elem())
67 d.throwSyntaxError(d.Offset-1, errors.New("unexpected 'e'"))
72 func checkForUnexpectedEOF(err error, offset int64) {
76 What: io.ErrUnexpectedEOF,
81 func (d *Decoder) readByte() byte {
82 b, err := d.r.ReadByte()
84 checkForUnexpectedEOF(err, d.Offset)
92 // reads data writing it to 'd.buf' until 'sep' byte is encountered, 'sep' byte
93 // is consumed, but not included into the 'd.buf'
94 func (d *Decoder) readUntil(sep byte) {
104 func checkForIntParseError(err error, offset int64) {
113 func (d *Decoder) throwSyntaxError(offset int64, err error) {
120 // Assume the 'i' is already consumed. Read and validate the rest of an int into the buffer.
121 func (d *Decoder) readInt() error {
122 // start := d.Offset - 1
124 if err := d.checkBufferedInt(); err != nil {
127 // if d.buf.Len() == 0 {
128 // panic(&SyntaxError{
130 // What: errors.New("empty integer value"),
136 // called when 'i' was consumed, for the integer type in v.
137 func (d *Decoder) parseInt(v reflect.Value) error {
138 start := d.Offset - 1
140 if err := d.readInt(); err != nil {
143 s := bytesAsString(d.buf.Bytes())
146 case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
147 n, err := strconv.ParseInt(s, 10, 64)
148 checkForIntParseError(err, start)
150 if v.OverflowInt(n) {
151 return &UnmarshalTypeError{
152 BencodeTypeName: "int",
153 UnmarshalTargetType: v.Type(),
157 case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
158 n, err := strconv.ParseUint(s, 10, 64)
159 checkForIntParseError(err, start)
161 if v.OverflowUint(n) {
162 return &UnmarshalTypeError{
163 BencodeTypeName: "int",
164 UnmarshalTargetType: v.Type(),
171 return &UnmarshalTypeError{
172 BencodeTypeName: "int",
173 UnmarshalTargetType: v.Type(),
180 func (d *Decoder) checkBufferedInt() error {
188 if b[0] < '1' || b[0] > '9' {
189 return errors.New("invalid leading digit")
194 func (d *Decoder) parseStringLength() (uint64, error) {
195 // We should have already consumed the first byte of the length into the Decoder buf.
196 start := d.Offset - 1
198 if err := d.checkBufferedInt(); err != nil {
201 // Really the limit should be the uint size for the platform. But we can't pass in an allocator,
202 // or limit total memory use in Go, the best we might hope to do is limit the size of a single
203 // decoded value (by reading it in in-place and then operating on a view).
204 length, err := strconv.ParseUint(bytesAsString(d.buf.Bytes()), 10, 0)
205 checkForIntParseError(err, start)
206 if int64(length) > d.getMaxStrLen() {
207 err = fmt.Errorf("parsed string length %v exceeds limit (%v)", length, DefaultDecodeMaxStrLen)
213 func (d *Decoder) parseString(v reflect.Value) error {
214 length, err := d.parseStringLength()
219 read := func(b []byte) {
220 n, err := io.ReadFull(d.r, b)
223 checkForUnexpectedEOF(err, d.Offset)
226 What: errors.New("unexpected I/O error: " + err.Error()),
233 b := make([]byte, length)
235 v.SetString(bytesAsString(b))
238 if v.Type().Elem().Kind() != reflect.Uint8 {
241 b := make([]byte, length)
246 if v.Type().Elem().Kind() != reflect.Uint8 {
249 d.buf.Grow(int(length))
250 b := d.buf.Bytes()[:length]
252 reflect.Copy(v, reflect.ValueOf(b))
255 d.buf.Grow(int(length))
256 read(d.buf.Bytes()[:length])
257 // I believe we return here to support "ignore_unmarshal_type_error".
258 return &UnmarshalTypeError{
259 BencodeTypeName: "string",
260 UnmarshalTargetType: v.Type(),
264 // Info for parsing a dict value.
265 type dictField struct {
267 Get func(value reflect.Value) func(reflect.Value)
271 // Returns specifics for parsing a dict field value.
272 func getDictField(dict reflect.Type, key string) (_ dictField, err error) {
273 // get valuev as a map value or as a struct field
274 switch k := dict.Kind(); k {
278 Get: func(mapValue reflect.Value) func(reflect.Value) {
279 return func(value reflect.Value) {
280 if mapValue.IsNil() {
281 mapValue.Set(reflect.MakeMap(dict))
283 // Assigns the value into the map.
284 // log.Printf("map type: %v", mapValue.Type())
285 mapValue.SetMapIndex(reflect.ValueOf(key).Convert(dict.Key()), value)
290 return getStructFieldForKey(dict, key), nil
291 // if sf.r.PkgPath != "" {
292 // panic(&UnmarshalFieldError{
294 // Type: dict.Type(),
299 err = fmt.Errorf("can't assign bencode dict items into a %v", k)
305 structFieldsMu sync.Mutex
306 structFields = map[reflect.Type]map[string]dictField{}
309 func parseStructFields(struct_ reflect.Type, each func(key string, df dictField)) {
310 for _i, n := 0, struct_.NumField(); _i < n; _i++ {
312 f := struct_.Field(i)
315 if t.Kind() == reflect.Ptr {
318 parseStructFields(t, func(key string, df dictField) {
320 df.Get = func(value reflect.Value) func(reflect.Value) {
321 anonPtr := value.Field(i)
322 if anonPtr.Kind() == reflect.Ptr && anonPtr.IsNil() {
323 anonPtr.Set(reflect.New(f.Type.Elem()))
324 anonPtr = anonPtr.Elem()
326 return innerGet(anonPtr)
332 tagStr := f.Tag.Get("bencode")
336 tag := parseTag(tagStr)
341 each(key, dictField{f.Type, func(value reflect.Value) func(reflect.Value) {
342 return value.Field(i).Set
347 func saveStructFields(struct_ reflect.Type) {
348 m := make(map[string]dictField)
349 parseStructFields(struct_, func(key string, sf dictField) {
352 structFields[struct_] = m
355 func getStructFieldForKey(struct_ reflect.Type, key string) (f dictField) {
356 structFieldsMu.Lock()
357 if _, ok := structFields[struct_]; !ok {
358 saveStructFields(struct_)
360 f, ok := structFields[struct_][key]
361 structFieldsMu.Unlock()
363 var discard interface{}
365 Type: reflect.TypeOf(discard),
366 Get: func(reflect.Value) func(reflect.Value) { return func(reflect.Value) {} },
373 func (d *Decoder) parseDict(v reflect.Value) error {
374 // At this point 'd' byte was consumed, now read key/value pairs
377 keyValue := reflect.ValueOf(&keyStr).Elem()
378 ok, err := d.parseValue(keyValue)
380 return fmt.Errorf("error parsing dict key: %w", err)
386 df, err := getDictField(v.Type(), keyStr)
388 return fmt.Errorf("parsing bencode dict into %v: %w", v.Type(), err)
391 // now we need to actually parse it
393 // Discard the value, there's nowhere to put it.
395 if_, ok = d.parseValueInterface()
397 return fmt.Errorf("error parsing value for key %q", keyStr)
400 return fmt.Errorf("missing value for key %q", keyStr)
404 setValue := reflect.New(df.Type).Elem()
405 // log.Printf("parsing into %v", setValue.Type())
406 ok, err = d.parseValue(setValue)
408 var target *UnmarshalTypeError
409 if !(errors.As(err, &target) && df.Tags.IgnoreUnmarshalTypeError()) {
410 return fmt.Errorf("parsing value for key %q: %w", keyStr, err)
414 return fmt.Errorf("missing value for key %q", keyStr)
420 func (d *Decoder) parseList(v reflect.Value) error {
423 // If the list is a singleton of the expected type, use that value. See
424 // https://github.com/anacrolix/torrent/issues/297.
425 l := reflect.New(reflect.SliceOf(v.Type()))
426 if err := d.parseList(l.Elem()); err != nil {
429 if l.Elem().Len() != 1 {
430 return &UnmarshalTypeError{
431 BencodeTypeName: "list",
432 UnmarshalTargetType: v.Type(),
435 v.Set(l.Elem().Index(0))
437 case reflect.Array, reflect.Slice:
438 // We can work with this. Normal case, fallthrough.
443 if v.Kind() == reflect.Slice && i >= v.Len() {
444 v.Set(reflect.Append(v, reflect.Zero(v.Type().Elem())))
448 ok, err := d.parseValue(v.Index(i))
456 _, ok := d.parseValueInterface()
464 if v.Kind() == reflect.Array {
465 z := reflect.Zero(v.Type().Elem())
466 for n := v.Len(); i < n; i++ {
474 if i == 0 && v.Kind() == reflect.Slice {
475 v.Set(reflect.MakeSlice(v.Type(), 0, 0))
480 func (d *Decoder) readOneValue() bool {
481 b, err := d.r.ReadByte()
495 // read until there is nothing to read
496 for d.readOneValue() {
498 // consume 'e' as well
503 d.buf.WriteString("e")
505 if b >= '0' && b <= '9' {
506 start := d.buf.Len() - 1
508 length, err := strconv.ParseInt(bytesAsString(d.buf.Bytes()[start:]), 10, 64)
509 checkForIntParseError(err, d.Offset-1)
511 d.buf.WriteString(":")
512 n, err := io.CopyN(&d.buf, d.r, length)
515 checkForUnexpectedEOF(err, d.Offset)
518 What: errors.New("unexpected I/O error: " + err.Error()),
524 d.raiseUnknownValueType(b, d.Offset-1)
530 func (d *Decoder) parseUnmarshaler(v reflect.Value) bool {
531 if !v.Type().Implements(unmarshalerType) {
532 if v.Addr().Type().Implements(unmarshalerType) {
539 if !d.readOneValue() {
542 m := v.Interface().(Unmarshaler)
543 err := m.UnmarshalBencode(d.buf.Bytes())
545 panic(&UnmarshalerError{v.Type(), err})
550 // Returns true if there was a value and it's now stored in 'v', otherwise
551 // there was an end symbol ("e") and no value was stored.
552 func (d *Decoder) parseValue(v reflect.Value) (bool, error) {
553 // we support one level of indirection at the moment
554 if v.Kind() == reflect.Ptr {
555 // if the pointer is nil, allocate a new element of the type it
558 v.Set(reflect.New(v.Type().Elem()))
563 if d.parseUnmarshaler(v) {
567 // common case: interface{}
568 if v.Kind() == reflect.Interface && v.NumMethod() == 0 {
569 iface, _ := d.parseValueInterface()
570 v.Set(reflect.ValueOf(iface))
574 b, err := d.r.ReadByte()
584 return true, d.parseDict(v)
586 return true, d.parseList(v)
588 return true, d.parseInt(v)
590 if b >= '0' && b <= '9' {
593 // Write the first digit of the length to the buffer.
595 return true, d.parseString(v)
598 d.raiseUnknownValueType(b, d.Offset-1)
603 // An unknown bencode type character was encountered.
604 func (d *Decoder) raiseUnknownValueType(b byte, offset int64) {
607 What: fmt.Errorf("unknown value type %+q", b),
611 func (d *Decoder) parseValueInterface() (interface{}, bool) {
612 b, err := d.r.ReadByte()
622 return d.parseDictInterface(), true
624 return d.parseListInterface(), true
626 return d.parseIntInterface(), true
628 if b >= '0' && b <= '9' {
630 // append first digit of the length to the buffer
632 return d.parseStringInterface(), true
635 d.raiseUnknownValueType(b, d.Offset-1)
640 // Called after 'i', for an arbitrary integer size.
641 func (d *Decoder) parseIntInterface() (ret interface{}) {
642 start := d.Offset - 1
644 if err := d.readInt(); err != nil {
647 n, err := strconv.ParseInt(d.buf.String(), 10, 64)
648 if ne, ok := err.(*strconv.NumError); ok && ne.Err == strconv.ErrRange {
650 _, ok := i.SetString(d.buf.String(), 10)
654 What: errors.New("failed to parse integer"),
659 checkForIntParseError(err, start)
667 func (d *Decoder) readBytes(length int) []byte {
668 b, err := io.ReadAll(io.LimitReader(d.r, int64(length)))
672 if len(b) != length {
673 panic(fmt.Errorf("read %v bytes expected %v", len(b), length))
678 func (d *Decoder) parseStringInterface() string {
679 length, err := d.parseStringLength()
683 b := d.readBytes(int(length))
684 d.Offset += int64(len(b))
686 panic(&SyntaxError{Offset: d.Offset, What: err})
688 return bytesAsString(b)
691 func (d *Decoder) parseDictInterface() interface{} {
692 dict := make(map[string]interface{})
696 keyi, ok := d.parseValueInterface()
701 key, ok := keyi.(string)
705 What: errors.New("non-string key in a dict"),
709 d.throwSyntaxError(start, fmt.Errorf("dict keys unsorted: %q <= %q", key, lastKey))
712 valuei, ok := d.parseValueInterface()
714 d.throwSyntaxError(start, fmt.Errorf("dict elem missing value [key=%v]", key))
723 func (d *Decoder) parseListInterface() (list []interface{}) {
724 list = []interface{}{}
725 valuei, ok := d.parseValueInterface()
727 list = append(list, valuei)
728 valuei, ok = d.parseValueInterface()
733 func (d *Decoder) getMaxStrLen() int64 {
734 if d.MaxStrLen == 0 {
735 return DefaultDecodeMaxStrLen