http2: switch into http2 mode if NPN indicates
[platform/upstream/curl.git] / lib / http2.c
1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
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.
13  *
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.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22
23 #include "curl_setup.h"
24
25 #ifdef USE_NGHTTP2
26 #define _MPRINTF_REPLACE
27 #include <curl/mprintf.h>
28
29 #include <nghttp2/nghttp2.h>
30 #include "urldata.h"
31 #include "http2.h"
32 #include "http.h"
33 #include "sendf.h"
34 #include "curl_base64.h"
35 #include "curl_memory.h"
36
37 /* include memdebug.h last */
38 #include "memdebug.h"
39
40 #if (NGHTTP2_VERSION_NUM < 0x000300)
41 #error too old nghttp2 version, upgrade!
42 #endif
43
44 /*
45  * HTTP2 handler interface. This isn't added to the general list of protocols
46  * but will be used at run-time when the protocol is dynamically switched from
47  * HTTP to HTTP2.
48  */
49 const struct Curl_handler Curl_handler_http2 = {
50   "HTTP2",                              /* scheme */
51   ZERO_NULL,                            /* setup_connection */
52   ZERO_NULL,                            /* do_it */
53   ZERO_NULL     ,                       /* done */
54   ZERO_NULL,                            /* do_more */
55   ZERO_NULL,                            /* connect_it */
56   ZERO_NULL,                            /* connecting */
57   ZERO_NULL,                            /* doing */
58   ZERO_NULL,                            /* proto_getsock */
59   ZERO_NULL,                            /* doing_getsock */
60   ZERO_NULL,                            /* domore_getsock */
61   ZERO_NULL,                            /* perform_getsock */
62   ZERO_NULL,                            /* disconnect */
63   ZERO_NULL,                            /* readwrite */
64   PORT_HTTP,                            /* defport */
65   0,                                    /* protocol */
66   PROTOPT_NONE                          /* flags */
67 };
68
69
70 /*
71  * Store nghttp2 version info in this buffer, Prefix with a space.  Return
72  * total length written.
73  */
74 int Curl_http2_ver(char *p, size_t len)
75 {
76   nghttp2_info *h2 = nghttp2_version(0);
77   return snprintf(p, len, " nghttp2/%s", h2->version_str);
78 }
79
80 /*
81  * The implementation of nghttp2_send_callback type. Here we write |data| with
82  * size |length| to the network and return the number of bytes actually
83  * written. See the documentation of nghttp2_send_callback for the details.
84  */
85 static ssize_t send_callback(nghttp2_session *h2,
86                              const uint8_t *data, size_t length, int flags,
87                              void *userp)
88 {
89   struct connectdata *conn = (struct connectdata *)userp;
90   ssize_t written;
91   CURLcode rc =
92     Curl_write(conn, conn->sock[FIRSTSOCKET], data, length, &written);
93   (void)h2;
94   (void)flags;
95
96   if(rc) {
97     failf(conn->data, "Failed sending HTTP2 data");
98     return NGHTTP2_ERR_CALLBACK_FAILURE;
99   }
100   else if(!written)
101     return NGHTTP2_ERR_WOULDBLOCK;
102
103   return written;
104 }
105
106 /*
107  * The implementation of nghttp2_recv_callback type. Here we read data from
108  * the network and write them in |buf|. The capacity of |buf| is |length|
109  * bytes. Returns the number of bytes stored in |buf|. See the documentation
110  * of nghttp2_recv_callback for the details.
111  */
112 static ssize_t recv_callback(nghttp2_session *h2,
113                              uint8_t *buf, size_t length, int flags,
114                              void *userp)
115 {
116   struct connectdata *conn = (struct connectdata *)userp;
117   ssize_t nread;
118   CURLcode rc;
119
120   infof(conn->data, "recv_callback() was called with length %d\n", length);
121
122   rc = Curl_read_plain(conn->sock[FIRSTSOCKET], (char *)buf, length,
123                        &nread);
124   (void)h2;
125   (void)flags;
126
127   if(rc) {
128     failf(conn->data, "Failed receiving HTTP2 data");
129     return NGHTTP2_ERR_CALLBACK_FAILURE;
130   }
131   if(!nread)
132     return NGHTTP2_ERR_WOULDBLOCK;
133
134   return nread;
135 }
136
137 static int on_frame_recv(nghttp2_session *session, const nghttp2_frame *frame,
138                          void *userp)
139 {
140   struct connectdata *conn = (struct connectdata *)userp;
141   (void)session;
142   (void)frame;
143   infof(conn->data, "on_frame_recv() was called with header %x\n",
144         frame->hd.type);
145   return 0;
146 }
147
148 static int on_invalid_frame_recv(nghttp2_session *session,
149                                  const nghttp2_frame *frame,
150                                  nghttp2_error_code error_code, void *userp)
151 {
152   struct connectdata *conn = (struct connectdata *)userp;
153   (void)session;
154   (void)frame;
155   infof(conn->data, "on_invalid_frame_recv() was called, error_code = %d\n",
156         error_code);
157   return 0;
158 }
159
160 static int on_data_chunk_recv(nghttp2_session *session, uint8_t flags,
161                               int32_t stream_id,
162                               const uint8_t *data, size_t len, void *userp)
163 {
164   struct connectdata *conn = (struct connectdata *)userp;
165   (void)session;
166   (void)flags;
167   (void)stream_id;
168   (void)data;
169   infof(conn->data, "on_data_chunk_recv() was called with len = %u\n", len);
170   return 0;
171 }
172
173 static int before_frame_send(nghttp2_session *session,
174                              const nghttp2_frame *frame,
175                              void *userp)
176 {
177   struct connectdata *conn = (struct connectdata *)userp;
178   (void)session;
179   (void)frame;
180   infof(conn->data, "before_frame_send() was called\n");
181   return 0;
182 }
183 static int on_frame_send(nghttp2_session *session,
184                          const nghttp2_frame *frame,
185                          void *userp)
186 {
187   struct connectdata *conn = (struct connectdata *)userp;
188   (void)session;
189   (void)frame;
190   infof(conn->data, "on_frame_send() was called\n");
191   return 0;
192 }
193 static int on_frame_not_send(nghttp2_session *session,
194                              const nghttp2_frame *frame,
195                              int lib_error_code, void *userp)
196 {
197   struct connectdata *conn = (struct connectdata *)userp;
198   (void)session;
199   (void)frame;
200   infof(conn->data, "on_frame_not_send() was called, lib_error_code = %d\n",
201         lib_error_code);
202   return 0;
203 }
204 static int on_stream_close(nghttp2_session *session, int32_t stream_id,
205                            nghttp2_error_code error_code, void *userp)
206 {
207   struct connectdata *conn = (struct connectdata *)userp;
208   (void)session;
209   (void)stream_id;
210   infof(conn->data, "on_stream_close() was called, error_code = %d\n",
211         error_code);
212   return 0;
213 }
214
215 static int on_unknown_frame_recv(nghttp2_session *session,
216                                  const uint8_t *head, size_t headlen,
217                                  const uint8_t *payload, size_t payloadlen,
218                                  void *userp)
219 {
220   struct connectdata *conn = (struct connectdata *)userp;
221   (void)session;
222   (void)head;
223   (void)headlen;
224   (void)payload;
225   (void)payloadlen;
226   infof(conn->data, "on_unknown_frame_recv() was called\n");
227   return 0;
228 }
229 static int on_begin_headers(nghttp2_session *session,
230                             const nghttp2_frame *frame, void *userp)
231 {
232   struct connectdata *conn = (struct connectdata *)userp;
233   (void)session;
234   (void)frame;
235   infof(conn->data, "on_begin_headers() was called\n");
236   return 0;
237 }
238
239 /* frame->hd.type is either NGHTTP2_HEADERS or NGHTTP2_PUSH_PROMISE */
240 static int on_header(nghttp2_session *session, const nghttp2_frame *frame,
241                       const uint8_t *name, size_t namelen,
242                       const uint8_t *value, size_t valuelen,
243                       void *userp)
244 {
245   struct connectdata *conn = (struct connectdata *)userp;
246   (void)session;
247   (void)frame;
248
249   if(namelen + valuelen < 200) {
250     char buffer[256];
251     memcpy(buffer, name, namelen);
252     buffer[namelen]=':';
253     memcpy(&buffer[namelen+1], value, valuelen);
254     buffer[namelen + valuelen + 1]=0;
255     infof(conn->data, "Got '%s'\n", buffer);
256     /* TODO: the headers need to be passed to the http parser */
257   }
258   else {
259     infof(conn->data, "Got header with no name or too long\n",
260           namelen, name, valuelen, value);
261   }
262
263   return 0; /* 0 is successful */
264 }
265
266 /*
267  * This is all callbacks nghttp2 calls
268  */
269 static const nghttp2_session_callbacks callbacks = {
270   send_callback,         /* nghttp2_send_callback */
271   recv_callback,         /* nghttp2_recv_callback */
272   on_frame_recv,         /* nghttp2_on_frame_recv_callback */
273   on_invalid_frame_recv, /* nghttp2_on_invalid_frame_recv_callback */
274   on_data_chunk_recv,    /* nghttp2_on_data_chunk_recv_callback */
275   before_frame_send,     /* nghttp2_before_frame_send_callback */
276   on_frame_send,         /* nghttp2_on_frame_send_callback */
277   on_frame_not_send,     /* nghttp2_on_frame_not_send_callback */
278   on_stream_close,       /* nghttp2_on_stream_close_callback */
279   on_unknown_frame_recv, /* nghttp2_on_unknown_frame_recv_callback */
280   on_begin_headers,      /* nghttp2_on_begin_headers_callback */
281   on_header              /* nghttp2_on_header_callback */
282 };
283
284 /*
285  * The HTTP2 settings we send in the Upgrade request
286  */
287 static nghttp2_settings_entry settings[] = {
288   { NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS, 100 },
289   { NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE, NGHTTP2_INITIAL_WINDOW_SIZE },
290 };
291
292 /*
293  * Initialize nghttp2 for a Curl connection
294  */
295 CURLcode Curl_http2_init(struct connectdata *conn) {
296   if(!conn->proto.httpc.h2) {
297     /* The nghttp2 session is not yet setup, do it */
298     int rc = nghttp2_session_client_new(&conn->proto.httpc.h2,
299                                         &callbacks, conn);
300     if(rc) {
301       failf(conn->data, "Couldn't initialize nghttp2!");
302       return CURLE_OUT_OF_MEMORY; /* most likely at least */
303     }
304   }
305   return CURLE_OK;
306 }
307
308 /*
309  * Send a request using http2
310  */
311 CURLcode Curl_http2_send_request(struct connectdata *conn)
312 {
313   (void)conn;
314   return CURLE_OK;
315 }
316
317 /*
318  * Append headers to ask for a HTTP1.1 to HTTP2 upgrade.
319  */
320 CURLcode Curl_http2_request_upgrade(Curl_send_buffer *req,
321                                     struct connectdata *conn)
322 {
323   uint8_t binsettings[80];
324   CURLcode result;
325   ssize_t binlen;
326   char *base64;
327   size_t blen;
328   struct SingleRequest *k = &conn->data->req;
329
330   Curl_http2_init(conn);
331
332   /* As long as we have a fixed set of settings, we don't have to dynamically
333    * figure out the base64 strings since it'll always be the same. However,
334    * the settings will likely not be fixed every time in the future.
335    */
336
337   /* this returns number of bytes it wrote */
338   binlen = nghttp2_pack_settings_payload(binsettings,
339                                          sizeof(binsettings),
340                                          settings,
341                                          sizeof(settings)/sizeof(settings[0]));
342   if(!binlen) {
343     failf(conn->data, "nghttp2 unexpectedly failed on pack_settings_payload");
344     return CURLE_FAILED_INIT;
345   }
346
347   result = Curl_base64_encode(conn->data, (const char *)binsettings, binlen,
348                               &base64, &blen);
349   if(result)
350     return result;
351
352   result = Curl_add_bufferf(req,
353                             "Connection: Upgrade, HTTP2-Settings\r\n"
354                             "Upgrade: %s\r\n"
355                             "HTTP2-Settings: %s\r\n",
356                             NGHTTP2_PROTO_VERSION_ID, base64);
357   free(base64);
358
359   k->upgr101 = UPGR101_REQUESTED;
360
361   return result;
362 }
363
364 /*
365  * If the read would block (EWOULDBLOCK) we return -1. Otherwise we return
366  * a regular CURLcode value.
367  */
368 static ssize_t http2_recv(struct connectdata *conn, int sockindex,
369                           char *mem, size_t len, CURLcode *err)
370 {
371   int rc;
372   (void)sockindex; /* we always do HTTP2 on sockindex 0 */
373
374   conn->proto.httpc.mem = mem;
375   conn->proto.httpc.size = len;
376
377   rc = nghttp2_session_recv(conn->proto.httpc.h2);
378
379   if(rc < 0) {
380     failf(conn->data, "nghttp2_session_recv() returned %d\n",
381           rc);
382     *err = CURLE_RECV_ERROR;
383   }
384   return 0;
385 }
386
387 /* return number of received (decrypted) bytes */
388 static ssize_t http2_send(struct connectdata *conn, int sockindex,
389                           const void *mem, size_t len, CURLcode *err)
390 {
391   /* TODO: proper implementation */
392   (void)conn;
393   (void)sockindex;
394   (void)mem;
395   (void)len;
396   (void)err;
397   return 0;
398 }
399
400 void Curl_http2_switched(struct connectdata *conn)
401 {
402   /* we are switched! */
403   conn->handler = &Curl_handler_http2;
404   conn->recv[FIRSTSOCKET] = http2_recv;
405   conn->send[FIRSTSOCKET] = http2_send;
406   infof(conn->data, "We have switched to HTTP2\n");
407 }
408
409 #endif