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