github.com/AESNooper/go/src@v0.0.0-20220218095104-b56a4ab1bbbb/net/http/server.go (about) 1 // Copyright 2009 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 5 // HTTP server. See RFC 7230 through 7235. 6 7 package http 8 9 import ( 10 "bufio" 11 "bytes" 12 "context" 13 "crypto/tls" 14 "errors" 15 "fmt" 16 "internal/godebug" 17 "io" 18 "log" 19 "math/rand" 20 "net" 21 "net/textproto" 22 "net/url" 23 urlpkg "net/url" 24 "path" 25 "runtime" 26 "sort" 27 "strconv" 28 "strings" 29 "sync" 30 "sync/atomic" 31 "time" 32 33 "golang.org/x/net/http/httpguts" 34 ) 35 36 // Errors used by the HTTP server. 37 var ( 38 // ErrBodyNotAllowed is returned by ResponseWriter.Write calls 39 // when the HTTP method or response code does not permit a 40 // body. 41 ErrBodyNotAllowed = errors.New("http: request method or response status code does not allow body") 42 43 // ErrHijacked is returned by ResponseWriter.Write calls when 44 // the underlying connection has been hijacked using the 45 // Hijacker interface. A zero-byte write on a hijacked 46 // connection will return ErrHijacked without any other side 47 // effects. 48 ErrHijacked = errors.New("http: connection has been hijacked") 49 50 // ErrContentLength is returned by ResponseWriter.Write calls 51 // when a Handler set a Content-Length response header with a 52 // declared size and then attempted to write more bytes than 53 // declared. 54 ErrContentLength = errors.New("http: wrote more than the declared Content-Length") 55 56 // Deprecated: ErrWriteAfterFlush is no longer returned by 57 // anything in the net/http package. Callers should not 58 // compare errors against this variable. 59 ErrWriteAfterFlush = errors.New("unused") 60 ) 61 62 // A Handler responds to an HTTP request. 63 // 64 // ServeHTTP should write reply headers and data to the ResponseWriter 65 // and then return. Returning signals that the request is finished; it 66 // is not valid to use the ResponseWriter or read from the 67 // Request.Body after or concurrently with the completion of the 68 // ServeHTTP call. 69 // 70 // Depending on the HTTP client software, HTTP protocol version, and 71 // any intermediaries between the client and the Go server, it may not 72 // be possible to read from the Request.Body after writing to the 73 // ResponseWriter. Cautious handlers should read the Request.Body 74 // first, and then reply. 75 // 76 // Except for reading the body, handlers should not modify the 77 // provided Request. 78 // 79 // If ServeHTTP panics, the server (the caller of ServeHTTP) assumes 80 // that the effect of the panic was isolated to the active request. 81 // It recovers the panic, logs a stack trace to the server error log, 82 // and either closes the network connection or sends an HTTP/2 83 // RST_STREAM, depending on the HTTP protocol. To abort a handler so 84 // the client sees an interrupted response but the server doesn't log 85 // an error, panic with the value ErrAbortHandler. 86 type Handler interface { 87 ServeHTTP(ResponseWriter, *Request) 88 } 89 90 // A ResponseWriter interface is used by an HTTP handler to 91 // construct an HTTP response. 92 // 93 // A ResponseWriter may not be used after the Handler.ServeHTTP method 94 // has returned. 95 type ResponseWriter interface { 96 // Header returns the header map that will be sent by 97 // WriteHeader. The Header map also is the mechanism with which 98 // Handlers can set HTTP trailers. 99 // 100 // Changing the header map after a call to WriteHeader (or 101 // Write) has no effect unless the modified headers are 102 // trailers. 103 // 104 // There are two ways to set Trailers. The preferred way is to 105 // predeclare in the headers which trailers you will later 106 // send by setting the "Trailer" header to the names of the 107 // trailer keys which will come later. In this case, those 108 // keys of the Header map are treated as if they were 109 // trailers. See the example. The second way, for trailer 110 // keys not known to the Handler until after the first Write, 111 // is to prefix the Header map keys with the TrailerPrefix 112 // constant value. See TrailerPrefix. 113 // 114 // To suppress automatic response headers (such as "Date"), set 115 // their value to nil. 116 Header() Header 117 118 // Write writes the data to the connection as part of an HTTP reply. 119 // 120 // If WriteHeader has not yet been called, Write calls 121 // WriteHeader(http.StatusOK) before writing the data. If the Header 122 // does not contain a Content-Type line, Write adds a Content-Type set 123 // to the result of passing the initial 512 bytes of written data to 124 // DetectContentType. Additionally, if the total size of all written 125 // data is under a few KB and there are no Flush calls, the 126 // Content-Length header is added automatically. 127 // 128 // Depending on the HTTP protocol version and the client, calling 129 // Write or WriteHeader may prevent future reads on the 130 // Request.Body. For HTTP/1.x requests, handlers should read any 131 // needed request body data before writing the response. Once the 132 // headers have been flushed (due to either an explicit Flusher.Flush 133 // call or writing enough data to trigger a flush), the request body 134 // may be unavailable. For HTTP/2 requests, the Go HTTP server permits 135 // handlers to continue to read the request body while concurrently 136 // writing the response. However, such behavior may not be supported 137 // by all HTTP/2 clients. Handlers should read before writing if 138 // possible to maximize compatibility. 139 Write([]byte) (int, error) 140 141 // WriteHeader sends an HTTP response header with the provided 142 // status code. 143 // 144 // If WriteHeader is not called explicitly, the first call to Write 145 // will trigger an implicit WriteHeader(http.StatusOK). 146 // Thus explicit calls to WriteHeader are mainly used to 147 // send error codes. 148 // 149 // The provided code must be a valid HTTP 1xx-5xx status code. 150 // Only one header may be written. Go does not currently 151 // support sending user-defined 1xx informational headers, 152 // with the exception of 100-continue response header that the 153 // Server sends automatically when the Request.Body is read. 154 WriteHeader(statusCode int) 155 } 156 157 // The Flusher interface is implemented by ResponseWriters that allow 158 // an HTTP handler to flush buffered data to the client. 159 // 160 // The default HTTP/1.x and HTTP/2 ResponseWriter implementations 161 // support Flusher, but ResponseWriter wrappers may not. Handlers 162 // should always test for this ability at runtime. 163 // 164 // Note that even for ResponseWriters that support Flush, 165 // if the client is connected through an HTTP proxy, 166 // the buffered data may not reach the client until the response 167 // completes. 168 type Flusher interface { 169 // Flush sends any buffered data to the client. 170 Flush() 171 } 172 173 // The Hijacker interface is implemented by ResponseWriters that allow 174 // an HTTP handler to take over the connection. 175 // 176 // The default ResponseWriter for HTTP/1.x connections supports 177 // Hijacker, but HTTP/2 connections intentionally do not. 178 // ResponseWriter wrappers may also not support Hijacker. Handlers 179 // should always test for this ability at runtime. 180 type Hijacker interface { 181 // Hijack lets the caller take over the connection. 182 // After a call to Hijack the HTTP server library 183 // will not do anything else with the connection. 184 // 185 // It becomes the caller's responsibility to manage 186 // and close the connection. 187 // 188 // The returned net.Conn may have read or write deadlines 189 // already set, depending on the configuration of the 190 // Server. It is the caller's responsibility to set 191 // or clear those deadlines as needed. 192 // 193 // The returned bufio.Reader may contain unprocessed buffered 194 // data from the client. 195 // 196 // After a call to Hijack, the original Request.Body must not 197 // be used. The original Request's Context remains valid and 198 // is not canceled until the Request's ServeHTTP method 199 // returns. 200 Hijack() (net.Conn, *bufio.ReadWriter, error) 201 } 202 203 // The CloseNotifier interface is implemented by ResponseWriters which 204 // allow detecting when the underlying connection has gone away. 205 // 206 // This mechanism can be used to cancel long operations on the server 207 // if the client has disconnected before the response is ready. 208 // 209 // Deprecated: the CloseNotifier interface predates Go's context package. 210 // New code should use Request.Context instead. 211 type CloseNotifier interface { 212 // CloseNotify returns a channel that receives at most a 213 // single value (true) when the client connection has gone 214 // away. 215 // 216 // CloseNotify may wait to notify until Request.Body has been 217 // fully read. 218 // 219 // After the Handler has returned, there is no guarantee 220 // that the channel receives a value. 221 // 222 // If the protocol is HTTP/1.1 and CloseNotify is called while 223 // processing an idempotent request (such a GET) while 224 // HTTP/1.1 pipelining is in use, the arrival of a subsequent 225 // pipelined request may cause a value to be sent on the 226 // returned channel. In practice HTTP/1.1 pipelining is not 227 // enabled in browsers and not seen often in the wild. If this 228 // is a problem, use HTTP/2 or only use CloseNotify on methods 229 // such as POST. 230 CloseNotify() <-chan bool 231 } 232 233 var ( 234 // ServerContextKey is a context key. It can be used in HTTP 235 // handlers with Context.Value to access the server that 236 // started the handler. The associated value will be of 237 // type *Server. 238 ServerContextKey = &contextKey{"http-server"} 239 240 // LocalAddrContextKey is a context key. It can be used in 241 // HTTP handlers with Context.Value to access the local 242 // address the connection arrived on. 243 // The associated value will be of type net.Addr. 244 LocalAddrContextKey = &contextKey{"local-addr"} 245 ) 246 247 // A conn represents the server side of an HTTP connection. 248 type conn struct { 249 // server is the server on which the connection arrived. 250 // Immutable; never nil. 251 server *Server 252 253 // cancelCtx cancels the connection-level context. 254 cancelCtx context.CancelFunc 255 256 // rwc is the underlying network connection. 257 // This is never wrapped by other types and is the value given out 258 // to CloseNotifier callers. It is usually of type *net.TCPConn or 259 // *tls.Conn. 260 rwc net.Conn 261 262 // remoteAddr is rwc.RemoteAddr().String(). It is not populated synchronously 263 // inside the Listener's Accept goroutine, as some implementations block. 264 // It is populated immediately inside the (*conn).serve goroutine. 265 // This is the value of a Handler's (*Request).RemoteAddr. 266 remoteAddr string 267 268 // tlsState is the TLS connection state when using TLS. 269 // nil means not TLS. 270 tlsState *tls.ConnectionState 271 272 // werr is set to the first write error to rwc. 273 // It is set via checkConnErrorWriter{w}, where bufw writes. 274 werr error 275 276 // r is bufr's read source. It's a wrapper around rwc that provides 277 // io.LimitedReader-style limiting (while reading request headers) 278 // and functionality to support CloseNotifier. See *connReader docs. 279 r *connReader 280 281 // bufr reads from r. 282 bufr *bufio.Reader 283 284 // bufw writes to checkConnErrorWriter{c}, which populates werr on error. 285 bufw *bufio.Writer 286 287 // lastMethod is the method of the most recent request 288 // on this connection, if any. 289 lastMethod string 290 291 curReq atomic.Value // of *response (which has a Request in it) 292 293 curState struct{ atomic uint64 } // packed (unixtime<<8|uint8(ConnState)) 294 295 // mu guards hijackedv 296 mu sync.Mutex 297 298 // hijackedv is whether this connection has been hijacked 299 // by a Handler with the Hijacker interface. 300 // It is guarded by mu. 301 hijackedv bool 302 } 303 304 func (c *conn) hijacked() bool { 305 c.mu.Lock() 306 defer c.mu.Unlock() 307 return c.hijackedv 308 } 309 310 // c.mu must be held. 311 func (c *conn) hijackLocked() (rwc net.Conn, buf *bufio.ReadWriter, err error) { 312 if c.hijackedv { 313 return nil, nil, ErrHijacked 314 } 315 c.r.abortPendingRead() 316 317 c.hijackedv = true 318 rwc = c.rwc 319 rwc.SetDeadline(time.Time{}) 320 321 buf = bufio.NewReadWriter(c.bufr, bufio.NewWriter(rwc)) 322 if c.r.hasByte { 323 if _, err := c.bufr.Peek(c.bufr.Buffered() + 1); err != nil { 324 return nil, nil, fmt.Errorf("unexpected Peek failure reading buffered byte: %v", err) 325 } 326 } 327 c.setState(rwc, StateHijacked, runHooks) 328 return 329 } 330 331 // This should be >= 512 bytes for DetectContentType, 332 // but otherwise it's somewhat arbitrary. 333 const bufferBeforeChunkingSize = 2048 334 335 // chunkWriter writes to a response's conn buffer, and is the writer 336 // wrapped by the response.w buffered writer. 337 // 338 // chunkWriter also is responsible for finalizing the Header, including 339 // conditionally setting the Content-Type and setting a Content-Length 340 // in cases where the handler's final output is smaller than the buffer 341 // size. It also conditionally adds chunk headers, when in chunking mode. 342 // 343 // See the comment above (*response).Write for the entire write flow. 344 type chunkWriter struct { 345 res *response 346 347 // header is either nil or a deep clone of res.handlerHeader 348 // at the time of res.writeHeader, if res.writeHeader is 349 // called and extra buffering is being done to calculate 350 // Content-Type and/or Content-Length. 351 header Header 352 353 // wroteHeader tells whether the header's been written to "the 354 // wire" (or rather: w.conn.buf). this is unlike 355 // (*response).wroteHeader, which tells only whether it was 356 // logically written. 357 wroteHeader bool 358 359 // set by the writeHeader method: 360 chunking bool // using chunked transfer encoding for reply body 361 } 362 363 var ( 364 crlf = []byte("\r\n") 365 colonSpace = []byte(": ") 366 ) 367 368 func (cw *chunkWriter) Write(p []byte) (n int, err error) { 369 if !cw.wroteHeader { 370 cw.writeHeader(p) 371 } 372 if cw.res.req.Method == "HEAD" { 373 // Eat writes. 374 return len(p), nil 375 } 376 if cw.chunking { 377 _, err = fmt.Fprintf(cw.res.conn.bufw, "%x\r\n", len(p)) 378 if err != nil { 379 cw.res.conn.rwc.Close() 380 return 381 } 382 } 383 n, err = cw.res.conn.bufw.Write(p) 384 if cw.chunking && err == nil { 385 _, err = cw.res.conn.bufw.Write(crlf) 386 } 387 if err != nil { 388 cw.res.conn.rwc.Close() 389 } 390 return 391 } 392 393 func (cw *chunkWriter) flush() { 394 if !cw.wroteHeader { 395 cw.writeHeader(nil) 396 } 397 cw.res.conn.bufw.Flush() 398 } 399 400 func (cw *chunkWriter) close() { 401 if !cw.wroteHeader { 402 cw.writeHeader(nil) 403 } 404 if cw.chunking { 405 bw := cw.res.conn.bufw // conn's bufio writer 406 // zero chunk to mark EOF 407 bw.WriteString("0\r\n") 408 if trailers := cw.res.finalTrailers(); trailers != nil { 409 trailers.Write(bw) // the writer handles noting errors 410 } 411 // final blank line after the trailers (whether 412 // present or not) 413 bw.WriteString("\r\n") 414 } 415 } 416 417 // A response represents the server side of an HTTP response. 418 type response struct { 419 conn *conn 420 req *Request // request for this response 421 reqBody io.ReadCloser 422 cancelCtx context.CancelFunc // when ServeHTTP exits 423 wroteHeader bool // reply header has been (logically) written 424 wroteContinue bool // 100 Continue response was written 425 wants10KeepAlive bool // HTTP/1.0 w/ Connection "keep-alive" 426 wantsClose bool // HTTP request has Connection "close" 427 428 // canWriteContinue is a boolean value accessed as an atomic int32 429 // that says whether or not a 100 Continue header can be written 430 // to the connection. 431 // writeContinueMu must be held while writing the header. 432 // These two fields together synchronize the body reader 433 // (the expectContinueReader, which wants to write 100 Continue) 434 // against the main writer. 435 canWriteContinue atomicBool 436 writeContinueMu sync.Mutex 437 438 w *bufio.Writer // buffers output in chunks to chunkWriter 439 cw chunkWriter 440 441 // handlerHeader is the Header that Handlers get access to, 442 // which may be retained and mutated even after WriteHeader. 443 // handlerHeader is copied into cw.header at WriteHeader 444 // time, and privately mutated thereafter. 445 handlerHeader Header 446 calledHeader bool // handler accessed handlerHeader via Header 447 448 written int64 // number of bytes written in body 449 contentLength int64 // explicitly-declared Content-Length; or -1 450 status int // status code passed to WriteHeader 451 452 // close connection after this reply. set on request and 453 // updated after response from handler if there's a 454 // "Connection: keep-alive" response header and a 455 // Content-Length. 456 closeAfterReply bool 457 458 // requestBodyLimitHit is set by requestTooLarge when 459 // maxBytesReader hits its max size. It is checked in 460 // WriteHeader, to make sure we don't consume the 461 // remaining request body to try to advance to the next HTTP 462 // request. Instead, when this is set, we stop reading 463 // subsequent requests on this connection and stop reading 464 // input from it. 465 requestBodyLimitHit bool 466 467 // trailers are the headers to be sent after the handler 468 // finishes writing the body. This field is initialized from 469 // the Trailer response header when the response header is 470 // written. 471 trailers []string 472 473 handlerDone atomicBool // set true when the handler exits 474 475 // Buffers for Date, Content-Length, and status code 476 dateBuf [len(TimeFormat)]byte 477 clenBuf [10]byte 478 statusBuf [3]byte 479 480 // closeNotifyCh is the channel returned by CloseNotify. 481 // TODO(bradfitz): this is currently (for Go 1.8) always 482 // non-nil. Make this lazily-created again as it used to be? 483 closeNotifyCh chan bool 484 didCloseNotify int32 // atomic (only 0->1 winner should send) 485 } 486 487 // TrailerPrefix is a magic prefix for ResponseWriter.Header map keys 488 // that, if present, signals that the map entry is actually for 489 // the response trailers, and not the response headers. The prefix 490 // is stripped after the ServeHTTP call finishes and the values are 491 // sent in the trailers. 492 // 493 // This mechanism is intended only for trailers that are not known 494 // prior to the headers being written. If the set of trailers is fixed 495 // or known before the header is written, the normal Go trailers mechanism 496 // is preferred: 497 // https://golang.org/pkg/net/http/#ResponseWriter 498 // https://golang.org/pkg/net/http/#example_ResponseWriter_trailers 499 const TrailerPrefix = "Trailer:" 500 501 // finalTrailers is called after the Handler exits and returns a non-nil 502 // value if the Handler set any trailers. 503 func (w *response) finalTrailers() Header { 504 var t Header 505 for k, vv := range w.handlerHeader { 506 if strings.HasPrefix(k, TrailerPrefix) { 507 if t == nil { 508 t = make(Header) 509 } 510 t[strings.TrimPrefix(k, TrailerPrefix)] = vv 511 } 512 } 513 for _, k := range w.trailers { 514 if t == nil { 515 t = make(Header) 516 } 517 for _, v := range w.handlerHeader[k] { 518 t.Add(k, v) 519 } 520 } 521 return t 522 } 523 524 type atomicBool int32 525 526 func (b *atomicBool) isSet() bool { return atomic.LoadInt32((*int32)(b)) != 0 } 527 func (b *atomicBool) setTrue() { atomic.StoreInt32((*int32)(b), 1) } 528 func (b *atomicBool) setFalse() { atomic.StoreInt32((*int32)(b), 0) } 529 530 // declareTrailer is called for each Trailer header when the 531 // response header is written. It notes that a header will need to be 532 // written in the trailers at the end of the response. 533 func (w *response) declareTrailer(k string) { 534 k = CanonicalHeaderKey(k) 535 if !httpguts.ValidTrailerHeader(k) { 536 // Forbidden by RFC 7230, section 4.1.2 537 return 538 } 539 w.trailers = append(w.trailers, k) 540 } 541 542 // requestTooLarge is called by maxBytesReader when too much input has 543 // been read from the client. 544 func (w *response) requestTooLarge() { 545 w.closeAfterReply = true 546 w.requestBodyLimitHit = true 547 if !w.wroteHeader { 548 w.Header().Set("Connection", "close") 549 } 550 } 551 552 // needsSniff reports whether a Content-Type still needs to be sniffed. 553 func (w *response) needsSniff() bool { 554 _, haveType := w.handlerHeader["Content-Type"] 555 return !w.cw.wroteHeader && !haveType && w.written < sniffLen 556 } 557 558 // writerOnly hides an io.Writer value's optional ReadFrom method 559 // from io.Copy. 560 type writerOnly struct { 561 io.Writer 562 } 563 564 // ReadFrom is here to optimize copying from an *os.File regular file 565 // to a *net.TCPConn with sendfile, or from a supported src type such 566 // as a *net.TCPConn on Linux with splice. 567 func (w *response) ReadFrom(src io.Reader) (n int64, err error) { 568 bufp := copyBufPool.Get().(*[]byte) 569 buf := *bufp 570 defer copyBufPool.Put(bufp) 571 572 // Our underlying w.conn.rwc is usually a *TCPConn (with its 573 // own ReadFrom method). If not, just fall back to the normal 574 // copy method. 575 rf, ok := w.conn.rwc.(io.ReaderFrom) 576 if !ok { 577 return io.CopyBuffer(writerOnly{w}, src, buf) 578 } 579 580 // Copy the first sniffLen bytes before switching to ReadFrom. 581 // This ensures we don't start writing the response before the 582 // source is available (see golang.org/issue/5660) and provides 583 // enough bytes to perform Content-Type sniffing when required. 584 if !w.cw.wroteHeader { 585 n0, err := io.CopyBuffer(writerOnly{w}, io.LimitReader(src, sniffLen), buf) 586 n += n0 587 if err != nil || n0 < sniffLen { 588 return n, err 589 } 590 } 591 592 w.w.Flush() // get rid of any previous writes 593 w.cw.flush() // make sure Header is written; flush data to rwc 594 595 // Now that cw has been flushed, its chunking field is guaranteed initialized. 596 if !w.cw.chunking && w.bodyAllowed() { 597 n0, err := rf.ReadFrom(src) 598 n += n0 599 w.written += n0 600 return n, err 601 } 602 603 n0, err := io.CopyBuffer(writerOnly{w}, src, buf) 604 n += n0 605 return n, err 606 } 607 608 // debugServerConnections controls whether all server connections are wrapped 609 // with a verbose logging wrapper. 610 const debugServerConnections = false 611 612 // Create new connection from rwc. 613 func (srv *Server) newConn(rwc net.Conn) *conn { 614 c := &conn{ 615 server: srv, 616 rwc: rwc, 617 } 618 if debugServerConnections { 619 c.rwc = newLoggingConn("server", c.rwc) 620 } 621 return c 622 } 623 624 type readResult struct { 625 _ incomparable 626 n int 627 err error 628 b byte // byte read, if n == 1 629 } 630 631 // connReader is the io.Reader wrapper used by *conn. It combines a 632 // selectively-activated io.LimitedReader (to bound request header 633 // read sizes) with support for selectively keeping an io.Reader.Read 634 // call blocked in a background goroutine to wait for activity and 635 // trigger a CloseNotifier channel. 636 type connReader struct { 637 conn *conn 638 639 mu sync.Mutex // guards following 640 hasByte bool 641 byteBuf [1]byte 642 cond *sync.Cond 643 inRead bool 644 aborted bool // set true before conn.rwc deadline is set to past 645 remain int64 // bytes remaining 646 } 647 648 func (cr *connReader) lock() { 649 cr.mu.Lock() 650 if cr.cond == nil { 651 cr.cond = sync.NewCond(&cr.mu) 652 } 653 } 654 655 func (cr *connReader) unlock() { cr.mu.Unlock() } 656 657 func (cr *connReader) startBackgroundRead() { 658 cr.lock() 659 defer cr.unlock() 660 if cr.inRead { 661 panic("invalid concurrent Body.Read call") 662 } 663 if cr.hasByte { 664 return 665 } 666 cr.inRead = true 667 cr.conn.rwc.SetReadDeadline(time.Time{}) 668 go cr.backgroundRead() 669 } 670 671 func (cr *connReader) backgroundRead() { 672 n, err := cr.conn.rwc.Read(cr.byteBuf[:]) 673 cr.lock() 674 if n == 1 { 675 cr.hasByte = true 676 // We were past the end of the previous request's body already 677 // (since we wouldn't be in a background read otherwise), so 678 // this is a pipelined HTTP request. Prior to Go 1.11 we used to 679 // send on the CloseNotify channel and cancel the context here, 680 // but the behavior was documented as only "may", and we only 681 // did that because that's how CloseNotify accidentally behaved 682 // in very early Go releases prior to context support. Once we 683 // added context support, people used a Handler's 684 // Request.Context() and passed it along. Having that context 685 // cancel on pipelined HTTP requests caused problems. 686 // Fortunately, almost nothing uses HTTP/1.x pipelining. 687 // Unfortunately, apt-get does, or sometimes does. 688 // New Go 1.11 behavior: don't fire CloseNotify or cancel 689 // contexts on pipelined requests. Shouldn't affect people, but 690 // fixes cases like Issue 23921. This does mean that a client 691 // closing their TCP connection after sending a pipelined 692 // request won't cancel the context, but we'll catch that on any 693 // write failure (in checkConnErrorWriter.Write). 694 // If the server never writes, yes, there are still contrived 695 // server & client behaviors where this fails to ever cancel the 696 // context, but that's kinda why HTTP/1.x pipelining died 697 // anyway. 698 } 699 if ne, ok := err.(net.Error); ok && cr.aborted && ne.Timeout() { 700 // Ignore this error. It's the expected error from 701 // another goroutine calling abortPendingRead. 702 } else if err != nil { 703 cr.handleReadError(err) 704 } 705 cr.aborted = false 706 cr.inRead = false 707 cr.unlock() 708 cr.cond.Broadcast() 709 } 710 711 func (cr *connReader) abortPendingRead() { 712 cr.lock() 713 defer cr.unlock() 714 if !cr.inRead { 715 return 716 } 717 cr.aborted = true 718 cr.conn.rwc.SetReadDeadline(aLongTimeAgo) 719 for cr.inRead { 720 cr.cond.Wait() 721 } 722 cr.conn.rwc.SetReadDeadline(time.Time{}) 723 } 724 725 func (cr *connReader) setReadLimit(remain int64) { cr.remain = remain } 726 func (cr *connReader) setInfiniteReadLimit() { cr.remain = maxInt64 } 727 func (cr *connReader) hitReadLimit() bool { return cr.remain <= 0 } 728 729 // handleReadError is called whenever a Read from the client returns a 730 // non-nil error. 731 // 732 // The provided non-nil err is almost always io.EOF or a "use of 733 // closed network connection". In any case, the error is not 734 // particularly interesting, except perhaps for debugging during 735 // development. Any error means the connection is dead and we should 736 // down its context. 737 // 738 // It may be called from multiple goroutines. 739 func (cr *connReader) handleReadError(_ error) { 740 cr.conn.cancelCtx() 741 cr.closeNotify() 742 } 743 744 // may be called from multiple goroutines. 745 func (cr *connReader) closeNotify() { 746 res, _ := cr.conn.curReq.Load().(*response) 747 if res != nil && atomic.CompareAndSwapInt32(&res.didCloseNotify, 0, 1) { 748 res.closeNotifyCh <- true 749 } 750 } 751 752 func (cr *connReader) Read(p []byte) (n int, err error) { 753 cr.lock() 754 if cr.inRead { 755 cr.unlock() 756 if cr.conn.hijacked() { 757 panic("invalid Body.Read call. After hijacked, the original Request must not be used") 758 } 759 panic("invalid concurrent Body.Read call") 760 } 761 if cr.hitReadLimit() { 762 cr.unlock() 763 return 0, io.EOF 764 } 765 if len(p) == 0 { 766 cr.unlock() 767 return 0, nil 768 } 769 if int64(len(p)) > cr.remain { 770 p = p[:cr.remain] 771 } 772 if cr.hasByte { 773 p[0] = cr.byteBuf[0] 774 cr.hasByte = false 775 cr.unlock() 776 return 1, nil 777 } 778 cr.inRead = true 779 cr.unlock() 780 n, err = cr.conn.rwc.Read(p) 781 782 cr.lock() 783 cr.inRead = false 784 if err != nil { 785 cr.handleReadError(err) 786 } 787 cr.remain -= int64(n) 788 cr.unlock() 789 790 cr.cond.Broadcast() 791 return n, err 792 } 793 794 var ( 795 bufioReaderPool sync.Pool 796 bufioWriter2kPool sync.Pool 797 bufioWriter4kPool sync.Pool 798 ) 799 800 var copyBufPool = sync.Pool{ 801 New: func() interface{} { 802 b := make([]byte, 32*1024) 803 return &b 804 }, 805 } 806 807 func bufioWriterPool(size int) *sync.Pool { 808 switch size { 809 case 2 << 10: 810 return &bufioWriter2kPool 811 case 4 << 10: 812 return &bufioWriter4kPool 813 } 814 return nil 815 } 816 817 func newBufioReader(r io.Reader) *bufio.Reader { 818 if v := bufioReaderPool.Get(); v != nil { 819 br := v.(*bufio.Reader) 820 br.Reset(r) 821 return br 822 } 823 // Note: if this reader size is ever changed, update 824 // TestHandlerBodyClose's assumptions. 825 return bufio.NewReader(r) 826 } 827 828 func putBufioReader(br *bufio.Reader) { 829 br.Reset(nil) 830 bufioReaderPool.Put(br) 831 } 832 833 func newBufioWriterSize(w io.Writer, size int) *bufio.Writer { 834 pool := bufioWriterPool(size) 835 if pool != nil { 836 if v := pool.Get(); v != nil { 837 bw := v.(*bufio.Writer) 838 bw.Reset(w) 839 return bw 840 } 841 } 842 return bufio.NewWriterSize(w, size) 843 } 844 845 func putBufioWriter(bw *bufio.Writer) { 846 bw.Reset(nil) 847 if pool := bufioWriterPool(bw.Available()); pool != nil { 848 pool.Put(bw) 849 } 850 } 851 852 // DefaultMaxHeaderBytes is the maximum permitted size of the headers 853 // in an HTTP request. 854 // This can be overridden by setting Server.MaxHeaderBytes. 855 const DefaultMaxHeaderBytes = 1 << 20 // 1 MB 856 857 func (srv *Server) maxHeaderBytes() int { 858 if srv.MaxHeaderBytes > 0 { 859 return srv.MaxHeaderBytes 860 } 861 return DefaultMaxHeaderBytes 862 } 863 864 func (srv *Server) initialReadLimitSize() int64 { 865 return int64(srv.maxHeaderBytes()) + 4096 // bufio slop 866 } 867 868 // tlsHandshakeTimeout returns the time limit permitted for the TLS 869 // handshake, or zero for unlimited. 870 // 871 // It returns the minimum of any positive ReadHeaderTimeout, 872 // ReadTimeout, or WriteTimeout. 873 func (srv *Server) tlsHandshakeTimeout() time.Duration { 874 var ret time.Duration 875 for _, v := range [...]time.Duration{ 876 srv.ReadHeaderTimeout, 877 srv.ReadTimeout, 878 srv.WriteTimeout, 879 } { 880 if v <= 0 { 881 continue 882 } 883 if ret == 0 || v < ret { 884 ret = v 885 } 886 } 887 return ret 888 } 889 890 // wrapper around io.ReadCloser which on first read, sends an 891 // HTTP/1.1 100 Continue header 892 type expectContinueReader struct { 893 resp *response 894 readCloser io.ReadCloser 895 closed atomicBool 896 sawEOF atomicBool 897 } 898 899 func (ecr *expectContinueReader) Read(p []byte) (n int, err error) { 900 if ecr.closed.isSet() { 901 return 0, ErrBodyReadAfterClose 902 } 903 w := ecr.resp 904 if !w.wroteContinue && w.canWriteContinue.isSet() && !w.conn.hijacked() { 905 w.wroteContinue = true 906 w.writeContinueMu.Lock() 907 if w.canWriteContinue.isSet() { 908 w.conn.bufw.WriteString("HTTP/1.1 100 Continue\r\n\r\n") 909 w.conn.bufw.Flush() 910 w.canWriteContinue.setFalse() 911 } 912 w.writeContinueMu.Unlock() 913 } 914 n, err = ecr.readCloser.Read(p) 915 if err == io.EOF { 916 ecr.sawEOF.setTrue() 917 } 918 return 919 } 920 921 func (ecr *expectContinueReader) Close() error { 922 ecr.closed.setTrue() 923 return ecr.readCloser.Close() 924 } 925 926 // TimeFormat is the time format to use when generating times in HTTP 927 // headers. It is like time.RFC1123 but hard-codes GMT as the time 928 // zone. The time being formatted must be in UTC for Format to 929 // generate the correct format. 930 // 931 // For parsing this time format, see ParseTime. 932 const TimeFormat = "Mon, 02 Jan 2006 15:04:05 GMT" 933 934 // appendTime is a non-allocating version of []byte(t.UTC().Format(TimeFormat)) 935 func appendTime(b []byte, t time.Time) []byte { 936 const days = "SunMonTueWedThuFriSat" 937 const months = "JanFebMarAprMayJunJulAugSepOctNovDec" 938 939 t = t.UTC() 940 yy, mm, dd := t.Date() 941 hh, mn, ss := t.Clock() 942 day := days[3*t.Weekday():] 943 mon := months[3*(mm-1):] 944 945 return append(b, 946 day[0], day[1], day[2], ',', ' ', 947 byte('0'+dd/10), byte('0'+dd%10), ' ', 948 mon[0], mon[1], mon[2], ' ', 949 byte('0'+yy/1000), byte('0'+(yy/100)%10), byte('0'+(yy/10)%10), byte('0'+yy%10), ' ', 950 byte('0'+hh/10), byte('0'+hh%10), ':', 951 byte('0'+mn/10), byte('0'+mn%10), ':', 952 byte('0'+ss/10), byte('0'+ss%10), ' ', 953 'G', 'M', 'T') 954 } 955 956 var errTooLarge = errors.New("http: request too large") 957 958 // Read next request from connection. 959 func (c *conn) readRequest(ctx context.Context) (w *response, err error) { 960 if c.hijacked() { 961 return nil, ErrHijacked 962 } 963 964 var ( 965 wholeReqDeadline time.Time // or zero if none 966 hdrDeadline time.Time // or zero if none 967 ) 968 t0 := time.Now() 969 if d := c.server.readHeaderTimeout(); d > 0 { 970 hdrDeadline = t0.Add(d) 971 } 972 if d := c.server.ReadTimeout; d > 0 { 973 wholeReqDeadline = t0.Add(d) 974 } 975 c.rwc.SetReadDeadline(hdrDeadline) 976 if d := c.server.WriteTimeout; d > 0 { 977 defer func() { 978 c.rwc.SetWriteDeadline(time.Now().Add(d)) 979 }() 980 } 981 982 c.r.setReadLimit(c.server.initialReadLimitSize()) 983 if c.lastMethod == "POST" { 984 // RFC 7230 section 3 tolerance for old buggy clients. 985 peek, _ := c.bufr.Peek(4) // ReadRequest will get err below 986 c.bufr.Discard(numLeadingCRorLF(peek)) 987 } 988 req, err := readRequest(c.bufr) 989 if err != nil { 990 if c.r.hitReadLimit() { 991 return nil, errTooLarge 992 } 993 return nil, err 994 } 995 996 if !http1ServerSupportsRequest(req) { 997 return nil, statusError{StatusHTTPVersionNotSupported, "unsupported protocol version"} 998 } 999 1000 c.lastMethod = req.Method 1001 c.r.setInfiniteReadLimit() 1002 1003 hosts, haveHost := req.Header["Host"] 1004 isH2Upgrade := req.isH2Upgrade() 1005 if req.ProtoAtLeast(1, 1) && (!haveHost || len(hosts) == 0) && !isH2Upgrade && req.Method != "CONNECT" { 1006 return nil, badRequestError("missing required Host header") 1007 } 1008 if len(hosts) == 1 && !httpguts.ValidHostHeader(hosts[0]) { 1009 return nil, badRequestError("malformed Host header") 1010 } 1011 for k, vv := range req.Header { 1012 if !httpguts.ValidHeaderFieldName(k) { 1013 return nil, badRequestError("invalid header name") 1014 } 1015 for _, v := range vv { 1016 if !httpguts.ValidHeaderFieldValue(v) { 1017 return nil, badRequestError("invalid header value") 1018 } 1019 } 1020 } 1021 delete(req.Header, "Host") 1022 1023 ctx, cancelCtx := context.WithCancel(ctx) 1024 req.ctx = ctx 1025 req.RemoteAddr = c.remoteAddr 1026 req.TLS = c.tlsState 1027 if body, ok := req.Body.(*body); ok { 1028 body.doEarlyClose = true 1029 } 1030 1031 // Adjust the read deadline if necessary. 1032 if !hdrDeadline.Equal(wholeReqDeadline) { 1033 c.rwc.SetReadDeadline(wholeReqDeadline) 1034 } 1035 1036 w = &response{ 1037 conn: c, 1038 cancelCtx: cancelCtx, 1039 req: req, 1040 reqBody: req.Body, 1041 handlerHeader: make(Header), 1042 contentLength: -1, 1043 closeNotifyCh: make(chan bool, 1), 1044 1045 // We populate these ahead of time so we're not 1046 // reading from req.Header after their Handler starts 1047 // and maybe mutates it (Issue 14940) 1048 wants10KeepAlive: req.wantsHttp10KeepAlive(), 1049 wantsClose: req.wantsClose(), 1050 } 1051 if isH2Upgrade { 1052 w.closeAfterReply = true 1053 } 1054 w.cw.res = w 1055 w.w = newBufioWriterSize(&w.cw, bufferBeforeChunkingSize) 1056 return w, nil 1057 } 1058 1059 // http1ServerSupportsRequest reports whether Go's HTTP/1.x server 1060 // supports the given request. 1061 func http1ServerSupportsRequest(req *Request) bool { 1062 if req.ProtoMajor == 1 { 1063 return true 1064 } 1065 // Accept "PRI * HTTP/2.0" upgrade requests, so Handlers can 1066 // wire up their own HTTP/2 upgrades. 1067 if req.ProtoMajor == 2 && req.ProtoMinor == 0 && 1068 req.Method == "PRI" && req.RequestURI == "*" { 1069 return true 1070 } 1071 // Reject HTTP/0.x, and all other HTTP/2+ requests (which 1072 // aren't encoded in ASCII anyway). 1073 return false 1074 } 1075 1076 func (w *response) Header() Header { 1077 if w.cw.header == nil && w.wroteHeader && !w.cw.wroteHeader { 1078 // Accessing the header between logically writing it 1079 // and physically writing it means we need to allocate 1080 // a clone to snapshot the logically written state. 1081 w.cw.header = w.handlerHeader.Clone() 1082 } 1083 w.calledHeader = true 1084 return w.handlerHeader 1085 } 1086 1087 // maxPostHandlerReadBytes is the max number of Request.Body bytes not 1088 // consumed by a handler that the server will read from the client 1089 // in order to keep a connection alive. If there are more bytes than 1090 // this then the server to be paranoid instead sends a "Connection: 1091 // close" response. 1092 // 1093 // This number is approximately what a typical machine's TCP buffer 1094 // size is anyway. (if we have the bytes on the machine, we might as 1095 // well read them) 1096 const maxPostHandlerReadBytes = 256 << 10 1097 1098 func checkWriteHeaderCode(code int) { 1099 // Issue 22880: require valid WriteHeader status codes. 1100 // For now we only enforce that it's three digits. 1101 // In the future we might block things over 599 (600 and above aren't defined 1102 // at https://httpwg.org/specs/rfc7231.html#status.codes) 1103 // and we might block under 200 (once we have more mature 1xx support). 1104 // But for now any three digits. 1105 // 1106 // We used to send "HTTP/1.1 000 0" on the wire in responses but there's 1107 // no equivalent bogus thing we can realistically send in HTTP/2, 1108 // so we'll consistently panic instead and help people find their bugs 1109 // early. (We can't return an error from WriteHeader even if we wanted to.) 1110 if code < 100 || code > 999 { 1111 panic(fmt.Sprintf("invalid WriteHeader code %v", code)) 1112 } 1113 } 1114 1115 // relevantCaller searches the call stack for the first function outside of net/http. 1116 // The purpose of this function is to provide more helpful error messages. 1117 func relevantCaller() runtime.Frame { 1118 pc := make([]uintptr, 16) 1119 n := runtime.Callers(1, pc) 1120 frames := runtime.CallersFrames(pc[:n]) 1121 var frame runtime.Frame 1122 for { 1123 frame, more := frames.Next() 1124 if !strings.HasPrefix(frame.Function, "net/http.") { 1125 return frame 1126 } 1127 if !more { 1128 break 1129 } 1130 } 1131 return frame 1132 } 1133 1134 func (w *response) WriteHeader(code int) { 1135 if w.conn.hijacked() { 1136 caller := relevantCaller() 1137 w.conn.server.logf("http: response.WriteHeader on hijacked connection from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line) 1138 return 1139 } 1140 if w.wroteHeader { 1141 caller := relevantCaller() 1142 w.conn.server.logf("http: superfluous response.WriteHeader call from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line) 1143 return 1144 } 1145 checkWriteHeaderCode(code) 1146 w.wroteHeader = true 1147 w.status = code 1148 1149 if w.calledHeader && w.cw.header == nil { 1150 w.cw.header = w.handlerHeader.Clone() 1151 } 1152 1153 if cl := w.handlerHeader.get("Content-Length"); cl != "" { 1154 v, err := strconv.ParseInt(cl, 10, 64) 1155 if err == nil && v >= 0 { 1156 w.contentLength = v 1157 } else { 1158 w.conn.server.logf("http: invalid Content-Length of %q", cl) 1159 w.handlerHeader.Del("Content-Length") 1160 } 1161 } 1162 } 1163 1164 // extraHeader is the set of headers sometimes added by chunkWriter.writeHeader. 1165 // This type is used to avoid extra allocations from cloning and/or populating 1166 // the response Header map and all its 1-element slices. 1167 type extraHeader struct { 1168 contentType string 1169 connection string 1170 transferEncoding string 1171 date []byte // written if not nil 1172 contentLength []byte // written if not nil 1173 } 1174 1175 // Sorted the same as extraHeader.Write's loop. 1176 var extraHeaderKeys = [][]byte{ 1177 []byte("Content-Type"), 1178 []byte("Connection"), 1179 []byte("Transfer-Encoding"), 1180 } 1181 1182 var ( 1183 headerContentLength = []byte("Content-Length: ") 1184 headerDate = []byte("Date: ") 1185 ) 1186 1187 // Write writes the headers described in h to w. 1188 // 1189 // This method has a value receiver, despite the somewhat large size 1190 // of h, because it prevents an allocation. The escape analysis isn't 1191 // smart enough to realize this function doesn't mutate h. 1192 func (h extraHeader) Write(w *bufio.Writer) { 1193 if h.date != nil { 1194 w.Write(headerDate) 1195 w.Write(h.date) 1196 w.Write(crlf) 1197 } 1198 if h.contentLength != nil { 1199 w.Write(headerContentLength) 1200 w.Write(h.contentLength) 1201 w.Write(crlf) 1202 } 1203 for i, v := range []string{h.contentType, h.connection, h.transferEncoding} { 1204 if v != "" { 1205 w.Write(extraHeaderKeys[i]) 1206 w.Write(colonSpace) 1207 w.WriteString(v) 1208 w.Write(crlf) 1209 } 1210 } 1211 } 1212 1213 // writeHeader finalizes the header sent to the client and writes it 1214 // to cw.res.conn.bufw. 1215 // 1216 // p is not written by writeHeader, but is the first chunk of the body 1217 // that will be written. It is sniffed for a Content-Type if none is 1218 // set explicitly. It's also used to set the Content-Length, if the 1219 // total body size was small and the handler has already finished 1220 // running. 1221 func (cw *chunkWriter) writeHeader(p []byte) { 1222 if cw.wroteHeader { 1223 return 1224 } 1225 cw.wroteHeader = true 1226 1227 w := cw.res 1228 keepAlivesEnabled := w.conn.server.doKeepAlives() 1229 isHEAD := w.req.Method == "HEAD" 1230 1231 // header is written out to w.conn.buf below. Depending on the 1232 // state of the handler, we either own the map or not. If we 1233 // don't own it, the exclude map is created lazily for 1234 // WriteSubset to remove headers. The setHeader struct holds 1235 // headers we need to add. 1236 header := cw.header 1237 owned := header != nil 1238 if !owned { 1239 header = w.handlerHeader 1240 } 1241 var excludeHeader map[string]bool 1242 delHeader := func(key string) { 1243 if owned { 1244 header.Del(key) 1245 return 1246 } 1247 if _, ok := header[key]; !ok { 1248 return 1249 } 1250 if excludeHeader == nil { 1251 excludeHeader = make(map[string]bool) 1252 } 1253 excludeHeader[key] = true 1254 } 1255 var setHeader extraHeader 1256 1257 // Don't write out the fake "Trailer:foo" keys. See TrailerPrefix. 1258 trailers := false 1259 for k := range cw.header { 1260 if strings.HasPrefix(k, TrailerPrefix) { 1261 if excludeHeader == nil { 1262 excludeHeader = make(map[string]bool) 1263 } 1264 excludeHeader[k] = true 1265 trailers = true 1266 } 1267 } 1268 for _, v := range cw.header["Trailer"] { 1269 trailers = true 1270 foreachHeaderElement(v, cw.res.declareTrailer) 1271 } 1272 1273 te := header.get("Transfer-Encoding") 1274 hasTE := te != "" 1275 1276 // If the handler is done but never sent a Content-Length 1277 // response header and this is our first (and last) write, set 1278 // it, even to zero. This helps HTTP/1.0 clients keep their 1279 // "keep-alive" connections alive. 1280 // Exceptions: 304/204/1xx responses never get Content-Length, and if 1281 // it was a HEAD request, we don't know the difference between 1282 // 0 actual bytes and 0 bytes because the handler noticed it 1283 // was a HEAD request and chose not to write anything. So for 1284 // HEAD, the handler should either write the Content-Length or 1285 // write non-zero bytes. If it's actually 0 bytes and the 1286 // handler never looked at the Request.Method, we just don't 1287 // send a Content-Length header. 1288 // Further, we don't send an automatic Content-Length if they 1289 // set a Transfer-Encoding, because they're generally incompatible. 1290 if w.handlerDone.isSet() && !trailers && !hasTE && bodyAllowedForStatus(w.status) && header.get("Content-Length") == "" && (!isHEAD || len(p) > 0) { 1291 w.contentLength = int64(len(p)) 1292 setHeader.contentLength = strconv.AppendInt(cw.res.clenBuf[:0], int64(len(p)), 10) 1293 } 1294 1295 // If this was an HTTP/1.0 request with keep-alive and we sent a 1296 // Content-Length back, we can make this a keep-alive response ... 1297 if w.wants10KeepAlive && keepAlivesEnabled { 1298 sentLength := header.get("Content-Length") != "" 1299 if sentLength && header.get("Connection") == "keep-alive" { 1300 w.closeAfterReply = false 1301 } 1302 } 1303 1304 // Check for an explicit (and valid) Content-Length header. 1305 hasCL := w.contentLength != -1 1306 1307 if w.wants10KeepAlive && (isHEAD || hasCL || !bodyAllowedForStatus(w.status)) { 1308 _, connectionHeaderSet := header["Connection"] 1309 if !connectionHeaderSet { 1310 setHeader.connection = "keep-alive" 1311 } 1312 } else if !w.req.ProtoAtLeast(1, 1) || w.wantsClose { 1313 w.closeAfterReply = true 1314 } 1315 1316 if header.get("Connection") == "close" || !keepAlivesEnabled { 1317 w.closeAfterReply = true 1318 } 1319 1320 // If the client wanted a 100-continue but we never sent it to 1321 // them (or, more strictly: we never finished reading their 1322 // request body), don't reuse this connection because it's now 1323 // in an unknown state: we might be sending this response at 1324 // the same time the client is now sending its request body 1325 // after a timeout. (Some HTTP clients send Expect: 1326 // 100-continue but knowing that some servers don't support 1327 // it, the clients set a timer and send the body later anyway) 1328 // If we haven't seen EOF, we can't skip over the unread body 1329 // because we don't know if the next bytes on the wire will be 1330 // the body-following-the-timer or the subsequent request. 1331 // See Issue 11549. 1332 if ecr, ok := w.req.Body.(*expectContinueReader); ok && !ecr.sawEOF.isSet() { 1333 w.closeAfterReply = true 1334 } 1335 1336 // Per RFC 2616, we should consume the request body before 1337 // replying, if the handler hasn't already done so. But we 1338 // don't want to do an unbounded amount of reading here for 1339 // DoS reasons, so we only try up to a threshold. 1340 // TODO(bradfitz): where does RFC 2616 say that? See Issue 15527 1341 // about HTTP/1.x Handlers concurrently reading and writing, like 1342 // HTTP/2 handlers can do. Maybe this code should be relaxed? 1343 if w.req.ContentLength != 0 && !w.closeAfterReply { 1344 var discard, tooBig bool 1345 1346 switch bdy := w.req.Body.(type) { 1347 case *expectContinueReader: 1348 if bdy.resp.wroteContinue { 1349 discard = true 1350 } 1351 case *body: 1352 bdy.mu.Lock() 1353 switch { 1354 case bdy.closed: 1355 if !bdy.sawEOF { 1356 // Body was closed in handler with non-EOF error. 1357 w.closeAfterReply = true 1358 } 1359 case bdy.unreadDataSizeLocked() >= maxPostHandlerReadBytes: 1360 tooBig = true 1361 default: 1362 discard = true 1363 } 1364 bdy.mu.Unlock() 1365 default: 1366 discard = true 1367 } 1368 1369 if discard { 1370 _, err := io.CopyN(io.Discard, w.reqBody, maxPostHandlerReadBytes+1) 1371 switch err { 1372 case nil: 1373 // There must be even more data left over. 1374 tooBig = true 1375 case ErrBodyReadAfterClose: 1376 // Body was already consumed and closed. 1377 case io.EOF: 1378 // The remaining body was just consumed, close it. 1379 err = w.reqBody.Close() 1380 if err != nil { 1381 w.closeAfterReply = true 1382 } 1383 default: 1384 // Some other kind of error occurred, like a read timeout, or 1385 // corrupt chunked encoding. In any case, whatever remains 1386 // on the wire must not be parsed as another HTTP request. 1387 w.closeAfterReply = true 1388 } 1389 } 1390 1391 if tooBig { 1392 w.requestTooLarge() 1393 delHeader("Connection") 1394 setHeader.connection = "close" 1395 } 1396 } 1397 1398 code := w.status 1399 if bodyAllowedForStatus(code) { 1400 // If no content type, apply sniffing algorithm to body. 1401 _, haveType := header["Content-Type"] 1402 1403 // If the Content-Encoding was set and is non-blank, 1404 // we shouldn't sniff the body. See Issue 31753. 1405 ce := header.Get("Content-Encoding") 1406 hasCE := len(ce) > 0 1407 if !hasCE && !haveType && !hasTE && len(p) > 0 { 1408 setHeader.contentType = DetectContentType(p) 1409 } 1410 } else { 1411 for _, k := range suppressedHeaders(code) { 1412 delHeader(k) 1413 } 1414 } 1415 1416 if !header.has("Date") { 1417 setHeader.date = appendTime(cw.res.dateBuf[:0], time.Now()) 1418 } 1419 1420 if hasCL && hasTE && te != "identity" { 1421 // TODO: return an error if WriteHeader gets a return parameter 1422 // For now just ignore the Content-Length. 1423 w.conn.server.logf("http: WriteHeader called with both Transfer-Encoding of %q and a Content-Length of %d", 1424 te, w.contentLength) 1425 delHeader("Content-Length") 1426 hasCL = false 1427 } 1428 1429 if w.req.Method == "HEAD" || !bodyAllowedForStatus(code) || code == StatusNoContent { 1430 // Response has no body. 1431 delHeader("Transfer-Encoding") 1432 } else if hasCL { 1433 // Content-Length has been provided, so no chunking is to be done. 1434 delHeader("Transfer-Encoding") 1435 } else if w.req.ProtoAtLeast(1, 1) { 1436 // HTTP/1.1 or greater: Transfer-Encoding has been set to identity, and no 1437 // content-length has been provided. The connection must be closed after the 1438 // reply is written, and no chunking is to be done. This is the setup 1439 // recommended in the Server-Sent Events candidate recommendation 11, 1440 // section 8. 1441 if hasTE && te == "identity" { 1442 cw.chunking = false 1443 w.closeAfterReply = true 1444 delHeader("Transfer-Encoding") 1445 } else { 1446 // HTTP/1.1 or greater: use chunked transfer encoding 1447 // to avoid closing the connection at EOF. 1448 cw.chunking = true 1449 setHeader.transferEncoding = "chunked" 1450 if hasTE && te == "chunked" { 1451 // We will send the chunked Transfer-Encoding header later. 1452 delHeader("Transfer-Encoding") 1453 } 1454 } 1455 } else { 1456 // HTTP version < 1.1: cannot do chunked transfer 1457 // encoding and we don't know the Content-Length so 1458 // signal EOF by closing connection. 1459 w.closeAfterReply = true 1460 delHeader("Transfer-Encoding") // in case already set 1461 } 1462 1463 // Cannot use Content-Length with non-identity Transfer-Encoding. 1464 if cw.chunking { 1465 delHeader("Content-Length") 1466 } 1467 if !w.req.ProtoAtLeast(1, 0) { 1468 return 1469 } 1470 1471 // Only override the Connection header if it is not a successful 1472 // protocol switch response and if KeepAlives are not enabled. 1473 // See https://golang.org/issue/36381. 1474 delConnectionHeader := w.closeAfterReply && 1475 (!keepAlivesEnabled || !hasToken(cw.header.get("Connection"), "close")) && 1476 !isProtocolSwitchResponse(w.status, header) 1477 if delConnectionHeader { 1478 delHeader("Connection") 1479 if w.req.ProtoAtLeast(1, 1) { 1480 setHeader.connection = "close" 1481 } 1482 } 1483 1484 writeStatusLine(w.conn.bufw, w.req.ProtoAtLeast(1, 1), code, w.statusBuf[:]) 1485 cw.header.WriteSubset(w.conn.bufw, excludeHeader) 1486 setHeader.Write(w.conn.bufw) 1487 w.conn.bufw.Write(crlf) 1488 } 1489 1490 // foreachHeaderElement splits v according to the "#rule" construction 1491 // in RFC 7230 section 7 and calls fn for each non-empty element. 1492 func foreachHeaderElement(v string, fn func(string)) { 1493 v = textproto.TrimString(v) 1494 if v == "" { 1495 return 1496 } 1497 if !strings.Contains(v, ",") { 1498 fn(v) 1499 return 1500 } 1501 for _, f := range strings.Split(v, ",") { 1502 if f = textproto.TrimString(f); f != "" { 1503 fn(f) 1504 } 1505 } 1506 } 1507 1508 // writeStatusLine writes an HTTP/1.x Status-Line (RFC 7230 Section 3.1.2) 1509 // to bw. is11 is whether the HTTP request is HTTP/1.1. false means HTTP/1.0. 1510 // code is the response status code. 1511 // scratch is an optional scratch buffer. If it has at least capacity 3, it's used. 1512 func writeStatusLine(bw *bufio.Writer, is11 bool, code int, scratch []byte) { 1513 if is11 { 1514 bw.WriteString("HTTP/1.1 ") 1515 } else { 1516 bw.WriteString("HTTP/1.0 ") 1517 } 1518 if text, ok := statusText[code]; ok { 1519 bw.Write(strconv.AppendInt(scratch[:0], int64(code), 10)) 1520 bw.WriteByte(' ') 1521 bw.WriteString(text) 1522 bw.WriteString("\r\n") 1523 } else { 1524 // don't worry about performance 1525 fmt.Fprintf(bw, "%03d status code %d\r\n", code, code) 1526 } 1527 } 1528 1529 // bodyAllowed reports whether a Write is allowed for this response type. 1530 // It's illegal to call this before the header has been flushed. 1531 func (w *response) bodyAllowed() bool { 1532 if !w.wroteHeader { 1533 panic("") 1534 } 1535 return bodyAllowedForStatus(w.status) 1536 } 1537 1538 // The Life Of A Write is like this: 1539 // 1540 // Handler starts. No header has been sent. The handler can either 1541 // write a header, or just start writing. Writing before sending a header 1542 // sends an implicitly empty 200 OK header. 1543 // 1544 // If the handler didn't declare a Content-Length up front, we either 1545 // go into chunking mode or, if the handler finishes running before 1546 // the chunking buffer size, we compute a Content-Length and send that 1547 // in the header instead. 1548 // 1549 // Likewise, if the handler didn't set a Content-Type, we sniff that 1550 // from the initial chunk of output. 1551 // 1552 // The Writers are wired together like: 1553 // 1554 // 1. *response (the ResponseWriter) -> 1555 // 2. (*response).w, a *bufio.Writer of bufferBeforeChunkingSize bytes -> 1556 // 3. chunkWriter.Writer (whose writeHeader finalizes Content-Length/Type) 1557 // and which writes the chunk headers, if needed -> 1558 // 4. conn.bufw, a *bufio.Writer of default (4kB) bytes, writing to -> 1559 // 5. checkConnErrorWriter{c}, which notes any non-nil error on Write 1560 // and populates c.werr with it if so, but otherwise writes to -> 1561 // 6. the rwc, the net.Conn. 1562 // 1563 // TODO(bradfitz): short-circuit some of the buffering when the 1564 // initial header contains both a Content-Type and Content-Length. 1565 // Also short-circuit in (1) when the header's been sent and not in 1566 // chunking mode, writing directly to (4) instead, if (2) has no 1567 // buffered data. More generally, we could short-circuit from (1) to 1568 // (3) even in chunking mode if the write size from (1) is over some 1569 // threshold and nothing is in (2). The answer might be mostly making 1570 // bufferBeforeChunkingSize smaller and having bufio's fast-paths deal 1571 // with this instead. 1572 func (w *response) Write(data []byte) (n int, err error) { 1573 return w.write(len(data), data, "") 1574 } 1575 1576 func (w *response) WriteString(data string) (n int, err error) { 1577 return w.write(len(data), nil, data) 1578 } 1579 1580 // either dataB or dataS is non-zero. 1581 func (w *response) write(lenData int, dataB []byte, dataS string) (n int, err error) { 1582 if w.conn.hijacked() { 1583 if lenData > 0 { 1584 caller := relevantCaller() 1585 w.conn.server.logf("http: response.Write on hijacked connection from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line) 1586 } 1587 return 0, ErrHijacked 1588 } 1589 1590 if w.canWriteContinue.isSet() { 1591 // Body reader wants to write 100 Continue but hasn't yet. 1592 // Tell it not to. The store must be done while holding the lock 1593 // because the lock makes sure that there is not an active write 1594 // this very moment. 1595 w.writeContinueMu.Lock() 1596 w.canWriteContinue.setFalse() 1597 w.writeContinueMu.Unlock() 1598 } 1599 1600 if !w.wroteHeader { 1601 w.WriteHeader(StatusOK) 1602 } 1603 if lenData == 0 { 1604 return 0, nil 1605 } 1606 if !w.bodyAllowed() { 1607 return 0, ErrBodyNotAllowed 1608 } 1609 1610 w.written += int64(lenData) // ignoring errors, for errorKludge 1611 if w.contentLength != -1 && w.written > w.contentLength { 1612 return 0, ErrContentLength 1613 } 1614 if dataB != nil { 1615 return w.w.Write(dataB) 1616 } else { 1617 return w.w.WriteString(dataS) 1618 } 1619 } 1620 1621 func (w *response) finishRequest() { 1622 w.handlerDone.setTrue() 1623 1624 if !w.wroteHeader { 1625 w.WriteHeader(StatusOK) 1626 } 1627 1628 w.w.Flush() 1629 putBufioWriter(w.w) 1630 w.cw.close() 1631 w.conn.bufw.Flush() 1632 1633 w.conn.r.abortPendingRead() 1634 1635 // Close the body (regardless of w.closeAfterReply) so we can 1636 // re-use its bufio.Reader later safely. 1637 w.reqBody.Close() 1638 1639 if w.req.MultipartForm != nil { 1640 w.req.MultipartForm.RemoveAll() 1641 } 1642 } 1643 1644 // shouldReuseConnection reports whether the underlying TCP connection can be reused. 1645 // It must only be called after the handler is done executing. 1646 func (w *response) shouldReuseConnection() bool { 1647 if w.closeAfterReply { 1648 // The request or something set while executing the 1649 // handler indicated we shouldn't reuse this 1650 // connection. 1651 return false 1652 } 1653 1654 if w.req.Method != "HEAD" && w.contentLength != -1 && w.bodyAllowed() && w.contentLength != w.written { 1655 // Did not write enough. Avoid getting out of sync. 1656 return false 1657 } 1658 1659 // There was some error writing to the underlying connection 1660 // during the request, so don't re-use this conn. 1661 if w.conn.werr != nil { 1662 return false 1663 } 1664 1665 if w.closedRequestBodyEarly() { 1666 return false 1667 } 1668 1669 return true 1670 } 1671 1672 func (w *response) closedRequestBodyEarly() bool { 1673 body, ok := w.req.Body.(*body) 1674 return ok && body.didEarlyClose() 1675 } 1676 1677 func (w *response) Flush() { 1678 if !w.wroteHeader { 1679 w.WriteHeader(StatusOK) 1680 } 1681 w.w.Flush() 1682 w.cw.flush() 1683 } 1684 1685 func (c *conn) finalFlush() { 1686 if c.bufr != nil { 1687 // Steal the bufio.Reader (~4KB worth of memory) and its associated 1688 // reader for a future connection. 1689 putBufioReader(c.bufr) 1690 c.bufr = nil 1691 } 1692 1693 if c.bufw != nil { 1694 c.bufw.Flush() 1695 // Steal the bufio.Writer (~4KB worth of memory) and its associated 1696 // writer for a future connection. 1697 putBufioWriter(c.bufw) 1698 c.bufw = nil 1699 } 1700 } 1701 1702 // Close the connection. 1703 func (c *conn) close() { 1704 c.finalFlush() 1705 c.rwc.Close() 1706 } 1707 1708 // rstAvoidanceDelay is the amount of time we sleep after closing the 1709 // write side of a TCP connection before closing the entire socket. 1710 // By sleeping, we increase the chances that the client sees our FIN 1711 // and processes its final data before they process the subsequent RST 1712 // from closing a connection with known unread data. 1713 // This RST seems to occur mostly on BSD systems. (And Windows?) 1714 // This timeout is somewhat arbitrary (~latency around the planet). 1715 const rstAvoidanceDelay = 500 * time.Millisecond 1716 1717 type closeWriter interface { 1718 CloseWrite() error 1719 } 1720 1721 var _ closeWriter = (*net.TCPConn)(nil) 1722 1723 // closeWrite flushes any outstanding data and sends a FIN packet (if 1724 // client is connected via TCP), signalling that we're done. We then 1725 // pause for a bit, hoping the client processes it before any 1726 // subsequent RST. 1727 // 1728 // See https://golang.org/issue/3595 1729 func (c *conn) closeWriteAndWait() { 1730 c.finalFlush() 1731 if tcp, ok := c.rwc.(closeWriter); ok { 1732 tcp.CloseWrite() 1733 } 1734 time.Sleep(rstAvoidanceDelay) 1735 } 1736 1737 // validNextProto reports whether the proto is a valid ALPN protocol name. 1738 // Everything is valid except the empty string and built-in protocol types, 1739 // so that those can't be overridden with alternate implementations. 1740 func validNextProto(proto string) bool { 1741 switch proto { 1742 case "", "http/1.1", "http/1.0": 1743 return false 1744 } 1745 return true 1746 } 1747 1748 const ( 1749 runHooks = true 1750 skipHooks = false 1751 ) 1752 1753 func (c *conn) setState(nc net.Conn, state ConnState, runHook bool) { 1754 srv := c.server 1755 switch state { 1756 case StateNew: 1757 srv.trackConn(c, true) 1758 case StateHijacked, StateClosed: 1759 srv.trackConn(c, false) 1760 } 1761 if state > 0xff || state < 0 { 1762 panic("internal error") 1763 } 1764 packedState := uint64(time.Now().Unix()<<8) | uint64(state) 1765 atomic.StoreUint64(&c.curState.atomic, packedState) 1766 if !runHook { 1767 return 1768 } 1769 if hook := srv.ConnState; hook != nil { 1770 hook(nc, state) 1771 } 1772 } 1773 1774 func (c *conn) getState() (state ConnState, unixSec int64) { 1775 packedState := atomic.LoadUint64(&c.curState.atomic) 1776 return ConnState(packedState & 0xff), int64(packedState >> 8) 1777 } 1778 1779 // badRequestError is a literal string (used by in the server in HTML, 1780 // unescaped) to tell the user why their request was bad. It should 1781 // be plain text without user info or other embedded errors. 1782 func badRequestError(e string) error { return statusError{StatusBadRequest, e} } 1783 1784 // statusError is an error used to respond to a request with an HTTP status. 1785 // The text should be plain text without user info or other embedded errors. 1786 type statusError struct { 1787 code int 1788 text string 1789 } 1790 1791 func (e statusError) Error() string { return StatusText(e.code) + ": " + e.text } 1792 1793 // ErrAbortHandler is a sentinel panic value to abort a handler. 1794 // While any panic from ServeHTTP aborts the response to the client, 1795 // panicking with ErrAbortHandler also suppresses logging of a stack 1796 // trace to the server's error log. 1797 var ErrAbortHandler = errors.New("net/http: abort Handler") 1798 1799 // isCommonNetReadError reports whether err is a common error 1800 // encountered during reading a request off the network when the 1801 // client has gone away or had its read fail somehow. This is used to 1802 // determine which logs are interesting enough to log about. 1803 func isCommonNetReadError(err error) bool { 1804 if err == io.EOF { 1805 return true 1806 } 1807 if neterr, ok := err.(net.Error); ok && neterr.Timeout() { 1808 return true 1809 } 1810 if oe, ok := err.(*net.OpError); ok && oe.Op == "read" { 1811 return true 1812 } 1813 return false 1814 } 1815 1816 // Serve a new connection. 1817 func (c *conn) serve(ctx context.Context) { 1818 c.remoteAddr = c.rwc.RemoteAddr().String() 1819 ctx = context.WithValue(ctx, LocalAddrContextKey, c.rwc.LocalAddr()) 1820 var inFlightResponse *response 1821 defer func() { 1822 if err := recover(); err != nil && err != ErrAbortHandler { 1823 const size = 64 << 10 1824 buf := make([]byte, size) 1825 buf = buf[:runtime.Stack(buf, false)] 1826 c.server.logf("http: panic serving %v: %v\n%s", c.remoteAddr, err, buf) 1827 } 1828 if inFlightResponse != nil { 1829 inFlightResponse.cancelCtx() 1830 } 1831 if !c.hijacked() { 1832 if inFlightResponse != nil { 1833 inFlightResponse.conn.r.abortPendingRead() 1834 inFlightResponse.reqBody.Close() 1835 } 1836 c.close() 1837 c.setState(c.rwc, StateClosed, runHooks) 1838 } 1839 }() 1840 1841 if tlsConn, ok := c.rwc.(*tls.Conn); ok { 1842 tlsTO := c.server.tlsHandshakeTimeout() 1843 if tlsTO > 0 { 1844 dl := time.Now().Add(tlsTO) 1845 c.rwc.SetReadDeadline(dl) 1846 c.rwc.SetWriteDeadline(dl) 1847 } 1848 if err := tlsConn.HandshakeContext(ctx); err != nil { 1849 // If the handshake failed due to the client not speaking 1850 // TLS, assume they're speaking plaintext HTTP and write a 1851 // 400 response on the TLS conn's underlying net.Conn. 1852 if re, ok := err.(tls.RecordHeaderError); ok && re.Conn != nil && tlsRecordHeaderLooksLikeHTTP(re.RecordHeader) { 1853 io.WriteString(re.Conn, "HTTP/1.0 400 Bad Request\r\n\r\nClient sent an HTTP request to an HTTPS server.\n") 1854 re.Conn.Close() 1855 return 1856 } 1857 c.server.logf("http: TLS handshake error from %s: %v", c.rwc.RemoteAddr(), err) 1858 return 1859 } 1860 // Restore Conn-level deadlines. 1861 if tlsTO > 0 { 1862 c.rwc.SetReadDeadline(time.Time{}) 1863 c.rwc.SetWriteDeadline(time.Time{}) 1864 } 1865 c.tlsState = new(tls.ConnectionState) 1866 *c.tlsState = tlsConn.ConnectionState() 1867 if proto := c.tlsState.NegotiatedProtocol; validNextProto(proto) { 1868 if fn := c.server.TLSNextProto[proto]; fn != nil { 1869 h := initALPNRequest{ctx, tlsConn, serverHandler{c.server}} 1870 // Mark freshly created HTTP/2 as active and prevent any server state hooks 1871 // from being run on these connections. This prevents closeIdleConns from 1872 // closing such connections. See issue https://golang.org/issue/39776. 1873 c.setState(c.rwc, StateActive, skipHooks) 1874 fn(c.server, tlsConn, h) 1875 } 1876 return 1877 } 1878 } 1879 1880 // HTTP/1.x from here on. 1881 1882 ctx, cancelCtx := context.WithCancel(ctx) 1883 c.cancelCtx = cancelCtx 1884 defer cancelCtx() 1885 1886 c.r = &connReader{conn: c} 1887 c.bufr = newBufioReader(c.r) 1888 c.bufw = newBufioWriterSize(checkConnErrorWriter{c}, 4<<10) 1889 1890 for { 1891 w, err := c.readRequest(ctx) 1892 if c.r.remain != c.server.initialReadLimitSize() { 1893 // If we read any bytes off the wire, we're active. 1894 c.setState(c.rwc, StateActive, runHooks) 1895 } 1896 if err != nil { 1897 const errorHeaders = "\r\nContent-Type: text/plain; charset=utf-8\r\nConnection: close\r\n\r\n" 1898 1899 switch { 1900 case err == errTooLarge: 1901 // Their HTTP client may or may not be 1902 // able to read this if we're 1903 // responding to them and hanging up 1904 // while they're still writing their 1905 // request. Undefined behavior. 1906 const publicErr = "431 Request Header Fields Too Large" 1907 fmt.Fprintf(c.rwc, "HTTP/1.1 "+publicErr+errorHeaders+publicErr) 1908 c.closeWriteAndWait() 1909 return 1910 1911 case isUnsupportedTEError(err): 1912 // Respond as per RFC 7230 Section 3.3.1 which says, 1913 // A server that receives a request message with a 1914 // transfer coding it does not understand SHOULD 1915 // respond with 501 (Unimplemented). 1916 code := StatusNotImplemented 1917 1918 // We purposefully aren't echoing back the transfer-encoding's value, 1919 // so as to mitigate the risk of cross side scripting by an attacker. 1920 fmt.Fprintf(c.rwc, "HTTP/1.1 %d %s%sUnsupported transfer encoding", code, StatusText(code), errorHeaders) 1921 return 1922 1923 case isCommonNetReadError(err): 1924 return // don't reply 1925 1926 default: 1927 if v, ok := err.(statusError); ok { 1928 fmt.Fprintf(c.rwc, "HTTP/1.1 %d %s: %s%s%d %s: %s", v.code, StatusText(v.code), v.text, errorHeaders, v.code, StatusText(v.code), v.text) 1929 return 1930 } 1931 publicErr := "400 Bad Request" 1932 fmt.Fprintf(c.rwc, "HTTP/1.1 "+publicErr+errorHeaders+publicErr) 1933 return 1934 } 1935 } 1936 1937 // Expect 100 Continue support 1938 req := w.req 1939 if req.expectsContinue() { 1940 if req.ProtoAtLeast(1, 1) && req.ContentLength != 0 { 1941 // Wrap the Body reader with one that replies on the connection 1942 req.Body = &expectContinueReader{readCloser: req.Body, resp: w} 1943 w.canWriteContinue.setTrue() 1944 } 1945 } else if req.Header.get("Expect") != "" { 1946 w.sendExpectationFailed() 1947 return 1948 } 1949 1950 c.curReq.Store(w) 1951 1952 if requestBodyRemains(req.Body) { 1953 registerOnHitEOF(req.Body, w.conn.r.startBackgroundRead) 1954 } else { 1955 w.conn.r.startBackgroundRead() 1956 } 1957 1958 // HTTP cannot have multiple simultaneous active requests.[*] 1959 // Until the server replies to this request, it can't read another, 1960 // so we might as well run the handler in this goroutine. 1961 // [*] Not strictly true: HTTP pipelining. We could let them all process 1962 // in parallel even if their responses need to be serialized. 1963 // But we're not going to implement HTTP pipelining because it 1964 // was never deployed in the wild and the answer is HTTP/2. 1965 inFlightResponse = w 1966 serverHandler{c.server}.ServeHTTP(w, w.req) 1967 inFlightResponse = nil 1968 w.cancelCtx() 1969 if c.hijacked() { 1970 return 1971 } 1972 w.finishRequest() 1973 if !w.shouldReuseConnection() { 1974 if w.requestBodyLimitHit || w.closedRequestBodyEarly() { 1975 c.closeWriteAndWait() 1976 } 1977 return 1978 } 1979 c.setState(c.rwc, StateIdle, runHooks) 1980 c.curReq.Store((*response)(nil)) 1981 1982 if !w.conn.server.doKeepAlives() { 1983 // We're in shutdown mode. We might've replied 1984 // to the user without "Connection: close" and 1985 // they might think they can send another 1986 // request, but such is life with HTTP/1.1. 1987 return 1988 } 1989 1990 if d := c.server.idleTimeout(); d != 0 { 1991 c.rwc.SetReadDeadline(time.Now().Add(d)) 1992 if _, err := c.bufr.Peek(4); err != nil { 1993 return 1994 } 1995 } 1996 c.rwc.SetReadDeadline(time.Time{}) 1997 } 1998 } 1999 2000 func (w *response) sendExpectationFailed() { 2001 // TODO(bradfitz): let ServeHTTP handlers handle 2002 // requests with non-standard expectation[s]? Seems 2003 // theoretical at best, and doesn't fit into the 2004 // current ServeHTTP model anyway. We'd need to 2005 // make the ResponseWriter an optional 2006 // "ExpectReplier" interface or something. 2007 // 2008 // For now we'll just obey RFC 7231 5.1.1 which says 2009 // "A server that receives an Expect field-value other 2010 // than 100-continue MAY respond with a 417 (Expectation 2011 // Failed) status code to indicate that the unexpected 2012 // expectation cannot be met." 2013 w.Header().Set("Connection", "close") 2014 w.WriteHeader(StatusExpectationFailed) 2015 w.finishRequest() 2016 } 2017 2018 // Hijack implements the Hijacker.Hijack method. Our response is both a ResponseWriter 2019 // and a Hijacker. 2020 func (w *response) Hijack() (rwc net.Conn, buf *bufio.ReadWriter, err error) { 2021 if w.handlerDone.isSet() { 2022 panic("net/http: Hijack called after ServeHTTP finished") 2023 } 2024 if w.wroteHeader { 2025 w.cw.flush() 2026 } 2027 2028 c := w.conn 2029 c.mu.Lock() 2030 defer c.mu.Unlock() 2031 2032 // Release the bufioWriter that writes to the chunk writer, it is not 2033 // used after a connection has been hijacked. 2034 rwc, buf, err = c.hijackLocked() 2035 if err == nil { 2036 putBufioWriter(w.w) 2037 w.w = nil 2038 } 2039 return rwc, buf, err 2040 } 2041 2042 func (w *response) CloseNotify() <-chan bool { 2043 if w.handlerDone.isSet() { 2044 panic("net/http: CloseNotify called after ServeHTTP finished") 2045 } 2046 return w.closeNotifyCh 2047 } 2048 2049 func registerOnHitEOF(rc io.ReadCloser, fn func()) { 2050 switch v := rc.(type) { 2051 case *expectContinueReader: 2052 registerOnHitEOF(v.readCloser, fn) 2053 case *body: 2054 v.registerOnHitEOF(fn) 2055 default: 2056 panic("unexpected type " + fmt.Sprintf("%T", rc)) 2057 } 2058 } 2059 2060 // requestBodyRemains reports whether future calls to Read 2061 // on rc might yield more data. 2062 func requestBodyRemains(rc io.ReadCloser) bool { 2063 if rc == NoBody { 2064 return false 2065 } 2066 switch v := rc.(type) { 2067 case *expectContinueReader: 2068 return requestBodyRemains(v.readCloser) 2069 case *body: 2070 return v.bodyRemains() 2071 default: 2072 panic("unexpected type " + fmt.Sprintf("%T", rc)) 2073 } 2074 } 2075 2076 // The HandlerFunc type is an adapter to allow the use of 2077 // ordinary functions as HTTP handlers. If f is a function 2078 // with the appropriate signature, HandlerFunc(f) is a 2079 // Handler that calls f. 2080 type HandlerFunc func(ResponseWriter, *Request) 2081 2082 // ServeHTTP calls f(w, r). 2083 func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) { 2084 f(w, r) 2085 } 2086 2087 // Helper handlers 2088 2089 // Error replies to the request with the specified error message and HTTP code. 2090 // It does not otherwise end the request; the caller should ensure no further 2091 // writes are done to w. 2092 // The error message should be plain text. 2093 func Error(w ResponseWriter, error string, code int) { 2094 w.Header().Set("Content-Type", "text/plain; charset=utf-8") 2095 w.Header().Set("X-Content-Type-Options", "nosniff") 2096 w.WriteHeader(code) 2097 fmt.Fprintln(w, error) 2098 } 2099 2100 // NotFound replies to the request with an HTTP 404 not found error. 2101 func NotFound(w ResponseWriter, r *Request) { Error(w, "404 page not found", StatusNotFound) } 2102 2103 // NotFoundHandler returns a simple request handler 2104 // that replies to each request with a ``404 page not found'' reply. 2105 func NotFoundHandler() Handler { return HandlerFunc(NotFound) } 2106 2107 // StripPrefix returns a handler that serves HTTP requests by removing the 2108 // given prefix from the request URL's Path (and RawPath if set) and invoking 2109 // the handler h. StripPrefix handles a request for a path that doesn't begin 2110 // with prefix by replying with an HTTP 404 not found error. The prefix must 2111 // match exactly: if the prefix in the request contains escaped characters 2112 // the reply is also an HTTP 404 not found error. 2113 func StripPrefix(prefix string, h Handler) Handler { 2114 if prefix == "" { 2115 return h 2116 } 2117 return HandlerFunc(func(w ResponseWriter, r *Request) { 2118 p := strings.TrimPrefix(r.URL.Path, prefix) 2119 rp := strings.TrimPrefix(r.URL.RawPath, prefix) 2120 if len(p) < len(r.URL.Path) && (r.URL.RawPath == "" || len(rp) < len(r.URL.RawPath)) { 2121 r2 := new(Request) 2122 *r2 = *r 2123 r2.URL = new(url.URL) 2124 *r2.URL = *r.URL 2125 r2.URL.Path = p 2126 r2.URL.RawPath = rp 2127 h.ServeHTTP(w, r2) 2128 } else { 2129 NotFound(w, r) 2130 } 2131 }) 2132 } 2133 2134 // Redirect replies to the request with a redirect to url, 2135 // which may be a path relative to the request path. 2136 // 2137 // The provided code should be in the 3xx range and is usually 2138 // StatusMovedPermanently, StatusFound or StatusSeeOther. 2139 // 2140 // If the Content-Type header has not been set, Redirect sets it 2141 // to "text/html; charset=utf-8" and writes a small HTML body. 2142 // Setting the Content-Type header to any value, including nil, 2143 // disables that behavior. 2144 func Redirect(w ResponseWriter, r *Request, url string, code int) { 2145 if u, err := urlpkg.Parse(url); err == nil { 2146 // If url was relative, make its path absolute by 2147 // combining with request path. 2148 // The client would probably do this for us, 2149 // but doing it ourselves is more reliable. 2150 // See RFC 7231, section 7.1.2 2151 if u.Scheme == "" && u.Host == "" { 2152 oldpath := r.URL.Path 2153 if oldpath == "" { // should not happen, but avoid a crash if it does 2154 oldpath = "/" 2155 } 2156 2157 // no leading http://server 2158 if url == "" || url[0] != '/' { 2159 // make relative path absolute 2160 olddir, _ := path.Split(oldpath) 2161 url = olddir + url 2162 } 2163 2164 var query string 2165 if i := strings.Index(url, "?"); i != -1 { 2166 url, query = url[:i], url[i:] 2167 } 2168 2169 // clean up but preserve trailing slash 2170 trailing := strings.HasSuffix(url, "/") 2171 url = path.Clean(url) 2172 if trailing && !strings.HasSuffix(url, "/") { 2173 url += "/" 2174 } 2175 url += query 2176 } 2177 } 2178 2179 h := w.Header() 2180 2181 // RFC 7231 notes that a short HTML body is usually included in 2182 // the response because older user agents may not understand 301/307. 2183 // Do it only if the request didn't already have a Content-Type header. 2184 _, hadCT := h["Content-Type"] 2185 2186 h.Set("Location", hexEscapeNonASCII(url)) 2187 if !hadCT && (r.Method == "GET" || r.Method == "HEAD") { 2188 h.Set("Content-Type", "text/html; charset=utf-8") 2189 } 2190 w.WriteHeader(code) 2191 2192 // Shouldn't send the body for POST or HEAD; that leaves GET. 2193 if !hadCT && r.Method == "GET" { 2194 body := "<a href=\"" + htmlEscape(url) + "\">" + statusText[code] + "</a>.\n" 2195 fmt.Fprintln(w, body) 2196 } 2197 } 2198 2199 var htmlReplacer = strings.NewReplacer( 2200 "&", "&", 2201 "<", "<", 2202 ">", ">", 2203 // """ is shorter than """. 2204 `"`, """, 2205 // "'" is shorter than "'" and apos was not in HTML until HTML5. 2206 "'", "'", 2207 ) 2208 2209 func htmlEscape(s string) string { 2210 return htmlReplacer.Replace(s) 2211 } 2212 2213 // Redirect to a fixed URL 2214 type redirectHandler struct { 2215 url string 2216 code int 2217 } 2218 2219 func (rh *redirectHandler) ServeHTTP(w ResponseWriter, r *Request) { 2220 Redirect(w, r, rh.url, rh.code) 2221 } 2222 2223 // RedirectHandler returns a request handler that redirects 2224 // each request it receives to the given url using the given 2225 // status code. 2226 // 2227 // The provided code should be in the 3xx range and is usually 2228 // StatusMovedPermanently, StatusFound or StatusSeeOther. 2229 func RedirectHandler(url string, code int) Handler { 2230 return &redirectHandler{url, code} 2231 } 2232 2233 // ServeMux is an HTTP request multiplexer. 2234 // It matches the URL of each incoming request against a list of registered 2235 // patterns and calls the handler for the pattern that 2236 // most closely matches the URL. 2237 // 2238 // Patterns name fixed, rooted paths, like "/favicon.ico", 2239 // or rooted subtrees, like "/images/" (note the trailing slash). 2240 // Longer patterns take precedence over shorter ones, so that 2241 // if there are handlers registered for both "/images/" 2242 // and "/images/thumbnails/", the latter handler will be 2243 // called for paths beginning "/images/thumbnails/" and the 2244 // former will receive requests for any other paths in the 2245 // "/images/" subtree. 2246 // 2247 // Note that since a pattern ending in a slash names a rooted subtree, 2248 // the pattern "/" matches all paths not matched by other registered 2249 // patterns, not just the URL with Path == "/". 2250 // 2251 // If a subtree has been registered and a request is received naming the 2252 // subtree root without its trailing slash, ServeMux redirects that 2253 // request to the subtree root (adding the trailing slash). This behavior can 2254 // be overridden with a separate registration for the path without 2255 // the trailing slash. For example, registering "/images/" causes ServeMux 2256 // to redirect a request for "/images" to "/images/", unless "/images" has 2257 // been registered separately. 2258 // 2259 // Patterns may optionally begin with a host name, restricting matches to 2260 // URLs on that host only. Host-specific patterns take precedence over 2261 // general patterns, so that a handler might register for the two patterns 2262 // "/codesearch" and "codesearch.google.com/" without also taking over 2263 // requests for "http://www.google.com/". 2264 // 2265 // ServeMux also takes care of sanitizing the URL request path and the Host 2266 // header, stripping the port number and redirecting any request containing . or 2267 // .. elements or repeated slashes to an equivalent, cleaner URL. 2268 type ServeMux struct { 2269 mu sync.RWMutex 2270 m map[string]muxEntry 2271 es []muxEntry // slice of entries sorted from longest to shortest. 2272 hosts bool // whether any patterns contain hostnames 2273 } 2274 2275 type muxEntry struct { 2276 h Handler 2277 pattern string 2278 } 2279 2280 // NewServeMux allocates and returns a new ServeMux. 2281 func NewServeMux() *ServeMux { return new(ServeMux) } 2282 2283 // DefaultServeMux is the default ServeMux used by Serve. 2284 var DefaultServeMux = &defaultServeMux 2285 2286 var defaultServeMux ServeMux 2287 2288 // cleanPath returns the canonical path for p, eliminating . and .. elements. 2289 func cleanPath(p string) string { 2290 if p == "" { 2291 return "/" 2292 } 2293 if p[0] != '/' { 2294 p = "/" + p 2295 } 2296 np := path.Clean(p) 2297 // path.Clean removes trailing slash except for root; 2298 // put the trailing slash back if necessary. 2299 if p[len(p)-1] == '/' && np != "/" { 2300 // Fast path for common case of p being the string we want: 2301 if len(p) == len(np)+1 && strings.HasPrefix(p, np) { 2302 np = p 2303 } else { 2304 np += "/" 2305 } 2306 } 2307 return np 2308 } 2309 2310 // stripHostPort returns h without any trailing ":<port>". 2311 func stripHostPort(h string) string { 2312 // If no port on host, return unchanged 2313 if !strings.Contains(h, ":") { 2314 return h 2315 } 2316 host, _, err := net.SplitHostPort(h) 2317 if err != nil { 2318 return h // on error, return unchanged 2319 } 2320 return host 2321 } 2322 2323 // Find a handler on a handler map given a path string. 2324 // Most-specific (longest) pattern wins. 2325 func (mux *ServeMux) match(path string) (h Handler, pattern string) { 2326 // Check for exact match first. 2327 v, ok := mux.m[path] 2328 if ok { 2329 return v.h, v.pattern 2330 } 2331 2332 // Check for longest valid match. mux.es contains all patterns 2333 // that end in / sorted from longest to shortest. 2334 for _, e := range mux.es { 2335 if strings.HasPrefix(path, e.pattern) { 2336 return e.h, e.pattern 2337 } 2338 } 2339 return nil, "" 2340 } 2341 2342 // redirectToPathSlash determines if the given path needs appending "/" to it. 2343 // This occurs when a handler for path + "/" was already registered, but 2344 // not for path itself. If the path needs appending to, it creates a new 2345 // URL, setting the path to u.Path + "/" and returning true to indicate so. 2346 func (mux *ServeMux) redirectToPathSlash(host, path string, u *url.URL) (*url.URL, bool) { 2347 mux.mu.RLock() 2348 shouldRedirect := mux.shouldRedirectRLocked(host, path) 2349 mux.mu.RUnlock() 2350 if !shouldRedirect { 2351 return u, false 2352 } 2353 path = path + "/" 2354 u = &url.URL{Path: path, RawQuery: u.RawQuery} 2355 return u, true 2356 } 2357 2358 // shouldRedirectRLocked reports whether the given path and host should be redirected to 2359 // path+"/". This should happen if a handler is registered for path+"/" but 2360 // not path -- see comments at ServeMux. 2361 func (mux *ServeMux) shouldRedirectRLocked(host, path string) bool { 2362 p := []string{path, host + path} 2363 2364 for _, c := range p { 2365 if _, exist := mux.m[c]; exist { 2366 return false 2367 } 2368 } 2369 2370 n := len(path) 2371 if n == 0 { 2372 return false 2373 } 2374 for _, c := range p { 2375 if _, exist := mux.m[c+"/"]; exist { 2376 return path[n-1] != '/' 2377 } 2378 } 2379 2380 return false 2381 } 2382 2383 // Handler returns the handler to use for the given request, 2384 // consulting r.Method, r.Host, and r.URL.Path. It always returns 2385 // a non-nil handler. If the path is not in its canonical form, the 2386 // handler will be an internally-generated handler that redirects 2387 // to the canonical path. If the host contains a port, it is ignored 2388 // when matching handlers. 2389 // 2390 // The path and host are used unchanged for CONNECT requests. 2391 // 2392 // Handler also returns the registered pattern that matches the 2393 // request or, in the case of internally-generated redirects, 2394 // the pattern that will match after following the redirect. 2395 // 2396 // If there is no registered handler that applies to the request, 2397 // Handler returns a ``page not found'' handler and an empty pattern. 2398 func (mux *ServeMux) Handler(r *Request) (h Handler, pattern string) { 2399 2400 // CONNECT requests are not canonicalized. 2401 if r.Method == "CONNECT" { 2402 // If r.URL.Path is /tree and its handler is not registered, 2403 // the /tree -> /tree/ redirect applies to CONNECT requests 2404 // but the path canonicalization does not. 2405 if u, ok := mux.redirectToPathSlash(r.URL.Host, r.URL.Path, r.URL); ok { 2406 return RedirectHandler(u.String(), StatusMovedPermanently), u.Path 2407 } 2408 2409 return mux.handler(r.Host, r.URL.Path) 2410 } 2411 2412 // All other requests have any port stripped and path cleaned 2413 // before passing to mux.handler. 2414 host := stripHostPort(r.Host) 2415 path := cleanPath(r.URL.Path) 2416 2417 // If the given path is /tree and its handler is not registered, 2418 // redirect for /tree/. 2419 if u, ok := mux.redirectToPathSlash(host, path, r.URL); ok { 2420 return RedirectHandler(u.String(), StatusMovedPermanently), u.Path 2421 } 2422 2423 if path != r.URL.Path { 2424 _, pattern = mux.handler(host, path) 2425 u := &url.URL{Path: path, RawQuery: r.URL.RawQuery} 2426 return RedirectHandler(u.String(), StatusMovedPermanently), pattern 2427 } 2428 2429 return mux.handler(host, r.URL.Path) 2430 } 2431 2432 // handler is the main implementation of Handler. 2433 // The path is known to be in canonical form, except for CONNECT methods. 2434 func (mux *ServeMux) handler(host, path string) (h Handler, pattern string) { 2435 mux.mu.RLock() 2436 defer mux.mu.RUnlock() 2437 2438 // Host-specific pattern takes precedence over generic ones 2439 if mux.hosts { 2440 h, pattern = mux.match(host + path) 2441 } 2442 if h == nil { 2443 h, pattern = mux.match(path) 2444 } 2445 if h == nil { 2446 h, pattern = NotFoundHandler(), "" 2447 } 2448 return 2449 } 2450 2451 // ServeHTTP dispatches the request to the handler whose 2452 // pattern most closely matches the request URL. 2453 func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) { 2454 if r.RequestURI == "*" { 2455 if r.ProtoAtLeast(1, 1) { 2456 w.Header().Set("Connection", "close") 2457 } 2458 w.WriteHeader(StatusBadRequest) 2459 return 2460 } 2461 h, _ := mux.Handler(r) 2462 h.ServeHTTP(w, r) 2463 } 2464 2465 // Handle registers the handler for the given pattern. 2466 // If a handler already exists for pattern, Handle panics. 2467 func (mux *ServeMux) Handle(pattern string, handler Handler) { 2468 mux.mu.Lock() 2469 defer mux.mu.Unlock() 2470 2471 if pattern == "" { 2472 panic("http: invalid pattern") 2473 } 2474 if handler == nil { 2475 panic("http: nil handler") 2476 } 2477 if _, exist := mux.m[pattern]; exist { 2478 panic("http: multiple registrations for " + pattern) 2479 } 2480 2481 if mux.m == nil { 2482 mux.m = make(map[string]muxEntry) 2483 } 2484 e := muxEntry{h: handler, pattern: pattern} 2485 mux.m[pattern] = e 2486 if pattern[len(pattern)-1] == '/' { 2487 mux.es = appendSorted(mux.es, e) 2488 } 2489 2490 if pattern[0] != '/' { 2491 mux.hosts = true 2492 } 2493 } 2494 2495 func appendSorted(es []muxEntry, e muxEntry) []muxEntry { 2496 n := len(es) 2497 i := sort.Search(n, func(i int) bool { 2498 return len(es[i].pattern) < len(e.pattern) 2499 }) 2500 if i == n { 2501 return append(es, e) 2502 } 2503 // we now know that i points at where we want to insert 2504 es = append(es, muxEntry{}) // try to grow the slice in place, any entry works. 2505 copy(es[i+1:], es[i:]) // Move shorter entries down 2506 es[i] = e 2507 return es 2508 } 2509 2510 // HandleFunc registers the handler function for the given pattern. 2511 func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request)) { 2512 if handler == nil { 2513 panic("http: nil handler") 2514 } 2515 mux.Handle(pattern, HandlerFunc(handler)) 2516 } 2517 2518 // Handle registers the handler for the given pattern 2519 // in the DefaultServeMux. 2520 // The documentation for ServeMux explains how patterns are matched. 2521 func Handle(pattern string, handler Handler) { DefaultServeMux.Handle(pattern, handler) } 2522 2523 // HandleFunc registers the handler function for the given pattern 2524 // in the DefaultServeMux. 2525 // The documentation for ServeMux explains how patterns are matched. 2526 func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) { 2527 DefaultServeMux.HandleFunc(pattern, handler) 2528 } 2529 2530 // Serve accepts incoming HTTP connections on the listener l, 2531 // creating a new service goroutine for each. The service goroutines 2532 // read requests and then call handler to reply to them. 2533 // 2534 // The handler is typically nil, in which case the DefaultServeMux is used. 2535 // 2536 // HTTP/2 support is only enabled if the Listener returns *tls.Conn 2537 // connections and they were configured with "h2" in the TLS 2538 // Config.NextProtos. 2539 // 2540 // Serve always returns a non-nil error. 2541 func Serve(l net.Listener, handler Handler) error { 2542 srv := &Server{Handler: handler} 2543 return srv.Serve(l) 2544 } 2545 2546 // ServeTLS accepts incoming HTTPS connections on the listener l, 2547 // creating a new service goroutine for each. The service goroutines 2548 // read requests and then call handler to reply to them. 2549 // 2550 // The handler is typically nil, in which case the DefaultServeMux is used. 2551 // 2552 // Additionally, files containing a certificate and matching private key 2553 // for the server must be provided. If the certificate is signed by a 2554 // certificate authority, the certFile should be the concatenation 2555 // of the server's certificate, any intermediates, and the CA's certificate. 2556 // 2557 // ServeTLS always returns a non-nil error. 2558 func ServeTLS(l net.Listener, handler Handler, certFile, keyFile string) error { 2559 srv := &Server{Handler: handler} 2560 return srv.ServeTLS(l, certFile, keyFile) 2561 } 2562 2563 // A Server defines parameters for running an HTTP server. 2564 // The zero value for Server is a valid configuration. 2565 type Server struct { 2566 // Addr optionally specifies the TCP address for the server to listen on, 2567 // in the form "host:port". If empty, ":http" (port 80) is used. 2568 // The service names are defined in RFC 6335 and assigned by IANA. 2569 // See net.Dial for details of the address format. 2570 Addr string 2571 2572 Handler Handler // handler to invoke, http.DefaultServeMux if nil 2573 2574 // TLSConfig optionally provides a TLS configuration for use 2575 // by ServeTLS and ListenAndServeTLS. Note that this value is 2576 // cloned by ServeTLS and ListenAndServeTLS, so it's not 2577 // possible to modify the configuration with methods like 2578 // tls.Config.SetSessionTicketKeys. To use 2579 // SetSessionTicketKeys, use Server.Serve with a TLS Listener 2580 // instead. 2581 TLSConfig *tls.Config 2582 2583 // ReadTimeout is the maximum duration for reading the entire 2584 // request, including the body. A zero or negative value means 2585 // there will be no timeout. 2586 // 2587 // Because ReadTimeout does not let Handlers make per-request 2588 // decisions on each request body's acceptable deadline or 2589 // upload rate, most users will prefer to use 2590 // ReadHeaderTimeout. It is valid to use them both. 2591 ReadTimeout time.Duration 2592 2593 // ReadHeaderTimeout is the amount of time allowed to read 2594 // request headers. The connection's read deadline is reset 2595 // after reading the headers and the Handler can decide what 2596 // is considered too slow for the body. If ReadHeaderTimeout 2597 // is zero, the value of ReadTimeout is used. If both are 2598 // zero, there is no timeout. 2599 ReadHeaderTimeout time.Duration 2600 2601 // WriteTimeout is the maximum duration before timing out 2602 // writes of the response. It is reset whenever a new 2603 // request's header is read. Like ReadTimeout, it does not 2604 // let Handlers make decisions on a per-request basis. 2605 // A zero or negative value means there will be no timeout. 2606 WriteTimeout time.Duration 2607 2608 // IdleTimeout is the maximum amount of time to wait for the 2609 // next request when keep-alives are enabled. If IdleTimeout 2610 // is zero, the value of ReadTimeout is used. If both are 2611 // zero, there is no timeout. 2612 IdleTimeout time.Duration 2613 2614 // MaxHeaderBytes controls the maximum number of bytes the 2615 // server will read parsing the request header's keys and 2616 // values, including the request line. It does not limit the 2617 // size of the request body. 2618 // If zero, DefaultMaxHeaderBytes is used. 2619 MaxHeaderBytes int 2620 2621 // TLSNextProto optionally specifies a function to take over 2622 // ownership of the provided TLS connection when an ALPN 2623 // protocol upgrade has occurred. The map key is the protocol 2624 // name negotiated. The Handler argument should be used to 2625 // handle HTTP requests and will initialize the Request's TLS 2626 // and RemoteAddr if not already set. The connection is 2627 // automatically closed when the function returns. 2628 // If TLSNextProto is not nil, HTTP/2 support is not enabled 2629 // automatically. 2630 TLSNextProto map[string]func(*Server, *tls.Conn, Handler) 2631 2632 // ConnState specifies an optional callback function that is 2633 // called when a client connection changes state. See the 2634 // ConnState type and associated constants for details. 2635 ConnState func(net.Conn, ConnState) 2636 2637 // ErrorLog specifies an optional logger for errors accepting 2638 // connections, unexpected behavior from handlers, and 2639 // underlying FileSystem errors. 2640 // If nil, logging is done via the log package's standard logger. 2641 ErrorLog *log.Logger 2642 2643 // BaseContext optionally specifies a function that returns 2644 // the base context for incoming requests on this server. 2645 // The provided Listener is the specific Listener that's 2646 // about to start accepting requests. 2647 // If BaseContext is nil, the default is context.Background(). 2648 // If non-nil, it must return a non-nil context. 2649 BaseContext func(net.Listener) context.Context 2650 2651 // ConnContext optionally specifies a function that modifies 2652 // the context used for a new connection c. The provided ctx 2653 // is derived from the base context and has a ServerContextKey 2654 // value. 2655 ConnContext func(ctx context.Context, c net.Conn) context.Context 2656 2657 inShutdown atomicBool // true when server is in shutdown 2658 2659 disableKeepAlives int32 // accessed atomically. 2660 nextProtoOnce sync.Once // guards setupHTTP2_* init 2661 nextProtoErr error // result of http2.ConfigureServer if used 2662 2663 mu sync.Mutex 2664 listeners map[*net.Listener]struct{} 2665 activeConn map[*conn]struct{} 2666 doneChan chan struct{} 2667 onShutdown []func() 2668 } 2669 2670 func (s *Server) getDoneChan() <-chan struct{} { 2671 s.mu.Lock() 2672 defer s.mu.Unlock() 2673 return s.getDoneChanLocked() 2674 } 2675 2676 func (s *Server) getDoneChanLocked() chan struct{} { 2677 if s.doneChan == nil { 2678 s.doneChan = make(chan struct{}) 2679 } 2680 return s.doneChan 2681 } 2682 2683 func (s *Server) closeDoneChanLocked() { 2684 ch := s.getDoneChanLocked() 2685 select { 2686 case <-ch: 2687 // Already closed. Don't close again. 2688 default: 2689 // Safe to close here. We're the only closer, guarded 2690 // by s.mu. 2691 close(ch) 2692 } 2693 } 2694 2695 // Close immediately closes all active net.Listeners and any 2696 // connections in state StateNew, StateActive, or StateIdle. For a 2697 // graceful shutdown, use Shutdown. 2698 // 2699 // Close does not attempt to close (and does not even know about) 2700 // any hijacked connections, such as WebSockets. 2701 // 2702 // Close returns any error returned from closing the Server's 2703 // underlying Listener(s). 2704 func (srv *Server) Close() error { 2705 srv.inShutdown.setTrue() 2706 srv.mu.Lock() 2707 defer srv.mu.Unlock() 2708 srv.closeDoneChanLocked() 2709 err := srv.closeListenersLocked() 2710 for c := range srv.activeConn { 2711 c.rwc.Close() 2712 delete(srv.activeConn, c) 2713 } 2714 return err 2715 } 2716 2717 // shutdownPollIntervalMax is the max polling interval when checking 2718 // quiescence during Server.Shutdown. Polling starts with a small 2719 // interval and backs off to the max. 2720 // Ideally we could find a solution that doesn't involve polling, 2721 // but which also doesn't have a high runtime cost (and doesn't 2722 // involve any contentious mutexes), but that is left as an 2723 // exercise for the reader. 2724 const shutdownPollIntervalMax = 500 * time.Millisecond 2725 2726 // Shutdown gracefully shuts down the server without interrupting any 2727 // active connections. Shutdown works by first closing all open 2728 // listeners, then closing all idle connections, and then waiting 2729 // indefinitely for connections to return to idle and then shut down. 2730 // If the provided context expires before the shutdown is complete, 2731 // Shutdown returns the context's error, otherwise it returns any 2732 // error returned from closing the Server's underlying Listener(s). 2733 // 2734 // When Shutdown is called, Serve, ListenAndServe, and 2735 // ListenAndServeTLS immediately return ErrServerClosed. Make sure the 2736 // program doesn't exit and waits instead for Shutdown to return. 2737 // 2738 // Shutdown does not attempt to close nor wait for hijacked 2739 // connections such as WebSockets. The caller of Shutdown should 2740 // separately notify such long-lived connections of shutdown and wait 2741 // for them to close, if desired. See RegisterOnShutdown for a way to 2742 // register shutdown notification functions. 2743 // 2744 // Once Shutdown has been called on a server, it may not be reused; 2745 // future calls to methods such as Serve will return ErrServerClosed. 2746 func (srv *Server) Shutdown(ctx context.Context) error { 2747 srv.inShutdown.setTrue() 2748 2749 srv.mu.Lock() 2750 lnerr := srv.closeListenersLocked() 2751 srv.closeDoneChanLocked() 2752 for _, f := range srv.onShutdown { 2753 go f() 2754 } 2755 srv.mu.Unlock() 2756 2757 pollIntervalBase := time.Millisecond 2758 nextPollInterval := func() time.Duration { 2759 // Add 10% jitter. 2760 interval := pollIntervalBase + time.Duration(rand.Intn(int(pollIntervalBase/10))) 2761 // Double and clamp for next time. 2762 pollIntervalBase *= 2 2763 if pollIntervalBase > shutdownPollIntervalMax { 2764 pollIntervalBase = shutdownPollIntervalMax 2765 } 2766 return interval 2767 } 2768 2769 timer := time.NewTimer(nextPollInterval()) 2770 defer timer.Stop() 2771 for { 2772 if srv.closeIdleConns() && srv.numListeners() == 0 { 2773 return lnerr 2774 } 2775 select { 2776 case <-ctx.Done(): 2777 return ctx.Err() 2778 case <-timer.C: 2779 timer.Reset(nextPollInterval()) 2780 } 2781 } 2782 } 2783 2784 // RegisterOnShutdown registers a function to call on Shutdown. 2785 // This can be used to gracefully shutdown connections that have 2786 // undergone ALPN protocol upgrade or that have been hijacked. 2787 // This function should start protocol-specific graceful shutdown, 2788 // but should not wait for shutdown to complete. 2789 func (srv *Server) RegisterOnShutdown(f func()) { 2790 srv.mu.Lock() 2791 srv.onShutdown = append(srv.onShutdown, f) 2792 srv.mu.Unlock() 2793 } 2794 2795 func (s *Server) numListeners() int { 2796 s.mu.Lock() 2797 defer s.mu.Unlock() 2798 return len(s.listeners) 2799 } 2800 2801 // closeIdleConns closes all idle connections and reports whether the 2802 // server is quiescent. 2803 func (s *Server) closeIdleConns() bool { 2804 s.mu.Lock() 2805 defer s.mu.Unlock() 2806 quiescent := true 2807 for c := range s.activeConn { 2808 st, unixSec := c.getState() 2809 // Issue 22682: treat StateNew connections as if 2810 // they're idle if we haven't read the first request's 2811 // header in over 5 seconds. 2812 if st == StateNew && unixSec < time.Now().Unix()-5 { 2813 st = StateIdle 2814 } 2815 if st != StateIdle || unixSec == 0 { 2816 // Assume unixSec == 0 means it's a very new 2817 // connection, without state set yet. 2818 quiescent = false 2819 continue 2820 } 2821 c.rwc.Close() 2822 delete(s.activeConn, c) 2823 } 2824 return quiescent 2825 } 2826 2827 func (s *Server) closeListenersLocked() error { 2828 var err error 2829 for ln := range s.listeners { 2830 if cerr := (*ln).Close(); cerr != nil && err == nil { 2831 err = cerr 2832 } 2833 } 2834 return err 2835 } 2836 2837 // A ConnState represents the state of a client connection to a server. 2838 // It's used by the optional Server.ConnState hook. 2839 type ConnState int 2840 2841 const ( 2842 // StateNew represents a new connection that is expected to 2843 // send a request immediately. Connections begin at this 2844 // state and then transition to either StateActive or 2845 // StateClosed. 2846 StateNew ConnState = iota 2847 2848 // StateActive represents a connection that has read 1 or more 2849 // bytes of a request. The Server.ConnState hook for 2850 // StateActive fires before the request has entered a handler 2851 // and doesn't fire again until the request has been 2852 // handled. After the request is handled, the state 2853 // transitions to StateClosed, StateHijacked, or StateIdle. 2854 // For HTTP/2, StateActive fires on the transition from zero 2855 // to one active request, and only transitions away once all 2856 // active requests are complete. That means that ConnState 2857 // cannot be used to do per-request work; ConnState only notes 2858 // the overall state of the connection. 2859 StateActive 2860 2861 // StateIdle represents a connection that has finished 2862 // handling a request and is in the keep-alive state, waiting 2863 // for a new request. Connections transition from StateIdle 2864 // to either StateActive or StateClosed. 2865 StateIdle 2866 2867 // StateHijacked represents a hijacked connection. 2868 // This is a terminal state. It does not transition to StateClosed. 2869 StateHijacked 2870 2871 // StateClosed represents a closed connection. 2872 // This is a terminal state. Hijacked connections do not 2873 // transition to StateClosed. 2874 StateClosed 2875 ) 2876 2877 var stateName = map[ConnState]string{ 2878 StateNew: "new", 2879 StateActive: "active", 2880 StateIdle: "idle", 2881 StateHijacked: "hijacked", 2882 StateClosed: "closed", 2883 } 2884 2885 func (c ConnState) String() string { 2886 return stateName[c] 2887 } 2888 2889 // serverHandler delegates to either the server's Handler or 2890 // DefaultServeMux and also handles "OPTIONS *" requests. 2891 type serverHandler struct { 2892 srv *Server 2893 } 2894 2895 func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) { 2896 handler := sh.srv.Handler 2897 if handler == nil { 2898 handler = DefaultServeMux 2899 } 2900 if req.RequestURI == "*" && req.Method == "OPTIONS" { 2901 handler = globalOptionsHandler{} 2902 } 2903 2904 if req.URL != nil && strings.Contains(req.URL.RawQuery, ";") { 2905 var allowQuerySemicolonsInUse int32 2906 req = req.WithContext(context.WithValue(req.Context(), silenceSemWarnContextKey, func() { 2907 atomic.StoreInt32(&allowQuerySemicolonsInUse, 1) 2908 })) 2909 defer func() { 2910 if atomic.LoadInt32(&allowQuerySemicolonsInUse) == 0 { 2911 sh.srv.logf("http: URL query contains semicolon, which is no longer a supported separator; parts of the query may be stripped when parsed; see golang.org/issue/25192") 2912 } 2913 }() 2914 } 2915 2916 handler.ServeHTTP(rw, req) 2917 } 2918 2919 var silenceSemWarnContextKey = &contextKey{"silence-semicolons"} 2920 2921 // AllowQuerySemicolons returns a handler that serves requests by converting any 2922 // unescaped semicolons in the URL query to ampersands, and invoking the handler h. 2923 // 2924 // This restores the pre-Go 1.17 behavior of splitting query parameters on both 2925 // semicolons and ampersands. (See golang.org/issue/25192). Note that this 2926 // behavior doesn't match that of many proxies, and the mismatch can lead to 2927 // security issues. 2928 // 2929 // AllowQuerySemicolons should be invoked before Request.ParseForm is called. 2930 func AllowQuerySemicolons(h Handler) Handler { 2931 return HandlerFunc(func(w ResponseWriter, r *Request) { 2932 if silenceSemicolonsWarning, ok := r.Context().Value(silenceSemWarnContextKey).(func()); ok { 2933 silenceSemicolonsWarning() 2934 } 2935 if strings.Contains(r.URL.RawQuery, ";") { 2936 r2 := new(Request) 2937 *r2 = *r 2938 r2.URL = new(url.URL) 2939 *r2.URL = *r.URL 2940 r2.URL.RawQuery = strings.ReplaceAll(r.URL.RawQuery, ";", "&") 2941 h.ServeHTTP(w, r2) 2942 } else { 2943 h.ServeHTTP(w, r) 2944 } 2945 }) 2946 } 2947 2948 // ListenAndServe listens on the TCP network address srv.Addr and then 2949 // calls Serve to handle requests on incoming connections. 2950 // Accepted connections are configured to enable TCP keep-alives. 2951 // 2952 // If srv.Addr is blank, ":http" is used. 2953 // 2954 // ListenAndServe always returns a non-nil error. After Shutdown or Close, 2955 // the returned error is ErrServerClosed. 2956 func (srv *Server) ListenAndServe() error { 2957 if srv.shuttingDown() { 2958 return ErrServerClosed 2959 } 2960 addr := srv.Addr 2961 if addr == "" { 2962 addr = ":http" 2963 } 2964 ln, err := net.Listen("tcp", addr) 2965 if err != nil { 2966 return err 2967 } 2968 return srv.Serve(ln) 2969 } 2970 2971 var testHookServerServe func(*Server, net.Listener) // used if non-nil 2972 2973 // shouldDoServeHTTP2 reports whether Server.Serve should configure 2974 // automatic HTTP/2. (which sets up the srv.TLSNextProto map) 2975 func (srv *Server) shouldConfigureHTTP2ForServe() bool { 2976 if srv.TLSConfig == nil { 2977 // Compatibility with Go 1.6: 2978 // If there's no TLSConfig, it's possible that the user just 2979 // didn't set it on the http.Server, but did pass it to 2980 // tls.NewListener and passed that listener to Serve. 2981 // So we should configure HTTP/2 (to set up srv.TLSNextProto) 2982 // in case the listener returns an "h2" *tls.Conn. 2983 return true 2984 } 2985 // The user specified a TLSConfig on their http.Server. 2986 // In this, case, only configure HTTP/2 if their tls.Config 2987 // explicitly mentions "h2". Otherwise http2.ConfigureServer 2988 // would modify the tls.Config to add it, but they probably already 2989 // passed this tls.Config to tls.NewListener. And if they did, 2990 // it's too late anyway to fix it. It would only be potentially racy. 2991 // See Issue 15908. 2992 return strSliceContains(srv.TLSConfig.NextProtos, http2NextProtoTLS) 2993 } 2994 2995 // ErrServerClosed is returned by the Server's Serve, ServeTLS, ListenAndServe, 2996 // and ListenAndServeTLS methods after a call to Shutdown or Close. 2997 var ErrServerClosed = errors.New("http: Server closed") 2998 2999 // Serve accepts incoming connections on the Listener l, creating a 3000 // new service goroutine for each. The service goroutines read requests and 3001 // then call srv.Handler to reply to them. 3002 // 3003 // HTTP/2 support is only enabled if the Listener returns *tls.Conn 3004 // connections and they were configured with "h2" in the TLS 3005 // Config.NextProtos. 3006 // 3007 // Serve always returns a non-nil error and closes l. 3008 // After Shutdown or Close, the returned error is ErrServerClosed. 3009 func (srv *Server) Serve(l net.Listener) error { 3010 if fn := testHookServerServe; fn != nil { 3011 fn(srv, l) // call hook with unwrapped listener 3012 } 3013 3014 origListener := l 3015 l = &onceCloseListener{Listener: l} 3016 defer l.Close() 3017 3018 if err := srv.setupHTTP2_Serve(); err != nil { 3019 return err 3020 } 3021 3022 if !srv.trackListener(&l, true) { 3023 return ErrServerClosed 3024 } 3025 defer srv.trackListener(&l, false) 3026 3027 baseCtx := context.Background() 3028 if srv.BaseContext != nil { 3029 baseCtx = srv.BaseContext(origListener) 3030 if baseCtx == nil { 3031 panic("BaseContext returned a nil context") 3032 } 3033 } 3034 3035 var tempDelay time.Duration // how long to sleep on accept failure 3036 3037 ctx := context.WithValue(baseCtx, ServerContextKey, srv) 3038 for { 3039 rw, err := l.Accept() 3040 if err != nil { 3041 select { 3042 case <-srv.getDoneChan(): 3043 return ErrServerClosed 3044 default: 3045 } 3046 if ne, ok := err.(net.Error); ok && ne.Temporary() { 3047 if tempDelay == 0 { 3048 tempDelay = 5 * time.Millisecond 3049 } else { 3050 tempDelay *= 2 3051 } 3052 if max := 1 * time.Second; tempDelay > max { 3053 tempDelay = max 3054 } 3055 srv.logf("http: Accept error: %v; retrying in %v", err, tempDelay) 3056 time.Sleep(tempDelay) 3057 continue 3058 } 3059 return err 3060 } 3061 connCtx := ctx 3062 if cc := srv.ConnContext; cc != nil { 3063 connCtx = cc(connCtx, rw) 3064 if connCtx == nil { 3065 panic("ConnContext returned nil") 3066 } 3067 } 3068 tempDelay = 0 3069 c := srv.newConn(rw) 3070 c.setState(c.rwc, StateNew, runHooks) // before Serve can return 3071 go c.serve(connCtx) 3072 } 3073 } 3074 3075 // ServeTLS accepts incoming connections on the Listener l, creating a 3076 // new service goroutine for each. The service goroutines perform TLS 3077 // setup and then read requests, calling srv.Handler to reply to them. 3078 // 3079 // Files containing a certificate and matching private key for the 3080 // server must be provided if neither the Server's 3081 // TLSConfig.Certificates nor TLSConfig.GetCertificate are populated. 3082 // If the certificate is signed by a certificate authority, the 3083 // certFile should be the concatenation of the server's certificate, 3084 // any intermediates, and the CA's certificate. 3085 // 3086 // ServeTLS always returns a non-nil error. After Shutdown or Close, the 3087 // returned error is ErrServerClosed. 3088 func (srv *Server) ServeTLS(l net.Listener, certFile, keyFile string) error { 3089 // Setup HTTP/2 before srv.Serve, to initialize srv.TLSConfig 3090 // before we clone it and create the TLS Listener. 3091 if err := srv.setupHTTP2_ServeTLS(); err != nil { 3092 return err 3093 } 3094 3095 config := cloneTLSConfig(srv.TLSConfig) 3096 if !strSliceContains(config.NextProtos, "http/1.1") { 3097 config.NextProtos = append(config.NextProtos, "http/1.1") 3098 } 3099 3100 configHasCert := len(config.Certificates) > 0 || config.GetCertificate != nil 3101 if !configHasCert || certFile != "" || keyFile != "" { 3102 var err error 3103 config.Certificates = make([]tls.Certificate, 1) 3104 config.Certificates[0], err = tls.LoadX509KeyPair(certFile, keyFile) 3105 if err != nil { 3106 return err 3107 } 3108 } 3109 3110 tlsListener := tls.NewListener(l, config) 3111 return srv.Serve(tlsListener) 3112 } 3113 3114 // trackListener adds or removes a net.Listener to the set of tracked 3115 // listeners. 3116 // 3117 // We store a pointer to interface in the map set, in case the 3118 // net.Listener is not comparable. This is safe because we only call 3119 // trackListener via Serve and can track+defer untrack the same 3120 // pointer to local variable there. We never need to compare a 3121 // Listener from another caller. 3122 // 3123 // It reports whether the server is still up (not Shutdown or Closed). 3124 func (s *Server) trackListener(ln *net.Listener, add bool) bool { 3125 s.mu.Lock() 3126 defer s.mu.Unlock() 3127 if s.listeners == nil { 3128 s.listeners = make(map[*net.Listener]struct{}) 3129 } 3130 if add { 3131 if s.shuttingDown() { 3132 return false 3133 } 3134 s.listeners[ln] = struct{}{} 3135 } else { 3136 delete(s.listeners, ln) 3137 } 3138 return true 3139 } 3140 3141 func (s *Server) trackConn(c *conn, add bool) { 3142 s.mu.Lock() 3143 defer s.mu.Unlock() 3144 if s.activeConn == nil { 3145 s.activeConn = make(map[*conn]struct{}) 3146 } 3147 if add { 3148 s.activeConn[c] = struct{}{} 3149 } else { 3150 delete(s.activeConn, c) 3151 } 3152 } 3153 3154 func (s *Server) idleTimeout() time.Duration { 3155 if s.IdleTimeout != 0 { 3156 return s.IdleTimeout 3157 } 3158 return s.ReadTimeout 3159 } 3160 3161 func (s *Server) readHeaderTimeout() time.Duration { 3162 if s.ReadHeaderTimeout != 0 { 3163 return s.ReadHeaderTimeout 3164 } 3165 return s.ReadTimeout 3166 } 3167 3168 func (s *Server) doKeepAlives() bool { 3169 return atomic.LoadInt32(&s.disableKeepAlives) == 0 && !s.shuttingDown() 3170 } 3171 3172 func (s *Server) shuttingDown() bool { 3173 return s.inShutdown.isSet() 3174 } 3175 3176 // SetKeepAlivesEnabled controls whether HTTP keep-alives are enabled. 3177 // By default, keep-alives are always enabled. Only very 3178 // resource-constrained environments or servers in the process of 3179 // shutting down should disable them. 3180 func (srv *Server) SetKeepAlivesEnabled(v bool) { 3181 if v { 3182 atomic.StoreInt32(&srv.disableKeepAlives, 0) 3183 return 3184 } 3185 atomic.StoreInt32(&srv.disableKeepAlives, 1) 3186 3187 // Close idle HTTP/1 conns: 3188 srv.closeIdleConns() 3189 3190 // TODO: Issue 26303: close HTTP/2 conns as soon as they become idle. 3191 } 3192 3193 func (s *Server) logf(format string, args ...interface{}) { 3194 if s.ErrorLog != nil { 3195 s.ErrorLog.Printf(format, args...) 3196 } else { 3197 log.Printf(format, args...) 3198 } 3199 } 3200 3201 // logf prints to the ErrorLog of the *Server associated with request r 3202 // via ServerContextKey. If there's no associated server, or if ErrorLog 3203 // is nil, logging is done via the log package's standard logger. 3204 func logf(r *Request, format string, args ...interface{}) { 3205 s, _ := r.Context().Value(ServerContextKey).(*Server) 3206 if s != nil && s.ErrorLog != nil { 3207 s.ErrorLog.Printf(format, args...) 3208 } else { 3209 log.Printf(format, args...) 3210 } 3211 } 3212 3213 // ListenAndServe listens on the TCP network address addr and then calls 3214 // Serve with handler to handle requests on incoming connections. 3215 // Accepted connections are configured to enable TCP keep-alives. 3216 // 3217 // The handler is typically nil, in which case the DefaultServeMux is used. 3218 // 3219 // ListenAndServe always returns a non-nil error. 3220 func ListenAndServe(addr string, handler Handler) error { 3221 server := &Server{Addr: addr, Handler: handler} 3222 return server.ListenAndServe() 3223 } 3224 3225 // ListenAndServeTLS acts identically to ListenAndServe, except that it 3226 // expects HTTPS connections. Additionally, files containing a certificate and 3227 // matching private key for the server must be provided. If the certificate 3228 // is signed by a certificate authority, the certFile should be the concatenation 3229 // of the server's certificate, any intermediates, and the CA's certificate. 3230 func ListenAndServeTLS(addr, certFile, keyFile string, handler Handler) error { 3231 server := &Server{Addr: addr, Handler: handler} 3232 return server.ListenAndServeTLS(certFile, keyFile) 3233 } 3234 3235 // ListenAndServeTLS listens on the TCP network address srv.Addr and 3236 // then calls ServeTLS to handle requests on incoming TLS connections. 3237 // Accepted connections are configured to enable TCP keep-alives. 3238 // 3239 // Filenames containing a certificate and matching private key for the 3240 // server must be provided if neither the Server's TLSConfig.Certificates 3241 // nor TLSConfig.GetCertificate are populated. If the certificate is 3242 // signed by a certificate authority, the certFile should be the 3243 // concatenation of the server's certificate, any intermediates, and 3244 // the CA's certificate. 3245 // 3246 // If srv.Addr is blank, ":https" is used. 3247 // 3248 // ListenAndServeTLS always returns a non-nil error. After Shutdown or 3249 // Close, the returned error is ErrServerClosed. 3250 func (srv *Server) ListenAndServeTLS(certFile, keyFile string) error { 3251 if srv.shuttingDown() { 3252 return ErrServerClosed 3253 } 3254 addr := srv.Addr 3255 if addr == "" { 3256 addr = ":https" 3257 } 3258 3259 ln, err := net.Listen("tcp", addr) 3260 if err != nil { 3261 return err 3262 } 3263 3264 defer ln.Close() 3265 3266 return srv.ServeTLS(ln, certFile, keyFile) 3267 } 3268 3269 // setupHTTP2_ServeTLS conditionally configures HTTP/2 on 3270 // srv and reports whether there was an error setting it up. If it is 3271 // not configured for policy reasons, nil is returned. 3272 func (srv *Server) setupHTTP2_ServeTLS() error { 3273 srv.nextProtoOnce.Do(srv.onceSetNextProtoDefaults) 3274 return srv.nextProtoErr 3275 } 3276 3277 // setupHTTP2_Serve is called from (*Server).Serve and conditionally 3278 // configures HTTP/2 on srv using a more conservative policy than 3279 // setupHTTP2_ServeTLS because Serve is called after tls.Listen, 3280 // and may be called concurrently. See shouldConfigureHTTP2ForServe. 3281 // 3282 // The tests named TestTransportAutomaticHTTP2* and 3283 // TestConcurrentServerServe in server_test.go demonstrate some 3284 // of the supported use cases and motivations. 3285 func (srv *Server) setupHTTP2_Serve() error { 3286 srv.nextProtoOnce.Do(srv.onceSetNextProtoDefaults_Serve) 3287 return srv.nextProtoErr 3288 } 3289 3290 func (srv *Server) onceSetNextProtoDefaults_Serve() { 3291 if srv.shouldConfigureHTTP2ForServe() { 3292 srv.onceSetNextProtoDefaults() 3293 } 3294 } 3295 3296 // onceSetNextProtoDefaults configures HTTP/2, if the user hasn't 3297 // configured otherwise. (by setting srv.TLSNextProto non-nil) 3298 // It must only be called via srv.nextProtoOnce (use srv.setupHTTP2_*). 3299 func (srv *Server) onceSetNextProtoDefaults() { 3300 if omitBundledHTTP2 || godebug.Get("http2server") == "0" { 3301 return 3302 } 3303 // Enable HTTP/2 by default if the user hasn't otherwise 3304 // configured their TLSNextProto map. 3305 if srv.TLSNextProto == nil { 3306 conf := &http2Server{ 3307 NewWriteScheduler: func() http2WriteScheduler { return http2NewPriorityWriteScheduler(nil) }, 3308 } 3309 srv.nextProtoErr = http2ConfigureServer(srv, conf) 3310 } 3311 } 3312 3313 // TimeoutHandler returns a Handler that runs h with the given time limit. 3314 // 3315 // The new Handler calls h.ServeHTTP to handle each request, but if a 3316 // call runs for longer than its time limit, the handler responds with 3317 // a 503 Service Unavailable error and the given message in its body. 3318 // (If msg is empty, a suitable default message will be sent.) 3319 // After such a timeout, writes by h to its ResponseWriter will return 3320 // ErrHandlerTimeout. 3321 // 3322 // TimeoutHandler supports the Pusher interface but does not support 3323 // the Hijacker or Flusher interfaces. 3324 func TimeoutHandler(h Handler, dt time.Duration, msg string) Handler { 3325 return &timeoutHandler{ 3326 handler: h, 3327 body: msg, 3328 dt: dt, 3329 } 3330 } 3331 3332 // ErrHandlerTimeout is returned on ResponseWriter Write calls 3333 // in handlers which have timed out. 3334 var ErrHandlerTimeout = errors.New("http: Handler timeout") 3335 3336 type timeoutHandler struct { 3337 handler Handler 3338 body string 3339 dt time.Duration 3340 3341 // When set, no context will be created and this context will 3342 // be used instead. 3343 testContext context.Context 3344 } 3345 3346 func (h *timeoutHandler) errorBody() string { 3347 if h.body != "" { 3348 return h.body 3349 } 3350 return "<html><head><title>Timeout</title></head><body><h1>Timeout</h1></body></html>" 3351 } 3352 3353 func (h *timeoutHandler) ServeHTTP(w ResponseWriter, r *Request) { 3354 ctx := h.testContext 3355 if ctx == nil { 3356 var cancelCtx context.CancelFunc 3357 ctx, cancelCtx = context.WithTimeout(r.Context(), h.dt) 3358 defer cancelCtx() 3359 } 3360 r = r.WithContext(ctx) 3361 done := make(chan struct{}) 3362 tw := &timeoutWriter{ 3363 w: w, 3364 h: make(Header), 3365 req: r, 3366 } 3367 panicChan := make(chan interface{}, 1) 3368 go func() { 3369 defer func() { 3370 if p := recover(); p != nil { 3371 panicChan <- p 3372 } 3373 }() 3374 h.handler.ServeHTTP(tw, r) 3375 close(done) 3376 }() 3377 select { 3378 case p := <-panicChan: 3379 panic(p) 3380 case <-done: 3381 tw.mu.Lock() 3382 defer tw.mu.Unlock() 3383 dst := w.Header() 3384 for k, vv := range tw.h { 3385 dst[k] = vv 3386 } 3387 if !tw.wroteHeader { 3388 tw.code = StatusOK 3389 } 3390 w.WriteHeader(tw.code) 3391 w.Write(tw.wbuf.Bytes()) 3392 case <-ctx.Done(): 3393 tw.mu.Lock() 3394 defer tw.mu.Unlock() 3395 switch err := ctx.Err(); err { 3396 case context.DeadlineExceeded: 3397 w.WriteHeader(StatusServiceUnavailable) 3398 io.WriteString(w, h.errorBody()) 3399 tw.err = ErrHandlerTimeout 3400 default: 3401 w.WriteHeader(StatusServiceUnavailable) 3402 tw.err = err 3403 } 3404 } 3405 } 3406 3407 type timeoutWriter struct { 3408 w ResponseWriter 3409 h Header 3410 wbuf bytes.Buffer 3411 req *Request 3412 3413 mu sync.Mutex 3414 err error 3415 wroteHeader bool 3416 code int 3417 } 3418 3419 var _ Pusher = (*timeoutWriter)(nil) 3420 3421 // Push implements the Pusher interface. 3422 func (tw *timeoutWriter) Push(target string, opts *PushOptions) error { 3423 if pusher, ok := tw.w.(Pusher); ok { 3424 return pusher.Push(target, opts) 3425 } 3426 return ErrNotSupported 3427 } 3428 3429 func (tw *timeoutWriter) Header() Header { return tw.h } 3430 3431 func (tw *timeoutWriter) Write(p []byte) (int, error) { 3432 tw.mu.Lock() 3433 defer tw.mu.Unlock() 3434 if tw.err != nil { 3435 return 0, tw.err 3436 } 3437 if !tw.wroteHeader { 3438 tw.writeHeaderLocked(StatusOK) 3439 } 3440 return tw.wbuf.Write(p) 3441 } 3442 3443 func (tw *timeoutWriter) writeHeaderLocked(code int) { 3444 checkWriteHeaderCode(code) 3445 3446 switch { 3447 case tw.err != nil: 3448 return 3449 case tw.wroteHeader: 3450 if tw.req != nil { 3451 caller := relevantCaller() 3452 logf(tw.req, "http: superfluous response.WriteHeader call from %s (%s:%d)", caller.Function, path.Base(caller.File), caller.Line) 3453 } 3454 default: 3455 tw.wroteHeader = true 3456 tw.code = code 3457 } 3458 } 3459 3460 func (tw *timeoutWriter) WriteHeader(code int) { 3461 tw.mu.Lock() 3462 defer tw.mu.Unlock() 3463 tw.writeHeaderLocked(code) 3464 } 3465 3466 // onceCloseListener wraps a net.Listener, protecting it from 3467 // multiple Close calls. 3468 type onceCloseListener struct { 3469 net.Listener 3470 once sync.Once 3471 closeErr error 3472 } 3473 3474 func (oc *onceCloseListener) Close() error { 3475 oc.once.Do(oc.close) 3476 return oc.closeErr 3477 } 3478 3479 func (oc *onceCloseListener) close() { oc.closeErr = oc.Listener.Close() } 3480 3481 // globalOptionsHandler responds to "OPTIONS *" requests. 3482 type globalOptionsHandler struct{} 3483 3484 func (globalOptionsHandler) ServeHTTP(w ResponseWriter, r *Request) { 3485 w.Header().Set("Content-Length", "0") 3486 if r.ContentLength != 0 { 3487 // Read up to 4KB of OPTIONS body (as mentioned in the 3488 // spec as being reserved for future use), but anything 3489 // over that is considered a waste of server resources 3490 // (or an attack) and we abort and close the connection, 3491 // courtesy of MaxBytesReader's EOF behavior. 3492 mb := MaxBytesReader(w, r.Body, 4<<10) 3493 io.Copy(io.Discard, mb) 3494 } 3495 } 3496 3497 // initALPNRequest is an HTTP handler that initializes certain 3498 // uninitialized fields in its *Request. Such partially-initialized 3499 // Requests come from ALPN protocol handlers. 3500 type initALPNRequest struct { 3501 ctx context.Context 3502 c *tls.Conn 3503 h serverHandler 3504 } 3505 3506 // BaseContext is an exported but unadvertised http.Handler method 3507 // recognized by x/net/http2 to pass down a context; the TLSNextProto 3508 // API predates context support so we shoehorn through the only 3509 // interface we have available. 3510 func (h initALPNRequest) BaseContext() context.Context { return h.ctx } 3511 3512 func (h initALPNRequest) ServeHTTP(rw ResponseWriter, req *Request) { 3513 if req.TLS == nil { 3514 req.TLS = &tls.ConnectionState{} 3515 *req.TLS = h.c.ConnectionState() 3516 } 3517 if req.Body == nil { 3518 req.Body = NoBody 3519 } 3520 if req.RemoteAddr == "" { 3521 req.RemoteAddr = h.c.RemoteAddr().String() 3522 } 3523 h.h.ServeHTTP(rw, req) 3524 } 3525 3526 // loggingConn is used for debugging. 3527 type loggingConn struct { 3528 name string 3529 net.Conn 3530 } 3531 3532 var ( 3533 uniqNameMu sync.Mutex 3534 uniqNameNext = make(map[string]int) 3535 ) 3536 3537 func newLoggingConn(baseName string, c net.Conn) net.Conn { 3538 uniqNameMu.Lock() 3539 defer uniqNameMu.Unlock() 3540 uniqNameNext[baseName]++ 3541 return &loggingConn{ 3542 name: fmt.Sprintf("%s-%d", baseName, uniqNameNext[baseName]), 3543 Conn: c, 3544 } 3545 } 3546 3547 func (c *loggingConn) Write(p []byte) (n int, err error) { 3548 log.Printf("%s.Write(%d) = ....", c.name, len(p)) 3549 n, err = c.Conn.Write(p) 3550 log.Printf("%s.Write(%d) = %d, %v", c.name, len(p), n, err) 3551 return 3552 } 3553 3554 func (c *loggingConn) Read(p []byte) (n int, err error) { 3555 log.Printf("%s.Read(%d) = ....", c.name, len(p)) 3556 n, err = c.Conn.Read(p) 3557 log.Printf("%s.Read(%d) = %d, %v", c.name, len(p), n, err) 3558 return 3559 } 3560 3561 func (c *loggingConn) Close() (err error) { 3562 log.Printf("%s.Close() = ...", c.name) 3563 err = c.Conn.Close() 3564 log.Printf("%s.Close() = %v", c.name, err) 3565 return 3566 } 3567 3568 // checkConnErrorWriter writes to c.rwc and records any write errors to c.werr. 3569 // It only contains one field (and a pointer field at that), so it 3570 // fits in an interface value without an extra allocation. 3571 type checkConnErrorWriter struct { 3572 c *conn 3573 } 3574 3575 func (w checkConnErrorWriter) Write(p []byte) (n int, err error) { 3576 n, err = w.c.rwc.Write(p) 3577 if err != nil && w.c.werr == nil { 3578 w.c.werr = err 3579 w.c.cancelCtx() 3580 } 3581 return 3582 } 3583 3584 func numLeadingCRorLF(v []byte) (n int) { 3585 for _, b := range v { 3586 if b == '\r' || b == '\n' { 3587 n++ 3588 continue 3589 } 3590 break 3591 } 3592 return 3593 3594 } 3595 3596 func strSliceContains(ss []string, s string) bool { 3597 for _, v := range ss { 3598 if v == s { 3599 return true 3600 } 3601 } 3602 return false 3603 } 3604 3605 // tlsRecordHeaderLooksLikeHTTP reports whether a TLS record header 3606 // looks like it might've been a misdirected plaintext HTTP request. 3607 func tlsRecordHeaderLooksLikeHTTP(hdr [5]byte) bool { 3608 switch string(hdr[:]) { 3609 case "GET /", "HEAD ", "POST ", "PUT /", "OPTIO": 3610 return true 3611 } 3612 return false 3613 } 3614 3615 // MaxBytesHandler returns a Handler that runs h with its ResponseWriter and Request.Body wrapped by a MaxBytesReader. 3616 func MaxBytesHandler(h Handler, n int64) Handler { 3617 return HandlerFunc(func(w ResponseWriter, r *Request) { 3618 r2 := *r 3619 r2.Body = MaxBytesReader(w, r.Body, n) 3620 h.ServeHTTP(w, &r2) 3621 }) 3622 }