http.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. #ifndef HEADER_CURL_HTTP_H
  2. #define HEADER_CURL_HTTP_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2019, 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. /* ------------------------------------------------------------------------- */
  41. /*
  42. * The add_buffer series of functions are used to build one large memory chunk
  43. * from repeated function invokes. Used so that the entire HTTP request can
  44. * be sent in one go.
  45. */
  46. struct Curl_send_buffer {
  47. char *buffer;
  48. size_t size_max;
  49. size_t size_used;
  50. };
  51. typedef struct Curl_send_buffer Curl_send_buffer;
  52. Curl_send_buffer *Curl_add_buffer_init(void);
  53. void Curl_add_buffer_free(Curl_send_buffer **inp);
  54. CURLcode Curl_add_bufferf(Curl_send_buffer **inp, const char *fmt, ...)
  55. WARN_UNUSED_RESULT;
  56. CURLcode Curl_add_buffer(Curl_send_buffer **inp, const void *inptr,
  57. size_t size) WARN_UNUSED_RESULT;
  58. CURLcode Curl_add_buffer_send(Curl_send_buffer **inp,
  59. struct connectdata *conn,
  60. curl_off_t *bytes_written,
  61. size_t included_body_bytes,
  62. int socketindex);
  63. CURLcode Curl_add_timecondition(struct Curl_easy *data,
  64. Curl_send_buffer *buf);
  65. CURLcode Curl_add_custom_headers(struct connectdata *conn,
  66. bool is_connect,
  67. Curl_send_buffer *req_buffer);
  68. CURLcode Curl_http_compile_trailers(struct curl_slist *trailers,
  69. Curl_send_buffer *buffer,
  70. struct Curl_easy *handle);
  71. /* protocol-specific functions set up to be called by the main engine */
  72. CURLcode Curl_http(struct connectdata *conn, bool *done);
  73. CURLcode Curl_http_done(struct connectdata *, CURLcode, bool premature);
  74. CURLcode Curl_http_connect(struct connectdata *conn, bool *done);
  75. CURLcode Curl_http_setup_conn(struct connectdata *conn);
  76. /* The following functions are defined in http_chunks.c */
  77. void Curl_httpchunk_init(struct connectdata *conn);
  78. CHUNKcode Curl_httpchunk_read(struct connectdata *conn, char *datap,
  79. ssize_t length, ssize_t *wrote);
  80. /* These functions are in http.c */
  81. void Curl_http_auth_stage(struct Curl_easy *data, int stage);
  82. CURLcode Curl_http_input_auth(struct connectdata *conn, bool proxy,
  83. const char *auth);
  84. CURLcode Curl_http_auth_act(struct connectdata *conn);
  85. CURLcode Curl_http_perhapsrewind(struct connectdata *conn);
  86. /* If only the PICKNONE bit is set, there has been a round-trip and we
  87. selected to use no auth at all. Ie, we actively select no auth, as opposed
  88. to not having one selected. The other CURLAUTH_* defines are present in the
  89. public curl/curl.h header. */
  90. #define CURLAUTH_PICKNONE (1<<30) /* don't use auth */
  91. /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
  92. data get included in the initial data chunk sent to the server. If the
  93. data is larger than this, it will automatically get split up in multiple
  94. system calls.
  95. This value used to be fairly big (100K), but we must take into account that
  96. if the server rejects the POST due for authentication reasons, this data
  97. will always be unconditionally sent and thus it may not be larger than can
  98. always be afforded to send twice.
  99. It must not be greater than 64K to work on VMS.
  100. */
  101. #ifndef MAX_INITIAL_POST_SIZE
  102. #define MAX_INITIAL_POST_SIZE (64*1024)
  103. #endif
  104. /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
  105. * automatically add an "Expect: 100-continue" header in HTTP requests. When
  106. * the size is unknown, it will always add it.
  107. *
  108. */
  109. #ifndef EXPECT_100_THRESHOLD
  110. #define EXPECT_100_THRESHOLD 1024
  111. #endif
  112. #endif /* CURL_DISABLE_HTTP */
  113. /****************************************************************************
  114. * HTTP unique setup
  115. ***************************************************************************/
  116. struct HTTP {
  117. curl_mimepart *sendit;
  118. curl_off_t postsize; /* off_t to handle large file sizes */
  119. const char *postdata;
  120. const char *p_pragma; /* Pragma: string */
  121. const char *p_accept; /* Accept: string */
  122. /* For FORM posting */
  123. curl_mimepart form;
  124. struct back {
  125. curl_read_callback fread_func; /* backup storage for fread pointer */
  126. void *fread_in; /* backup storage for fread_in pointer */
  127. const char *postdata;
  128. curl_off_t postsize;
  129. } backup;
  130. enum {
  131. HTTPSEND_NADA, /* init */
  132. HTTPSEND_REQUEST, /* sending a request */
  133. HTTPSEND_BODY, /* sending body */
  134. HTTPSEND_LAST /* never use this */
  135. } sending;
  136. #ifndef CURL_DISABLE_HTTP
  137. Curl_send_buffer *send_buffer; /* used if the request couldn't be sent in
  138. one chunk, points to an allocated
  139. send_buffer struct */
  140. #endif
  141. #ifdef USE_NGHTTP2
  142. /*********** for HTTP/2 we store stream-local data here *************/
  143. int32_t stream_id; /* stream we are interested in */
  144. bool bodystarted;
  145. /* We store non-final and final response headers here, per-stream */
  146. Curl_send_buffer *header_recvbuf;
  147. size_t nread_header_recvbuf; /* number of bytes in header_recvbuf fed into
  148. upper layer */
  149. Curl_send_buffer *trailer_recvbuf;
  150. int status_code; /* HTTP status code */
  151. const uint8_t *pausedata; /* pointer to data received in on_data_chunk */
  152. size_t pauselen; /* the number of bytes left in data */
  153. bool closed; /* TRUE on HTTP2 stream close */
  154. bool close_handled; /* TRUE if stream closure is handled by libcurl */
  155. char *mem; /* points to a buffer in memory to store received data */
  156. size_t len; /* size of the buffer 'mem' points to */
  157. size_t memlen; /* size of data copied to mem */
  158. const uint8_t *upload_mem; /* points to a buffer to read from */
  159. size_t upload_len; /* size of the buffer 'upload_mem' points to */
  160. curl_off_t upload_left; /* number of bytes left to upload */
  161. char **push_headers; /* allocated array */
  162. size_t push_headers_used; /* number of entries filled in */
  163. size_t push_headers_alloc; /* number of entries allocated */
  164. #endif
  165. };
  166. #ifdef USE_NGHTTP2
  167. /* h2 settings for this connection */
  168. struct h2settings {
  169. uint32_t max_concurrent_streams;
  170. bool enable_push;
  171. };
  172. #endif
  173. struct http_conn {
  174. #ifdef USE_NGHTTP2
  175. #define H2_BINSETTINGS_LEN 80
  176. nghttp2_session *h2;
  177. uint8_t binsettings[H2_BINSETTINGS_LEN];
  178. size_t binlen; /* length of the binsettings data */
  179. Curl_send *send_underlying; /* underlying send Curl_send callback */
  180. Curl_recv *recv_underlying; /* underlying recv Curl_recv callback */
  181. char *inbuf; /* buffer to receive data from underlying socket */
  182. size_t inbuflen; /* number of bytes filled in inbuf */
  183. size_t nread_inbuf; /* number of bytes read from in inbuf */
  184. /* We need separate buffer for transmission and reception because we
  185. may call nghttp2_session_send() after the
  186. nghttp2_session_mem_recv() but mem buffer is still not full. In
  187. this case, we wrongly sends the content of mem buffer if we share
  188. them for both cases. */
  189. int32_t pause_stream_id; /* stream ID which paused
  190. nghttp2_session_mem_recv */
  191. size_t drain_total; /* sum of all stream's UrlState.drain */
  192. /* this is a hash of all individual streams (Curl_easy structs) */
  193. struct h2settings settings;
  194. /* list of settings that will be sent */
  195. nghttp2_settings_entry local_settings[3];
  196. size_t local_settings_num;
  197. uint32_t error_code; /* HTTP/2 error code */
  198. #else
  199. int unused; /* prevent a compiler warning */
  200. #endif
  201. };
  202. CURLcode Curl_http_readwrite_headers(struct Curl_easy *data,
  203. struct connectdata *conn,
  204. ssize_t *nread,
  205. bool *stop_reading);
  206. /**
  207. * Curl_http_output_auth() setups the authentication headers for the
  208. * host/proxy and the correct authentication
  209. * method. conn->data->state.authdone is set to TRUE when authentication is
  210. * done.
  211. *
  212. * @param conn all information about the current connection
  213. * @param request pointer to the request keyword
  214. * @param path pointer to the requested path
  215. * @param proxytunnel boolean if this is the request setting up a "proxy
  216. * tunnel"
  217. *
  218. * @returns CURLcode
  219. */
  220. CURLcode
  221. Curl_http_output_auth(struct connectdata *conn,
  222. const char *request,
  223. const char *path,
  224. bool proxytunnel); /* TRUE if this is the request setting
  225. up the proxy tunnel */
  226. #endif /* HEADER_CURL_HTTP_H */