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 struct ssl_config_data {
 129   long version;          /* what version the client wants to use */
 130   long certverifyresult; /* result from the certificate verification */
 131   long verifypeer;       /* set TRUE if this is desired */
 132   char *CApath;          /* DOES NOT WORK ON WINDOWS */
 133   char *CAfile;          /* cerficate to verify peer against */
 134   char *random_file;     /* path to file containing "random" data */
 135   char *egdsocket;       /* path to file containing the EGD daemon socket */
 136 };
 137
 138 /****************************************************************************
 139  * HTTP unique setup
 140  ***************************************************************************/
 141 struct HTTP {
 142   struct FormData *sendit;
 143   int postsize;
 144   char *p_pragma;      /* Pragma: string */
 145   char *p_accept;      /* Accept: string */
 146   long readbytecount;
 147   long writebytecount;
 148
 149   /* For FORM posting */
 150   struct Form form;
 151   size_t (*storefread)(char *, size_t , size_t , FILE *);
 152   FILE *in;
 153
 154   struct Curl_chunker chunk;
 155 };
 156
 157 /****************************************************************************
 158  * FTP unique setup
 159  ***************************************************************************/
 160 struct FTP {
 161   long *bytecountp;
 162   char *user;    /* user name string */
 163   char *passwd;  /* password string */
 164   char *urlpath; /* the originally given path part of the URL */
 165   char *dir;     /* decoded directory */
 166   char *file;    /* decoded file */
 167
 168   char *entrypath; /* the PWD reply when we logged on */
 169 };
 170
 171 /****************************************************************************
 172  * FILE unique setup
 173  ***************************************************************************/
 174 struct FILE {
 175   int fd; /* open file descriptor to read from! */
 176 };
 177
 178 /*
 179  * Boolean values that concerns this connection.
 180  */
 181 struct ConnectBits {
 182   bool close; /* if set, we close the connection after this request */
 183   bool reuse; /* if set, this is a re-used connection */
 184   bool chunk; /* if set, this is a chunked transfer-encoding */
 185   bool httpproxy; /* if set, this transfer is done through a http proxy */
 186   bool user_passwd;       /* do we use user+password for this connection? */
 187   bool proxy_user_passwd; /* user+password for the proxy? */
 188 };
 189
 190 /*
 191  * The connectdata struct contains all fields and variables that should be
 192  * unique for an entire connection.
 193  */
 194 struct connectdata {
 195   /**** Fields set when inited and not modified again */
 196   struct UrlData *data; /* link to the root CURL struct */
 197   int connectindex; /* what index in the connects index this particular
 198                        struct has */
 199
 200   long protocol; /* PROT_* flags concerning the protocol set */
 201 #define PROT_MISSING (1<<0)
 202 #define PROT_GOPHER  (1<<1)
 203 #define PROT_HTTP    (1<<2)
 204 #define PROT_HTTPS   (1<<3)
 205 #define PROT_FTP     (1<<4)
 206 #define PROT_TELNET  (1<<5)
 207 #define PROT_DICT    (1<<6)
 208 #define PROT_LDAP    (1<<7)
 209 #define PROT_FILE    (1<<8)
 210 #define PROT_FTPS    (1<<9)
 211
 212 #ifdef ENABLE_IPV6
 213   struct addrinfo *hp; /* host info pointer list */
 214   struct addrinfo *ai; /* the particular host we use */
 215 #else
 216   char *hostent_buf; /* pointer to allocated memory for name info */
 217   struct hostent *hp;
 218   struct sockaddr_in serv_addr;
 219 #endif
 220   char protostr[64];  /* store the protocol string in this buffer */
 221   char gname[257]; /* store the hostname in this buffer */
 222   char *name;      /* host name pointer to fool around with */
 223   char *path;      /* allocated buffer to store the URL's path part in */
 224   char *hostname;  /* hostname to connect, as parsed from url */
 225   long port;       /* which port to use locally */
 226   unsigned short remote_port; /* what remote port to connect to,
 227                                  not the proxy port! */
 228   char *ppath;
 229   long bytecount;
 230
 231   char *proxyhost; /* name of the http proxy host */
 232
 233   struct timeval now;     /* "current" time */
 234   struct timeval created; /* creation time */
 235   int firstsocket;     /* the main socket to use */
 236   int secondarysocket; /* for i.e ftp transfers */
 237
 238   long upload_bufsize; /* adjust as you see fit, never bigger than BUFSIZE
 239                           never smaller than UPLOAD_BUFSIZE */
 240
 241   long maxdownload; /* in bytes, the maximum amount of data to fetch, 0
 242                        means unlimited */
 243
 244   struct ssl_connect_data ssl; /* this is for ssl-stuff */
 245
 246   struct ConnectBits bits;    /* various state-flags for this connection */
 247
 248   /* These two functions MUST be set by the curl_connect() function to be
 249      be protocol dependent */
 250   CURLcode (*curl_do)(struct connectdata *connect);
 251   CURLcode (*curl_done)(struct connectdata *connect);
 252
 253   /* This function *MAY* be set to a protocol-dependent function that is run
 254    * after the connect() and everything is done, as a step in the connection.
 255    */
 256   CURLcode (*curl_connect)(struct connectdata *connect);
 257
 258   /* This function *MAY* be set to a protocol-dependent function that is run
 259    * by the curl_disconnect(), as a step in the disconnection.
 260    */
 261   CURLcode (*curl_disconnect)(struct connectdata *connect);
 262
 263   /* This function *MAY* be set to a protocol-dependent function that is run
 264    * in the curl_close() function if protocol-specific cleanups are required.
 265    */
 266   CURLcode (*curl_close)(struct connectdata *connect);
 267
 268   /**** curl_get() phase fields */
 269
 270   /* READ stuff */
 271   int sockfd;            /* socket to read from or -1 */
 272   int size;              /* -1 if unknown at this point */
 273   bool getheader;        /* TRUE if header parsing is wanted */
 274   long *bytecountp;      /* return number of bytes read or NULL */
 275
 276   /* WRITE stuff */
 277   int writesockfd;       /* socket to write to, it may very well be
 278                             the same we read from. -1 disables */
 279   long *writebytecountp; /* return number of bytes written or NULL */
 280
 281   /** Dynamicly allocated strings, may need to be freed before this **/
 282   /** struct is killed.                                             **/
 283   struct dynamically_allocated_data {
 284     char *proxyuserpwd; /* free later if not NULL! */
 285     char *uagent; /* free later if not NULL! */
 286     char *userpwd; /* free later if not NULL! */
 287     char *rangeline; /* free later if not NULL! */
 288     char *ref; /* free later if not NULL! */
 289     char *cookie; /* free later if not NULL! */
 290     char *host; /* free later if not NULL */
 291   } allocptr;
 292
 293   char *newurl; /* This can only be set if a Location: was in the
 294                    document headers */
 295
 296 #ifdef KRB4
 297   enum protection_level command_prot;
 298   enum protection_level data_prot;
 299   enum protection_level request_data_prot;
 300
 301   size_t buffer_size;
 302
 303   struct krb4buffer in_buffer, out_buffer;
 304   int sec_complete;
 305   void *app_data;
 306
 307 #endif
 308
 309   /*************** Request - specific items ************/
 310   /* previously this was in the urldata struct */
 311   union {
 312     struct HTTP *http;
 313     struct HTTP *gopher; /* alias, just for the sake of being more readable */
 314     struct HTTP *https;  /* alias, just for the sake of being more readable */
 315     struct FTP *ftp;
 316     struct FILE *file;
 317     void *telnet;        /* private for telnet.c-eyes only */
 318 #if 0 /* no need for special ones for these: */
 319     struct LDAP *ldap;
 320     struct DICT *dict;
 321 #endif
 322     void *generic;
 323   } proto;
 324
 325
 326 };
 327
 328 struct Progress {
 329   long lastshow; /* time() of the last displayed progress meter or NULL to
 330                     force redraw at next call */
 331   double size_dl;
 332   double size_ul;
 333   double downloaded;
 334   double uploaded;
 335
 336   double current_speed; /* uses the currently fastest transfer */
 337
 338   bool callback;  /* set when progress callback is used */
 339   int width; /* screen width at download start */
 340   int flags; /* see progress.h */
 341   double timespent;
 342   double dlspeed;
 343   double ulspeed;
 344
 345   struct timeval start;
 346   struct timeval t_startsingle;
 347   /* various data stored for possible later report */
 348   double t_nslookup;
 349   double t_connect;
 350   double t_pretransfer;
 351   int httpcode;
 352   int httpversion;
 353   time_t filetime; /* If requested, this is might get set. It may be 0 if
 354                       the time was unretrievable */
 355
 356 #define CURR_TIME 5
 357
 358   double speeder[ CURR_TIME ];
 359   int speeder_c;
 360 };
 361
 362 typedef enum {
 363   HTTPREQ_NONE, /* first in list */
 364   HTTPREQ_GET,
 365   HTTPREQ_POST,
 366   HTTPREQ_POST_FORM, /* we make a difference internally */
 367   HTTPREQ_PUT,
 368   HTTPREQ_CUSTOM,
 369   HTTPREQ_LAST /* last in list */
 370 } Curl_HttpReq;
 371
 372 /* This struct is for boolean settings that define how to behave during
 373    this session. */
 374 struct Configbits {
 375   /* these four request types mirror the httpreq field */
 376   bool http_formpost;
 377   bool http_post;
 378   bool http_put;
 379   bool http_get;
 380
 381   bool get_filetime;
 382   bool tunnel_thru_httpproxy;
 383   bool ftp_append;
 384   bool ftp_ascii;
 385   bool ftp_list_only;
 386   bool ftp_use_port;
 387   bool hide_progress;
 388   bool http_fail_on_error;
 389   bool http_follow_location;
 390   bool http_include_header;
 391   bool http_set_referer;
 392   bool http_auto_referer; /* set "correct" referer when following location: */
 393   bool httpproxy;
 394   bool mute;
 395   bool no_body;
 396   bool set_port;
 397   bool set_range;
 398   bool upload;
 399   bool use_netrc;
 400   bool verbose;
 401   bool this_is_a_follow; /* this is a followed Location: request */
 402   bool krb4; /* kerberos4 connection requested */
 403   bool proxystringalloc; /* the http proxy string is malloc()'ed */
 404   bool rangestringalloc; /* the range string is malloc()'ed */
 405   bool urlstringalloc;   /* the URL string is malloc()'ed */
 406   bool reuse_forbid;     /* if this is forbidden to be reused, close
 407                             after use */
 408   bool reuse_fresh;      /* do not re-use an existing connection for this
 409                             transfer */
 410 };
 411
 412 /*
 413  * As of April 11, 2000 we're now trying to split up the urldata struct in
 414  * three different parts:
 415  *
 416  * (Global)
 417  * 1 - No matter how many hosts and requests that are being performed, this
 418  *     goes for all of them.
 419  *
 420  * (Session)
 421  * 2 - Host and protocol-specific. No matter if we do several transfers to and
 422  *     from this host, these variables stay the same.
 423  *
 424  * (Request)
 425  * 3 - Request-specific. Variables that are of interest for this particular
 426  *     transfer being made right now. THIS IS WRONG STRUCT FOR THOSE.
 427  *
 428  * In Febrary 2001, this is being done stricter. The 'connectdata' struct
 429  * MUST have all the connection oriented stuff as we may now have several
 430  * simultaneous connections and connection structs in memory.
 431  *
 432  * From now on, the 'UrlData' must only contain data that is set once to go
 433  * for many (perhaps) independent connections. Values that are generated or
 434  * calculated internally MUST NOT be a part of this struct.
 435  */
 436
 437 struct UrlData {
 438   /*************** Global - specific items  ************/
 439   FILE *err;    /* the stderr writes goes here */
 440   char *errorbuffer; /* store failure messages in here */
 441
 442   /*************** Session - specific items ************/
 443   char *proxy; /* if proxy, set it here */
 444   char *proxyuserpwd;  /* Proxy <user:password>, if used */
 445   long proxyport; /* If non-zero, use this port number by default. If the
 446                      proxy string features a ":[port]" that one will override
 447                      this. */
 448
 449
 450   long header_size;  /* size of read header(s) in bytes */
 451   long request_size; /* the amount of bytes sent in the request(s) */
 452
 453   FILE *out;    /* the fetched file goes here */
 454   FILE *in;     /* the uploaded file is read from here */
 455   FILE *writeheader; /* write the header to this is non-NULL */
 456   char *url;   /* what to get */
 457   char *freethis; /* if non-NULL, an allocated string for the URL */
 458   long use_port;  /* which port to use (when not using default) */
 459   struct Configbits bits; /* new-style (v7) flag data */
 460   struct ssl_config_data ssl; /* this is for ssl-stuff */
 461
 462   char *userpwd;  /* <user:password>, if used */
 463   char *range; /* range, if used. See README for detailed specification on
 464                   this syntax. */
 465
 466   /* stuff related to HTTP */
 467
 468   long followlocation;
 469   long maxredirs; /* maximum no. of http(s) redirects to follow */
 470   char *referer;
 471   bool free_referer; /* set TRUE if 'referer' points to a string we
 472                         allocated */
 473   char *useragent;   /* User-Agent string */
 474   char *postfields; /* if POST, set the fields' values here */
 475   long postfieldsize; /* if POST, this might have a size to use instead of
 476                          strlen(), and then the data *may* be binary (contain
 477                          zero bytes) */
 478
 479   /* stuff related to FTP */
 480   char *ftpport; /* port to send with the PORT command */
 481
 482   /* general things */
 483   char *device;  /* Interface to use */
 484
 485   /* function that stores the output:*/
 486   curl_write_callback fwrite;
 487
 488   /* optional function that stores the header output:*/
 489   curl_write_callback fwrite_header;
 490
 491   /* function that reads the input:*/
 492   curl_read_callback fread;
 493
 494   /* function that wants progress information */
 495   curl_progress_callback fprogress;
 496   void *progress_client; /* pointer to pass to the progress callback */
 497
 498   /* function to call instead of the internal for password */
 499   curl_passwd_callback fpasswd;
 500   void *passwd_client; /* pointer to pass to the passwd callback */
 501
 502   long timeout;        /* in seconds, 0 means no timeout */
 503   long connecttimeout; /* in seconds, 0 means no timeout */
 504   long infilesize;     /* size of file to upload, -1 means unknown */
 505
 506   char buffer[BUFSIZE+1]; /* buffer with size BUFSIZE */
 507
 508   double current_speed;  /* the ProgressShow() funcion sets this */
 509
 510   long low_speed_limit; /* bytes/second */
 511   long low_speed_time;  /* number of seconds */
 512
 513   int resume_from;    /* continue [ftp] transfer from here */
 514
 515   char *cookie;       /* HTTP cookie string to send */
 516
 517   struct curl_slist *headers; /* linked list of extra headers */
 518   struct HttpPost *httppost;  /* linked list of POST data */
 519
 520   char *cert; /* PEM-formatted certificate */
 521   char *cert_passwd; /* plain text certificate password */
 522
 523   struct CookieInfo *cookies;
 524
 525   long crlf;
 526   struct curl_slist *quote;     /* before the transfer */
 527   struct curl_slist *postquote; /* after the transfer */
 528
 529   /* Telnet negotiation options */
 530   struct curl_slist *telnet_options; /* linked list of telnet options */
 531
 532   TimeCond timecondition; /* kind of comparison */
 533   time_t timevalue;       /* what time to compare with */
 534
 535   Curl_HttpReq httpreq; /* what kind of HTTP request (if any) is this */
 536
 537   char *customrequest; /* http/ftp request to use */
 538
 539   char *headerbuff; /* allocated buffer to store headers in */
 540   int headersize;   /* size of the allocation */
 541
 542   struct Progress progress; /* for all the progress meter data */
 543
 544 #define MAX_CURL_USER_LENGTH 128
 545 #define MAX_CURL_PASSWORD_LENGTH 128
 546
 547   char *auth_host; /* if set, this is the allocated string to the host name
 548                     * to which to send the authorization data to, and no other
 549                     * host (which location-following otherwise could lead to)
 550                     */
 551
 552   /* buffers to store authentication data in */
 553   char user[MAX_CURL_USER_LENGTH];
 554   char passwd[MAX_CURL_PASSWORD_LENGTH];
 555   char proxyuser[MAX_CURL_USER_LENGTH];
 556   char proxypasswd[MAX_CURL_PASSWORD_LENGTH];
 557
 558   char *krb4_level; /* what security level */
 559   struct timeval keeps_speed; /* this should be request-specific */
 560
 561   /* 'connects' will be an allocated array with pointers. If the pointer is
 562      set, it holds an allocated connection. */
 563   struct connectdata **connects;
 564   size_t numconnects; /* size of the 'connects' array */
 565   curl_closepolicy closepolicy;
 566
 567 };
 568
 569 #define LIBCURL_NAME "libcurl"
 570 #define LIBCURL_ID LIBCURL_NAME " " LIBCURL_VERSION " " SSL_ID
 571
 572 CURLcode Curl_getinfo(CURL *curl, CURLINFO info, ...);
 573
 574 /*
 575  * Here follows function prototypes from what we used to plan to call
 576  * the "low level" interface. It is no longer prioritized and it is not likely
 577  * to ever be supported to external users.
 578  *
 579  * I removed all the comments to them as well, as they were no longer accurate
 580  * and they're not meant for "public use" anymore.
 581  */
 582
 583 CURLcode Curl_open(CURL **curl, char *url);
 584 CURLcode Curl_setopt(CURL *handle, CURLoption option, ...);
 585 CURLcode Curl_close(CURL *curl); /* the opposite of curl_open() */
 586 CURLcode Curl_connect(struct UrlData *,
 587                       struct connectdata **,
 588                       bool allow_port);
 589 CURLcode Curl_do(struct connectdata *);
 590 CURLcode Curl_done(struct connectdata *);
 591 CURLcode Curl_disconnect(struct connectdata *);
 592
 593
 594 #endif