session.go 62 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045
  1. package quic
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/tls"
  6. "errors"
  7. "fmt"
  8. "io"
  9. "net"
  10. "reflect"
  11. "sync"
  12. "sync/atomic"
  13. "time"
  14. "github.com/Psiphon-Labs/quic-go/internal/ackhandler"
  15. "github.com/Psiphon-Labs/quic-go/internal/flowcontrol"
  16. "github.com/Psiphon-Labs/quic-go/internal/handshake"
  17. "github.com/Psiphon-Labs/quic-go/internal/logutils"
  18. "github.com/Psiphon-Labs/quic-go/internal/protocol"
  19. "github.com/Psiphon-Labs/quic-go/internal/qerr"
  20. "github.com/Psiphon-Labs/quic-go/internal/utils"
  21. "github.com/Psiphon-Labs/quic-go/internal/wire"
  22. "github.com/Psiphon-Labs/quic-go/logging"
  23. )
  24. type unpacker interface {
  25. Unpack(hdr *wire.Header, rcvTime time.Time, data []byte) (*unpackedPacket, error)
  26. }
  27. type streamGetter interface {
  28. GetOrOpenReceiveStream(protocol.StreamID) (receiveStreamI, error)
  29. GetOrOpenSendStream(protocol.StreamID) (sendStreamI, error)
  30. }
  31. type streamManager interface {
  32. GetOrOpenSendStream(protocol.StreamID) (sendStreamI, error)
  33. GetOrOpenReceiveStream(protocol.StreamID) (receiveStreamI, error)
  34. OpenStream() (Stream, error)
  35. OpenUniStream() (SendStream, error)
  36. OpenStreamSync(context.Context) (Stream, error)
  37. OpenUniStreamSync(context.Context) (SendStream, error)
  38. AcceptStream(context.Context) (Stream, error)
  39. AcceptUniStream(context.Context) (ReceiveStream, error)
  40. DeleteStream(protocol.StreamID) error
  41. UpdateLimits(*wire.TransportParameters)
  42. HandleMaxStreamsFrame(*wire.MaxStreamsFrame)
  43. CloseWithError(error)
  44. ResetFor0RTT()
  45. UseResetMaps()
  46. }
  47. type cryptoStreamHandler interface {
  48. RunHandshake()
  49. ChangeConnectionID(protocol.ConnectionID)
  50. SetLargest1RTTAcked(protocol.PacketNumber) error
  51. SetHandshakeConfirmed()
  52. GetSessionTicket() ([]byte, error)
  53. io.Closer
  54. ConnectionState() handshake.ConnectionState
  55. }
  56. type packetInfo struct {
  57. addr net.IP
  58. ifIndex uint32
  59. }
  60. type receivedPacket struct {
  61. buffer *packetBuffer
  62. remoteAddr net.Addr
  63. rcvTime time.Time
  64. data []byte
  65. ecn protocol.ECN
  66. info *packetInfo
  67. }
  68. func (p *receivedPacket) Size() protocol.ByteCount { return protocol.ByteCount(len(p.data)) }
  69. func (p *receivedPacket) Clone() *receivedPacket {
  70. return &receivedPacket{
  71. remoteAddr: p.remoteAddr,
  72. rcvTime: p.rcvTime,
  73. data: p.data,
  74. buffer: p.buffer,
  75. ecn: p.ecn,
  76. info: p.info,
  77. }
  78. }
  79. type sessionRunner interface {
  80. Add(protocol.ConnectionID, packetHandler) bool
  81. GetStatelessResetToken(protocol.ConnectionID) protocol.StatelessResetToken
  82. Retire(protocol.ConnectionID)
  83. Remove(protocol.ConnectionID)
  84. ReplaceWithClosed(protocol.ConnectionID, packetHandler)
  85. AddResetToken(protocol.StatelessResetToken, packetHandler)
  86. RemoveResetToken(protocol.StatelessResetToken)
  87. }
  88. type handshakeRunner struct {
  89. onReceivedParams func(*wire.TransportParameters)
  90. onError func(error)
  91. dropKeys func(protocol.EncryptionLevel)
  92. onHandshakeComplete func()
  93. }
  94. func (r *handshakeRunner) OnReceivedParams(tp *wire.TransportParameters) { r.onReceivedParams(tp) }
  95. func (r *handshakeRunner) OnError(e error) { r.onError(e) }
  96. func (r *handshakeRunner) DropKeys(el protocol.EncryptionLevel) { r.dropKeys(el) }
  97. func (r *handshakeRunner) OnHandshakeComplete() { r.onHandshakeComplete() }
  98. type closeError struct {
  99. err error
  100. remote bool
  101. immediate bool
  102. }
  103. type errCloseForRecreating struct {
  104. nextPacketNumber protocol.PacketNumber
  105. nextVersion protocol.VersionNumber
  106. }
  107. func (e *errCloseForRecreating) Error() string {
  108. return "closing session in order to recreate it"
  109. }
  110. var sessionTracingID uint64 // to be accessed atomically
  111. func nextSessionTracingID() uint64 { return atomic.AddUint64(&sessionTracingID, 1) }
  112. // A Session is a QUIC session
  113. type session struct {
  114. // Destination connection ID used during the handshake.
  115. // Used to check source connection ID on incoming packets.
  116. handshakeDestConnID protocol.ConnectionID
  117. // Set for the client. Destination connection ID used on the first Initial sent.
  118. origDestConnID protocol.ConnectionID
  119. retrySrcConnID *protocol.ConnectionID // only set for the client (and if a Retry was performed)
  120. srcConnIDLen int
  121. perspective protocol.Perspective
  122. version protocol.VersionNumber
  123. config *Config
  124. conn sendConn
  125. sendQueue sender
  126. streamsMap streamManager
  127. connIDManager *connIDManager
  128. connIDGenerator *connIDGenerator
  129. rttStats *utils.RTTStats
  130. cryptoStreamManager *cryptoStreamManager
  131. sentPacketHandler ackhandler.SentPacketHandler
  132. receivedPacketHandler ackhandler.ReceivedPacketHandler
  133. retransmissionQueue *retransmissionQueue
  134. framer framer
  135. windowUpdateQueue *windowUpdateQueue
  136. connFlowController flowcontrol.ConnectionFlowController
  137. tokenStoreKey string // only set for the client
  138. tokenGenerator *handshake.TokenGenerator // only set for the server
  139. unpacker unpacker
  140. frameParser wire.FrameParser
  141. packer packer
  142. mtuDiscoverer mtuDiscoverer // initialized when the handshake completes
  143. oneRTTStream cryptoStream // only set for the server
  144. cryptoStreamHandler cryptoStreamHandler
  145. receivedPackets chan *receivedPacket
  146. sendingScheduled chan struct{}
  147. closeOnce sync.Once
  148. // closeChan is used to notify the run loop that it should terminate
  149. closeChan chan closeError
  150. ctx context.Context
  151. ctxCancel context.CancelFunc
  152. handshakeCtx context.Context
  153. handshakeCtxCancel context.CancelFunc
  154. undecryptablePackets []*receivedPacket // undecryptable packets, waiting for a change in encryption level
  155. undecryptablePacketsToProcess []*receivedPacket
  156. clientHelloWritten <-chan *wire.TransportParameters
  157. earlySessionReadyChan chan struct{}
  158. handshakeCompleteChan chan struct{} // is closed when the handshake completes
  159. handshakeComplete bool
  160. handshakeConfirmed bool
  161. receivedRetry bool
  162. versionNegotiated bool
  163. receivedFirstPacket bool
  164. idleTimeout time.Duration
  165. sessionCreationTime time.Time
  166. // The idle timeout is set based on the max of the time we received the last packet...
  167. lastPacketReceivedTime time.Time
  168. // ... and the time we sent a new ack-eliciting packet after receiving a packet.
  169. firstAckElicitingPacketAfterIdleSentTime time.Time
  170. // pacingDeadline is the time when the next packet should be sent
  171. pacingDeadline time.Time
  172. peerParams *wire.TransportParameters
  173. timer *utils.Timer
  174. // keepAlivePingSent stores whether a keep alive PING is in flight.
  175. // It is reset as soon as we receive a packet from the peer.
  176. keepAlivePingSent bool
  177. keepAliveInterval time.Duration
  178. datagramQueue *datagramQueue
  179. logID string
  180. tracer logging.ConnectionTracer
  181. logger utils.Logger
  182. }
  183. var (
  184. _ Session = &session{}
  185. _ EarlySession = &session{}
  186. _ streamSender = &session{}
  187. deadlineSendImmediately = time.Time{}.Add(42 * time.Millisecond) // any value > time.Time{} and before time.Now() is fine
  188. )
  189. var newSession = func(
  190. conn sendConn,
  191. runner sessionRunner,
  192. origDestConnID protocol.ConnectionID,
  193. retrySrcConnID *protocol.ConnectionID,
  194. clientDestConnID protocol.ConnectionID,
  195. destConnID protocol.ConnectionID,
  196. srcConnID protocol.ConnectionID,
  197. statelessResetToken protocol.StatelessResetToken,
  198. conf *Config,
  199. tlsConf *tls.Config,
  200. tokenGenerator *handshake.TokenGenerator,
  201. enable0RTT bool,
  202. tracer logging.ConnectionTracer,
  203. tracingID uint64,
  204. logger utils.Logger,
  205. v protocol.VersionNumber,
  206. ) quicSession {
  207. s := &session{
  208. conn: conn,
  209. config: conf,
  210. handshakeDestConnID: destConnID,
  211. srcConnIDLen: srcConnID.Len(),
  212. tokenGenerator: tokenGenerator,
  213. oneRTTStream: newCryptoStream(),
  214. perspective: protocol.PerspectiveServer,
  215. handshakeCompleteChan: make(chan struct{}),
  216. tracer: tracer,
  217. logger: logger,
  218. version: v,
  219. }
  220. if origDestConnID != nil {
  221. s.logID = origDestConnID.String()
  222. } else {
  223. s.logID = destConnID.String()
  224. }
  225. s.connIDManager = newConnIDManager(
  226. destConnID,
  227. func(token protocol.StatelessResetToken) { runner.AddResetToken(token, s) },
  228. runner.RemoveResetToken,
  229. s.queueControlFrame,
  230. )
  231. s.connIDGenerator = newConnIDGenerator(
  232. srcConnID,
  233. clientDestConnID,
  234. func(connID protocol.ConnectionID) { runner.Add(connID, s) },
  235. runner.GetStatelessResetToken,
  236. runner.Remove,
  237. runner.Retire,
  238. runner.ReplaceWithClosed,
  239. s.queueControlFrame,
  240. s.version,
  241. )
  242. s.preSetup()
  243. s.ctx, s.ctxCancel = context.WithCancel(context.WithValue(context.Background(), SessionTracingKey, tracingID))
  244. // [Psiphon]
  245. maxPacketSizeAdjustment := 0
  246. if conf.ServerMaxPacketSizeAdjustment != nil {
  247. maxPacketSizeAdjustment = conf.ServerMaxPacketSizeAdjustment(s.RemoteAddr())
  248. }
  249. s.sentPacketHandler, s.receivedPacketHandler = ackhandler.NewAckHandler(
  250. 0,
  251. getMaxPacketSize(s.conn.RemoteAddr(), maxPacketSizeAdjustment),
  252. s.rttStats,
  253. s.perspective,
  254. s.tracer,
  255. s.logger,
  256. s.version,
  257. )
  258. initialStream := newCryptoStream()
  259. handshakeStream := newCryptoStream()
  260. params := &wire.TransportParameters{
  261. InitialMaxStreamDataBidiLocal: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  262. InitialMaxStreamDataBidiRemote: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  263. InitialMaxStreamDataUni: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  264. InitialMaxData: protocol.ByteCount(s.config.InitialConnectionReceiveWindow),
  265. MaxIdleTimeout: s.config.MaxIdleTimeout,
  266. MaxBidiStreamNum: protocol.StreamNum(s.config.MaxIncomingStreams),
  267. MaxUniStreamNum: protocol.StreamNum(s.config.MaxIncomingUniStreams),
  268. MaxAckDelay: protocol.MaxAckDelayInclGranularity,
  269. AckDelayExponent: protocol.AckDelayExponent,
  270. DisableActiveMigration: true,
  271. StatelessResetToken: &statelessResetToken,
  272. OriginalDestinationConnectionID: origDestConnID,
  273. ActiveConnectionIDLimit: protocol.MaxActiveConnectionIDs,
  274. InitialSourceConnectionID: srcConnID,
  275. RetrySourceConnectionID: retrySrcConnID,
  276. }
  277. if s.config.EnableDatagrams {
  278. params.MaxDatagramFrameSize = protocol.MaxDatagramFrameSize
  279. }
  280. if s.tracer != nil {
  281. s.tracer.SentTransportParameters(params)
  282. }
  283. cs := handshake.NewCryptoSetupServer(
  284. initialStream,
  285. handshakeStream,
  286. clientDestConnID,
  287. conn.LocalAddr(),
  288. conn.RemoteAddr(),
  289. params,
  290. &handshakeRunner{
  291. onReceivedParams: s.handleTransportParameters,
  292. onError: s.closeLocal,
  293. dropKeys: s.dropEncryptionLevel,
  294. onHandshakeComplete: func() {
  295. runner.Retire(clientDestConnID)
  296. close(s.handshakeCompleteChan)
  297. },
  298. },
  299. tlsConf,
  300. enable0RTT,
  301. s.rttStats,
  302. tracer,
  303. logger,
  304. s.version,
  305. )
  306. s.cryptoStreamHandler = cs
  307. s.packer = newPacketPacker(
  308. srcConnID,
  309. s.connIDManager.Get,
  310. initialStream,
  311. handshakeStream,
  312. s.sentPacketHandler,
  313. s.retransmissionQueue,
  314. s.RemoteAddr(),
  315. // [Psiphon]
  316. maxPacketSizeAdjustment,
  317. cs,
  318. s.framer,
  319. s.receivedPacketHandler,
  320. s.datagramQueue,
  321. s.perspective,
  322. s.version,
  323. )
  324. s.unpacker = newPacketUnpacker(cs, s.version)
  325. s.cryptoStreamManager = newCryptoStreamManager(cs, initialStream, handshakeStream, s.oneRTTStream)
  326. return s
  327. }
  328. // declare this as a variable, such that we can it mock it in the tests
  329. var newClientSession = func(
  330. conn sendConn,
  331. runner sessionRunner,
  332. destConnID protocol.ConnectionID,
  333. srcConnID protocol.ConnectionID,
  334. conf *Config,
  335. tlsConf *tls.Config,
  336. initialPacketNumber protocol.PacketNumber,
  337. enable0RTT bool,
  338. hasNegotiatedVersion bool,
  339. tracer logging.ConnectionTracer,
  340. tracingID uint64,
  341. logger utils.Logger,
  342. v protocol.VersionNumber,
  343. ) quicSession {
  344. s := &session{
  345. conn: conn,
  346. config: conf,
  347. origDestConnID: destConnID,
  348. handshakeDestConnID: destConnID,
  349. srcConnIDLen: srcConnID.Len(),
  350. perspective: protocol.PerspectiveClient,
  351. handshakeCompleteChan: make(chan struct{}),
  352. logID: destConnID.String(),
  353. logger: logger,
  354. tracer: tracer,
  355. versionNegotiated: hasNegotiatedVersion,
  356. version: v,
  357. }
  358. s.connIDManager = newConnIDManager(
  359. destConnID,
  360. func(token protocol.StatelessResetToken) { runner.AddResetToken(token, s) },
  361. runner.RemoveResetToken,
  362. s.queueControlFrame,
  363. )
  364. s.connIDGenerator = newConnIDGenerator(
  365. srcConnID,
  366. nil,
  367. func(connID protocol.ConnectionID) { runner.Add(connID, s) },
  368. runner.GetStatelessResetToken,
  369. runner.Remove,
  370. runner.Retire,
  371. runner.ReplaceWithClosed,
  372. s.queueControlFrame,
  373. s.version,
  374. )
  375. s.preSetup()
  376. s.ctx, s.ctxCancel = context.WithCancel(context.WithValue(context.Background(), SessionTracingKey, tracingID))
  377. s.sentPacketHandler, s.receivedPacketHandler = ackhandler.NewAckHandler(
  378. initialPacketNumber,
  379. // [Psiphon]
  380. getMaxPacketSize(s.conn.RemoteAddr(), conf.ClientMaxPacketSizeAdjustment),
  381. s.rttStats,
  382. s.perspective,
  383. s.tracer,
  384. s.logger,
  385. s.version,
  386. )
  387. initialStream := newCryptoStream()
  388. handshakeStream := newCryptoStream()
  389. params := &wire.TransportParameters{
  390. InitialMaxStreamDataBidiRemote: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  391. InitialMaxStreamDataBidiLocal: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  392. InitialMaxStreamDataUni: protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  393. InitialMaxData: protocol.ByteCount(s.config.InitialConnectionReceiveWindow),
  394. MaxIdleTimeout: s.config.MaxIdleTimeout,
  395. MaxBidiStreamNum: protocol.StreamNum(s.config.MaxIncomingStreams),
  396. MaxUniStreamNum: protocol.StreamNum(s.config.MaxIncomingUniStreams),
  397. MaxAckDelay: protocol.MaxAckDelayInclGranularity,
  398. AckDelayExponent: protocol.AckDelayExponent,
  399. DisableActiveMigration: true,
  400. ActiveConnectionIDLimit: protocol.MaxActiveConnectionIDs,
  401. InitialSourceConnectionID: srcConnID,
  402. }
  403. if s.config.EnableDatagrams {
  404. params.MaxDatagramFrameSize = protocol.MaxDatagramFrameSize
  405. }
  406. if s.tracer != nil {
  407. s.tracer.SentTransportParameters(params)
  408. }
  409. cs, clientHelloWritten := handshake.NewCryptoSetupClient(
  410. initialStream,
  411. handshakeStream,
  412. destConnID,
  413. conn.LocalAddr(),
  414. conn.RemoteAddr(),
  415. params,
  416. &handshakeRunner{
  417. onReceivedParams: s.handleTransportParameters,
  418. onError: s.closeLocal,
  419. dropKeys: s.dropEncryptionLevel,
  420. onHandshakeComplete: func() { close(s.handshakeCompleteChan) },
  421. },
  422. tlsConf,
  423. // [Psiphon]
  424. conf.ClientHelloSeed,
  425. conf.GetClientHelloRandom,
  426. enable0RTT,
  427. s.rttStats,
  428. tracer,
  429. logger,
  430. s.version,
  431. )
  432. s.clientHelloWritten = clientHelloWritten
  433. s.cryptoStreamHandler = cs
  434. s.cryptoStreamManager = newCryptoStreamManager(cs, initialStream, handshakeStream, newCryptoStream())
  435. s.unpacker = newPacketUnpacker(cs, s.version)
  436. s.packer = newPacketPacker(
  437. srcConnID,
  438. s.connIDManager.Get,
  439. initialStream,
  440. handshakeStream,
  441. s.sentPacketHandler,
  442. s.retransmissionQueue,
  443. s.RemoteAddr(),
  444. // [Psiphon]
  445. conf.ClientMaxPacketSizeAdjustment,
  446. cs,
  447. s.framer,
  448. s.receivedPacketHandler,
  449. s.datagramQueue,
  450. s.perspective,
  451. s.version,
  452. )
  453. if len(tlsConf.ServerName) > 0 {
  454. s.tokenStoreKey = tlsConf.ServerName
  455. } else {
  456. s.tokenStoreKey = conn.RemoteAddr().String()
  457. }
  458. if s.config.TokenStore != nil {
  459. if token := s.config.TokenStore.Pop(s.tokenStoreKey); token != nil {
  460. s.packer.SetToken(token.data)
  461. }
  462. }
  463. return s
  464. }
  465. func (s *session) preSetup() {
  466. s.sendQueue = newSendQueue(s.conn)
  467. s.retransmissionQueue = newRetransmissionQueue(s.version)
  468. s.frameParser = wire.NewFrameParser(s.config.EnableDatagrams, s.version)
  469. s.rttStats = &utils.RTTStats{}
  470. s.connFlowController = flowcontrol.NewConnectionFlowController(
  471. protocol.ByteCount(s.config.InitialConnectionReceiveWindow),
  472. protocol.ByteCount(s.config.MaxConnectionReceiveWindow),
  473. s.onHasConnectionWindowUpdate,
  474. func(size protocol.ByteCount) bool {
  475. if s.config.AllowConnectionWindowIncrease == nil {
  476. return true
  477. }
  478. return s.config.AllowConnectionWindowIncrease(s, uint64(size))
  479. },
  480. s.rttStats,
  481. s.logger,
  482. )
  483. s.earlySessionReadyChan = make(chan struct{})
  484. s.streamsMap = newStreamsMap(
  485. s,
  486. s.newFlowController,
  487. uint64(s.config.MaxIncomingStreams),
  488. uint64(s.config.MaxIncomingUniStreams),
  489. s.perspective,
  490. s.version,
  491. )
  492. s.framer = newFramer(s.streamsMap, s.version)
  493. s.receivedPackets = make(chan *receivedPacket, protocol.MaxSessionUnprocessedPackets)
  494. s.closeChan = make(chan closeError, 1)
  495. s.sendingScheduled = make(chan struct{}, 1)
  496. s.handshakeCtx, s.handshakeCtxCancel = context.WithCancel(context.Background())
  497. now := time.Now()
  498. s.lastPacketReceivedTime = now
  499. s.sessionCreationTime = now
  500. s.windowUpdateQueue = newWindowUpdateQueue(s.streamsMap, s.connFlowController, s.framer.QueueControlFrame)
  501. if s.config.EnableDatagrams {
  502. s.datagramQueue = newDatagramQueue(s.scheduleSending, s.logger)
  503. }
  504. }
  505. // run the session main loop
  506. func (s *session) run() error {
  507. defer s.ctxCancel()
  508. s.timer = utils.NewTimer()
  509. go s.cryptoStreamHandler.RunHandshake()
  510. go func() {
  511. if err := s.sendQueue.Run(); err != nil {
  512. s.destroyImpl(err)
  513. }
  514. }()
  515. if s.perspective == protocol.PerspectiveClient {
  516. select {
  517. case zeroRTTParams := <-s.clientHelloWritten:
  518. s.scheduleSending()
  519. if zeroRTTParams != nil {
  520. s.restoreTransportParameters(zeroRTTParams)
  521. close(s.earlySessionReadyChan)
  522. }
  523. case closeErr := <-s.closeChan:
  524. // put the close error back into the channel, so that the run loop can receive it
  525. s.closeChan <- closeErr
  526. }
  527. }
  528. var (
  529. closeErr closeError
  530. sendQueueAvailable <-chan struct{}
  531. )
  532. runLoop:
  533. for {
  534. // Close immediately if requested
  535. select {
  536. case closeErr = <-s.closeChan:
  537. break runLoop
  538. case <-s.handshakeCompleteChan:
  539. s.handleHandshakeComplete()
  540. default:
  541. }
  542. s.maybeResetTimer()
  543. var processedUndecryptablePacket bool
  544. if len(s.undecryptablePacketsToProcess) > 0 {
  545. queue := s.undecryptablePacketsToProcess
  546. s.undecryptablePacketsToProcess = nil
  547. for _, p := range queue {
  548. if processed := s.handlePacketImpl(p); processed {
  549. processedUndecryptablePacket = true
  550. }
  551. // Don't set timers and send packets if the packet made us close the session.
  552. select {
  553. case closeErr = <-s.closeChan:
  554. break runLoop
  555. default:
  556. }
  557. }
  558. }
  559. // If we processed any undecryptable packets, jump to the resetting of the timers directly.
  560. if !processedUndecryptablePacket {
  561. select {
  562. case closeErr = <-s.closeChan:
  563. break runLoop
  564. case <-s.timer.Chan():
  565. s.timer.SetRead()
  566. // We do all the interesting stuff after the switch statement, so
  567. // nothing to see here.
  568. case <-s.sendingScheduled:
  569. // We do all the interesting stuff after the switch statement, so
  570. // nothing to see here.
  571. case <-sendQueueAvailable:
  572. case firstPacket := <-s.receivedPackets:
  573. wasProcessed := s.handlePacketImpl(firstPacket)
  574. // Don't set timers and send packets if the packet made us close the session.
  575. select {
  576. case closeErr = <-s.closeChan:
  577. break runLoop
  578. default:
  579. }
  580. if s.handshakeComplete {
  581. // Now process all packets in the receivedPackets channel.
  582. // Limit the number of packets to the length of the receivedPackets channel,
  583. // so we eventually get a chance to send out an ACK when receiving a lot of packets.
  584. numPackets := len(s.receivedPackets)
  585. receiveLoop:
  586. for i := 0; i < numPackets; i++ {
  587. select {
  588. case p := <-s.receivedPackets:
  589. if processed := s.handlePacketImpl(p); processed {
  590. wasProcessed = true
  591. }
  592. select {
  593. case closeErr = <-s.closeChan:
  594. break runLoop
  595. default:
  596. }
  597. default:
  598. break receiveLoop
  599. }
  600. }
  601. }
  602. // Only reset the timers if this packet was actually processed.
  603. // This avoids modifying any state when handling undecryptable packets,
  604. // which could be injected by an attacker.
  605. if !wasProcessed {
  606. continue
  607. }
  608. case <-s.handshakeCompleteChan:
  609. s.handleHandshakeComplete()
  610. }
  611. }
  612. now := time.Now()
  613. if timeout := s.sentPacketHandler.GetLossDetectionTimeout(); !timeout.IsZero() && timeout.Before(now) {
  614. // This could cause packets to be retransmitted.
  615. // Check it before trying to send packets.
  616. if err := s.sentPacketHandler.OnLossDetectionTimeout(); err != nil {
  617. s.closeLocal(err)
  618. }
  619. }
  620. if keepAliveTime := s.nextKeepAliveTime(); !keepAliveTime.IsZero() && !now.Before(keepAliveTime) {
  621. // send a PING frame since there is no activity in the session
  622. s.logger.Debugf("Sending a keep-alive PING to keep the connection alive.")
  623. s.framer.QueueControlFrame(&wire.PingFrame{})
  624. s.keepAlivePingSent = true
  625. } else if !s.handshakeComplete && now.Sub(s.sessionCreationTime) >= s.config.handshakeTimeout() {
  626. s.destroyImpl(qerr.ErrHandshakeTimeout)
  627. continue
  628. } else {
  629. idleTimeoutStartTime := s.idleTimeoutStartTime()
  630. if (!s.handshakeComplete && now.Sub(idleTimeoutStartTime) >= s.config.HandshakeIdleTimeout) ||
  631. (s.handshakeComplete && now.Sub(idleTimeoutStartTime) >= s.idleTimeout) {
  632. s.destroyImpl(qerr.ErrIdleTimeout)
  633. continue
  634. }
  635. }
  636. if s.sendQueue.WouldBlock() {
  637. // The send queue is still busy sending out packets.
  638. // Wait until there's space to enqueue new packets.
  639. sendQueueAvailable = s.sendQueue.Available()
  640. continue
  641. }
  642. if err := s.sendPackets(); err != nil {
  643. s.closeLocal(err)
  644. }
  645. if s.sendQueue.WouldBlock() {
  646. sendQueueAvailable = s.sendQueue.Available()
  647. } else {
  648. sendQueueAvailable = nil
  649. }
  650. }
  651. s.handleCloseError(&closeErr)
  652. if e := (&errCloseForRecreating{}); !errors.As(closeErr.err, &e) && s.tracer != nil {
  653. s.tracer.Close()
  654. }
  655. s.logger.Infof("Connection %s closed.", s.logID)
  656. s.cryptoStreamHandler.Close()
  657. s.sendQueue.Close()
  658. s.timer.Stop()
  659. return closeErr.err
  660. }
  661. // blocks until the early session can be used
  662. func (s *session) earlySessionReady() <-chan struct{} {
  663. return s.earlySessionReadyChan
  664. }
  665. func (s *session) HandshakeComplete() context.Context {
  666. return s.handshakeCtx
  667. }
  668. func (s *session) Context() context.Context {
  669. return s.ctx
  670. }
  671. func (s *session) supportsDatagrams() bool {
  672. return s.peerParams.MaxDatagramFrameSize != protocol.InvalidByteCount
  673. }
  674. func (s *session) ConnectionState() ConnectionState {
  675. return ConnectionState{
  676. TLS: s.cryptoStreamHandler.ConnectionState(),
  677. SupportsDatagrams: s.supportsDatagrams(),
  678. }
  679. }
  680. // Time when the next keep-alive packet should be sent.
  681. // It returns a zero time if no keep-alive should be sent.
  682. func (s *session) nextKeepAliveTime() time.Time {
  683. if !s.config.KeepAlive || s.keepAlivePingSent || !s.firstAckElicitingPacketAfterIdleSentTime.IsZero() {
  684. return time.Time{}
  685. }
  686. return s.lastPacketReceivedTime.Add(s.keepAliveInterval)
  687. }
  688. func (s *session) maybeResetTimer() {
  689. var deadline time.Time
  690. if !s.handshakeComplete {
  691. deadline = utils.MinTime(
  692. s.sessionCreationTime.Add(s.config.handshakeTimeout()),
  693. s.idleTimeoutStartTime().Add(s.config.HandshakeIdleTimeout),
  694. )
  695. } else {
  696. if keepAliveTime := s.nextKeepAliveTime(); !keepAliveTime.IsZero() {
  697. deadline = keepAliveTime
  698. } else {
  699. deadline = s.idleTimeoutStartTime().Add(s.idleTimeout)
  700. }
  701. }
  702. if s.handshakeConfirmed && !s.config.DisablePathMTUDiscovery {
  703. if probeTime := s.mtuDiscoverer.NextProbeTime(); !probeTime.IsZero() {
  704. deadline = utils.MinTime(deadline, probeTime)
  705. }
  706. }
  707. if ackAlarm := s.receivedPacketHandler.GetAlarmTimeout(); !ackAlarm.IsZero() {
  708. deadline = utils.MinTime(deadline, ackAlarm)
  709. }
  710. if lossTime := s.sentPacketHandler.GetLossDetectionTimeout(); !lossTime.IsZero() {
  711. deadline = utils.MinTime(deadline, lossTime)
  712. }
  713. if !s.pacingDeadline.IsZero() {
  714. deadline = utils.MinTime(deadline, s.pacingDeadline)
  715. }
  716. s.timer.Reset(deadline)
  717. }
  718. func (s *session) idleTimeoutStartTime() time.Time {
  719. return utils.MaxTime(s.lastPacketReceivedTime, s.firstAckElicitingPacketAfterIdleSentTime)
  720. }
  721. func (s *session) handleHandshakeComplete() {
  722. s.handshakeComplete = true
  723. s.handshakeCompleteChan = nil // prevent this case from ever being selected again
  724. defer s.handshakeCtxCancel()
  725. // Once the handshake completes, we have derived 1-RTT keys.
  726. // There's no point in queueing undecryptable packets for later decryption any more.
  727. s.undecryptablePackets = nil
  728. s.connIDManager.SetHandshakeComplete()
  729. s.connIDGenerator.SetHandshakeComplete()
  730. if s.perspective == protocol.PerspectiveClient {
  731. s.applyTransportParameters()
  732. return
  733. }
  734. s.handleHandshakeConfirmed()
  735. ticket, err := s.cryptoStreamHandler.GetSessionTicket()
  736. if err != nil {
  737. s.closeLocal(err)
  738. }
  739. if ticket != nil {
  740. s.oneRTTStream.Write(ticket)
  741. for s.oneRTTStream.HasData() {
  742. s.queueControlFrame(s.oneRTTStream.PopCryptoFrame(protocol.MaxPostHandshakeCryptoFrameSize))
  743. }
  744. }
  745. token, err := s.tokenGenerator.NewToken(s.conn.RemoteAddr())
  746. if err != nil {
  747. s.closeLocal(err)
  748. }
  749. s.queueControlFrame(&wire.NewTokenFrame{Token: token})
  750. s.queueControlFrame(&wire.HandshakeDoneFrame{})
  751. }
  752. func (s *session) handleHandshakeConfirmed() {
  753. // [Psiphon]
  754. // Adjust the max packet size to allow for obfuscation overhead.
  755. maxPacketSizeAdjustment := 0
  756. if s.config.ServerMaxPacketSizeAdjustment != nil {
  757. maxPacketSizeAdjustment = s.config.ServerMaxPacketSizeAdjustment(s.conn.RemoteAddr())
  758. } else {
  759. maxPacketSizeAdjustment = s.config.ClientMaxPacketSizeAdjustment
  760. }
  761. s.handshakeConfirmed = true
  762. s.sentPacketHandler.SetHandshakeConfirmed()
  763. s.cryptoStreamHandler.SetHandshakeConfirmed()
  764. if !s.config.DisablePathMTUDiscovery {
  765. maxPacketSize := s.peerParams.MaxUDPPayloadSize
  766. if maxPacketSize == 0 {
  767. maxPacketSize = protocol.MaxByteCount
  768. }
  769. maxPacketSize = utils.MinByteCount(maxPacketSize, protocol.MaxPacketBufferSize)
  770. // [Psiphon]
  771. if maxPacketSize > protocol.ByteCount(maxPacketSizeAdjustment) {
  772. maxPacketSize -= protocol.ByteCount(maxPacketSizeAdjustment)
  773. }
  774. s.mtuDiscoverer = newMTUDiscoverer(
  775. s.rttStats,
  776. // [Psiphon]
  777. getMaxPacketSize(s.conn.RemoteAddr(), maxPacketSizeAdjustment),
  778. maxPacketSize,
  779. func(size protocol.ByteCount) {
  780. s.sentPacketHandler.SetMaxDatagramSize(size)
  781. s.packer.SetMaxPacketSize(size)
  782. },
  783. )
  784. }
  785. }
  786. func (s *session) handlePacketImpl(rp *receivedPacket) bool {
  787. s.sentPacketHandler.ReceivedBytes(rp.Size())
  788. if wire.IsVersionNegotiationPacket(rp.data) {
  789. s.handleVersionNegotiationPacket(rp)
  790. return false
  791. }
  792. var counter uint8
  793. var lastConnID protocol.ConnectionID
  794. var processed bool
  795. data := rp.data
  796. p := rp
  797. for len(data) > 0 {
  798. if counter > 0 {
  799. p = p.Clone()
  800. p.data = data
  801. }
  802. hdr, packetData, rest, err := wire.ParsePacket(p.data, s.srcConnIDLen)
  803. if err != nil {
  804. if s.tracer != nil {
  805. dropReason := logging.PacketDropHeaderParseError
  806. if err == wire.ErrUnsupportedVersion {
  807. dropReason = logging.PacketDropUnsupportedVersion
  808. }
  809. s.tracer.DroppedPacket(logging.PacketTypeNotDetermined, protocol.ByteCount(len(data)), dropReason)
  810. }
  811. s.logger.Debugf("error parsing packet: %s", err)
  812. break
  813. }
  814. if hdr.IsLongHeader && hdr.Version != s.version {
  815. if s.tracer != nil {
  816. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), protocol.ByteCount(len(data)), logging.PacketDropUnexpectedVersion)
  817. }
  818. s.logger.Debugf("Dropping packet with version %x. Expected %x.", hdr.Version, s.version)
  819. break
  820. }
  821. if counter > 0 && !hdr.DestConnectionID.Equal(lastConnID) {
  822. if s.tracer != nil {
  823. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), protocol.ByteCount(len(data)), logging.PacketDropUnknownConnectionID)
  824. }
  825. s.logger.Debugf("coalesced packet has different destination connection ID: %s, expected %s", hdr.DestConnectionID, lastConnID)
  826. break
  827. }
  828. lastConnID = hdr.DestConnectionID
  829. if counter > 0 {
  830. p.buffer.Split()
  831. }
  832. counter++
  833. // only log if this actually a coalesced packet
  834. if s.logger.Debug() && (counter > 1 || len(rest) > 0) {
  835. s.logger.Debugf("Parsed a coalesced packet. Part %d: %d bytes. Remaining: %d bytes.", counter, len(packetData), len(rest))
  836. }
  837. p.data = packetData
  838. if wasProcessed := s.handleSinglePacket(p, hdr); wasProcessed {
  839. processed = true
  840. }
  841. data = rest
  842. }
  843. p.buffer.MaybeRelease()
  844. return processed
  845. }
  846. func (s *session) handleSinglePacket(p *receivedPacket, hdr *wire.Header) bool /* was the packet successfully processed */ {
  847. var wasQueued bool
  848. defer func() {
  849. // Put back the packet buffer if the packet wasn't queued for later decryption.
  850. if !wasQueued {
  851. p.buffer.Decrement()
  852. }
  853. }()
  854. if hdr.Type == protocol.PacketTypeRetry {
  855. return s.handleRetryPacket(hdr, p.data)
  856. }
  857. // The server can change the source connection ID with the first Handshake packet.
  858. // After this, all packets with a different source connection have to be ignored.
  859. if s.receivedFirstPacket && hdr.IsLongHeader && hdr.Type == protocol.PacketTypeInitial && !hdr.SrcConnectionID.Equal(s.handshakeDestConnID) {
  860. if s.tracer != nil {
  861. s.tracer.DroppedPacket(logging.PacketTypeInitial, p.Size(), logging.PacketDropUnknownConnectionID)
  862. }
  863. s.logger.Debugf("Dropping Initial packet (%d bytes) with unexpected source connection ID: %s (expected %s)", p.Size(), hdr.SrcConnectionID, s.handshakeDestConnID)
  864. return false
  865. }
  866. // drop 0-RTT packets, if we are a client
  867. if s.perspective == protocol.PerspectiveClient && hdr.Type == protocol.PacketType0RTT {
  868. if s.tracer != nil {
  869. s.tracer.DroppedPacket(logging.PacketType0RTT, p.Size(), logging.PacketDropKeyUnavailable)
  870. }
  871. return false
  872. }
  873. packet, err := s.unpacker.Unpack(hdr, p.rcvTime, p.data)
  874. if err != nil {
  875. switch err {
  876. case handshake.ErrKeysDropped:
  877. if s.tracer != nil {
  878. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropKeyUnavailable)
  879. }
  880. s.logger.Debugf("Dropping %s packet (%d bytes) because we already dropped the keys.", hdr.PacketType(), p.Size())
  881. case handshake.ErrKeysNotYetAvailable:
  882. // Sealer for this encryption level not yet available.
  883. // Try again later.
  884. wasQueued = true
  885. s.tryQueueingUndecryptablePacket(p, hdr)
  886. case wire.ErrInvalidReservedBits:
  887. s.closeLocal(&qerr.TransportError{
  888. ErrorCode: qerr.ProtocolViolation,
  889. ErrorMessage: err.Error(),
  890. })
  891. case handshake.ErrDecryptionFailed:
  892. // This might be a packet injected by an attacker. Drop it.
  893. if s.tracer != nil {
  894. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropPayloadDecryptError)
  895. }
  896. s.logger.Debugf("Dropping %s packet (%d bytes) that could not be unpacked. Error: %s", hdr.PacketType(), p.Size(), err)
  897. default:
  898. var headerErr *headerParseError
  899. if errors.As(err, &headerErr) {
  900. // This might be a packet injected by an attacker. Drop it.
  901. if s.tracer != nil {
  902. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropHeaderParseError)
  903. }
  904. s.logger.Debugf("Dropping %s packet (%d bytes) for which we couldn't unpack the header. Error: %s", hdr.PacketType(), p.Size(), err)
  905. } else {
  906. // This is an error returned by the AEAD (other than ErrDecryptionFailed).
  907. // For example, a PROTOCOL_VIOLATION due to key updates.
  908. s.closeLocal(err)
  909. }
  910. }
  911. return false
  912. }
  913. if s.logger.Debug() {
  914. s.logger.Debugf("<- Reading packet %d (%d bytes) for connection %s, %s", packet.packetNumber, p.Size(), hdr.DestConnectionID, packet.encryptionLevel)
  915. packet.hdr.Log(s.logger)
  916. }
  917. if s.receivedPacketHandler.IsPotentiallyDuplicate(packet.packetNumber, packet.encryptionLevel) {
  918. s.logger.Debugf("Dropping (potentially) duplicate packet.")
  919. if s.tracer != nil {
  920. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropDuplicate)
  921. }
  922. return false
  923. }
  924. if err := s.handleUnpackedPacket(packet, p.ecn, p.rcvTime, p.Size()); err != nil {
  925. s.closeLocal(err)
  926. return false
  927. }
  928. return true
  929. }
  930. func (s *session) handleRetryPacket(hdr *wire.Header, data []byte) bool /* was this a valid Retry */ {
  931. if s.perspective == protocol.PerspectiveServer {
  932. if s.tracer != nil {
  933. s.tracer.DroppedPacket(logging.PacketTypeRetry, protocol.ByteCount(len(data)), logging.PacketDropUnexpectedPacket)
  934. }
  935. s.logger.Debugf("Ignoring Retry.")
  936. return false
  937. }
  938. if s.receivedFirstPacket {
  939. if s.tracer != nil {
  940. s.tracer.DroppedPacket(logging.PacketTypeRetry, protocol.ByteCount(len(data)), logging.PacketDropUnexpectedPacket)
  941. }
  942. s.logger.Debugf("Ignoring Retry, since we already received a packet.")
  943. return false
  944. }
  945. destConnID := s.connIDManager.Get()
  946. if hdr.SrcConnectionID.Equal(destConnID) {
  947. if s.tracer != nil {
  948. s.tracer.DroppedPacket(logging.PacketTypeRetry, protocol.ByteCount(len(data)), logging.PacketDropUnexpectedPacket)
  949. }
  950. s.logger.Debugf("Ignoring Retry, since the server didn't change the Source Connection ID.")
  951. return false
  952. }
  953. // If a token is already set, this means that we already received a Retry from the server.
  954. // Ignore this Retry packet.
  955. if s.receivedRetry {
  956. s.logger.Debugf("Ignoring Retry, since a Retry was already received.")
  957. return false
  958. }
  959. tag := handshake.GetRetryIntegrityTag(data[:len(data)-16], destConnID, hdr.Version)
  960. if !bytes.Equal(data[len(data)-16:], tag[:]) {
  961. if s.tracer != nil {
  962. s.tracer.DroppedPacket(logging.PacketTypeRetry, protocol.ByteCount(len(data)), logging.PacketDropPayloadDecryptError)
  963. }
  964. s.logger.Debugf("Ignoring spoofed Retry. Integrity Tag doesn't match.")
  965. return false
  966. }
  967. if s.logger.Debug() {
  968. s.logger.Debugf("<- Received Retry:")
  969. (&wire.ExtendedHeader{Header: *hdr}).Log(s.logger)
  970. s.logger.Debugf("Switching destination connection ID to: %s", hdr.SrcConnectionID)
  971. }
  972. if s.tracer != nil {
  973. s.tracer.ReceivedRetry(hdr)
  974. }
  975. newDestConnID := hdr.SrcConnectionID
  976. s.receivedRetry = true
  977. if err := s.sentPacketHandler.ResetForRetry(); err != nil {
  978. s.closeLocal(err)
  979. return false
  980. }
  981. s.handshakeDestConnID = newDestConnID
  982. s.retrySrcConnID = &newDestConnID
  983. s.cryptoStreamHandler.ChangeConnectionID(newDestConnID)
  984. s.packer.SetToken(hdr.Token)
  985. s.connIDManager.ChangeInitialConnID(newDestConnID)
  986. s.scheduleSending()
  987. return true
  988. }
  989. func (s *session) handleVersionNegotiationPacket(p *receivedPacket) {
  990. if s.perspective == protocol.PerspectiveServer || // servers never receive version negotiation packets
  991. s.receivedFirstPacket || s.versionNegotiated { // ignore delayed / duplicated version negotiation packets
  992. if s.tracer != nil {
  993. s.tracer.DroppedPacket(logging.PacketTypeVersionNegotiation, p.Size(), logging.PacketDropUnexpectedPacket)
  994. }
  995. return
  996. }
  997. hdr, supportedVersions, err := wire.ParseVersionNegotiationPacket(bytes.NewReader(p.data))
  998. if err != nil {
  999. if s.tracer != nil {
  1000. s.tracer.DroppedPacket(logging.PacketTypeVersionNegotiation, p.Size(), logging.PacketDropHeaderParseError)
  1001. }
  1002. s.logger.Debugf("Error parsing Version Negotiation packet: %s", err)
  1003. return
  1004. }
  1005. for _, v := range supportedVersions {
  1006. if v == s.version {
  1007. if s.tracer != nil {
  1008. s.tracer.DroppedPacket(logging.PacketTypeVersionNegotiation, p.Size(), logging.PacketDropUnexpectedVersion)
  1009. }
  1010. // The Version Negotiation packet contains the version that we offered.
  1011. // This might be a packet sent by an attacker, or it was corrupted.
  1012. return
  1013. }
  1014. }
  1015. s.logger.Infof("Received a Version Negotiation packet. Supported Versions: %s", supportedVersions)
  1016. if s.tracer != nil {
  1017. s.tracer.ReceivedVersionNegotiationPacket(hdr, supportedVersions)
  1018. }
  1019. newVersion, ok := protocol.ChooseSupportedVersion(s.config.Versions, supportedVersions)
  1020. if !ok {
  1021. s.destroyImpl(&VersionNegotiationError{
  1022. Ours: s.config.Versions,
  1023. Theirs: supportedVersions,
  1024. })
  1025. s.logger.Infof("No compatible QUIC version found.")
  1026. return
  1027. }
  1028. if s.tracer != nil {
  1029. s.tracer.NegotiatedVersion(newVersion, s.config.Versions, supportedVersions)
  1030. }
  1031. s.logger.Infof("Switching to QUIC version %s.", newVersion)
  1032. nextPN, _ := s.sentPacketHandler.PeekPacketNumber(protocol.EncryptionInitial)
  1033. s.destroyImpl(&errCloseForRecreating{
  1034. nextPacketNumber: nextPN,
  1035. nextVersion: newVersion,
  1036. })
  1037. }
  1038. func (s *session) handleUnpackedPacket(
  1039. packet *unpackedPacket,
  1040. ecn protocol.ECN,
  1041. rcvTime time.Time,
  1042. packetSize protocol.ByteCount, // only for logging
  1043. ) error {
  1044. if len(packet.data) == 0 {
  1045. return &qerr.TransportError{
  1046. ErrorCode: qerr.ProtocolViolation,
  1047. ErrorMessage: "empty packet",
  1048. }
  1049. }
  1050. if !s.receivedFirstPacket {
  1051. s.receivedFirstPacket = true
  1052. if !s.versionNegotiated && s.tracer != nil {
  1053. var clientVersions, serverVersions []protocol.VersionNumber
  1054. switch s.perspective {
  1055. case protocol.PerspectiveClient:
  1056. clientVersions = s.config.Versions
  1057. case protocol.PerspectiveServer:
  1058. serverVersions = s.config.Versions
  1059. }
  1060. s.tracer.NegotiatedVersion(s.version, clientVersions, serverVersions)
  1061. }
  1062. // The server can change the source connection ID with the first Handshake packet.
  1063. if s.perspective == protocol.PerspectiveClient && packet.hdr.IsLongHeader && !packet.hdr.SrcConnectionID.Equal(s.handshakeDestConnID) {
  1064. cid := packet.hdr.SrcConnectionID
  1065. s.logger.Debugf("Received first packet. Switching destination connection ID to: %s", cid)
  1066. s.handshakeDestConnID = cid
  1067. s.connIDManager.ChangeInitialConnID(cid)
  1068. }
  1069. // We create the session as soon as we receive the first packet from the client.
  1070. // We do that before authenticating the packet.
  1071. // That means that if the source connection ID was corrupted,
  1072. // we might have create a session with an incorrect source connection ID.
  1073. // Once we authenticate the first packet, we need to update it.
  1074. if s.perspective == protocol.PerspectiveServer {
  1075. if !packet.hdr.SrcConnectionID.Equal(s.handshakeDestConnID) {
  1076. s.handshakeDestConnID = packet.hdr.SrcConnectionID
  1077. s.connIDManager.ChangeInitialConnID(packet.hdr.SrcConnectionID)
  1078. }
  1079. if s.tracer != nil {
  1080. s.tracer.StartedConnection(
  1081. s.conn.LocalAddr(),
  1082. s.conn.RemoteAddr(),
  1083. packet.hdr.SrcConnectionID,
  1084. packet.hdr.DestConnectionID,
  1085. )
  1086. }
  1087. }
  1088. }
  1089. s.lastPacketReceivedTime = rcvTime
  1090. s.firstAckElicitingPacketAfterIdleSentTime = time.Time{}
  1091. s.keepAlivePingSent = false
  1092. // Only used for tracing.
  1093. // If we're not tracing, this slice will always remain empty.
  1094. var frames []wire.Frame
  1095. r := bytes.NewReader(packet.data)
  1096. var isAckEliciting bool
  1097. for {
  1098. frame, err := s.frameParser.ParseNext(r, packet.encryptionLevel)
  1099. if err != nil {
  1100. return err
  1101. }
  1102. if frame == nil {
  1103. break
  1104. }
  1105. if ackhandler.IsFrameAckEliciting(frame) {
  1106. isAckEliciting = true
  1107. }
  1108. // Only process frames now if we're not logging.
  1109. // If we're logging, we need to make sure that the packet_received event is logged first.
  1110. if s.tracer == nil {
  1111. if err := s.handleFrame(frame, packet.encryptionLevel, packet.hdr.DestConnectionID); err != nil {
  1112. return err
  1113. }
  1114. } else {
  1115. frames = append(frames, frame)
  1116. }
  1117. }
  1118. if s.tracer != nil {
  1119. fs := make([]logging.Frame, len(frames))
  1120. for i, frame := range frames {
  1121. fs[i] = logutils.ConvertFrame(frame)
  1122. }
  1123. s.tracer.ReceivedPacket(packet.hdr, packetSize, fs)
  1124. for _, frame := range frames {
  1125. if err := s.handleFrame(frame, packet.encryptionLevel, packet.hdr.DestConnectionID); err != nil {
  1126. return err
  1127. }
  1128. }
  1129. }
  1130. return s.receivedPacketHandler.ReceivedPacket(packet.packetNumber, ecn, packet.encryptionLevel, rcvTime, isAckEliciting)
  1131. }
  1132. func (s *session) handleFrame(f wire.Frame, encLevel protocol.EncryptionLevel, destConnID protocol.ConnectionID) error {
  1133. var err error
  1134. wire.LogFrame(s.logger, f, false)
  1135. switch frame := f.(type) {
  1136. case *wire.CryptoFrame:
  1137. err = s.handleCryptoFrame(frame, encLevel)
  1138. case *wire.StreamFrame:
  1139. err = s.handleStreamFrame(frame)
  1140. case *wire.AckFrame:
  1141. err = s.handleAckFrame(frame, encLevel)
  1142. case *wire.ConnectionCloseFrame:
  1143. s.handleConnectionCloseFrame(frame)
  1144. case *wire.ResetStreamFrame:
  1145. err = s.handleResetStreamFrame(frame)
  1146. case *wire.MaxDataFrame:
  1147. s.handleMaxDataFrame(frame)
  1148. case *wire.MaxStreamDataFrame:
  1149. err = s.handleMaxStreamDataFrame(frame)
  1150. case *wire.MaxStreamsFrame:
  1151. s.handleMaxStreamsFrame(frame)
  1152. case *wire.DataBlockedFrame:
  1153. case *wire.StreamDataBlockedFrame:
  1154. case *wire.StreamsBlockedFrame:
  1155. case *wire.StopSendingFrame:
  1156. err = s.handleStopSendingFrame(frame)
  1157. case *wire.PingFrame:
  1158. case *wire.PathChallengeFrame:
  1159. s.handlePathChallengeFrame(frame)
  1160. case *wire.PathResponseFrame:
  1161. // since we don't send PATH_CHALLENGEs, we don't expect PATH_RESPONSEs
  1162. err = errors.New("unexpected PATH_RESPONSE frame")
  1163. case *wire.NewTokenFrame:
  1164. err = s.handleNewTokenFrame(frame)
  1165. case *wire.NewConnectionIDFrame:
  1166. err = s.handleNewConnectionIDFrame(frame)
  1167. case *wire.RetireConnectionIDFrame:
  1168. err = s.handleRetireConnectionIDFrame(frame, destConnID)
  1169. case *wire.HandshakeDoneFrame:
  1170. err = s.handleHandshakeDoneFrame()
  1171. case *wire.DatagramFrame:
  1172. err = s.handleDatagramFrame(frame)
  1173. default:
  1174. err = fmt.Errorf("unexpected frame type: %s", reflect.ValueOf(&frame).Elem().Type().Name())
  1175. }
  1176. return err
  1177. }
  1178. // handlePacket is called by the server with a new packet
  1179. func (s *session) handlePacket(p *receivedPacket) {
  1180. // Discard packets once the amount of queued packets is larger than
  1181. // the channel size, protocol.MaxSessionUnprocessedPackets
  1182. select {
  1183. case s.receivedPackets <- p:
  1184. default:
  1185. if s.tracer != nil {
  1186. s.tracer.DroppedPacket(logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropDOSPrevention)
  1187. }
  1188. }
  1189. }
  1190. func (s *session) handleConnectionCloseFrame(frame *wire.ConnectionCloseFrame) {
  1191. if frame.IsApplicationError {
  1192. s.closeRemote(&qerr.ApplicationError{
  1193. Remote: true,
  1194. ErrorCode: qerr.ApplicationErrorCode(frame.ErrorCode),
  1195. ErrorMessage: frame.ReasonPhrase,
  1196. })
  1197. return
  1198. }
  1199. s.closeRemote(&qerr.TransportError{
  1200. Remote: true,
  1201. ErrorCode: qerr.TransportErrorCode(frame.ErrorCode),
  1202. FrameType: frame.FrameType,
  1203. ErrorMessage: frame.ReasonPhrase,
  1204. })
  1205. }
  1206. func (s *session) handleCryptoFrame(frame *wire.CryptoFrame, encLevel protocol.EncryptionLevel) error {
  1207. encLevelChanged, err := s.cryptoStreamManager.HandleCryptoFrame(frame, encLevel)
  1208. if err != nil {
  1209. return err
  1210. }
  1211. if encLevelChanged {
  1212. // Queue all packets for decryption that have been undecryptable so far.
  1213. s.undecryptablePacketsToProcess = s.undecryptablePackets
  1214. s.undecryptablePackets = nil
  1215. }
  1216. return nil
  1217. }
  1218. func (s *session) handleStreamFrame(frame *wire.StreamFrame) error {
  1219. str, err := s.streamsMap.GetOrOpenReceiveStream(frame.StreamID)
  1220. if err != nil {
  1221. return err
  1222. }
  1223. if str == nil {
  1224. // Stream is closed and already garbage collected
  1225. // ignore this StreamFrame
  1226. return nil
  1227. }
  1228. return str.handleStreamFrame(frame)
  1229. }
  1230. func (s *session) handleMaxDataFrame(frame *wire.MaxDataFrame) {
  1231. s.connFlowController.UpdateSendWindow(frame.MaximumData)
  1232. }
  1233. func (s *session) handleMaxStreamDataFrame(frame *wire.MaxStreamDataFrame) error {
  1234. str, err := s.streamsMap.GetOrOpenSendStream(frame.StreamID)
  1235. if err != nil {
  1236. return err
  1237. }
  1238. if str == nil {
  1239. // stream is closed and already garbage collected
  1240. return nil
  1241. }
  1242. str.updateSendWindow(frame.MaximumStreamData)
  1243. return nil
  1244. }
  1245. func (s *session) handleMaxStreamsFrame(frame *wire.MaxStreamsFrame) {
  1246. s.streamsMap.HandleMaxStreamsFrame(frame)
  1247. }
  1248. func (s *session) handleResetStreamFrame(frame *wire.ResetStreamFrame) error {
  1249. str, err := s.streamsMap.GetOrOpenReceiveStream(frame.StreamID)
  1250. if err != nil {
  1251. return err
  1252. }
  1253. if str == nil {
  1254. // stream is closed and already garbage collected
  1255. return nil
  1256. }
  1257. return str.handleResetStreamFrame(frame)
  1258. }
  1259. func (s *session) handleStopSendingFrame(frame *wire.StopSendingFrame) error {
  1260. str, err := s.streamsMap.GetOrOpenSendStream(frame.StreamID)
  1261. if err != nil {
  1262. return err
  1263. }
  1264. if str == nil {
  1265. // stream is closed and already garbage collected
  1266. return nil
  1267. }
  1268. str.handleStopSendingFrame(frame)
  1269. return nil
  1270. }
  1271. func (s *session) handlePathChallengeFrame(frame *wire.PathChallengeFrame) {
  1272. s.queueControlFrame(&wire.PathResponseFrame{Data: frame.Data})
  1273. }
  1274. func (s *session) handleNewTokenFrame(frame *wire.NewTokenFrame) error {
  1275. if s.perspective == protocol.PerspectiveServer {
  1276. return &qerr.TransportError{
  1277. ErrorCode: qerr.ProtocolViolation,
  1278. ErrorMessage: "received NEW_TOKEN frame from the client",
  1279. }
  1280. }
  1281. if s.config.TokenStore != nil {
  1282. s.config.TokenStore.Put(s.tokenStoreKey, &ClientToken{data: frame.Token})
  1283. }
  1284. return nil
  1285. }
  1286. func (s *session) handleNewConnectionIDFrame(f *wire.NewConnectionIDFrame) error {
  1287. return s.connIDManager.Add(f)
  1288. }
  1289. func (s *session) handleRetireConnectionIDFrame(f *wire.RetireConnectionIDFrame, destConnID protocol.ConnectionID) error {
  1290. return s.connIDGenerator.Retire(f.SequenceNumber, destConnID)
  1291. }
  1292. func (s *session) handleHandshakeDoneFrame() error {
  1293. if s.perspective == protocol.PerspectiveServer {
  1294. return &qerr.TransportError{
  1295. ErrorCode: qerr.ProtocolViolation,
  1296. ErrorMessage: "received a HANDSHAKE_DONE frame",
  1297. }
  1298. }
  1299. if !s.handshakeConfirmed {
  1300. s.handleHandshakeConfirmed()
  1301. }
  1302. return nil
  1303. }
  1304. func (s *session) handleAckFrame(frame *wire.AckFrame, encLevel protocol.EncryptionLevel) error {
  1305. acked1RTTPacket, err := s.sentPacketHandler.ReceivedAck(frame, encLevel, s.lastPacketReceivedTime)
  1306. if err != nil {
  1307. return err
  1308. }
  1309. if !acked1RTTPacket {
  1310. return nil
  1311. }
  1312. if s.perspective == protocol.PerspectiveClient && !s.handshakeConfirmed {
  1313. s.handleHandshakeConfirmed()
  1314. }
  1315. return s.cryptoStreamHandler.SetLargest1RTTAcked(frame.LargestAcked())
  1316. }
  1317. func (s *session) handleDatagramFrame(f *wire.DatagramFrame) error {
  1318. if f.Length(s.version) > protocol.MaxDatagramFrameSize {
  1319. return &qerr.TransportError{
  1320. ErrorCode: qerr.ProtocolViolation,
  1321. ErrorMessage: "DATAGRAM frame too large",
  1322. }
  1323. }
  1324. s.datagramQueue.HandleDatagramFrame(f)
  1325. return nil
  1326. }
  1327. // closeLocal closes the session and send a CONNECTION_CLOSE containing the error
  1328. func (s *session) closeLocal(e error) {
  1329. s.closeOnce.Do(func() {
  1330. if e == nil {
  1331. s.logger.Infof("Closing session.")
  1332. } else {
  1333. s.logger.Errorf("Closing session with error: %s", e)
  1334. }
  1335. s.closeChan <- closeError{err: e, immediate: false, remote: false}
  1336. })
  1337. }
  1338. // destroy closes the session without sending the error on the wire
  1339. func (s *session) destroy(e error) {
  1340. s.destroyImpl(e)
  1341. <-s.ctx.Done()
  1342. }
  1343. func (s *session) destroyImpl(e error) {
  1344. s.closeOnce.Do(func() {
  1345. if nerr, ok := e.(net.Error); ok && nerr.Timeout() {
  1346. s.logger.Errorf("Destroying session: %s", e)
  1347. } else {
  1348. s.logger.Errorf("Destroying session with error: %s", e)
  1349. }
  1350. s.closeChan <- closeError{err: e, immediate: true, remote: false}
  1351. })
  1352. }
  1353. func (s *session) closeRemote(e error) {
  1354. s.closeOnce.Do(func() {
  1355. s.logger.Errorf("Peer closed session with error: %s", e)
  1356. s.closeChan <- closeError{err: e, immediate: true, remote: true}
  1357. })
  1358. }
  1359. // Close the connection. It sends a NO_ERROR application error.
  1360. // It waits until the run loop has stopped before returning
  1361. func (s *session) shutdown() {
  1362. s.closeLocal(nil)
  1363. <-s.ctx.Done()
  1364. }
  1365. func (s *session) CloseWithError(code ApplicationErrorCode, desc string) error {
  1366. s.closeLocal(&qerr.ApplicationError{
  1367. ErrorCode: code,
  1368. ErrorMessage: desc,
  1369. })
  1370. <-s.ctx.Done()
  1371. return nil
  1372. }
  1373. func (s *session) handleCloseError(closeErr *closeError) {
  1374. e := closeErr.err
  1375. if e == nil {
  1376. e = &qerr.ApplicationError{}
  1377. } else {
  1378. defer func() {
  1379. closeErr.err = e
  1380. }()
  1381. }
  1382. var (
  1383. statelessResetErr *StatelessResetError
  1384. versionNegotiationErr *VersionNegotiationError
  1385. recreateErr *errCloseForRecreating
  1386. applicationErr *ApplicationError
  1387. transportErr *TransportError
  1388. )
  1389. switch {
  1390. case errors.Is(e, qerr.ErrIdleTimeout),
  1391. errors.Is(e, qerr.ErrHandshakeTimeout),
  1392. errors.As(e, &statelessResetErr),
  1393. errors.As(e, &versionNegotiationErr),
  1394. errors.As(e, &recreateErr),
  1395. errors.As(e, &applicationErr),
  1396. errors.As(e, &transportErr):
  1397. default:
  1398. e = &qerr.TransportError{
  1399. ErrorCode: qerr.InternalError,
  1400. ErrorMessage: e.Error(),
  1401. }
  1402. }
  1403. s.streamsMap.CloseWithError(e)
  1404. s.connIDManager.Close()
  1405. if s.datagramQueue != nil {
  1406. s.datagramQueue.CloseWithError(e)
  1407. }
  1408. if s.tracer != nil && !errors.As(e, &recreateErr) {
  1409. s.tracer.ClosedConnection(e)
  1410. }
  1411. // If this is a remote close we're done here
  1412. if closeErr.remote {
  1413. s.connIDGenerator.ReplaceWithClosed(newClosedRemoteSession(s.perspective))
  1414. return
  1415. }
  1416. if closeErr.immediate {
  1417. s.connIDGenerator.RemoveAll()
  1418. return
  1419. }
  1420. connClosePacket, err := s.sendConnectionClose(e)
  1421. if err != nil {
  1422. s.logger.Debugf("Error sending CONNECTION_CLOSE: %s", err)
  1423. }
  1424. cs := newClosedLocalSession(s.conn, connClosePacket, s.perspective, s.logger)
  1425. s.connIDGenerator.ReplaceWithClosed(cs)
  1426. }
  1427. func (s *session) dropEncryptionLevel(encLevel protocol.EncryptionLevel) {
  1428. s.sentPacketHandler.DropPackets(encLevel)
  1429. s.receivedPacketHandler.DropPackets(encLevel)
  1430. if s.tracer != nil {
  1431. s.tracer.DroppedEncryptionLevel(encLevel)
  1432. }
  1433. if encLevel == protocol.Encryption0RTT {
  1434. s.streamsMap.ResetFor0RTT()
  1435. if err := s.connFlowController.Reset(); err != nil {
  1436. s.closeLocal(err)
  1437. }
  1438. if err := s.framer.Handle0RTTRejection(); err != nil {
  1439. s.closeLocal(err)
  1440. }
  1441. }
  1442. }
  1443. // is called for the client, when restoring transport parameters saved for 0-RTT
  1444. func (s *session) restoreTransportParameters(params *wire.TransportParameters) {
  1445. if s.logger.Debug() {
  1446. s.logger.Debugf("Restoring Transport Parameters: %s", params)
  1447. }
  1448. s.peerParams = params
  1449. s.connIDGenerator.SetMaxActiveConnIDs(params.ActiveConnectionIDLimit)
  1450. s.connFlowController.UpdateSendWindow(params.InitialMaxData)
  1451. s.streamsMap.UpdateLimits(params)
  1452. }
  1453. func (s *session) handleTransportParameters(params *wire.TransportParameters) {
  1454. if err := s.checkTransportParameters(params); err != nil {
  1455. s.closeLocal(&qerr.TransportError{
  1456. ErrorCode: qerr.TransportParameterError,
  1457. ErrorMessage: err.Error(),
  1458. })
  1459. }
  1460. s.peerParams = params
  1461. // On the client side we have to wait for handshake completion.
  1462. // During a 0-RTT connection, we are only allowed to use the new transport parameters for 1-RTT packets.
  1463. if s.perspective == protocol.PerspectiveServer {
  1464. s.applyTransportParameters()
  1465. // On the server side, the early session is ready as soon as we processed
  1466. // the client's transport parameters.
  1467. close(s.earlySessionReadyChan)
  1468. }
  1469. }
  1470. func (s *session) checkTransportParameters(params *wire.TransportParameters) error {
  1471. if s.logger.Debug() {
  1472. s.logger.Debugf("Processed Transport Parameters: %s", params)
  1473. }
  1474. if s.tracer != nil {
  1475. s.tracer.ReceivedTransportParameters(params)
  1476. }
  1477. // check the initial_source_connection_id
  1478. if !params.InitialSourceConnectionID.Equal(s.handshakeDestConnID) {
  1479. return fmt.Errorf("expected initial_source_connection_id to equal %s, is %s", s.handshakeDestConnID, params.InitialSourceConnectionID)
  1480. }
  1481. if s.perspective == protocol.PerspectiveServer {
  1482. return nil
  1483. }
  1484. // check the original_destination_connection_id
  1485. if !params.OriginalDestinationConnectionID.Equal(s.origDestConnID) {
  1486. return fmt.Errorf("expected original_destination_connection_id to equal %s, is %s", s.origDestConnID, params.OriginalDestinationConnectionID)
  1487. }
  1488. if s.retrySrcConnID != nil { // a Retry was performed
  1489. if params.RetrySourceConnectionID == nil {
  1490. return errors.New("missing retry_source_connection_id")
  1491. }
  1492. if !(*params.RetrySourceConnectionID).Equal(*s.retrySrcConnID) {
  1493. return fmt.Errorf("expected retry_source_connection_id to equal %s, is %s", s.retrySrcConnID, *params.RetrySourceConnectionID)
  1494. }
  1495. } else if params.RetrySourceConnectionID != nil {
  1496. return errors.New("received retry_source_connection_id, although no Retry was performed")
  1497. }
  1498. return nil
  1499. }
  1500. func (s *session) applyTransportParameters() {
  1501. params := s.peerParams
  1502. // Our local idle timeout will always be > 0.
  1503. s.idleTimeout = utils.MinNonZeroDuration(s.config.MaxIdleTimeout, params.MaxIdleTimeout)
  1504. s.keepAliveInterval = utils.MinDuration(s.idleTimeout/2, protocol.MaxKeepAliveInterval)
  1505. s.streamsMap.UpdateLimits(params)
  1506. s.packer.HandleTransportParameters(params)
  1507. s.frameParser.SetAckDelayExponent(params.AckDelayExponent)
  1508. s.connFlowController.UpdateSendWindow(params.InitialMaxData)
  1509. s.rttStats.SetMaxAckDelay(params.MaxAckDelay)
  1510. s.connIDGenerator.SetMaxActiveConnIDs(params.ActiveConnectionIDLimit)
  1511. if params.StatelessResetToken != nil {
  1512. s.connIDManager.SetStatelessResetToken(*params.StatelessResetToken)
  1513. }
  1514. // We don't support connection migration yet, so we don't have any use for the preferred_address.
  1515. if params.PreferredAddress != nil {
  1516. // Retire the connection ID.
  1517. s.connIDManager.AddFromPreferredAddress(params.PreferredAddress.ConnectionID, params.PreferredAddress.StatelessResetToken)
  1518. }
  1519. }
  1520. func (s *session) sendPackets() error {
  1521. s.pacingDeadline = time.Time{}
  1522. var sentPacket bool // only used in for packets sent in send mode SendAny
  1523. for {
  1524. sendMode := s.sentPacketHandler.SendMode()
  1525. if sendMode == ackhandler.SendAny && s.handshakeComplete && !s.sentPacketHandler.HasPacingBudget() {
  1526. deadline := s.sentPacketHandler.TimeUntilSend()
  1527. if deadline.IsZero() {
  1528. deadline = deadlineSendImmediately
  1529. }
  1530. s.pacingDeadline = deadline
  1531. // Allow sending of an ACK if we're pacing limit (if we haven't sent out a packet yet).
  1532. // This makes sure that a peer that is mostly receiving data (and thus has an inaccurate cwnd estimate)
  1533. // sends enough ACKs to allow its peer to utilize the bandwidth.
  1534. if sentPacket {
  1535. return nil
  1536. }
  1537. sendMode = ackhandler.SendAck
  1538. }
  1539. switch sendMode {
  1540. case ackhandler.SendNone:
  1541. return nil
  1542. case ackhandler.SendAck:
  1543. // If we already sent packets, and the send mode switches to SendAck,
  1544. // as we've just become congestion limited.
  1545. // There's no need to try to send an ACK at this moment.
  1546. if sentPacket {
  1547. return nil
  1548. }
  1549. // We can at most send a single ACK only packet.
  1550. // There will only be a new ACK after receiving new packets.
  1551. // SendAck is only returned when we're congestion limited, so we don't need to set the pacingt timer.
  1552. return s.maybeSendAckOnlyPacket()
  1553. case ackhandler.SendPTOInitial:
  1554. if err := s.sendProbePacket(protocol.EncryptionInitial); err != nil {
  1555. return err
  1556. }
  1557. case ackhandler.SendPTOHandshake:
  1558. if err := s.sendProbePacket(protocol.EncryptionHandshake); err != nil {
  1559. return err
  1560. }
  1561. case ackhandler.SendPTOAppData:
  1562. if err := s.sendProbePacket(protocol.Encryption1RTT); err != nil {
  1563. return err
  1564. }
  1565. case ackhandler.SendAny:
  1566. sent, err := s.sendPacket()
  1567. if err != nil || !sent {
  1568. return err
  1569. }
  1570. sentPacket = true
  1571. default:
  1572. return fmt.Errorf("BUG: invalid send mode %d", sendMode)
  1573. }
  1574. // Prioritize receiving of packets over sending out more packets.
  1575. if len(s.receivedPackets) > 0 {
  1576. s.pacingDeadline = deadlineSendImmediately
  1577. return nil
  1578. }
  1579. if s.sendQueue.WouldBlock() {
  1580. return nil
  1581. }
  1582. }
  1583. }
  1584. func (s *session) maybeSendAckOnlyPacket() error {
  1585. packet, err := s.packer.MaybePackAckPacket(s.handshakeConfirmed)
  1586. if err != nil {
  1587. return err
  1588. }
  1589. if packet == nil {
  1590. return nil
  1591. }
  1592. s.sendPackedPacket(packet, time.Now())
  1593. return nil
  1594. }
  1595. func (s *session) sendProbePacket(encLevel protocol.EncryptionLevel) error {
  1596. // Queue probe packets until we actually send out a packet,
  1597. // or until there are no more packets to queue.
  1598. var packet *packedPacket
  1599. for {
  1600. if wasQueued := s.sentPacketHandler.QueueProbePacket(encLevel); !wasQueued {
  1601. break
  1602. }
  1603. var err error
  1604. packet, err = s.packer.MaybePackProbePacket(encLevel)
  1605. if err != nil {
  1606. return err
  1607. }
  1608. if packet != nil {
  1609. break
  1610. }
  1611. }
  1612. if packet == nil {
  1613. //nolint:exhaustive // Cannot send probe packets for 0-RTT.
  1614. switch encLevel {
  1615. case protocol.EncryptionInitial:
  1616. s.retransmissionQueue.AddInitial(&wire.PingFrame{})
  1617. case protocol.EncryptionHandshake:
  1618. s.retransmissionQueue.AddHandshake(&wire.PingFrame{})
  1619. case protocol.Encryption1RTT:
  1620. s.retransmissionQueue.AddAppData(&wire.PingFrame{})
  1621. default:
  1622. panic("unexpected encryption level")
  1623. }
  1624. var err error
  1625. packet, err = s.packer.MaybePackProbePacket(encLevel)
  1626. if err != nil {
  1627. return err
  1628. }
  1629. }
  1630. if packet == nil || packet.packetContents == nil {
  1631. return fmt.Errorf("session BUG: couldn't pack %s probe packet", encLevel)
  1632. }
  1633. s.sendPackedPacket(packet, time.Now())
  1634. return nil
  1635. }
  1636. func (s *session) sendPacket() (bool, error) {
  1637. if isBlocked, offset := s.connFlowController.IsNewlyBlocked(); isBlocked {
  1638. s.framer.QueueControlFrame(&wire.DataBlockedFrame{MaximumData: offset})
  1639. }
  1640. s.windowUpdateQueue.QueueAll()
  1641. now := time.Now()
  1642. if !s.handshakeConfirmed {
  1643. packet, err := s.packer.PackCoalescedPacket()
  1644. if err != nil || packet == nil {
  1645. return false, err
  1646. }
  1647. s.logCoalescedPacket(packet)
  1648. for _, p := range packet.packets {
  1649. if s.firstAckElicitingPacketAfterIdleSentTime.IsZero() && p.IsAckEliciting() {
  1650. s.firstAckElicitingPacketAfterIdleSentTime = now
  1651. }
  1652. s.sentPacketHandler.SentPacket(p.ToAckHandlerPacket(now, s.retransmissionQueue))
  1653. }
  1654. s.connIDManager.SentPacket()
  1655. s.sendQueue.Send(packet.buffer)
  1656. return true, nil
  1657. }
  1658. if !s.config.DisablePathMTUDiscovery && s.mtuDiscoverer.ShouldSendProbe(now) {
  1659. packet, err := s.packer.PackMTUProbePacket(s.mtuDiscoverer.GetPing())
  1660. if err != nil {
  1661. return false, err
  1662. }
  1663. s.sendPackedPacket(packet, now)
  1664. return true, nil
  1665. }
  1666. packet, err := s.packer.PackPacket()
  1667. if err != nil || packet == nil {
  1668. return false, err
  1669. }
  1670. s.sendPackedPacket(packet, now)
  1671. return true, nil
  1672. }
  1673. func (s *session) sendPackedPacket(packet *packedPacket, now time.Time) {
  1674. if s.firstAckElicitingPacketAfterIdleSentTime.IsZero() && packet.IsAckEliciting() {
  1675. s.firstAckElicitingPacketAfterIdleSentTime = now
  1676. }
  1677. s.logPacket(packet)
  1678. s.sentPacketHandler.SentPacket(packet.ToAckHandlerPacket(now, s.retransmissionQueue))
  1679. s.connIDManager.SentPacket()
  1680. s.sendQueue.Send(packet.buffer)
  1681. }
  1682. func (s *session) sendConnectionClose(e error) ([]byte, error) {
  1683. var packet *coalescedPacket
  1684. var err error
  1685. var transportErr *qerr.TransportError
  1686. var applicationErr *qerr.ApplicationError
  1687. if errors.As(e, &transportErr) {
  1688. packet, err = s.packer.PackConnectionClose(transportErr)
  1689. } else if errors.As(e, &applicationErr) {
  1690. packet, err = s.packer.PackApplicationClose(applicationErr)
  1691. } else {
  1692. packet, err = s.packer.PackConnectionClose(&qerr.TransportError{
  1693. ErrorCode: qerr.InternalError,
  1694. ErrorMessage: fmt.Sprintf("session BUG: unspecified error type (msg: %s)", e.Error()),
  1695. })
  1696. }
  1697. if err != nil {
  1698. return nil, err
  1699. }
  1700. s.logCoalescedPacket(packet)
  1701. return packet.buffer.Data, s.conn.Write(packet.buffer.Data)
  1702. }
  1703. func (s *session) logPacketContents(p *packetContents) {
  1704. // tracing
  1705. if s.tracer != nil {
  1706. frames := make([]logging.Frame, 0, len(p.frames))
  1707. for _, f := range p.frames {
  1708. frames = append(frames, logutils.ConvertFrame(f.Frame))
  1709. }
  1710. s.tracer.SentPacket(p.header, p.length, p.ack, frames)
  1711. }
  1712. // quic-go logging
  1713. if !s.logger.Debug() {
  1714. return
  1715. }
  1716. p.header.Log(s.logger)
  1717. if p.ack != nil {
  1718. wire.LogFrame(s.logger, p.ack, true)
  1719. }
  1720. for _, frame := range p.frames {
  1721. wire.LogFrame(s.logger, frame.Frame, true)
  1722. }
  1723. }
  1724. func (s *session) logCoalescedPacket(packet *coalescedPacket) {
  1725. if s.logger.Debug() {
  1726. if len(packet.packets) > 1 {
  1727. s.logger.Debugf("-> Sending coalesced packet (%d parts, %d bytes) for connection %s", len(packet.packets), packet.buffer.Len(), s.logID)
  1728. } else {
  1729. s.logger.Debugf("-> Sending packet %d (%d bytes) for connection %s, %s", packet.packets[0].header.PacketNumber, packet.buffer.Len(), s.logID, packet.packets[0].EncryptionLevel())
  1730. }
  1731. }
  1732. for _, p := range packet.packets {
  1733. s.logPacketContents(p)
  1734. }
  1735. }
  1736. func (s *session) logPacket(packet *packedPacket) {
  1737. if s.logger.Debug() {
  1738. s.logger.Debugf("-> Sending packet %d (%d bytes) for connection %s, %s", packet.header.PacketNumber, packet.buffer.Len(), s.logID, packet.EncryptionLevel())
  1739. }
  1740. s.logPacketContents(packet.packetContents)
  1741. }
  1742. // AcceptStream returns the next stream openend by the peer
  1743. func (s *session) AcceptStream(ctx context.Context) (Stream, error) {
  1744. return s.streamsMap.AcceptStream(ctx)
  1745. }
  1746. func (s *session) AcceptUniStream(ctx context.Context) (ReceiveStream, error) {
  1747. return s.streamsMap.AcceptUniStream(ctx)
  1748. }
  1749. // OpenStream opens a stream
  1750. func (s *session) OpenStream() (Stream, error) {
  1751. return s.streamsMap.OpenStream()
  1752. }
  1753. func (s *session) OpenStreamSync(ctx context.Context) (Stream, error) {
  1754. return s.streamsMap.OpenStreamSync(ctx)
  1755. }
  1756. func (s *session) OpenUniStream() (SendStream, error) {
  1757. return s.streamsMap.OpenUniStream()
  1758. }
  1759. func (s *session) OpenUniStreamSync(ctx context.Context) (SendStream, error) {
  1760. return s.streamsMap.OpenUniStreamSync(ctx)
  1761. }
  1762. func (s *session) newFlowController(id protocol.StreamID) flowcontrol.StreamFlowController {
  1763. initialSendWindow := s.peerParams.InitialMaxStreamDataUni
  1764. if id.Type() == protocol.StreamTypeBidi {
  1765. if id.InitiatedBy() == s.perspective {
  1766. initialSendWindow = s.peerParams.InitialMaxStreamDataBidiRemote
  1767. } else {
  1768. initialSendWindow = s.peerParams.InitialMaxStreamDataBidiLocal
  1769. }
  1770. }
  1771. return flowcontrol.NewStreamFlowController(
  1772. id,
  1773. s.connFlowController,
  1774. protocol.ByteCount(s.config.InitialStreamReceiveWindow),
  1775. protocol.ByteCount(s.config.MaxStreamReceiveWindow),
  1776. initialSendWindow,
  1777. s.onHasStreamWindowUpdate,
  1778. s.rttStats,
  1779. s.logger,
  1780. )
  1781. }
  1782. // scheduleSending signals that we have data for sending
  1783. func (s *session) scheduleSending() {
  1784. select {
  1785. case s.sendingScheduled <- struct{}{}:
  1786. default:
  1787. }
  1788. }
  1789. func (s *session) tryQueueingUndecryptablePacket(p *receivedPacket, hdr *wire.Header) {
  1790. if s.handshakeComplete {
  1791. panic("shouldn't queue undecryptable packets after handshake completion")
  1792. }
  1793. if len(s.undecryptablePackets)+1 > protocol.MaxUndecryptablePackets {
  1794. if s.tracer != nil {
  1795. s.tracer.DroppedPacket(logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropDOSPrevention)
  1796. }
  1797. s.logger.Infof("Dropping undecryptable packet (%d bytes). Undecryptable packet queue full.", p.Size())
  1798. return
  1799. }
  1800. s.logger.Infof("Queueing packet (%d bytes) for later decryption", p.Size())
  1801. if s.tracer != nil {
  1802. s.tracer.BufferedPacket(logging.PacketTypeFromHeader(hdr))
  1803. }
  1804. s.undecryptablePackets = append(s.undecryptablePackets, p)
  1805. }
  1806. func (s *session) queueControlFrame(f wire.Frame) {
  1807. s.framer.QueueControlFrame(f)
  1808. s.scheduleSending()
  1809. }
  1810. func (s *session) onHasStreamWindowUpdate(id protocol.StreamID) {
  1811. s.windowUpdateQueue.AddStream(id)
  1812. s.scheduleSending()
  1813. }
  1814. func (s *session) onHasConnectionWindowUpdate() {
  1815. s.windowUpdateQueue.AddConnection()
  1816. s.scheduleSending()
  1817. }
  1818. func (s *session) onHasStreamData(id protocol.StreamID) {
  1819. s.framer.AddActiveStream(id)
  1820. s.scheduleSending()
  1821. }
  1822. func (s *session) onStreamCompleted(id protocol.StreamID) {
  1823. if err := s.streamsMap.DeleteStream(id); err != nil {
  1824. s.closeLocal(err)
  1825. }
  1826. }
  1827. func (s *session) SendMessage(p []byte) error {
  1828. f := &wire.DatagramFrame{DataLenPresent: true}
  1829. if protocol.ByteCount(len(p)) > f.MaxDataLen(s.peerParams.MaxDatagramFrameSize, s.version) {
  1830. return errors.New("message too large")
  1831. }
  1832. f.Data = make([]byte, len(p))
  1833. copy(f.Data, p)
  1834. return s.datagramQueue.AddAndWait(f)
  1835. }
  1836. func (s *session) ReceiveMessage() ([]byte, error) {
  1837. return s.datagramQueue.Receive()
  1838. }
  1839. func (s *session) LocalAddr() net.Addr {
  1840. return s.conn.LocalAddr()
  1841. }
  1842. func (s *session) RemoteAddr() net.Addr {
  1843. return s.conn.RemoteAddr()
  1844. }
  1845. func (s *session) getPerspective() protocol.Perspective {
  1846. return s.perspective
  1847. }
  1848. func (s *session) GetVersion() protocol.VersionNumber {
  1849. return s.version
  1850. }
  1851. func (s *session) NextSession() Session {
  1852. <-s.HandshakeComplete().Done()
  1853. s.streamsMap.UseResetMaps()
  1854. return s
  1855. }