mirror of
https://github.com/curl/curl.git
synced 2024-11-27 05:50:21 +08:00
e3f335148a
curl_ws_recv() now receives data to fill up the provided buffer, but can return a partial fragment. The function now also get a pointer to a curl_ws_frame struct with metadata that also mentions the offset and total size of the fragment (of which you might be receiving a smaller piece). This way, large incoming fragments will be "streamed" to the application. When the curl_ws_frame struct field 'bytesleft' is 0, the final fragment piece has been delivered. curl_ws_recv() was also adjusted to work with a buffer size smaller than the fragment size. (Possibly needless to say as the fragment size can now be 63 bit large). curl_ws_send() now supports sending a piece of a fragment, in a streaming manner, in addition to sending the entire fragment in a single call if it is small enough. To send a huge fragment, curl_ws_send() can be used to send it in many small calls by first telling libcurl about the total expected fragment size, and then send the payload in N number of separate invokes and libcurl will stream those over the wire. The struct curl_ws_meta() returns is now called 'curl_ws_frame' and it has been extended with two new fields: *offset* and *bytesleft*. To help describe the passed on data chunk when a fragment is delivered in many smaller pieces. The documentation has been updated accordingly. Closes #9636
385 lines
14 KiB
C
385 lines
14 KiB
C
#ifndef HEADER_CURL_HTTP_H
|
|
#define HEADER_CURL_HTTP_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
#include "ws.h"
|
|
|
|
typedef enum {
|
|
HTTPREQ_GET,
|
|
HTTPREQ_POST,
|
|
HTTPREQ_POST_FORM, /* we make a difference internally */
|
|
HTTPREQ_POST_MIME, /* we make a difference internally */
|
|
HTTPREQ_PUT,
|
|
HTTPREQ_HEAD
|
|
} Curl_HttpReq;
|
|
|
|
#ifndef CURL_DISABLE_HTTP
|
|
|
|
#ifdef USE_NGHTTP2
|
|
#include <nghttp2/nghttp2.h>
|
|
#endif
|
|
|
|
#if defined(_WIN32) && defined(ENABLE_QUIC)
|
|
#include <stdint.h>
|
|
#endif
|
|
|
|
extern const struct Curl_handler Curl_handler_http;
|
|
|
|
#ifdef USE_SSL
|
|
extern const struct Curl_handler Curl_handler_https;
|
|
#endif
|
|
|
|
#ifdef USE_WEBSOCKETS
|
|
extern const struct Curl_handler Curl_handler_ws;
|
|
|
|
#ifdef USE_SSL
|
|
extern const struct Curl_handler Curl_handler_wss;
|
|
#endif
|
|
#endif /* websockets */
|
|
|
|
|
|
/* Header specific functions */
|
|
bool Curl_compareheader(const char *headerline, /* line to check */
|
|
const char *header, /* header keyword _with_ colon */
|
|
const size_t hlen, /* len of the keyword in bytes */
|
|
const char *content, /* content string to find */
|
|
const size_t clen); /* len of the content in bytes */
|
|
|
|
char *Curl_copy_header_value(const char *header);
|
|
|
|
char *Curl_checkProxyheaders(struct Curl_easy *data,
|
|
const struct connectdata *conn,
|
|
const char *thisheader,
|
|
const size_t thislen);
|
|
CURLcode Curl_buffer_send(struct dynbuf *in,
|
|
struct Curl_easy *data,
|
|
curl_off_t *bytes_written,
|
|
curl_off_t included_body_bytes,
|
|
int socketindex);
|
|
|
|
CURLcode Curl_add_timecondition(struct Curl_easy *data,
|
|
#ifndef USE_HYPER
|
|
struct dynbuf *req
|
|
#else
|
|
void *headers
|
|
#endif
|
|
);
|
|
CURLcode Curl_add_custom_headers(struct Curl_easy *data,
|
|
bool is_connect,
|
|
#ifndef USE_HYPER
|
|
struct dynbuf *req
|
|
#else
|
|
void *headers
|
|
#endif
|
|
);
|
|
CURLcode Curl_http_compile_trailers(struct curl_slist *trailers,
|
|
struct dynbuf *buf,
|
|
struct Curl_easy *handle);
|
|
|
|
void Curl_http_method(struct Curl_easy *data, struct connectdata *conn,
|
|
const char **method, Curl_HttpReq *);
|
|
CURLcode Curl_http_useragent(struct Curl_easy *data);
|
|
CURLcode Curl_http_host(struct Curl_easy *data, struct connectdata *conn);
|
|
CURLcode Curl_http_target(struct Curl_easy *data, struct connectdata *conn,
|
|
struct dynbuf *req);
|
|
CURLcode Curl_http_statusline(struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
CURLcode Curl_http_header(struct Curl_easy *data, struct connectdata *conn,
|
|
char *headp);
|
|
CURLcode Curl_transferencode(struct Curl_easy *data);
|
|
CURLcode Curl_http_body(struct Curl_easy *data, struct connectdata *conn,
|
|
Curl_HttpReq httpreq,
|
|
const char **teep);
|
|
CURLcode Curl_http_bodysend(struct Curl_easy *data, struct connectdata *conn,
|
|
struct dynbuf *r, Curl_HttpReq httpreq);
|
|
bool Curl_use_http_1_1plus(const struct Curl_easy *data,
|
|
const struct connectdata *conn);
|
|
#ifndef CURL_DISABLE_COOKIES
|
|
CURLcode Curl_http_cookies(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
struct dynbuf *r);
|
|
#else
|
|
#define Curl_http_cookies(a,b,c) CURLE_OK
|
|
#endif
|
|
CURLcode Curl_http_resume(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
Curl_HttpReq httpreq);
|
|
CURLcode Curl_http_range(struct Curl_easy *data,
|
|
Curl_HttpReq httpreq);
|
|
CURLcode Curl_http_firstwrite(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
bool *done);
|
|
|
|
/* protocol-specific functions set up to be called by the main engine */
|
|
CURLcode Curl_http(struct Curl_easy *data, bool *done);
|
|
CURLcode Curl_http_done(struct Curl_easy *data, CURLcode, bool premature);
|
|
CURLcode Curl_http_connect(struct Curl_easy *data, bool *done);
|
|
|
|
/* These functions are in http.c */
|
|
CURLcode Curl_http_input_auth(struct Curl_easy *data, bool proxy,
|
|
const char *auth);
|
|
CURLcode Curl_http_auth_act(struct Curl_easy *data);
|
|
|
|
/* If only the PICKNONE bit is set, there has been a round-trip and we
|
|
selected to use no auth at all. Ie, we actively select no auth, as opposed
|
|
to not having one selected. The other CURLAUTH_* defines are present in the
|
|
public curl/curl.h header. */
|
|
#define CURLAUTH_PICKNONE (1<<30) /* don't use auth */
|
|
|
|
/* MAX_INITIAL_POST_SIZE indicates the number of bytes that will make the POST
|
|
data get included in the initial data chunk sent to the server. If the
|
|
data is larger than this, it will automatically get split up in multiple
|
|
system calls.
|
|
|
|
This value used to be fairly big (100K), but we must take into account that
|
|
if the server rejects the POST due for authentication reasons, this data
|
|
will always be unconditionally sent and thus it may not be larger than can
|
|
always be afforded to send twice.
|
|
|
|
It must not be greater than 64K to work on VMS.
|
|
*/
|
|
#ifndef MAX_INITIAL_POST_SIZE
|
|
#define MAX_INITIAL_POST_SIZE (64*1024)
|
|
#endif
|
|
|
|
/* EXPECT_100_THRESHOLD is the request body size limit for when libcurl will
|
|
* automatically add an "Expect: 100-continue" header in HTTP requests. When
|
|
* the size is unknown, it will always add it.
|
|
*
|
|
*/
|
|
#ifndef EXPECT_100_THRESHOLD
|
|
#define EXPECT_100_THRESHOLD (1024*1024)
|
|
#endif
|
|
|
|
#endif /* CURL_DISABLE_HTTP */
|
|
|
|
#ifdef USE_NGHTTP3
|
|
struct h3out; /* see ngtcp2 */
|
|
#endif
|
|
|
|
#ifdef USE_MSH3
|
|
#ifdef _WIN32
|
|
#define msh3_lock CRITICAL_SECTION
|
|
#define msh3_lock_initialize(lock) InitializeCriticalSection(lock)
|
|
#define msh3_lock_uninitialize(lock) DeleteCriticalSection(lock)
|
|
#define msh3_lock_acquire(lock) EnterCriticalSection(lock)
|
|
#define msh3_lock_release(lock) LeaveCriticalSection(lock)
|
|
#else /* !_WIN32 */
|
|
#include <pthread.h>
|
|
#define msh3_lock pthread_mutex_t
|
|
#define msh3_lock_initialize(lock) { \
|
|
pthread_mutexattr_t attr; \
|
|
pthread_mutexattr_init(&attr); \
|
|
pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE); \
|
|
pthread_mutex_init(lock, &attr); \
|
|
pthread_mutexattr_destroy(&attr); \
|
|
}
|
|
#define msh3_lock_uninitialize(lock) pthread_mutex_destroy(lock)
|
|
#define msh3_lock_acquire(lock) pthread_mutex_lock(lock)
|
|
#define msh3_lock_release(lock) pthread_mutex_unlock(lock)
|
|
#endif /* _WIN32 */
|
|
#endif /* USE_MSH3 */
|
|
|
|
/****************************************************************************
|
|
* HTTP unique setup
|
|
***************************************************************************/
|
|
struct HTTP {
|
|
curl_mimepart *sendit;
|
|
curl_off_t postsize; /* off_t to handle large file sizes */
|
|
const char *postdata;
|
|
|
|
const char *p_pragma; /* Pragma: string */
|
|
|
|
/* For FORM posting */
|
|
curl_mimepart form;
|
|
|
|
struct back {
|
|
curl_read_callback fread_func; /* backup storage for fread pointer */
|
|
void *fread_in; /* backup storage for fread_in pointer */
|
|
const char *postdata;
|
|
curl_off_t postsize;
|
|
} backup;
|
|
|
|
enum {
|
|
HTTPSEND_NADA, /* init */
|
|
HTTPSEND_REQUEST, /* sending a request */
|
|
HTTPSEND_BODY /* sending body */
|
|
} sending;
|
|
|
|
#ifdef USE_WEBSOCKETS
|
|
struct websocket ws;
|
|
#endif
|
|
|
|
#ifndef CURL_DISABLE_HTTP
|
|
struct dynbuf send_buffer; /* used if the request couldn't be sent in one
|
|
chunk, points to an allocated send_buffer
|
|
struct */
|
|
#endif
|
|
#ifdef USE_NGHTTP2
|
|
/*********** for HTTP/2 we store stream-local data here *************/
|
|
int32_t stream_id; /* stream we are interested in */
|
|
|
|
/* We store non-final and final response headers here, per-stream */
|
|
struct dynbuf header_recvbuf;
|
|
size_t nread_header_recvbuf; /* number of bytes in header_recvbuf fed into
|
|
upper layer */
|
|
struct dynbuf trailer_recvbuf;
|
|
const uint8_t *pausedata; /* pointer to data received in on_data_chunk */
|
|
size_t pauselen; /* the number of bytes left in data */
|
|
bool close_handled; /* TRUE if stream closure is handled by libcurl */
|
|
|
|
char **push_headers; /* allocated array */
|
|
size_t push_headers_used; /* number of entries filled in */
|
|
size_t push_headers_alloc; /* number of entries allocated */
|
|
uint32_t error; /* HTTP/2 stream error code */
|
|
#endif
|
|
#if defined(USE_NGHTTP2) || defined(USE_NGHTTP3)
|
|
bool bodystarted;
|
|
int status_code; /* HTTP status code */
|
|
bool closed; /* TRUE on HTTP2 stream close */
|
|
char *mem; /* points to a buffer in memory to store received data */
|
|
size_t len; /* size of the buffer 'mem' points to */
|
|
size_t memlen; /* size of data copied to mem */
|
|
#endif
|
|
#if defined(USE_NGHTTP2) || defined(ENABLE_QUIC)
|
|
/* fields used by both HTTP/2 and HTTP/3 */
|
|
const uint8_t *upload_mem; /* points to a buffer to read from */
|
|
size_t upload_len; /* size of the buffer 'upload_mem' points to */
|
|
curl_off_t upload_left; /* number of bytes left to upload */
|
|
#endif
|
|
|
|
#ifdef ENABLE_QUIC
|
|
#ifndef USE_MSH3
|
|
/*********** for HTTP/3 we store stream-local data here *************/
|
|
int64_t stream3_id; /* stream we are interested in */
|
|
uint64_t error3; /* HTTP/3 stream error code */
|
|
bool firstheader; /* FALSE until headers arrive */
|
|
bool firstbody; /* FALSE until body arrives */
|
|
bool h3req; /* FALSE until request is issued */
|
|
#endif
|
|
bool upload_done;
|
|
#endif
|
|
#ifdef USE_NGHTTP3
|
|
size_t unacked_window;
|
|
struct h3out *h3out; /* per-stream buffers for upload */
|
|
struct dynbuf overflow; /* excess data received during a single Curl_read */
|
|
#endif
|
|
#ifdef USE_MSH3
|
|
struct MSH3_REQUEST *req;
|
|
msh3_lock recv_lock;
|
|
/* Receive Buffer (Headers and Data) */
|
|
uint8_t* recv_buf;
|
|
size_t recv_buf_alloc;
|
|
/* Receive Headers */
|
|
size_t recv_header_len;
|
|
bool recv_header_complete;
|
|
/* Receive Data */
|
|
size_t recv_data_len;
|
|
bool recv_data_complete;
|
|
/* General Receive Error */
|
|
CURLcode recv_error;
|
|
#endif
|
|
};
|
|
|
|
#ifdef USE_NGHTTP2
|
|
/* h2 settings for this connection */
|
|
struct h2settings {
|
|
uint32_t max_concurrent_streams;
|
|
bool enable_push;
|
|
};
|
|
#endif
|
|
|
|
struct http_conn {
|
|
#ifdef USE_NGHTTP2
|
|
#define H2_BINSETTINGS_LEN 80
|
|
uint8_t binsettings[H2_BINSETTINGS_LEN];
|
|
size_t binlen; /* length of the binsettings data */
|
|
|
|
/* We associate the connnectdata struct with the connection, but we need to
|
|
make sure we can identify the current "driving" transfer. This is a
|
|
work-around for the lack of nghttp2_session_set_user_data() in older
|
|
nghttp2 versions that we want to support. (Added in 1.31.0) */
|
|
struct Curl_easy *trnsfr;
|
|
|
|
nghttp2_session *h2;
|
|
Curl_send *send_underlying; /* underlying send Curl_send callback */
|
|
Curl_recv *recv_underlying; /* underlying recv Curl_recv callback */
|
|
char *inbuf; /* buffer to receive data from underlying socket */
|
|
size_t inbuflen; /* number of bytes filled in inbuf */
|
|
size_t nread_inbuf; /* number of bytes read from in inbuf */
|
|
/* We need separate buffer for transmission and reception because we
|
|
may call nghttp2_session_send() after the
|
|
nghttp2_session_mem_recv() but mem buffer is still not full. In
|
|
this case, we wrongly sends the content of mem buffer if we share
|
|
them for both cases. */
|
|
int32_t pause_stream_id; /* stream ID which paused
|
|
nghttp2_session_mem_recv */
|
|
size_t drain_total; /* sum of all stream's UrlState.drain */
|
|
|
|
/* this is a hash of all individual streams (Curl_easy structs) */
|
|
struct h2settings settings;
|
|
|
|
/* list of settings that will be sent */
|
|
nghttp2_settings_entry local_settings[3];
|
|
size_t local_settings_num;
|
|
#else
|
|
int unused; /* prevent a compiler warning */
|
|
#endif
|
|
};
|
|
|
|
CURLcode Curl_http_size(struct Curl_easy *data);
|
|
|
|
CURLcode Curl_http_readwrite_headers(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
ssize_t *nread,
|
|
bool *stop_reading);
|
|
|
|
/**
|
|
* Curl_http_output_auth() setups the authentication headers for the
|
|
* host/proxy and the correct authentication
|
|
* method. data->state.authdone is set to TRUE when authentication is
|
|
* done.
|
|
*
|
|
* @param data all information about the current transfer
|
|
* @param conn all information about the current connection
|
|
* @param request pointer to the request keyword
|
|
* @param httpreq is the request type
|
|
* @param path pointer to the requested path
|
|
* @param proxytunnel boolean if this is the request setting up a "proxy
|
|
* tunnel"
|
|
*
|
|
* @returns CURLcode
|
|
*/
|
|
CURLcode
|
|
Curl_http_output_auth(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
const char *request,
|
|
Curl_HttpReq httpreq,
|
|
const char *path,
|
|
bool proxytunnel); /* TRUE if this is the request setting
|
|
up the proxy tunnel */
|
|
|
|
#endif /* HEADER_CURL_HTTP_H */
|