lib/urldata.h

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