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