1 #ifndef HEADER_CURL_HTTP_H 2 #define HEADER_CURL_HTTP_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2021, 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.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 26 typedef enum { 27 HTTPREQ_GET, 28 HTTPREQ_POST, 29 HTTPREQ_POST_FORM, /* we make a difference internally */ 30 HTTPREQ_POST_MIME, /* we make a difference internally */ 31 HTTPREQ_PUT, 32 HTTPREQ_HEAD 33 } Curl_HttpReq; 34 35 #ifndef CURL_DISABLE_HTTP 36 37 #ifdef USE_NGHTTP2 38 #include <nghttp2/nghttp2.h> 39 #endif 40 41 extern const struct Curl_handler Curl_handler_http; 42 43 #ifdef USE_SSL 44 extern const struct Curl_handler Curl_handler_https; 45 #endif 46 47 /* Header specific functions */ 48 bool Curl_compareheader(const char *headerline, /* line to check */ 49 const char *header, /* header keyword _with_ colon */ 50 const char *content); /* content string to find */ 51 52 char *Curl_copy_header_value(const char *header); 53 54 char *Curl_checkProxyheaders(struct Curl_easy *data, 55 const struct connectdata *conn, 56 const char *thisheader); 57 #ifndef USE_HYPER 58 CURLcode Curl_buffer_send(struct dynbuf *in, 59 struct Curl_easy *data, 60 curl_off_t *bytes_written, 61 curl_off_t included_body_bytes, 62 int socketindex); 63 #else 64 #define Curl_buffer_send(a,b,c,d,e) CURLE_OK 65 #endif 66 67 CURLcode Curl_add_timecondition(struct Curl_easy *data, 68 #ifndef USE_HYPER 69 struct dynbuf *req 70 #else 71 void *headers 72 #endif 73 ); 74 CURLcode Curl_add_custom_headers(struct Curl_easy *data, 75 bool is_connect, 76 #ifndef USE_HYPER 77 struct dynbuf *req 78 #else 79 void *headers 80 #endif 81 ); 82 CURLcode Curl_http_compile_trailers(struct curl_slist *trailers, 83 struct dynbuf *buf, 84 struct Curl_easy *handle); 85 86 void Curl_http_method(struct Curl_easy *data, struct connectdata *conn, 87 const char **method, Curl_HttpReq *); 88 CURLcode Curl_http_useragent(struct Curl_easy *data); 89 CURLcode Curl_http_host(struct Curl_easy *data, struct connectdata *conn); 90 CURLcode Curl_http_target(struct Curl_easy *data, struct connectdata *conn, 91 struct dynbuf *req); 92 CURLcode Curl_http_statusline(struct Curl_easy *data, 93 struct connectdata *conn); 94 CURLcode Curl_http_header(struct Curl_easy *data, struct connectdata *conn, 95 char *headp); 96 CURLcode Curl_transferencode(struct Curl_easy *data); 97 CURLcode Curl_http_body(struct Curl_easy *data, struct connectdata *conn, 98 Curl_HttpReq httpreq, 99 const char **teep); 100 CURLcode Curl_http_bodysend(struct Curl_easy *data, struct connectdata *conn, 101 struct dynbuf *r, Curl_HttpReq httpreq); 102 #ifndef CURL_DISABLE_COOKIES 103 CURLcode Curl_http_cookies(struct Curl_easy *data, 104 struct connectdata *conn, 105 struct dynbuf *r); 106 #else 107 #define Curl_http_cookies(a,b,c) CURLE_OK 108 #endif 109 CURLcode Curl_http_resume(struct Curl_easy *data, 110 struct connectdata *conn, 111 Curl_HttpReq httpreq); 112 CURLcode Curl_http_range(struct Curl_easy *data, 113 Curl_HttpReq httpreq); 114 CURLcode Curl_http_firstwrite(struct Curl_easy *data, 115 struct connectdata *conn, 116 bool *done); 117 118 /* protocol-specific functions set up to be called by the main engine */ 119 CURLcode Curl_http(struct Curl_easy *data, bool *done); 120 CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature); 121 CURLcode Curl_http_connect(struct Curl_easy *data, bool *done); 122 123 /* These functions are in http.c */ 124 CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy, 125 const char *auth); 126 CURLcode Curl_http_auth_act(struct Curl_easy *data); 127 128 /* If only the PICKNONE bit is set, there has been a round-trip and we 129 selected to use no auth at all. Ie, we actively select no auth, as opposed 130 to not having one selected. The other CURLAUTH_* defines are present in the 131 public curl/curl.h header. */ 132 #define CURLAUTH_PICKNONE (1<<30) /* don't use auth */ 133 134 /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST 135 data get included in the initial data chunk sent to the server. If the 136 data is larger than this, it will automatically get split up in multiple 137 system calls. 138 139 This value used to be fairly big (100K), but we must take into account that 140 if the server rejects the POST due for authentication reasons, this data 141 will always be unconditionally sent and thus it may not be larger than can 142 always be afforded to send twice. 143 144 It must not be greater than 64K to work on VMS. 145 */ 146 #ifndef MAX_INITIAL_POST_SIZE 147 #define MAX_INITIAL_POST_SIZE (64*1024) 148 #endif 149 150 /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will 151 * automatically add an "Expect: 100-continue" header in HTTP requests. When 152 * the size is unknown, it will always add it. 153 * 154 */ 155 #ifndef EXPECT_100_THRESHOLD 156 #define EXPECT_100_THRESHOLD (1024*1024) 157 #endif 158 159 #endif /* CURL_DISABLE_HTTP */ 160 161 #ifdef USE_NGHTTP3 162 struct h3out; /* see ngtcp2 */ 163 #endif 164 165 /**************************************************************************** 166 * HTTP unique setup 167 ***************************************************************************/ 168 struct HTTP { 169 curl_mimepart *sendit; 170 curl_off_t postsize; /* off_t to handle large file sizes */ 171 const char *postdata; 172 173 const char *p_pragma; /* Pragma: string */ 174 175 /* For FORM posting */ 176 curl_mimepart form; 177 178 struct back { 179 curl_read_callback fread_func; /* backup storage for fread pointer */ 180 void *fread_in; /* backup storage for fread_in pointer */ 181 const char *postdata; 182 curl_off_t postsize; 183 } backup; 184 185 enum { 186 HTTPSEND_NADA, /* init */ 187 HTTPSEND_REQUEST, /* sending a request */ 188 HTTPSEND_BODY /* sending body */ 189 } sending; 190 191 #ifndef CURL_DISABLE_HTTP 192 struct dynbuf send_buffer; /* used if the request couldn't be sent in one 193 chunk, points to an allocated send_buffer 194 struct */ 195 #endif 196 #ifdef USE_NGHTTP2 197 /*********** for HTTP/2 we store stream-local data here *************/ 198 int32_t stream_id; /* stream we are interested in */ 199 200 bool bodystarted; 201 /* We store non-final and final response headers here, per-stream */ 202 struct dynbuf header_recvbuf; 203 size_t nread_header_recvbuf; /* number of bytes in header_recvbuf fed into 204 upper layer */ 205 struct dynbuf trailer_recvbuf; 206 int status_code; /* HTTP status code */ 207 const uint8_t *pausedata; /* pointer to data received in on_data_chunk */ 208 size_t pauselen; /* the number of bytes left in data */ 209 bool close_handled; /* TRUE if stream closure is handled by libcurl */ 210 211 char **push_headers; /* allocated array */ 212 size_t push_headers_used; /* number of entries filled in */ 213 size_t push_headers_alloc; /* number of entries allocated */ 214 uint32_t error; /* HTTP/2 stream error code */ 215 #endif 216 #if defined(USE_NGHTTP2) || defined(USE_NGHTTP3) 217 bool closed; /* TRUE on HTTP2 stream close */ 218 char *mem; /* points to a buffer in memory to store received data */ 219 size_t len; /* size of the buffer 'mem' points to */ 220 size_t memlen; /* size of data copied to mem */ 221 #endif 222 #if defined(USE_NGHTTP2) || defined(ENABLE_QUIC) 223 /* fields used by both HTTP/2 and HTTP/3 */ 224 const uint8_t *upload_mem; /* points to a buffer to read from */ 225 size_t upload_len; /* size of the buffer 'upload_mem' points to */ 226 curl_off_t upload_left; /* number of bytes left to upload */ 227 #endif 228 229 #ifdef ENABLE_QUIC 230 /*********** for HTTP/3 we store stream-local data here *************/ 231 int64_t stream3_id; /* stream we are interested in */ 232 bool firstheader; /* FALSE until headers arrive */ 233 bool firstbody; /* FALSE until body arrives */ 234 bool h3req; /* FALSE until request is issued */ 235 bool upload_done; 236 #endif 237 #ifdef USE_NGHTTP3 238 size_t unacked_window; 239 struct h3out *h3out; /* per-stream buffers for upload */ 240 struct dynbuf overflow; /* excess data received during a single Curl_read */ 241 #endif 242 }; 243 244 #ifdef USE_NGHTTP2 245 /* h2 settings for this connection */ 246 struct h2settings { 247 uint32_t max_concurrent_streams; 248 bool enable_push; 249 }; 250 #endif 251 252 struct http_conn { 253 #ifdef USE_NGHTTP2 254 #define H2_BINSETTINGS_LEN 80 255 uint8_t binsettings[H2_BINSETTINGS_LEN]; 256 size_t binlen; /* length of the binsettings data */ 257 258 /* We associate the connnectdata struct with the connection, but we need to 259 make sure we can identify the current "driving" transfer. This is a 260 work-around for the lack of nghttp2_session_set_user_data() in older 261 nghttp2 versions that we want to support. (Added in 1.31.0) */ 262 struct Curl_easy *trnsfr; 263 264 nghttp2_session *h2; 265 Curl_send *send_underlying; /* underlying send Curl_send callback */ 266 Curl_recv *recv_underlying; /* underlying recv Curl_recv callback */ 267 char *inbuf; /* buffer to receive data from underlying socket */ 268 size_t inbuflen; /* number of bytes filled in inbuf */ 269 size_t nread_inbuf; /* number of bytes read from in inbuf */ 270 /* We need separate buffer for transmission and reception because we 271 may call nghttp2_session_send() after the 272 nghttp2_session_mem_recv() but mem buffer is still not full. In 273 this case, we wrongly sends the content of mem buffer if we share 274 them for both cases. */ 275 int32_t pause_stream_id; /* stream ID which paused 276 nghttp2_session_mem_recv */ 277 size_t drain_total; /* sum of all stream's UrlState.drain */ 278 279 /* this is a hash of all individual streams (Curl_easy structs) */ 280 struct h2settings settings; 281 282 /* list of settings that will be sent */ 283 nghttp2_settings_entry local_settings[3]; 284 size_t local_settings_num; 285 #else 286 int unused; /* prevent a compiler warning */ 287 #endif 288 }; 289 290 CURLcode Curl_http_readwrite_headers(struct Curl_easy *data, 291 struct connectdata *conn, 292 ssize_t *nread, 293 bool *stop_reading); 294 295 /** 296 * Curl_http_output_auth() setups the authentication headers for the 297 * host/proxy and the correct authentication 298 * method. data->state.authdone is set to TRUE when authentication is 299 * done. 300 * 301 * @param data all information about the current transfer 302 * @param conn all information about the current connection 303 * @param request pointer to the request keyword 304 * @param httpreq is the request type 305 * @param path pointer to the requested path 306 * @param proxytunnel boolean if this is the request setting up a "proxy 307 * tunnel" 308 * 309 * @returns CURLcode 310 */ 311 CURLcode 312 Curl_http_output_auth(struct Curl_easy *data, 313 struct connectdata *conn, 314 const char *request, 315 Curl_HttpReq httpreq, 316 const char *path, 317 bool proxytunnel); /* TRUE if this is the request setting 318 up the proxy tunnel */ 319 320 /* 321 * Curl_allow_auth_to_host() tells if authentication, cookies or other 322 * "sensitive data" can (still) be sent to this host. 323 */ 324 bool Curl_allow_auth_to_host(struct Curl_easy *data); 325 326 #endif /* HEADER_CURL_HTTP_H */ 327