3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2003, Daniel Stenberg, <daniel@haxx.se>, et al.
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 http://curl.haxx.se/docs/copyright.html.
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.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
24 ***************************************************************************/
26 /* This file is for lib internal stuff */
31 #define PORT_TELNET 23
32 #define PORT_GOPHER 70
34 #define PORT_HTTPS 443
35 #define PORT_DICT 2628
38 #define DICT_MATCH "/MATCH:"
39 #define DICT_MATCH2 "/M:"
40 #define DICT_MATCH3 "/FIND:"
41 #define DICT_DEFINE "/DEFINE:"
42 #define DICT_DEFINE2 "/D:"
43 #define DICT_DEFINE3 "/LOOKUP:"
45 #define CURL_DEFAULT_USER "anonymous"
46 #define CURL_DEFAULT_PASSWORD "curl_by_daniel@haxx.se"
52 /* SSLeay stuff usually in /usr/local/ssl/include */
54 #include "openssl/rsa.h"
55 #include "openssl/crypto.h"
56 #include "openssl/x509.h"
57 #include "openssl/pem.h"
58 #include "openssl/ssl.h"
59 #include "openssl/err.h"
60 #ifdef HAVE_OPENSSL_ENGINE_H
61 #include <openssl/engine.h>
73 #ifdef HAVE_NETINET_IN_H
74 #include <netinet/in.h>
79 #include <curl/curl.h>
81 #include "http_chunks.h" /* for the structs and enum stuff */
86 #include <zlib.h> /* for content-encoding 08/28/02 jhrg */
89 /* Download buffer size, keep it fairly big for speed reasons */
90 #define BUFSIZE CURL_MAX_WRITE_SIZE
92 /* Initial size of the buffer to store headers in, it'll be enlarged in case
94 #define HEADERSIZE 256
96 /* Just a convenience macro to get the larger value out of two given */
98 #define MAX(x,y) ((x)>(y)?(x):(y))
102 /* Types needed for krb4-ftp connections */
109 enum protection_level {
117 /* struct for data related to SSL and SSL connections */
118 struct ssl_connect_data {
119 bool use; /* use ssl encrypted communications TRUE/FALSE */
121 /* these ones requires specific SSL-types */
125 #endif /* USE_SSLEAY */
128 /* information about one single SSL session */
129 struct curl_ssl_session {
130 char *name; /* host name for which this ID was used */
131 void *sessionid; /* as returned from the SSL layer */
132 long age; /* just a number, the higher the more recent */
133 unsigned short remote_port; /* remote port to connect to */
136 struct ssl_config_data {
137 long version; /* what version the client wants to use */
138 long certverifyresult; /* result from the certificate verification */
139 long verifypeer; /* set TRUE if this is desired */
140 long verifyhost; /* 0: no verify
141 1: check that CN exists
142 2: CN must match hostname */
143 char *CApath; /* DOES NOT WORK ON WINDOWS */
144 char *CAfile; /* cerficate to verify peer against */
145 char *random_file; /* path to file containing "random" data */
146 char *egdsocket; /* path to file containing the EGD daemon socket */
147 char *cipher_list; /* list of ciphers to use */
148 long numsessions; /* SSL session id cache size */
151 /****************************************************************************
153 ***************************************************************************/
155 struct FormData *sendit;
159 const char *p_pragma; /* Pragma: string */
160 const char *p_accept; /* Accept: string */
164 /* For FORM posting */
166 struct Curl_chunker chunk;
169 curl_read_callback fread; /* backup storage for fread pointer */
170 void *fread_in; /* backup storage for fread_in pointer */
176 HTTPSEND_NADA, /* init */
177 HTTPSEND_REQUEST, /* sending a request */
178 HTTPSEND_BODY, /* sending body */
179 HTTPSEND_LAST /* never use this */
182 void *send_buffer; /* used if the request couldn't be sent in one chunk,
183 points to an allocated send_buffer struct */
186 /****************************************************************************
188 ***************************************************************************/
191 char *user; /* user name string */
192 char *passwd; /* password string */
193 char *urlpath; /* the originally given path part of the URL */
194 char *dir; /* decoded directory */
195 char *file; /* decoded file */
197 char *entrypath; /* the PWD reply when we logged on */
199 char *cache; /* data cache between getresponse()-calls */
200 size_t cache_size; /* size of cache in bytes */
201 bool dont_check; /* Set to TRUE to prevent the final (post-transfer)
202 file size and 226/250 status check. It should still
203 read the line, just ignore the result. */
204 bool no_transfer; /* nothing was transfered, (possibly because a resumed
205 transfer already was complete) */
206 long response_time; /* When no timeout is given, this is the amount of
207 seconds we await for an FTP response. Initialized
208 in Curl_ftp_connect() */
211 /****************************************************************************
213 ***************************************************************************/
215 int fd; /* open file descriptor to read from! */
219 * Boolean values that concerns this connection.
222 bool close; /* if set, we close the connection after this request */
223 bool reuse; /* if set, this is a re-used connection */
224 bool chunk; /* if set, this is a chunked transfer-encoding */
225 bool httpproxy; /* if set, this transfer is done through a http proxy */
226 bool user_passwd; /* do we use user+password for this connection? */
227 bool proxy_user_passwd; /* user+password for the proxy? */
228 bool ipv6_ip; /* we communicate with a remove site specified with pure IPv6
231 bool rangestringalloc; /* the range string is malloc()'ed */
233 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
234 supposed to be called, after ->curl_do() */
236 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
238 bool getheader; /* TRUE if header parsing is wanted */
240 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
241 specific upload buffers. See readmoredata() in
242 http.c for details. */
243 bool tcpconnect; /* the tcp stream (or simimlar) is connected, this
244 is set the first time on the first connect function
249 * This struct is all the previously local variables from Curl_perform() moved
250 * to struct to allow the function to return and get re-invoked better without
254 struct Curl_transfer_keeper {
255 int bytecount; /* total number of bytes read */
256 int writebytecount; /* number of bytes written */
257 long contentlength; /* size of incoming data */
258 struct timeval start; /* transfer started at this time */
259 struct timeval now; /* current time */
260 bool header; /* incoming data has HTTP header */
262 HEADER_NORMAL, /* no bad header at all */
263 HEADER_PARTHEADER, /* part of the chunk is a bad header, the rest is
265 HEADER_ALLBAD /* all was believed to be header */
266 } badheader; /* the header was deemed bad and will be
268 int headerline; /* counts header lines to better track the
270 char *hbufp; /* points at *end* of header line */
272 char *str; /* within buf */
273 char *str_start; /* within buf */
274 char *end_ptr; /* within buf */
275 char *p; /* within headerbuff */
276 bool content_range; /* set TRUE if Content-Range: was found */
277 int offset; /* possible resume offset read from the
278 Content-Range: header */
279 int httpcode; /* error code from the 'HTTP/1.? XXX' line */
280 int httpversion; /* the HTTP version*10 */
281 struct timeval start100; /* time stamp to wait for the 100 code from */
282 bool write_after_100_header; /* TRUE = we enable the write after we
283 received a 100-continue/timeout or
285 bool wait100_after_headers; /* TRUE = after the request-headers have been
286 sent off properly, we go into the wait100
287 state, FALSE = don't */
288 int content_encoding; /* What content encoding. sec 3.5, RFC2616. */
290 #define IDENTITY 0 /* No encoding */
291 #define DEFLATE 1 /* zlib delfate [RFC 1950 & 1951] */
292 #define GZIP 2 /* gzip algorithm [RFC 1952] */
293 #define COMPRESS 3 /* Not handled, added for completeness */
296 bool zlib_init; /* True if zlib already initialized;
297 undefined if Content-Encdoing header. */
298 z_stream z; /* State structure for zlib. */
301 /* for the low speed checks: */
310 /* pointers to the actual descriptors we check */
314 /* the file descriptors to play with */
321 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
322 and we're uploading the last chunk */
327 * The connectdata struct contains all fields and variables that should be
328 * unique for an entire connection.
331 /**** Fields set when inited and not modified again */
332 struct SessionHandle *data; /* link to the root CURL struct */
333 int connectindex; /* what index in the connects index this particular
336 long protocol; /* PROT_* flags concerning the protocol set */
337 #define PROT_MISSING (1<<0)
338 #define PROT_GOPHER (1<<1)
339 #define PROT_HTTP (1<<2)
340 #define PROT_HTTPS (1<<3)
341 #define PROT_FTP (1<<4)
342 #define PROT_TELNET (1<<5)
343 #define PROT_DICT (1<<6)
344 #define PROT_LDAP (1<<7)
345 #define PROT_FILE (1<<8)
346 #define PROT_FTPS (1<<9)
347 #define PROT_SSL (1<<10) /* protocol requires SSL */
349 /* the particular host we use, in two different ways */
350 struct Curl_dns_entry *connect_addr;
353 struct addrinfo *serv_addr;
355 struct sockaddr_in serv_addr;
357 char protostr[64]; /* store the protocol string in this buffer */
358 char gname[513]; /* store the hostname in this buffer */
359 char *name; /* host name pointer to fool around with */
360 char *path; /* allocated buffer to store the URL's path part in */
361 char *hostname; /* hostname to connect, as parsed from url */
362 long port; /* which port to use locally */
363 unsigned short remote_port; /* what remote port to connect to,
364 not the proxy port! */
367 long headerbytecount; /* only count received headers */
369 char *range; /* range, if used. See README for detailed specification on
371 ssize_t resume_from; /* continue [ftp] transfer from here */
373 char *proxyhost; /* name of the http proxy host */
375 struct timeval now; /* "current" time */
376 struct timeval created; /* creation time */
377 int firstsocket; /* the main socket to use */
378 int secondarysocket; /* for i.e ftp transfers */
379 long maxdownload; /* in bytes, the maximum amount of data to fetch, 0
382 struct ssl_connect_data ssl; /* this is for ssl-stuff */
384 struct ConnectBits bits; /* various state-flags for this connection */
386 /* These two functions MUST be set by the curl_connect() function to be
387 be protocol dependent */
388 CURLcode (*curl_do)(struct connectdata *connect);
389 CURLcode (*curl_done)(struct connectdata *connect);
391 /* If the curl_do() function is better made in two halves, this
392 * curl_do_more() function will be called afterwards, if set. For example
393 * for doing the FTP stuff after the PASV/PORT command.
395 CURLcode (*curl_do_more)(struct connectdata *connect);
397 /* This function *MAY* be set to a protocol-dependent function that is run
398 * after the connect() and everything is done, as a step in the connection.
400 CURLcode (*curl_connect)(struct connectdata *connect);
402 /* This function *MAY* be set to a protocol-dependent function that is run
403 * by the curl_disconnect(), as a step in the disconnection.
405 CURLcode (*curl_disconnect)(struct connectdata *connect);
407 /* This function *MAY* be set to a protocol-dependent function that is run
408 * in the curl_close() function if protocol-specific cleanups are required.
410 CURLcode (*curl_close)(struct connectdata *connect);
412 /**** curl_get() phase fields */
415 int sockfd; /* socket to read from or -1 */
416 int size; /* -1 if unknown at this point */
417 long *bytecountp; /* return number of bytes read or NULL */
420 int writesockfd; /* socket to write to, it may very well be
421 the same we read from. -1 disables */
422 long *writebytecountp; /* return number of bytes written or NULL */
424 /** Dynamicly allocated strings, may need to be freed before this **/
425 /** struct is killed. **/
426 struct dynamically_allocated_data {
427 char *proxyuserpwd; /* free later if not NULL! */
428 char *uagent; /* free later if not NULL! */
429 char *accept_encoding; /* free later if not NULL! 08/28/02 jhrg */
430 char *userpwd; /* free later if not NULL! */
431 char *rangeline; /* free later if not NULL! */
432 char *ref; /* free later if not NULL! */
433 char *cookie; /* free later if not NULL! */
434 char *host; /* free later if not NULL */
437 char *newurl; /* This can only be set if a Location: was in the
441 enum protection_level command_prot;
442 enum protection_level data_prot;
443 enum protection_level request_data_prot;
447 struct krb4buffer in_buffer, out_buffer;
451 struct Curl_sec_client_mech *mech;
452 struct sockaddr_in local_addr;
456 /*************** Request - specific items ************/
457 /* previously this was in the urldata struct */
460 struct HTTP *gopher; /* alias, just for the sake of being more readable */
461 struct HTTP *https; /* alias, just for the sake of being more readable */
464 void *telnet; /* private for telnet.c-eyes only */
465 #if 0 /* no need for special ones for these: */
472 /* This struct is inited when needed */
473 struct Curl_transfer_keeper keep;
475 /* 'upload_present' is used to keep a byte counter of how much data there is
476 still left in the buffer, aimed for upload. */
479 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
480 buffer, so the next read should read from where this pointer points to,
481 and the 'upload_present' contains the number of bytes available at this
483 char *upload_fromhere;
485 curl_read_callback fread; /* function that reads the input */
486 void *fread_in; /* pointer to pass to the fread() above */
489 /* The end of connectdata. 08/27/02 jhrg */
492 * Struct to keep statistical and informational data.
497 long filetime; /* If requested, this is might get set. Set to -1 if
498 the time was unretrievable */
499 long header_size; /* size of read header(s) in bytes */
500 long request_size; /* the amount of bytes sent in the request(s) */
502 char *contenttype; /* the content type of the object */
507 long lastshow; /* time() of the last displayed progress meter or NULL to
508 force redraw at next call */
514 double current_speed; /* uses the currently fastest transfer */
516 bool callback; /* set when progress callback is used */
517 int width; /* screen width at download start */
518 int flags; /* see progress.h */
527 double t_pretransfer;
528 double t_starttransfer;
531 struct timeval start;
532 struct timeval t_startsingle;
533 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
535 double speeder[ CURR_TIME ];
536 struct timeval speeder_time[ CURR_TIME ];
541 HTTPREQ_NONE, /* first in list */
544 HTTPREQ_POST_FORM, /* we make a difference internally */
547 HTTPREQ_LAST /* last in list */
551 * Values that are generated, temporary or calculated internally for a
552 * "session handle" must be defined within the 'struct urlstate'. This struct
553 * will be used within the SessionHandle struct. When the 'SessionHandle'
554 * struct is cloned, this data MUST NOT be copied.
556 * Remember that any "state" information goes globally for the curl handle.
557 * Session-data MUST be put in the connectdata struct and here. */
558 #define MAX_CURL_USER_LENGTH 256
559 #define MAX_CURL_PASSWORD_LENGTH 256
568 /* buffers to store authentication data in, as parsed from input options */
569 char user[MAX_CURL_USER_LENGTH];
570 char passwd[MAX_CURL_PASSWORD_LENGTH];
571 char proxyuser[MAX_CURL_USER_LENGTH];
572 char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
574 bool passwdgiven; /* set TRUE if an application-provided password has been
577 struct timeval keeps_speed; /* for the progress meter really */
579 /* 'connects' will be an allocated array with pointers. If the pointer is
580 set, it holds an allocated connection. */
581 struct connectdata **connects;
582 long numconnects; /* size of the 'connects' array */
584 char *headerbuff; /* allocated buffer to store headers in */
585 int headersize; /* size of the allocation */
587 char buffer[BUFSIZE+1]; /* download buffer */
588 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
589 double current_speed; /* the ProgressShow() funcion sets this */
591 bool this_is_a_follow; /* this is a followed Location: request */
593 char *auth_host; /* if set, this should be the host name that we will
594 sent authorization to, no else. Used to make Location:
595 following not keep sending user+password... This is
599 struct curl_ssl_session *session; /* array of 'numsessions' size */
600 long sessionage; /* number of the most recent session */
602 char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
603 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
604 This must be set to FALSE every time _easy_perform() is
608 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
609 void (*prev_signal)(int sig);
611 bool allow_port; /* Is set.use_port allowed to take effect or not. This
612 is always set TRUE when curl_easy_perform() is called. */
617 * This 'DynamicStatic' struct defines dynamic states that actually change
618 * values in the 'UserDefined' area, which MUST be taken into consideration
619 * if the UserDefined struct is cloned or similar. You can probably just
620 * copy these, but each one indicate a special action on other data.
623 struct DynamicStatic {
624 char *url; /* work URL, copied from UserDefined */
625 bool url_alloc; /* URL string is malloc()'ed */
626 char *proxy; /* work proxy, copied from UserDefined */
627 bool proxy_alloc; /* http proxy string is malloc()'ed */
628 char *referer; /* referer string */
629 bool referer_alloc; /* referer sting is malloc()ed */
630 struct curl_slist *cookielist; /* list of cookie files set by
631 curl_easy_setopt(COOKIEFILE) calls */
635 * This 'UserDefined' struct must only contain data that is set once to go
636 * for many (perhaps) independent connections. Values that are generated or
637 * calculated internally for the "session handle" MUST be defined within the
638 * 'struct urlstate' instead. The only exceptions MUST note the changes in
639 * the 'DynamicStatic' struct.
643 FILE *err; /* the stderr user data goes here */
644 void *debugdata; /* the data that will be passed to fdebug */
645 char *errorbuffer; /* store failure messages in here */
646 char *proxyuserpwd; /* Proxy <user:password>, if used */
647 long proxyport; /* If non-zero, use this port number by default. If the
648 proxy string features a ":[port]" that one will override
650 void *out; /* the fetched file goes here */
651 void *in; /* the uploaded file is read from here */
652 void *writeheader; /* write the header to this is non-NULL */
653 char *set_url; /* what original URL to work on */
654 char *set_proxy; /* proxy to use */
655 long use_port; /* which port to use (when not using default) */
656 char *userpwd; /* <user:password>, if used */
657 char *set_range; /* range, if used. See README for detailed specification
659 long followlocation; /* as in HTTP Location: */
660 long maxredirs; /* maximum no. of http(s) redirects to follow */
661 char *set_referer; /* custom string */
662 bool free_referer; /* set TRUE if 'referer' points to a string we
664 char *useragent; /* User-Agent string */
665 char *encoding; /* Accept-Encoding string */
666 char *postfields; /* if POST, set the fields' values here */
667 size_t postfieldsize; /* if POST, this might have a size to use instead of
668 strlen(), and then the data *may* be binary (contain
670 char *ftpport; /* port to send with the FTP PORT command */
671 char *device; /* network interface to use */
672 curl_write_callback fwrite; /* function that stores the output */
673 curl_write_callback fwrite_header; /* function that stores headers */
674 curl_read_callback fread; /* function that reads the input */
675 curl_progress_callback fprogress; /* function for progress information */
676 curl_debug_callback fdebug; /* function that write informational data */
677 void *progress_client; /* pointer to pass to the progress callback */
678 curl_passwd_callback fpasswd; /* call for password */
679 void *passwd_client; /* pass to the passwd callback */
680 long timeout; /* in seconds, 0 means no timeout */
681 long connecttimeout; /* in seconds, 0 means no timeout */
682 long infilesize; /* size of file to upload, -1 means unknown */
683 long low_speed_limit; /* bytes/second */
684 long low_speed_time; /* number of seconds */
685 int set_resume_from; /* continue [ftp] transfer from here */
686 char *cookie; /* HTTP cookie string to send */
687 struct curl_slist *headers; /* linked list of extra headers */
688 struct HttpPost *httppost; /* linked list of POST data */
689 char *cert; /* certificate */
690 char *cert_type; /* format for certificate (default: PEM) */
691 char *key; /* private key */
692 char *key_type; /* format for private key (default: PEM) */
693 char *key_passwd; /* plain text private key password */
694 char *crypto_engine; /* name of the crypto engine to use */
695 char *cookiejar; /* dump all cookies to this file */
696 bool cookiesession; /* new cookie session? */
697 bool crlf; /* convert crlf on ftp upload(?) */
698 struct curl_slist *quote; /* after connection is established */
699 struct curl_slist *postquote; /* after the transfer */
700 struct curl_slist *prequote; /* before the transfer, after type (Wesley Laxton)*/
701 struct curl_slist *telnet_options; /* linked list of telnet options */
702 curl_TimeCond timecondition; /* kind of time/date comparison */
703 time_t timevalue; /* what time to compare with */
704 curl_closepolicy closepolicy; /* connection cache close concept */
705 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
706 char *customrequest; /* HTTP/FTP request to use */
707 long httpversion; /* when non-zero, a specific HTTP version requested to
708 be used in the library's request(s) */
709 char *auth_host; /* if set, this is the allocated string to the host name
710 * to which to send the authorization data to, and no other
711 * host (which location-following otherwise could lead to)
713 char *krb4_level; /* what security level */
714 struct ssl_config_data ssl; /* user defined SSL stuff */
716 curl_proxytype proxytype; /* what kind of proxy that is in use */
718 int dns_cache_timeout; /* DNS cache timeout */
719 long buffer_size; /* size of receive buffer to use */
721 char *private; /* Private data */
723 struct curl_slist *http200aliases; /* linked list of aliases for http200 */
725 /* Here follows boolean settings that define how to behave during
726 this session. They are STATIC, set by libcurl users or at least initially
727 and they don't change during operations. */
730 bool tunnel_thru_httpproxy;
736 bool http_fail_on_error;
737 bool http_follow_location;
739 #define http_include_header include_header /* former name */
741 bool http_set_referer;
742 bool http_auto_referer; /* set "correct" referer when following location: */
746 enum CURL_NETRC_OPTION
747 use_netrc; /* defined in include/curl.h */
749 bool krb4; /* kerberos4 connection requested */
750 bool reuse_forbid; /* forbidden to be reused, close after use */
751 bool reuse_fresh; /* do not re-use an existing connection */
752 bool expect100header; /* TRUE if we added Expect: 100-continue */
753 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
754 bool no_signal; /* do not use any signal/alarm handler */
756 bool global_dns_cache;
760 * In August 2001, this struct was redesigned and is since stricter than
761 * before. The 'connectdata' struct MUST have all the connection oriented
762 * stuff as we may now have several simultaneous connections and connection
765 * From now on, the 'SessionHandle' must only contain data that is set once to
766 * go for many (perhaps) independent connections. Values that are generated or
767 * calculated internally for the "session handle" must be defined within the
768 * 'struct urlstate' instead. */
770 struct SessionHandle {
771 curl_hash *hostcache;
772 struct Curl_share *share; /* Share, handles global variable mutexing */
773 struct UserDefined set; /* values set by the libcurl user */
774 struct DynamicStatic change; /* possibly modified userdefined data */
776 struct CookieInfo *cookies; /* the cookies, read from files and servers */
777 struct Progress progress; /* for all the progress meter data */
778 struct UrlState state; /* struct for fields used for state info and
779 other dynamic purposes */
780 struct PureInfo info; /* stats, reports and info data */
781 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
783 #endif /* USE_SSLEAY */
786 #define LIBCURL_NAME "libcurl"