3 /*****************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2002, Daniel Stenberg, <daniel@haxx.se>, et al.
12 * In order to be useful for every potential user, curl and libcurl are
13 * dual-licensed under the MPL and the MIT/X-derivate licenses.
15 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
16 * copies of the Software, and permit persons to whom the Software is
17 * furnished to do so, under the terms of the MPL or the MIT/X-derivate
18 * licenses. You may pick one of these licenses.
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 */
33 #define PORT_TELNET 23
34 #define PORT_GOPHER 70
36 #define PORT_HTTPS 443
37 #define PORT_DICT 2628
40 #define DICT_MATCH "/MATCH:"
41 #define DICT_MATCH2 "/M:"
42 #define DICT_MATCH3 "/FIND:"
43 #define DICT_DEFINE "/DEFINE:"
44 #define DICT_DEFINE2 "/D:"
45 #define DICT_DEFINE3 "/LOOKUP:"
47 #define CURL_DEFAULT_USER "anonymous"
48 #define CURL_DEFAULT_PASSWORD "curl_by_daniel@haxx.se"
54 /* SSLeay stuff usually in /usr/local/ssl/include */
56 #include "openssl/rsa.h"
57 #include "openssl/crypto.h"
58 #include "openssl/x509.h"
59 #include "openssl/pem.h"
60 #include "openssl/ssl.h"
61 #include "openssl/err.h"
62 #ifdef HAVE_OPENSSL_ENGINE_H
63 #include <openssl/engine.h>
75 #ifdef HAVE_NETINET_IN_H
76 #include <netinet/in.h>
81 #include <curl/curl.h>
83 #include "http_chunks.h" /* for the structs and enum stuff */
85 /* Download buffer size, keep it fairly big for speed reasons */
86 #define BUFSIZE CURL_MAX_WRITE_SIZE
88 /* Initial size of the buffer to store headers in, it'll be enlarged in case
90 #define HEADERSIZE 256
92 /* Just a convenience macro to get the larger value out of two given */
94 #define MAX(x,y) ((x)>(y)?(x):(y))
98 /* Types needed for krb4-ftp connections */
105 enum protection_level {
113 #ifndef HAVE_OPENSSL_ENGINE_H
116 /* struct for data related to SSL and SSL connections */
117 struct ssl_connect_data {
118 bool use; /* use ssl encrypted communications TRUE/FALSE */
120 /* these ones requires specific SSL-types */
124 #endif /* USE_SSLEAY */
127 /* information about one single SSL session */
128 struct curl_ssl_session {
129 char *name; /* host name for which this ID was used */
130 void *sessionid; /* as returned from the SSL layer */
131 long age; /* just a number, the higher the more recent */
132 unsigned short remote_port; /* remote port to connect to */
135 struct ssl_config_data {
136 long version; /* what version the client wants to use */
137 long certverifyresult; /* result from the certificate verification */
138 long verifypeer; /* set TRUE if this is desired */
139 long verifyhost; /* 0: no verif, 1: check that CN exists, 2: CN must match hostname */
140 char *CApath; /* DOES NOT WORK ON WINDOWS */
141 char *CAfile; /* cerficate to verify peer against */
142 char *random_file; /* path to file containing "random" data */
143 char *egdsocket; /* path to file containing the EGD daemon socket */
144 char *cipher_list; /* list of ciphers to use */
146 long numsessions; /* SSL session id cache size */
149 /****************************************************************************
151 ***************************************************************************/
153 struct FormData *sendit;
155 const char *p_pragma; /* Pragma: string */
156 const char *p_accept; /* Accept: string */
160 /* For FORM posting */
162 curl_read_callback storefread;
165 struct Curl_chunker chunk;
168 /****************************************************************************
170 ***************************************************************************/
173 char *user; /* user name string */
174 char *passwd; /* password string */
175 char *urlpath; /* the originally given path part of the URL */
176 char *dir; /* decoded directory */
177 char *file; /* decoded file */
179 char *entrypath; /* the PWD reply when we logged on */
181 char *cache; /* data cache between getresponse()-calls */
182 size_t cache_size; /* size of cache in bytes */
183 bool dont_check; /* Set to TRUE to prevent the final (post-transfer)
184 file size and 226/250 status check. It should still
185 read the line, just ignore the result. */
186 bool no_transfer; /* nothing was transfered, (possibly because a resumed
187 transfer already was complete) */
191 /****************************************************************************
193 ***************************************************************************/
195 int fd; /* open file descriptor to read from! */
199 * Boolean values that concerns this connection.
202 bool close; /* if set, we close the connection after this request */
203 bool reuse; /* if set, this is a re-used connection */
204 bool chunk; /* if set, this is a chunked transfer-encoding */
205 bool httpproxy; /* if set, this transfer is done through a http proxy */
206 bool user_passwd; /* do we use user+password for this connection? */
207 bool proxy_user_passwd; /* user+password for the proxy? */
210 bool rangestringalloc; /* the range string is malloc()'ed */
214 * This struct is all the previously local variables from Curl_perform() moved
215 * to struct to allow the function to return and get re-invoked better without
219 struct Curl_transfer_keeper {
220 int bytecount; /* total number of bytes read */
221 int writebytecount; /* number of bytes written */
222 long contentlength; /* size of incoming data */
223 struct timeval start; /* transfer started at this time */
224 struct timeval now; /* current time */
225 bool header; /* incoming data has HTTP header */
226 int headerline; /* counts header lines to better track the
228 char *hbufp; /* points at *end* of header line */
230 char *str; /* within buf */
231 char *str_start; /* within buf */
232 char *end_ptr; /* within buf */
233 char *p; /* within headerbuff */
234 bool content_range; /* set TRUE if Content-Range: was found */
235 int offset; /* possible resume offset read from the
236 Content-Range: header */
237 int httpcode; /* error code from the 'HTTP/1.? XXX' line */
238 int httpversion; /* the HTTP version*10 */
239 bool write_after_100_header; /* should we enable the write after
240 we received a 100-continue/timeout
243 /* for the low speed checks: */
248 /* the highest fd we use + 1 */
249 struct SessionHandle *data;
250 struct connectdata *conn;
255 /* pointers to the actual descriptors we check */
259 /* the file descriptors to play with */
270 * The connectdata struct contains all fields and variables that should be
271 * unique for an entire connection.
274 /**** Fields set when inited and not modified again */
275 struct SessionHandle *data; /* link to the root CURL struct */
276 int connectindex; /* what index in the connects index this particular
279 long protocol; /* PROT_* flags concerning the protocol set */
280 #define PROT_MISSING (1<<0)
281 #define PROT_GOPHER (1<<1)
282 #define PROT_HTTP (1<<2)
283 #define PROT_HTTPS (1<<3)
284 #define PROT_FTP (1<<4)
285 #define PROT_TELNET (1<<5)
286 #define PROT_DICT (1<<6)
287 #define PROT_LDAP (1<<7)
288 #define PROT_FILE (1<<8)
289 #define PROT_FTPS (1<<9)
290 #define PROT_SSL (1<<10) /* protocol requires SSL */
293 struct addrinfo *serv_addr; /* the particular host we use */
295 struct sockaddr_in serv_addr;
297 char protostr[64]; /* store the protocol string in this buffer */
298 char gname[513]; /* store the hostname in this buffer */
299 char *name; /* host name pointer to fool around with */
300 char *path; /* allocated buffer to store the URL's path part in */
301 char *hostname; /* hostname to connect, as parsed from url */
302 long port; /* which port to use locally */
303 unsigned short remote_port; /* what remote port to connect to,
304 not the proxy port! */
307 long headerbytecount; /* only count received headers */
309 char *range; /* range, if used. See README for detailed specification on
311 ssize_t resume_from; /* continue [ftp] transfer from here */
313 char *proxyhost; /* name of the http proxy host */
315 struct timeval now; /* "current" time */
316 struct timeval created; /* creation time */
317 int firstsocket; /* the main socket to use */
318 int secondarysocket; /* for i.e ftp transfers */
319 long maxdownload; /* in bytes, the maximum amount of data to fetch, 0
322 struct ssl_connect_data ssl; /* this is for ssl-stuff */
324 struct ConnectBits bits; /* various state-flags for this connection */
326 /* These two functions MUST be set by the curl_connect() function to be
327 be protocol dependent */
328 CURLcode (*curl_do)(struct connectdata *connect);
329 CURLcode (*curl_done)(struct connectdata *connect);
331 /* This function *MAY* be set to a protocol-dependent function that is run
332 * after the connect() and everything is done, as a step in the connection.
334 CURLcode (*curl_connect)(struct connectdata *connect);
336 /* This function *MAY* be set to a protocol-dependent function that is run
337 * by the curl_disconnect(), as a step in the disconnection.
339 CURLcode (*curl_disconnect)(struct connectdata *connect);
341 /* This function *MAY* be set to a protocol-dependent function that is run
342 * in the curl_close() function if protocol-specific cleanups are required.
344 CURLcode (*curl_close)(struct connectdata *connect);
346 /**** curl_get() phase fields */
349 int sockfd; /* socket to read from or -1 */
350 int size; /* -1 if unknown at this point */
351 bool getheader; /* TRUE if header parsing is wanted */
352 long *bytecountp; /* return number of bytes read or NULL */
355 int writesockfd; /* socket to write to, it may very well be
356 the same we read from. -1 disables */
357 long *writebytecountp; /* return number of bytes written or NULL */
359 /** Dynamicly allocated strings, may need to be freed before this **/
360 /** struct is killed. **/
361 struct dynamically_allocated_data {
362 char *proxyuserpwd; /* free later if not NULL! */
363 char *uagent; /* free later if not NULL! */
364 char *userpwd; /* free later if not NULL! */
365 char *rangeline; /* free later if not NULL! */
366 char *ref; /* free later if not NULL! */
367 char *cookie; /* free later if not NULL! */
368 char *host; /* free later if not NULL */
371 char *newurl; /* This can only be set if a Location: was in the
375 enum protection_level command_prot;
376 enum protection_level data_prot;
377 enum protection_level request_data_prot;
381 struct krb4buffer in_buffer, out_buffer;
385 struct Curl_sec_client_mech *mech;
386 struct sockaddr_in local_addr;
390 /*************** Request - specific items ************/
391 /* previously this was in the urldata struct */
394 struct HTTP *gopher; /* alias, just for the sake of being more readable */
395 struct HTTP *https; /* alias, just for the sake of being more readable */
398 void *telnet; /* private for telnet.c-eyes only */
399 #if 0 /* no need for special ones for these: */
406 /* This struct is inited when needed */
407 struct Curl_transfer_keeper keep;
409 /* 'upload_present' is used to keep a byte counter of how much data there is
410 still left in the buffer, aimed for upload. */
413 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
414 buffer, so the next read should read from where this pointer points to,
415 and the 'upload_present' contains the number of bytes available at this
417 char *upload_fromhere;
421 * Struct to keep statistical and informational data.
426 long filetime; /* If requested, this is might get set. Set to -1 if
427 the time was unretrievable */
428 long header_size; /* size of read header(s) in bytes */
429 long request_size; /* the amount of bytes sent in the request(s) */
431 char *contenttype; /* the content type of the object */
436 long lastshow; /* time() of the last displayed progress meter or NULL to
437 force redraw at next call */
443 double current_speed; /* uses the currently fastest transfer */
445 bool callback; /* set when progress callback is used */
446 int width; /* screen width at download start */
447 int flags; /* see progress.h */
456 double t_pretransfer;
457 double t_starttransfer;
460 struct timeval start;
461 struct timeval t_startsingle;
462 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
464 double speeder[ CURR_TIME ];
465 struct timeval speeder_time[ CURR_TIME ];
470 HTTPREQ_NONE, /* first in list */
473 HTTPREQ_POST_FORM, /* we make a difference internally */
476 HTTPREQ_LAST /* last in list */
480 * Values that are generated, temporary or calculated internally for a
481 * "session handle" must be defined within the 'struct urlstate'. This struct
482 * will be used within the SessionHandle struct. When the 'SessionHandle'
483 * struct is cloned, this data MUST NOT be copied.
485 * Remember that any "state" information goes globally for the curl handle.
486 * Session-data MUST be put in the connectdata struct and here. */
487 #define MAX_CURL_USER_LENGTH 256
488 #define MAX_CURL_PASSWORD_LENGTH 256
491 /* buffers to store authentication data in, as parsed from input options */
492 char user[MAX_CURL_USER_LENGTH];
493 char passwd[MAX_CURL_PASSWORD_LENGTH];
494 char proxyuser[MAX_CURL_USER_LENGTH];
495 char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
497 struct timeval keeps_speed; /* for the progress meter really */
499 /* 'connects' will be an allocated array with pointers. If the pointer is
500 set, it holds an allocated connection. */
501 struct connectdata **connects;
502 long numconnects; /* size of the 'connects' array */
504 char *headerbuff; /* allocated buffer to store headers in */
505 int headersize; /* size of the allocation */
507 char buffer[BUFSIZE+1]; /* download buffer */
508 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
509 double current_speed; /* the ProgressShow() funcion sets this */
511 bool this_is_a_follow; /* this is a followed Location: request */
513 char *auth_host; /* if set, this should be the host name that we will
514 sent authorization to, no else. Used to make Location:
515 following not keep sending user+password... This is
519 struct curl_ssl_session *session; /* array of 'numsessions' size */
520 long sessionage; /* number of the most recent session */
522 char scratch[BUFSIZE*2]; /* huge buffer when doing upload CRLF replacing */
523 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
524 This must be set to FALSE every time _easy_perform() is
528 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
529 void (*prev_signal)(int sig);
531 bool allow_port; /* Is set.use_port allowed to take effect or not. This
532 is always set TRUE when curl_easy_perform() is called. */
537 * This 'DynamicStatic' struct defines dynamic states that actually change
538 * values in the 'UserDefined' area, which MUST be taken into consideration
539 * if the UserDefined struct is cloned or similar. You can probably just
540 * copy these, but each one indicate a special action on other data.
543 struct DynamicStatic {
544 char *url; /* work URL, copied from UserDefined */
545 bool url_alloc; /* URL string is malloc()'ed */
546 char *proxy; /* work proxy, copied from UserDefined */
547 bool proxy_alloc; /* http proxy string is malloc()'ed */
548 char *referer; /* referer string */
549 bool referer_alloc; /* referer sting is malloc()ed */
553 * This 'UserDefined' struct must only contain data that is set once to go
554 * for many (perhaps) independent connections. Values that are generated or
555 * calculated internally for the "session handle" MUST be defined within the
556 * 'struct urlstate' instead. The only exceptions MUST note the changes in
557 * the 'DynamicStatic' struct.
561 FILE *err; /* the stderr user data goes here */
562 void *debugdata; /* the data that will be passed to fdebug */
563 char *errorbuffer; /* store failure messages in here */
564 char *proxyuserpwd; /* Proxy <user:password>, if used */
565 long proxyport; /* If non-zero, use this port number by default. If the
566 proxy string features a ":[port]" that one will override
568 void *out; /* the fetched file goes here */
569 void *in; /* the uploaded file is read from here */
570 void *writeheader; /* write the header to this is non-NULL */
571 char *set_url; /* what original URL to work on */
572 char *set_proxy; /* proxy to use */
573 long use_port; /* which port to use (when not using default) */
574 char *userpwd; /* <user:password>, if used */
575 char *set_range; /* range, if used. See README for detailed specification
577 long followlocation; /* as in HTTP Location: */
578 long maxredirs; /* maximum no. of http(s) redirects to follow */
579 char *set_referer; /* custom string */
580 bool free_referer; /* set TRUE if 'referer' points to a string we
582 char *useragent; /* User-Agent string */
583 char *postfields; /* if POST, set the fields' values here */
584 size_t postfieldsize; /* if POST, this might have a size to use instead of
585 strlen(), and then the data *may* be binary (contain
587 char *ftpport; /* port to send with the FTP PORT command */
588 char *device; /* network interface to use */
589 curl_write_callback fwrite; /* function that stores the output */
590 curl_write_callback fwrite_header; /* function that stores headers */
591 curl_read_callback fread; /* function that reads the input */
592 curl_progress_callback fprogress; /* function for progress information */
593 curl_debug_callback fdebug; /* function that write informational data */
594 void *progress_client; /* pointer to pass to the progress callback */
595 curl_passwd_callback fpasswd; /* call for password */
596 void *passwd_client; /* pass to the passwd callback */
597 long timeout; /* in seconds, 0 means no timeout */
598 long connecttimeout; /* in seconds, 0 means no timeout */
599 long infilesize; /* size of file to upload, -1 means unknown */
600 long low_speed_limit; /* bytes/second */
601 long low_speed_time; /* number of seconds */
602 int set_resume_from; /* continue [ftp] transfer from here */
603 char *cookie; /* HTTP cookie string to send */
604 struct curl_slist *headers; /* linked list of extra headers */
605 struct HttpPost *httppost; /* linked list of POST data */
606 char *cert; /* certificate */
607 char *cert_type; /* format for certificate (default: PEM) */
608 char *key; /* private key */
609 char *key_type; /* format for private key (default: PEM) */
610 char *key_passwd; /* plain text private key password */
611 char *crypto_engine; /* name of the crypto engine to use */
612 char *cookiejar; /* dump all cookies to this file */
613 bool cookiesession; /* new cookie session? */
614 bool crlf; /* convert crlf on ftp upload(?) */
615 struct curl_slist *quote; /* after connection is established */
616 struct curl_slist *postquote; /* after the transfer */
617 struct curl_slist *prequote; /* before the transfer, after type (Wesley Laxton)*/
618 struct curl_slist *telnet_options; /* linked list of telnet options */
619 curl_TimeCond timecondition; /* kind of time/date comparison */
620 time_t timevalue; /* what time to compare with */
621 curl_closepolicy closepolicy; /* connection cache close concept */
622 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
623 char *customrequest; /* HTTP/FTP request to use */
624 long httpversion; /* when non-zero, a specific HTTP version requested to
625 be used in the library's request(s) */
626 char *auth_host; /* if set, this is the allocated string to the host name
627 * to which to send the authorization data to, and no other
628 * host (which location-following otherwise could lead to)
630 char *krb4_level; /* what security level */
631 struct ssl_config_data ssl; /* user defined SSL stuff */
633 int dns_cache_timeout; /* DNS cache timeout */
635 /* Here follows boolean settings that define how to behave during
636 this session. They are STATIC, set by libcurl users or at least initially
637 and they don't change during operations. */
640 bool tunnel_thru_httpproxy;
646 bool http_fail_on_error;
647 bool http_follow_location;
649 #define http_include_header include_header /* former name */
651 bool http_set_referer;
652 bool http_auto_referer; /* set "correct" referer when following location: */
656 enum CURL_NETRC_OPTION
657 use_netrc; /* defined in include/curl.h */
659 bool krb4; /* kerberos4 connection requested */
660 bool reuse_forbid; /* forbidden to be reused, close after use */
661 bool reuse_fresh; /* do not re-use an existing connection */
662 bool expect100header; /* TRUE if we added Expect: 100-continue */
663 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
665 bool global_dns_cache;
669 * In August 2001, this struct was redesigned and is since stricter than
670 * before. The 'connectdata' struct MUST have all the connection oriented
671 * stuff as we may now have several simultaneous connections and connection
674 * From now on, the 'SessionHandle' must only contain data that is set once to
675 * go for many (perhaps) independent connections. Values that are generated or
676 * calculated internally for the "session handle" must be defined within the
677 * 'struct urlstate' instead. */
679 struct SessionHandle {
680 curl_hash *hostcache;
681 struct UserDefined set; /* values set by the libcurl user */
682 struct DynamicStatic change; /* possibly modified userdefined data */
684 struct CookieInfo *cookies; /* the cookies, read from files and servers */
685 struct Progress progress; /* for all the progress meter data */
686 struct UrlState state; /* struct for fields used for state info and
687 other dynamic purposes */
688 struct PureInfo info; /* stats, reports and info data */
691 #endif /* USE_SSLEAY */
694 #define LIBCURL_NAME "libcurl"