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"
38 /* include memdebug.h last */
41 #if (NGHTTP2_VERSION_NUM < 0x000300)
42 #error too old nghttp2 version, upgrade!
46 * HTTP2 handler interface. This isn't added to the general list of protocols
47 * but will be used at run-time when the protocol is dynamically switched from
50 const struct Curl_handler Curl_handler_http2 = {
52 ZERO_NULL, /* setup_connection */
53 ZERO_NULL, /* do_it */
54 ZERO_NULL , /* done */
55 ZERO_NULL, /* do_more */
56 ZERO_NULL, /* connect_it */
57 ZERO_NULL, /* connecting */
58 ZERO_NULL, /* doing */
59 ZERO_NULL, /* proto_getsock */
60 ZERO_NULL, /* doing_getsock */
61 ZERO_NULL, /* domore_getsock */
62 ZERO_NULL, /* perform_getsock */
63 ZERO_NULL, /* disconnect */
64 ZERO_NULL, /* readwrite */
65 PORT_HTTP, /* defport */
66 CURLPROTO_HTTP, /* protocol */
67 PROTOPT_NONE /* flags */
72 * Store nghttp2 version info in this buffer, Prefix with a space. Return
73 * total length written.
75 int Curl_http2_ver(char *p, size_t len)
77 nghttp2_info *h2 = nghttp2_version(0);
78 return snprintf(p, len, " nghttp2/%s", h2->version_str);
82 * The implementation of nghttp2_send_callback type. Here we write |data| with
83 * size |length| to the network and return the number of bytes actually
84 * written. See the documentation of nghttp2_send_callback for the details.
86 static ssize_t send_callback(nghttp2_session *h2,
87 const uint8_t *data, size_t length, int flags,
90 struct connectdata *conn = (struct connectdata *)userp;
91 struct http_conn *httpc = &conn->proto.httpc;
98 written = ((Curl_send*)httpc->send_underlying)(conn, FIRSTSOCKET,
101 if(rc == CURLE_AGAIN) {
102 return NGHTTP2_ERR_WOULDBLOCK;
106 failf(conn->data, "Failed sending HTTP2 data");
107 return NGHTTP2_ERR_CALLBACK_FAILURE;
111 return NGHTTP2_ERR_WOULDBLOCK;
116 static int on_frame_recv(nghttp2_session *session, const nghttp2_frame *frame,
119 struct connectdata *conn = (struct connectdata *)userp;
120 struct http_conn *c = &conn->proto.httpc;
124 infof(conn->data, "on_frame_recv() was called with header %x\n",
126 switch(frame->hd.type) {
127 case NGHTTP2_HEADERS:
128 if(frame->headers.cat != NGHTTP2_HCAT_RESPONSE)
130 c->bodystarted = TRUE;
131 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
132 c->nread_header_recvbuf = c->len < c->header_recvbuf->size_used ?
133 c->len : c->header_recvbuf->size_used;
135 memcpy(c->mem, c->header_recvbuf->buffer, c->nread_header_recvbuf);
137 c->mem += c->nread_header_recvbuf;
138 c->len -= c->nread_header_recvbuf;
140 case NGHTTP2_PUSH_PROMISE:
141 rv = nghttp2_submit_rst_stream(session, NGHTTP2_FLAG_NONE,
142 frame->hd.stream_id, NGHTTP2_CANCEL);
143 if(nghttp2_is_fatal(rv)) {
151 static int on_invalid_frame_recv(nghttp2_session *session,
152 const nghttp2_frame *frame,
153 nghttp2_error_code error_code, void *userp)
155 struct connectdata *conn = (struct connectdata *)userp;
158 infof(conn->data, "on_invalid_frame_recv() was called, error_code = %d\n",
163 static int on_data_chunk_recv(nghttp2_session *session, uint8_t flags,
165 const uint8_t *data, size_t len, void *userp)
167 struct connectdata *conn = (struct connectdata *)userp;
168 struct http_conn *c = &conn->proto.httpc;
173 infof(conn->data, "on_data_chunk_recv() "
174 "len = %u, stream = %x\n", len, stream_id);
176 if(stream_id != c->stream_id) {
180 nread = c->len < len ? c->len : len;
181 memcpy(c->mem, data, nread);
186 infof(conn->data, "%zu data written\n", nread);
189 c->data = data + nread;
190 c->datalen = len - nread;
191 return NGHTTP2_ERR_PAUSE;
196 static int before_frame_send(nghttp2_session *session,
197 const nghttp2_frame *frame,
200 struct connectdata *conn = (struct connectdata *)userp;
201 struct http_conn *c = &conn->proto.httpc;
204 infof(conn->data, "before_frame_send() was called\n");
205 if(frame->hd.type == NGHTTP2_HEADERS &&
206 frame->headers.cat == NGHTTP2_HCAT_REQUEST) {
207 /* Get stream ID of our request */
208 c->stream_id = frame->hd.stream_id;
212 static int on_frame_send(nghttp2_session *session,
213 const nghttp2_frame *frame,
216 struct connectdata *conn = (struct connectdata *)userp;
219 infof(conn->data, "on_frame_send() was called\n");
222 static int on_frame_not_send(nghttp2_session *session,
223 const nghttp2_frame *frame,
224 int lib_error_code, void *userp)
226 struct connectdata *conn = (struct connectdata *)userp;
229 infof(conn->data, "on_frame_not_send() was called, lib_error_code = %d\n",
233 static int on_stream_close(nghttp2_session *session, int32_t stream_id,
234 nghttp2_error_code error_code, void *userp)
236 struct connectdata *conn = (struct connectdata *)userp;
237 struct http_conn *c = &conn->proto.httpc;
240 infof(conn->data, "on_stream_close() was called, error_code = %d\n",
243 if(stream_id != c->stream_id) {
252 static int on_unknown_frame_recv(nghttp2_session *session,
253 const uint8_t *head, size_t headlen,
254 const uint8_t *payload, size_t payloadlen,
257 struct connectdata *conn = (struct connectdata *)userp;
263 infof(conn->data, "on_unknown_frame_recv() was called\n");
266 static int on_begin_headers(nghttp2_session *session,
267 const nghttp2_frame *frame, void *userp)
269 struct connectdata *conn = (struct connectdata *)userp;
272 infof(conn->data, "on_begin_headers() was called\n");
276 static const char STATUS[] = ":status";
278 /* frame->hd.type is either NGHTTP2_HEADERS or NGHTTP2_PUSH_PROMISE */
279 static int on_header(nghttp2_session *session, const nghttp2_frame *frame,
280 const uint8_t *name, size_t namelen,
281 const uint8_t *value, size_t valuelen,
284 struct connectdata *conn = (struct connectdata *)userp;
285 struct http_conn *c = &conn->proto.httpc;
289 if(frame->hd.stream_id != c->stream_id) {
293 if(namelen == sizeof(":status") - 1 &&
294 memcmp(STATUS, name, namelen) == 0) {
295 snprintf(c->header_recvbuf->buffer, 13, "HTTP/2.0 %s", value);
296 c->header_recvbuf->buffer[12] = '\r';
300 /* convert to a HTTP1-style header */
301 infof(conn->data, "got header\n");
302 Curl_add_buffer(c->header_recvbuf, name, namelen);
303 Curl_add_buffer(c->header_recvbuf, ":", 1);
304 Curl_add_buffer(c->header_recvbuf, value, valuelen);
305 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
308 return 0; /* 0 is successful */
312 * This is all callbacks nghttp2 calls
314 static const nghttp2_session_callbacks callbacks = {
315 send_callback, /* nghttp2_send_callback */
316 NULL, /* nghttp2_recv_callback */
317 on_frame_recv, /* nghttp2_on_frame_recv_callback */
318 on_invalid_frame_recv, /* nghttp2_on_invalid_frame_recv_callback */
319 on_data_chunk_recv, /* nghttp2_on_data_chunk_recv_callback */
320 before_frame_send, /* nghttp2_before_frame_send_callback */
321 on_frame_send, /* nghttp2_on_frame_send_callback */
322 on_frame_not_send, /* nghttp2_on_frame_not_send_callback */
323 on_stream_close, /* nghttp2_on_stream_close_callback */
324 on_unknown_frame_recv, /* nghttp2_on_unknown_frame_recv_callback */
325 on_begin_headers, /* nghttp2_on_begin_headers_callback */
326 on_header /* nghttp2_on_header_callback */
330 * The HTTP2 settings we send in the Upgrade request
332 static nghttp2_settings_entry settings[] = {
333 { NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS, 100 },
334 { NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE, NGHTTP2_INITIAL_WINDOW_SIZE },
337 #define H2_BUFSIZE 4096
340 * Initialize nghttp2 for a Curl connection
342 CURLcode Curl_http2_init(struct connectdata *conn)
344 if(!conn->proto.httpc.h2) {
346 conn->proto.httpc.inbuf = malloc(H2_BUFSIZE);
347 if(conn->proto.httpc.inbuf == NULL)
348 return CURLE_OUT_OF_MEMORY;
350 /* The nghttp2 session is not yet setup, do it */
351 rc = nghttp2_session_client_new(&conn->proto.httpc.h2,
354 failf(conn->data, "Couldn't initialize nghttp2!");
355 return CURLE_OUT_OF_MEMORY; /* most likely at least */
362 * Send a request using http2
364 CURLcode Curl_http2_send_request(struct connectdata *conn)
371 * Append headers to ask for a HTTP1.1 to HTTP2 upgrade.
373 CURLcode Curl_http2_request_upgrade(Curl_send_buffer *req,
374 struct connectdata *conn)
380 struct SingleRequest *k = &conn->data->req;
381 uint8_t *binsettings = conn->proto.httpc.binsettings;
383 Curl_http2_init(conn);
385 /* As long as we have a fixed set of settings, we don't have to dynamically
386 * figure out the base64 strings since it'll always be the same. However,
387 * the settings will likely not be fixed every time in the future.
390 /* this returns number of bytes it wrote */
391 binlen = nghttp2_pack_settings_payload(binsettings, H2_BINSETTINGS_LEN,
393 sizeof(settings)/sizeof(settings[0]));
395 failf(conn->data, "nghttp2 unexpectedly failed on pack_settings_payload");
396 return CURLE_FAILED_INIT;
398 conn->proto.httpc.binlen = binlen;
400 result = Curl_base64_encode(conn->data, (const char *)binsettings, binlen,
405 result = Curl_add_bufferf(req,
406 "Connection: Upgrade, HTTP2-Settings\r\n"
408 "HTTP2-Settings: %s\r\n",
409 NGHTTP2_PROTO_VERSION_ID, base64);
412 k->upgr101 = UPGR101_REQUESTED;
413 k->auto_decoding = GZIP;
419 * If the read would block (EWOULDBLOCK) we return -1. Otherwise we return
420 * a regular CURLcode value.
422 static ssize_t http2_recv(struct connectdata *conn, int sockindex,
423 char *mem, size_t len, CURLcode *err)
428 struct http_conn *httpc = &conn->proto.httpc;
430 (void)sockindex; /* we always do HTTP2 on sockindex 0 */
432 if(httpc->bodystarted &&
433 httpc->nread_header_recvbuf < httpc->header_recvbuf->size_used) {
435 httpc->header_recvbuf->size_used - httpc->nread_header_recvbuf;
436 size_t ncopy = len < left ? len : left;
437 memcpy(mem, httpc->header_recvbuf->buffer + httpc->nread_header_recvbuf,
439 httpc->nread_header_recvbuf += ncopy;
444 nread = len < httpc->datalen ? len : httpc->datalen;
445 memcpy(mem, httpc->data, nread);
447 httpc->data += nread;
448 httpc->datalen -= nread;
450 infof(conn->data, "%zu data written\n", nread);
451 if(httpc->datalen == 0) {
458 conn->proto.httpc.mem = mem;
459 conn->proto.httpc.len = len;
461 infof(conn->data, "http2_recv: %d bytes buffer\n",
462 conn->proto.httpc.len);
465 nread = ((Curl_recv*)httpc->recv_underlying)(conn, FIRSTSOCKET,
466 httpc->inbuf, H2_BUFSIZE, &rc);
468 if(rc == CURLE_AGAIN) {
474 failf(conn->data, "Failed receiving HTTP2 data");
479 infof(conn->data, "nread=%zd\n", nread);
480 rv = nghttp2_session_mem_recv(httpc->h2,
481 (const uint8_t *)httpc->inbuf, nread);
483 if(nghttp2_is_fatal((int)rv)) {
484 failf(conn->data, "nghttp2_session_mem_recv() returned %d:%s\n",
485 rv, nghttp2_strerror((int)rv));
486 *err = CURLE_RECV_ERROR;
489 infof(conn->data, "nghttp2_session_mem_recv() returns %zd\n", rv);
490 /* Always send pending frames in nghttp2 session, because
491 nghttp2_session_mem_recv() may queue new frame */
492 rv = nghttp2_session_send(httpc->h2);
494 *err = CURLE_SEND_ERROR;
497 if(len != httpc->len) {
498 return len - conn->proto.httpc.len;
500 /* If stream is closed, return 0 to signal the http routine to close
509 #define MAKE_NV(k, v) \
510 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, sizeof(v) - 1 }
512 #define MAKE_NV2(k, v, vlen) \
513 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, vlen }
515 /* return number of received (decrypted) bytes */
516 static ssize_t http2_send(struct connectdata *conn, int sockindex,
517 const void *mem, size_t len, CURLcode *err)
520 * BIG TODO: Currently, we send request in this function, but this
521 * function is also used to send request body. It would be nice to
522 * add dedicated function for request.
525 struct http_conn *httpc = &conn->proto.httpc;
529 char *hdbuf = (char*)mem;
533 infof(conn->data, "http2_send len=%zu\n", len);
535 /* Calculate number of headers contained in [mem, mem + len) */
536 /* Here, we assume the curl http code generate *correct* HTTP header
539 for(i = 0; i < len; ++i) {
540 if(hdbuf[i] == 0x0a) {
544 /* We counted additional 2 \n in the first and last line. We need 3
545 new headers: :method, :path and :scheme. Therefore we need one
548 nva = malloc(sizeof(nghttp2_nv) * nheader);
550 *err = CURLE_OUT_OF_MEMORY;
553 /* Extract :method, :path from request line */
554 end = strchr(hdbuf, ' ');
555 nva[0].name = (unsigned char *)":method";
556 nva[0].namelen = (uint16_t)strlen((char *)nva[0].name);
557 nva[0].value = (unsigned char *)hdbuf;
558 nva[0].valuelen = (uint16_t)(end - hdbuf);
562 end = strchr(hdbuf, ' ');
563 nva[1].name = (unsigned char *)":path";
564 nva[1].namelen = (uint16_t)strlen((char *)nva[1].name);
565 nva[1].value = (unsigned char *)hdbuf;
566 nva[1].valuelen = (uint16_t)(end - hdbuf);
568 nva[2].name = (unsigned char *)":scheme";
569 nva[2].namelen = (uint16_t)strlen((char *)nva[2].name);
570 if(conn->handler->flags & PROTOPT_SSL)
571 nva[2].value = (unsigned char *)"https";
573 nva[2].value = (unsigned char *)"http";
574 nva[2].valuelen = (uint16_t)strlen((char *)nva[2].value);
576 hdbuf = strchr(hdbuf, 0x0a);
579 for(i = 3; i < nheader; ++i) {
580 end = strchr(hdbuf, ':');
582 if(end - hdbuf == 4 && Curl_raw_nequal("host", hdbuf, 4)) {
583 nva[i].name = (unsigned char *)":authority";
584 nva[i].namelen = (uint16_t)strlen((char *)nva[i].name);
587 nva[i].name = (unsigned char *)hdbuf;
588 nva[i].namelen = (uint16_t)(end - hdbuf);
591 for(; *hdbuf == ' '; ++hdbuf);
592 end = strchr(hdbuf, 0x0d);
594 nva[i].value = (unsigned char *)hdbuf;
595 nva[i].valuelen = (uint16_t)(end - hdbuf);
600 rv = nghttp2_submit_request(httpc->h2, 0, nva, nheader, NULL, NULL);
605 *err = CURLE_SEND_ERROR;
609 rv = nghttp2_session_send(httpc->h2);
612 *err = CURLE_SEND_ERROR;
616 /* TODO: Still whole HEADERS frame may have not been sent because of
617 EAGAIN. But I don't know how to setup to call
618 nghttp2_session_send() when socket becomes writable. */
623 int Curl_http2_switched(struct connectdata *conn)
627 struct http_conn *httpc = &conn->proto.httpc;
628 /* we are switched! */
629 /* Don't know this is needed here at this moment. Original
630 handler->flags is still useful. */
631 /* conn->handler = &Curl_handler_http2; */
632 httpc->recv_underlying = (recving)conn->recv[FIRSTSOCKET];
633 httpc->send_underlying = (sending)conn->send[FIRSTSOCKET];
634 conn->recv[FIRSTSOCKET] = http2_recv;
635 conn->send[FIRSTSOCKET] = http2_send;
636 infof(conn->data, "We have switched to HTTP2\n");
637 httpc->bodystarted = FALSE;
638 httpc->closed = FALSE;
639 httpc->header_recvbuf = Curl_add_buffer_init();
640 httpc->nread_header_recvbuf = 0;
644 conn->data->req.auto_decoding = GZIP;
646 /* Put place holder for status line */
647 Curl_add_buffer(httpc->header_recvbuf, "HTTP/2.0 200\r\n", 14);
649 /* TODO: May get CURLE_AGAIN */
650 rv = (int) ((Curl_send*)httpc->send_underlying)
652 NGHTTP2_CLIENT_CONNECTION_HEADER,
653 NGHTTP2_CLIENT_CONNECTION_HEADER_LEN,
656 if(conn->data->req.upgr101 == UPGR101_RECEIVED) {
657 /* stream 1 is opened implicitly on upgrade */
658 httpc->stream_id = 1;
659 /* queue SETTINGS frame (again) */
660 rv = nghttp2_session_upgrade(httpc->h2, httpc->binsettings,
661 httpc->binlen, NULL);
663 failf(conn->data, "nghttp2_session_upgrade() failed: %s(%d)",
664 nghttp2_strerror(rv), rv);
669 /* stream ID is unknown at this point */
670 httpc->stream_id = -1;
671 rv = nghttp2_submit_settings(httpc->h2, NGHTTP2_FLAG_NONE, NULL, 0);
673 failf(conn->data, "nghttp2_submit_settings() failed: %s(%d)",
674 nghttp2_strerror(rv), rv);