aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/golang.org/x/crypto/openpgp/packet/reader.go
blob: 34bc7c613e6e236b24b7bf97f246fceef37c8b29 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Copyright 2011 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package packet

import (
    "golang.org/x/crypto/openpgp/errors"
    "io"
)

// Reader reads packets from an io.Reader and allows packets to be 'unread' so
// that they result from the next call to Next.
type Reader struct {
    q       []Packet
    readers []io.Reader
}

// New io.Readers are pushed when a compressed or encrypted packet is processed
// and recursively treated as a new source of packets. However, a carefully
// crafted packet can trigger an infinite recursive sequence of packets. See
// http://mumble.net/~campbell/misc/pgp-quine
// https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2013-4402
// This constant limits the number of recursive packets that may be pushed.
const maxReaders = 32

// Next returns the most recently unread Packet, or reads another packet from
// the top-most io.Reader. Unknown packet types are skipped.
func (r *Reader) Next() (p Packet, err error) {
    if len(r.q) > 0 {
        p = r.q[len(r.q)-1]
        r.q = r.q[:len(r.q)-1]
        return
    }

    for len(r.readers) > 0 {
        p, err = Read(r.readers[len(r.readers)-1])
        if err == nil {
            return
        }
        if err == io.EOF {
            r.readers = r.readers[:len(r.readers)-1]
            continue
        }
        if _, ok := err.(errors.UnknownPacketTypeError); !ok {
            return nil, err
        }
    }

    return nil, io.EOF
}

// Push causes the Reader to start reading from a new io.Reader. When an EOF
// error is seen from the new io.Reader, it is popped and the Reader continues
// to read from the next most recent io.Reader. Push returns a StructuralError
// if pushing the reader would exceed the maximum recursion level, otherwise it
// returns nil.
func (r *Reader) Push(reader io.Reader) (err error) {
    if len(r.readers) >= maxReaders {
        return errors.StructuralError("too many layers of packets")
    }
    r.readers = append(r.readers, reader)
    return nil
}

// Unread causes the given Packet to be returned from the next call to Next.
func (r *Reader) Unread(p Packet) {
    r.q = append(r.q, p)
}

func NewReader(r io.Reader) *Reader {
    return &Reader{
        q:       nil,
        readers: []io.Reader{r},
    }
}