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;
123 infof(conn->data, "on_frame_recv() was called with header %x\n",
125 if(frame->hd.type == NGHTTP2_HEADERS &&
126 frame->headers.cat == NGHTTP2_HCAT_RESPONSE) {
127 c->bodystarted = TRUE;
128 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
129 c->nread_header_recvbuf = c->len < c->header_recvbuf->size_used ?
130 c->len : c->header_recvbuf->size_used;
132 memcpy(c->mem, c->header_recvbuf->buffer, c->nread_header_recvbuf);
134 c->mem += c->nread_header_recvbuf;
135 c->len -= c->nread_header_recvbuf;
137 if((frame->hd.type == NGHTTP2_HEADERS || frame->hd.type == NGHTTP2_DATA) &&
138 frame->hd.flags & NGHTTP2_FLAG_END_STREAM) {
139 infof(conn->data, "stream_id=%d closed\n", frame->hd.stream_id);
144 static int on_invalid_frame_recv(nghttp2_session *session,
145 const nghttp2_frame *frame,
146 nghttp2_error_code error_code, void *userp)
148 struct connectdata *conn = (struct connectdata *)userp;
151 infof(conn->data, "on_invalid_frame_recv() was called, error_code = %d\n",
156 static int on_data_chunk_recv(nghttp2_session *session, uint8_t flags,
158 const uint8_t *data, size_t len, void *userp)
160 struct connectdata *conn = (struct connectdata *)userp;
161 struct http_conn *c = &conn->proto.httpc;
165 infof(conn->data, "on_data_chunk_recv() "
166 "len = %u, stream = %x\n", len, stream_id);
169 memcpy(c->mem, data, len);
174 infof(conn->data, "EEEEEEK: %d > %d\n", len, c->len);
175 /* return NGHTTP2_ERR_PAUSE; */
181 static int before_frame_send(nghttp2_session *session,
182 const nghttp2_frame *frame,
185 struct connectdata *conn = (struct connectdata *)userp;
188 infof(conn->data, "before_frame_send() was called\n");
191 static int on_frame_send(nghttp2_session *session,
192 const nghttp2_frame *frame,
195 struct connectdata *conn = (struct connectdata *)userp;
198 infof(conn->data, "on_frame_send() was called\n");
201 static int on_frame_not_send(nghttp2_session *session,
202 const nghttp2_frame *frame,
203 int lib_error_code, void *userp)
205 struct connectdata *conn = (struct connectdata *)userp;
208 infof(conn->data, "on_frame_not_send() was called, lib_error_code = %d\n",
212 static int on_stream_close(nghttp2_session *session, int32_t stream_id,
213 nghttp2_error_code error_code, void *userp)
215 struct connectdata *conn = (struct connectdata *)userp;
216 struct http_conn *c = &conn->proto.httpc;
219 infof(conn->data, "on_stream_close() was called, error_code = %d\n",
227 static int on_unknown_frame_recv(nghttp2_session *session,
228 const uint8_t *head, size_t headlen,
229 const uint8_t *payload, size_t payloadlen,
232 struct connectdata *conn = (struct connectdata *)userp;
238 infof(conn->data, "on_unknown_frame_recv() was called\n");
241 static int on_begin_headers(nghttp2_session *session,
242 const nghttp2_frame *frame, void *userp)
244 struct connectdata *conn = (struct connectdata *)userp;
247 infof(conn->data, "on_begin_headers() was called\n");
251 static const char STATUS[] = ":status";
253 /* frame->hd.type is either NGHTTP2_HEADERS or NGHTTP2_PUSH_PROMISE */
254 static int on_header(nghttp2_session *session, const nghttp2_frame *frame,
255 const uint8_t *name, size_t namelen,
256 const uint8_t *value, size_t valuelen,
259 struct connectdata *conn = (struct connectdata *)userp;
260 struct http_conn *c = &conn->proto.httpc;
264 if(namelen == sizeof(":status") - 1 &&
265 memcmp(STATUS, name, namelen) == 0) {
266 snprintf(c->header_recvbuf->buffer, 13, "HTTP/2.0 %s", value);
267 c->header_recvbuf->buffer[12] = '\r';
271 /* convert to a HTTP1-style header */
272 infof(conn->data, "got header\n");
273 Curl_add_buffer(c->header_recvbuf, name, namelen);
274 Curl_add_buffer(c->header_recvbuf, ":", 1);
275 Curl_add_buffer(c->header_recvbuf, value, valuelen);
276 Curl_add_buffer(c->header_recvbuf, "\r\n", 2);
279 return 0; /* 0 is successful */
283 * This is all callbacks nghttp2 calls
285 static const nghttp2_session_callbacks callbacks = {
286 send_callback, /* nghttp2_send_callback */
287 NULL, /* nghttp2_recv_callback */
288 on_frame_recv, /* nghttp2_on_frame_recv_callback */
289 on_invalid_frame_recv, /* nghttp2_on_invalid_frame_recv_callback */
290 on_data_chunk_recv, /* nghttp2_on_data_chunk_recv_callback */
291 before_frame_send, /* nghttp2_before_frame_send_callback */
292 on_frame_send, /* nghttp2_on_frame_send_callback */
293 on_frame_not_send, /* nghttp2_on_frame_not_send_callback */
294 on_stream_close, /* nghttp2_on_stream_close_callback */
295 on_unknown_frame_recv, /* nghttp2_on_unknown_frame_recv_callback */
296 on_begin_headers, /* nghttp2_on_begin_headers_callback */
297 on_header /* nghttp2_on_header_callback */
301 * The HTTP2 settings we send in the Upgrade request
303 static nghttp2_settings_entry settings[] = {
304 { NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS, 100 },
305 { NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE, NGHTTP2_INITIAL_WINDOW_SIZE },
309 * Initialize nghttp2 for a Curl connection
311 CURLcode Curl_http2_init(struct connectdata *conn) {
312 if(!conn->proto.httpc.h2) {
313 /* The nghttp2 session is not yet setup, do it */
314 int rc = nghttp2_session_client_new(&conn->proto.httpc.h2,
317 failf(conn->data, "Couldn't initialize nghttp2!");
318 return CURLE_OUT_OF_MEMORY; /* most likely at least */
325 * Send a request using http2
327 CURLcode Curl_http2_send_request(struct connectdata *conn)
334 * Append headers to ask for a HTTP1.1 to HTTP2 upgrade.
336 CURLcode Curl_http2_request_upgrade(Curl_send_buffer *req,
337 struct connectdata *conn)
343 struct SingleRequest *k = &conn->data->req;
344 uint8_t *binsettings = conn->proto.httpc.binsettings;
346 Curl_http2_init(conn);
348 /* As long as we have a fixed set of settings, we don't have to dynamically
349 * figure out the base64 strings since it'll always be the same. However,
350 * the settings will likely not be fixed every time in the future.
353 /* this returns number of bytes it wrote */
354 binlen = nghttp2_pack_settings_payload(binsettings, H2_BINSETTINGS_LEN,
356 sizeof(settings)/sizeof(settings[0]));
358 failf(conn->data, "nghttp2 unexpectedly failed on pack_settings_payload");
359 return CURLE_FAILED_INIT;
361 conn->proto.httpc.binlen = binlen;
363 result = Curl_base64_encode(conn->data, (const char *)binsettings, binlen,
368 result = Curl_add_bufferf(req,
369 "Connection: Upgrade, HTTP2-Settings\r\n"
371 "HTTP2-Settings: %s\r\n",
372 NGHTTP2_PROTO_VERSION_ID, base64);
375 k->upgr101 = UPGR101_REQUESTED;
380 #define H2_BUFSIZE 4096
383 * If the read would block (EWOULDBLOCK) we return -1. Otherwise we return
384 * a regular CURLcode value.
386 static ssize_t http2_recv(struct connectdata *conn, int sockindex,
387 char *mem, size_t len, CURLcode *err)
392 char inbuf[H2_BUFSIZE];
393 struct http_conn *httpc = &conn->proto.httpc;
395 (void)sockindex; /* we always do HTTP2 on sockindex 0 */
397 if(httpc->bodystarted &&
398 httpc->nread_header_recvbuf < httpc->header_recvbuf->size_used) {
400 httpc->header_recvbuf->size_used - httpc->nread_header_recvbuf;
401 size_t ncopy = len < left ? len : left;
402 memcpy(mem, httpc->header_recvbuf->buffer + httpc->nread_header_recvbuf,
404 httpc->nread_header_recvbuf += ncopy;
408 conn->proto.httpc.mem = mem;
409 conn->proto.httpc.len = len;
411 infof(conn->data, "http2_recv: %d bytes buffer\n",
412 conn->proto.httpc.len);
415 nread = ((Curl_recv*)httpc->recv_underlying)(conn, FIRSTSOCKET,
416 inbuf, H2_BUFSIZE, &rc);
418 if(rc == CURLE_AGAIN) {
424 failf(conn->data, "Failed receiving HTTP2 data");
429 infof(conn->data, "nread=%zd\n", nread);
430 rv = nghttp2_session_mem_recv(httpc->h2, (const uint8_t *)inbuf, nread);
432 if(nghttp2_is_fatal((int)rv)) {
433 failf(conn->data, "nghttp2_session_mem_recv() returned %d:%s\n",
434 rv, nghttp2_strerror((int)rv));
435 *err = CURLE_RECV_ERROR;
438 infof(conn->data, "nghttp2_session_mem_recv() returns %zd\n", rv);
439 /* Always send pending frames in nghttp2 session, because
440 nghttp2_session_mem_recv() may queue new frame */
441 rv = nghttp2_session_send(httpc->h2);
443 *err = CURLE_SEND_ERROR;
446 if(len != httpc->len) {
447 return len - conn->proto.httpc.len;
449 /* If stream is closed, return 0 to signal the http routine to close
458 #define MAKE_NV(k, v) \
459 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, sizeof(v) - 1 }
461 #define MAKE_NV2(k, v, vlen) \
462 { (uint8_t*)k, (uint8_t*)v, sizeof(k) - 1, vlen }
464 /* return number of received (decrypted) bytes */
465 static ssize_t http2_send(struct connectdata *conn, int sockindex,
466 const void *mem, size_t len, CURLcode *err)
469 * BIG TODO: Currently, we send request in this function, but this
470 * function is also used to send request body. It would be nice to
471 * add dedicated function for request.
474 struct http_conn *httpc = &conn->proto.httpc;
478 char *hdbuf = (char*)mem;
482 infof(conn->data, "http2_send len=%zu\n", len);
484 /* Calculate number of headers contained in [mem, mem + len) */
485 /* Here, we assume the curl http code generate *correct* HTTP header
488 for(i = 0; i < len; ++i) {
489 if(hdbuf[i] == 0x0a) {
493 /* We counted additional 2 \n in the first and last line. We need 3
494 new headers: :method, :path and :scheme. Therefore we need one
497 nva = malloc(sizeof(nghttp2_nv) * nheader);
499 *err = CURLE_OUT_OF_MEMORY;
502 /* Extract :method, :path from request line */
503 end = strchr(hdbuf, ' ');
504 nva[0].name = (unsigned char *)":method";
505 nva[0].namelen = (uint16_t)strlen((char *)nva[0].name);
506 nva[0].value = (unsigned char *)hdbuf;
507 nva[0].valuelen = (uint16_t)(end - hdbuf);
511 end = strchr(hdbuf, ' ');
512 nva[1].name = (unsigned char *)":path";
513 nva[1].namelen = (uint16_t)strlen((char *)nva[1].name);
514 nva[1].value = (unsigned char *)hdbuf;
515 nva[1].valuelen = (uint16_t)(end - hdbuf);
517 nva[2].name = (unsigned char *)":scheme";
518 nva[2].namelen = (uint16_t)strlen((char *)nva[2].name);
519 if(conn->handler->flags & PROTOPT_SSL)
520 nva[2].value = (unsigned char *)"https";
522 nva[2].value = (unsigned char *)"http";
523 nva[2].valuelen = (uint16_t)strlen((char *)nva[2].value);
525 hdbuf = strchr(hdbuf, 0x0a);
528 for(i = 3; i < nheader; ++i) {
529 end = strchr(hdbuf, ':');
531 if(end - hdbuf == 4 && Curl_raw_nequal("host", hdbuf, 4)) {
532 nva[i].name = (unsigned char *)":authority";
533 nva[i].namelen = (uint16_t)strlen((char *)nva[i].name);
536 nva[i].name = (unsigned char *)hdbuf;
537 nva[i].namelen = (uint16_t)(end - hdbuf);
540 for(; *hdbuf == ' '; ++hdbuf);
541 end = strchr(hdbuf, 0x0d);
543 nva[i].value = (unsigned char *)hdbuf;
544 nva[i].valuelen = (uint16_t)(end - hdbuf);
549 rv = nghttp2_submit_request(httpc->h2, 0, nva, nheader, NULL, NULL);
554 *err = CURLE_SEND_ERROR;
558 rv = nghttp2_session_send(httpc->h2);
561 *err = CURLE_SEND_ERROR;
565 /* TODO: Still whole HEADERS frame may have not been sent because of
566 EAGAIN. But I don't know how to setup to call
567 nghttp2_session_send() when socket becomes writable. */
572 int Curl_http2_switched(struct connectdata *conn)
576 struct http_conn *httpc = &conn->proto.httpc;
577 /* we are switched! */
578 /* Don't know this is needed here at this moment. Original
579 handler->flags is still useful. */
580 /* conn->handler = &Curl_handler_http2; */
581 httpc->recv_underlying = (recving)conn->recv[FIRSTSOCKET];
582 httpc->send_underlying = (sending)conn->send[FIRSTSOCKET];
583 conn->recv[FIRSTSOCKET] = http2_recv;
584 conn->send[FIRSTSOCKET] = http2_send;
585 infof(conn->data, "We have switched to HTTP2\n");
586 httpc->bodystarted = FALSE;
587 httpc->closed = FALSE;
588 httpc->header_recvbuf = Curl_add_buffer_init();
589 httpc->nread_header_recvbuf = 0;
591 /* Put place holder for status line */
592 Curl_add_buffer(httpc->header_recvbuf, "HTTP/2.0 200\r\n", 14);
594 /* TODO: May get CURLE_AGAIN */
595 rv = (int) ((Curl_send*)httpc->send_underlying)
597 NGHTTP2_CLIENT_CONNECTION_HEADER,
598 NGHTTP2_CLIENT_CONNECTION_HEADER_LEN,
601 if(conn->data->req.upgr101 == UPGR101_RECEIVED) {
602 /* queue SETTINGS frame (again) */
603 rv = nghttp2_session_upgrade(httpc->h2, httpc->binsettings,
604 httpc->binlen, NULL);
606 failf(conn->data, "nghttp2_session_upgrade() failed: %s(%d)",
607 nghttp2_strerror(rv), rv);
612 rv = nghttp2_submit_settings(httpc->h2, NGHTTP2_FLAG_NONE, NULL, 0);
614 failf(conn->data, "nghttp2_submit_settings() failed: %s(%d)",
615 nghttp2_strerror(rv), rv);