3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2002, 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 #ifndef HAVE_OPENSSL_ENGINE_H
120 /* struct for data related to SSL and SSL connections */
121 struct ssl_connect_data {
122 bool use; /* use ssl encrypted communications TRUE/FALSE */
124 /* these ones requires specific SSL-types */
128 #endif /* USE_SSLEAY */
131 /* information about one single SSL session */
132 struct curl_ssl_session {
133 char *name; /* host name for which this ID was used */
134 void *sessionid; /* as returned from the SSL layer */
135 long age; /* just a number, the higher the more recent */
136 unsigned short remote_port; /* remote port to connect to */
139 struct ssl_config_data {
140 long version; /* what version the client wants to use */
141 long certverifyresult; /* result from the certificate verification */
142 long verifypeer; /* set TRUE if this is desired */
143 long verifyhost; /* 0: no verify
144 1: check that CN exists
145 2: CN must match hostname */
146 char *CApath; /* DOES NOT WORK ON WINDOWS */
147 char *CAfile; /* cerficate to verify peer against */
148 char *random_file; /* path to file containing "random" data */
149 char *egdsocket; /* path to file containing the EGD daemon socket */
150 char *cipher_list; /* list of ciphers to use */
151 long numsessions; /* SSL session id cache size */
154 /****************************************************************************
156 ***************************************************************************/
158 struct FormData *sendit;
162 const char *p_pragma; /* Pragma: string */
163 const char *p_accept; /* Accept: string */
167 /* For FORM posting */
169 struct Curl_chunker chunk;
172 curl_read_callback fread; /* backup storage for fread pointer */
173 void *fread_in; /* backup storage for fread_in pointer */
179 HTTPSEND_NADA, /* init */
180 HTTPSEND_REQUEST, /* sending a request */
181 HTTPSEND_BODY, /* sending body */
182 HTTPSEND_LAST /* never use this */
185 void *send_buffer; /* used if the request couldn't be sent in one chunk,
186 points to an allocated send_buffer struct */
189 /****************************************************************************
191 ***************************************************************************/
194 char *user; /* user name string */
195 char *passwd; /* password string */
196 char *urlpath; /* the originally given path part of the URL */
197 char *dir; /* decoded directory */
198 char *file; /* decoded file */
200 char *entrypath; /* the PWD reply when we logged on */
202 char *cache; /* data cache between getresponse()-calls */
203 size_t cache_size; /* size of cache in bytes */
204 bool dont_check; /* Set to TRUE to prevent the final (post-transfer)
205 file size and 226/250 status check. It should still
206 read the line, just ignore the result. */
207 bool no_transfer; /* nothing was transfered, (possibly because a resumed
208 transfer already was complete) */
209 long response_time; /* When no timeout is given, this is the amount of
210 seconds we await for an FTP response. Initialized
211 in Curl_ftp_connect() */
214 /****************************************************************************
216 ***************************************************************************/
218 int fd; /* open file descriptor to read from! */
222 * Boolean values that concerns this connection.
225 bool close; /* if set, we close the connection after this request */
226 bool reuse; /* if set, this is a re-used connection */
227 bool chunk; /* if set, this is a chunked transfer-encoding */
228 bool httpproxy; /* if set, this transfer is done through a http proxy */
229 bool user_passwd; /* do we use user+password for this connection? */
230 bool proxy_user_passwd; /* user+password for the proxy? */
231 bool ipv6_ip; /* we communicate with a remove site specified with pure IPv6
234 bool rangestringalloc; /* the range string is malloc()'ed */
236 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
237 supposed to be called, after ->curl_do() */
239 bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
241 bool getheader; /* TRUE if header parsing is wanted */
243 bool forbidchunk; /* used only to explicitly forbid chunk-upload for
244 specific upload buffers. See readmoredata() in
245 http.c for details. */
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 bool write_after_100_header; /* should we enable the write after
282 we received a 100-continue/timeout
284 int content_encoding; /* What content encoding. sec 3.5, RFC2616. */
286 #define IDENTITY 0 /* No encoding */
287 #define DEFLATE 1 /* zlib delfate [RFC 1950 & 1951] */
288 #define GZIP 2 /* gzip algorithm [RFC 1952] */
289 #define COMPRESS 3 /* Not handled, added for completeness */
292 bool zlib_init; /* True if zlib already initialized;
293 undefined if Content-Encdoing header. */
294 z_stream z; /* State structure for zlib. */
297 /* for the low speed checks: */
306 /* pointers to the actual descriptors we check */
310 /* the file descriptors to play with */
317 bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
318 and we're uploading the last chunk */
323 * The connectdata struct contains all fields and variables that should be
324 * unique for an entire connection.
327 /**** Fields set when inited and not modified again */
328 struct SessionHandle *data; /* link to the root CURL struct */
329 int connectindex; /* what index in the connects index this particular
332 long protocol; /* PROT_* flags concerning the protocol set */
333 #define PROT_MISSING (1<<0)
334 #define PROT_GOPHER (1<<1)
335 #define PROT_HTTP (1<<2)
336 #define PROT_HTTPS (1<<3)
337 #define PROT_FTP (1<<4)
338 #define PROT_TELNET (1<<5)
339 #define PROT_DICT (1<<6)
340 #define PROT_LDAP (1<<7)
341 #define PROT_FILE (1<<8)
342 #define PROT_FTPS (1<<9)
343 #define PROT_SSL (1<<10) /* protocol requires SSL */
345 /* the particular host we use, in two different ways */
346 struct Curl_dns_entry *connect_addr;
349 struct addrinfo *serv_addr;
351 struct sockaddr_in serv_addr;
353 char protostr[64]; /* store the protocol string in this buffer */
354 char gname[513]; /* store the hostname in this buffer */
355 char *name; /* host name pointer to fool around with */
356 char *path; /* allocated buffer to store the URL's path part in */
357 char *hostname; /* hostname to connect, as parsed from url */
358 long port; /* which port to use locally */
359 unsigned short remote_port; /* what remote port to connect to,
360 not the proxy port! */
363 long headerbytecount; /* only count received headers */
365 char *range; /* range, if used. See README for detailed specification on
367 ssize_t resume_from; /* continue [ftp] transfer from here */
369 char *proxyhost; /* name of the http proxy host */
371 struct timeval now; /* "current" time */
372 struct timeval created; /* creation time */
373 int firstsocket; /* the main socket to use */
374 int secondarysocket; /* for i.e ftp transfers */
375 long maxdownload; /* in bytes, the maximum amount of data to fetch, 0
378 struct ssl_connect_data ssl; /* this is for ssl-stuff */
380 struct ConnectBits bits; /* various state-flags for this connection */
382 /* These two functions MUST be set by the curl_connect() function to be
383 be protocol dependent */
384 CURLcode (*curl_do)(struct connectdata *connect);
385 CURLcode (*curl_done)(struct connectdata *connect);
387 /* If the curl_do() function is better made in two halves, this
388 * curl_do_more() function will be called afterwards, if set. For example
389 * for doing the FTP stuff after the PASV/PORT command.
391 CURLcode (*curl_do_more)(struct connectdata *connect);
393 /* This function *MAY* be set to a protocol-dependent function that is run
394 * after the connect() and everything is done, as a step in the connection.
396 CURLcode (*curl_connect)(struct connectdata *connect);
398 /* This function *MAY* be set to a protocol-dependent function that is run
399 * by the curl_disconnect(), as a step in the disconnection.
401 CURLcode (*curl_disconnect)(struct connectdata *connect);
403 /* This function *MAY* be set to a protocol-dependent function that is run
404 * in the curl_close() function if protocol-specific cleanups are required.
406 CURLcode (*curl_close)(struct connectdata *connect);
408 /**** curl_get() phase fields */
411 int sockfd; /* socket to read from or -1 */
412 int size; /* -1 if unknown at this point */
413 long *bytecountp; /* return number of bytes read or NULL */
416 int writesockfd; /* socket to write to, it may very well be
417 the same we read from. -1 disables */
418 long *writebytecountp; /* return number of bytes written or NULL */
420 /** Dynamicly allocated strings, may need to be freed before this **/
421 /** struct is killed. **/
422 struct dynamically_allocated_data {
423 char *proxyuserpwd; /* free later if not NULL! */
424 char *uagent; /* free later if not NULL! */
425 char *accept_encoding; /* free later if not NULL! 08/28/02 jhrg */
426 char *userpwd; /* free later if not NULL! */
427 char *rangeline; /* free later if not NULL! */
428 char *ref; /* free later if not NULL! */
429 char *cookie; /* free later if not NULL! */
430 char *host; /* free later if not NULL */
433 char *newurl; /* This can only be set if a Location: was in the
437 enum protection_level command_prot;
438 enum protection_level data_prot;
439 enum protection_level request_data_prot;
443 struct krb4buffer in_buffer, out_buffer;
447 struct Curl_sec_client_mech *mech;
448 struct sockaddr_in local_addr;
452 /*************** Request - specific items ************/
453 /* previously this was in the urldata struct */
456 struct HTTP *gopher; /* alias, just for the sake of being more readable */
457 struct HTTP *https; /* alias, just for the sake of being more readable */
460 void *telnet; /* private for telnet.c-eyes only */
461 #if 0 /* no need for special ones for these: */
468 /* This struct is inited when needed */
469 struct Curl_transfer_keeper keep;
471 /* 'upload_present' is used to keep a byte counter of how much data there is
472 still left in the buffer, aimed for upload. */
475 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
476 buffer, so the next read should read from where this pointer points to,
477 and the 'upload_present' contains the number of bytes available at this
479 char *upload_fromhere;
481 curl_read_callback fread; /* function that reads the input */
482 void *fread_in; /* pointer to pass to the fread() above */
485 /* The end of connectdata. 08/27/02 jhrg */
488 * Struct to keep statistical and informational data.
493 long filetime; /* If requested, this is might get set. Set to -1 if
494 the time was unretrievable */
495 long header_size; /* size of read header(s) in bytes */
496 long request_size; /* the amount of bytes sent in the request(s) */
498 char *contenttype; /* the content type of the object */
503 long lastshow; /* time() of the last displayed progress meter or NULL to
504 force redraw at next call */
510 double current_speed; /* uses the currently fastest transfer */
512 bool callback; /* set when progress callback is used */
513 int width; /* screen width at download start */
514 int flags; /* see progress.h */
523 double t_pretransfer;
524 double t_starttransfer;
527 struct timeval start;
528 struct timeval t_startsingle;
529 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
531 double speeder[ CURR_TIME ];
532 struct timeval speeder_time[ CURR_TIME ];
537 HTTPREQ_NONE, /* first in list */
540 HTTPREQ_POST_FORM, /* we make a difference internally */
543 HTTPREQ_LAST /* last in list */
547 * Values that are generated, temporary or calculated internally for a
548 * "session handle" must be defined within the 'struct urlstate'. This struct
549 * will be used within the SessionHandle struct. When the 'SessionHandle'
550 * struct is cloned, this data MUST NOT be copied.
552 * Remember that any "state" information goes globally for the curl handle.
553 * Session-data MUST be put in the connectdata struct and here. */
554 #define MAX_CURL_USER_LENGTH 256
555 #define MAX_CURL_PASSWORD_LENGTH 256
564 /* buffers to store authentication data in, as parsed from input options */
565 char user[MAX_CURL_USER_LENGTH];
566 char passwd[MAX_CURL_PASSWORD_LENGTH];
567 char proxyuser[MAX_CURL_USER_LENGTH];
568 char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
570 struct timeval keeps_speed; /* for the progress meter really */
572 /* 'connects' will be an allocated array with pointers. If the pointer is
573 set, it holds an allocated connection. */
574 struct connectdata **connects;
575 long numconnects; /* size of the 'connects' array */
577 char *headerbuff; /* allocated buffer to store headers in */
578 int headersize; /* size of the allocation */
580 char buffer[BUFSIZE+1]; /* download buffer */
581 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
582 double current_speed; /* the ProgressShow() funcion sets this */
584 bool this_is_a_follow; /* this is a followed Location: request */
586 char *auth_host; /* if set, this should be the host name that we will
587 sent authorization to, no else. Used to make Location:
588 following not keep sending user+password... This is
592 struct curl_ssl_session *session; /* array of 'numsessions' size */
593 long sessionage; /* number of the most recent session */
595 char scratch[BUFSIZE*2]; /* huge buffer when doing upload CRLF replacing */
596 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
597 This must be set to FALSE every time _easy_perform() is
601 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
602 void (*prev_signal)(int sig);
604 bool allow_port; /* Is set.use_port allowed to take effect or not. This
605 is always set TRUE when curl_easy_perform() is called. */
610 * This 'DynamicStatic' struct defines dynamic states that actually change
611 * values in the 'UserDefined' area, which MUST be taken into consideration
612 * if the UserDefined struct is cloned or similar. You can probably just
613 * copy these, but each one indicate a special action on other data.
616 struct DynamicStatic {
617 char *url; /* work URL, copied from UserDefined */
618 bool url_alloc; /* URL string is malloc()'ed */
619 char *proxy; /* work proxy, copied from UserDefined */
620 bool proxy_alloc; /* http proxy string is malloc()'ed */
621 char *referer; /* referer string */
622 bool referer_alloc; /* referer sting is malloc()ed */
623 struct curl_slist *cookielist; /* list of cookie files set by
624 curl_easy_setopt(COOKIEFILE) calls */
628 * This 'UserDefined' struct must only contain data that is set once to go
629 * for many (perhaps) independent connections. Values that are generated or
630 * calculated internally for the "session handle" MUST be defined within the
631 * 'struct urlstate' instead. The only exceptions MUST note the changes in
632 * the 'DynamicStatic' struct.
636 FILE *err; /* the stderr user data goes here */
637 void *debugdata; /* the data that will be passed to fdebug */
638 char *errorbuffer; /* store failure messages in here */
639 char *proxyuserpwd; /* Proxy <user:password>, if used */
640 long proxyport; /* If non-zero, use this port number by default. If the
641 proxy string features a ":[port]" that one will override
643 void *out; /* the fetched file goes here */
644 void *in; /* the uploaded file is read from here */
645 void *writeheader; /* write the header to this is non-NULL */
646 char *set_url; /* what original URL to work on */
647 char *set_proxy; /* proxy to use */
648 long use_port; /* which port to use (when not using default) */
649 char *userpwd; /* <user:password>, if used */
650 char *set_range; /* range, if used. See README for detailed specification
652 long followlocation; /* as in HTTP Location: */
653 long maxredirs; /* maximum no. of http(s) redirects to follow */
654 char *set_referer; /* custom string */
655 bool free_referer; /* set TRUE if 'referer' points to a string we
657 char *useragent; /* User-Agent string */
658 char *encoding; /* Accept-Encoding string */
659 char *postfields; /* if POST, set the fields' values here */
660 size_t postfieldsize; /* if POST, this might have a size to use instead of
661 strlen(), and then the data *may* be binary (contain
663 char *ftpport; /* port to send with the FTP PORT command */
664 char *device; /* network interface to use */
665 curl_write_callback fwrite; /* function that stores the output */
666 curl_write_callback fwrite_header; /* function that stores headers */
667 curl_read_callback fread; /* function that reads the input */
668 curl_progress_callback fprogress; /* function for progress information */
669 curl_debug_callback fdebug; /* function that write informational data */
670 void *progress_client; /* pointer to pass to the progress callback */
671 curl_passwd_callback fpasswd; /* call for password */
672 void *passwd_client; /* pass to the passwd callback */
673 long timeout; /* in seconds, 0 means no timeout */
674 long connecttimeout; /* in seconds, 0 means no timeout */
675 long infilesize; /* size of file to upload, -1 means unknown */
676 long low_speed_limit; /* bytes/second */
677 long low_speed_time; /* number of seconds */
678 int set_resume_from; /* continue [ftp] transfer from here */
679 char *cookie; /* HTTP cookie string to send */
680 struct curl_slist *headers; /* linked list of extra headers */
681 struct HttpPost *httppost; /* linked list of POST data */
682 char *cert; /* certificate */
683 char *cert_type; /* format for certificate (default: PEM) */
684 char *key; /* private key */
685 char *key_type; /* format for private key (default: PEM) */
686 char *key_passwd; /* plain text private key password */
687 char *crypto_engine; /* name of the crypto engine to use */
688 char *cookiejar; /* dump all cookies to this file */
689 bool cookiesession; /* new cookie session? */
690 bool crlf; /* convert crlf on ftp upload(?) */
691 struct curl_slist *quote; /* after connection is established */
692 struct curl_slist *postquote; /* after the transfer */
693 struct curl_slist *prequote; /* before the transfer, after type (Wesley Laxton)*/
694 struct curl_slist *telnet_options; /* linked list of telnet options */
695 curl_TimeCond timecondition; /* kind of time/date comparison */
696 time_t timevalue; /* what time to compare with */
697 curl_closepolicy closepolicy; /* connection cache close concept */
698 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
699 char *customrequest; /* HTTP/FTP request to use */
700 long httpversion; /* when non-zero, a specific HTTP version requested to
701 be used in the library's request(s) */
702 char *auth_host; /* if set, this is the allocated string to the host name
703 * to which to send the authorization data to, and no other
704 * host (which location-following otherwise could lead to)
706 char *krb4_level; /* what security level */
707 struct ssl_config_data ssl; /* user defined SSL stuff */
709 curl_proxytype proxytype; /* what kind of proxy that is in use */
711 int dns_cache_timeout; /* DNS cache timeout */
712 long buffer_size; /* size of receive buffer to use */
714 char *private; /* Private data */
716 /* Here follows boolean settings that define how to behave during
717 this session. They are STATIC, set by libcurl users or at least initially
718 and they don't change during operations. */
721 bool tunnel_thru_httpproxy;
727 bool http_fail_on_error;
728 bool http_follow_location;
730 #define http_include_header include_header /* former name */
732 bool http_set_referer;
733 bool http_auto_referer; /* set "correct" referer when following location: */
737 enum CURL_NETRC_OPTION
738 use_netrc; /* defined in include/curl.h */
740 bool krb4; /* kerberos4 connection requested */
741 bool reuse_forbid; /* forbidden to be reused, close after use */
742 bool reuse_fresh; /* do not re-use an existing connection */
743 bool expect100header; /* TRUE if we added Expect: 100-continue */
744 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
745 bool no_signal; /* do not use any signal/alarm handler */
747 bool global_dns_cache;
751 * In August 2001, this struct was redesigned and is since stricter than
752 * before. The 'connectdata' struct MUST have all the connection oriented
753 * stuff as we may now have several simultaneous connections and connection
756 * From now on, the 'SessionHandle' must only contain data that is set once to
757 * go for many (perhaps) independent connections. Values that are generated or
758 * calculated internally for the "session handle" must be defined within the
759 * 'struct urlstate' instead. */
761 struct SessionHandle {
762 curl_hash *hostcache;
763 curl_share *share; /* Share, handles global variable mutexing */
764 struct UserDefined set; /* values set by the libcurl user */
765 struct DynamicStatic change; /* possibly modified userdefined data */
767 struct CookieInfo *cookies; /* the cookies, read from files and servers */
768 struct Progress progress; /* for all the progress meter data */
769 struct UrlState state; /* struct for fields used for state info and
770 other dynamic purposes */
771 struct PureInfo info; /* stats, reports and info data */
774 #endif /* USE_SSLEAY */
777 #define LIBCURL_NAME "libcurl"