• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #ifndef HEADER_CURL_HTTP_H
2 #define HEADER_CURL_HTTP_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) 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  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 #include "curl_setup.h"
27 
28 #if defined(USE_MSH3) && !defined(_WIN32)
29 #include <pthread.h>
30 #endif
31 
32 #include "bufq.h"
33 #include "dynhds.h"
34 #include "ws.h"
35 
36 typedef enum {
37   HTTPREQ_GET,
38   HTTPREQ_POST,
39   HTTPREQ_POST_FORM, /* we make a difference internally */
40   HTTPREQ_POST_MIME, /* we make a difference internally */
41   HTTPREQ_PUT,
42   HTTPREQ_HEAD
43 } Curl_HttpReq;
44 
45 
46 /* When redirecting transfers. */
47 typedef enum {
48   FOLLOW_NONE,  /* not used within the function, just a placeholder to
49                    allow initing to this */
50   FOLLOW_FAKE,  /* only records stuff, not actually following */
51   FOLLOW_RETRY, /* set if this is a request retry as opposed to a real
52                    redirect following */
53   FOLLOW_REDIR /* a full true redirect */
54 } followtype;
55 
56 
57 #ifndef CURL_DISABLE_HTTP
58 
59 #if defined(USE_HTTP3)
60 #include <stdint.h>
61 #endif
62 
63 extern const struct Curl_handler Curl_handler_http;
64 
65 #ifdef USE_SSL
66 extern const struct Curl_handler Curl_handler_https;
67 #endif
68 
69 struct dynhds;
70 
71 CURLcode Curl_bump_headersize(struct Curl_easy *data,
72                               size_t delta,
73                               bool connect_only);
74 
75 /* Header specific functions */
76 bool Curl_compareheader(const char *headerline,  /* line to check */
77                         const char *header,   /* header keyword _with_ colon */
78                         const size_t hlen,   /* len of the keyword in bytes */
79                         const char *content, /* content string to find */
80                         const size_t clen);   /* len of the content in bytes */
81 
82 char *Curl_copy_header_value(const char *header);
83 
84 char *Curl_checkProxyheaders(struct Curl_easy *data,
85                              const struct connectdata *conn,
86                              const char *thisheader,
87                              const size_t thislen);
88 
89 CURLcode Curl_add_timecondition(struct Curl_easy *data, struct dynbuf *req);
90 CURLcode Curl_add_custom_headers(struct Curl_easy *data, bool is_connect,
91                                  int httpversion, struct dynbuf *req);
92 CURLcode Curl_dynhds_add_custom(struct Curl_easy *data, bool is_connect,
93                                 struct dynhds *hds);
94 
95 void Curl_http_method(struct Curl_easy *data, struct connectdata *conn,
96                       const char **method, Curl_HttpReq *);
97 
98 /* protocol-specific functions set up to be called by the main engine */
99 CURLcode Curl_http_setup_conn(struct Curl_easy *data,
100                               struct connectdata *conn);
101 CURLcode Curl_http(struct Curl_easy *data, bool *done);
102 CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature);
103 CURLcode Curl_http_connect(struct Curl_easy *data, bool *done);
104 int Curl_http_getsock_do(struct Curl_easy *data, struct connectdata *conn,
105                          curl_socket_t *socks);
106 CURLcode Curl_http_write_resp(struct Curl_easy *data,
107                               const char *buf, size_t blen,
108                               bool is_eos);
109 CURLcode Curl_http_write_resp_hd(struct Curl_easy *data,
110                                  const char *hd, size_t hdlen,
111                                  bool is_eos);
112 
113 /* These functions are in http.c */
114 CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy,
115                               const char *auth);
116 CURLcode Curl_http_auth_act(struct Curl_easy *data);
117 
118 /* follow a redirect or not */
119 CURLcode Curl_http_follow(struct Curl_easy *data, const char *newurl,
120                           followtype type);
121 
122 /* If only the PICKNONE bit is set, there has been a round-trip and we
123    selected to use no auth at all. Ie, we actively select no auth, as opposed
124    to not having one selected. The other CURLAUTH_* defines are present in the
125    public curl/curl.h header. */
126 #define CURLAUTH_PICKNONE (1<<30) /* do not use auth */
127 
128 /* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
129    data get included in the initial data chunk sent to the server. If the
130    data is larger than this, it will automatically get split up in multiple
131    system calls.
132 
133    This value used to be fairly big (100K), but we must take into account that
134    if the server rejects the POST due for authentication reasons, this data
135    will always be unconditionally sent and thus it may not be larger than can
136    always be afforded to send twice.
137 
138    It must not be greater than 64K to work on VMS.
139 */
140 #ifndef MAX_INITIAL_POST_SIZE
141 #define MAX_INITIAL_POST_SIZE (64*1024)
142 #endif
143 
144 /* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
145  * automatically add an "Expect: 100-continue" header in HTTP requests. When
146  * the size is unknown, it will always add it.
147  *
148  */
149 #ifndef EXPECT_100_THRESHOLD
150 #define EXPECT_100_THRESHOLD (1024*1024)
151 #endif
152 
153 /* MAX_HTTP_RESP_HEADER_SIZE is the maximum size of all response headers
154    combined that libcurl allows for a single HTTP response, any HTTP
155    version. This count includes CONNECT response headers. */
156 #define MAX_HTTP_RESP_HEADER_SIZE (300*1024)
157 
158 
159 #endif /* CURL_DISABLE_HTTP */
160 
161 /****************************************************************************
162  * HTTP unique setup
163  ***************************************************************************/
164 
165 CURLcode Curl_http_write_resp_hds(struct Curl_easy *data,
166                                   const char *buf, size_t blen,
167                                   size_t *pconsumed);
168 
169 /**
170  * Curl_http_output_auth() setups the authentication headers for the
171  * host/proxy and the correct authentication
172  * method. data->state.authdone is set to TRUE when authentication is
173  * done.
174  *
175  * @param data all information about the current transfer
176  * @param conn all information about the current connection
177  * @param request pointer to the request keyword
178  * @param httpreq is the request type
179  * @param path pointer to the requested path
180  * @param proxytunnel boolean if this is the request setting up a "proxy
181  * tunnel"
182  *
183  * @returns CURLcode
184  */
185 CURLcode
186 Curl_http_output_auth(struct Curl_easy *data,
187                       struct connectdata *conn,
188                       const char *request,
189                       Curl_HttpReq httpreq,
190                       const char *path,
191                       bool proxytunnel); /* TRUE if this is the request setting
192                                             up the proxy tunnel */
193 
194 /* Decode HTTP status code string. */
195 CURLcode Curl_http_decode_status(int *pstatus, const char *s, size_t len);
196 
197 
198 /**
199  * All about a core HTTP request, excluding body and trailers
200  */
201 struct httpreq {
202   char method[24];
203   char *scheme;
204   char *authority;
205   char *path;
206   struct dynhds headers;
207   struct dynhds trailers;
208 };
209 
210 /**
211  * Create an HTTP request struct.
212  */
213 CURLcode Curl_http_req_make(struct httpreq **preq,
214                             const char *method, size_t m_len,
215                             const char *scheme, size_t s_len,
216                             const char *authority, size_t a_len,
217                             const char *path, size_t p_len);
218 
219 CURLcode Curl_http_req_make2(struct httpreq **preq,
220                              const char *method, size_t m_len,
221                              CURLU *url, const char *scheme_default);
222 
223 void Curl_http_req_free(struct httpreq *req);
224 
225 #define HTTP_PSEUDO_METHOD ":method"
226 #define HTTP_PSEUDO_SCHEME ":scheme"
227 #define HTTP_PSEUDO_AUTHORITY ":authority"
228 #define HTTP_PSEUDO_PATH ":path"
229 #define HTTP_PSEUDO_STATUS ":status"
230 
231 /**
232  * Create the list of HTTP/2 headers which represent the request,
233  * using HTTP/2 pseudo headers preceding the `req->headers`.
234  *
235  * Applies the following transformations:
236  * - if `authority` is set, any "Host" header is removed.
237  * - if `authority` is unset and a "Host" header is present, use
238  *   that as `authority` and remove "Host"
239  * - removes and Connection header fields as defined in rfc9113 ch. 8.2.2
240  * - lower-cases the header field names
241  *
242  * @param h2_headers will contain the HTTP/2 headers on success
243  * @param req        the request to transform
244  * @param data       the handle to lookup defaults like ' :scheme' from
245  */
246 CURLcode Curl_http_req_to_h2(struct dynhds *h2_headers,
247                              struct httpreq *req, struct Curl_easy *data);
248 
249 /**
250  * All about a core HTTP response, excluding body and trailers
251  */
252 struct http_resp {
253   int status;
254   char *description;
255   struct dynhds headers;
256   struct dynhds trailers;
257   struct http_resp *prev;
258 };
259 
260 /**
261  * Create an HTTP response struct.
262  */
263 CURLcode Curl_http_resp_make(struct http_resp **presp,
264                              int status,
265                              const char *description);
266 
267 void Curl_http_resp_free(struct http_resp *resp);
268 
269 #endif /* HEADER_CURL_HTTP_H */
270