server.go 96 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119
  1. // Copyright 2014 The Go Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. // TODO: turn off the serve goroutine when idle, so
  5. // an idle conn only has the readFrames goroutine active. (which could
  6. // also be optimized probably to pin less memory in crypto/tls). This
  7. // would involve tracking when the serve goroutine is active (atomic
  8. // int32 read/CAS probably?) and starting it up when frames arrive,
  9. // and shutting it down when all handlers exit. the occasional PING
  10. // packets could use time.AfterFunc to call sc.wakeStartServeLoop()
  11. // (which is a no-op if already running) and then queue the PING write
  12. // as normal. The serve loop would then exit in most cases (if no
  13. // Handlers running) and not be woken up again until the PING packet
  14. // returns.
  15. // TODO (maybe): add a mechanism for Handlers to going into
  16. // half-closed-local mode (rw.(io.Closer) test?) but not exit their
  17. // handler, and continue to be able to read from the
  18. // Request.Body. This would be a somewhat semantic change from HTTP/1
  19. // (or at least what we expose in net/http), so I'd probably want to
  20. // add it there too. For now, this package says that returning from
  21. // the Handler ServeHTTP function means you're both done reading and
  22. // done writing, without a way to stop just one or the other.
  23. package http2
  24. import (
  25. "bufio"
  26. "bytes"
  27. "context"
  28. "crypto/tls"
  29. "errors"
  30. "fmt"
  31. "io"
  32. "log"
  33. "math"
  34. "net"
  35. "net/http"
  36. "net/textproto"
  37. "net/url"
  38. "os"
  39. "reflect"
  40. "runtime"
  41. "strconv"
  42. "strings"
  43. "sync"
  44. "time"
  45. "golang.org/x/net/http/httpguts"
  46. "golang.org/x/net/http2/hpack"
  47. )
  48. const (
  49. prefaceTimeout = 10 * time.Second
  50. firstSettingsTimeout = 2 * time.Second // should be in-flight with preface anyway
  51. handlerChunkWriteSize = 4 << 10
  52. defaultMaxStreams = 250 // TODO: make this 100 as the GFE seems to?
  53. maxQueuedControlFrames = 10000
  54. )
  55. var (
  56. errClientDisconnected = errors.New("client disconnected")
  57. errClosedBody = errors.New("body closed by handler")
  58. errHandlerComplete = errors.New("http2: request body closed due to handler exiting")
  59. errStreamClosed = errors.New("http2: stream closed")
  60. )
  61. var responseWriterStatePool = sync.Pool{
  62. New: func() interface{} {
  63. rws := &responseWriterState{}
  64. rws.bw = bufio.NewWriterSize(chunkWriter{rws}, handlerChunkWriteSize)
  65. return rws
  66. },
  67. }
  68. // Test hooks.
  69. var (
  70. testHookOnConn func()
  71. testHookGetServerConn func(*serverConn)
  72. testHookOnPanicMu *sync.Mutex // nil except in tests
  73. testHookOnPanic func(sc *serverConn, panicVal interface{}) (rePanic bool)
  74. )
  75. // Server is an HTTP/2 server.
  76. type Server struct {
  77. // MaxHandlers limits the number of http.Handler ServeHTTP goroutines
  78. // which may run at a time over all connections.
  79. // Negative or zero no limit.
  80. // TODO: implement
  81. MaxHandlers int
  82. // MaxConcurrentStreams optionally specifies the number of
  83. // concurrent streams that each client may have open at a
  84. // time. This is unrelated to the number of http.Handler goroutines
  85. // which may be active globally, which is MaxHandlers.
  86. // If zero, MaxConcurrentStreams defaults to at least 100, per
  87. // the HTTP/2 spec's recommendations.
  88. MaxConcurrentStreams uint32
  89. // MaxReadFrameSize optionally specifies the largest frame
  90. // this server is willing to read. A valid value is between
  91. // 16k and 16M, inclusive. If zero or otherwise invalid, a
  92. // default value is used.
  93. MaxReadFrameSize uint32
  94. // PermitProhibitedCipherSuites, if true, permits the use of
  95. // cipher suites prohibited by the HTTP/2 spec.
  96. PermitProhibitedCipherSuites bool
  97. // IdleTimeout specifies how long until idle clients should be
  98. // closed with a GOAWAY frame. PING frames are not considered
  99. // activity for the purposes of IdleTimeout.
  100. IdleTimeout time.Duration
  101. // MaxUploadBufferPerConnection is the size of the initial flow
  102. // control window for each connections. The HTTP/2 spec does not
  103. // allow this to be smaller than 65535 or larger than 2^32-1.
  104. // If the value is outside this range, a default value will be
  105. // used instead.
  106. MaxUploadBufferPerConnection int32
  107. // MaxUploadBufferPerStream is the size of the initial flow control
  108. // window for each stream. The HTTP/2 spec does not allow this to
  109. // be larger than 2^32-1. If the value is zero or larger than the
  110. // maximum, a default value will be used instead.
  111. MaxUploadBufferPerStream int32
  112. // NewWriteScheduler constructs a write scheduler for a connection.
  113. // If nil, a default scheduler is chosen.
  114. NewWriteScheduler func() WriteScheduler
  115. // CountError, if non-nil, is called on HTTP/2 server errors.
  116. // It's intended to increment a metric for monitoring, such
  117. // as an expvar or Prometheus metric.
  118. // The errType consists of only ASCII word characters.
  119. CountError func(errType string)
  120. // Internal state. This is a pointer (rather than embedded directly)
  121. // so that we don't embed a Mutex in this struct, which will make the
  122. // struct non-copyable, which might break some callers.
  123. state *serverInternalState
  124. }
  125. func (s *Server) initialConnRecvWindowSize() int32 {
  126. if s.MaxUploadBufferPerConnection > initialWindowSize {
  127. return s.MaxUploadBufferPerConnection
  128. }
  129. return 1 << 20
  130. }
  131. func (s *Server) initialStreamRecvWindowSize() int32 {
  132. if s.MaxUploadBufferPerStream > 0 {
  133. return s.MaxUploadBufferPerStream
  134. }
  135. return 1 << 20
  136. }
  137. func (s *Server) maxReadFrameSize() uint32 {
  138. if v := s.MaxReadFrameSize; v >= minMaxFrameSize && v <= maxFrameSize {
  139. return v
  140. }
  141. return defaultMaxReadFrameSize
  142. }
  143. func (s *Server) maxConcurrentStreams() uint32 {
  144. if v := s.MaxConcurrentStreams; v > 0 {
  145. return v
  146. }
  147. return defaultMaxStreams
  148. }
  149. // maxQueuedControlFrames is the maximum number of control frames like
  150. // SETTINGS, PING and RST_STREAM that will be queued for writing before
  151. // the connection is closed to prevent memory exhaustion attacks.
  152. func (s *Server) maxQueuedControlFrames() int {
  153. // TODO: if anybody asks, add a Server field, and remember to define the
  154. // behavior of negative values.
  155. return maxQueuedControlFrames
  156. }
  157. type serverInternalState struct {
  158. mu sync.Mutex
  159. activeConns map[*serverConn]struct{}
  160. }
  161. func (s *serverInternalState) registerConn(sc *serverConn) {
  162. if s == nil {
  163. return // if the Server was used without calling ConfigureServer
  164. }
  165. s.mu.Lock()
  166. s.activeConns[sc] = struct{}{}
  167. s.mu.Unlock()
  168. }
  169. func (s *serverInternalState) unregisterConn(sc *serverConn) {
  170. if s == nil {
  171. return // if the Server was used without calling ConfigureServer
  172. }
  173. s.mu.Lock()
  174. delete(s.activeConns, sc)
  175. s.mu.Unlock()
  176. }
  177. func (s *serverInternalState) startGracefulShutdown() {
  178. if s == nil {
  179. return // if the Server was used without calling ConfigureServer
  180. }
  181. s.mu.Lock()
  182. for sc := range s.activeConns {
  183. sc.startGracefulShutdown()
  184. }
  185. s.mu.Unlock()
  186. }
  187. // ConfigureServer adds HTTP/2 support to a net/http Server.
  188. //
  189. // The configuration conf may be nil.
  190. //
  191. // ConfigureServer must be called before s begins serving.
  192. func ConfigureServer(s *http.Server, conf *Server) error {
  193. if s == nil {
  194. panic("nil *http.Server")
  195. }
  196. if conf == nil {
  197. conf = new(Server)
  198. }
  199. conf.state = &serverInternalState{activeConns: make(map[*serverConn]struct{})}
  200. if h1, h2 := s, conf; h2.IdleTimeout == 0 {
  201. if h1.IdleTimeout != 0 {
  202. h2.IdleTimeout = h1.IdleTimeout
  203. } else {
  204. h2.IdleTimeout = h1.ReadTimeout
  205. }
  206. }
  207. s.RegisterOnShutdown(conf.state.startGracefulShutdown)
  208. if s.TLSConfig == nil {
  209. s.TLSConfig = new(tls.Config)
  210. } else if s.TLSConfig.CipherSuites != nil && s.TLSConfig.MinVersion < tls.VersionTLS13 {
  211. // If they already provided a TLS 1.0–1.2 CipherSuite list, return an
  212. // error if it is missing ECDHE_RSA_WITH_AES_128_GCM_SHA256 or
  213. // ECDHE_ECDSA_WITH_AES_128_GCM_SHA256.
  214. haveRequired := false
  215. for _, cs := range s.TLSConfig.CipherSuites {
  216. switch cs {
  217. case tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
  218. // Alternative MTI cipher to not discourage ECDSA-only servers.
  219. // See http://golang.org/cl/30721 for further information.
  220. tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256:
  221. haveRequired = true
  222. }
  223. }
  224. if !haveRequired {
  225. return fmt.Errorf("http2: TLSConfig.CipherSuites is missing an HTTP/2-required AES_128_GCM_SHA256 cipher (need at least one of TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 or TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256)")
  226. }
  227. }
  228. // Note: not setting MinVersion to tls.VersionTLS12,
  229. // as we don't want to interfere with HTTP/1.1 traffic
  230. // on the user's server. We enforce TLS 1.2 later once
  231. // we accept a connection. Ideally this should be done
  232. // during next-proto selection, but using TLS <1.2 with
  233. // HTTP/2 is still the client's bug.
  234. s.TLSConfig.PreferServerCipherSuites = true
  235. if !strSliceContains(s.TLSConfig.NextProtos, NextProtoTLS) {
  236. s.TLSConfig.NextProtos = append(s.TLSConfig.NextProtos, NextProtoTLS)
  237. }
  238. if !strSliceContains(s.TLSConfig.NextProtos, "http/1.1") {
  239. s.TLSConfig.NextProtos = append(s.TLSConfig.NextProtos, "http/1.1")
  240. }
  241. if s.TLSNextProto == nil {
  242. s.TLSNextProto = map[string]func(*http.Server, *tls.Conn, http.Handler){}
  243. }
  244. protoHandler := func(hs *http.Server, c *tls.Conn, h http.Handler) {
  245. if testHookOnConn != nil {
  246. testHookOnConn()
  247. }
  248. // The TLSNextProto interface predates contexts, so
  249. // the net/http package passes down its per-connection
  250. // base context via an exported but unadvertised
  251. // method on the Handler. This is for internal
  252. // net/http<=>http2 use only.
  253. var ctx context.Context
  254. type baseContexter interface {
  255. BaseContext() context.Context
  256. }
  257. if bc, ok := h.(baseContexter); ok {
  258. ctx = bc.BaseContext()
  259. }
  260. conf.ServeConn(c, &ServeConnOpts{
  261. Context: ctx,
  262. Handler: h,
  263. BaseConfig: hs,
  264. })
  265. }
  266. s.TLSNextProto[NextProtoTLS] = protoHandler
  267. return nil
  268. }
  269. // ServeConnOpts are options for the Server.ServeConn method.
  270. type ServeConnOpts struct {
  271. // Context is the base context to use.
  272. // If nil, context.Background is used.
  273. Context context.Context
  274. // BaseConfig optionally sets the base configuration
  275. // for values. If nil, defaults are used.
  276. BaseConfig *http.Server
  277. // Handler specifies which handler to use for processing
  278. // requests. If nil, BaseConfig.Handler is used. If BaseConfig
  279. // or BaseConfig.Handler is nil, http.DefaultServeMux is used.
  280. Handler http.Handler
  281. // UpgradeRequest is an initial request received on a connection
  282. // undergoing an h2c upgrade. The request body must have been
  283. // completely read from the connection before calling ServeConn,
  284. // and the 101 Switching Protocols response written.
  285. UpgradeRequest *http.Request
  286. // Settings is the decoded contents of the HTTP2-Settings header
  287. // in an h2c upgrade request.
  288. Settings []byte
  289. // SawClientPreface is set if the HTTP/2 connection preface
  290. // has already been read from the connection.
  291. SawClientPreface bool
  292. }
  293. func (o *ServeConnOpts) context() context.Context {
  294. if o != nil && o.Context != nil {
  295. return o.Context
  296. }
  297. return context.Background()
  298. }
  299. func (o *ServeConnOpts) baseConfig() *http.Server {
  300. if o != nil && o.BaseConfig != nil {
  301. return o.BaseConfig
  302. }
  303. return new(http.Server)
  304. }
  305. func (o *ServeConnOpts) handler() http.Handler {
  306. if o != nil {
  307. if o.Handler != nil {
  308. return o.Handler
  309. }
  310. if o.BaseConfig != nil && o.BaseConfig.Handler != nil {
  311. return o.BaseConfig.Handler
  312. }
  313. }
  314. return http.DefaultServeMux
  315. }
  316. // ServeConn serves HTTP/2 requests on the provided connection and
  317. // blocks until the connection is no longer readable.
  318. //
  319. // ServeConn starts speaking HTTP/2 assuming that c has not had any
  320. // reads or writes. It writes its initial settings frame and expects
  321. // to be able to read the preface and settings frame from the
  322. // client. If c has a ConnectionState method like a *tls.Conn, the
  323. // ConnectionState is used to verify the TLS ciphersuite and to set
  324. // the Request.TLS field in Handlers.
  325. //
  326. // ServeConn does not support h2c by itself. Any h2c support must be
  327. // implemented in terms of providing a suitably-behaving net.Conn.
  328. //
  329. // The opts parameter is optional. If nil, default values are used.
  330. func (s *Server) ServeConn(c net.Conn, opts *ServeConnOpts) {
  331. baseCtx, cancel := serverConnBaseContext(c, opts)
  332. defer cancel()
  333. sc := &serverConn{
  334. srv: s,
  335. hs: opts.baseConfig(),
  336. conn: c,
  337. baseCtx: baseCtx,
  338. remoteAddrStr: c.RemoteAddr().String(),
  339. bw: newBufferedWriter(c),
  340. handler: opts.handler(),
  341. streams: make(map[uint32]*stream),
  342. readFrameCh: make(chan readFrameResult),
  343. wantWriteFrameCh: make(chan FrameWriteRequest, 8),
  344. serveMsgCh: make(chan interface{}, 8),
  345. wroteFrameCh: make(chan frameWriteResult, 1), // buffered; one send in writeFrameAsync
  346. bodyReadCh: make(chan bodyReadMsg), // buffering doesn't matter either way
  347. doneServing: make(chan struct{}),
  348. clientMaxStreams: math.MaxUint32, // Section 6.5.2: "Initially, there is no limit to this value"
  349. advMaxStreams: s.maxConcurrentStreams(),
  350. initialStreamSendWindowSize: initialWindowSize,
  351. maxFrameSize: initialMaxFrameSize,
  352. headerTableSize: initialHeaderTableSize,
  353. serveG: newGoroutineLock(),
  354. pushEnabled: true,
  355. sawClientPreface: opts.SawClientPreface,
  356. }
  357. s.state.registerConn(sc)
  358. defer s.state.unregisterConn(sc)
  359. // The net/http package sets the write deadline from the
  360. // http.Server.WriteTimeout during the TLS handshake, but then
  361. // passes the connection off to us with the deadline already set.
  362. // Write deadlines are set per stream in serverConn.newStream.
  363. // Disarm the net.Conn write deadline here.
  364. if sc.hs.WriteTimeout != 0 {
  365. sc.conn.SetWriteDeadline(time.Time{})
  366. }
  367. if s.NewWriteScheduler != nil {
  368. sc.writeSched = s.NewWriteScheduler()
  369. } else {
  370. sc.writeSched = NewPriorityWriteScheduler(nil)
  371. }
  372. // These start at the RFC-specified defaults. If there is a higher
  373. // configured value for inflow, that will be updated when we send a
  374. // WINDOW_UPDATE shortly after sending SETTINGS.
  375. sc.flow.add(initialWindowSize)
  376. sc.inflow.add(initialWindowSize)
  377. sc.hpackEncoder = hpack.NewEncoder(&sc.headerWriteBuf)
  378. fr := NewFramer(sc.bw, c)
  379. if s.CountError != nil {
  380. fr.countError = s.CountError
  381. }
  382. fr.ReadMetaHeaders = hpack.NewDecoder(initialHeaderTableSize, nil)
  383. fr.MaxHeaderListSize = sc.maxHeaderListSize()
  384. fr.SetMaxReadFrameSize(s.maxReadFrameSize())
  385. sc.framer = fr
  386. if tc, ok := c.(connectionStater); ok {
  387. sc.tlsState = new(tls.ConnectionState)
  388. *sc.tlsState = tc.ConnectionState()
  389. // 9.2 Use of TLS Features
  390. // An implementation of HTTP/2 over TLS MUST use TLS
  391. // 1.2 or higher with the restrictions on feature set
  392. // and cipher suite described in this section. Due to
  393. // implementation limitations, it might not be
  394. // possible to fail TLS negotiation. An endpoint MUST
  395. // immediately terminate an HTTP/2 connection that
  396. // does not meet the TLS requirements described in
  397. // this section with a connection error (Section
  398. // 5.4.1) of type INADEQUATE_SECURITY.
  399. if sc.tlsState.Version < tls.VersionTLS12 {
  400. sc.rejectConn(ErrCodeInadequateSecurity, "TLS version too low")
  401. return
  402. }
  403. if sc.tlsState.ServerName == "" {
  404. // Client must use SNI, but we don't enforce that anymore,
  405. // since it was causing problems when connecting to bare IP
  406. // addresses during development.
  407. //
  408. // TODO: optionally enforce? Or enforce at the time we receive
  409. // a new request, and verify the ServerName matches the :authority?
  410. // But that precludes proxy situations, perhaps.
  411. //
  412. // So for now, do nothing here again.
  413. }
  414. if !s.PermitProhibitedCipherSuites && isBadCipher(sc.tlsState.CipherSuite) {
  415. // "Endpoints MAY choose to generate a connection error
  416. // (Section 5.4.1) of type INADEQUATE_SECURITY if one of
  417. // the prohibited cipher suites are negotiated."
  418. //
  419. // We choose that. In my opinion, the spec is weak
  420. // here. It also says both parties must support at least
  421. // TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 so there's no
  422. // excuses here. If we really must, we could allow an
  423. // "AllowInsecureWeakCiphers" option on the server later.
  424. // Let's see how it plays out first.
  425. sc.rejectConn(ErrCodeInadequateSecurity, fmt.Sprintf("Prohibited TLS 1.2 Cipher Suite: %x", sc.tlsState.CipherSuite))
  426. return
  427. }
  428. }
  429. if opts.Settings != nil {
  430. fr := &SettingsFrame{
  431. FrameHeader: FrameHeader{valid: true},
  432. p: opts.Settings,
  433. }
  434. if err := fr.ForeachSetting(sc.processSetting); err != nil {
  435. sc.rejectConn(ErrCodeProtocol, "invalid settings")
  436. return
  437. }
  438. opts.Settings = nil
  439. }
  440. if hook := testHookGetServerConn; hook != nil {
  441. hook(sc)
  442. }
  443. if opts.UpgradeRequest != nil {
  444. sc.upgradeRequest(opts.UpgradeRequest)
  445. opts.UpgradeRequest = nil
  446. }
  447. sc.serve()
  448. }
  449. func serverConnBaseContext(c net.Conn, opts *ServeConnOpts) (ctx context.Context, cancel func()) {
  450. ctx, cancel = context.WithCancel(opts.context())
  451. ctx = context.WithValue(ctx, http.LocalAddrContextKey, c.LocalAddr())
  452. if hs := opts.baseConfig(); hs != nil {
  453. ctx = context.WithValue(ctx, http.ServerContextKey, hs)
  454. }
  455. return
  456. }
  457. func (sc *serverConn) rejectConn(err ErrCode, debug string) {
  458. sc.vlogf("http2: server rejecting conn: %v, %s", err, debug)
  459. // ignoring errors. hanging up anyway.
  460. sc.framer.WriteGoAway(0, err, []byte(debug))
  461. sc.bw.Flush()
  462. sc.conn.Close()
  463. }
  464. type serverConn struct {
  465. // Immutable:
  466. srv *Server
  467. hs *http.Server
  468. conn net.Conn
  469. bw *bufferedWriter // writing to conn
  470. handler http.Handler
  471. baseCtx context.Context
  472. framer *Framer
  473. doneServing chan struct{} // closed when serverConn.serve ends
  474. readFrameCh chan readFrameResult // written by serverConn.readFrames
  475. wantWriteFrameCh chan FrameWriteRequest // from handlers -> serve
  476. wroteFrameCh chan frameWriteResult // from writeFrameAsync -> serve, tickles more frame writes
  477. bodyReadCh chan bodyReadMsg // from handlers -> serve
  478. serveMsgCh chan interface{} // misc messages & code to send to / run on the serve loop
  479. flow flow // conn-wide (not stream-specific) outbound flow control
  480. inflow flow // conn-wide inbound flow control
  481. tlsState *tls.ConnectionState // shared by all handlers, like net/http
  482. remoteAddrStr string
  483. writeSched WriteScheduler
  484. // Everything following is owned by the serve loop; use serveG.check():
  485. serveG goroutineLock // used to verify funcs are on serve()
  486. pushEnabled bool
  487. sawClientPreface bool // preface has already been read, used in h2c upgrade
  488. sawFirstSettings bool // got the initial SETTINGS frame after the preface
  489. needToSendSettingsAck bool
  490. unackedSettings int // how many SETTINGS have we sent without ACKs?
  491. queuedControlFrames int // control frames in the writeSched queue
  492. clientMaxStreams uint32 // SETTINGS_MAX_CONCURRENT_STREAMS from client (our PUSH_PROMISE limit)
  493. advMaxStreams uint32 // our SETTINGS_MAX_CONCURRENT_STREAMS advertised the client
  494. curClientStreams uint32 // number of open streams initiated by the client
  495. curPushedStreams uint32 // number of open streams initiated by server push
  496. maxClientStreamID uint32 // max ever seen from client (odd), or 0 if there have been no client requests
  497. maxPushPromiseID uint32 // ID of the last push promise (even), or 0 if there have been no pushes
  498. streams map[uint32]*stream
  499. initialStreamSendWindowSize int32
  500. maxFrameSize int32
  501. headerTableSize uint32
  502. peerMaxHeaderListSize uint32 // zero means unknown (default)
  503. canonHeader map[string]string // http2-lower-case -> Go-Canonical-Case
  504. writingFrame bool // started writing a frame (on serve goroutine or separate)
  505. writingFrameAsync bool // started a frame on its own goroutine but haven't heard back on wroteFrameCh
  506. needsFrameFlush bool // last frame write wasn't a flush
  507. inGoAway bool // we've started to or sent GOAWAY
  508. inFrameScheduleLoop bool // whether we're in the scheduleFrameWrite loop
  509. needToSendGoAway bool // we need to schedule a GOAWAY frame write
  510. goAwayCode ErrCode
  511. shutdownTimer *time.Timer // nil until used
  512. idleTimer *time.Timer // nil if unused
  513. // Owned by the writeFrameAsync goroutine:
  514. headerWriteBuf bytes.Buffer
  515. hpackEncoder *hpack.Encoder
  516. // Used by startGracefulShutdown.
  517. shutdownOnce sync.Once
  518. }
  519. func (sc *serverConn) maxHeaderListSize() uint32 {
  520. n := sc.hs.MaxHeaderBytes
  521. if n <= 0 {
  522. n = http.DefaultMaxHeaderBytes
  523. }
  524. // http2's count is in a slightly different unit and includes 32 bytes per pair.
  525. // So, take the net/http.Server value and pad it up a bit, assuming 10 headers.
  526. const perFieldOverhead = 32 // per http2 spec
  527. const typicalHeaders = 10 // conservative
  528. return uint32(n + typicalHeaders*perFieldOverhead)
  529. }
  530. func (sc *serverConn) curOpenStreams() uint32 {
  531. sc.serveG.check()
  532. return sc.curClientStreams + sc.curPushedStreams
  533. }
  534. // stream represents a stream. This is the minimal metadata needed by
  535. // the serve goroutine. Most of the actual stream state is owned by
  536. // the http.Handler's goroutine in the responseWriter. Because the
  537. // responseWriter's responseWriterState is recycled at the end of a
  538. // handler, this struct intentionally has no pointer to the
  539. // *responseWriter{,State} itself, as the Handler ending nils out the
  540. // responseWriter's state field.
  541. type stream struct {
  542. // immutable:
  543. sc *serverConn
  544. id uint32
  545. body *pipe // non-nil if expecting DATA frames
  546. cw closeWaiter // closed wait stream transitions to closed state
  547. ctx context.Context
  548. cancelCtx func()
  549. // owned by serverConn's serve loop:
  550. bodyBytes int64 // body bytes seen so far
  551. declBodyBytes int64 // or -1 if undeclared
  552. flow flow // limits writing from Handler to client
  553. inflow flow // what the client is allowed to POST/etc to us
  554. state streamState
  555. resetQueued bool // RST_STREAM queued for write; set by sc.resetStream
  556. gotTrailerHeader bool // HEADER frame for trailers was seen
  557. wroteHeaders bool // whether we wrote headers (not status 100)
  558. writeDeadline *time.Timer // nil if unused
  559. trailer http.Header // accumulated trailers
  560. reqTrailer http.Header // handler's Request.Trailer
  561. }
  562. func (sc *serverConn) Framer() *Framer { return sc.framer }
  563. func (sc *serverConn) CloseConn() error { return sc.conn.Close() }
  564. func (sc *serverConn) Flush() error { return sc.bw.Flush() }
  565. func (sc *serverConn) HeaderEncoder() (*hpack.Encoder, *bytes.Buffer) {
  566. return sc.hpackEncoder, &sc.headerWriteBuf
  567. }
  568. func (sc *serverConn) state(streamID uint32) (streamState, *stream) {
  569. sc.serveG.check()
  570. // http://tools.ietf.org/html/rfc7540#section-5.1
  571. if st, ok := sc.streams[streamID]; ok {
  572. return st.state, st
  573. }
  574. // "The first use of a new stream identifier implicitly closes all
  575. // streams in the "idle" state that might have been initiated by
  576. // that peer with a lower-valued stream identifier. For example, if
  577. // a client sends a HEADERS frame on stream 7 without ever sending a
  578. // frame on stream 5, then stream 5 transitions to the "closed"
  579. // state when the first frame for stream 7 is sent or received."
  580. if streamID%2 == 1 {
  581. if streamID <= sc.maxClientStreamID {
  582. return stateClosed, nil
  583. }
  584. } else {
  585. if streamID <= sc.maxPushPromiseID {
  586. return stateClosed, nil
  587. }
  588. }
  589. return stateIdle, nil
  590. }
  591. // setConnState calls the net/http ConnState hook for this connection, if configured.
  592. // Note that the net/http package does StateNew and StateClosed for us.
  593. // There is currently no plan for StateHijacked or hijacking HTTP/2 connections.
  594. func (sc *serverConn) setConnState(state http.ConnState) {
  595. if sc.hs.ConnState != nil {
  596. sc.hs.ConnState(sc.conn, state)
  597. }
  598. }
  599. func (sc *serverConn) vlogf(format string, args ...interface{}) {
  600. if VerboseLogs {
  601. sc.logf(format, args...)
  602. }
  603. }
  604. func (sc *serverConn) logf(format string, args ...interface{}) {
  605. if lg := sc.hs.ErrorLog; lg != nil {
  606. lg.Printf(format, args...)
  607. } else {
  608. log.Printf(format, args...)
  609. }
  610. }
  611. // errno returns v's underlying uintptr, else 0.
  612. //
  613. // TODO: remove this helper function once http2 can use build
  614. // tags. See comment in isClosedConnError.
  615. func errno(v error) uintptr {
  616. if rv := reflect.ValueOf(v); rv.Kind() == reflect.Uintptr {
  617. return uintptr(rv.Uint())
  618. }
  619. return 0
  620. }
  621. // isClosedConnError reports whether err is an error from use of a closed
  622. // network connection.
  623. func isClosedConnError(err error) bool {
  624. if err == nil {
  625. return false
  626. }
  627. // TODO: remove this string search and be more like the Windows
  628. // case below. That might involve modifying the standard library
  629. // to return better error types.
  630. str := err.Error()
  631. if strings.Contains(str, "use of closed network connection") {
  632. return true
  633. }
  634. // TODO(bradfitz): x/tools/cmd/bundle doesn't really support
  635. // build tags, so I can't make an http2_windows.go file with
  636. // Windows-specific stuff. Fix that and move this, once we
  637. // have a way to bundle this into std's net/http somehow.
  638. if runtime.GOOS == "windows" {
  639. if oe, ok := err.(*net.OpError); ok && oe.Op == "read" {
  640. if se, ok := oe.Err.(*os.SyscallError); ok && se.Syscall == "wsarecv" {
  641. const WSAECONNABORTED = 10053
  642. const WSAECONNRESET = 10054
  643. if n := errno(se.Err); n == WSAECONNRESET || n == WSAECONNABORTED {
  644. return true
  645. }
  646. }
  647. }
  648. }
  649. return false
  650. }
  651. func (sc *serverConn) condlogf(err error, format string, args ...interface{}) {
  652. if err == nil {
  653. return
  654. }
  655. if err == io.EOF || err == io.ErrUnexpectedEOF || isClosedConnError(err) || err == errPrefaceTimeout {
  656. // Boring, expected errors.
  657. sc.vlogf(format, args...)
  658. } else {
  659. sc.logf(format, args...)
  660. }
  661. }
  662. func (sc *serverConn) canonicalHeader(v string) string {
  663. sc.serveG.check()
  664. buildCommonHeaderMapsOnce()
  665. cv, ok := commonCanonHeader[v]
  666. if ok {
  667. return cv
  668. }
  669. cv, ok = sc.canonHeader[v]
  670. if ok {
  671. return cv
  672. }
  673. if sc.canonHeader == nil {
  674. sc.canonHeader = make(map[string]string)
  675. }
  676. cv = http.CanonicalHeaderKey(v)
  677. // maxCachedCanonicalHeaders is an arbitrarily-chosen limit on the number of
  678. // entries in the canonHeader cache. This should be larger than the number
  679. // of unique, uncommon header keys likely to be sent by the peer, while not
  680. // so high as to permit unreasonable memory usage if the peer sends an unbounded
  681. // number of unique header keys.
  682. const maxCachedCanonicalHeaders = 32
  683. if len(sc.canonHeader) < maxCachedCanonicalHeaders {
  684. sc.canonHeader[v] = cv
  685. }
  686. return cv
  687. }
  688. type readFrameResult struct {
  689. f Frame // valid until readMore is called
  690. err error
  691. // readMore should be called once the consumer no longer needs or
  692. // retains f. After readMore, f is invalid and more frames can be
  693. // read.
  694. readMore func()
  695. }
  696. // readFrames is the loop that reads incoming frames.
  697. // It takes care to only read one frame at a time, blocking until the
  698. // consumer is done with the frame.
  699. // It's run on its own goroutine.
  700. func (sc *serverConn) readFrames() {
  701. gate := make(gate)
  702. gateDone := gate.Done
  703. for {
  704. f, err := sc.framer.ReadFrame()
  705. select {
  706. case sc.readFrameCh <- readFrameResult{f, err, gateDone}:
  707. case <-sc.doneServing:
  708. return
  709. }
  710. select {
  711. case <-gate:
  712. case <-sc.doneServing:
  713. return
  714. }
  715. if terminalReadFrameError(err) {
  716. return
  717. }
  718. }
  719. }
  720. // frameWriteResult is the message passed from writeFrameAsync to the serve goroutine.
  721. type frameWriteResult struct {
  722. _ incomparable
  723. wr FrameWriteRequest // what was written (or attempted)
  724. err error // result of the writeFrame call
  725. }
  726. // writeFrameAsync runs in its own goroutine and writes a single frame
  727. // and then reports when it's done.
  728. // At most one goroutine can be running writeFrameAsync at a time per
  729. // serverConn.
  730. func (sc *serverConn) writeFrameAsync(wr FrameWriteRequest) {
  731. err := wr.write.writeFrame(sc)
  732. sc.wroteFrameCh <- frameWriteResult{wr: wr, err: err}
  733. }
  734. func (sc *serverConn) closeAllStreamsOnConnClose() {
  735. sc.serveG.check()
  736. for _, st := range sc.streams {
  737. sc.closeStream(st, errClientDisconnected)
  738. }
  739. }
  740. func (sc *serverConn) stopShutdownTimer() {
  741. sc.serveG.check()
  742. if t := sc.shutdownTimer; t != nil {
  743. t.Stop()
  744. }
  745. }
  746. func (sc *serverConn) notePanic() {
  747. // Note: this is for serverConn.serve panicking, not http.Handler code.
  748. if testHookOnPanicMu != nil {
  749. testHookOnPanicMu.Lock()
  750. defer testHookOnPanicMu.Unlock()
  751. }
  752. if testHookOnPanic != nil {
  753. if e := recover(); e != nil {
  754. if testHookOnPanic(sc, e) {
  755. panic(e)
  756. }
  757. }
  758. }
  759. }
  760. func (sc *serverConn) serve() {
  761. sc.serveG.check()
  762. defer sc.notePanic()
  763. defer sc.conn.Close()
  764. defer sc.closeAllStreamsOnConnClose()
  765. defer sc.stopShutdownTimer()
  766. defer close(sc.doneServing) // unblocks handlers trying to send
  767. if VerboseLogs {
  768. sc.vlogf("http2: server connection from %v on %p", sc.conn.RemoteAddr(), sc.hs)
  769. }
  770. sc.writeFrame(FrameWriteRequest{
  771. write: writeSettings{
  772. {SettingMaxFrameSize, sc.srv.maxReadFrameSize()},
  773. {SettingMaxConcurrentStreams, sc.advMaxStreams},
  774. {SettingMaxHeaderListSize, sc.maxHeaderListSize()},
  775. {SettingInitialWindowSize, uint32(sc.srv.initialStreamRecvWindowSize())},
  776. },
  777. })
  778. sc.unackedSettings++
  779. // Each connection starts with initialWindowSize inflow tokens.
  780. // If a higher value is configured, we add more tokens.
  781. if diff := sc.srv.initialConnRecvWindowSize() - initialWindowSize; diff > 0 {
  782. sc.sendWindowUpdate(nil, int(diff))
  783. }
  784. if err := sc.readPreface(); err != nil {
  785. sc.condlogf(err, "http2: server: error reading preface from client %v: %v", sc.conn.RemoteAddr(), err)
  786. return
  787. }
  788. // Now that we've got the preface, get us out of the
  789. // "StateNew" state. We can't go directly to idle, though.
  790. // Active means we read some data and anticipate a request. We'll
  791. // do another Active when we get a HEADERS frame.
  792. sc.setConnState(http.StateActive)
  793. sc.setConnState(http.StateIdle)
  794. if sc.srv.IdleTimeout != 0 {
  795. sc.idleTimer = time.AfterFunc(sc.srv.IdleTimeout, sc.onIdleTimer)
  796. defer sc.idleTimer.Stop()
  797. }
  798. go sc.readFrames() // closed by defer sc.conn.Close above
  799. settingsTimer := time.AfterFunc(firstSettingsTimeout, sc.onSettingsTimer)
  800. defer settingsTimer.Stop()
  801. loopNum := 0
  802. for {
  803. loopNum++
  804. select {
  805. case wr := <-sc.wantWriteFrameCh:
  806. if se, ok := wr.write.(StreamError); ok {
  807. sc.resetStream(se)
  808. break
  809. }
  810. sc.writeFrame(wr)
  811. case res := <-sc.wroteFrameCh:
  812. sc.wroteFrame(res)
  813. case res := <-sc.readFrameCh:
  814. // Process any written frames before reading new frames from the client since a
  815. // written frame could have triggered a new stream to be started.
  816. if sc.writingFrameAsync {
  817. select {
  818. case wroteRes := <-sc.wroteFrameCh:
  819. sc.wroteFrame(wroteRes)
  820. default:
  821. }
  822. }
  823. if !sc.processFrameFromReader(res) {
  824. return
  825. }
  826. res.readMore()
  827. if settingsTimer != nil {
  828. settingsTimer.Stop()
  829. settingsTimer = nil
  830. }
  831. case m := <-sc.bodyReadCh:
  832. sc.noteBodyRead(m.st, m.n)
  833. case msg := <-sc.serveMsgCh:
  834. switch v := msg.(type) {
  835. case func(int):
  836. v(loopNum) // for testing
  837. case *serverMessage:
  838. switch v {
  839. case settingsTimerMsg:
  840. sc.logf("timeout waiting for SETTINGS frames from %v", sc.conn.RemoteAddr())
  841. return
  842. case idleTimerMsg:
  843. sc.vlogf("connection is idle")
  844. sc.goAway(ErrCodeNo)
  845. case shutdownTimerMsg:
  846. sc.vlogf("GOAWAY close timer fired; closing conn from %v", sc.conn.RemoteAddr())
  847. return
  848. case gracefulShutdownMsg:
  849. sc.startGracefulShutdownInternal()
  850. default:
  851. panic("unknown timer")
  852. }
  853. case *startPushRequest:
  854. sc.startPush(v)
  855. default:
  856. panic(fmt.Sprintf("unexpected type %T", v))
  857. }
  858. }
  859. // If the peer is causing us to generate a lot of control frames,
  860. // but not reading them from us, assume they are trying to make us
  861. // run out of memory.
  862. if sc.queuedControlFrames > sc.srv.maxQueuedControlFrames() {
  863. sc.vlogf("http2: too many control frames in send queue, closing connection")
  864. return
  865. }
  866. // Start the shutdown timer after sending a GOAWAY. When sending GOAWAY
  867. // with no error code (graceful shutdown), don't start the timer until
  868. // all open streams have been completed.
  869. sentGoAway := sc.inGoAway && !sc.needToSendGoAway && !sc.writingFrame
  870. gracefulShutdownComplete := sc.goAwayCode == ErrCodeNo && sc.curOpenStreams() == 0
  871. if sentGoAway && sc.shutdownTimer == nil && (sc.goAwayCode != ErrCodeNo || gracefulShutdownComplete) {
  872. sc.shutDownIn(goAwayTimeout)
  873. }
  874. }
  875. }
  876. func (sc *serverConn) awaitGracefulShutdown(sharedCh <-chan struct{}, privateCh chan struct{}) {
  877. select {
  878. case <-sc.doneServing:
  879. case <-sharedCh:
  880. close(privateCh)
  881. }
  882. }
  883. type serverMessage int
  884. // Message values sent to serveMsgCh.
  885. var (
  886. settingsTimerMsg = new(serverMessage)
  887. idleTimerMsg = new(serverMessage)
  888. shutdownTimerMsg = new(serverMessage)
  889. gracefulShutdownMsg = new(serverMessage)
  890. )
  891. func (sc *serverConn) onSettingsTimer() { sc.sendServeMsg(settingsTimerMsg) }
  892. func (sc *serverConn) onIdleTimer() { sc.sendServeMsg(idleTimerMsg) }
  893. func (sc *serverConn) onShutdownTimer() { sc.sendServeMsg(shutdownTimerMsg) }
  894. func (sc *serverConn) sendServeMsg(msg interface{}) {
  895. sc.serveG.checkNotOn() // NOT
  896. select {
  897. case sc.serveMsgCh <- msg:
  898. case <-sc.doneServing:
  899. }
  900. }
  901. var errPrefaceTimeout = errors.New("timeout waiting for client preface")
  902. // readPreface reads the ClientPreface greeting from the peer or
  903. // returns errPrefaceTimeout on timeout, or an error if the greeting
  904. // is invalid.
  905. func (sc *serverConn) readPreface() error {
  906. if sc.sawClientPreface {
  907. return nil
  908. }
  909. errc := make(chan error, 1)
  910. go func() {
  911. // Read the client preface
  912. buf := make([]byte, len(ClientPreface))
  913. if _, err := io.ReadFull(sc.conn, buf); err != nil {
  914. errc <- err
  915. } else if !bytes.Equal(buf, clientPreface) {
  916. errc <- fmt.Errorf("bogus greeting %q", buf)
  917. } else {
  918. errc <- nil
  919. }
  920. }()
  921. timer := time.NewTimer(prefaceTimeout) // TODO: configurable on *Server?
  922. defer timer.Stop()
  923. select {
  924. case <-timer.C:
  925. return errPrefaceTimeout
  926. case err := <-errc:
  927. if err == nil {
  928. if VerboseLogs {
  929. sc.vlogf("http2: server: client %v said hello", sc.conn.RemoteAddr())
  930. }
  931. }
  932. return err
  933. }
  934. }
  935. var errChanPool = sync.Pool{
  936. New: func() interface{} { return make(chan error, 1) },
  937. }
  938. var writeDataPool = sync.Pool{
  939. New: func() interface{} { return new(writeData) },
  940. }
  941. // writeDataFromHandler writes DATA response frames from a handler on
  942. // the given stream.
  943. func (sc *serverConn) writeDataFromHandler(stream *stream, data []byte, endStream bool) error {
  944. ch := errChanPool.Get().(chan error)
  945. writeArg := writeDataPool.Get().(*writeData)
  946. *writeArg = writeData{stream.id, data, endStream}
  947. err := sc.writeFrameFromHandler(FrameWriteRequest{
  948. write: writeArg,
  949. stream: stream,
  950. done: ch,
  951. })
  952. if err != nil {
  953. return err
  954. }
  955. var frameWriteDone bool // the frame write is done (successfully or not)
  956. select {
  957. case err = <-ch:
  958. frameWriteDone = true
  959. case <-sc.doneServing:
  960. return errClientDisconnected
  961. case <-stream.cw:
  962. // If both ch and stream.cw were ready (as might
  963. // happen on the final Write after an http.Handler
  964. // ends), prefer the write result. Otherwise this
  965. // might just be us successfully closing the stream.
  966. // The writeFrameAsync and serve goroutines guarantee
  967. // that the ch send will happen before the stream.cw
  968. // close.
  969. select {
  970. case err = <-ch:
  971. frameWriteDone = true
  972. default:
  973. return errStreamClosed
  974. }
  975. }
  976. errChanPool.Put(ch)
  977. if frameWriteDone {
  978. writeDataPool.Put(writeArg)
  979. }
  980. return err
  981. }
  982. // writeFrameFromHandler sends wr to sc.wantWriteFrameCh, but aborts
  983. // if the connection has gone away.
  984. //
  985. // This must not be run from the serve goroutine itself, else it might
  986. // deadlock writing to sc.wantWriteFrameCh (which is only mildly
  987. // buffered and is read by serve itself). If you're on the serve
  988. // goroutine, call writeFrame instead.
  989. func (sc *serverConn) writeFrameFromHandler(wr FrameWriteRequest) error {
  990. sc.serveG.checkNotOn() // NOT
  991. select {
  992. case sc.wantWriteFrameCh <- wr:
  993. return nil
  994. case <-sc.doneServing:
  995. // Serve loop is gone.
  996. // Client has closed their connection to the server.
  997. return errClientDisconnected
  998. }
  999. }
  1000. // writeFrame schedules a frame to write and sends it if there's nothing
  1001. // already being written.
  1002. //
  1003. // There is no pushback here (the serve goroutine never blocks). It's
  1004. // the http.Handlers that block, waiting for their previous frames to
  1005. // make it onto the wire
  1006. //
  1007. // If you're not on the serve goroutine, use writeFrameFromHandler instead.
  1008. func (sc *serverConn) writeFrame(wr FrameWriteRequest) {
  1009. sc.serveG.check()
  1010. // If true, wr will not be written and wr.done will not be signaled.
  1011. var ignoreWrite bool
  1012. // We are not allowed to write frames on closed streams. RFC 7540 Section
  1013. // 5.1.1 says: "An endpoint MUST NOT send frames other than PRIORITY on
  1014. // a closed stream." Our server never sends PRIORITY, so that exception
  1015. // does not apply.
  1016. //
  1017. // The serverConn might close an open stream while the stream's handler
  1018. // is still running. For example, the server might close a stream when it
  1019. // receives bad data from the client. If this happens, the handler might
  1020. // attempt to write a frame after the stream has been closed (since the
  1021. // handler hasn't yet been notified of the close). In this case, we simply
  1022. // ignore the frame. The handler will notice that the stream is closed when
  1023. // it waits for the frame to be written.
  1024. //
  1025. // As an exception to this rule, we allow sending RST_STREAM after close.
  1026. // This allows us to immediately reject new streams without tracking any
  1027. // state for those streams (except for the queued RST_STREAM frame). This
  1028. // may result in duplicate RST_STREAMs in some cases, but the client should
  1029. // ignore those.
  1030. if wr.StreamID() != 0 {
  1031. _, isReset := wr.write.(StreamError)
  1032. if state, _ := sc.state(wr.StreamID()); state == stateClosed && !isReset {
  1033. ignoreWrite = true
  1034. }
  1035. }
  1036. // Don't send a 100-continue response if we've already sent headers.
  1037. // See golang.org/issue/14030.
  1038. switch wr.write.(type) {
  1039. case *writeResHeaders:
  1040. wr.stream.wroteHeaders = true
  1041. case write100ContinueHeadersFrame:
  1042. if wr.stream.wroteHeaders {
  1043. // We do not need to notify wr.done because this frame is
  1044. // never written with wr.done != nil.
  1045. if wr.done != nil {
  1046. panic("wr.done != nil for write100ContinueHeadersFrame")
  1047. }
  1048. ignoreWrite = true
  1049. }
  1050. }
  1051. if !ignoreWrite {
  1052. if wr.isControl() {
  1053. sc.queuedControlFrames++
  1054. // For extra safety, detect wraparounds, which should not happen,
  1055. // and pull the plug.
  1056. if sc.queuedControlFrames < 0 {
  1057. sc.conn.Close()
  1058. }
  1059. }
  1060. sc.writeSched.Push(wr)
  1061. }
  1062. sc.scheduleFrameWrite()
  1063. }
  1064. // startFrameWrite starts a goroutine to write wr (in a separate
  1065. // goroutine since that might block on the network), and updates the
  1066. // serve goroutine's state about the world, updated from info in wr.
  1067. func (sc *serverConn) startFrameWrite(wr FrameWriteRequest) {
  1068. sc.serveG.check()
  1069. if sc.writingFrame {
  1070. panic("internal error: can only be writing one frame at a time")
  1071. }
  1072. st := wr.stream
  1073. if st != nil {
  1074. switch st.state {
  1075. case stateHalfClosedLocal:
  1076. switch wr.write.(type) {
  1077. case StreamError, handlerPanicRST, writeWindowUpdate:
  1078. // RFC 7540 Section 5.1 allows sending RST_STREAM, PRIORITY, and WINDOW_UPDATE
  1079. // in this state. (We never send PRIORITY from the server, so that is not checked.)
  1080. default:
  1081. panic(fmt.Sprintf("internal error: attempt to send frame on a half-closed-local stream: %v", wr))
  1082. }
  1083. case stateClosed:
  1084. panic(fmt.Sprintf("internal error: attempt to send frame on a closed stream: %v", wr))
  1085. }
  1086. }
  1087. if wpp, ok := wr.write.(*writePushPromise); ok {
  1088. var err error
  1089. wpp.promisedID, err = wpp.allocatePromisedID()
  1090. if err != nil {
  1091. sc.writingFrameAsync = false
  1092. wr.replyToWriter(err)
  1093. return
  1094. }
  1095. }
  1096. sc.writingFrame = true
  1097. sc.needsFrameFlush = true
  1098. if wr.write.staysWithinBuffer(sc.bw.Available()) {
  1099. sc.writingFrameAsync = false
  1100. err := wr.write.writeFrame(sc)
  1101. sc.wroteFrame(frameWriteResult{wr: wr, err: err})
  1102. } else {
  1103. sc.writingFrameAsync = true
  1104. go sc.writeFrameAsync(wr)
  1105. }
  1106. }
  1107. // errHandlerPanicked is the error given to any callers blocked in a read from
  1108. // Request.Body when the main goroutine panics. Since most handlers read in the
  1109. // main ServeHTTP goroutine, this will show up rarely.
  1110. var errHandlerPanicked = errors.New("http2: handler panicked")
  1111. // wroteFrame is called on the serve goroutine with the result of
  1112. // whatever happened on writeFrameAsync.
  1113. func (sc *serverConn) wroteFrame(res frameWriteResult) {
  1114. sc.serveG.check()
  1115. if !sc.writingFrame {
  1116. panic("internal error: expected to be already writing a frame")
  1117. }
  1118. sc.writingFrame = false
  1119. sc.writingFrameAsync = false
  1120. wr := res.wr
  1121. if writeEndsStream(wr.write) {
  1122. st := wr.stream
  1123. if st == nil {
  1124. panic("internal error: expecting non-nil stream")
  1125. }
  1126. switch st.state {
  1127. case stateOpen:
  1128. // Here we would go to stateHalfClosedLocal in
  1129. // theory, but since our handler is done and
  1130. // the net/http package provides no mechanism
  1131. // for closing a ResponseWriter while still
  1132. // reading data (see possible TODO at top of
  1133. // this file), we go into closed state here
  1134. // anyway, after telling the peer we're
  1135. // hanging up on them. We'll transition to
  1136. // stateClosed after the RST_STREAM frame is
  1137. // written.
  1138. st.state = stateHalfClosedLocal
  1139. // Section 8.1: a server MAY request that the client abort
  1140. // transmission of a request without error by sending a
  1141. // RST_STREAM with an error code of NO_ERROR after sending
  1142. // a complete response.
  1143. sc.resetStream(streamError(st.id, ErrCodeNo))
  1144. case stateHalfClosedRemote:
  1145. sc.closeStream(st, errHandlerComplete)
  1146. }
  1147. } else {
  1148. switch v := wr.write.(type) {
  1149. case StreamError:
  1150. // st may be unknown if the RST_STREAM was generated to reject bad input.
  1151. if st, ok := sc.streams[v.StreamID]; ok {
  1152. sc.closeStream(st, v)
  1153. }
  1154. case handlerPanicRST:
  1155. sc.closeStream(wr.stream, errHandlerPanicked)
  1156. }
  1157. }
  1158. // Reply (if requested) to unblock the ServeHTTP goroutine.
  1159. wr.replyToWriter(res.err)
  1160. sc.scheduleFrameWrite()
  1161. }
  1162. // scheduleFrameWrite tickles the frame writing scheduler.
  1163. //
  1164. // If a frame is already being written, nothing happens. This will be called again
  1165. // when the frame is done being written.
  1166. //
  1167. // If a frame isn't being written and we need to send one, the best frame
  1168. // to send is selected by writeSched.
  1169. //
  1170. // If a frame isn't being written and there's nothing else to send, we
  1171. // flush the write buffer.
  1172. func (sc *serverConn) scheduleFrameWrite() {
  1173. sc.serveG.check()
  1174. if sc.writingFrame || sc.inFrameScheduleLoop {
  1175. return
  1176. }
  1177. sc.inFrameScheduleLoop = true
  1178. for !sc.writingFrameAsync {
  1179. if sc.needToSendGoAway {
  1180. sc.needToSendGoAway = false
  1181. sc.startFrameWrite(FrameWriteRequest{
  1182. write: &writeGoAway{
  1183. maxStreamID: sc.maxClientStreamID,
  1184. code: sc.goAwayCode,
  1185. },
  1186. })
  1187. continue
  1188. }
  1189. if sc.needToSendSettingsAck {
  1190. sc.needToSendSettingsAck = false
  1191. sc.startFrameWrite(FrameWriteRequest{write: writeSettingsAck{}})
  1192. continue
  1193. }
  1194. if !sc.inGoAway || sc.goAwayCode == ErrCodeNo {
  1195. if wr, ok := sc.writeSched.Pop(); ok {
  1196. if wr.isControl() {
  1197. sc.queuedControlFrames--
  1198. }
  1199. sc.startFrameWrite(wr)
  1200. continue
  1201. }
  1202. }
  1203. if sc.needsFrameFlush {
  1204. sc.startFrameWrite(FrameWriteRequest{write: flushFrameWriter{}})
  1205. sc.needsFrameFlush = false // after startFrameWrite, since it sets this true
  1206. continue
  1207. }
  1208. break
  1209. }
  1210. sc.inFrameScheduleLoop = false
  1211. }
  1212. // startGracefulShutdown gracefully shuts down a connection. This
  1213. // sends GOAWAY with ErrCodeNo to tell the client we're gracefully
  1214. // shutting down. The connection isn't closed until all current
  1215. // streams are done.
  1216. //
  1217. // startGracefulShutdown returns immediately; it does not wait until
  1218. // the connection has shut down.
  1219. func (sc *serverConn) startGracefulShutdown() {
  1220. sc.serveG.checkNotOn() // NOT
  1221. sc.shutdownOnce.Do(func() { sc.sendServeMsg(gracefulShutdownMsg) })
  1222. }
  1223. // After sending GOAWAY with an error code (non-graceful shutdown), the
  1224. // connection will close after goAwayTimeout.
  1225. //
  1226. // If we close the connection immediately after sending GOAWAY, there may
  1227. // be unsent data in our kernel receive buffer, which will cause the kernel
  1228. // to send a TCP RST on close() instead of a FIN. This RST will abort the
  1229. // connection immediately, whether or not the client had received the GOAWAY.
  1230. //
  1231. // Ideally we should delay for at least 1 RTT + epsilon so the client has
  1232. // a chance to read the GOAWAY and stop sending messages. Measuring RTT
  1233. // is hard, so we approximate with 1 second. See golang.org/issue/18701.
  1234. //
  1235. // This is a var so it can be shorter in tests, where all requests uses the
  1236. // loopback interface making the expected RTT very small.
  1237. //
  1238. // TODO: configurable?
  1239. var goAwayTimeout = 1 * time.Second
  1240. func (sc *serverConn) startGracefulShutdownInternal() {
  1241. sc.goAway(ErrCodeNo)
  1242. }
  1243. func (sc *serverConn) goAway(code ErrCode) {
  1244. sc.serveG.check()
  1245. if sc.inGoAway {
  1246. return
  1247. }
  1248. sc.inGoAway = true
  1249. sc.needToSendGoAway = true
  1250. sc.goAwayCode = code
  1251. sc.scheduleFrameWrite()
  1252. }
  1253. func (sc *serverConn) shutDownIn(d time.Duration) {
  1254. sc.serveG.check()
  1255. sc.shutdownTimer = time.AfterFunc(d, sc.onShutdownTimer)
  1256. }
  1257. func (sc *serverConn) resetStream(se StreamError) {
  1258. sc.serveG.check()
  1259. sc.writeFrame(FrameWriteRequest{write: se})
  1260. if st, ok := sc.streams[se.StreamID]; ok {
  1261. st.resetQueued = true
  1262. }
  1263. }
  1264. // processFrameFromReader processes the serve loop's read from readFrameCh from the
  1265. // frame-reading goroutine.
  1266. // processFrameFromReader returns whether the connection should be kept open.
  1267. func (sc *serverConn) processFrameFromReader(res readFrameResult) bool {
  1268. sc.serveG.check()
  1269. err := res.err
  1270. if err != nil {
  1271. if err == ErrFrameTooLarge {
  1272. sc.goAway(ErrCodeFrameSize)
  1273. return true // goAway will close the loop
  1274. }
  1275. clientGone := err == io.EOF || err == io.ErrUnexpectedEOF || isClosedConnError(err)
  1276. if clientGone {
  1277. // TODO: could we also get into this state if
  1278. // the peer does a half close
  1279. // (e.g. CloseWrite) because they're done
  1280. // sending frames but they're still wanting
  1281. // our open replies? Investigate.
  1282. // TODO: add CloseWrite to crypto/tls.Conn first
  1283. // so we have a way to test this? I suppose
  1284. // just for testing we could have a non-TLS mode.
  1285. return false
  1286. }
  1287. } else {
  1288. f := res.f
  1289. if VerboseLogs {
  1290. sc.vlogf("http2: server read frame %v", summarizeFrame(f))
  1291. }
  1292. err = sc.processFrame(f)
  1293. if err == nil {
  1294. return true
  1295. }
  1296. }
  1297. switch ev := err.(type) {
  1298. case StreamError:
  1299. sc.resetStream(ev)
  1300. return true
  1301. case goAwayFlowError:
  1302. sc.goAway(ErrCodeFlowControl)
  1303. return true
  1304. case ConnectionError:
  1305. sc.logf("http2: server connection error from %v: %v", sc.conn.RemoteAddr(), ev)
  1306. sc.goAway(ErrCode(ev))
  1307. return true // goAway will handle shutdown
  1308. default:
  1309. if res.err != nil {
  1310. sc.vlogf("http2: server closing client connection; error reading frame from client %s: %v", sc.conn.RemoteAddr(), err)
  1311. } else {
  1312. sc.logf("http2: server closing client connection: %v", err)
  1313. }
  1314. return false
  1315. }
  1316. }
  1317. func (sc *serverConn) processFrame(f Frame) error {
  1318. sc.serveG.check()
  1319. // First frame received must be SETTINGS.
  1320. if !sc.sawFirstSettings {
  1321. if _, ok := f.(*SettingsFrame); !ok {
  1322. return sc.countError("first_settings", ConnectionError(ErrCodeProtocol))
  1323. }
  1324. sc.sawFirstSettings = true
  1325. }
  1326. switch f := f.(type) {
  1327. case *SettingsFrame:
  1328. return sc.processSettings(f)
  1329. case *MetaHeadersFrame:
  1330. return sc.processHeaders(f)
  1331. case *WindowUpdateFrame:
  1332. return sc.processWindowUpdate(f)
  1333. case *PingFrame:
  1334. return sc.processPing(f)
  1335. case *DataFrame:
  1336. return sc.processData(f)
  1337. case *RSTStreamFrame:
  1338. return sc.processResetStream(f)
  1339. case *PriorityFrame:
  1340. return sc.processPriority(f)
  1341. case *GoAwayFrame:
  1342. return sc.processGoAway(f)
  1343. case *PushPromiseFrame:
  1344. // A client cannot push. Thus, servers MUST treat the receipt of a PUSH_PROMISE
  1345. // frame as a connection error (Section 5.4.1) of type PROTOCOL_ERROR.
  1346. return sc.countError("push_promise", ConnectionError(ErrCodeProtocol))
  1347. default:
  1348. sc.vlogf("http2: server ignoring frame: %v", f.Header())
  1349. return nil
  1350. }
  1351. }
  1352. func (sc *serverConn) processPing(f *PingFrame) error {
  1353. sc.serveG.check()
  1354. if f.IsAck() {
  1355. // 6.7 PING: " An endpoint MUST NOT respond to PING frames
  1356. // containing this flag."
  1357. return nil
  1358. }
  1359. if f.StreamID != 0 {
  1360. // "PING frames are not associated with any individual
  1361. // stream. If a PING frame is received with a stream
  1362. // identifier field value other than 0x0, the recipient MUST
  1363. // respond with a connection error (Section 5.4.1) of type
  1364. // PROTOCOL_ERROR."
  1365. return sc.countError("ping_on_stream", ConnectionError(ErrCodeProtocol))
  1366. }
  1367. if sc.inGoAway && sc.goAwayCode != ErrCodeNo {
  1368. return nil
  1369. }
  1370. sc.writeFrame(FrameWriteRequest{write: writePingAck{f}})
  1371. return nil
  1372. }
  1373. func (sc *serverConn) processWindowUpdate(f *WindowUpdateFrame) error {
  1374. sc.serveG.check()
  1375. switch {
  1376. case f.StreamID != 0: // stream-level flow control
  1377. state, st := sc.state(f.StreamID)
  1378. if state == stateIdle {
  1379. // Section 5.1: "Receiving any frame other than HEADERS
  1380. // or PRIORITY on a stream in this state MUST be
  1381. // treated as a connection error (Section 5.4.1) of
  1382. // type PROTOCOL_ERROR."
  1383. return sc.countError("stream_idle", ConnectionError(ErrCodeProtocol))
  1384. }
  1385. if st == nil {
  1386. // "WINDOW_UPDATE can be sent by a peer that has sent a
  1387. // frame bearing the END_STREAM flag. This means that a
  1388. // receiver could receive a WINDOW_UPDATE frame on a "half
  1389. // closed (remote)" or "closed" stream. A receiver MUST
  1390. // NOT treat this as an error, see Section 5.1."
  1391. return nil
  1392. }
  1393. if !st.flow.add(int32(f.Increment)) {
  1394. return sc.countError("bad_flow", streamError(f.StreamID, ErrCodeFlowControl))
  1395. }
  1396. default: // connection-level flow control
  1397. if !sc.flow.add(int32(f.Increment)) {
  1398. return goAwayFlowError{}
  1399. }
  1400. }
  1401. sc.scheduleFrameWrite()
  1402. return nil
  1403. }
  1404. func (sc *serverConn) processResetStream(f *RSTStreamFrame) error {
  1405. sc.serveG.check()
  1406. state, st := sc.state(f.StreamID)
  1407. if state == stateIdle {
  1408. // 6.4 "RST_STREAM frames MUST NOT be sent for a
  1409. // stream in the "idle" state. If a RST_STREAM frame
  1410. // identifying an idle stream is received, the
  1411. // recipient MUST treat this as a connection error
  1412. // (Section 5.4.1) of type PROTOCOL_ERROR.
  1413. return sc.countError("reset_idle_stream", ConnectionError(ErrCodeProtocol))
  1414. }
  1415. if st != nil {
  1416. st.cancelCtx()
  1417. sc.closeStream(st, streamError(f.StreamID, f.ErrCode))
  1418. }
  1419. return nil
  1420. }
  1421. func (sc *serverConn) closeStream(st *stream, err error) {
  1422. sc.serveG.check()
  1423. if st.state == stateIdle || st.state == stateClosed {
  1424. panic(fmt.Sprintf("invariant; can't close stream in state %v", st.state))
  1425. }
  1426. st.state = stateClosed
  1427. if st.writeDeadline != nil {
  1428. st.writeDeadline.Stop()
  1429. }
  1430. if st.isPushed() {
  1431. sc.curPushedStreams--
  1432. } else {
  1433. sc.curClientStreams--
  1434. }
  1435. delete(sc.streams, st.id)
  1436. if len(sc.streams) == 0 {
  1437. sc.setConnState(http.StateIdle)
  1438. if sc.srv.IdleTimeout != 0 {
  1439. sc.idleTimer.Reset(sc.srv.IdleTimeout)
  1440. }
  1441. if h1ServerKeepAlivesDisabled(sc.hs) {
  1442. sc.startGracefulShutdownInternal()
  1443. }
  1444. }
  1445. if p := st.body; p != nil {
  1446. // Return any buffered unread bytes worth of conn-level flow control.
  1447. // See golang.org/issue/16481
  1448. sc.sendWindowUpdate(nil, p.Len())
  1449. p.CloseWithError(err)
  1450. }
  1451. st.cw.Close() // signals Handler's CloseNotifier, unblocks writes, etc
  1452. sc.writeSched.CloseStream(st.id)
  1453. }
  1454. func (sc *serverConn) processSettings(f *SettingsFrame) error {
  1455. sc.serveG.check()
  1456. if f.IsAck() {
  1457. sc.unackedSettings--
  1458. if sc.unackedSettings < 0 {
  1459. // Why is the peer ACKing settings we never sent?
  1460. // The spec doesn't mention this case, but
  1461. // hang up on them anyway.
  1462. return sc.countError("ack_mystery", ConnectionError(ErrCodeProtocol))
  1463. }
  1464. return nil
  1465. }
  1466. if f.NumSettings() > 100 || f.HasDuplicates() {
  1467. // This isn't actually in the spec, but hang up on
  1468. // suspiciously large settings frames or those with
  1469. // duplicate entries.
  1470. return sc.countError("settings_big_or_dups", ConnectionError(ErrCodeProtocol))
  1471. }
  1472. if err := f.ForeachSetting(sc.processSetting); err != nil {
  1473. return err
  1474. }
  1475. // TODO: judging by RFC 7540, Section 6.5.3 each SETTINGS frame should be
  1476. // acknowledged individually, even if multiple are received before the ACK.
  1477. sc.needToSendSettingsAck = true
  1478. sc.scheduleFrameWrite()
  1479. return nil
  1480. }
  1481. func (sc *serverConn) processSetting(s Setting) error {
  1482. sc.serveG.check()
  1483. if err := s.Valid(); err != nil {
  1484. return err
  1485. }
  1486. if VerboseLogs {
  1487. sc.vlogf("http2: server processing setting %v", s)
  1488. }
  1489. switch s.ID {
  1490. case SettingHeaderTableSize:
  1491. sc.headerTableSize = s.Val
  1492. sc.hpackEncoder.SetMaxDynamicTableSize(s.Val)
  1493. case SettingEnablePush:
  1494. sc.pushEnabled = s.Val != 0
  1495. case SettingMaxConcurrentStreams:
  1496. sc.clientMaxStreams = s.Val
  1497. case SettingInitialWindowSize:
  1498. return sc.processSettingInitialWindowSize(s.Val)
  1499. case SettingMaxFrameSize:
  1500. sc.maxFrameSize = int32(s.Val) // the maximum valid s.Val is < 2^31
  1501. case SettingMaxHeaderListSize:
  1502. sc.peerMaxHeaderListSize = s.Val
  1503. default:
  1504. // Unknown setting: "An endpoint that receives a SETTINGS
  1505. // frame with any unknown or unsupported identifier MUST
  1506. // ignore that setting."
  1507. if VerboseLogs {
  1508. sc.vlogf("http2: server ignoring unknown setting %v", s)
  1509. }
  1510. }
  1511. return nil
  1512. }
  1513. func (sc *serverConn) processSettingInitialWindowSize(val uint32) error {
  1514. sc.serveG.check()
  1515. // Note: val already validated to be within range by
  1516. // processSetting's Valid call.
  1517. // "A SETTINGS frame can alter the initial flow control window
  1518. // size for all current streams. When the value of
  1519. // SETTINGS_INITIAL_WINDOW_SIZE changes, a receiver MUST
  1520. // adjust the size of all stream flow control windows that it
  1521. // maintains by the difference between the new value and the
  1522. // old value."
  1523. old := sc.initialStreamSendWindowSize
  1524. sc.initialStreamSendWindowSize = int32(val)
  1525. growth := int32(val) - old // may be negative
  1526. for _, st := range sc.streams {
  1527. if !st.flow.add(growth) {
  1528. // 6.9.2 Initial Flow Control Window Size
  1529. // "An endpoint MUST treat a change to
  1530. // SETTINGS_INITIAL_WINDOW_SIZE that causes any flow
  1531. // control window to exceed the maximum size as a
  1532. // connection error (Section 5.4.1) of type
  1533. // FLOW_CONTROL_ERROR."
  1534. return sc.countError("setting_win_size", ConnectionError(ErrCodeFlowControl))
  1535. }
  1536. }
  1537. return nil
  1538. }
  1539. func (sc *serverConn) processData(f *DataFrame) error {
  1540. sc.serveG.check()
  1541. id := f.Header().StreamID
  1542. if sc.inGoAway && (sc.goAwayCode != ErrCodeNo || id > sc.maxClientStreamID) {
  1543. // Discard all DATA frames if the GOAWAY is due to an
  1544. // error, or:
  1545. //
  1546. // Section 6.8: After sending a GOAWAY frame, the sender
  1547. // can discard frames for streams initiated by the
  1548. // receiver with identifiers higher than the identified
  1549. // last stream.
  1550. return nil
  1551. }
  1552. data := f.Data()
  1553. state, st := sc.state(id)
  1554. if id == 0 || state == stateIdle {
  1555. // Section 6.1: "DATA frames MUST be associated with a
  1556. // stream. If a DATA frame is received whose stream
  1557. // identifier field is 0x0, the recipient MUST respond
  1558. // with a connection error (Section 5.4.1) of type
  1559. // PROTOCOL_ERROR."
  1560. //
  1561. // Section 5.1: "Receiving any frame other than HEADERS
  1562. // or PRIORITY on a stream in this state MUST be
  1563. // treated as a connection error (Section 5.4.1) of
  1564. // type PROTOCOL_ERROR."
  1565. return sc.countError("data_on_idle", ConnectionError(ErrCodeProtocol))
  1566. }
  1567. // "If a DATA frame is received whose stream is not in "open"
  1568. // or "half closed (local)" state, the recipient MUST respond
  1569. // with a stream error (Section 5.4.2) of type STREAM_CLOSED."
  1570. if st == nil || state != stateOpen || st.gotTrailerHeader || st.resetQueued {
  1571. // This includes sending a RST_STREAM if the stream is
  1572. // in stateHalfClosedLocal (which currently means that
  1573. // the http.Handler returned, so it's done reading &
  1574. // done writing). Try to stop the client from sending
  1575. // more DATA.
  1576. // But still enforce their connection-level flow control,
  1577. // and return any flow control bytes since we're not going
  1578. // to consume them.
  1579. if sc.inflow.available() < int32(f.Length) {
  1580. return sc.countError("data_flow", streamError(id, ErrCodeFlowControl))
  1581. }
  1582. // Deduct the flow control from inflow, since we're
  1583. // going to immediately add it back in
  1584. // sendWindowUpdate, which also schedules sending the
  1585. // frames.
  1586. sc.inflow.take(int32(f.Length))
  1587. sc.sendWindowUpdate(nil, int(f.Length)) // conn-level
  1588. if st != nil && st.resetQueued {
  1589. // Already have a stream error in flight. Don't send another.
  1590. return nil
  1591. }
  1592. return sc.countError("closed", streamError(id, ErrCodeStreamClosed))
  1593. }
  1594. if st.body == nil {
  1595. panic("internal error: should have a body in this state")
  1596. }
  1597. // Sender sending more than they'd declared?
  1598. if st.declBodyBytes != -1 && st.bodyBytes+int64(len(data)) > st.declBodyBytes {
  1599. st.body.CloseWithError(fmt.Errorf("sender tried to send more than declared Content-Length of %d bytes", st.declBodyBytes))
  1600. // RFC 7540, sec 8.1.2.6: A request or response is also malformed if the
  1601. // value of a content-length header field does not equal the sum of the
  1602. // DATA frame payload lengths that form the body.
  1603. return sc.countError("send_too_much", streamError(id, ErrCodeProtocol))
  1604. }
  1605. if f.Length > 0 {
  1606. // Check whether the client has flow control quota.
  1607. if st.inflow.available() < int32(f.Length) {
  1608. return sc.countError("flow_on_data_length", streamError(id, ErrCodeFlowControl))
  1609. }
  1610. st.inflow.take(int32(f.Length))
  1611. if len(data) > 0 {
  1612. wrote, err := st.body.Write(data)
  1613. if err != nil {
  1614. sc.sendWindowUpdate(nil, int(f.Length)-wrote)
  1615. return sc.countError("body_write_err", streamError(id, ErrCodeStreamClosed))
  1616. }
  1617. if wrote != len(data) {
  1618. panic("internal error: bad Writer")
  1619. }
  1620. st.bodyBytes += int64(len(data))
  1621. }
  1622. // Return any padded flow control now, since we won't
  1623. // refund it later on body reads.
  1624. if pad := int32(f.Length) - int32(len(data)); pad > 0 {
  1625. sc.sendWindowUpdate32(nil, pad)
  1626. sc.sendWindowUpdate32(st, pad)
  1627. }
  1628. }
  1629. if f.StreamEnded() {
  1630. st.endStream()
  1631. }
  1632. return nil
  1633. }
  1634. func (sc *serverConn) processGoAway(f *GoAwayFrame) error {
  1635. sc.serveG.check()
  1636. if f.ErrCode != ErrCodeNo {
  1637. sc.logf("http2: received GOAWAY %+v, starting graceful shutdown", f)
  1638. } else {
  1639. sc.vlogf("http2: received GOAWAY %+v, starting graceful shutdown", f)
  1640. }
  1641. sc.startGracefulShutdownInternal()
  1642. // http://tools.ietf.org/html/rfc7540#section-6.8
  1643. // We should not create any new streams, which means we should disable push.
  1644. sc.pushEnabled = false
  1645. return nil
  1646. }
  1647. // isPushed reports whether the stream is server-initiated.
  1648. func (st *stream) isPushed() bool {
  1649. return st.id%2 == 0
  1650. }
  1651. // endStream closes a Request.Body's pipe. It is called when a DATA
  1652. // frame says a request body is over (or after trailers).
  1653. func (st *stream) endStream() {
  1654. sc := st.sc
  1655. sc.serveG.check()
  1656. if st.declBodyBytes != -1 && st.declBodyBytes != st.bodyBytes {
  1657. st.body.CloseWithError(fmt.Errorf("request declared a Content-Length of %d but only wrote %d bytes",
  1658. st.declBodyBytes, st.bodyBytes))
  1659. } else {
  1660. st.body.closeWithErrorAndCode(io.EOF, st.copyTrailersToHandlerRequest)
  1661. st.body.CloseWithError(io.EOF)
  1662. }
  1663. st.state = stateHalfClosedRemote
  1664. }
  1665. // copyTrailersToHandlerRequest is run in the Handler's goroutine in
  1666. // its Request.Body.Read just before it gets io.EOF.
  1667. func (st *stream) copyTrailersToHandlerRequest() {
  1668. for k, vv := range st.trailer {
  1669. if _, ok := st.reqTrailer[k]; ok {
  1670. // Only copy it over it was pre-declared.
  1671. st.reqTrailer[k] = vv
  1672. }
  1673. }
  1674. }
  1675. // onWriteTimeout is run on its own goroutine (from time.AfterFunc)
  1676. // when the stream's WriteTimeout has fired.
  1677. func (st *stream) onWriteTimeout() {
  1678. st.sc.writeFrameFromHandler(FrameWriteRequest{write: streamError(st.id, ErrCodeInternal)})
  1679. }
  1680. func (sc *serverConn) processHeaders(f *MetaHeadersFrame) error {
  1681. sc.serveG.check()
  1682. id := f.StreamID
  1683. if sc.inGoAway {
  1684. // Ignore.
  1685. return nil
  1686. }
  1687. // http://tools.ietf.org/html/rfc7540#section-5.1.1
  1688. // Streams initiated by a client MUST use odd-numbered stream
  1689. // identifiers. [...] An endpoint that receives an unexpected
  1690. // stream identifier MUST respond with a connection error
  1691. // (Section 5.4.1) of type PROTOCOL_ERROR.
  1692. if id%2 != 1 {
  1693. return sc.countError("headers_even", ConnectionError(ErrCodeProtocol))
  1694. }
  1695. // A HEADERS frame can be used to create a new stream or
  1696. // send a trailer for an open one. If we already have a stream
  1697. // open, let it process its own HEADERS frame (trailers at this
  1698. // point, if it's valid).
  1699. if st := sc.streams[f.StreamID]; st != nil {
  1700. if st.resetQueued {
  1701. // We're sending RST_STREAM to close the stream, so don't bother
  1702. // processing this frame.
  1703. return nil
  1704. }
  1705. // RFC 7540, sec 5.1: If an endpoint receives additional frames, other than
  1706. // WINDOW_UPDATE, PRIORITY, or RST_STREAM, for a stream that is in
  1707. // this state, it MUST respond with a stream error (Section 5.4.2) of
  1708. // type STREAM_CLOSED.
  1709. if st.state == stateHalfClosedRemote {
  1710. return sc.countError("headers_half_closed", streamError(id, ErrCodeStreamClosed))
  1711. }
  1712. return st.processTrailerHeaders(f)
  1713. }
  1714. // [...] The identifier of a newly established stream MUST be
  1715. // numerically greater than all streams that the initiating
  1716. // endpoint has opened or reserved. [...] An endpoint that
  1717. // receives an unexpected stream identifier MUST respond with
  1718. // a connection error (Section 5.4.1) of type PROTOCOL_ERROR.
  1719. if id <= sc.maxClientStreamID {
  1720. return sc.countError("stream_went_down", ConnectionError(ErrCodeProtocol))
  1721. }
  1722. sc.maxClientStreamID = id
  1723. if sc.idleTimer != nil {
  1724. sc.idleTimer.Stop()
  1725. }
  1726. // http://tools.ietf.org/html/rfc7540#section-5.1.2
  1727. // [...] Endpoints MUST NOT exceed the limit set by their peer. An
  1728. // endpoint that receives a HEADERS frame that causes their
  1729. // advertised concurrent stream limit to be exceeded MUST treat
  1730. // this as a stream error (Section 5.4.2) of type PROTOCOL_ERROR
  1731. // or REFUSED_STREAM.
  1732. if sc.curClientStreams+1 > sc.advMaxStreams {
  1733. if sc.unackedSettings == 0 {
  1734. // They should know better.
  1735. return sc.countError("over_max_streams", streamError(id, ErrCodeProtocol))
  1736. }
  1737. // Assume it's a network race, where they just haven't
  1738. // received our last SETTINGS update. But actually
  1739. // this can't happen yet, because we don't yet provide
  1740. // a way for users to adjust server parameters at
  1741. // runtime.
  1742. return sc.countError("over_max_streams_race", streamError(id, ErrCodeRefusedStream))
  1743. }
  1744. initialState := stateOpen
  1745. if f.StreamEnded() {
  1746. initialState = stateHalfClosedRemote
  1747. }
  1748. st := sc.newStream(id, 0, initialState)
  1749. if f.HasPriority() {
  1750. if err := sc.checkPriority(f.StreamID, f.Priority); err != nil {
  1751. return err
  1752. }
  1753. sc.writeSched.AdjustStream(st.id, f.Priority)
  1754. }
  1755. rw, req, err := sc.newWriterAndRequest(st, f)
  1756. if err != nil {
  1757. return err
  1758. }
  1759. st.reqTrailer = req.Trailer
  1760. if st.reqTrailer != nil {
  1761. st.trailer = make(http.Header)
  1762. }
  1763. st.body = req.Body.(*requestBody).pipe // may be nil
  1764. st.declBodyBytes = req.ContentLength
  1765. handler := sc.handler.ServeHTTP
  1766. if f.Truncated {
  1767. // Their header list was too long. Send a 431 error.
  1768. handler = handleHeaderListTooLong
  1769. } else if err := checkValidHTTP2RequestHeaders(req.Header); err != nil {
  1770. handler = new400Handler(err)
  1771. }
  1772. // The net/http package sets the read deadline from the
  1773. // http.Server.ReadTimeout during the TLS handshake, but then
  1774. // passes the connection off to us with the deadline already
  1775. // set. Disarm it here after the request headers are read,
  1776. // similar to how the http1 server works. Here it's
  1777. // technically more like the http1 Server's ReadHeaderTimeout
  1778. // (in Go 1.8), though. That's a more sane option anyway.
  1779. if sc.hs.ReadTimeout != 0 {
  1780. sc.conn.SetReadDeadline(time.Time{})
  1781. }
  1782. go sc.runHandler(rw, req, handler)
  1783. return nil
  1784. }
  1785. func (sc *serverConn) upgradeRequest(req *http.Request) {
  1786. sc.serveG.check()
  1787. id := uint32(1)
  1788. sc.maxClientStreamID = id
  1789. st := sc.newStream(id, 0, stateHalfClosedRemote)
  1790. st.reqTrailer = req.Trailer
  1791. if st.reqTrailer != nil {
  1792. st.trailer = make(http.Header)
  1793. }
  1794. rw := sc.newResponseWriter(st, req)
  1795. // Disable any read deadline set by the net/http package
  1796. // prior to the upgrade.
  1797. if sc.hs.ReadTimeout != 0 {
  1798. sc.conn.SetReadDeadline(time.Time{})
  1799. }
  1800. go sc.runHandler(rw, req, sc.handler.ServeHTTP)
  1801. }
  1802. func (st *stream) processTrailerHeaders(f *MetaHeadersFrame) error {
  1803. sc := st.sc
  1804. sc.serveG.check()
  1805. if st.gotTrailerHeader {
  1806. return sc.countError("dup_trailers", ConnectionError(ErrCodeProtocol))
  1807. }
  1808. st.gotTrailerHeader = true
  1809. if !f.StreamEnded() {
  1810. return sc.countError("trailers_not_ended", streamError(st.id, ErrCodeProtocol))
  1811. }
  1812. if len(f.PseudoFields()) > 0 {
  1813. return sc.countError("trailers_pseudo", streamError(st.id, ErrCodeProtocol))
  1814. }
  1815. if st.trailer != nil {
  1816. for _, hf := range f.RegularFields() {
  1817. key := sc.canonicalHeader(hf.Name)
  1818. if !httpguts.ValidTrailerHeader(key) {
  1819. // TODO: send more details to the peer somehow. But http2 has
  1820. // no way to send debug data at a stream level. Discuss with
  1821. // HTTP folk.
  1822. return sc.countError("trailers_bogus", streamError(st.id, ErrCodeProtocol))
  1823. }
  1824. st.trailer[key] = append(st.trailer[key], hf.Value)
  1825. }
  1826. }
  1827. st.endStream()
  1828. return nil
  1829. }
  1830. func (sc *serverConn) checkPriority(streamID uint32, p PriorityParam) error {
  1831. if streamID == p.StreamDep {
  1832. // Section 5.3.1: "A stream cannot depend on itself. An endpoint MUST treat
  1833. // this as a stream error (Section 5.4.2) of type PROTOCOL_ERROR."
  1834. // Section 5.3.3 says that a stream can depend on one of its dependencies,
  1835. // so it's only self-dependencies that are forbidden.
  1836. return sc.countError("priority", streamError(streamID, ErrCodeProtocol))
  1837. }
  1838. return nil
  1839. }
  1840. func (sc *serverConn) processPriority(f *PriorityFrame) error {
  1841. if sc.inGoAway {
  1842. return nil
  1843. }
  1844. if err := sc.checkPriority(f.StreamID, f.PriorityParam); err != nil {
  1845. return err
  1846. }
  1847. sc.writeSched.AdjustStream(f.StreamID, f.PriorityParam)
  1848. return nil
  1849. }
  1850. func (sc *serverConn) newStream(id, pusherID uint32, state streamState) *stream {
  1851. sc.serveG.check()
  1852. if id == 0 {
  1853. panic("internal error: cannot create stream with id 0")
  1854. }
  1855. ctx, cancelCtx := context.WithCancel(sc.baseCtx)
  1856. st := &stream{
  1857. sc: sc,
  1858. id: id,
  1859. state: state,
  1860. ctx: ctx,
  1861. cancelCtx: cancelCtx,
  1862. }
  1863. st.cw.Init()
  1864. st.flow.conn = &sc.flow // link to conn-level counter
  1865. st.flow.add(sc.initialStreamSendWindowSize)
  1866. st.inflow.conn = &sc.inflow // link to conn-level counter
  1867. st.inflow.add(sc.srv.initialStreamRecvWindowSize())
  1868. if sc.hs.WriteTimeout != 0 {
  1869. st.writeDeadline = time.AfterFunc(sc.hs.WriteTimeout, st.onWriteTimeout)
  1870. }
  1871. sc.streams[id] = st
  1872. sc.writeSched.OpenStream(st.id, OpenStreamOptions{PusherID: pusherID})
  1873. if st.isPushed() {
  1874. sc.curPushedStreams++
  1875. } else {
  1876. sc.curClientStreams++
  1877. }
  1878. if sc.curOpenStreams() == 1 {
  1879. sc.setConnState(http.StateActive)
  1880. }
  1881. return st
  1882. }
  1883. func (sc *serverConn) newWriterAndRequest(st *stream, f *MetaHeadersFrame) (*responseWriter, *http.Request, error) {
  1884. sc.serveG.check()
  1885. rp := requestParam{
  1886. method: f.PseudoValue("method"),
  1887. scheme: f.PseudoValue("scheme"),
  1888. authority: f.PseudoValue("authority"),
  1889. path: f.PseudoValue("path"),
  1890. }
  1891. isConnect := rp.method == "CONNECT"
  1892. if isConnect {
  1893. if rp.path != "" || rp.scheme != "" || rp.authority == "" {
  1894. return nil, nil, sc.countError("bad_connect", streamError(f.StreamID, ErrCodeProtocol))
  1895. }
  1896. } else if rp.method == "" || rp.path == "" || (rp.scheme != "https" && rp.scheme != "http") {
  1897. // See 8.1.2.6 Malformed Requests and Responses:
  1898. //
  1899. // Malformed requests or responses that are detected
  1900. // MUST be treated as a stream error (Section 5.4.2)
  1901. // of type PROTOCOL_ERROR."
  1902. //
  1903. // 8.1.2.3 Request Pseudo-Header Fields
  1904. // "All HTTP/2 requests MUST include exactly one valid
  1905. // value for the :method, :scheme, and :path
  1906. // pseudo-header fields"
  1907. return nil, nil, sc.countError("bad_path_method", streamError(f.StreamID, ErrCodeProtocol))
  1908. }
  1909. bodyOpen := !f.StreamEnded()
  1910. if rp.method == "HEAD" && bodyOpen {
  1911. // HEAD requests can't have bodies
  1912. return nil, nil, sc.countError("head_body", streamError(f.StreamID, ErrCodeProtocol))
  1913. }
  1914. rp.header = make(http.Header)
  1915. for _, hf := range f.RegularFields() {
  1916. rp.header.Add(sc.canonicalHeader(hf.Name), hf.Value)
  1917. }
  1918. if rp.authority == "" {
  1919. rp.authority = rp.header.Get("Host")
  1920. }
  1921. rw, req, err := sc.newWriterAndRequestNoBody(st, rp)
  1922. if err != nil {
  1923. return nil, nil, err
  1924. }
  1925. if bodyOpen {
  1926. if vv, ok := rp.header["Content-Length"]; ok {
  1927. if cl, err := strconv.ParseUint(vv[0], 10, 63); err == nil {
  1928. req.ContentLength = int64(cl)
  1929. } else {
  1930. req.ContentLength = 0
  1931. }
  1932. } else {
  1933. req.ContentLength = -1
  1934. }
  1935. req.Body.(*requestBody).pipe = &pipe{
  1936. b: &dataBuffer{expected: req.ContentLength},
  1937. }
  1938. }
  1939. return rw, req, nil
  1940. }
  1941. type requestParam struct {
  1942. method string
  1943. scheme, authority, path string
  1944. header http.Header
  1945. }
  1946. func (sc *serverConn) newWriterAndRequestNoBody(st *stream, rp requestParam) (*responseWriter, *http.Request, error) {
  1947. sc.serveG.check()
  1948. var tlsState *tls.ConnectionState // nil if not scheme https
  1949. if rp.scheme == "https" {
  1950. tlsState = sc.tlsState
  1951. }
  1952. needsContinue := rp.header.Get("Expect") == "100-continue"
  1953. if needsContinue {
  1954. rp.header.Del("Expect")
  1955. }
  1956. // Merge Cookie headers into one "; "-delimited value.
  1957. if cookies := rp.header["Cookie"]; len(cookies) > 1 {
  1958. rp.header.Set("Cookie", strings.Join(cookies, "; "))
  1959. }
  1960. // Setup Trailers
  1961. var trailer http.Header
  1962. for _, v := range rp.header["Trailer"] {
  1963. for _, key := range strings.Split(v, ",") {
  1964. key = http.CanonicalHeaderKey(textproto.TrimString(key))
  1965. switch key {
  1966. case "Transfer-Encoding", "Trailer", "Content-Length":
  1967. // Bogus. (copy of http1 rules)
  1968. // Ignore.
  1969. default:
  1970. if trailer == nil {
  1971. trailer = make(http.Header)
  1972. }
  1973. trailer[key] = nil
  1974. }
  1975. }
  1976. }
  1977. delete(rp.header, "Trailer")
  1978. var url_ *url.URL
  1979. var requestURI string
  1980. if rp.method == "CONNECT" {
  1981. url_ = &url.URL{Host: rp.authority}
  1982. requestURI = rp.authority // mimic HTTP/1 server behavior
  1983. } else {
  1984. var err error
  1985. url_, err = url.ParseRequestURI(rp.path)
  1986. if err != nil {
  1987. return nil, nil, sc.countError("bad_path", streamError(st.id, ErrCodeProtocol))
  1988. }
  1989. requestURI = rp.path
  1990. }
  1991. body := &requestBody{
  1992. conn: sc,
  1993. stream: st,
  1994. needsContinue: needsContinue,
  1995. }
  1996. req := &http.Request{
  1997. Method: rp.method,
  1998. URL: url_,
  1999. RemoteAddr: sc.remoteAddrStr,
  2000. Header: rp.header,
  2001. RequestURI: requestURI,
  2002. Proto: "HTTP/2.0",
  2003. ProtoMajor: 2,
  2004. ProtoMinor: 0,
  2005. TLS: tlsState,
  2006. Host: rp.authority,
  2007. Body: body,
  2008. Trailer: trailer,
  2009. }
  2010. req = req.WithContext(st.ctx)
  2011. rw := sc.newResponseWriter(st, req)
  2012. return rw, req, nil
  2013. }
  2014. func (sc *serverConn) newResponseWriter(st *stream, req *http.Request) *responseWriter {
  2015. rws := responseWriterStatePool.Get().(*responseWriterState)
  2016. bwSave := rws.bw
  2017. *rws = responseWriterState{} // zero all the fields
  2018. rws.conn = sc
  2019. rws.bw = bwSave
  2020. rws.bw.Reset(chunkWriter{rws})
  2021. rws.stream = st
  2022. rws.req = req
  2023. return &responseWriter{rws: rws}
  2024. }
  2025. // Run on its own goroutine.
  2026. func (sc *serverConn) runHandler(rw *responseWriter, req *http.Request, handler func(http.ResponseWriter, *http.Request)) {
  2027. didPanic := true
  2028. defer func() {
  2029. rw.rws.stream.cancelCtx()
  2030. if didPanic {
  2031. e := recover()
  2032. sc.writeFrameFromHandler(FrameWriteRequest{
  2033. write: handlerPanicRST{rw.rws.stream.id},
  2034. stream: rw.rws.stream,
  2035. })
  2036. // Same as net/http:
  2037. if e != nil && e != http.ErrAbortHandler {
  2038. const size = 64 << 10
  2039. buf := make([]byte, size)
  2040. buf = buf[:runtime.Stack(buf, false)]
  2041. sc.logf("http2: panic serving %v: %v\n%s", sc.conn.RemoteAddr(), e, buf)
  2042. }
  2043. return
  2044. }
  2045. rw.handlerDone()
  2046. }()
  2047. handler(rw, req)
  2048. didPanic = false
  2049. }
  2050. func handleHeaderListTooLong(w http.ResponseWriter, r *http.Request) {
  2051. // 10.5.1 Limits on Header Block Size:
  2052. // .. "A server that receives a larger header block than it is
  2053. // willing to handle can send an HTTP 431 (Request Header Fields Too
  2054. // Large) status code"
  2055. const statusRequestHeaderFieldsTooLarge = 431 // only in Go 1.6+
  2056. w.WriteHeader(statusRequestHeaderFieldsTooLarge)
  2057. io.WriteString(w, "<h1>HTTP Error 431</h1><p>Request Header Field(s) Too Large</p>")
  2058. }
  2059. // called from handler goroutines.
  2060. // h may be nil.
  2061. func (sc *serverConn) writeHeaders(st *stream, headerData *writeResHeaders) error {
  2062. sc.serveG.checkNotOn() // NOT on
  2063. var errc chan error
  2064. if headerData.h != nil {
  2065. // If there's a header map (which we don't own), so we have to block on
  2066. // waiting for this frame to be written, so an http.Flush mid-handler
  2067. // writes out the correct value of keys, before a handler later potentially
  2068. // mutates it.
  2069. errc = errChanPool.Get().(chan error)
  2070. }
  2071. if err := sc.writeFrameFromHandler(FrameWriteRequest{
  2072. write: headerData,
  2073. stream: st,
  2074. done: errc,
  2075. }); err != nil {
  2076. return err
  2077. }
  2078. if errc != nil {
  2079. select {
  2080. case err := <-errc:
  2081. errChanPool.Put(errc)
  2082. return err
  2083. case <-sc.doneServing:
  2084. return errClientDisconnected
  2085. case <-st.cw:
  2086. return errStreamClosed
  2087. }
  2088. }
  2089. return nil
  2090. }
  2091. // called from handler goroutines.
  2092. func (sc *serverConn) write100ContinueHeaders(st *stream) {
  2093. sc.writeFrameFromHandler(FrameWriteRequest{
  2094. write: write100ContinueHeadersFrame{st.id},
  2095. stream: st,
  2096. })
  2097. }
  2098. // A bodyReadMsg tells the server loop that the http.Handler read n
  2099. // bytes of the DATA from the client on the given stream.
  2100. type bodyReadMsg struct {
  2101. st *stream
  2102. n int
  2103. }
  2104. // called from handler goroutines.
  2105. // Notes that the handler for the given stream ID read n bytes of its body
  2106. // and schedules flow control tokens to be sent.
  2107. func (sc *serverConn) noteBodyReadFromHandler(st *stream, n int, err error) {
  2108. sc.serveG.checkNotOn() // NOT on
  2109. if n > 0 {
  2110. select {
  2111. case sc.bodyReadCh <- bodyReadMsg{st, n}:
  2112. case <-sc.doneServing:
  2113. }
  2114. }
  2115. }
  2116. func (sc *serverConn) noteBodyRead(st *stream, n int) {
  2117. sc.serveG.check()
  2118. sc.sendWindowUpdate(nil, n) // conn-level
  2119. if st.state != stateHalfClosedRemote && st.state != stateClosed {
  2120. // Don't send this WINDOW_UPDATE if the stream is closed
  2121. // remotely.
  2122. sc.sendWindowUpdate(st, n)
  2123. }
  2124. }
  2125. // st may be nil for conn-level
  2126. func (sc *serverConn) sendWindowUpdate(st *stream, n int) {
  2127. sc.serveG.check()
  2128. // "The legal range for the increment to the flow control
  2129. // window is 1 to 2^31-1 (2,147,483,647) octets."
  2130. // A Go Read call on 64-bit machines could in theory read
  2131. // a larger Read than this. Very unlikely, but we handle it here
  2132. // rather than elsewhere for now.
  2133. const maxUint31 = 1<<31 - 1
  2134. for n >= maxUint31 {
  2135. sc.sendWindowUpdate32(st, maxUint31)
  2136. n -= maxUint31
  2137. }
  2138. sc.sendWindowUpdate32(st, int32(n))
  2139. }
  2140. // st may be nil for conn-level
  2141. func (sc *serverConn) sendWindowUpdate32(st *stream, n int32) {
  2142. sc.serveG.check()
  2143. if n == 0 {
  2144. return
  2145. }
  2146. if n < 0 {
  2147. panic("negative update")
  2148. }
  2149. var streamID uint32
  2150. if st != nil {
  2151. streamID = st.id
  2152. }
  2153. sc.writeFrame(FrameWriteRequest{
  2154. write: writeWindowUpdate{streamID: streamID, n: uint32(n)},
  2155. stream: st,
  2156. })
  2157. var ok bool
  2158. if st == nil {
  2159. ok = sc.inflow.add(n)
  2160. } else {
  2161. ok = st.inflow.add(n)
  2162. }
  2163. if !ok {
  2164. panic("internal error; sent too many window updates without decrements?")
  2165. }
  2166. }
  2167. // requestBody is the Handler's Request.Body type.
  2168. // Read and Close may be called concurrently.
  2169. type requestBody struct {
  2170. _ incomparable
  2171. stream *stream
  2172. conn *serverConn
  2173. closeOnce sync.Once // for use by Close only
  2174. sawEOF bool // for use by Read only
  2175. pipe *pipe // non-nil if we have a HTTP entity message body
  2176. needsContinue bool // need to send a 100-continue
  2177. }
  2178. func (b *requestBody) Close() error {
  2179. b.closeOnce.Do(func() {
  2180. if b.pipe != nil {
  2181. b.pipe.BreakWithError(errClosedBody)
  2182. }
  2183. })
  2184. return nil
  2185. }
  2186. func (b *requestBody) Read(p []byte) (n int, err error) {
  2187. if b.needsContinue {
  2188. b.needsContinue = false
  2189. b.conn.write100ContinueHeaders(b.stream)
  2190. }
  2191. if b.pipe == nil || b.sawEOF {
  2192. return 0, io.EOF
  2193. }
  2194. n, err = b.pipe.Read(p)
  2195. if err == io.EOF {
  2196. b.sawEOF = true
  2197. }
  2198. if b.conn == nil && inTests {
  2199. return
  2200. }
  2201. b.conn.noteBodyReadFromHandler(b.stream, n, err)
  2202. return
  2203. }
  2204. // responseWriter is the http.ResponseWriter implementation. It's
  2205. // intentionally small (1 pointer wide) to minimize garbage. The
  2206. // responseWriterState pointer inside is zeroed at the end of a
  2207. // request (in handlerDone) and calls on the responseWriter thereafter
  2208. // simply crash (caller's mistake), but the much larger responseWriterState
  2209. // and buffers are reused between multiple requests.
  2210. type responseWriter struct {
  2211. rws *responseWriterState
  2212. }
  2213. // Optional http.ResponseWriter interfaces implemented.
  2214. var (
  2215. _ http.CloseNotifier = (*responseWriter)(nil)
  2216. _ http.Flusher = (*responseWriter)(nil)
  2217. _ stringWriter = (*responseWriter)(nil)
  2218. )
  2219. type responseWriterState struct {
  2220. // immutable within a request:
  2221. stream *stream
  2222. req *http.Request
  2223. conn *serverConn
  2224. // TODO: adjust buffer writing sizes based on server config, frame size updates from peer, etc
  2225. bw *bufio.Writer // writing to a chunkWriter{this *responseWriterState}
  2226. // mutated by http.Handler goroutine:
  2227. handlerHeader http.Header // nil until called
  2228. snapHeader http.Header // snapshot of handlerHeader at WriteHeader time
  2229. trailers []string // set in writeChunk
  2230. status int // status code passed to WriteHeader
  2231. wroteHeader bool // WriteHeader called (explicitly or implicitly). Not necessarily sent to user yet.
  2232. sentHeader bool // have we sent the header frame?
  2233. handlerDone bool // handler has finished
  2234. dirty bool // a Write failed; don't reuse this responseWriterState
  2235. sentContentLen int64 // non-zero if handler set a Content-Length header
  2236. wroteBytes int64
  2237. closeNotifierMu sync.Mutex // guards closeNotifierCh
  2238. closeNotifierCh chan bool // nil until first used
  2239. }
  2240. type chunkWriter struct{ rws *responseWriterState }
  2241. func (cw chunkWriter) Write(p []byte) (n int, err error) { return cw.rws.writeChunk(p) }
  2242. func (rws *responseWriterState) hasTrailers() bool { return len(rws.trailers) > 0 }
  2243. func (rws *responseWriterState) hasNonemptyTrailers() bool {
  2244. for _, trailer := range rws.trailers {
  2245. if _, ok := rws.handlerHeader[trailer]; ok {
  2246. return true
  2247. }
  2248. }
  2249. return false
  2250. }
  2251. // declareTrailer is called for each Trailer header when the
  2252. // response header is written. It notes that a header will need to be
  2253. // written in the trailers at the end of the response.
  2254. func (rws *responseWriterState) declareTrailer(k string) {
  2255. k = http.CanonicalHeaderKey(k)
  2256. if !httpguts.ValidTrailerHeader(k) {
  2257. // Forbidden by RFC 7230, section 4.1.2.
  2258. rws.conn.logf("ignoring invalid trailer %q", k)
  2259. return
  2260. }
  2261. if !strSliceContains(rws.trailers, k) {
  2262. rws.trailers = append(rws.trailers, k)
  2263. }
  2264. }
  2265. // writeChunk writes chunks from the bufio.Writer. But because
  2266. // bufio.Writer may bypass its chunking, sometimes p may be
  2267. // arbitrarily large.
  2268. //
  2269. // writeChunk is also responsible (on the first chunk) for sending the
  2270. // HEADER response.
  2271. func (rws *responseWriterState) writeChunk(p []byte) (n int, err error) {
  2272. if !rws.wroteHeader {
  2273. rws.writeHeader(200)
  2274. }
  2275. isHeadResp := rws.req.Method == "HEAD"
  2276. if !rws.sentHeader {
  2277. rws.sentHeader = true
  2278. var ctype, clen string
  2279. if clen = rws.snapHeader.Get("Content-Length"); clen != "" {
  2280. rws.snapHeader.Del("Content-Length")
  2281. if cl, err := strconv.ParseUint(clen, 10, 63); err == nil {
  2282. rws.sentContentLen = int64(cl)
  2283. } else {
  2284. clen = ""
  2285. }
  2286. }
  2287. if clen == "" && rws.handlerDone && bodyAllowedForStatus(rws.status) && (len(p) > 0 || !isHeadResp) {
  2288. clen = strconv.Itoa(len(p))
  2289. }
  2290. _, hasContentType := rws.snapHeader["Content-Type"]
  2291. // If the Content-Encoding is non-blank, we shouldn't
  2292. // sniff the body. See Issue golang.org/issue/31753.
  2293. ce := rws.snapHeader.Get("Content-Encoding")
  2294. hasCE := len(ce) > 0
  2295. if !hasCE && !hasContentType && bodyAllowedForStatus(rws.status) && len(p) > 0 {
  2296. ctype = http.DetectContentType(p)
  2297. }
  2298. var date string
  2299. if _, ok := rws.snapHeader["Date"]; !ok {
  2300. // TODO(bradfitz): be faster here, like net/http? measure.
  2301. date = time.Now().UTC().Format(http.TimeFormat)
  2302. }
  2303. for _, v := range rws.snapHeader["Trailer"] {
  2304. foreachHeaderElement(v, rws.declareTrailer)
  2305. }
  2306. // "Connection" headers aren't allowed in HTTP/2 (RFC 7540, 8.1.2.2),
  2307. // but respect "Connection" == "close" to mean sending a GOAWAY and tearing
  2308. // down the TCP connection when idle, like we do for HTTP/1.
  2309. // TODO: remove more Connection-specific header fields here, in addition
  2310. // to "Connection".
  2311. if _, ok := rws.snapHeader["Connection"]; ok {
  2312. v := rws.snapHeader.Get("Connection")
  2313. delete(rws.snapHeader, "Connection")
  2314. if v == "close" {
  2315. rws.conn.startGracefulShutdown()
  2316. }
  2317. }
  2318. endStream := (rws.handlerDone && !rws.hasTrailers() && len(p) == 0) || isHeadResp
  2319. err = rws.conn.writeHeaders(rws.stream, &writeResHeaders{
  2320. streamID: rws.stream.id,
  2321. httpResCode: rws.status,
  2322. h: rws.snapHeader,
  2323. endStream: endStream,
  2324. contentType: ctype,
  2325. contentLength: clen,
  2326. date: date,
  2327. })
  2328. if err != nil {
  2329. rws.dirty = true
  2330. return 0, err
  2331. }
  2332. if endStream {
  2333. return 0, nil
  2334. }
  2335. }
  2336. if isHeadResp {
  2337. return len(p), nil
  2338. }
  2339. if len(p) == 0 && !rws.handlerDone {
  2340. return 0, nil
  2341. }
  2342. if rws.handlerDone {
  2343. rws.promoteUndeclaredTrailers()
  2344. }
  2345. // only send trailers if they have actually been defined by the
  2346. // server handler.
  2347. hasNonemptyTrailers := rws.hasNonemptyTrailers()
  2348. endStream := rws.handlerDone && !hasNonemptyTrailers
  2349. if len(p) > 0 || endStream {
  2350. // only send a 0 byte DATA frame if we're ending the stream.
  2351. if err := rws.conn.writeDataFromHandler(rws.stream, p, endStream); err != nil {
  2352. rws.dirty = true
  2353. return 0, err
  2354. }
  2355. }
  2356. if rws.handlerDone && hasNonemptyTrailers {
  2357. err = rws.conn.writeHeaders(rws.stream, &writeResHeaders{
  2358. streamID: rws.stream.id,
  2359. h: rws.handlerHeader,
  2360. trailers: rws.trailers,
  2361. endStream: true,
  2362. })
  2363. if err != nil {
  2364. rws.dirty = true
  2365. }
  2366. return len(p), err
  2367. }
  2368. return len(p), nil
  2369. }
  2370. // TrailerPrefix is a magic prefix for ResponseWriter.Header map keys
  2371. // that, if present, signals that the map entry is actually for
  2372. // the response trailers, and not the response headers. The prefix
  2373. // is stripped after the ServeHTTP call finishes and the values are
  2374. // sent in the trailers.
  2375. //
  2376. // This mechanism is intended only for trailers that are not known
  2377. // prior to the headers being written. If the set of trailers is fixed
  2378. // or known before the header is written, the normal Go trailers mechanism
  2379. // is preferred:
  2380. //
  2381. // https://golang.org/pkg/net/http/#ResponseWriter
  2382. // https://golang.org/pkg/net/http/#example_ResponseWriter_trailers
  2383. const TrailerPrefix = "Trailer:"
  2384. // promoteUndeclaredTrailers permits http.Handlers to set trailers
  2385. // after the header has already been flushed. Because the Go
  2386. // ResponseWriter interface has no way to set Trailers (only the
  2387. // Header), and because we didn't want to expand the ResponseWriter
  2388. // interface, and because nobody used trailers, and because RFC 7230
  2389. // says you SHOULD (but not must) predeclare any trailers in the
  2390. // header, the official ResponseWriter rules said trailers in Go must
  2391. // be predeclared, and then we reuse the same ResponseWriter.Header()
  2392. // map to mean both Headers and Trailers. When it's time to write the
  2393. // Trailers, we pick out the fields of Headers that were declared as
  2394. // trailers. That worked for a while, until we found the first major
  2395. // user of Trailers in the wild: gRPC (using them only over http2),
  2396. // and gRPC libraries permit setting trailers mid-stream without
  2397. // predeclaring them. So: change of plans. We still permit the old
  2398. // way, but we also permit this hack: if a Header() key begins with
  2399. // "Trailer:", the suffix of that key is a Trailer. Because ':' is an
  2400. // invalid token byte anyway, there is no ambiguity. (And it's already
  2401. // filtered out) It's mildly hacky, but not terrible.
  2402. //
  2403. // This method runs after the Handler is done and promotes any Header
  2404. // fields to be trailers.
  2405. func (rws *responseWriterState) promoteUndeclaredTrailers() {
  2406. for k, vv := range rws.handlerHeader {
  2407. if !strings.HasPrefix(k, TrailerPrefix) {
  2408. continue
  2409. }
  2410. trailerKey := strings.TrimPrefix(k, TrailerPrefix)
  2411. rws.declareTrailer(trailerKey)
  2412. rws.handlerHeader[http.CanonicalHeaderKey(trailerKey)] = vv
  2413. }
  2414. if len(rws.trailers) > 1 {
  2415. sorter := sorterPool.Get().(*sorter)
  2416. sorter.SortStrings(rws.trailers)
  2417. sorterPool.Put(sorter)
  2418. }
  2419. }
  2420. func (w *responseWriter) Flush() {
  2421. rws := w.rws
  2422. if rws == nil {
  2423. panic("Header called after Handler finished")
  2424. }
  2425. if rws.bw.Buffered() > 0 {
  2426. if err := rws.bw.Flush(); err != nil {
  2427. // Ignore the error. The frame writer already knows.
  2428. return
  2429. }
  2430. } else {
  2431. // The bufio.Writer won't call chunkWriter.Write
  2432. // (writeChunk with zero bytes, so we have to do it
  2433. // ourselves to force the HTTP response header and/or
  2434. // final DATA frame (with END_STREAM) to be sent.
  2435. rws.writeChunk(nil)
  2436. }
  2437. }
  2438. func (w *responseWriter) CloseNotify() <-chan bool {
  2439. rws := w.rws
  2440. if rws == nil {
  2441. panic("CloseNotify called after Handler finished")
  2442. }
  2443. rws.closeNotifierMu.Lock()
  2444. ch := rws.closeNotifierCh
  2445. if ch == nil {
  2446. ch = make(chan bool, 1)
  2447. rws.closeNotifierCh = ch
  2448. cw := rws.stream.cw
  2449. go func() {
  2450. cw.Wait() // wait for close
  2451. ch <- true
  2452. }()
  2453. }
  2454. rws.closeNotifierMu.Unlock()
  2455. return ch
  2456. }
  2457. func (w *responseWriter) Header() http.Header {
  2458. rws := w.rws
  2459. if rws == nil {
  2460. panic("Header called after Handler finished")
  2461. }
  2462. if rws.handlerHeader == nil {
  2463. rws.handlerHeader = make(http.Header)
  2464. }
  2465. return rws.handlerHeader
  2466. }
  2467. // checkWriteHeaderCode is a copy of net/http's checkWriteHeaderCode.
  2468. func checkWriteHeaderCode(code int) {
  2469. // Issue 22880: require valid WriteHeader status codes.
  2470. // For now we only enforce that it's three digits.
  2471. // In the future we might block things over 599 (600 and above aren't defined
  2472. // at http://httpwg.org/specs/rfc7231.html#status.codes).
  2473. // But for now any three digits.
  2474. //
  2475. // We used to send "HTTP/1.1 000 0" on the wire in responses but there's
  2476. // no equivalent bogus thing we can realistically send in HTTP/2,
  2477. // so we'll consistently panic instead and help people find their bugs
  2478. // early. (We can't return an error from WriteHeader even if we wanted to.)
  2479. if code < 100 || code > 999 {
  2480. panic(fmt.Sprintf("invalid WriteHeader code %v", code))
  2481. }
  2482. }
  2483. func (w *responseWriter) WriteHeader(code int) {
  2484. rws := w.rws
  2485. if rws == nil {
  2486. panic("WriteHeader called after Handler finished")
  2487. }
  2488. rws.writeHeader(code)
  2489. }
  2490. func (rws *responseWriterState) writeHeader(code int) {
  2491. if rws.wroteHeader {
  2492. return
  2493. }
  2494. checkWriteHeaderCode(code)
  2495. // Handle informational headers
  2496. if code >= 100 && code <= 199 {
  2497. // Per RFC 8297 we must not clear the current header map
  2498. h := rws.handlerHeader
  2499. _, cl := h["Content-Length"]
  2500. _, te := h["Transfer-Encoding"]
  2501. if cl || te {
  2502. h = h.Clone()
  2503. h.Del("Content-Length")
  2504. h.Del("Transfer-Encoding")
  2505. }
  2506. if rws.conn.writeHeaders(rws.stream, &writeResHeaders{
  2507. streamID: rws.stream.id,
  2508. httpResCode: code,
  2509. h: h,
  2510. endStream: rws.handlerDone && !rws.hasTrailers(),
  2511. }) != nil {
  2512. rws.dirty = true
  2513. }
  2514. return
  2515. }
  2516. rws.wroteHeader = true
  2517. rws.status = code
  2518. if len(rws.handlerHeader) > 0 {
  2519. rws.snapHeader = cloneHeader(rws.handlerHeader)
  2520. }
  2521. }
  2522. func cloneHeader(h http.Header) http.Header {
  2523. h2 := make(http.Header, len(h))
  2524. for k, vv := range h {
  2525. vv2 := make([]string, len(vv))
  2526. copy(vv2, vv)
  2527. h2[k] = vv2
  2528. }
  2529. return h2
  2530. }
  2531. // The Life Of A Write is like this:
  2532. //
  2533. // * Handler calls w.Write or w.WriteString ->
  2534. // * -> rws.bw (*bufio.Writer) ->
  2535. // * (Handler might call Flush)
  2536. // * -> chunkWriter{rws}
  2537. // * -> responseWriterState.writeChunk(p []byte)
  2538. // * -> responseWriterState.writeChunk (most of the magic; see comment there)
  2539. func (w *responseWriter) Write(p []byte) (n int, err error) {
  2540. return w.write(len(p), p, "")
  2541. }
  2542. func (w *responseWriter) WriteString(s string) (n int, err error) {
  2543. return w.write(len(s), nil, s)
  2544. }
  2545. // either dataB or dataS is non-zero.
  2546. func (w *responseWriter) write(lenData int, dataB []byte, dataS string) (n int, err error) {
  2547. rws := w.rws
  2548. if rws == nil {
  2549. panic("Write called after Handler finished")
  2550. }
  2551. if !rws.wroteHeader {
  2552. w.WriteHeader(200)
  2553. }
  2554. if !bodyAllowedForStatus(rws.status) {
  2555. return 0, http.ErrBodyNotAllowed
  2556. }
  2557. rws.wroteBytes += int64(len(dataB)) + int64(len(dataS)) // only one can be set
  2558. if rws.sentContentLen != 0 && rws.wroteBytes > rws.sentContentLen {
  2559. // TODO: send a RST_STREAM
  2560. return 0, errors.New("http2: handler wrote more than declared Content-Length")
  2561. }
  2562. if dataB != nil {
  2563. return rws.bw.Write(dataB)
  2564. } else {
  2565. return rws.bw.WriteString(dataS)
  2566. }
  2567. }
  2568. func (w *responseWriter) handlerDone() {
  2569. rws := w.rws
  2570. dirty := rws.dirty
  2571. rws.handlerDone = true
  2572. w.Flush()
  2573. w.rws = nil
  2574. if !dirty {
  2575. // Only recycle the pool if all prior Write calls to
  2576. // the serverConn goroutine completed successfully. If
  2577. // they returned earlier due to resets from the peer
  2578. // there might still be write goroutines outstanding
  2579. // from the serverConn referencing the rws memory. See
  2580. // issue 20704.
  2581. responseWriterStatePool.Put(rws)
  2582. }
  2583. }
  2584. // Push errors.
  2585. var (
  2586. ErrRecursivePush = errors.New("http2: recursive push not allowed")
  2587. ErrPushLimitReached = errors.New("http2: push would exceed peer's SETTINGS_MAX_CONCURRENT_STREAMS")
  2588. )
  2589. var _ http.Pusher = (*responseWriter)(nil)
  2590. func (w *responseWriter) Push(target string, opts *http.PushOptions) error {
  2591. st := w.rws.stream
  2592. sc := st.sc
  2593. sc.serveG.checkNotOn()
  2594. // No recursive pushes: "PUSH_PROMISE frames MUST only be sent on a peer-initiated stream."
  2595. // http://tools.ietf.org/html/rfc7540#section-6.6
  2596. if st.isPushed() {
  2597. return ErrRecursivePush
  2598. }
  2599. if opts == nil {
  2600. opts = new(http.PushOptions)
  2601. }
  2602. // Default options.
  2603. if opts.Method == "" {
  2604. opts.Method = "GET"
  2605. }
  2606. if opts.Header == nil {
  2607. opts.Header = http.Header{}
  2608. }
  2609. wantScheme := "http"
  2610. if w.rws.req.TLS != nil {
  2611. wantScheme = "https"
  2612. }
  2613. // Validate the request.
  2614. u, err := url.Parse(target)
  2615. if err != nil {
  2616. return err
  2617. }
  2618. if u.Scheme == "" {
  2619. if !strings.HasPrefix(target, "/") {
  2620. return fmt.Errorf("target must be an absolute URL or an absolute path: %q", target)
  2621. }
  2622. u.Scheme = wantScheme
  2623. u.Host = w.rws.req.Host
  2624. } else {
  2625. if u.Scheme != wantScheme {
  2626. return fmt.Errorf("cannot push URL with scheme %q from request with scheme %q", u.Scheme, wantScheme)
  2627. }
  2628. if u.Host == "" {
  2629. return errors.New("URL must have a host")
  2630. }
  2631. }
  2632. for k := range opts.Header {
  2633. if strings.HasPrefix(k, ":") {
  2634. return fmt.Errorf("promised request headers cannot include pseudo header %q", k)
  2635. }
  2636. // These headers are meaningful only if the request has a body,
  2637. // but PUSH_PROMISE requests cannot have a body.
  2638. // http://tools.ietf.org/html/rfc7540#section-8.2
  2639. // Also disallow Host, since the promised URL must be absolute.
  2640. if asciiEqualFold(k, "content-length") ||
  2641. asciiEqualFold(k, "content-encoding") ||
  2642. asciiEqualFold(k, "trailer") ||
  2643. asciiEqualFold(k, "te") ||
  2644. asciiEqualFold(k, "expect") ||
  2645. asciiEqualFold(k, "host") {
  2646. return fmt.Errorf("promised request headers cannot include %q", k)
  2647. }
  2648. }
  2649. if err := checkValidHTTP2RequestHeaders(opts.Header); err != nil {
  2650. return err
  2651. }
  2652. // The RFC effectively limits promised requests to GET and HEAD:
  2653. // "Promised requests MUST be cacheable [GET, HEAD, or POST], and MUST be safe [GET or HEAD]"
  2654. // http://tools.ietf.org/html/rfc7540#section-8.2
  2655. if opts.Method != "GET" && opts.Method != "HEAD" {
  2656. return fmt.Errorf("method %q must be GET or HEAD", opts.Method)
  2657. }
  2658. msg := &startPushRequest{
  2659. parent: st,
  2660. method: opts.Method,
  2661. url: u,
  2662. header: cloneHeader(opts.Header),
  2663. done: errChanPool.Get().(chan error),
  2664. }
  2665. select {
  2666. case <-sc.doneServing:
  2667. return errClientDisconnected
  2668. case <-st.cw:
  2669. return errStreamClosed
  2670. case sc.serveMsgCh <- msg:
  2671. }
  2672. select {
  2673. case <-sc.doneServing:
  2674. return errClientDisconnected
  2675. case <-st.cw:
  2676. return errStreamClosed
  2677. case err := <-msg.done:
  2678. errChanPool.Put(msg.done)
  2679. return err
  2680. }
  2681. }
  2682. type startPushRequest struct {
  2683. parent *stream
  2684. method string
  2685. url *url.URL
  2686. header http.Header
  2687. done chan error
  2688. }
  2689. func (sc *serverConn) startPush(msg *startPushRequest) {
  2690. sc.serveG.check()
  2691. // http://tools.ietf.org/html/rfc7540#section-6.6.
  2692. // PUSH_PROMISE frames MUST only be sent on a peer-initiated stream that
  2693. // is in either the "open" or "half-closed (remote)" state.
  2694. if msg.parent.state != stateOpen && msg.parent.state != stateHalfClosedRemote {
  2695. // responseWriter.Push checks that the stream is peer-initiated.
  2696. msg.done <- errStreamClosed
  2697. return
  2698. }
  2699. // http://tools.ietf.org/html/rfc7540#section-6.6.
  2700. if !sc.pushEnabled {
  2701. msg.done <- http.ErrNotSupported
  2702. return
  2703. }
  2704. // PUSH_PROMISE frames must be sent in increasing order by stream ID, so
  2705. // we allocate an ID for the promised stream lazily, when the PUSH_PROMISE
  2706. // is written. Once the ID is allocated, we start the request handler.
  2707. allocatePromisedID := func() (uint32, error) {
  2708. sc.serveG.check()
  2709. // Check this again, just in case. Technically, we might have received
  2710. // an updated SETTINGS by the time we got around to writing this frame.
  2711. if !sc.pushEnabled {
  2712. return 0, http.ErrNotSupported
  2713. }
  2714. // http://tools.ietf.org/html/rfc7540#section-6.5.2.
  2715. if sc.curPushedStreams+1 > sc.clientMaxStreams {
  2716. return 0, ErrPushLimitReached
  2717. }
  2718. // http://tools.ietf.org/html/rfc7540#section-5.1.1.
  2719. // Streams initiated by the server MUST use even-numbered identifiers.
  2720. // A server that is unable to establish a new stream identifier can send a GOAWAY
  2721. // frame so that the client is forced to open a new connection for new streams.
  2722. if sc.maxPushPromiseID+2 >= 1<<31 {
  2723. sc.startGracefulShutdownInternal()
  2724. return 0, ErrPushLimitReached
  2725. }
  2726. sc.maxPushPromiseID += 2
  2727. promisedID := sc.maxPushPromiseID
  2728. // http://tools.ietf.org/html/rfc7540#section-8.2.
  2729. // Strictly speaking, the new stream should start in "reserved (local)", then
  2730. // transition to "half closed (remote)" after sending the initial HEADERS, but
  2731. // we start in "half closed (remote)" for simplicity.
  2732. // See further comments at the definition of stateHalfClosedRemote.
  2733. promised := sc.newStream(promisedID, msg.parent.id, stateHalfClosedRemote)
  2734. rw, req, err := sc.newWriterAndRequestNoBody(promised, requestParam{
  2735. method: msg.method,
  2736. scheme: msg.url.Scheme,
  2737. authority: msg.url.Host,
  2738. path: msg.url.RequestURI(),
  2739. header: cloneHeader(msg.header), // clone since handler runs concurrently with writing the PUSH_PROMISE
  2740. })
  2741. if err != nil {
  2742. // Should not happen, since we've already validated msg.url.
  2743. panic(fmt.Sprintf("newWriterAndRequestNoBody(%+v): %v", msg.url, err))
  2744. }
  2745. go sc.runHandler(rw, req, sc.handler.ServeHTTP)
  2746. return promisedID, nil
  2747. }
  2748. sc.writeFrame(FrameWriteRequest{
  2749. write: &writePushPromise{
  2750. streamID: msg.parent.id,
  2751. method: msg.method,
  2752. url: msg.url,
  2753. h: msg.header,
  2754. allocatePromisedID: allocatePromisedID,
  2755. },
  2756. stream: msg.parent,
  2757. done: msg.done,
  2758. })
  2759. }
  2760. // foreachHeaderElement splits v according to the "#rule" construction
  2761. // in RFC 7230 section 7 and calls fn for each non-empty element.
  2762. func foreachHeaderElement(v string, fn func(string)) {
  2763. v = textproto.TrimString(v)
  2764. if v == "" {
  2765. return
  2766. }
  2767. if !strings.Contains(v, ",") {
  2768. fn(v)
  2769. return
  2770. }
  2771. for _, f := range strings.Split(v, ",") {
  2772. if f = textproto.TrimString(f); f != "" {
  2773. fn(f)
  2774. }
  2775. }
  2776. }
  2777. // From http://httpwg.org/specs/rfc7540.html#rfc.section.8.1.2.2
  2778. var connHeaders = []string{
  2779. "Connection",
  2780. "Keep-Alive",
  2781. "Proxy-Connection",
  2782. "Transfer-Encoding",
  2783. "Upgrade",
  2784. }
  2785. // checkValidHTTP2RequestHeaders checks whether h is a valid HTTP/2 request,
  2786. // per RFC 7540 Section 8.1.2.2.
  2787. // The returned error is reported to users.
  2788. func checkValidHTTP2RequestHeaders(h http.Header) error {
  2789. for _, k := range connHeaders {
  2790. if _, ok := h[k]; ok {
  2791. return fmt.Errorf("request header %q is not valid in HTTP/2", k)
  2792. }
  2793. }
  2794. te := h["Te"]
  2795. if len(te) > 0 && (len(te) > 1 || (te[0] != "trailers" && te[0] != "")) {
  2796. return errors.New(`request header "TE" may only be "trailers" in HTTP/2`)
  2797. }
  2798. return nil
  2799. }
  2800. func new400Handler(err error) http.HandlerFunc {
  2801. return func(w http.ResponseWriter, r *http.Request) {
  2802. http.Error(w, err.Error(), http.StatusBadRequest)
  2803. }
  2804. }
  2805. // h1ServerKeepAlivesDisabled reports whether hs has its keep-alives
  2806. // disabled. See comments on h1ServerShutdownChan above for why
  2807. // the code is written this way.
  2808. func h1ServerKeepAlivesDisabled(hs *http.Server) bool {
  2809. var x interface{} = hs
  2810. type I interface {
  2811. doKeepAlives() bool
  2812. }
  2813. if hs, ok := x.(I); ok {
  2814. return !hs.doKeepAlives()
  2815. }
  2816. return false
  2817. }
  2818. func (sc *serverConn) countError(name string, err error) error {
  2819. if sc == nil || sc.srv == nil {
  2820. return err
  2821. }
  2822. f := sc.srv.CountError
  2823. if f == nil {
  2824. return err
  2825. }
  2826. var typ string
  2827. var code ErrCode
  2828. switch e := err.(type) {
  2829. case ConnectionError:
  2830. typ = "conn"
  2831. code = ErrCode(e)
  2832. case StreamError:
  2833. typ = "stream"
  2834. code = ErrCode(e.Code)
  2835. default:
  2836. return err
  2837. }
  2838. codeStr := errCodeName[code]
  2839. if codeStr == "" {
  2840. codeStr = strconv.Itoa(int(code))
  2841. }
  2842. f(fmt.Sprintf("%s_%s_%s", typ, codeStr, name))
  2843. return err
  2844. }