package wire import ( "bytes" "encoding/binary" "log" "os" "github.com/lucas-clemente/quic-go/internal/protocol" "github.com/lucas-clemente/quic-go/internal/utils" "github.com/lucas-clemente/quic-go/qerr" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" ) var _ = Describe("Public Header", func() { Context("when parsing", func() { It("accepts a sample client header", func() { ver := make([]byte, 4) binary.BigEndian.PutUint32(ver, uint32(protocol.SupportedVersions[0])) b := bytes.NewReader(append(append([]byte{0x09, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6}, ver...), 0x01)) hdr, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(hdr.VersionFlag).To(BeTrue()) Expect(hdr.IsVersionNegotiation).To(BeFalse()) Expect(hdr.ResetFlag).To(BeFalse()) Expect(hdr.ConnectionID).To(Equal(protocol.ConnectionID(0x4cfa9f9b668619f6))) Expect(hdr.Version).To(Equal(protocol.SupportedVersions[0])) Expect(hdr.SupportedVersions).To(BeEmpty()) Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(1))) Expect(b.Len()).To(BeZero()) }) It("does not accept an omittedd connection ID as a server", func() { b := bytes.NewReader([]byte{0x00, 0x01}) _, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).To(MatchError(errReceivedOmittedConnectionID)) }) It("accepts aan d connection ID as a client", func() { b := bytes.NewReader([]byte{0x00, 0x01}) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.OmitConnectionID).To(BeTrue()) Expect(hdr.ConnectionID).To(BeZero()) Expect(b.Len()).To(BeZero()) }) It("rejects 0 as a connection ID", func() { b := bytes.NewReader([]byte{0x09, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x51, 0x30, 0x33, 0x30, 0x01}) _, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).To(MatchError(errInvalidConnectionID)) }) It("reads a PublicReset packet", func() { b := bytes.NewReader([]byte{0xa, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8}) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.ResetFlag).To(BeTrue()) Expect(hdr.ConnectionID).ToNot(BeZero()) }) It("parses a public reset packet", func() { b := bytes.NewReader([]byte{0xa, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08}) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.ResetFlag).To(BeTrue()) Expect(hdr.VersionFlag).To(BeFalse()) Expect(hdr.IsVersionNegotiation).To(BeFalse()) Expect(hdr.ConnectionID).To(Equal(protocol.ConnectionID(0x0102030405060708))) }) It("reads a diversification nonce sent by the server", func() { divNonce := []byte{0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f} Expect(divNonce).To(HaveLen(32)) b := bytes.NewReader(append(append([]byte{0x0c, 0xf6, 0x19, 0x86, 0x66, 0x9b, 0x9f, 0xfa, 0x4c}, divNonce...), 0x37)) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.ConnectionID).To(Not(BeZero())) Expect(hdr.DiversificationNonce).To(Equal(divNonce)) Expect(b.Len()).To(BeZero()) }) Context("version negotiation packets", func() { appendVersion := func(data []byte, v protocol.VersionNumber) []byte { data = append(data, []byte{0, 0, 0, 0}...) binary.BigEndian.PutUint32(data[len(data)-4:], uint32(v)) return data } It("parses", func() { versions := []protocol.VersionNumber{0x13, 0x37} b := bytes.NewReader(ComposeGQUICVersionNegotiation(0x1337, versions)) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.VersionFlag).To(BeTrue()) Expect(hdr.Version).To(BeZero()) // unitialized Expect(hdr.IsVersionNegotiation).To(BeTrue()) // in addition to the versions, the supported versions might contain a reserved version number for _, version := range versions { Expect(hdr.SupportedVersions).To(ContainElement(version)) } Expect(b.Len()).To(BeZero()) }) It("errors if it doesn't contain any versions", func() { b := bytes.NewReader([]byte{0x9, 0xf6, 0x19, 0x86, 0x66, 0x9b, 0x9f, 0xfa, 0x4c}) _, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).To(MatchError("InvalidVersionNegotiationPacket: empty version list")) }) It("reads version negotiation packets containing unsupported versions", func() { data := []byte{0x9, 0xf6, 0x19, 0x86, 0x66, 0x9b, 0x9f, 0xfa, 0x4c} data = appendVersion(data, 1) // unsupported version data = appendVersion(data, protocol.SupportedVersions[0]) data = appendVersion(data, 99) // unsupported version b := bytes.NewReader(data) hdr, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(hdr.VersionFlag).To(BeTrue()) Expect(hdr.IsVersionNegotiation).To(BeTrue()) Expect(hdr.SupportedVersions).To(Equal([]protocol.VersionNumber{1, protocol.SupportedVersions[0], 99})) Expect(b.Len()).To(BeZero()) }) It("errors on invalid version tags", func() { data := ComposeGQUICVersionNegotiation(0x1337, protocol.SupportedVersions) data = append(data, []byte{0x13, 0x37}...) b := bytes.NewReader(data) _, err := parsePublicHeader(b, protocol.PerspectiveServer) Expect(err).To(MatchError(qerr.InvalidVersionNegotiationPacket)) }) }) Context("Packet Number lengths", func() { It("accepts 1-byte packet numbers", func() { b := bytes.NewReader([]byte{0x08, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xde}) hdr, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0xde))) Expect(hdr.PacketNumberLen).To(Equal(protocol.PacketNumberLen1)) Expect(b.Len()).To(BeZero()) }) It("accepts 2-byte packet numbers", func() { b := bytes.NewReader([]byte{0x18, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xde, 0xca}) hdr, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0xdeca))) Expect(hdr.PacketNumberLen).To(Equal(protocol.PacketNumberLen2)) Expect(b.Len()).To(BeZero()) }) It("accepts 4-byte packet numbers", func() { b := bytes.NewReader([]byte{0x28, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xad, 0xfb, 0xca, 0xde}) hdr, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0xadfbcade))) Expect(hdr.PacketNumberLen).To(Equal(protocol.PacketNumberLen4)) Expect(b.Len()).To(BeZero()) }) It("accepts 6-byte packet numbers", func() { b := bytes.NewReader([]byte{0x38, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0x23, 0x42, 0xad, 0xfb, 0xca, 0xde}) hdr, err := parsePublicHeader(b, protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0x2342adfbcade))) Expect(hdr.PacketNumberLen).To(Equal(protocol.PacketNumberLen6)) Expect(b.Len()).To(BeZero()) }) }) }) Context("when writing", func() { It("writes a sample header as a server", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 2, PacketNumberLen: protocol.PacketNumberLen6, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, versionBigEndian) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x38, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0, 0, 0, 0, 0, 2})) }) It("writes a sample header as a client", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0x1337, PacketNumberLen: protocol.PacketNumberLen6, } err := hdr.writePublicHeader(b, protocol.PerspectiveClient, versionBigEndian) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x38, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0x0, 0x0, 0x0, 0x0, 0x13, 0x37})) }) It("refuses to write a Public Header if the PacketNumberLen is not set", func() { hdr := Header{ ConnectionID: 1, PacketNumber: 2, } b := &bytes.Buffer{} err := hdr.writePublicHeader(b, protocol.PerspectiveServer, protocol.VersionWhatever) Expect(err).To(MatchError("PublicHeader: PacketNumberLen not set")) }) It("omits the connection ID", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, OmitConnectionID: true, PacketNumberLen: protocol.PacketNumberLen1, PacketNumber: 1, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, protocol.VersionWhatever) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x0, 0x1})) }) It("writes diversification nonces", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 1, PacketNumberLen: protocol.PacketNumberLen1, DiversificationNonce: bytes.Repeat([]byte{1}, 32), } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, versionBigEndian) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{ 0x0c, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0x01, })) }) It("throws an error if both Reset Flag and Version Flag are set", func() { b := &bytes.Buffer{} hdr := Header{ VersionFlag: true, ResetFlag: true, } err := hdr.writePublicHeader(b, protocol.PerspectiveClient, protocol.VersionWhatever) Expect(err).To(MatchError(errResetAndVersionFlagSet)) }) It("doesn't write Version Negotiation Packets", func() { b := &bytes.Buffer{} hdr := Header{ VersionFlag: true, ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 2, PacketNumberLen: protocol.PacketNumberLen6, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, protocol.VersionWhatever) Expect(err).To(MatchError("PublicHeader: Writing of Version Negotiation Packets not supported")) }) It("writes packets with Version Flag, as a client", func() { b := &bytes.Buffer{} hdr := Header{ VersionFlag: true, Version: protocol.Version39, ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0x42, PacketNumberLen: protocol.PacketNumberLen1, } err := hdr.writePublicHeader(b, protocol.PerspectiveClient, protocol.VersionWhatever) Expect(err).ToNot(HaveOccurred()) // must be the first assertion Expect(b.Len()).To(Equal(1 + 8 + 4 + 1)) // 1 FlagByte + 8 ConnectionID + 4 version number + 1 PacketNumber firstByte, _ := b.ReadByte() Expect(firstByte & 0x01).To(Equal(uint8(1))) Expect(firstByte & 0x30).To(Equal(uint8(0x0))) Expect(string(b.Bytes()[8:12])).To(Equal("Q039")) Expect(b.Bytes()[12:13]).To(Equal([]byte{0x42})) }) Context("PublicReset packets", func() { It("sets the Reset Flag", func() { b := &bytes.Buffer{} hdr := Header{ ResetFlag: true, ConnectionID: 0x4cfa9f9b668619f6, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, protocol.VersionWhatever) Expect(err).ToNot(HaveOccurred()) // must be the first assertion Expect(b.Len()).To(Equal(1 + 8)) // 1 FlagByte + 8 ConnectionID firstByte, _ := b.ReadByte() Expect((firstByte & 0x02) >> 1).To(Equal(uint8(1))) }) It("doesn't add a packet number for headers with Reset Flag sent as a client", func() { b := &bytes.Buffer{} hdr := Header{ ResetFlag: true, ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 2, PacketNumberLen: protocol.PacketNumberLen6, } err := hdr.writePublicHeader(b, protocol.PerspectiveClient, protocol.VersionWhatever) Expect(err).ToNot(HaveOccurred()) // must be the first assertion Expect(b.Len()).To(Equal(1 + 8)) // 1 FlagByte + 8 ConnectionID }) }) Context("getting the length", func() { It("errors when calling getPublicHeaderLength for Version Negotiation packets", func() { hdr := Header{VersionFlag: true} _, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).To(MatchError(errGetLengthNotForVersionNegotiation)) }) It("errors when calling getPublicHeaderLength for packets that have the VersionFlag and the ResetFlag set", func() { hdr := Header{ ResetFlag: true, VersionFlag: true, } _, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).To(MatchError(errResetAndVersionFlagSet)) }) It("errors when PacketNumberLen is not set", func() { hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xdecafbad, } _, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).To(MatchError(errPacketNumberLenNotSet)) }) It("gets the length of a packet with longest packet number length and connectionID", func() { hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xdecafbad, PacketNumberLen: protocol.PacketNumberLen6, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 8 + 6))) // 1 byte public flag, 8 bytes connectionID, and packet number }) It("gets the lengths of a packet sent by the client with the VersionFlag set", func() { hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, OmitConnectionID: true, PacketNumber: 0xdecafbad, PacketNumberLen: protocol.PacketNumberLen6, VersionFlag: true, Version: versionBigEndian, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveClient) Expect(err).ToNot(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 4 + 6))) // 1 byte public flag, 4 version number, and packet number }) It("gets the length of a packet with longest packet number length and omitted connectionID", func() { hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, OmitConnectionID: true, PacketNumber: 0xDECAFBAD, PacketNumberLen: protocol.PacketNumberLen6, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 6))) // 1 byte public flag, and packet number }) It("gets the length of a packet 2 byte packet number length ", func() { hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xDECAFBAD, PacketNumberLen: protocol.PacketNumberLen2, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).ToNot(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 8 + 2))) // 1 byte public flag, 8 byte connectionID, and packet number }) It("works with diversification nonce", func() { hdr := Header{ DiversificationNonce: []byte("foo"), PacketNumberLen: protocol.PacketNumberLen1, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).NotTo(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 8 + 3 + 1))) // 1 byte public flag, 8 byte connectionID, 3 byte DiversificationNonce, 1 byte PacketNumber }) It("gets the length of a PublicReset", func() { hdr := Header{ ResetFlag: true, ConnectionID: 0x4cfa9f9b668619f6, } length, err := hdr.getPublicHeaderLength(protocol.PerspectiveServer) Expect(err).NotTo(HaveOccurred()) Expect(length).To(Equal(protocol.ByteCount(1 + 8))) // 1 byte public flag, 8 byte connectionID }) }) Context("packet number length", func() { It("doesn't write a header if the packet number length is not set", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xDECAFBAD, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, protocol.VersionWhatever) Expect(err).To(MatchError("PublicHeader: PacketNumberLen not set")) }) Context("in big endian", func() { version := versionBigEndian It("writes a header with a 1-byte packet number", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xdecafbad, PacketNumberLen: protocol.PacketNumberLen1, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, version) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x08, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xad})) }) It("writes a header with a 2-byte packet number", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xdecafbad, PacketNumberLen: protocol.PacketNumberLen2, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, version) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x18, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xfb, 0xad})) }) It("writes a header with a 4-byte packet number", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0x13decafbad, PacketNumberLen: protocol.PacketNumberLen4, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, version) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x28, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0xde, 0xca, 0xfb, 0xad})) }) It("writes a header with a 6-byte packet number", func() { b := &bytes.Buffer{} hdr := Header{ ConnectionID: 0x4cfa9f9b668619f6, PacketNumber: 0xbe1337decafbad, PacketNumberLen: protocol.PacketNumberLen6, } err := hdr.writePublicHeader(b, protocol.PerspectiveServer, version) Expect(err).ToNot(HaveOccurred()) Expect(b.Bytes()).To(Equal([]byte{0x38, 0x4c, 0xfa, 0x9f, 0x9b, 0x66, 0x86, 0x19, 0xf6, 0x13, 0x37, 0xde, 0xca, 0xfb, 0xad})) }) }) }) }) Context("logging", func() { var buf bytes.Buffer BeforeEach(func() { buf.Reset() utils.SetLogLevel(utils.LogLevelDebug) log.SetOutput(&buf) }) AfterEach(func() { utils.SetLogLevel(utils.LogLevelNothing) log.SetOutput(os.Stdout) }) It("logs a Public Header containing a connection ID", func() { (&Header{ ConnectionID: 0xdecafbad, PacketNumber: 0x1337, PacketNumberLen: 6, Version: protocol.Version39, }).logPublicHeader() Expect(buf.String()).To(ContainSubstring("Public Header{ConnectionID: 0xdecafbad, PacketNumber: 0x1337, PacketNumberLen: 6, Version: gQUIC 39")) }) It("logs a Public Header with omitted connection ID", func() { (&Header{ OmitConnectionID: true, PacketNumber: 0x1337, PacketNumberLen: 6, Version: protocol.Version39, }).logPublicHeader() Expect(buf.String()).To(ContainSubstring("Public Header{ConnectionID: (omitted)")) }) It("logs a Public Header without a version", func() { (&Header{ OmitConnectionID: true, PacketNumber: 0x1337, PacketNumberLen: 6, }).logPublicHeader() Expect(buf.String()).To(ContainSubstring("Version: (unset)")) }) It("logs diversification nonces", func() { (&Header{ ConnectionID: 0xdecafbad, DiversificationNonce: []byte{0xba, 0xdf, 0x00, 0x0d}, }).logPublicHeader() Expect(buf.String()).To(ContainSubstring("DiversificationNonce: []byte{0xba, 0xdf, 0x0, 0xd}")) }) }) })