lib/urldata.h

   1 #ifndef __URLDATA_H
   2 #define __URLDATA_H
   3 /*****************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 2000, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  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.
  14  *
  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.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  * $Id$
  24  *****************************************************************************/
  25
  26 /* This file is for lib internal stuff */
  27
  28 #include "setup.h"
  29
  30 #ifndef MAXHOSTNAMELEN
  31 #define MAXHOSTNAMELEN 256
  32 #endif
  33
  34 #define PORT_FTP 21
  35 #define PORT_TELNET 23
  36 #define PORT_GOPHER 70
  37 #define PORT_HTTP 80
  38 #define PORT_HTTPS 443
  39 #define PORT_DICT 2628
  40 #define PORT_LDAP 389
  41
  42 #define DICT_MATCH "/MATCH:"
  43 #define DICT_MATCH2 "/M:"
  44 #define DICT_MATCH3 "/FIND:"
  45 #define DICT_DEFINE "/DEFINE:"
  46 #define DICT_DEFINE2 "/D:"
  47 #define DICT_DEFINE3 "/LOOKUP:"
  48
  49 #define CURL_DEFAULT_USER "anonymous"
  50 #define CURL_DEFAULT_PASSWORD "curl_by_daniel@haxx.se"
  51
  52 #include "cookie.h"
  53 #include "formdata.h"
  54
  55 #ifdef USE_SSLEAY
  56 /* SSLeay stuff usually in /usr/local/ssl/include */
  57 #ifdef USE_OPENSSL
  58 #include "openssl/rsa.h"
  59 #include "openssl/crypto.h"
  60 #include "openssl/x509.h"
  61 #include "openssl/pem.h"
  62 #include "openssl/ssl.h"
  63 #include "openssl/err.h"
  64 #else
  65 #include "rsa.h"
  66 #include "crypto.h"
  67 #include "x509.h"
  68 #include "pem.h"
  69 #include "ssl.h"
  70 #include "err.h"
  71 #endif
  72 #endif
  73
  74 #ifdef HAVE_NETINET_IN_H
  75 #include <netinet/in.h>
  76 #endif
  77
  78 #include "timeval.h"
  79
  80 #include <curl/curl.h>
  81
  82 #include "http_chunks.h" /* for the structs and enum stuff */
  83
  84 /* Download buffer size, keep it fairly big for speed reasons */
  85 #define BUFSIZE (1024*50)
  86
  87 /* Defaul upload buffer size, keep it smallish to get faster progress meter
  88    updates. This is just default, it is dynamic and adjusts to the upload
  89    speed. */
  90 #define UPLOAD_BUFSIZE (1024*2)
  91
  92 /* Initial size of the buffer to store headers in, it'll be enlarged in case
  93    of need. */
  94 #define HEADERSIZE 256
  95
  96 /* Just a convenience macro to get the larger value out of two given */
  97 #ifndef MAX
  98 #define MAX(x,y) ((x)>(y)?(x):(y))
  99 #endif
 100
 101 #ifdef KRB4
 102 /* Types needed for krb4-ftp connections */
 103 struct krb4buffer {
 104   void *data;
 105   size_t size;
 106   size_t index;
 107   int eof_flag;
 108 };
 109 enum protection_level {
 110     prot_clear,
 111     prot_safe,
 112     prot_confidential,
 113     prot_private
 114 };
 115 #endif
 116
 117 /* struct for data related to SSL and SSL connections */
 118 struct ssl_connect_data {
 119   bool use;              /* use ssl encrypted communications TRUE/FALSE */
 120 #ifdef USE_SSLEAY
 121   /* these ones requires specific SSL-types */
 122   SSL_CTX* ctx;
 123   SSL*     handle;
 124   X509*    server_cert;
 125 #endif /* USE_SSLEAY */
 126 };
 127
 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 };
 134
 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
 145   struct curl_ssl_session *session; /* array of 'numsessions' size */
 146   long numsessions;                 /* SSL session id cache size */
 147   long sessionage;                  /* number of the most recent session */
 148 };
 149
 150 /****************************************************************************
 151  * HTTP unique setup
 152  ***************************************************************************/
 153 struct HTTP {
 154   struct FormData *sendit;
 155   int postsize;
 156   const char *p_pragma;      /* Pragma: string */
 157   const char *p_accept;      /* Accept: string */
 158   long readbytecount;
 159   long writebytecount;
 160
 161   /* For FORM posting */
 162   struct Form form;
 163   curl_read_callback storefread;
 164   FILE *in;
 165
 166   struct Curl_chunker chunk;
 167 };
 168
 169 /****************************************************************************
 170  * FTP unique setup
 171  ***************************************************************************/
 172 struct FTP {
 173   long *bytecountp;
 174   char *user;    /* user name string */
 175   char *passwd;  /* password string */
 176   char *urlpath; /* the originally given path part of the URL */
 177   char *dir;     /* decoded directory */
 178   char *file;    /* decoded file */
 179
 180   char *entrypath; /* the PWD reply when we logged on */
 181 };
 182
 183 /****************************************************************************
 184  * FILE unique setup
 185  ***************************************************************************/
 186 struct FILE {
 187   int fd; /* open file descriptor to read from! */
 188 };
 189
 190 /*
 191  * Boolean values that concerns this connection.
 192  */
 193 struct ConnectBits {
 194   bool close; /* if set, we close the connection after this request */
 195   bool reuse; /* if set, this is a re-used connection */
 196   bool chunk; /* if set, this is a chunked transfer-encoding */
 197   bool httpproxy; /* if set, this transfer is done through a http proxy */
 198   bool user_passwd;       /* do we use user+password for this connection? */
 199   bool proxy_user_passwd; /* user+password for the proxy? */
 200
 201   bool use_range;
 202   bool rangestringalloc; /* the range string is malloc()'ed */
 203
 204   bool resume_done; /* nothing was transfered, resumed transfer already
 205                        complete */
 206 };
 207
 208 /*
 209  * The connectdata struct contains all fields and variables that should be
 210  * unique for an entire connection.
 211  */
 212 struct connectdata {
 213   /**** Fields set when inited and not modified again */
 214   struct UrlData *data; /* link to the root CURL struct */
 215   int connectindex; /* what index in the connects index this particular
 216                        struct has */
 217
 218   long protocol; /* PROT_* flags concerning the protocol set */
 219 #define PROT_MISSING (1<<0)
 220 #define PROT_GOPHER  (1<<1)
 221 #define PROT_HTTP    (1<<2)
 222 #define PROT_HTTPS   (1<<3)
 223 #define PROT_FTP     (1<<4)
 224 #define PROT_TELNET  (1<<5)
 225 #define PROT_DICT    (1<<6)
 226 #define PROT_LDAP    (1<<7)
 227 #define PROT_FILE    (1<<8)
 228 #define PROT_FTPS    (1<<9)
 229
 230 #ifdef ENABLE_IPV6
 231   struct addrinfo *hp; /* host info pointer list */
 232   struct addrinfo *ai; /* the particular host we use */
 233 #else
 234   char *hostent_buf; /* pointer to allocated memory for name info */
 235   struct hostent *hp;
 236   struct sockaddr_in serv_addr;
 237 #endif
 238   char protostr[64];  /* store the protocol string in this buffer */
 239   char gname[257]; /* store the hostname in this buffer */
 240   char *name;      /* host name pointer to fool around with */
 241   char *path;      /* allocated buffer to store the URL's path part in */
 242   char *hostname;  /* hostname to connect, as parsed from url */
 243   long port;       /* which port to use locally */
 244   unsigned short remote_port; /* what remote port to connect to,
 245                                  not the proxy port! */
 246   char *ppath;
 247   long bytecount;
 248
 249   char *range; /* range, if used. See README for detailed specification on
 250                   this syntax. */
 251   int resume_from; /* continue [ftp] transfer from here */
 252
 253   char *proxyhost; /* name of the http proxy host */
 254
 255   struct timeval now;     /* "current" time */
 256   struct timeval created; /* creation time */
 257   int firstsocket;     /* the main socket to use */
 258   int secondarysocket; /* for i.e ftp transfers */
 259
 260   long upload_bufsize; /* adjust as you see fit, never bigger than BUFSIZE
 261                           never smaller than UPLOAD_BUFSIZE */
 262
 263   long maxdownload; /* in bytes, the maximum amount of data to fetch, 0
 264                        means unlimited */
 265
 266   struct ssl_connect_data ssl; /* this is for ssl-stuff */
 267
 268   struct ConnectBits bits;    /* various state-flags for this connection */
 269
 270   /* These two functions MUST be set by the curl_connect() function to be
 271      be protocol dependent */
 272   CURLcode (*curl_do)(struct connectdata *connect);
 273   CURLcode (*curl_done)(struct connectdata *connect);
 274
 275   /* This function *MAY* be set to a protocol-dependent function that is run
 276    * after the connect() and everything is done, as a step in the connection.
 277    */
 278   CURLcode (*curl_connect)(struct connectdata *connect);
 279
 280   /* This function *MAY* be set to a protocol-dependent function that is run
 281    * by the curl_disconnect(), as a step in the disconnection.
 282    */
 283   CURLcode (*curl_disconnect)(struct connectdata *connect);
 284
 285   /* This function *MAY* be set to a protocol-dependent function that is run
 286    * in the curl_close() function if protocol-specific cleanups are required.
 287    */
 288   CURLcode (*curl_close)(struct connectdata *connect);
 289
 290   /**** curl_get() phase fields */
 291
 292   /* READ stuff */
 293   int sockfd;            /* socket to read from or -1 */
 294   int size;              /* -1 if unknown at this point */
 295   bool getheader;        /* TRUE if header parsing is wanted */
 296   long *bytecountp;      /* return number of bytes read or NULL */
 297
 298   /* WRITE stuff */
 299   int writesockfd;       /* socket to write to, it may very well be
 300                             the same we read from. -1 disables */
 301   long *writebytecountp; /* return number of bytes written or NULL */
 302
 303   /** Dynamicly allocated strings, may need to be freed before this **/
 304   /** struct is killed.                                             **/
 305   struct dynamically_allocated_data {
 306     char *proxyuserpwd; /* free later if not NULL! */
 307     char *uagent; /* free later if not NULL! */
 308     char *userpwd; /* free later if not NULL! */
 309     char *rangeline; /* free later if not NULL! */
 310     char *ref; /* free later if not NULL! */
 311     char *cookie; /* free later if not NULL! */
 312     char *host; /* free later if not NULL */
 313   } allocptr;
 314
 315   char *newurl; /* This can only be set if a Location: was in the
 316                    document headers */
 317
 318 #ifdef KRB4
 319   enum protection_level command_prot;
 320   enum protection_level data_prot;
 321   enum protection_level request_data_prot;
 322
 323   size_t buffer_size;
 324
 325   struct krb4buffer in_buffer, out_buffer;
 326   int sec_complete;
 327   void *app_data;
 328
 329   struct Curl_sec_client_mech *mech;
 330   struct sockaddr_in local_addr;
 331
 332 #endif
 333
 334   /*************** Request - specific items ************/
 335   /* previously this was in the urldata struct */
 336   union {
 337     struct HTTP *http;
 338     struct HTTP *gopher; /* alias, just for the sake of being more readable */
 339     struct HTTP *https;  /* alias, just for the sake of being more readable */
 340     struct FTP *ftp;
 341     struct FILE *file;
 342     void *telnet;        /* private for telnet.c-eyes only */
 343 #if 0 /* no need for special ones for these: */
 344     struct LDAP *ldap;
 345     struct DICT *dict;
 346 #endif
 347     void *generic;
 348   } proto;
 349
 350
 351 };
 352
 353 struct Progress {
 354   long lastshow; /* time() of the last displayed progress meter or NULL to
 355                     force redraw at next call */
 356   double size_dl;
 357   double size_ul;
 358   double downloaded;
 359   double uploaded;
 360
 361   double current_speed; /* uses the currently fastest transfer */
 362
 363   bool callback;  /* set when progress callback is used */
 364   int width; /* screen width at download start */
 365   int flags; /* see progress.h */
 366   double timespent;
 367   double dlspeed;
 368   double ulspeed;
 369
 370   struct timeval start;
 371   struct timeval t_startsingle;
 372   /* various data stored for possible later report */
 373   double t_nslookup;
 374   double t_connect;
 375   double t_pretransfer;
 376   int httpcode;
 377   int httpversion;
 378   time_t filetime; /* If requested, this is might get set. It may be 0 if
 379                       the time was unretrievable */
 380
 381 #define CURR_TIME 5
 382
 383   double speeder[ CURR_TIME ];
 384   int speeder_c;
 385 };
 386
 387 typedef enum {
 388   HTTPREQ_NONE, /* first in list */
 389   HTTPREQ_GET,
 390   HTTPREQ_POST,
 391   HTTPREQ_POST_FORM, /* we make a difference internally */
 392   HTTPREQ_PUT,
 393   HTTPREQ_CUSTOM,
 394   HTTPREQ_LAST /* last in list */
 395 } Curl_HttpReq;
 396
 397 /* This struct is for boolean settings that define how to behave during
 398    this session. */
 399 struct Configbits {
 400   bool get_filetime;
 401   bool tunnel_thru_httpproxy;
 402   bool ftp_append;
 403   bool ftp_ascii;
 404   bool ftp_list_only;
 405   bool ftp_use_port;
 406   bool hide_progress;
 407   bool http_fail_on_error;
 408   bool http_follow_location;
 409   bool http_include_header;
 410   bool http_set_referer;
 411   bool http_auto_referer; /* set "correct" referer when following location: */
 412   bool httpproxy;
 413   bool no_body;
 414   bool set_port;
 415   bool set_range;
 416   bool upload;
 417   bool use_netrc;
 418   bool verbose;
 419   bool this_is_a_follow; /* this is a followed Location: request */
 420   bool krb4; /* kerberos4 connection requested */
 421   bool proxystringalloc; /* the http proxy string is malloc()'ed */
 422   bool urlstringalloc;   /* the URL string is malloc()'ed */
 423   bool reuse_forbid;     /* if this is forbidden to be reused, close
 424                             after use */
 425   bool reuse_fresh;      /* do not re-use an existing connection for this
 426                             transfer */
 427   bool expect100header;  /* TRUE if we added Expect: 100-continue to the
 428                             HTTP header */
 429 };
 430
 431 /*
 432  * As of April 11, 2000 we're now trying to split up the urldata struct in
 433  * three different parts:
 434  *
 435  * (Global)
 436  * 1 - No matter how many hosts and requests that are being performed, this
 437  *     goes for all of them.
 438  *
 439  * (Session)
 440  * 2 - Host and protocol-specific. No matter if we do several transfers to and
 441  *     from this host, these variables stay the same.
 442  *
 443  * (Request)
 444  * 3 - Request-specific. Variables that are of interest for this particular
 445  *     transfer being made right now. THIS IS WRONG STRUCT FOR THOSE.
 446  *
 447  * In Febrary 2001, this is being done stricter. The 'connectdata' struct
 448  * MUST have all the connection oriented stuff as we may now have several
 449  * simultaneous connections and connection structs in memory.
 450  *
 451  * From now on, the 'UrlData' must only contain data that is set once to go
 452  * for many (perhaps) independent connections. Values that are generated or
 453  * calculated internally MUST NOT be a part of this struct.
 454  */
 455
 456 struct UrlData {
 457   /*************** Global - specific items  ************/
 458   FILE *err;    /* the stderr writes goes here */
 459   char *errorbuffer; /* store failure messages in here */
 460
 461   /*************** Session - specific items ************/
 462   char *proxy; /* if proxy, set it here */
 463   char *proxyuserpwd;  /* Proxy <user:password>, if used */
 464   long proxyport; /* If non-zero, use this port number by default. If the
 465                      proxy string features a ":[port]" that one will override
 466                      this. */
 467
 468
 469   long header_size;  /* size of read header(s) in bytes */
 470   long request_size; /* the amount of bytes sent in the request(s) */
 471
 472   void *out;         /* the fetched file goes here */
 473   void *in;          /* the uploaded file is read from here */
 474   void *writeheader; /* write the header to this is non-NULL */
 475
 476   char *url;   /* what to get */
 477   char *freethis; /* if non-NULL, an allocated string for the URL */
 478   long use_port;  /* which port to use (when not using default) */
 479   struct Configbits bits; /* new-style (v7) flag data */
 480   struct ssl_config_data ssl; /* this is for ssl-stuff */
 481
 482   char *userpwd;  /* <user:password>, if used */
 483   char *set_range; /* range, if used. See README for detailed specification on
 484                       this syntax. */
 485
 486   /* stuff related to HTTP */
 487
 488   long followlocation;
 489   long maxredirs; /* maximum no. of http(s) redirects to follow */
 490   char *referer;
 491   bool free_referer; /* set TRUE if 'referer' points to a string we
 492                         allocated */
 493   char *useragent;   /* User-Agent string */
 494   char *postfields; /* if POST, set the fields' values here */
 495   size_t postfieldsize; /* if POST, this might have a size to use instead of
 496                            strlen(), and then the data *may* be binary (contain
 497                            zero bytes) */
 498
 499   /* stuff related to FTP */
 500   char *ftpport; /* port to send with the PORT command */
 501
 502   /* general things */
 503   char *device;  /* Interface to use */
 504
 505   /* function that stores the output:*/
 506   curl_write_callback fwrite;
 507
 508   /* optional function that stores the header output:*/
 509   curl_write_callback fwrite_header;
 510
 511   /* function that reads the input:*/
 512   curl_read_callback fread;
 513
 514   /* function that wants progress information */
 515   curl_progress_callback fprogress;
 516   void *progress_client; /* pointer to pass to the progress callback */
 517
 518   /* function to call instead of the internal for password */
 519   curl_passwd_callback fpasswd;
 520   void *passwd_client; /* pointer to pass to the passwd callback */
 521
 522   long timeout;        /* in seconds, 0 means no timeout */
 523   long connecttimeout; /* in seconds, 0 means no timeout */
 524   long infilesize;     /* size of file to upload, -1 means unknown */
 525
 526   char buffer[BUFSIZE+1]; /* buffer with size BUFSIZE */
 527
 528   double current_speed;  /* the ProgressShow() funcion sets this */
 529
 530   long low_speed_limit; /* bytes/second */
 531   long low_speed_time;  /* number of seconds */
 532
 533   int set_resume_from;    /* continue [ftp] transfer from here */
 534
 535   char *cookie;       /* HTTP cookie string to send */
 536
 537   struct curl_slist *headers; /* linked list of extra headers */
 538   struct HttpPost *httppost;  /* linked list of POST data */
 539
 540   char *cert; /* PEM-formatted certificate */
 541   char *cert_passwd; /* plain text certificate password */
 542
 543   struct CookieInfo *cookies;
 544
 545   long crlf;
 546   struct curl_slist *quote;     /* before the transfer */
 547   struct curl_slist *postquote; /* after the transfer */
 548
 549   /* Telnet negotiation options */
 550   struct curl_slist *telnet_options; /* linked list of telnet options */
 551
 552   TimeCond timecondition; /* kind of comparison */
 553   time_t timevalue;       /* what time to compare with */
 554
 555   Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
 556
 557   char *customrequest; /* http/ftp request to use */
 558
 559   char *headerbuff; /* allocated buffer to store headers in */
 560   int headersize;   /* size of the allocation */
 561
 562   struct Progress progress; /* for all the progress meter data */
 563
 564 #define MAX_CURL_USER_LENGTH 128
 565 #define MAX_CURL_PASSWORD_LENGTH 128
 566
 567   char *auth_host; /* if set, this is the allocated string to the host name
 568                     * to which to send the authorization data to, and no other
 569                     * host (which location-following otherwise could lead to)
 570                     */
 571
 572   /* buffers to store authentication data in */
 573   char user[MAX_CURL_USER_LENGTH];
 574   char passwd[MAX_CURL_PASSWORD_LENGTH];
 575   char proxyuser[MAX_CURL_USER_LENGTH];
 576   char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
 577
 578   char *krb4_level; /* what security level */
 579   struct timeval keeps_speed; /* this should be request-specific */
 580
 581   /* 'connects' will be an allocated array with pointers. If the pointer is
 582      set, it holds an allocated connection. */
 583   struct connectdata **connects;
 584   long numconnects; /* size of the 'connects' array */
 585   curl_closepolicy closepolicy;
 586
 587 };
 588
 589 #define LIBCURL_NAME "libcurl"
 590 #define LIBCURL_ID LIBCURL_NAME " " LIBCURL_VERSION " " SSL_ID
 591
 592
 593 #endif