http.h 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  1. #ifndef HEADER_CURL_HTTP_H
  2. #define HEADER_CURL_HTTP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.haxx.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. ***************************************************************************/
  24. #include "curl_setup.h"
  25. #ifndef CURL_DISABLE_HTTP
  26. #ifdef USE_NGHTTP2
  27. #include <nghttp2/nghttp2.h>
  28. #endif
  29. extern const struct Curl_handler Curl_handler_http;
  30. #ifdef USE_SSL
  31. extern const struct Curl_handler Curl_handler_https;
  32. #endif
  33. /* Header specific functions */
  34. bool Curl_compareheader(const char *headerline, /* line to check */
  35. const char *header, /* header keyword _with_ colon */
  36. const char *content); /* content string to find */
  37. char *Curl_copy_header_value(const char *header);
  38. char *Curl_checkProxyheaders(const struct connectdata *conn,
  39. const char *thisheader);
  40. CURLcode Curl_buffer_send(struct dynbuf *in,
  41. struct connectdata *conn,
  42. curl_off_t *bytes_written,
  43. size_t included_body_bytes,
  44. int socketindex);
  45. CURLcode Curl_add_timecondition(const struct connectdata *conn,
  46. struct dynbuf *buf);
  47. CURLcode Curl_add_custom_headers(struct connectdata *conn,
  48. bool is_connect,
  49. struct dynbuf *req_buffer);
  50. CURLcode Curl_http_compile_trailers(struct curl_slist *trailers,
  51. struct dynbuf *buf,
  52. struct Curl_easy *handle);
  53. /* protocol-specific functions set up to be called by the main engine */
  54. CURLcode Curl_http(struct connectdata *conn, bool *done);
  55. CURLcode Curl_http_done(struct connectdata *, CURLcode, bool premature);
  56. CURLcode Curl_http_connect(struct connectdata *conn, bool *done);
  57. /* These functions are in http.c */
  58. CURLcode Curl_http_input_auth(struct connectdata *conn, bool proxy,
  59. const char *auth);
  60. CURLcode Curl_http_auth_act(struct connectdata *conn);
  61. /* If only the PICKNONE bit is set, there has been a round-trip and we
  62. selected to use no auth at all. Ie, we actively select no auth, as opposed
  63. to not having one selected. The other CURLAUTH_* defines are present in the
  64. public curl/curl.h header. */
  65. #define CURLAUTH_PICKNONE (1<<30) /* don't use auth */
  66. /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
  67. data get included in the initial data chunk sent to the server. If the
  68. data is larger than this, it will automatically get split up in multiple
  69. system calls.
  70. This value used to be fairly big (100K), but we must take into account that
  71. if the server rejects the POST due for authentication reasons, this data
  72. will always be unconditionally sent and thus it may not be larger than can
  73. always be afforded to send twice.
  74. It must not be greater than 64K to work on VMS.
  75. */
  76. #ifndef MAX_INITIAL_POST_SIZE
  77. #define MAX_INITIAL_POST_SIZE (64*1024)
  78. #endif
  79. /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
  80. * automatically add an "Expect: 100-continue" header in HTTP requests. When
  81. * the size is unknown, it will always add it.
  82. *
  83. */
  84. #ifndef EXPECT_100_THRESHOLD
  85. #define EXPECT_100_THRESHOLD (1024*1024)
  86. #endif
  87. #endif /* CURL_DISABLE_HTTP */
  88. #ifdef USE_NGHTTP3
  89. struct h3out; /* see ngtcp2 */
  90. #endif
  91. /****************************************************************************
  92. * HTTP unique setup
  93. ***************************************************************************/
  94. struct HTTP {
  95. curl_mimepart *sendit;
  96. curl_off_t postsize; /* off_t to handle large file sizes */
  97. const char *postdata;
  98. const char *p_pragma; /* Pragma: string */
  99. const char *p_accept; /* Accept: string */
  100. /* For FORM posting */
  101. curl_mimepart form;
  102. struct back {
  103. curl_read_callback fread_func; /* backup storage for fread pointer */
  104. void *fread_in; /* backup storage for fread_in pointer */
  105. const char *postdata;
  106. curl_off_t postsize;
  107. } backup;
  108. enum {
  109. HTTPSEND_NADA, /* init */
  110. HTTPSEND_REQUEST, /* sending a request */
  111. HTTPSEND_BODY, /* sending body */
  112. HTTPSEND_LAST /* never use this */
  113. } sending;
  114. #ifndef CURL_DISABLE_HTTP
  115. struct dynbuf send_buffer; /* used if the request couldn't be sent in one
  116. chunk, points to an allocated send_buffer
  117. struct */
  118. #endif
  119. #ifdef USE_NGHTTP2
  120. /*********** for HTTP/2 we store stream-local data here *************/
  121. int32_t stream_id; /* stream we are interested in */
  122. bool bodystarted;
  123. /* We store non-final and final response headers here, per-stream */
  124. struct dynbuf header_recvbuf;
  125. size_t nread_header_recvbuf; /* number of bytes in header_recvbuf fed into
  126. upper layer */
  127. struct dynbuf trailer_recvbuf;
  128. int status_code; /* HTTP status code */
  129. const uint8_t *pausedata; /* pointer to data received in on_data_chunk */
  130. size_t pauselen; /* the number of bytes left in data */
  131. bool close_handled; /* TRUE if stream closure is handled by libcurl */
  132. char **push_headers; /* allocated array */
  133. size_t push_headers_used; /* number of entries filled in */
  134. size_t push_headers_alloc; /* number of entries allocated */
  135. #endif
  136. #if defined(USE_NGHTTP2) || defined(USE_NGHTTP3)
  137. bool closed; /* TRUE on HTTP2 stream close */
  138. char *mem; /* points to a buffer in memory to store received data */
  139. size_t len; /* size of the buffer 'mem' points to */
  140. size_t memlen; /* size of data copied to mem */
  141. #endif
  142. #if defined(USE_NGHTTP2) || defined(ENABLE_QUIC)
  143. /* fields used by both HTTP/2 and HTTP/3 */
  144. const uint8_t *upload_mem; /* points to a buffer to read from */
  145. size_t upload_len; /* size of the buffer 'upload_mem' points to */
  146. curl_off_t upload_left; /* number of bytes left to upload */
  147. #endif
  148. #ifdef ENABLE_QUIC
  149. /*********** for HTTP/3 we store stream-local data here *************/
  150. int64_t stream3_id; /* stream we are interested in */
  151. bool firstheader; /* FALSE until headers arrive */
  152. bool firstbody; /* FALSE until body arrives */
  153. bool h3req; /* FALSE until request is issued */
  154. bool upload_done;
  155. #endif
  156. #ifdef USE_NGHTTP3
  157. size_t unacked_window;
  158. struct h3out *h3out; /* per-stream buffers for upload */
  159. struct dynbuf overflow; /* excess data received during a single Curl_read */
  160. #endif
  161. };
  162. #ifdef USE_NGHTTP2
  163. /* h2 settings for this connection */
  164. struct h2settings {
  165. uint32_t max_concurrent_streams;
  166. bool enable_push;
  167. };
  168. #endif
  169. struct http_conn {
  170. #ifdef USE_NGHTTP2
  171. #define H2_BINSETTINGS_LEN 80
  172. nghttp2_session *h2;
  173. uint8_t binsettings[H2_BINSETTINGS_LEN];
  174. size_t binlen; /* length of the binsettings data */
  175. Curl_send *send_underlying; /* underlying send Curl_send callback */
  176. Curl_recv *recv_underlying; /* underlying recv Curl_recv callback */
  177. char *inbuf; /* buffer to receive data from underlying socket */
  178. size_t inbuflen; /* number of bytes filled in inbuf */
  179. size_t nread_inbuf; /* number of bytes read from in inbuf */
  180. /* We need separate buffer for transmission and reception because we
  181. may call nghttp2_session_send() after the
  182. nghttp2_session_mem_recv() but mem buffer is still not full. In
  183. this case, we wrongly sends the content of mem buffer if we share
  184. them for both cases. */
  185. int32_t pause_stream_id; /* stream ID which paused
  186. nghttp2_session_mem_recv */
  187. size_t drain_total; /* sum of all stream's UrlState.drain */
  188. /* this is a hash of all individual streams (Curl_easy structs) */
  189. struct h2settings settings;
  190. /* list of settings that will be sent */
  191. nghttp2_settings_entry local_settings[3];
  192. size_t local_settings_num;
  193. uint32_t error_code; /* HTTP/2 error code */
  194. #else
  195. int unused; /* prevent a compiler warning */
  196. #endif
  197. };
  198. CURLcode Curl_http_readwrite_headers(struct Curl_easy *data,
  199. struct connectdata *conn,
  200. ssize_t *nread,
  201. bool *stop_reading);
  202. /**
  203. * Curl_http_output_auth() setups the authentication headers for the
  204. * host/proxy and the correct authentication
  205. * method. conn->data->state.authdone is set to TRUE when authentication is
  206. * done.
  207. *
  208. * @param conn all information about the current connection
  209. * @param request pointer to the request keyword
  210. * @param path pointer to the requested path
  211. * @param proxytunnel boolean if this is the request setting up a "proxy
  212. * tunnel"
  213. *
  214. * @returns CURLcode
  215. */
  216. CURLcode
  217. Curl_http_output_auth(struct connectdata *conn,
  218. const char *request,
  219. const char *path,
  220. bool proxytunnel); /* TRUE if this is the request setting
  221. up the proxy tunnel */
  222. #endif /* HEADER_CURL_HTTP_H */