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 /* If the curl_do() function is better made in two halves, this
332 * curl_do_more() function will be called afterwards, if set. For example
333 * for doing the FTP stuff after the PASV/PORT command.
335 CURLcode (*curl_do_more)(struct connectdata *connect);
337 /* This function *MAY* be set to a protocol-dependent function that is run
338 * after the connect() and everything is done, as a step in the connection.
340 CURLcode (*curl_connect)(struct connectdata *connect);
342 /* This function *MAY* be set to a protocol-dependent function that is run
343 * by the curl_disconnect(), as a step in the disconnection.
345 CURLcode (*curl_disconnect)(struct connectdata *connect);
347 /* This function *MAY* be set to a protocol-dependent function that is run
348 * in the curl_close() function if protocol-specific cleanups are required.
350 CURLcode (*curl_close)(struct connectdata *connect);
352 /**** curl_get() phase fields */
355 int sockfd; /* socket to read from or -1 */
356 int size; /* -1 if unknown at this point */
357 bool getheader; /* TRUE if header parsing is wanted */
358 long *bytecountp; /* return number of bytes read or NULL */
361 int writesockfd; /* socket to write to, it may very well be
362 the same we read from. -1 disables */
363 long *writebytecountp; /* return number of bytes written or NULL */
365 /** Dynamicly allocated strings, may need to be freed before this **/
366 /** struct is killed. **/
367 struct dynamically_allocated_data {
368 char *proxyuserpwd; /* free later if not NULL! */
369 char *uagent; /* free later if not NULL! */
370 char *userpwd; /* free later if not NULL! */
371 char *rangeline; /* free later if not NULL! */
372 char *ref; /* free later if not NULL! */
373 char *cookie; /* free later if not NULL! */
374 char *host; /* free later if not NULL */
377 char *newurl; /* This can only be set if a Location: was in the
381 enum protection_level command_prot;
382 enum protection_level data_prot;
383 enum protection_level request_data_prot;
387 struct krb4buffer in_buffer, out_buffer;
391 struct Curl_sec_client_mech *mech;
392 struct sockaddr_in local_addr;
396 /*************** Request - specific items ************/
397 /* previously this was in the urldata struct */
400 struct HTTP *gopher; /* alias, just for the sake of being more readable */
401 struct HTTP *https; /* alias, just for the sake of being more readable */
404 void *telnet; /* private for telnet.c-eyes only */
405 #if 0 /* no need for special ones for these: */
412 /* This struct is inited when needed */
413 struct Curl_transfer_keeper keep;
415 /* 'upload_present' is used to keep a byte counter of how much data there is
416 still left in the buffer, aimed for upload. */
419 /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
420 buffer, so the next read should read from where this pointer points to,
421 and the 'upload_present' contains the number of bytes available at this
423 char *upload_fromhere;
425 bool do_more; /* this is set TRUE if the ->curl_do_more() function is
426 supposed to be called, after ->curl_do() */
430 * Struct to keep statistical and informational data.
435 long filetime; /* If requested, this is might get set. Set to -1 if
436 the time was unretrievable */
437 long header_size; /* size of read header(s) in bytes */
438 long request_size; /* the amount of bytes sent in the request(s) */
440 char *contenttype; /* the content type of the object */
445 long lastshow; /* time() of the last displayed progress meter or NULL to
446 force redraw at next call */
452 double current_speed; /* uses the currently fastest transfer */
454 bool callback; /* set when progress callback is used */
455 int width; /* screen width at download start */
456 int flags; /* see progress.h */
465 double t_pretransfer;
466 double t_starttransfer;
469 struct timeval start;
470 struct timeval t_startsingle;
471 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
473 double speeder[ CURR_TIME ];
474 struct timeval speeder_time[ CURR_TIME ];
479 HTTPREQ_NONE, /* first in list */
482 HTTPREQ_POST_FORM, /* we make a difference internally */
485 HTTPREQ_LAST /* last in list */
489 * Values that are generated, temporary or calculated internally for a
490 * "session handle" must be defined within the 'struct urlstate'. This struct
491 * will be used within the SessionHandle struct. When the 'SessionHandle'
492 * struct is cloned, this data MUST NOT be copied.
494 * Remember that any "state" information goes globally for the curl handle.
495 * Session-data MUST be put in the connectdata struct and here. */
496 #define MAX_CURL_USER_LENGTH 256
497 #define MAX_CURL_PASSWORD_LENGTH 256
506 /* buffers to store authentication data in, as parsed from input options */
507 char user[MAX_CURL_USER_LENGTH];
508 char passwd[MAX_CURL_PASSWORD_LENGTH];
509 char proxyuser[MAX_CURL_USER_LENGTH];
510 char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
512 struct timeval keeps_speed; /* for the progress meter really */
514 /* 'connects' will be an allocated array with pointers. If the pointer is
515 set, it holds an allocated connection. */
516 struct connectdata **connects;
517 long numconnects; /* size of the 'connects' array */
519 char *headerbuff; /* allocated buffer to store headers in */
520 int headersize; /* size of the allocation */
522 char buffer[BUFSIZE+1]; /* download buffer */
523 char uploadbuffer[BUFSIZE+1]; /* upload buffer */
524 double current_speed; /* the ProgressShow() funcion sets this */
526 bool this_is_a_follow; /* this is a followed Location: request */
528 char *auth_host; /* if set, this should be the host name that we will
529 sent authorization to, no else. Used to make Location:
530 following not keep sending user+password... This is
534 struct curl_ssl_session *session; /* array of 'numsessions' size */
535 long sessionage; /* number of the most recent session */
537 char scratch[BUFSIZE*2]; /* huge buffer when doing upload CRLF replacing */
538 bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
539 This must be set to FALSE every time _easy_perform() is
543 /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
544 void (*prev_signal)(int sig);
546 bool allow_port; /* Is set.use_port allowed to take effect or not. This
547 is always set TRUE when curl_easy_perform() is called. */
552 * This 'DynamicStatic' struct defines dynamic states that actually change
553 * values in the 'UserDefined' area, which MUST be taken into consideration
554 * if the UserDefined struct is cloned or similar. You can probably just
555 * copy these, but each one indicate a special action on other data.
558 struct DynamicStatic {
559 char *url; /* work URL, copied from UserDefined */
560 bool url_alloc; /* URL string is malloc()'ed */
561 char *proxy; /* work proxy, copied from UserDefined */
562 bool proxy_alloc; /* http proxy string is malloc()'ed */
563 char *referer; /* referer string */
564 bool referer_alloc; /* referer sting is malloc()ed */
568 * This 'UserDefined' struct must only contain data that is set once to go
569 * for many (perhaps) independent connections. Values that are generated or
570 * calculated internally for the "session handle" MUST be defined within the
571 * 'struct urlstate' instead. The only exceptions MUST note the changes in
572 * the 'DynamicStatic' struct.
576 FILE *err; /* the stderr user data goes here */
577 void *debugdata; /* the data that will be passed to fdebug */
578 char *errorbuffer; /* store failure messages in here */
579 char *proxyuserpwd; /* Proxy <user:password>, if used */
580 long proxyport; /* If non-zero, use this port number by default. If the
581 proxy string features a ":[port]" that one will override
583 void *out; /* the fetched file goes here */
584 void *in; /* the uploaded file is read from here */
585 void *writeheader; /* write the header to this is non-NULL */
586 char *set_url; /* what original URL to work on */
587 char *set_proxy; /* proxy to use */
588 long use_port; /* which port to use (when not using default) */
589 char *userpwd; /* <user:password>, if used */
590 char *set_range; /* range, if used. See README for detailed specification
592 long followlocation; /* as in HTTP Location: */
593 long maxredirs; /* maximum no. of http(s) redirects to follow */
594 char *set_referer; /* custom string */
595 bool free_referer; /* set TRUE if 'referer' points to a string we
597 char *useragent; /* User-Agent string */
598 char *postfields; /* if POST, set the fields' values here */
599 size_t postfieldsize; /* if POST, this might have a size to use instead of
600 strlen(), and then the data *may* be binary (contain
602 char *ftpport; /* port to send with the FTP PORT command */
603 char *device; /* network interface to use */
604 curl_write_callback fwrite; /* function that stores the output */
605 curl_write_callback fwrite_header; /* function that stores headers */
606 curl_read_callback fread; /* function that reads the input */
607 curl_progress_callback fprogress; /* function for progress information */
608 curl_debug_callback fdebug; /* function that write informational data */
609 void *progress_client; /* pointer to pass to the progress callback */
610 curl_passwd_callback fpasswd; /* call for password */
611 void *passwd_client; /* pass to the passwd callback */
612 long timeout; /* in seconds, 0 means no timeout */
613 long connecttimeout; /* in seconds, 0 means no timeout */
614 long infilesize; /* size of file to upload, -1 means unknown */
615 long low_speed_limit; /* bytes/second */
616 long low_speed_time; /* number of seconds */
617 int set_resume_from; /* continue [ftp] transfer from here */
618 char *cookie; /* HTTP cookie string to send */
619 struct curl_slist *headers; /* linked list of extra headers */
620 struct HttpPost *httppost; /* linked list of POST data */
621 char *cert; /* certificate */
622 char *cert_type; /* format for certificate (default: PEM) */
623 char *key; /* private key */
624 char *key_type; /* format for private key (default: PEM) */
625 char *key_passwd; /* plain text private key password */
626 char *crypto_engine; /* name of the crypto engine to use */
627 char *cookiejar; /* dump all cookies to this file */
628 bool cookiesession; /* new cookie session? */
629 bool crlf; /* convert crlf on ftp upload(?) */
630 struct curl_slist *quote; /* after connection is established */
631 struct curl_slist *postquote; /* after the transfer */
632 struct curl_slist *prequote; /* before the transfer, after type (Wesley Laxton)*/
633 struct curl_slist *telnet_options; /* linked list of telnet options */
634 curl_TimeCond timecondition; /* kind of time/date comparison */
635 time_t timevalue; /* what time to compare with */
636 curl_closepolicy closepolicy; /* connection cache close concept */
637 Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
638 char *customrequest; /* HTTP/FTP request to use */
639 long httpversion; /* when non-zero, a specific HTTP version requested to
640 be used in the library's request(s) */
641 char *auth_host; /* if set, this is the allocated string to the host name
642 * to which to send the authorization data to, and no other
643 * host (which location-following otherwise could lead to)
645 char *krb4_level; /* what security level */
646 struct ssl_config_data ssl; /* user defined SSL stuff */
648 int dns_cache_timeout; /* DNS cache timeout */
649 long buffer_size; /* size of receive buffer to use */
651 /* Here follows boolean settings that define how to behave during
652 this session. They are STATIC, set by libcurl users or at least initially
653 and they don't change during operations. */
656 bool tunnel_thru_httpproxy;
662 bool http_fail_on_error;
663 bool http_follow_location;
665 #define http_include_header include_header /* former name */
667 bool http_set_referer;
668 bool http_auto_referer; /* set "correct" referer when following location: */
672 enum CURL_NETRC_OPTION
673 use_netrc; /* defined in include/curl.h */
675 bool krb4; /* kerberos4 connection requested */
676 bool reuse_forbid; /* forbidden to be reused, close after use */
677 bool reuse_fresh; /* do not re-use an existing connection */
678 bool expect100header; /* TRUE if we added Expect: 100-continue */
679 bool ftp_use_epsv; /* if EPSV is to be attempted or not */
682 bool global_dns_cache;
686 * In August 2001, this struct was redesigned and is since stricter than
687 * before. The 'connectdata' struct MUST have all the connection oriented
688 * stuff as we may now have several simultaneous connections and connection
691 * From now on, the 'SessionHandle' must only contain data that is set once to
692 * go for many (perhaps) independent connections. Values that are generated or
693 * calculated internally for the "session handle" must be defined within the
694 * 'struct urlstate' instead. */
696 struct SessionHandle {
697 curl_hash *hostcache;
698 curl_share *share; /* Share, handles global variable mutexing */
699 struct UserDefined set; /* values set by the libcurl user */
700 struct DynamicStatic change; /* possibly modified userdefined data */
702 struct CookieInfo *cookies; /* the cookies, read from files and servers */
703 struct Progress progress; /* for all the progress meter data */
704 struct UrlState state; /* struct for fields used for state info and
705 other dynamic purposes */
706 struct PureInfo info; /* stats, reports and info data */
709 #endif /* USE_SSLEAY */
712 #define LIBCURL_NAME "libcurl"