server.go 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049
  1. package quic
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "net"
  7. "sync"
  8. "sync/atomic"
  9. "time"
  10. tls "github.com/Psiphon-Labs/psiphon-tls"
  11. "github.com/Psiphon-Labs/quic-go/internal/handshake"
  12. "github.com/Psiphon-Labs/quic-go/internal/protocol"
  13. "github.com/Psiphon-Labs/quic-go/internal/qerr"
  14. "github.com/Psiphon-Labs/quic-go/internal/qtls"
  15. "github.com/Psiphon-Labs/quic-go/internal/utils"
  16. "github.com/Psiphon-Labs/quic-go/internal/wire"
  17. "github.com/Psiphon-Labs/quic-go/logging"
  18. )
  19. // ErrServerClosed is returned by the Listener or EarlyListener's Accept method after a call to Close.
  20. var ErrServerClosed = errors.New("quic: server closed")
  21. // packetHandler handles packets
  22. type packetHandler interface {
  23. handlePacket(receivedPacket)
  24. shutdown()
  25. destroy(error)
  26. getPerspective() protocol.Perspective
  27. }
  28. type packetHandlerManager interface {
  29. Get(protocol.ConnectionID) (packetHandler, bool)
  30. GetByResetToken(protocol.StatelessResetToken) (packetHandler, bool)
  31. AddWithConnID(protocol.ConnectionID, protocol.ConnectionID, func() (packetHandler, bool)) bool
  32. Close(error)
  33. connRunner
  34. }
  35. type quicConn interface {
  36. EarlyConnection
  37. earlyConnReady() <-chan struct{}
  38. handlePacket(receivedPacket)
  39. GetVersion() protocol.VersionNumber
  40. getPerspective() protocol.Perspective
  41. run() error
  42. destroy(error)
  43. shutdown()
  44. }
  45. type zeroRTTQueue struct {
  46. packets []receivedPacket
  47. expiration time.Time
  48. }
  49. type rejectedPacket struct {
  50. receivedPacket
  51. hdr *wire.Header
  52. }
  53. // A Listener of QUIC
  54. type baseServer struct {
  55. disableVersionNegotiation bool
  56. acceptEarlyConns bool
  57. tlsConf *tls.Config
  58. config *Config
  59. conn rawConn
  60. tokenGenerator *handshake.TokenGenerator
  61. maxTokenAge time.Duration
  62. connIDGenerator ConnectionIDGenerator
  63. connHandler packetHandlerManager
  64. onClose func()
  65. receivedPackets chan receivedPacket
  66. nextZeroRTTCleanup time.Time
  67. zeroRTTQueues map[protocol.ConnectionID]*zeroRTTQueue // only initialized if acceptEarlyConns == true
  68. // set as a member, so they can be set in the tests
  69. newConn func(
  70. sendConn,
  71. connRunner,
  72. protocol.ConnectionID, /* original dest connection ID */
  73. *protocol.ConnectionID, /* retry src connection ID */
  74. protocol.ConnectionID, /* client dest connection ID */
  75. protocol.ConnectionID, /* destination connection ID */
  76. protocol.ConnectionID, /* source connection ID */
  77. ConnectionIDGenerator,
  78. protocol.StatelessResetToken,
  79. *Config,
  80. *tls.Config,
  81. *handshake.TokenGenerator,
  82. bool, /* client address validated by an address validation token */
  83. *logging.ConnectionTracer,
  84. uint64,
  85. utils.Logger,
  86. protocol.VersionNumber,
  87. ) quicConn
  88. closeOnce sync.Once
  89. errorChan chan struct{} // is closed when the server is closed
  90. closeErr error
  91. running chan struct{} // closed as soon as run() returns
  92. versionNegotiationQueue chan receivedPacket
  93. invalidTokenQueue chan rejectedPacket
  94. connectionRefusedQueue chan rejectedPacket
  95. retryQueue chan rejectedPacket
  96. connQueue chan quicConn
  97. connQueueLen int32 // to be used as an atomic
  98. tracer *logging.Tracer
  99. logger utils.Logger
  100. }
  101. // A Listener listens for incoming QUIC connections.
  102. // It returns connections once the handshake has completed.
  103. type Listener struct {
  104. baseServer *baseServer
  105. }
  106. // Accept returns new connections. It should be called in a loop.
  107. func (l *Listener) Accept(ctx context.Context) (Connection, error) {
  108. return l.baseServer.Accept(ctx)
  109. }
  110. // Close closes the listener.
  111. // Accept will return ErrServerClosed as soon as all connections in the accept queue have been accepted.
  112. // QUIC handshakes that are still in flight will be rejected with a CONNECTION_REFUSED error.
  113. // The effect of closing the listener depends on how it was created:
  114. // * if it was created using Transport.Listen, already established connections will be unaffected
  115. // * if it was created using the Listen convenience method, all established connection will be closed immediately
  116. func (l *Listener) Close() error {
  117. return l.baseServer.Close()
  118. }
  119. // Addr returns the local network address that the server is listening on.
  120. func (l *Listener) Addr() net.Addr {
  121. return l.baseServer.Addr()
  122. }
  123. // An EarlyListener listens for incoming QUIC connections, and returns them before the handshake completes.
  124. // For connections that don't use 0-RTT, this allows the server to send 0.5-RTT data.
  125. // This data is encrypted with forward-secure keys, however, the client's identity has not yet been verified.
  126. // For connection using 0-RTT, this allows the server to accept and respond to streams that the client opened in the
  127. // 0-RTT data it sent. Note that at this point during the handshake, the live-ness of the
  128. // client has not yet been confirmed, and the 0-RTT data could have been replayed by an attacker.
  129. type EarlyListener struct {
  130. baseServer *baseServer
  131. }
  132. // Accept returns a new connections. It should be called in a loop.
  133. func (l *EarlyListener) Accept(ctx context.Context) (EarlyConnection, error) {
  134. return l.baseServer.accept(ctx)
  135. }
  136. // Close the server. All active connections will be closed.
  137. func (l *EarlyListener) Close() error {
  138. return l.baseServer.Close()
  139. }
  140. // Addr returns the local network addr that the server is listening on.
  141. func (l *EarlyListener) Addr() net.Addr {
  142. return l.baseServer.Addr()
  143. }
  144. // ListenAddr creates a QUIC server listening on a given address.
  145. // See Listen for more details.
  146. func ListenAddr(addr string, tlsConf *tls.Config, config *Config) (*Listener, error) {
  147. conn, err := listenUDP(addr)
  148. if err != nil {
  149. return nil, err
  150. }
  151. return (&Transport{
  152. Conn: conn,
  153. createdConn: true,
  154. isSingleUse: true,
  155. }).Listen(tlsConf, config)
  156. }
  157. // ListenAddrEarly works like ListenAddr, but it returns connections before the handshake completes.
  158. func ListenAddrEarly(addr string, tlsConf *tls.Config, config *Config) (*EarlyListener, error) {
  159. conn, err := listenUDP(addr)
  160. if err != nil {
  161. return nil, err
  162. }
  163. return (&Transport{
  164. Conn: conn,
  165. createdConn: true,
  166. isSingleUse: true,
  167. }).ListenEarly(tlsConf, config)
  168. }
  169. func listenUDP(addr string) (*net.UDPConn, error) {
  170. udpAddr, err := net.ResolveUDPAddr("udp", addr)
  171. if err != nil {
  172. return nil, err
  173. }
  174. return net.ListenUDP("udp", udpAddr)
  175. }
  176. // Listen listens for QUIC connections on a given net.PacketConn.
  177. // If the PacketConn satisfies the OOBCapablePacketConn interface (as a net.UDPConn does),
  178. // ECN and packet info support will be enabled. In this case, ReadMsgUDP and WriteMsgUDP
  179. // will be used instead of ReadFrom and WriteTo to read/write packets.
  180. // A single net.PacketConn can only be used for a single call to Listen.
  181. //
  182. // The tls.Config must not be nil and must contain a certificate configuration.
  183. // Furthermore, it must define an application control (using NextProtos).
  184. // The quic.Config may be nil, in that case the default values will be used.
  185. //
  186. // This is a convenience function. More advanced use cases should instantiate a Transport,
  187. // which offers configuration options for a more fine-grained control of the connection establishment,
  188. // including reusing the underlying UDP socket for outgoing QUIC connections.
  189. // When closing a listener created with Listen, all established QUIC connections will be closed immediately.
  190. func Listen(conn net.PacketConn, tlsConf *tls.Config, config *Config) (*Listener, error) {
  191. tr := &Transport{Conn: conn, isSingleUse: true}
  192. return tr.Listen(tlsConf, config)
  193. }
  194. // ListenEarly works like Listen, but it returns connections before the handshake completes.
  195. func ListenEarly(conn net.PacketConn, tlsConf *tls.Config, config *Config) (*EarlyListener, error) {
  196. tr := &Transport{Conn: conn, isSingleUse: true}
  197. return tr.ListenEarly(tlsConf, config)
  198. }
  199. func newServer(
  200. conn rawConn,
  201. connHandler packetHandlerManager,
  202. connIDGenerator ConnectionIDGenerator,
  203. tlsConf *tls.Config,
  204. config *Config,
  205. tracer *logging.Tracer,
  206. onClose func(),
  207. tokenGeneratorKey TokenGeneratorKey,
  208. maxTokenAge time.Duration,
  209. disableVersionNegotiation bool,
  210. acceptEarly bool,
  211. ) *baseServer {
  212. s := &baseServer{
  213. conn: conn,
  214. tlsConf: tlsConf,
  215. config: config,
  216. tokenGenerator: handshake.NewTokenGenerator(tokenGeneratorKey),
  217. maxTokenAge: maxTokenAge,
  218. connIDGenerator: connIDGenerator,
  219. connHandler: connHandler,
  220. connQueue: make(chan quicConn),
  221. errorChan: make(chan struct{}),
  222. running: make(chan struct{}),
  223. receivedPackets: make(chan receivedPacket, protocol.MaxServerUnprocessedPackets),
  224. versionNegotiationQueue: make(chan receivedPacket, 4),
  225. invalidTokenQueue: make(chan rejectedPacket, 4),
  226. connectionRefusedQueue: make(chan rejectedPacket, 4),
  227. retryQueue: make(chan rejectedPacket, 8),
  228. newConn: newConnection,
  229. tracer: tracer,
  230. logger: utils.DefaultLogger.WithPrefix("server"),
  231. acceptEarlyConns: acceptEarly,
  232. disableVersionNegotiation: disableVersionNegotiation,
  233. onClose: onClose,
  234. }
  235. if acceptEarly {
  236. s.zeroRTTQueues = map[protocol.ConnectionID]*zeroRTTQueue{}
  237. }
  238. go s.run()
  239. go s.runSendQueue()
  240. s.logger.Debugf("Listening for %s connections on %s", conn.LocalAddr().Network(), conn.LocalAddr().String())
  241. return s
  242. }
  243. func (s *baseServer) run() {
  244. defer close(s.running)
  245. for {
  246. select {
  247. case <-s.errorChan:
  248. return
  249. default:
  250. }
  251. select {
  252. case <-s.errorChan:
  253. return
  254. case p := <-s.receivedPackets:
  255. if bufferStillInUse := s.handlePacketImpl(p); !bufferStillInUse {
  256. p.buffer.Release()
  257. }
  258. }
  259. }
  260. }
  261. func (s *baseServer) runSendQueue() {
  262. for {
  263. select {
  264. case <-s.running:
  265. return
  266. case p := <-s.versionNegotiationQueue:
  267. s.maybeSendVersionNegotiationPacket(p)
  268. case p := <-s.invalidTokenQueue:
  269. s.maybeSendInvalidToken(p)
  270. case p := <-s.connectionRefusedQueue:
  271. s.sendConnectionRefused(p)
  272. case p := <-s.retryQueue:
  273. s.sendRetry(p)
  274. }
  275. }
  276. }
  277. // Accept returns connections that already completed the handshake.
  278. // It is only valid if acceptEarlyConns is false.
  279. func (s *baseServer) Accept(ctx context.Context) (Connection, error) {
  280. return s.accept(ctx)
  281. }
  282. func (s *baseServer) accept(ctx context.Context) (quicConn, error) {
  283. select {
  284. case <-ctx.Done():
  285. return nil, ctx.Err()
  286. case conn := <-s.connQueue:
  287. atomic.AddInt32(&s.connQueueLen, -1)
  288. return conn, nil
  289. case <-s.errorChan:
  290. return nil, s.closeErr
  291. }
  292. }
  293. func (s *baseServer) Close() error {
  294. s.close(ErrServerClosed, true)
  295. return nil
  296. }
  297. func (s *baseServer) close(e error, notifyOnClose bool) {
  298. s.closeOnce.Do(func() {
  299. s.closeErr = e
  300. close(s.errorChan)
  301. <-s.running
  302. if notifyOnClose {
  303. s.onClose()
  304. }
  305. })
  306. }
  307. // Addr returns the server's network address
  308. func (s *baseServer) Addr() net.Addr {
  309. return s.conn.LocalAddr()
  310. }
  311. func (s *baseServer) handlePacket(p receivedPacket) {
  312. select {
  313. case s.receivedPackets <- p:
  314. default:
  315. s.logger.Debugf("Dropping packet from %s (%d bytes). Server receive queue full.", p.remoteAddr, p.Size())
  316. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  317. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropDOSPrevention)
  318. }
  319. }
  320. }
  321. func (s *baseServer) handlePacketImpl(p receivedPacket) bool /* is the buffer still in use? */ {
  322. if !s.nextZeroRTTCleanup.IsZero() && p.rcvTime.After(s.nextZeroRTTCleanup) {
  323. defer s.cleanupZeroRTTQueues(p.rcvTime)
  324. }
  325. if wire.IsVersionNegotiationPacket(p.data) {
  326. s.logger.Debugf("Dropping Version Negotiation packet.")
  327. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  328. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeVersionNegotiation, p.Size(), logging.PacketDropUnexpectedPacket)
  329. }
  330. return false
  331. }
  332. // Short header packets should never end up here in the first place
  333. if !wire.IsLongHeaderPacket(p.data[0]) {
  334. panic(fmt.Sprintf("misrouted packet: %#v", p.data))
  335. }
  336. v, err := wire.ParseVersion(p.data)
  337. // drop the packet if we failed to parse the protocol version
  338. if err != nil {
  339. s.logger.Debugf("Dropping a packet with an unknown version")
  340. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  341. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropUnexpectedPacket)
  342. }
  343. return false
  344. }
  345. // send a Version Negotiation Packet if the client is speaking a different protocol version
  346. if !protocol.IsSupportedVersion(s.config.Versions, v) {
  347. if s.disableVersionNegotiation {
  348. return false
  349. }
  350. if p.Size() < protocol.MinUnknownVersionPacketSize {
  351. s.logger.Debugf("Dropping a packet with an unsupported version number %d that is too small (%d bytes)", v, p.Size())
  352. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  353. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropUnexpectedPacket)
  354. }
  355. return false
  356. }
  357. return s.enqueueVersionNegotiationPacket(p)
  358. }
  359. if wire.Is0RTTPacket(p.data) {
  360. if !s.acceptEarlyConns {
  361. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  362. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketType0RTT, p.Size(), logging.PacketDropUnexpectedPacket)
  363. }
  364. return false
  365. }
  366. return s.handle0RTTPacket(p)
  367. }
  368. // If we're creating a new connection, the packet will be passed to the connection.
  369. // The header will then be parsed again.
  370. hdr, _, _, err := wire.ParsePacket(p.data)
  371. if err != nil {
  372. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  373. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropHeaderParseError)
  374. }
  375. s.logger.Debugf("Error parsing packet: %s", err)
  376. return false
  377. }
  378. // [Psiphon]
  379. // To accomodate additional messages, obfuscated QUIC packets may reserve
  380. // significant space in the Initial packet and send less that 1200 QUIC
  381. // bytes. In this configuration, the obfuscation layer enforces the
  382. // anti-amplification 1200 byte rule, but it must be disabled here.
  383. isObfuscated := s.config.ServerMaxPacketSizeAdjustment != nil && s.config.ServerMaxPacketSizeAdjustment(p.remoteAddr) > 0
  384. if !isObfuscated &&
  385. hdr.Type == protocol.PacketTypeInitial && p.Size() < protocol.MinInitialPacketSize {
  386. s.logger.Debugf("Dropping a packet that is too small to be a valid Initial (%d bytes)", p.Size())
  387. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  388. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeInitial, p.Size(), logging.PacketDropUnexpectedPacket)
  389. }
  390. return false
  391. }
  392. if hdr.Type != protocol.PacketTypeInitial {
  393. // Drop long header packets.
  394. // There's little point in sending a Stateless Reset, since the client
  395. // might not have received the token yet.
  396. s.logger.Debugf("Dropping long header packet of type %s (%d bytes)", hdr.Type, len(p.data))
  397. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  398. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeFromHeader(hdr), p.Size(), logging.PacketDropUnexpectedPacket)
  399. }
  400. return false
  401. }
  402. s.logger.Debugf("<- Received Initial packet.")
  403. if err := s.handleInitialImpl(p, hdr); err != nil {
  404. s.logger.Errorf("Error occurred handling initial packet: %s", err)
  405. }
  406. // Don't put the packet buffer back.
  407. // handleInitialImpl deals with the buffer.
  408. return true
  409. }
  410. func (s *baseServer) handle0RTTPacket(p receivedPacket) bool {
  411. connID, err := wire.ParseConnectionID(p.data, 0)
  412. if err != nil {
  413. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  414. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketType0RTT, p.Size(), logging.PacketDropHeaderParseError)
  415. }
  416. return false
  417. }
  418. // check again if we might have a connection now
  419. if handler, ok := s.connHandler.Get(connID); ok {
  420. handler.handlePacket(p)
  421. return true
  422. }
  423. if q, ok := s.zeroRTTQueues[connID]; ok {
  424. if len(q.packets) >= protocol.Max0RTTQueueLen {
  425. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  426. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketType0RTT, p.Size(), logging.PacketDropDOSPrevention)
  427. }
  428. return false
  429. }
  430. q.packets = append(q.packets, p)
  431. return true
  432. }
  433. if len(s.zeroRTTQueues) >= protocol.Max0RTTQueues {
  434. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  435. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketType0RTT, p.Size(), logging.PacketDropDOSPrevention)
  436. }
  437. return false
  438. }
  439. queue := &zeroRTTQueue{packets: make([]receivedPacket, 1, 8)}
  440. queue.packets[0] = p
  441. expiration := p.rcvTime.Add(protocol.Max0RTTQueueingDuration)
  442. queue.expiration = expiration
  443. if s.nextZeroRTTCleanup.IsZero() || s.nextZeroRTTCleanup.After(expiration) {
  444. s.nextZeroRTTCleanup = expiration
  445. }
  446. s.zeroRTTQueues[connID] = queue
  447. return true
  448. }
  449. func (s *baseServer) cleanupZeroRTTQueues(now time.Time) {
  450. // Iterate over all queues to find those that are expired.
  451. // This is ok since we're placing a pretty low limit on the number of queues.
  452. var nextCleanup time.Time
  453. for connID, q := range s.zeroRTTQueues {
  454. if q.expiration.After(now) {
  455. if nextCleanup.IsZero() || nextCleanup.After(q.expiration) {
  456. nextCleanup = q.expiration
  457. }
  458. continue
  459. }
  460. for _, p := range q.packets {
  461. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  462. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketType0RTT, p.Size(), logging.PacketDropDOSPrevention)
  463. }
  464. p.buffer.Release()
  465. }
  466. delete(s.zeroRTTQueues, connID)
  467. if s.logger.Debug() {
  468. s.logger.Debugf("Removing 0-RTT queue for %s.", connID)
  469. }
  470. }
  471. s.nextZeroRTTCleanup = nextCleanup
  472. }
  473. // [Psiphon]
  474. type stubCryptoSetup struct {
  475. initialOpener handshake.LongHeaderOpener
  476. }
  477. var errNotSupported = errors.New("not supported")
  478. func (s *stubCryptoSetup) StartHandshake() error {
  479. return nil
  480. }
  481. func (s *stubCryptoSetup) Close() error {
  482. return errNotSupported
  483. }
  484. func (s *stubCryptoSetup) ChangeConnectionID(protocol.ConnectionID) {
  485. }
  486. func (s *stubCryptoSetup) GetSessionTicket() ([]byte, error) {
  487. return nil, errNotSupported
  488. }
  489. func (s *stubCryptoSetup) HandleMessage([]byte, protocol.EncryptionLevel) error {
  490. return nil
  491. }
  492. func (s *stubCryptoSetup) NextEvent() handshake.Event {
  493. return handshake.Event{}
  494. }
  495. func (s *stubCryptoSetup) SetLargest1RTTAcked(protocol.PacketNumber) error {
  496. return errNotSupported
  497. }
  498. func (s *stubCryptoSetup) DiscardInitialKeys() {
  499. }
  500. func (s *stubCryptoSetup) SetHandshakeConfirmed() {
  501. }
  502. func (s *stubCryptoSetup) ConnectionState() handshake.ConnectionState {
  503. return handshake.ConnectionState{}
  504. }
  505. func (s *stubCryptoSetup) GetInitialOpener() (handshake.LongHeaderOpener, error) {
  506. return s.initialOpener, nil
  507. }
  508. func (s *stubCryptoSetup) GetHandshakeOpener() (handshake.LongHeaderOpener, error) {
  509. return nil, errNotSupported
  510. }
  511. func (s *stubCryptoSetup) Get0RTTOpener() (handshake.LongHeaderOpener, error) {
  512. return nil, errNotSupported
  513. }
  514. func (s *stubCryptoSetup) Get1RTTOpener() (handshake.ShortHeaderOpener, error) {
  515. return nil, errNotSupported
  516. }
  517. func (s *stubCryptoSetup) GetInitialSealer() (handshake.LongHeaderSealer, error) {
  518. return nil, errNotSupported
  519. }
  520. func (s *stubCryptoSetup) GetHandshakeSealer() (handshake.LongHeaderSealer, error) {
  521. return nil, errNotSupported
  522. }
  523. func (s *stubCryptoSetup) Get0RTTSealer() (handshake.LongHeaderSealer, error) {
  524. return nil, errNotSupported
  525. }
  526. func (s *stubCryptoSetup) Get1RTTSealer() (handshake.ShortHeaderSealer, error) {
  527. return nil, errNotSupported
  528. }
  529. // [Psiphon]
  530. // verifyClientHelloRandom unpacks an Initial packet, extracts the CRYPTO
  531. // frame, and calls Config.VerifyClientHelloRandom.
  532. func (s *baseServer) verifyClientHelloRandom(p receivedPacket, hdr *wire.Header) error {
  533. // TODO: support QUICv2
  534. versionNumber := protocol.Version1
  535. _, initialOpener := handshake.NewInitialAEAD(
  536. hdr.DestConnectionID, protocol.PerspectiveServer, versionNumber)
  537. cs := &stubCryptoSetup{
  538. initialOpener: initialOpener,
  539. }
  540. // Make a copy of the packet data since this unpacking modifies it and the
  541. // original packet data must be retained for subsequent processing.
  542. data := append([]byte(nil), p.data...)
  543. unpacker := newPacketUnpacker(cs, 0)
  544. unpacked, err := unpacker.UnpackLongHeader(hdr, p.rcvTime, data, versionNumber)
  545. if err != nil {
  546. return fmt.Errorf("verifyClientHelloRandom: UnpackLongHeader: %w", err)
  547. }
  548. parser := wire.NewFrameParser(s.config.EnableDatagrams)
  549. d := unpacked.data
  550. for len(d) > 0 {
  551. l, frame, err := parser.ParseNext(d, protocol.EncryptionInitial, versionNumber)
  552. if err != nil {
  553. return fmt.Errorf("verifyClientHelloRandom: ParseNext: %w", err)
  554. }
  555. if frame == nil {
  556. return errors.New("verifyClientHelloRandom: missing CRYPTO frame")
  557. }
  558. d = d[l:]
  559. cryptoFrame, ok := frame.(*wire.CryptoFrame)
  560. if !ok {
  561. continue
  562. }
  563. if cryptoFrame.Offset != 0 {
  564. return errors.New("verifyClientHelloRandom: unexpected CRYPTO frame offset")
  565. }
  566. random, err := qtls.ReadClientHelloRandom(cryptoFrame.Data)
  567. if err != nil {
  568. return fmt.Errorf("verifyClientHelloRandom: ReadClientHelloRandom: %w", err)
  569. }
  570. if !s.config.VerifyClientHelloRandom(p.remoteAddr, random) {
  571. return fmt.Errorf("verifyClientHelloRandom: VerifyClientHelloRandom failed")
  572. }
  573. break
  574. }
  575. return nil
  576. }
  577. // validateToken returns false if:
  578. // - address is invalid
  579. // - token is expired
  580. // - token is null
  581. func (s *baseServer) validateToken(token *handshake.Token, addr net.Addr) bool {
  582. if token == nil {
  583. return false
  584. }
  585. if !token.ValidateRemoteAddr(addr) {
  586. return false
  587. }
  588. if !token.IsRetryToken && time.Since(token.SentTime) > s.maxTokenAge {
  589. return false
  590. }
  591. if token.IsRetryToken && time.Since(token.SentTime) > s.config.maxRetryTokenAge() {
  592. return false
  593. }
  594. return true
  595. }
  596. func (s *baseServer) handleInitialImpl(p receivedPacket, hdr *wire.Header) error {
  597. if len(hdr.Token) == 0 && hdr.DestConnectionID.Len() < protocol.MinConnectionIDLenInitial {
  598. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  599. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeInitial, p.Size(), logging.PacketDropUnexpectedPacket)
  600. }
  601. p.buffer.Release()
  602. return errors.New("too short connection ID")
  603. }
  604. // [Psiphon]
  605. // Drop any Initial packet that fails verifyClientHelloRandom.
  606. if s.config.VerifyClientHelloRandom != nil {
  607. err := s.verifyClientHelloRandom(p, hdr)
  608. if err != nil {
  609. p.buffer.Release()
  610. return err
  611. }
  612. }
  613. // The server queues packets for a while, and we might already have established a connection by now.
  614. // This results in a second check in the connection map.
  615. // That's ok since it's not the hot path (it's only taken by some Initial and 0-RTT packets).
  616. if handler, ok := s.connHandler.Get(hdr.DestConnectionID); ok {
  617. handler.handlePacket(p)
  618. return nil
  619. }
  620. var (
  621. token *handshake.Token
  622. retrySrcConnID *protocol.ConnectionID
  623. )
  624. origDestConnID := hdr.DestConnectionID
  625. if len(hdr.Token) > 0 {
  626. tok, err := s.tokenGenerator.DecodeToken(hdr.Token)
  627. if err == nil {
  628. if tok.IsRetryToken {
  629. origDestConnID = tok.OriginalDestConnectionID
  630. retrySrcConnID = &tok.RetrySrcConnectionID
  631. }
  632. token = tok
  633. }
  634. }
  635. clientAddrIsValid := s.validateToken(token, p.remoteAddr)
  636. if token != nil && !clientAddrIsValid {
  637. // For invalid and expired non-retry tokens, we don't send an INVALID_TOKEN error.
  638. // We just ignore them, and act as if there was no token on this packet at all.
  639. // This also means we might send a Retry later.
  640. if !token.IsRetryToken {
  641. token = nil
  642. } else {
  643. // For Retry tokens, we send an INVALID_ERROR if
  644. // * the token is too old, or
  645. // * the token is invalid, in case of a retry token.
  646. select {
  647. case s.invalidTokenQueue <- rejectedPacket{receivedPacket: p, hdr: hdr}:
  648. default:
  649. // drop packet if we can't send out the INVALID_TOKEN packets fast enough
  650. p.buffer.Release()
  651. }
  652. return nil
  653. }
  654. }
  655. if token == nil && s.config.RequireAddressValidation(p.remoteAddr) {
  656. // Retry invalidates all 0-RTT packets sent.
  657. delete(s.zeroRTTQueues, hdr.DestConnectionID)
  658. select {
  659. case s.retryQueue <- rejectedPacket{receivedPacket: p, hdr: hdr}:
  660. default:
  661. // drop packet if we can't send out Retry packets fast enough
  662. p.buffer.Release()
  663. }
  664. return nil
  665. }
  666. if queueLen := atomic.LoadInt32(&s.connQueueLen); queueLen >= protocol.MaxAcceptQueueSize {
  667. s.logger.Debugf("Rejecting new connection. Server currently busy. Accept queue length: %d (max %d)", queueLen, protocol.MaxAcceptQueueSize)
  668. select {
  669. case s.connectionRefusedQueue <- rejectedPacket{receivedPacket: p, hdr: hdr}:
  670. default:
  671. // drop packet if we can't send out the CONNECTION_REFUSED fast enough
  672. p.buffer.Release()
  673. }
  674. return nil
  675. }
  676. connID, err := s.connIDGenerator.GenerateConnectionID()
  677. if err != nil {
  678. return err
  679. }
  680. s.logger.Debugf("Changing connection ID to %s.", connID)
  681. var conn quicConn
  682. tracingID := nextConnTracingID()
  683. if added := s.connHandler.AddWithConnID(hdr.DestConnectionID, connID, func() (packetHandler, bool) {
  684. config := s.config
  685. if s.config.GetConfigForClient != nil {
  686. conf, err := s.config.GetConfigForClient(&ClientHelloInfo{RemoteAddr: p.remoteAddr})
  687. if err != nil {
  688. s.logger.Debugf("Rejecting new connection due to GetConfigForClient callback")
  689. return nil, false
  690. }
  691. config = populateConfig(conf)
  692. }
  693. var tracer *logging.ConnectionTracer
  694. if config.Tracer != nil {
  695. // Use the same connection ID that is passed to the client's GetLogWriter callback.
  696. connID := hdr.DestConnectionID
  697. if origDestConnID.Len() > 0 {
  698. connID = origDestConnID
  699. }
  700. tracer = config.Tracer(context.WithValue(context.Background(), ConnectionTracingKey, tracingID), protocol.PerspectiveServer, connID)
  701. }
  702. conn = s.newConn(
  703. newSendConn(s.conn, p.remoteAddr, p.info, s.logger),
  704. s.connHandler,
  705. origDestConnID,
  706. retrySrcConnID,
  707. hdr.DestConnectionID,
  708. hdr.SrcConnectionID,
  709. connID,
  710. s.connIDGenerator,
  711. s.connHandler.GetStatelessResetToken(connID),
  712. config,
  713. s.tlsConf,
  714. s.tokenGenerator,
  715. clientAddrIsValid,
  716. tracer,
  717. tracingID,
  718. s.logger,
  719. hdr.Version,
  720. )
  721. conn.handlePacket(p)
  722. if q, ok := s.zeroRTTQueues[hdr.DestConnectionID]; ok {
  723. for _, p := range q.packets {
  724. conn.handlePacket(p)
  725. }
  726. delete(s.zeroRTTQueues, hdr.DestConnectionID)
  727. }
  728. return conn, true
  729. }); !added {
  730. select {
  731. case s.connectionRefusedQueue <- rejectedPacket{receivedPacket: p, hdr: hdr}:
  732. default:
  733. // drop packet if we can't send out the CONNECTION_REFUSED fast enough
  734. p.buffer.Release()
  735. }
  736. return nil
  737. }
  738. go conn.run()
  739. go s.handleNewConn(conn)
  740. if conn == nil {
  741. p.buffer.Release()
  742. return nil
  743. }
  744. return nil
  745. }
  746. func (s *baseServer) handleNewConn(conn quicConn) {
  747. connCtx := conn.Context()
  748. if s.acceptEarlyConns {
  749. // wait until the early connection is ready, the handshake fails, or the server is closed
  750. select {
  751. case <-s.errorChan:
  752. conn.destroy(&qerr.TransportError{ErrorCode: ConnectionRefused})
  753. return
  754. case <-conn.earlyConnReady():
  755. case <-connCtx.Done():
  756. return
  757. }
  758. } else {
  759. // wait until the handshake is complete (or fails)
  760. select {
  761. case <-s.errorChan:
  762. conn.destroy(&qerr.TransportError{ErrorCode: ConnectionRefused})
  763. return
  764. case <-conn.HandshakeComplete():
  765. case <-connCtx.Done():
  766. return
  767. }
  768. }
  769. atomic.AddInt32(&s.connQueueLen, 1)
  770. select {
  771. case s.connQueue <- conn:
  772. // blocks until the connection is accepted
  773. case <-connCtx.Done():
  774. atomic.AddInt32(&s.connQueueLen, -1)
  775. // don't pass connections that were already closed to Accept()
  776. }
  777. }
  778. func (s *baseServer) sendRetry(p rejectedPacket) {
  779. if err := s.sendRetryPacket(p); err != nil {
  780. s.logger.Debugf("Error sending Retry packet: %s", err)
  781. }
  782. }
  783. func (s *baseServer) sendRetryPacket(p rejectedPacket) error {
  784. hdr := p.hdr
  785. // Log the Initial packet now.
  786. // If no Retry is sent, the packet will be logged by the connection.
  787. (&wire.ExtendedHeader{Header: *hdr}).Log(s.logger)
  788. srcConnID, err := s.connIDGenerator.GenerateConnectionID()
  789. if err != nil {
  790. return err
  791. }
  792. token, err := s.tokenGenerator.NewRetryToken(p.remoteAddr, hdr.DestConnectionID, srcConnID)
  793. if err != nil {
  794. return err
  795. }
  796. replyHdr := &wire.ExtendedHeader{}
  797. replyHdr.Type = protocol.PacketTypeRetry
  798. replyHdr.Version = hdr.Version
  799. replyHdr.SrcConnectionID = srcConnID
  800. replyHdr.DestConnectionID = hdr.SrcConnectionID
  801. replyHdr.Token = token
  802. if s.logger.Debug() {
  803. s.logger.Debugf("Changing connection ID to %s.", srcConnID)
  804. s.logger.Debugf("-> Sending Retry")
  805. replyHdr.Log(s.logger)
  806. }
  807. buf := getPacketBuffer()
  808. defer buf.Release()
  809. buf.Data, err = replyHdr.Append(buf.Data, hdr.Version)
  810. if err != nil {
  811. return err
  812. }
  813. // append the Retry integrity tag
  814. tag := handshake.GetRetryIntegrityTag(buf.Data, hdr.DestConnectionID, hdr.Version)
  815. buf.Data = append(buf.Data, tag[:]...)
  816. if s.tracer != nil && s.tracer.SentPacket != nil {
  817. s.tracer.SentPacket(p.remoteAddr, &replyHdr.Header, protocol.ByteCount(len(buf.Data)), nil)
  818. }
  819. _, err = s.conn.WritePacket(buf.Data, p.remoteAddr, p.info.OOB(), 0, protocol.ECNUnsupported)
  820. return err
  821. }
  822. func (s *baseServer) maybeSendInvalidToken(p rejectedPacket) {
  823. defer p.buffer.Release()
  824. // Only send INVALID_TOKEN if we can unprotect the packet.
  825. // This makes sure that we won't send it for packets that were corrupted.
  826. hdr := p.hdr
  827. sealer, opener := handshake.NewInitialAEAD(hdr.DestConnectionID, protocol.PerspectiveServer, hdr.Version)
  828. data := p.data[:hdr.ParsedLen()+hdr.Length]
  829. extHdr, err := unpackLongHeader(opener, hdr, data, hdr.Version)
  830. // Only send INVALID_TOKEN if we can unprotect the packet.
  831. // This makes sure that we won't send it for packets that were corrupted.
  832. if err != nil {
  833. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  834. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeInitial, p.Size(), logging.PacketDropHeaderParseError)
  835. }
  836. return
  837. }
  838. hdrLen := extHdr.ParsedLen()
  839. if _, err := opener.Open(data[hdrLen:hdrLen], data[hdrLen:], extHdr.PacketNumber, data[:hdrLen]); err != nil {
  840. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  841. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeInitial, p.Size(), logging.PacketDropPayloadDecryptError)
  842. }
  843. return
  844. }
  845. if s.logger.Debug() {
  846. s.logger.Debugf("Client sent an invalid retry token. Sending INVALID_TOKEN to %s.", p.remoteAddr)
  847. }
  848. if err := s.sendError(p.remoteAddr, hdr, sealer, qerr.InvalidToken, p.info); err != nil {
  849. s.logger.Debugf("Error sending INVALID_TOKEN error: %s", err)
  850. }
  851. }
  852. func (s *baseServer) sendConnectionRefused(p rejectedPacket) {
  853. defer p.buffer.Release()
  854. sealer, _ := handshake.NewInitialAEAD(p.hdr.DestConnectionID, protocol.PerspectiveServer, p.hdr.Version)
  855. if err := s.sendError(p.remoteAddr, p.hdr, sealer, qerr.ConnectionRefused, p.info); err != nil {
  856. s.logger.Debugf("Error sending CONNECTION_REFUSED error: %s", err)
  857. }
  858. }
  859. // sendError sends the error as a response to the packet received with header hdr
  860. func (s *baseServer) sendError(remoteAddr net.Addr, hdr *wire.Header, sealer handshake.LongHeaderSealer, errorCode qerr.TransportErrorCode, info packetInfo) error {
  861. b := getPacketBuffer()
  862. defer b.Release()
  863. ccf := &wire.ConnectionCloseFrame{ErrorCode: uint64(errorCode)}
  864. replyHdr := &wire.ExtendedHeader{}
  865. replyHdr.Type = protocol.PacketTypeInitial
  866. replyHdr.Version = hdr.Version
  867. replyHdr.SrcConnectionID = hdr.DestConnectionID
  868. replyHdr.DestConnectionID = hdr.SrcConnectionID
  869. replyHdr.PacketNumberLen = protocol.PacketNumberLen4
  870. replyHdr.Length = 4 /* packet number len */ + ccf.Length(hdr.Version) + protocol.ByteCount(sealer.Overhead())
  871. var err error
  872. b.Data, err = replyHdr.Append(b.Data, hdr.Version)
  873. if err != nil {
  874. return err
  875. }
  876. payloadOffset := len(b.Data)
  877. b.Data, err = ccf.Append(b.Data, hdr.Version)
  878. if err != nil {
  879. return err
  880. }
  881. _ = sealer.Seal(b.Data[payloadOffset:payloadOffset], b.Data[payloadOffset:], replyHdr.PacketNumber, b.Data[:payloadOffset])
  882. b.Data = b.Data[0 : len(b.Data)+sealer.Overhead()]
  883. pnOffset := payloadOffset - int(replyHdr.PacketNumberLen)
  884. sealer.EncryptHeader(
  885. b.Data[pnOffset+4:pnOffset+4+16],
  886. &b.Data[0],
  887. b.Data[pnOffset:payloadOffset],
  888. )
  889. replyHdr.Log(s.logger)
  890. wire.LogFrame(s.logger, ccf, true)
  891. if s.tracer != nil && s.tracer.SentPacket != nil {
  892. s.tracer.SentPacket(remoteAddr, &replyHdr.Header, protocol.ByteCount(len(b.Data)), []logging.Frame{ccf})
  893. }
  894. _, err = s.conn.WritePacket(b.Data, remoteAddr, info.OOB(), 0, protocol.ECNUnsupported)
  895. return err
  896. }
  897. func (s *baseServer) enqueueVersionNegotiationPacket(p receivedPacket) (bufferInUse bool) {
  898. select {
  899. case s.versionNegotiationQueue <- p:
  900. return true
  901. default:
  902. // it's fine to not send version negotiation packets when we are busy
  903. }
  904. return false
  905. }
  906. func (s *baseServer) maybeSendVersionNegotiationPacket(p receivedPacket) {
  907. defer p.buffer.Release()
  908. v, err := wire.ParseVersion(p.data)
  909. if err != nil {
  910. s.logger.Debugf("failed to parse version for sending version negotiation packet: %s", err)
  911. return
  912. }
  913. _, src, dest, err := wire.ParseArbitraryLenConnectionIDs(p.data)
  914. if err != nil { // should never happen
  915. s.logger.Debugf("Dropping a packet with an unknown version for which we failed to parse connection IDs")
  916. if s.tracer != nil && s.tracer.DroppedPacket != nil {
  917. s.tracer.DroppedPacket(p.remoteAddr, logging.PacketTypeNotDetermined, p.Size(), logging.PacketDropUnexpectedPacket)
  918. }
  919. return
  920. }
  921. s.logger.Debugf("Client offered version %s, sending Version Negotiation", v)
  922. data := wire.ComposeVersionNegotiation(dest, src, s.config.Versions)
  923. if s.tracer != nil && s.tracer.SentVersionNegotiationPacket != nil {
  924. s.tracer.SentVersionNegotiationPacket(p.remoteAddr, src, dest, s.config.Versions)
  925. }
  926. if _, err := s.conn.WritePacket(data, p.remoteAddr, p.info.OOB(), 0, protocol.ECNUnsupported); err != nil {
  927. s.logger.Debugf("Error sending Version Negotiation: %s", err)
  928. }
  929. }