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