1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at http://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
23 #include "curl_setup.h"
26 #define _MPRINTF_REPLACE
27 #include <curl/mprintf.h>
29 #include <nghttp2/nghttp2.h>
34 #include "curl_base64.h"
35 #include "curl_memory.h"
39 /* include memdebug.h last */
42 #if (NGHTTP2_VERSION_NUM < 0x000300)
43 #error too old nghttp2 version, upgrade!
46 static int http2_perform_getsock(const struct connectdata *conn,
47 curl_socket_t *sock, /* points to
53 const struct http_conn *httpc = &conn->proto.httpc;
54 int bitmap = GETSOCK_BLANK;
57 /* TODO We should check underlying socket state if it is SSL socket
58 because of renegotiation. */
59 sock[0] = conn->sock[FIRSTSOCKET];
61 if(nghttp2_session_want_read(httpc->h2))
62 bitmap |= GETSOCK_READSOCK(FIRSTSOCKET);
64 if(nghttp2_session_want_write(httpc->h2))
65 bitmap |= GETSOCK_WRITESOCK(FIRSTSOCKET);
70 static int http2_getsock(struct connectdata *conn,
71 curl_socket_t *sock, /* points to numsocks
75 return http2_perform_getsock(conn, sock, numsocks);
79 * HTTP2 handler interface. This isn't added to the general list of protocols
80 * but will be used at run-time when the protocol is dynamically switched from
83 const struct Curl_handler Curl_handler_http2 = {
85 ZERO_NULL, /* setup_connection */
86 ZERO_NULL, /* do_it */
87 ZERO_NULL , /* done */
88 ZERO_NULL, /* do_more */
89 ZERO_NULL, /* connect_it */
90 ZERO_NULL, /* connecting */
91 ZERO_NULL, /* doing */
92 http2_getsock, /* proto_getsock */
93 http2_getsock, /* doing_getsock */
94 ZERO_NULL, /* domore_getsock */
95 http2_perform_getsock, /* perform_getsock */
96 ZERO_NULL, /* disconnect */
97 ZERO_NULL, /* readwrite */
98 PORT_HTTP, /* defport */
99 CURLPROTO_HTTP, /* protocol */
100 PROTOPT_NONE /* flags */
103 const struct Curl_handler Curl_handler_http2_ssl = {
104 "HTTP2", /* scheme */
105 ZERO_NULL, /* setup_connection */
106 ZERO_NULL, /* do_it */
107 ZERO_NULL , /* done */
108 ZERO_NULL, /* do_more */
109 ZERO_NULL, /* connect_it */
110 ZERO_NULL, /* connecting */
111 ZERO_NULL, /* doing */
112 http2_getsock, /* proto_getsock */
113 http2_getsock, /* doing_getsock */
114 ZERO_NULL, /* domore_getsock */
115 http2_perform_getsock, /* perform_getsock */
116 ZERO_NULL, /* disconnect */
117 ZERO_NULL, /* readwrite */
118 PORT_HTTP, /* defport */
119 CURLPROTO_HTTP | CURLPROTO_HTTPS, /* protocol */
120 PROTOPT_SSL /* flags */
124 * Store nghttp2 version info in this buffer, Prefix with a space. Return
125 * total length written.
127 int Curl_http2_ver(char *p, size_t len)
129 nghttp2_info *h2 = nghttp2_version(0);
130 return snprintf(p, len, " nghttp2/%s", h2->version_str);
134 * The implementation of nghttp2_send_callback type. Here we write |data| with
135 * size |length| to the network and return the number of bytes actually
136 * written. See the documentation of nghttp2_send_callback for the details.
138 static ssize_t send_callback(nghttp2_session *h2,
139 const uint8_t *data, size_t length, int flags,
142 struct connectdata *conn = (struct connectdata *)userp;
143 struct http_conn *httpc = &conn->proto.httpc;
150 written = ((Curl_send*)httpc->send_underlying)(conn, FIRSTSOCKET,
153 if(rc == CURLE_AGAIN) {
154 return NGHTTP2_ERR_WOULDBLOCK;
158 failf(conn->data, "Failed sending HTTP2 data");
159 return NGHTTP2_ERR_CALLBACK_FAILURE;
163 return NGHTTP2_ERR_WOULDBLOCK;
168 static int on_frame_recv(nghttp2_session *session, const nghttp2_frame *frame,
171 struct connectdata *conn = (struct connectdata *)userp;
172 struct http_conn *c = &conn->proto.httpc;
176 infof(conn->data, "on_frame_recv() was called with header %x\n",
178 switch(frame->hd.type) {
179 case NGHTTP2_HEADERS:
180 if(frame->headers.cat != NGHTTP2_HCAT_RESPONSE)
182 c->bodystarted = TRUE;
183 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
184 c->nread_header_recvbuf = c->len < c->header_recvbuf->size_used ?
185 c->len : c->header_recvbuf->size_used;
187 memcpy(c->mem, c->header_recvbuf->buffer, c->nread_header_recvbuf);
189 c->mem += c->nread_header_recvbuf;
190 c->len -= c->nread_header_recvbuf;
192 case NGHTTP2_PUSH_PROMISE:
193 rv = nghttp2_submit_rst_stream(session, NGHTTP2_FLAG_NONE,
194 frame->hd.stream_id, NGHTTP2_CANCEL);
195 if(nghttp2_is_fatal(rv)) {
203 static int on_invalid_frame_recv(nghttp2_session *session,
204 const nghttp2_frame *frame,
205 nghttp2_error_code error_code, void *userp)
207 struct connectdata *conn = (struct connectdata *)userp;
210 infof(conn->data, "on_invalid_frame_recv() was called, error_code = %d\n",
215 static int on_data_chunk_recv(nghttp2_session *session, uint8_t flags,
217 const uint8_t *data, size_t len, void *userp)
219 struct connectdata *conn = (struct connectdata *)userp;
220 struct http_conn *c = &conn->proto.httpc;
225 infof(conn->data, "on_data_chunk_recv() "
226 "len = %u, stream = %x\n", len, stream_id);
228 if(stream_id != c->stream_id) {
232 nread = c->len < len ? c->len : len;
233 memcpy(c->mem, data, nread);
238 infof(conn->data, "%zu data written\n", nread);
241 c->data = data + nread;
242 c->datalen = len - nread;
243 return NGHTTP2_ERR_PAUSE;
248 static int before_frame_send(nghttp2_session *session,
249 const nghttp2_frame *frame,
252 struct connectdata *conn = (struct connectdata *)userp;
253 struct http_conn *c = &conn->proto.httpc;
256 infof(conn->data, "before_frame_send() was called\n");
257 if(frame->hd.type == NGHTTP2_HEADERS &&
258 frame->headers.cat == NGHTTP2_HCAT_REQUEST) {
259 /* Get stream ID of our request */
260 c->stream_id = frame->hd.stream_id;
264 static int on_frame_send(nghttp2_session *session,
265 const nghttp2_frame *frame,
268 struct connectdata *conn = (struct connectdata *)userp;
271 infof(conn->data, "on_frame_send() was called\n");
274 static int on_frame_not_send(nghttp2_session *session,
275 const nghttp2_frame *frame,
276 int lib_error_code, void *userp)
278 struct connectdata *conn = (struct connectdata *)userp;
281 infof(conn->data, "on_frame_not_send() was called, lib_error_code = %d\n",
285 static int on_stream_close(nghttp2_session *session, int32_t stream_id,
286 nghttp2_error_code error_code, void *userp)
288 struct connectdata *conn = (struct connectdata *)userp;
289 struct http_conn *c = &conn->proto.httpc;
292 infof(conn->data, "on_stream_close() was called, error_code = %d\n",
295 if(stream_id != c->stream_id) {
304 static int on_unknown_frame_recv(nghttp2_session *session,
305 const uint8_t *head, size_t headlen,
306 const uint8_t *payload, size_t payloadlen,
309 struct connectdata *conn = (struct connectdata *)userp;
315 infof(conn->data, "on_unknown_frame_recv() was called\n");
318 static int on_begin_headers(nghttp2_session *session,
319 const nghttp2_frame *frame, void *userp)
321 struct connectdata *conn = (struct connectdata *)userp;
324 infof(conn->data, "on_begin_headers() was called\n");
328 static const char STATUS[] = ":status";
330 /* frame->hd.type is either NGHTTP2_HEADERS or NGHTTP2_PUSH_PROMISE */
331 static int on_header(nghttp2_session *session, const nghttp2_frame *frame,
332 const uint8_t *name, size_t namelen,
333 const uint8_t *value, size_t valuelen,
336 struct connectdata *conn = (struct connectdata *)userp;
337 struct http_conn *c = &conn->proto.httpc;
341 if(frame->hd.stream_id != c->stream_id) {
345 if(namelen == sizeof(":status") - 1 &&
346 memcmp(STATUS, name, namelen) == 0) {
347 snprintf(c->header_recvbuf->buffer, 13, "HTTP/2.0 %s", value);
348 c->header_recvbuf->buffer[12] = '\r';
352 /* convert to a HTTP1-style header */
353 infof(conn->data, "got header\n");
354 Curl_add_buffer(c->header_recvbuf, name, namelen);
355 Curl_add_buffer(c->header_recvbuf, ":", 1);
356 Curl_add_buffer(c->header_recvbuf, value, valuelen);
357 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
360 return 0; /* 0 is successful */
364 * This is all callbacks nghttp2 calls
366 static const nghttp2_session_callbacks callbacks = {
367 send_callback, /* nghttp2_send_callback */
368 NULL, /* nghttp2_recv_callback */
369 on_frame_recv, /* nghttp2_on_frame_recv_callback */
370 on_invalid_frame_recv, /* nghttp2_on_invalid_frame_recv_callback */
371 on_data_chunk_recv, /* nghttp2_on_data_chunk_recv_callback */
372 before_frame_send, /* nghttp2_before_frame_send_callback */
373 on_frame_send, /* nghttp2_on_frame_send_callback */
374 on_frame_not_send, /* nghttp2_on_frame_not_send_callback */
375 on_stream_close, /* nghttp2_on_stream_close_callback */
376 on_unknown_frame_recv, /* nghttp2_on_unknown_frame_recv_callback */
377 on_begin_headers, /* nghttp2_on_begin_headers_callback */
378 on_header /* nghttp2_on_header_callback */
381 static ssize_t data_source_read_callback(nghttp2_session *session,
383 uint8_t *buf, size_t length,
385 nghttp2_data_source *source,
388 struct connectdata *conn = (struct connectdata *)userp;
389 struct http_conn *c = &conn->proto.httpc;
396 nread = c->upload_len < length ? c->upload_len : length;
398 memcpy(buf, c->upload_mem, nread);
399 c->upload_mem += nread;
400 c->upload_len -= nread;
401 c->upload_left -= nread;
404 if(c->upload_left == 0)
407 return NGHTTP2_ERR_DEFERRED;
413 * The HTTP2 settings we send in the Upgrade request
415 static nghttp2_settings_entry settings[] = {
416 { NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS, 100 },
417 { NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE, NGHTTP2_INITIAL_WINDOW_SIZE },
420 #define H2_BUFSIZE 4096
423 * Initialize nghttp2 for a Curl connection
425 CURLcode Curl_http2_init(struct connectdata *conn)
427 if(!conn->proto.httpc.h2) {
429 conn->proto.httpc.inbuf = malloc(H2_BUFSIZE);
430 if(conn->proto.httpc.inbuf == NULL)
431 return CURLE_OUT_OF_MEMORY;
433 /* The nghttp2 session is not yet setup, do it */
434 rc = nghttp2_session_client_new(&conn->proto.httpc.h2,
437 failf(conn->data, "Couldn't initialize nghttp2!");
438 return CURLE_OUT_OF_MEMORY; /* most likely at least */
445 * Send a request using http2
447 CURLcode Curl_http2_send_request(struct connectdata *conn)
454 * Append headers to ask for a HTTP1.1 to HTTP2 upgrade.
456 CURLcode Curl_http2_request_upgrade(Curl_send_buffer *req,
457 struct connectdata *conn)
463 struct SingleRequest *k = &conn->data->req;
464 uint8_t *binsettings = conn->proto.httpc.binsettings;
466 Curl_http2_init(conn);
468 /* As long as we have a fixed set of settings, we don't have to dynamically
469 * figure out the base64 strings since it'll always be the same. However,
470 * the settings will likely not be fixed every time in the future.
473 /* this returns number of bytes it wrote */
474 binlen = nghttp2_pack_settings_payload(binsettings, H2_BINSETTINGS_LEN,
476 sizeof(settings)/sizeof(settings[0]));
478 failf(conn->data, "nghttp2 unexpectedly failed on pack_settings_payload");
479 return CURLE_FAILED_INIT;
481 conn->proto.httpc.binlen = binlen;
483 result = Curl_base64_encode(conn->data, (const char *)binsettings, binlen,
488 result = Curl_add_bufferf(req,
489 "Connection: Upgrade, HTTP2-Settings\r\n"
491 "HTTP2-Settings: %s\r\n",
492 NGHTTP2_PROTO_VERSION_ID, base64);
495 k->upgr101 = UPGR101_REQUESTED;
501 * If the read would block (EWOULDBLOCK) we return -1. Otherwise we return
502 * a regular CURLcode value.
504 static ssize_t http2_recv(struct connectdata *conn, int sockindex,
505 char *mem, size_t len, CURLcode *err)
510 struct http_conn *httpc = &conn->proto.httpc;
512 (void)sockindex; /* we always do HTTP2 on sockindex 0 */
514 /* Nullify here because we call nghttp2_session_send() and they
515 might refer to the old buffer. */
516 httpc->upload_mem = NULL;
517 httpc->upload_len = 0;
519 if(httpc->bodystarted &&
520 httpc->nread_header_recvbuf < httpc->header_recvbuf->size_used) {
522 httpc->header_recvbuf->size_used - httpc->nread_header_recvbuf;
523 size_t ncopy = len < left ? len : left;
524 memcpy(mem, httpc->header_recvbuf->buffer + httpc->nread_header_recvbuf,
526 httpc->nread_header_recvbuf += ncopy;
531 nread = len < httpc->datalen ? len : httpc->datalen;
532 memcpy(mem, httpc->data, nread);
534 httpc->data += nread;
535 httpc->datalen -= nread;
537 infof(conn->data, "%zu data written\n", nread);
538 if(httpc->datalen == 0) {
545 conn->proto.httpc.mem = mem;
546 conn->proto.httpc.len = len;
548 infof(conn->data, "http2_recv: %d bytes buffer\n",
549 conn->proto.httpc.len);
552 nread = ((Curl_recv*)httpc->recv_underlying)(conn, FIRSTSOCKET,
553 httpc->inbuf, H2_BUFSIZE, &rc);
555 if(rc == CURLE_AGAIN) {
561 failf(conn->data, "Failed receiving HTTP2 data");
566 infof(conn->data, "nread=%zd\n", nread);
567 rv = nghttp2_session_mem_recv(httpc->h2,
568 (const uint8_t *)httpc->inbuf, nread);
570 if(nghttp2_is_fatal((int)rv)) {
571 failf(conn->data, "nghttp2_session_mem_recv() returned %d:%s\n",
572 rv, nghttp2_strerror((int)rv));
573 *err = CURLE_RECV_ERROR;
576 infof(conn->data, "nghttp2_session_mem_recv() returns %zd\n", rv);
577 /* Always send pending frames in nghttp2 session, because
578 nghttp2_session_mem_recv() may queue new frame */
579 rv = nghttp2_session_send(httpc->h2);
581 *err = CURLE_SEND_ERROR;
584 if(len != httpc->len) {
585 return len - conn->proto.httpc.len;
587 /* If stream is closed, return 0 to signal the http routine to close
596 #define MAKE_NV(k, v) \
597 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, sizeof(v) - 1 }
599 #define MAKE_NV2(k, v, vlen) \
600 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, vlen }
602 /* return number of received (decrypted) bytes */
603 static ssize_t http2_send(struct connectdata *conn, int sockindex,
604 const void *mem, size_t len, CURLcode *err)
607 * BIG TODO: Currently, we send request in this function, but this
608 * function is also used to send request body. It would be nice to
609 * add dedicated function for request.
612 struct http_conn *httpc = &conn->proto.httpc;
616 char *hdbuf = (char*)mem;
618 nghttp2_data_provider data_prd;
621 infof(conn->data, "http2_send len=%zu\n", len);
623 if(httpc->stream_id != -1) {
624 /* If stream_id != -1, we have dispatched request HEADERS, and now
625 are going to send or sending request body in DATA frame */
626 httpc->upload_mem = mem;
627 httpc->upload_len = len;
628 nghttp2_session_resume_data(httpc->h2, httpc->stream_id);
629 rv = nghttp2_session_send(httpc->h2);
630 if(nghttp2_is_fatal(rv)) {
631 *err = CURLE_SEND_ERROR;
634 return len - httpc->upload_len;
637 /* Calculate number of headers contained in [mem, mem + len) */
638 /* Here, we assume the curl http code generate *correct* HTTP header
641 for(i = 0; i < len; ++i) {
642 if(hdbuf[i] == 0x0a) {
646 /* We counted additional 2 \n in the first and last line. We need 3
647 new headers: :method, :path and :scheme. Therefore we need one
650 nva = malloc(sizeof(nghttp2_nv) * nheader);
652 *err = CURLE_OUT_OF_MEMORY;
655 /* Extract :method, :path from request line */
656 end = strchr(hdbuf, ' ');
657 nva[0].name = (unsigned char *)":method";
658 nva[0].namelen = (uint16_t)strlen((char *)nva[0].name);
659 nva[0].value = (unsigned char *)hdbuf;
660 nva[0].valuelen = (uint16_t)(end - hdbuf);
664 end = strchr(hdbuf, ' ');
665 nva[1].name = (unsigned char *)":path";
666 nva[1].namelen = (uint16_t)strlen((char *)nva[1].name);
667 nva[1].value = (unsigned char *)hdbuf;
668 nva[1].valuelen = (uint16_t)(end - hdbuf);
670 nva[2].name = (unsigned char *)":scheme";
671 nva[2].namelen = (uint16_t)strlen((char *)nva[2].name);
672 if(conn->handler->flags & PROTOPT_SSL)
673 nva[2].value = (unsigned char *)"https";
675 nva[2].value = (unsigned char *)"http";
676 nva[2].valuelen = (uint16_t)strlen((char *)nva[2].value);
678 hdbuf = strchr(hdbuf, 0x0a);
681 for(i = 3; i < nheader; ++i) {
682 end = strchr(hdbuf, ':');
684 if(end - hdbuf == 4 && Curl_raw_nequal("host", hdbuf, 4)) {
685 nva[i].name = (unsigned char *)":authority";
686 nva[i].namelen = (uint16_t)strlen((char *)nva[i].name);
689 nva[i].name = (unsigned char *)hdbuf;
690 nva[i].namelen = (uint16_t)(end - hdbuf);
693 for(; *hdbuf == ' '; ++hdbuf);
694 end = strchr(hdbuf, 0x0d);
696 nva[i].value = (unsigned char *)hdbuf;
697 nva[i].valuelen = (uint16_t)(end - hdbuf);
700 /* Inspect Content-Length header field and retrieve the request
701 entity length so that we can set END_STREAM to the last DATA
703 if(nva[i].namelen == 14 &&
704 Curl_raw_nequal("content-length", (char*)nva[i].name, 14)) {
706 for(j = 0; j < nva[i].valuelen; ++j) {
707 httpc->upload_left *= 10;
708 httpc->upload_left += nva[i].value[j] - '0';
710 infof(conn->data, "request content-length=%zu\n", httpc->upload_left);
714 switch(conn->data->set.httpreq) {
716 case HTTPREQ_POST_FORM:
718 data_prd.read_callback = data_source_read_callback;
719 data_prd.source.ptr = NULL;
720 rv = nghttp2_submit_request(httpc->h2, 0, nva, nheader, &data_prd, NULL);
723 rv = nghttp2_submit_request(httpc->h2, 0, nva, nheader, NULL, NULL);
729 *err = CURLE_SEND_ERROR;
733 rv = nghttp2_session_send(httpc->h2);
736 *err = CURLE_SEND_ERROR;
740 if(httpc->stream_id != -1) {
741 /* If whole HEADERS frame was sent off to the underlying socket,
742 the nghttp2 library calls data_source_read_callback. But only
743 it found that no data available, so it deferred the DATA
744 transmission. Which means that nghttp2_session_want_write()
745 returns 0 on http2_perform_getsock(), which results that no
746 writable socket check is performed. To workaround this, we
747 issue nghttp2_session_resume_data() here to bring back DATA
748 transmission from deferred state. */
749 nghttp2_session_resume_data(httpc->h2, httpc->stream_id);
755 int Curl_http2_switched(struct connectdata *conn)
759 struct http_conn *httpc = &conn->proto.httpc;
760 /* we are switched! */
761 /* Don't know this is needed here at this moment. Original
762 handler->flags is still useful. */
763 if(conn->handler->flags & PROTOPT_SSL)
764 conn->handler = &Curl_handler_http2_ssl;
766 conn->handler = &Curl_handler_http2;
768 httpc->recv_underlying = (recving)conn->recv[FIRSTSOCKET];
769 httpc->send_underlying = (sending)conn->send[FIRSTSOCKET];
770 conn->recv[FIRSTSOCKET] = http2_recv;
771 conn->send[FIRSTSOCKET] = http2_send;
772 infof(conn->data, "We have switched to HTTP2\n");
773 httpc->bodystarted = FALSE;
774 httpc->closed = FALSE;
775 httpc->header_recvbuf = Curl_add_buffer_init();
776 httpc->nread_header_recvbuf = 0;
779 httpc->upload_left = 0;
780 httpc->upload_mem = NULL;
781 httpc->upload_len = 0;
783 conn->httpversion = 20;
785 /* Put place holder for status line */
786 Curl_add_buffer(httpc->header_recvbuf, "HTTP/2.0 200\r\n", 14);
788 /* TODO: May get CURLE_AGAIN */
789 rv = (int) ((Curl_send*)httpc->send_underlying)
791 NGHTTP2_CLIENT_CONNECTION_HEADER,
792 NGHTTP2_CLIENT_CONNECTION_HEADER_LEN,
795 if(conn->data->req.upgr101 == UPGR101_RECEIVED) {
796 /* stream 1 is opened implicitly on upgrade */
797 httpc->stream_id = 1;
798 /* queue SETTINGS frame (again) */
799 rv = nghttp2_session_upgrade(httpc->h2, httpc->binsettings,
800 httpc->binlen, NULL);
802 failf(conn->data, "nghttp2_session_upgrade() failed: %s(%d)",
803 nghttp2_strerror(rv), rv);
808 /* stream ID is unknown at this point */
809 httpc->stream_id = -1;
810 rv = nghttp2_submit_settings(httpc->h2, NGHTTP2_FLAG_NONE, NULL, 0);
812 failf(conn->data, "nghttp2_submit_settings() failed: %s(%d)",
813 nghttp2_strerror(rv), rv);