package quic import ( "bytes" "context" "crypto/tls" "errors" "net" "os" "time" "github.com/golang/mock/gomock" "github.com/lucas-clemente/quic-go/internal/handshake" "github.com/lucas-clemente/quic-go/internal/protocol" "github.com/lucas-clemente/quic-go/internal/qerr" "github.com/lucas-clemente/quic-go/internal/utils" "github.com/lucas-clemente/quic-go/internal/wire" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" ) var _ = Describe("Client", func() { var ( cl *client packetConn *mockPacketConn addr net.Addr connID protocol.ConnectionID mockMultiplexer *MockMultiplexer origMultiplexer multiplexer originalClientSessConstructor func( conn connection, runner sessionRunner, destConnID protocol.ConnectionID, srcConnID protocol.ConnectionID, conf *Config, tlsConf *tls.Config, initialPacketNumber protocol.PacketNumber, params *handshake.TransportParameters, initialVersion protocol.VersionNumber, logger utils.Logger, v protocol.VersionNumber, ) (quicSession, error) ) // generate a packet sent by the server that accepts the QUIC version suggested by the client acceptClientVersionPacket := func(connID protocol.ConnectionID) []byte { b := &bytes.Buffer{} Expect((&wire.ExtendedHeader{ Header: wire.Header{DestConnectionID: connID}, PacketNumber: 1, PacketNumberLen: 1, }).Write(b, protocol.VersionWhatever)).To(Succeed()) return b.Bytes() } composeVersionNegotiationPacket := func(connID protocol.ConnectionID, versions []protocol.VersionNumber) *receivedPacket { data, err := wire.ComposeVersionNegotiation(connID, nil, versions) Expect(err).ToNot(HaveOccurred()) Expect(wire.IsVersionNegotiationPacket(data)).To(BeTrue()) return &receivedPacket{ rcvTime: time.Now(), data: data, } } BeforeEach(func() { connID = protocol.ConnectionID{0, 0, 0, 0, 0, 0, 0x13, 0x37} originalClientSessConstructor = newClientSession Eventually(areSessionsRunning).Should(BeFalse()) // sess = NewMockQuicSession(mockCtrl) addr = &net.UDPAddr{IP: net.IPv4(192, 168, 100, 200), Port: 1337} packetConn = newMockPacketConn() packetConn.addr = &net.UDPAddr{IP: net.IPv4(127, 0, 0, 1), Port: 1234} packetConn.dataReadFrom = addr cl = &client{ srcConnID: connID, destConnID: connID, version: protocol.SupportedVersions[0], conn: &conn{pconn: packetConn, currentAddr: addr}, logger: utils.DefaultLogger, } getMultiplexer() // make the sync.Once execute // replace the clientMuxer. getClientMultiplexer will now return the MockMultiplexer mockMultiplexer = NewMockMultiplexer(mockCtrl) origMultiplexer = connMuxer connMuxer = mockMultiplexer }) AfterEach(func() { connMuxer = origMultiplexer newClientSession = originalClientSessConstructor }) AfterEach(func() { if s, ok := cl.session.(*session); ok { s.Close() } Eventually(areSessionsRunning).Should(BeFalse()) }) Context("Dialing", func() { var origGenerateConnectionID func(int) (protocol.ConnectionID, error) var origGenerateConnectionIDForInitial func() (protocol.ConnectionID, error) BeforeEach(func() { origGenerateConnectionID = generateConnectionID origGenerateConnectionIDForInitial = generateConnectionIDForInitial generateConnectionID = func(int) (protocol.ConnectionID, error) { return connID, nil } generateConnectionIDForInitial = func() (protocol.ConnectionID, error) { return connID, nil } }) AfterEach(func() { generateConnectionID = origGenerateConnectionID generateConnectionIDForInitial = origGenerateConnectionIDForInitial }) It("resolves the address", func() { if os.Getenv("APPVEYOR") == "True" { Skip("This test is flaky on AppVeyor.") } manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(gomock.Any(), gomock.Any()) manager.EXPECT().Close() mockMultiplexer.EXPECT().AddConn(gomock.Any(), gomock.Any()).Return(manager, nil) remoteAddrChan := make(chan string, 1) newClientSession = func( conn connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { remoteAddrChan <- conn.RemoteAddr().String() sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run() return sess, nil } _, err := DialAddr("localhost:17890", nil, &Config{HandshakeTimeout: time.Millisecond}) Expect(err).ToNot(HaveOccurred()) Eventually(remoteAddrChan).Should(Receive(Equal("127.0.0.1:17890"))) }) It("uses the tls.Config.ServerName as the hostname, if present", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(gomock.Any(), gomock.Any()) manager.EXPECT().Close() mockMultiplexer.EXPECT().AddConn(gomock.Any(), gomock.Any()).Return(manager, nil) hostnameChan := make(chan string, 1) newClientSession = func( _ connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, tlsConf *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { hostnameChan <- tlsConf.ServerName sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run() return sess, nil } _, err := DialAddr("localhost:17890", &tls.Config{ServerName: "foobar"}, nil) Expect(err).ToNot(HaveOccurred()) Eventually(hostnameChan).Should(Receive(Equal("foobar"))) }) It("returns after the handshake is complete", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(gomock.Any(), gomock.Any()) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) run := make(chan struct{}) newClientSession = func( _ connection, runner sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run().Do(func() { close(run) }) runner.onHandshakeComplete(sess) return sess, nil } s, err := Dial( packetConn, addr, "localhost:1337", nil, &Config{}, ) Expect(err).ToNot(HaveOccurred()) Expect(s).ToNot(BeNil()) Eventually(run).Should(BeClosed()) }) It("returns an error that occurs while waiting for the connection to become secure", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(gomock.Any(), gomock.Any()) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) testErr := errors.New("early handshake error") newClientSession = func( _ connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run().Return(testErr) return sess, nil } packetConn.dataToRead <- acceptClientVersionPacket(cl.srcConnID) _, err := Dial( packetConn, addr, "localhost:1337", nil, &Config{}, ) Expect(err).To(MatchError(testErr)) }) It("closes the session when the context is canceled", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(gomock.Any(), gomock.Any()) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) sessionRunning := make(chan struct{}) defer close(sessionRunning) sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run().Do(func() { <-sessionRunning }) newClientSession = func( _ connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { return sess, nil } ctx, cancel := context.WithCancel(context.Background()) dialed := make(chan struct{}) go func() { defer GinkgoRecover() _, err := DialContext( ctx, packetConn, addr, "localhost:1337", nil, &Config{}, ) Expect(err).To(MatchError(context.Canceled)) close(dialed) }() Consistently(dialed).ShouldNot(BeClosed()) sess.EXPECT().Close() cancel() Eventually(dialed).Should(BeClosed()) }) It("removes closed sessions from the multiplexer", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(connID, gomock.Any()) manager.EXPECT().Retire(connID) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) var runner sessionRunner sess := NewMockQuicSession(mockCtrl) newClientSession = func( _ connection, runnerP sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { runner = runnerP return sess, nil } sess.EXPECT().run().Do(func() { runner.retireConnectionID(connID) }) _, err := DialContext( context.Background(), packetConn, addr, "localhost:1337", nil, &Config{}, ) Expect(err).ToNot(HaveOccurred()) }) It("closes the connection when it was created by DialAddr", func() { if os.Getenv("APPVEYOR") == "True" { Skip("This test is flaky on AppVeyor.") } manager := NewMockPacketHandlerManager(mockCtrl) mockMultiplexer.EXPECT().AddConn(gomock.Any(), gomock.Any()).Return(manager, nil) manager.EXPECT().Add(gomock.Any(), gomock.Any()) var conn connection run := make(chan struct{}) sessionCreated := make(chan struct{}) sess := NewMockQuicSession(mockCtrl) newClientSession = func( connP connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { conn = connP close(sessionCreated) return sess, nil } sess.EXPECT().run().Do(func() { <-run }) done := make(chan struct{}) go func() { defer GinkgoRecover() _, err := DialAddr("localhost:1337", nil, nil) Expect(err).ToNot(HaveOccurred()) close(done) }() Eventually(sessionCreated).Should(BeClosed()) // check that the connection is not closed Expect(conn.Write([]byte("foobar"))).To(Succeed()) manager.EXPECT().Close() close(run) time.Sleep(50 * time.Millisecond) Eventually(done).Should(BeClosed()) }) Context("quic.Config", func() { It("setups with the right values", func() { config := &Config{ HandshakeTimeout: 1337 * time.Minute, IdleTimeout: 42 * time.Hour, MaxIncomingStreams: 1234, MaxIncomingUniStreams: 4321, ConnectionIDLength: 13, } c := populateClientConfig(config, false) Expect(c.HandshakeTimeout).To(Equal(1337 * time.Minute)) Expect(c.IdleTimeout).To(Equal(42 * time.Hour)) Expect(c.MaxIncomingStreams).To(Equal(1234)) Expect(c.MaxIncomingUniStreams).To(Equal(4321)) Expect(c.ConnectionIDLength).To(Equal(13)) }) It("errors when the Config contains an invalid version", func() { manager := NewMockPacketHandlerManager(mockCtrl) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) version := protocol.VersionNumber(0x1234) _, err := Dial(packetConn, nil, "localhost:1234", &tls.Config{}, &Config{Versions: []protocol.VersionNumber{version}}) Expect(err).To(MatchError("0x1234 is not a valid QUIC version")) }) It("disables bidirectional streams", func() { config := &Config{ MaxIncomingStreams: -1, MaxIncomingUniStreams: 4321, } c := populateClientConfig(config, false) Expect(c.MaxIncomingStreams).To(BeZero()) Expect(c.MaxIncomingUniStreams).To(Equal(4321)) }) It("disables unidirectional streams", func() { config := &Config{ MaxIncomingStreams: 1234, MaxIncomingUniStreams: -1, } c := populateClientConfig(config, false) Expect(c.MaxIncomingStreams).To(Equal(1234)) Expect(c.MaxIncomingUniStreams).To(BeZero()) }) It("uses 0-byte connection IDs when dialing an address", func() { config := &Config{} c := populateClientConfig(config, true) Expect(c.ConnectionIDLength).To(BeZero()) }) It("fills in default values if options are not set in the Config", func() { c := populateClientConfig(&Config{}, false) Expect(c.Versions).To(Equal(protocol.SupportedVersions)) Expect(c.HandshakeTimeout).To(Equal(protocol.DefaultHandshakeTimeout)) Expect(c.IdleTimeout).To(Equal(protocol.DefaultIdleTimeout)) }) }) It("creates new TLS sessions with the right parameters", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(connID, gomock.Any()) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) config := &Config{Versions: []protocol.VersionNumber{protocol.VersionTLS}} c := make(chan struct{}) var cconn connection var version protocol.VersionNumber var conf *Config newClientSession = func( connP connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, configP *Config, _ *tls.Config, _ protocol.PacketNumber, params *handshake.TransportParameters, _ protocol.VersionNumber, /* initial version */ _ utils.Logger, versionP protocol.VersionNumber, ) (quicSession, error) { cconn = connP version = versionP conf = configP close(c) // TODO: check connection IDs? sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run() return sess, nil } _, err := Dial(packetConn, addr, "localhost:1337", nil, config) Expect(err).ToNot(HaveOccurred()) Eventually(c).Should(BeClosed()) Expect(cconn.(*conn).pconn).To(Equal(packetConn)) Expect(version).To(Equal(config.Versions[0])) Expect(conf.Versions).To(Equal(config.Versions)) }) Context("version negotiation", func() { var origSupportedVersions []protocol.VersionNumber BeforeEach(func() { origSupportedVersions = protocol.SupportedVersions protocol.SupportedVersions = append(protocol.SupportedVersions, []protocol.VersionNumber{77, 78}...) }) AfterEach(func() { protocol.SupportedVersions = origSupportedVersions }) It("returns an error that occurs during version negotiation", func() { manager := NewMockPacketHandlerManager(mockCtrl) manager.EXPECT().Add(connID, gomock.Any()) mockMultiplexer.EXPECT().AddConn(packetConn, gomock.Any()).Return(manager, nil) testErr := errors.New("early handshake error") newClientSession = func( conn connection, _ sessionRunner, _ protocol.ConnectionID, _ protocol.ConnectionID, _ *Config, _ *tls.Config, _ protocol.PacketNumber, _ *handshake.TransportParameters, _ protocol.VersionNumber, _ utils.Logger, _ protocol.VersionNumber, ) (quicSession, error) { Expect(conn.Write([]byte("0 fake CHLO"))).To(Succeed()) sess := NewMockQuicSession(mockCtrl) sess.EXPECT().run().Return(testErr) return sess, nil } _, err := Dial( packetConn, addr, "localhost:1337", nil, &Config{}, ) Expect(err).To(MatchError(testErr)) }) It("recognizes that a non Version Negotiation packet means that the server accepted the suggested version", func() { sess := NewMockQuicSession(mockCtrl) sess.EXPECT().handlePacket(gomock.Any()) cl.session = sess cl.config = &Config{} buf := &bytes.Buffer{} Expect((&wire.ExtendedHeader{ Header: wire.Header{ DestConnectionID: connID, SrcConnectionID: connID, Version: cl.version, }, PacketNumberLen: protocol.PacketNumberLen3, }).Write(buf, protocol.VersionTLS)).To(Succeed()) cl.handlePacket(&receivedPacket{data: buf.Bytes()}) Eventually(cl.versionNegotiated.Get).Should(BeTrue()) }) It("errors if no matching version is found", func() { sess := NewMockQuicSession(mockCtrl) done := make(chan struct{}) sess.EXPECT().destroy(qerr.InvalidVersion).Do(func(error) { close(done) }) cl.session = sess cl.config = &Config{Versions: protocol.SupportedVersions} cl.handlePacket(composeVersionNegotiationPacket(connID, []protocol.VersionNumber{1})) Eventually(done).Should(BeClosed()) }) It("errors if the version is supported by quic-go, but disabled by the quic.Config", func() { sess := NewMockQuicSession(mockCtrl) done := make(chan struct{}) sess.EXPECT().destroy(qerr.InvalidVersion).Do(func(error) { close(done) }) cl.session = sess v := protocol.VersionNumber(1234) Expect(v).ToNot(Equal(cl.version)) cl.config = &Config{Versions: protocol.SupportedVersions} cl.handlePacket(composeVersionNegotiationPacket(connID, []protocol.VersionNumber{v})) Eventually(done).Should(BeClosed()) }) It("changes to the version preferred by the quic.Config", func() { phm := NewMockPacketHandlerManager(mockCtrl) cl.packetHandlers = phm sess := NewMockQuicSession(mockCtrl) destroyed := make(chan struct{}) sess.EXPECT().closeForRecreating().Do(func() { close(destroyed) }) cl.session = sess versions := []protocol.VersionNumber{1234, 4321} cl.config = &Config{Versions: versions} cl.handlePacket(composeVersionNegotiationPacket(connID, versions)) Eventually(destroyed).Should(BeClosed()) Expect(cl.version).To(Equal(protocol.VersionNumber(1234))) }) It("drops version negotiation packets that contain the offered version", func() { cl.config = &Config{} ver := cl.version cl.handlePacket(composeVersionNegotiationPacket(connID, []protocol.VersionNumber{ver})) Expect(cl.version).To(Equal(ver)) }) }) }) It("tells its version", func() { Expect(cl.version).ToNot(BeZero()) Expect(cl.GetVersion()).To(Equal(cl.version)) }) })