Git init
[external/curl.git] / lib / urldata.h
1 #ifndef __URLDATA_H
2 #define __URLDATA_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at http://curl.haxx.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  ***************************************************************************/
24
25 /* This file is for lib internal stuff */
26
27 #include "setup.h"
28
29 #define PORT_FTP 21
30 #define PORT_FTPS 990
31 #define PORT_TELNET 23
32 #define PORT_HTTP 80
33 #define PORT_HTTPS 443
34 #define PORT_DICT 2628
35 #define PORT_LDAP 389
36 #define PORT_LDAPS 636
37 #define PORT_TFTP 69
38 #define PORT_SSH 22
39 #define PORT_IMAP 143
40 #define PORT_IMAPS 993
41 #define PORT_POP3 110
42 #define PORT_POP3S 995
43 #define PORT_SMTP 25
44 #define PORT_SMTPS 465 /* sometimes called SSMTP */
45 #define PORT_RTSP 554
46 #define PORT_RTMP 1935
47 #define PORT_RTMPT PORT_HTTP
48 #define PORT_RTMPS PORT_HTTPS
49 #define PORT_GOPHER 70
50
51 #define DICT_MATCH "/MATCH:"
52 #define DICT_MATCH2 "/M:"
53 #define DICT_MATCH3 "/FIND:"
54 #define DICT_DEFINE "/DEFINE:"
55 #define DICT_DEFINE2 "/D:"
56 #define DICT_DEFINE3 "/LOOKUP:"
57
58 #define CURL_DEFAULT_USER "anonymous"
59 #define CURL_DEFAULT_PASSWORD "ftp@example.com"
60
61 /* length of longest IPv6 address string including the trailing null */
62 #define MAX_IPADR_LEN sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")
63
64 /* Default FTP/IMAP etc response timeout in milliseconds.
65    Symbian OS panics when given a timeout much greater than 1/2 hour.
66 */
67 #define RESP_TIMEOUT (1800*1000)
68
69 #include "cookie.h"
70 #include "formdata.h"
71
72 #ifdef USE_SSLEAY
73 #ifdef USE_OPENSSL
74 #include "openssl/rsa.h"
75 #include "openssl/crypto.h"
76 #include "openssl/x509.h"
77 #include "openssl/pem.h"
78 #include "openssl/ssl.h"
79 #include "openssl/err.h"
80 #ifdef HAVE_OPENSSL_ENGINE_H
81 #include <openssl/engine.h>
82 #endif
83 #ifdef HAVE_OPENSSL_PKCS12_H
84 #include <openssl/pkcs12.h>
85 #endif
86 #else /* SSLeay-style includes */
87 #include "rsa.h"
88 #include "crypto.h"
89 #include "x509.h"
90 #include "pem.h"
91 #include "ssl.h"
92 #include "err.h"
93 #ifdef HAVE_OPENSSL_ENGINE_H
94 #include <engine.h>
95 #endif
96 #ifdef HAVE_OPENSSL_PKCS12_H
97 #include <pkcs12.h>
98 #endif
99 #endif /* USE_OPENSSL */
100 #ifdef USE_GNUTLS
101 #error Configuration error; cannot use GnuTLS *and* OpenSSL.
102 #endif
103 #endif /* USE_SSLEAY */
104
105 #ifdef USE_GNUTLS
106 #include <gnutls/gnutls.h>
107 #endif
108
109 #ifdef USE_POLARSSL
110 #include <polarssl/havege.h>
111 #include <polarssl/ssl.h>
112 #endif
113
114 #ifdef USE_NSS
115 #include <nspr.h>
116 #include <pk11pub.h>
117 #endif
118
119 #ifdef USE_QSOSSL
120 #include <qsossl.h>
121 #endif
122
123 #ifdef HAVE_NETINET_IN_H
124 #include <netinet/in.h>
125 #endif
126
127 #include "timeval.h"
128
129 #ifdef HAVE_ZLIB_H
130 #include <zlib.h>               /* for content-encoding */
131 #ifdef __SYMBIAN32__
132 /* zlib pollutes the namespace with this definition */
133 #undef WIN32
134 #endif
135 #endif
136
137 #ifdef USE_ARES
138 #  if defined(CURL_STATICLIB) && !defined(CARES_STATICLIB) && \
139      (defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__))
140 #    define CARES_STATICLIB
141 #  endif
142 #  include <ares.h>
143 #endif
144
145 #include <curl/curl.h>
146
147 #include "http_chunks.h" /* for the structs and enum stuff */
148 #include "hostip.h"
149 #include "hash.h"
150 #include "splay.h"
151
152 #include "imap.h"
153 #include "pop3.h"
154 #include "smtp.h"
155 #include "ftp.h"
156 #include "file.h"
157 #include "ssh.h"
158 #include "http.h"
159 #include "rtsp.h"
160 #include "wildcard.h"
161
162 #ifdef HAVE_GSSAPI
163 # ifdef HAVE_GSSGNU
164 #  include <gss.h>
165 # elif defined HAVE_GSSMIT
166 #  include <gssapi/gssapi.h>
167 #  include <gssapi/gssapi_generic.h>
168 # else
169 #  include <gssapi.h>
170 # endif
171 #endif
172
173 #ifdef HAVE_LIBSSH2_H
174 #include <libssh2.h>
175 #include <libssh2_sftp.h>
176 #endif /* HAVE_LIBSSH2_H */
177
178 /* Download buffer size, keep it fairly big for speed reasons */
179 #undef BUFSIZE
180 #define BUFSIZE CURL_MAX_WRITE_SIZE
181
182 /* Initial size of the buffer to store headers in, it'll be enlarged in case
183    of need. */
184 #define HEADERSIZE 256
185
186 #define CURLEASY_MAGIC_NUMBER 0xc0dedbadU
187
188 /* Some convenience macros to get the larger/smaller value out of two given.
189    We prefix with CURL to prevent name collisions. */
190 #define CURLMAX(x,y) ((x)>(y)?(x):(y))
191 #define CURLMIN(x,y) ((x)<(y)?(x):(y))
192
193
194 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
195 /* Types needed for krb4/5-ftp connections */
196 struct krb4buffer {
197   void *data;
198   size_t size;
199   size_t index;
200   int eof_flag;
201 };
202
203 enum protection_level {
204   PROT_NONE, /* first in list */
205   PROT_CLEAR,
206   PROT_SAFE,
207   PROT_CONFIDENTIAL,
208   PROT_PRIVATE,
209   PROT_CMD,
210   PROT_LAST /* last in list */
211 };
212 #endif
213
214 /* enum for the nonblocking SSL connection state machine */
215 typedef enum {
216   ssl_connect_1,
217   ssl_connect_2,
218   ssl_connect_2_reading,
219   ssl_connect_2_writing,
220   ssl_connect_3,
221   ssl_connect_done
222 } ssl_connect_state;
223
224 typedef enum {
225   ssl_connection_none,
226   ssl_connection_negotiating,
227   ssl_connection_complete
228 } ssl_connection_state;
229
230 /* struct for data related to each SSL connection */
231 struct ssl_connect_data {
232   /* Use ssl encrypted communications TRUE/FALSE, not necessarily using it atm
233      but at least asked to or meaning to use it. See 'state' for the exact
234      current state of the connection. */
235   bool use;
236   ssl_connection_state state;
237 #ifdef USE_SSLEAY
238   /* these ones requires specific SSL-types */
239   SSL_CTX* ctx;
240   SSL*     handle;
241   X509*    server_cert;
242   ssl_connect_state connecting_state;
243 #endif /* USE_SSLEAY */
244 #ifdef USE_GNUTLS
245   gnutls_session session;
246   gnutls_certificate_credentials cred;
247   ssl_connect_state connecting_state;
248 #endif /* USE_GNUTLS */
249 #ifdef USE_POLARSSL
250   havege_state hs;
251   ssl_context ssl;
252   ssl_session ssn;
253   int server_fd;
254   x509_cert cacert;
255   x509_cert clicert;
256   x509_crl crl;
257   rsa_context rsa;
258 #endif /* USE_POLARSSL */
259 #ifdef USE_NSS
260   PRFileDesc *handle;
261   char *client_nickname;
262   struct SessionHandle *data;
263 #ifdef HAVE_PK11_CREATEGENERICOBJECT
264   PK11GenericObject *key;
265   PK11GenericObject *cacert[2];
266 #endif
267 #endif /* USE_NSS */
268 #ifdef USE_QSOSSL
269   SSLHandle *handle;
270 #endif /* USE_QSOSSL */
271 };
272
273 struct ssl_config_data {
274   long version;          /* what version the client wants to use */
275   long certverifyresult; /* result from the certificate verification */
276   long verifypeer;       /* set TRUE if this is desired */
277   long verifyhost;       /* 0: no verify
278                             1: check that CN exists
279                             2: CN must match hostname */
280   char *CApath;          /* certificate dir (doesn't work on windows) */
281   char *CAfile;          /* certificate to verify peer against */
282   const char *CRLfile;   /* CRL to check certificate revocation */
283   const char *issuercert;/* optional issuer certificate filename */
284   char *random_file;     /* path to file containing "random" data */
285   char *egdsocket;       /* path to file containing the EGD daemon socket */
286   char *cipher_list;     /* list of ciphers to use */
287   long numsessions;      /* SSL session id cache size */
288   curl_ssl_ctx_callback fsslctx; /* function to initialize ssl ctx */
289   void *fsslctxp;        /* parameter for call back */
290   bool sessionid;        /* cache session IDs or not */
291   bool certinfo;         /* gather lots of certificate info */
292 };
293
294 /* information stored about one single SSL session */
295 struct curl_ssl_session {
296   char *name;       /* host name for which this ID was used */
297   void *sessionid;  /* as returned from the SSL layer */
298   size_t idsize;    /* if known, otherwise 0 */
299   long age;         /* just a number, the higher the more recent */
300   unsigned short remote_port; /* remote port to connect to */
301   struct ssl_config_data ssl_config; /* setup for this session */
302 };
303
304 /* Struct used for Digest challenge-response authentication */
305 struct digestdata {
306   char *nonce;
307   char *cnonce;
308   char *realm;
309   int algo;
310   bool stale; /* set true for re-negotiation */
311   char *opaque;
312   char *qop;
313   char *algorithm;
314   int nc; /* nounce count */
315 };
316
317 typedef enum {
318   NTLMSTATE_NONE,
319   NTLMSTATE_TYPE1,
320   NTLMSTATE_TYPE2,
321   NTLMSTATE_TYPE3,
322   NTLMSTATE_LAST
323 } curlntlm;
324
325 #ifdef USE_WINDOWS_SSPI
326 #include "curl_sspi.h"
327 #endif
328
329 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
330 #include <iconv.h>
331 #endif
332
333 /* Struct used for NTLM challenge-response authentication */
334 struct ntlmdata {
335   curlntlm state;
336 #ifdef USE_WINDOWS_SSPI
337   CredHandle handle;
338   CtxtHandle c_handle;
339   SEC_WINNT_AUTH_IDENTITY identity;
340   SEC_WINNT_AUTH_IDENTITY *p_identity;
341   int has_handles;
342   void *type_2;
343   int n_type_2;
344 #else
345   unsigned int flags;
346   unsigned char nonce[8];
347 #endif
348 };
349
350 #ifdef HAVE_GSSAPI
351 struct negotiatedata {
352   /* when doing Negotiate we first need to receive an auth token and then we
353      need to send our header */
354   enum { GSS_AUTHNONE, GSS_AUTHRECV, GSS_AUTHSENT } state;
355   bool gss; /* Whether we're processing GSS-Negotiate or Negotiate */
356   const char* protocol; /* "GSS-Negotiate" or "Negotiate" */
357   OM_uint32 status;
358   gss_ctx_id_t context;
359   gss_name_t server_name;
360   gss_buffer_desc output_token;
361 };
362 #endif
363
364
365 /*
366  * Boolean values that concerns this connection.
367  */
368 struct ConnectBits {
369   bool close; /* if set, we close the connection after this request */
370   bool reuse; /* if set, this is a re-used connection */
371   bool proxy; /* if set, this transfer is done through a proxy - any type */
372   bool httpproxy;    /* if set, this transfer is done through a http proxy */
373   bool user_passwd;    /* do we use user+password for this connection? */
374   bool proxy_user_passwd; /* user+password for the proxy? */
375   bool ipv6_ip; /* we communicate with a remote site specified with pure IPv6
376                    IP address */
377   bool ipv6;    /* we communicate with a site using an IPv6 address */
378
379   bool do_more; /* this is set TRUE if the ->curl_do_more() function is
380                    supposed to be called, after ->curl_do() */
381
382   bool tcpconnect;    /* the TCP layer (or similar) is connected, this is set
383                          the first time on the first connect function call */
384   bool protoconnstart;/* the protocol layer has STARTED its operation after
385                          the TCP layer connect */
386
387   bool retry;         /* this connection is about to get closed and then
388                          re-attempted at another connection. */
389   bool tunnel_proxy;  /* if CONNECT is used to "tunnel" through the proxy.
390                          This is implicit when SSL-protocols are used through
391                          proxies, but can also be enabled explicitly by
392                          apps */
393   bool tunnel_connecting; /* TRUE while we're still waiting for a proxy CONNECT
394                            */
395   bool authneg;       /* TRUE when the auth phase has started, which means
396                          that we are creating a request with an auth header,
397                          but it is not the final request in the auth
398                          negotiation. */
399   bool rewindaftersend;/* TRUE when the sending couldn't be stopped even
400                           though it will be discarded. When the whole send
401                           operation is done, we must call the data rewind
402                           callback. */
403   bool ftp_use_epsv;  /* As set with CURLOPT_FTP_USE_EPSV, but if we find out
404                          EPSV doesn't work we disable it for the forthcoming
405                          requests */
406
407   bool ftp_use_eprt;  /* As set with CURLOPT_FTP_USE_EPRT, but if we find out
408                          EPRT doesn't work we disable it for the forthcoming
409                          requests */
410   bool netrc;         /* name+password provided by netrc */
411   bool userpwd_in_url; /* name+password found in url */
412
413   bool done;          /* set to FALSE when Curl_do() is called and set to TRUE
414                          when Curl_done() is called, to prevent Curl_done() to
415                          get invoked twice when the multi interface is
416                          used. */
417   bool stream_was_rewound; /* Indicates that the stream was rewound after a
418                               request read past the end of its response byte
419                               boundary */
420   bool proxy_connect_closed; /* set true if a proxy disconnected the
421                                 connection in a CONNECT request with auth, so
422                                 that libcurl should reconnect and continue. */
423   bool bound; /* set true if bind() has already been done on this socket/
424                  connection */
425   bool type_set;  /* type= was used in the URL */
426 };
427
428 struct hostname {
429   char *rawalloc; /* allocated "raw" version of the name */
430   char *encalloc; /* allocated IDN-encoded version of the name */
431   char *name;     /* name to use internally, might be encoded, might be raw */
432   const char *dispname; /* name to display, as 'name' might be encoded */
433 };
434
435 /*
436  * Flags on the keepon member of the Curl_transfer_keeper
437  */
438
439 #define KEEP_NONE  0
440 #define KEEP_RECV  (1<<0)     /* there is or may be data to read */
441 #define KEEP_SEND (1<<1)     /* there is or may be data to write */
442 #define KEEP_RECV_HOLD (1<<2) /* when set, no reading should be done but there
443                                  might still be data to read */
444 #define KEEP_SEND_HOLD (1<<3) /* when set, no writing should be done but there
445                                   might still be data to write */
446 #define KEEP_RECV_PAUSE (1<<4) /* reading is paused */
447 #define KEEP_SEND_PAUSE (1<<5) /* writing is paused */
448
449 #define KEEP_RECVBITS (KEEP_RECV | KEEP_RECV_HOLD | KEEP_RECV_PAUSE)
450 #define KEEP_SENDBITS (KEEP_SEND | KEEP_SEND_HOLD | KEEP_SEND_PAUSE)
451
452
453 #ifdef HAVE_LIBZ
454 typedef enum {
455   ZLIB_UNINIT,          /* uninitialized */
456   ZLIB_INIT,            /* initialized */
457   ZLIB_GZIP_HEADER,     /* reading gzip header */
458   ZLIB_GZIP_INFLATING,  /* inflating gzip stream */
459   ZLIB_INIT_GZIP        /* initialized in transparent gzip mode */
460 } zlibInitState;
461 #endif
462
463 #ifdef CURLRES_ASYNCH
464 struct Curl_async {
465   char *hostname;
466   int port;
467   struct Curl_dns_entry *dns;
468   bool done;  /* set TRUE when the lookup is complete */
469   int status; /* if done is TRUE, this is the status from the callback */
470   void *os_specific;  /* 'struct thread_data' for Windows */
471 };
472 #endif
473
474 #define FIRSTSOCKET     0
475 #define SECONDARYSOCKET 1
476
477 /* These function pointer types are here only to allow easier typecasting
478    within the source when we need to cast between data pointers (such as NULL)
479    and function pointers. */
480 typedef CURLcode (*Curl_do_more_func)(struct connectdata *);
481 typedef CURLcode (*Curl_done_func)(struct connectdata *, CURLcode, bool);
482
483
484 enum expect100 {
485   EXP100_SEND_DATA,           /* enough waiting, just send the body now */
486   EXP100_AWAITING_CONTINUE,   /* waiting for the 100 Continue header */
487   EXP100_SENDING_REQUEST,     /* still sending the request but will wait for
488                                  the 100 header once done with the request */
489   EXP100_FAILED               /* used on 417 Expectation Failed */
490 };
491
492 /*
493  * Request specific data in the easy handle (SessionHandle).  Previously,
494  * these members were on the connectdata struct but since a conn struct may
495  * now be shared between different SessionHandles, we store connection-specific
496  * data here. This struct only keeps stuff that's interesting for *this*
497  * request, as it will be cleared between multiple ones
498  */
499 struct SingleRequest {
500   curl_off_t size;        /* -1 if unknown at this point */
501   curl_off_t *bytecountp; /* return number of bytes read or NULL */
502
503   curl_off_t maxdownload; /* in bytes, the maximum amount of data to fetch,
504                              -1 means unlimited */
505   curl_off_t *writebytecountp; /* return number of bytes written or NULL */
506
507   curl_off_t bytecount;         /* total number of bytes read */
508   curl_off_t writebytecount;    /* number of bytes written */
509
510   long headerbytecount;         /* only count received headers */
511   long deductheadercount; /* this amount of bytes doesn't count when we check
512                              if anything has been transfered at the end of a
513                              connection. We use this counter to make only a
514                              100 reply (without a following second response
515                              code) result in a CURLE_GOT_NOTHING error code */
516
517   struct timeval start;         /* transfer started at this time */
518   struct timeval now;           /* current time */
519   bool header;                  /* incoming data has HTTP header */
520   enum {
521     HEADER_NORMAL,              /* no bad header at all */
522     HEADER_PARTHEADER,          /* part of the chunk is a bad header, the rest
523                                    is normal data */
524     HEADER_ALLBAD               /* all was believed to be header */
525   } badheader;                  /* the header was deemed bad and will be
526                                    written as body */
527   int headerline;               /* counts header lines to better track the
528                                    first one */
529   char *hbufp;                  /* points at *end* of header line */
530   size_t hbuflen;
531   char *str;                    /* within buf */
532   char *str_start;              /* within buf */
533   char *end_ptr;                /* within buf */
534   char *p;                      /* within headerbuff */
535   bool content_range;           /* set TRUE if Content-Range: was found */
536   curl_off_t offset;            /* possible resume offset read from the
537                                    Content-Range: header */
538   int httpcode;                 /* error code from the 'HTTP/1.? XXX' or
539                                    'RTSP/1.? XXX' line */
540   struct timeval start100;      /* time stamp to wait for the 100 code from */
541   enum expect100 exp100;        /* expect 100 continue state */
542
543   int content_encoding;         /* What content encoding. sec 3.5, RFC2616. */
544
545 #define IDENTITY 0              /* No encoding */
546 #define DEFLATE 1               /* zlib deflate [RFC 1950 & 1951] */
547 #define GZIP 2                  /* gzip algorithm [RFC 1952] */
548 #define COMPRESS 3              /* Not handled, added for completeness */
549
550 #ifdef HAVE_LIBZ
551   zlibInitState zlib_init;      /* possible zlib init state;
552                                    undefined if Content-Encoding header. */
553   z_stream z;                   /* State structure for zlib. */
554 #endif
555
556   time_t timeofdoc;
557   long bodywrites;
558
559   char *buf;
560   char *uploadbuf;
561   curl_socket_t maxfd;
562
563   int keepon;
564
565   bool upload_done; /* set to TRUE when doing chunked transfer-encoding upload
566                        and we're uploading the last chunk */
567
568   bool ignorebody;  /* we read a response-body but we ignore it! */
569   bool ignorecl;    /* This HTTP response has no body so we ignore the Content-
570                        Length: header */
571
572   char *location;   /* This points to an allocated version of the Location:
573                        header data */
574   char *newurl;     /* Set to the new URL to use when a redirect or a retry is
575                        wanted */
576
577   /* 'upload_present' is used to keep a byte counter of how much data there is
578      still left in the buffer, aimed for upload. */
579   ssize_t upload_present;
580
581    /* 'upload_fromhere' is used as a read-pointer when we uploaded parts of a
582       buffer, so the next read should read from where this pointer points to,
583       and the 'upload_present' contains the number of bytes available at this
584       position */
585   char *upload_fromhere;
586
587   bool chunk; /* if set, this is a chunked transfer-encoding */
588   bool upload_chunky; /* set TRUE if we are doing chunked transfer-encoding
589                          on upload */
590   bool getheader;     /* TRUE if header parsing is wanted */
591
592   bool forbidchunk;   /* used only to explicitly forbid chunk-upload for
593                          specific upload buffers. See readmoredata() in
594                          http.c for details. */
595 };
596
597 /*
598  * Specific protocol handler.
599  */
600
601 struct Curl_handler {
602   const char * scheme;        /* URL scheme name. */
603
604   /* Complement to setup_connection_internals(). */
605   CURLcode (*setup_connection)(struct connectdata *);
606
607   /* These two functions MUST be set to be protocol dependent */
608   CURLcode (*do_it)(struct connectdata *, bool *done);
609   Curl_done_func done;
610
611   /* If the curl_do() function is better made in two halves, this
612    * curl_do_more() function will be called afterwards, if set. For example
613    * for doing the FTP stuff after the PASV/PORT command.
614    */
615   Curl_do_more_func do_more;
616
617   /* This function *MAY* be set to a protocol-dependent function that is run
618    * after the connect() and everything is done, as a step in the connection.
619    * The 'done' pointer points to a bool that should be set to TRUE if the
620    * function completes before return. If it doesn't complete, the caller
621    * should call the curl_connecting() function until it is.
622    */
623   CURLcode (*connect_it)(struct connectdata *, bool *done);
624
625   /* See above. Currently only used for FTP. */
626   CURLcode (*connecting)(struct connectdata *, bool *done);
627   CURLcode (*doing)(struct connectdata *, bool *done);
628
629   /* Called from the multi interface during the PROTOCONNECT phase, and it
630      should then return a proper fd set */
631   int (*proto_getsock)(struct connectdata *conn,
632                        curl_socket_t *socks,
633                        int numsocks);
634
635   /* Called from the multi interface during the DOING phase, and it should
636      then return a proper fd set */
637   int (*doing_getsock)(struct connectdata *conn,
638                        curl_socket_t *socks,
639                        int numsocks);
640
641   /* Called from the multi interface during the DO_DONE, PERFORM and
642      WAITPERFORM phases, and it should then return a proper fd set. Not setting
643      this will make libcurl use the generic default one. */
644   int (*perform_getsock)(const struct connectdata *conn,
645                          curl_socket_t *socks,
646                          int numsocks);
647
648   /* This function *MAY* be set to a protocol-dependent function that is run
649    * by the curl_disconnect(), as a step in the disconnection.  If the handler
650    * is called because the connection has been considered dead, dead_connection
651    * is set to TRUE.
652    */
653   CURLcode (*disconnect)(struct connectdata *, bool dead_connection);
654
655   long defport;       /* Default port. */
656   long protocol;      /* PROT_* flags concerning the protocol set */
657 };
658
659 /* return the count of bytes sent, or -1 on error */
660 typedef ssize_t (Curl_send)(struct connectdata *conn, /* connection data */
661                             int sockindex,            /* socketindex */
662                             const void *buf,          /* data to write */
663                             size_t len,               /* max amount to write */
664                             CURLcode *err);           /* error to return */
665
666 /* return the count of bytes read, or -1 on error */
667 typedef ssize_t (Curl_recv)(struct connectdata *conn, /* connection data */
668                             int sockindex,            /* socketindex */
669                             char *buf,                /* store data here */
670                             size_t len,               /* max amount to read */
671                             CURLcode *err);           /* error to return */
672
673 /*
674  * The connectdata struct contains all fields and variables that should be
675  * unique for an entire connection.
676  */
677 struct connectdata {
678   /* 'data' is the CURRENT SessionHandle using this connection -- take great
679      caution that this might very well vary between different times this
680      connection is used! */
681   struct SessionHandle *data;
682
683   /* chunk is for HTTP chunked encoding, but is in the general connectdata
684      struct only because we can do just about any protocol through a HTTP proxy
685      and a HTTP proxy may in fact respond using chunked encoding */
686   struct Curl_chunker chunk;
687
688   bool inuse; /* This is a marker for the connection cache logic. If this is
689                  TRUE this handle is being used by an easy handle and cannot
690                  be used by any other easy handle without careful
691                  consideration (== only for pipelining). */
692
693   /**** Fields set when inited and not modified again */
694   long connectindex; /* what index in the connection cache connects index this
695                         particular struct has */
696   long protocol; /* PROT_* flags concerning the protocol set */
697 #define PROT_HTTP    CURLPROTO_HTTP
698 #define PROT_HTTPS   CURLPROTO_HTTPS
699 #define PROT_FTP     CURLPROTO_FTP
700 #define PROT_TELNET  CURLPROTO_TELNET
701 #define PROT_DICT    CURLPROTO_DICT
702 #define PROT_LDAP    CURLPROTO_LDAP
703 #define PROT_FILE    CURLPROTO_FILE
704 #define PROT_FTPS    CURLPROTO_FTPS
705 #define PROT_TFTP    CURLPROTO_TFTP
706 #define PROT_SCP     CURLPROTO_SCP
707 #define PROT_SFTP    CURLPROTO_SFTP
708 #define PROT_IMAP    CURLPROTO_IMAP
709 #define PROT_IMAPS   CURLPROTO_IMAPS
710 #define PROT_POP3    CURLPROTO_POP3
711 #define PROT_POP3S   CURLPROTO_POP3S
712 #define PROT_SMTP    CURLPROTO_SMTP
713 #define PROT_SMTPS   CURLPROTO_SMTPS
714 #define PROT_RTSP    CURLPROTO_RTSP
715 #define PROT_RTMP    CURLPROTO_RTMP
716 #define PROT_RTMPT   CURLPROTO_RTMPT
717 #define PROT_RTMPE   CURLPROTO_RTMPE
718 #define PROT_RTMPTE  CURLPROTO_RTMPTE
719 #define PROT_RTMPS   CURLPROTO_RTMPS
720 #define PROT_RTMPTS  CURLPROTO_RTMPTS
721 #define PROT_GOPHER  CURLPROTO_GOPHER
722
723 /* (1<<25) is currently the highest used bit in the public bitmask. We make
724    sure we use "private bits" above the public ones to make things easier;
725    Gopher will not conflict with the current bit 25. */
726
727 #define PROT_EXTMASK 0x03ffffff
728
729 #define PROT_SSL     (1<<29) /* protocol requires SSL */
730
731 /* these ones need action before socket close */
732 #define PROT_CLOSEACTION (PROT_FTP | PROT_IMAP | PROT_POP3)
733 #define PROT_DUALCHANNEL PROT_FTP /* these protocols use two connections */
734
735   /* 'dns_entry' is the particular host we use. This points to an entry in the
736      DNS cache and it will not get pruned while locked. It gets unlocked in
737      Curl_done(). This entry will be NULL if the connection is re-used as then
738      there is no name resolve done. */
739   struct Curl_dns_entry *dns_entry;
740
741   /* 'ip_addr' is the particular IP we connected to. It points to a struct
742      within the DNS cache, so this pointer is only valid as long as the DNS
743      cache entry remains locked. It gets unlocked in Curl_done() */
744   Curl_addrinfo *ip_addr;
745
746   /* 'ip_addr_str' is the ip_addr data as a human readable string.
747      It remains available as long as the connection does, which is longer than
748      the ip_addr itself. */
749   char ip_addr_str[MAX_IPADR_LEN];
750
751   unsigned int scope;    /* address scope for IPv6 */
752
753   int socktype;  /* SOCK_STREAM or SOCK_DGRAM */
754
755   struct hostname host;
756   struct hostname proxy;
757
758   long port;       /* which port to use locally */
759   unsigned short remote_port; /* what remote port to connect to,
760                                  not the proxy port! */
761
762   /* 'primary_ip' and 'primary_port' get filled with peer's numerical
763      ip address and port number whenever an outgoing connection is
764      *attemted* from the primary socket to a remote address. When more
765      than one address is tried for a connection these will hold data
766      for the last attempt. When the connection is actualy established
767      these are updated with data which comes directly from the socket. */
768
769   char primary_ip[MAX_IPADR_LEN];
770   long primary_port;
771
772   /* 'local_ip' and 'local_port' get filled with local's numerical
773      ip address and port number whenever an outgoing connection is
774      **established** from the primary socket to a remote address. */
775
776   char local_ip[MAX_IPADR_LEN];
777   long local_port;
778
779   char *user;    /* user name string, allocated */
780   char *passwd;  /* password string, allocated */
781
782   char *proxyuser;    /* proxy user name string, allocated */
783   char *proxypasswd;  /* proxy password string, allocated */
784   curl_proxytype proxytype; /* what kind of proxy that is in use */
785
786   int httpversion;        /* the HTTP version*10 reported by the server */
787   int rtspversion;        /* the RTSP version*10 reported by the server */
788
789   struct timeval now;     /* "current" time */
790   struct timeval created; /* creation time */
791   curl_socket_t sock[2]; /* two sockets, the second is used for the data
792                             transfer when doing FTP */
793
794   Curl_recv *recv[2];
795   Curl_send *send[2];
796
797   struct ssl_connect_data ssl[2]; /* this is for ssl-stuff */
798   struct ssl_config_data ssl_config;
799
800   struct ConnectBits bits;    /* various state-flags for this connection */
801
802   const struct Curl_handler * handler;  /* Connection's protocol handler. */
803
804   long ip_version; /* copied from the SessionHandle at creation time */
805
806   /**** curl_get() phase fields */
807
808   curl_socket_t sockfd;   /* socket to read from or CURL_SOCKET_BAD */
809   curl_socket_t writesockfd; /* socket to write to, it may very
810                                 well be the same we read from.
811                                 CURL_SOCKET_BAD disables */
812
813   /** Dynamicly allocated strings, may need to be freed before this **/
814   /** struct is killed.                                             **/
815   struct dynamically_allocated_data {
816     char *proxyuserpwd; /* free later if not NULL! */
817     char *uagent; /* free later if not NULL! */
818     char *accept_encoding; /* free later if not NULL! */
819     char *userpwd; /* free later if not NULL! */
820     char *rangeline; /* free later if not NULL! */
821     char *ref; /* free later if not NULL! */
822     char *host; /* free later if not NULL */
823     char *cookiehost; /* free later if not NULL */
824     char *rtsp_transport; /* free later if not NULL */
825   } allocptr;
826
827   int sec_complete; /* if kerberos is enabled for this connection */
828 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
829   enum protection_level command_prot;
830   enum protection_level data_prot;
831   enum protection_level request_data_prot;
832   size_t buffer_size;
833   struct krb4buffer in_buffer;
834   void *app_data;
835   const struct Curl_sec_client_mech *mech;
836   struct sockaddr_in local_addr;
837 #endif
838
839   /* the two following *_inuse fields are only flags, not counters in any way.
840      If TRUE it means the channel is in use, and if FALSE it means the channel
841      is up for grabs by one. */
842
843   bool readchannel_inuse;  /* whether the read channel is in use by an easy
844                               handle */
845   bool writechannel_inuse; /* whether the write channel is in use by an easy
846                               handle */
847   bool server_supports_pipelining; /* TRUE if server supports pipelining,
848                                       set after first response */
849
850   struct curl_llist *send_pipe; /* List of handles waiting to
851                                    send on this pipeline */
852   struct curl_llist *recv_pipe; /* List of handles waiting to read
853                                    their responses on this pipeline */
854   struct curl_llist *pend_pipe; /* List of pending handles on
855                                    this pipeline */
856   struct curl_llist *done_pipe; /* Handles that are finished, but
857                                    still reference this connectdata */
858 #define MAX_PIPELINE_LENGTH 5
859
860   char* master_buffer; /* The master buffer allocated on-demand;
861                           used for pipelining. */
862   size_t read_pos; /* Current read position in the master buffer */
863   size_t buf_len; /* Length of the buffer?? */
864
865
866   curl_seek_callback seek_func; /* function that seeks the input */
867   void *seek_client;            /* pointer to pass to the seek() above */
868
869   /*************** Request - specific items ************/
870
871   /* previously this was in the urldata struct */
872   curl_read_callback fread_func; /* function that reads the input */
873   void *fread_in;           /* pointer to pass to the fread() above */
874
875   struct ntlmdata ntlm;     /* NTLM differs from other authentication schemes
876                                because it authenticates connections, not
877                                single requests! */
878   struct ntlmdata proxyntlm; /* NTLM data for proxy */
879
880   char syserr_buf [256]; /* buffer for Curl_strerror() */
881
882 #ifdef CURLRES_ASYNCH
883   /* data used for the asynch name resolve callback */
884   struct Curl_async async;
885 #endif
886
887   /* These three are used for chunked-encoding trailer support */
888   char *trailer; /* allocated buffer to store trailer in */
889   int trlMax;    /* allocated buffer size */
890   int trlPos;    /* index of where to store data */
891
892   union {
893     struct ftp_conn ftpc;
894     struct ssh_conn sshc;
895     struct tftp_state_data *tftpc;
896     struct imap_conn imapc;
897     struct pop3_conn pop3c;
898     struct smtp_conn smtpc;
899     struct rtsp_conn rtspc;
900     void *generic;
901   } proto;
902
903   int cselect_bits; /* bitmask of socket events */
904   int waitfor;      /* current READ/WRITE bits to wait for */
905
906 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
907   int socks5_gssapi_enctype;
908 #endif
909
910   long verifypeer;
911   long verifyhost;
912 };
913
914 /* The end of connectdata. */
915
916 /*
917  * Struct to keep statistical and informational data.
918  */
919 struct PureInfo {
920   int httpcode;  /* Recent HTTP, FTP, or RTSP response code */
921   int httpproxycode; /* response code from proxy when received separate */
922   int httpversion; /* the http version number X.Y = X*10+Y */
923   long filetime; /* If requested, this is might get set. Set to -1 if the time
924                     was unretrievable. We cannot have this of type time_t,
925                     since time_t is unsigned on several platforms such as
926                     OpenVMS. */
927   bool timecond;  /* set to TRUE if the time condition didn't match, which
928                      thus made the document NOT get fetched */
929   long header_size;  /* size of read header(s) in bytes */
930   long request_size; /* the amount of bytes sent in the request(s) */
931   long proxyauthavail; /* what proxy auth types were announced */
932   long httpauthavail;  /* what host auth types were announced */
933   long numconnects; /* how many new connection did libcurl created */
934   char *contenttype; /* the content type of the object */
935   char *wouldredirect; /* URL this would've been redirected to if asked to */
936
937   /* PureInfo members 'conn_primary_ip', 'conn_primary_port', 'conn_local_ip'
938      and, 'conn_local_port' are copied over from the connectdata struct in
939      order to allow curl_easy_getinfo() to return this information even when
940      the session handle is no longer associated with a connection, and also
941      allow curl_easy_reset() to clear this information from the session handle
942      without disturbing information which is still alive, and that might be
943      reused, in the connection cache. */
944
945   char conn_primary_ip[MAX_IPADR_LEN];
946   long conn_primary_port;
947
948   char conn_local_ip[MAX_IPADR_LEN];
949   long conn_local_port;
950
951   struct curl_certinfo certs; /* info about the certs, only populated in
952                                  OpenSSL builds. Asked for with
953                                  CURLOPT_CERTINFO / CURLINFO_CERTINFO */
954 };
955
956
957 struct Progress {
958   long lastshow; /* time() of the last displayed progress meter or NULL to
959                     force redraw at next call */
960   curl_off_t size_dl; /* total expected size */
961   curl_off_t size_ul; /* total expected size */
962   curl_off_t downloaded; /* transfered so far */
963   curl_off_t uploaded; /* transfered so far */
964
965   curl_off_t current_speed; /* uses the currently fastest transfer */
966
967   bool callback;  /* set when progress callback is used */
968   int width; /* screen width at download start */
969   int flags; /* see progress.h */
970
971   double timespent;
972
973   curl_off_t dlspeed;
974   curl_off_t ulspeed;
975
976   double t_nslookup;
977   double t_connect;
978   double t_appconnect;
979   double t_pretransfer;
980   double t_starttransfer;
981   double t_redirect;
982
983   struct timeval start;
984   struct timeval t_startsingle;
985 #define CURR_TIME (5+1) /* 6 entries for 5 seconds */
986
987   curl_off_t speeder[ CURR_TIME ];
988   struct timeval speeder_time[ CURR_TIME ];
989   int speeder_c;
990 };
991
992 typedef enum {
993   HTTPREQ_NONE, /* first in list */
994   HTTPREQ_GET,
995   HTTPREQ_POST,
996   HTTPREQ_POST_FORM, /* we make a difference internally */
997   HTTPREQ_PUT,
998   HTTPREQ_HEAD,
999   HTTPREQ_CUSTOM,
1000   HTTPREQ_LAST /* last in list */
1001 } Curl_HttpReq;
1002
1003 typedef enum {
1004     RTSPREQ_NONE, /* first in list */
1005     RTSPREQ_OPTIONS,
1006     RTSPREQ_DESCRIBE,
1007     RTSPREQ_ANNOUNCE,
1008     RTSPREQ_SETUP,
1009     RTSPREQ_PLAY,
1010     RTSPREQ_PAUSE,
1011     RTSPREQ_TEARDOWN,
1012     RTSPREQ_GET_PARAMETER,
1013     RTSPREQ_SET_PARAMETER,
1014     RTSPREQ_RECORD,
1015     RTSPREQ_RECEIVE,
1016     RTSPREQ_LAST /* last in list */
1017 } Curl_RtspReq;
1018
1019 /*
1020  * Values that are generated, temporary or calculated internally for a
1021  * "session handle" must be defined within the 'struct UrlState'.  This struct
1022  * will be used within the SessionHandle struct. When the 'SessionHandle'
1023  * struct is cloned, this data MUST NOT be copied.
1024  *
1025  * Remember that any "state" information goes globally for the curl handle.
1026  * Session-data MUST be put in the connectdata struct and here.  */
1027 #define MAX_CURL_USER_LENGTH 256
1028 #define MAX_CURL_PASSWORD_LENGTH 256
1029 #define MAX_CURL_USER_LENGTH_TXT "255"
1030 #define MAX_CURL_PASSWORD_LENGTH_TXT "255"
1031
1032 struct auth {
1033   long want;  /* Bitmask set to the authentication methods wanted by the app
1034                  (with CURLOPT_HTTPAUTH or CURLOPT_PROXYAUTH). */
1035   long picked;
1036   long avail; /* bitmask for what the server reports to support for this
1037                  resource */
1038   bool done;  /* TRUE when the auth phase is done and ready to do the *actual*
1039                  request */
1040   bool multi; /* TRUE if this is not yet authenticated but within the auth
1041                  multipass negotiation */
1042   bool iestyle; /* TRUE if digest should be done IE-style or FALSE if it should
1043                    be RFC compliant */
1044 };
1045
1046 struct conncache {
1047   /* 'connects' will be an allocated array with pointers. If the pointer is
1048      set, it holds an allocated connection. */
1049   struct connectdata **connects;
1050   long num;           /* number of entries of the 'connects' array */
1051   enum {
1052     CONNCACHE_PRIVATE, /* used for an easy handle alone */
1053     CONNCACHE_MULTI    /* shared within a multi handle */
1054   } type;
1055 };
1056
1057
1058 struct UrlState {
1059   enum {
1060     Curl_if_none,
1061     Curl_if_easy,
1062     Curl_if_multi
1063   } used_interface;
1064
1065   struct conncache *connc; /* points to the connection cache this handle
1066                               uses */
1067
1068   /* buffers to store authentication data in, as parsed from input options */
1069   struct timeval keeps_speed; /* for the progress meter really */
1070
1071   long lastconnect;  /* index of most recent connect or -1 if undefined */
1072
1073   char *headerbuff; /* allocated buffer to store headers in */
1074   size_t headersize;   /* size of the allocation */
1075
1076   char buffer[BUFSIZE+1]; /* download buffer */
1077   char uploadbuffer[BUFSIZE+1]; /* upload buffer */
1078   curl_off_t current_speed;  /* the ProgressShow() funcion sets this,
1079                                 bytes / second */
1080   bool this_is_a_follow; /* this is a followed Location: request */
1081
1082   char *first_host; /* if set, this should be the host name that we will
1083                        sent authorization to, no else. Used to make Location:
1084                        following not keep sending user+password... This is
1085                        strdup() data.
1086                     */
1087   struct curl_ssl_session *session; /* array of 'numsessions' size */
1088   long sessionage;                  /* number of the most recent session */
1089   char *tempwrite;      /* allocated buffer to keep data in when a write
1090                            callback returns to make the connection paused */
1091   size_t tempwritesize; /* size of the 'tempwrite' allocated buffer */
1092   int tempwritetype;    /* type of the 'tempwrite' buffer as a bitmask that is
1093                            used with Curl_client_write() */
1094   char *scratch; /* huge buffer[BUFSIZE*2] when doing upload CRLF replacing */
1095   bool errorbuf; /* Set to TRUE if the error buffer is already filled in.
1096                     This must be set to FALSE every time _easy_perform() is
1097                     called. */
1098   int os_errno;  /* filled in with errno whenever an error occurs */
1099 #ifdef HAVE_SIGNAL
1100   /* storage for the previous bag^H^H^HSIGPIPE signal handler :-) */
1101   void (*prev_signal)(int sig);
1102 #endif
1103   bool allow_port; /* Is set.use_port allowed to take effect or not. This
1104                       is always set TRUE when curl_easy_perform() is called. */
1105   struct digestdata digest;      /* state data for host Digest auth */
1106   struct digestdata proxydigest; /* state data for proxy Digest auth */
1107
1108 #ifdef HAVE_GSSAPI
1109   struct negotiatedata negotiate; /* state data for host Negotiate auth */
1110   struct negotiatedata proxyneg; /* state data for proxy Negotiate auth */
1111 #endif
1112
1113   struct auth authhost;  /* auth details for host */
1114   struct auth authproxy; /* auth details for proxy */
1115
1116   bool authproblem; /* TRUE if there's some problem authenticating */
1117
1118 #ifdef USE_ARES
1119   ares_channel areschannel; /* for name resolves */
1120 #endif
1121
1122 #if defined(USE_SSLEAY) && defined(HAVE_OPENSSL_ENGINE_H)
1123   ENGINE *engine;
1124 #endif /* USE_SSLEAY */
1125   struct timeval expiretime; /* set this with Curl_expire() only */
1126   struct Curl_tree timenode; /* for the splay stuff */
1127   struct curl_llist *timeoutlist; /* list of pending timeouts */
1128
1129   /* a place to store the most recently set FTP entrypath */
1130   char *most_recent_ftp_entrypath;
1131
1132   /* set after initial USER failure, to prevent an authentication loop */
1133   bool ftp_trying_alternative;
1134
1135   int httpversion;       /* the lowest HTTP version*10 reported by any server
1136                             involved in this request */
1137   bool expect100header;  /* TRUE if we added Expect: 100-continue */
1138
1139   bool pipe_broke; /* TRUE if the connection we were pipelined on broke
1140                       and we need to restart from the beginning */
1141
1142 #if !defined(WIN32) && !defined(MSDOS) && !defined(__EMX__) && \
1143     !defined(__SYMBIAN32__)
1144 /* do FTP line-end conversions on most platforms */
1145 #define CURL_DO_LINEEND_CONV
1146   /* for FTP downloads: track CRLF sequences that span blocks */
1147   bool prev_block_had_trailing_cr;
1148   /* for FTP downloads: how many CRLFs did we converted to LFs? */
1149   curl_off_t crlf_conversions;
1150 #endif
1151   /* If set to non-NULL, there's a connection in a shared connection cache
1152      that uses this handle so we can't kill this SessionHandle just yet but
1153      must keep it around and add it to the list of handles to kill once all
1154      its connections are gone */
1155   void *shared_conn;
1156   bool closed; /* set to TRUE when curl_easy_cleanup() has been called on this
1157                   handle, but it is kept around as mentioned for
1158                   shared_conn */
1159   char *pathbuffer;/* allocated buffer to store the URL's path part in */
1160   char *path;      /* path to use, points to somewhere within the pathbuffer
1161                       area */
1162   bool slash_removed; /* set TRUE if the 'path' points to a path where the
1163                          initial URL slash separator has been taken off */
1164   bool use_range;
1165   bool rangestringalloc; /* the range string is malloc()'ed */
1166
1167   char *range; /* range, if used. See README for detailed specification on
1168                   this syntax. */
1169   curl_off_t resume_from; /* continue [ftp] transfer from here */
1170
1171   /* This RTSP state information survives requests and connections */
1172   long rtsp_next_client_CSeq; /* the session's next client CSeq */
1173   long rtsp_next_server_CSeq; /* the session's next server CSeq */
1174   long rtsp_CSeq_recv; /* most recent CSeq received */
1175
1176   /* Protocol specific data.
1177    *
1178    *************************************************************************
1179    * Note that this data will be REMOVED after each request, so anything that
1180    * should be kept/stored on a per-connection basis and thus live for the
1181    * next request on the same connection MUST be put in the connectdata struct!
1182    *************************************************************************/
1183   union {
1184     struct HTTP *http;
1185     struct HTTP *https;  /* alias, just for the sake of being more readable */
1186     struct RTSP *rtsp;
1187     struct FTP *ftp;
1188     /* void *tftp;    not used */
1189     struct FILEPROTO *file;
1190     void *telnet;        /* private for telnet.c-eyes only */
1191     void *generic;
1192     struct SSHPROTO *ssh;
1193     struct FTP *imap;
1194     struct FTP *pop3;
1195     struct FTP *smtp;
1196   } proto;
1197   /* current user of this SessionHandle instance, or NULL */
1198   struct connectdata *current_conn;
1199
1200   /* if true, force SSL connection retry (workaround for certain servers) */
1201   bool ssl_connect_retry;
1202 };
1203
1204
1205 /*
1206  * This 'DynamicStatic' struct defines dynamic states that actually change
1207  * values in the 'UserDefined' area, which MUST be taken into consideration
1208  * if the UserDefined struct is cloned or similar. You can probably just
1209  * copy these, but each one indicate a special action on other data.
1210  */
1211
1212 struct DynamicStatic {
1213   char *url;        /* work URL, copied from UserDefined */
1214   bool url_alloc;   /* URL string is malloc()'ed */
1215   char *referer;    /* referer string */
1216   bool referer_alloc; /* referer sting is malloc()ed */
1217   struct curl_slist *cookielist; /* list of cookie files set by
1218                                     curl_easy_setopt(COOKIEFILE) calls */
1219   struct curl_slist *resolve; /* set to point to the set.resolve list when
1220                                  this should be dealt with in pretransfer */
1221 };
1222
1223 /*
1224  * This 'UserDefined' struct must only contain data that is set once to go
1225  * for many (perhaps) independent connections. Values that are generated or
1226  * calculated internally for the "session handle" MUST be defined within the
1227  * 'struct UrlState' instead. The only exceptions MUST note the changes in
1228  * the 'DynamicStatic' struct.
1229  * Character pointer fields point to dynamic storage, unless otherwise stated.
1230  */
1231 struct Curl_one_easy; /* declared and used only in multi.c */
1232 struct Curl_multi;    /* declared and used only in multi.c */
1233
1234 enum dupstring {
1235   STRING_CERT,            /* client certificate file name */
1236   STRING_CERT_TYPE,       /* format for certificate (default: PEM)*/
1237   STRING_COOKIE,          /* HTTP cookie string to send */
1238   STRING_COOKIEJAR,       /* dump all cookies to this file */
1239   STRING_CUSTOMREQUEST,   /* HTTP/FTP/RTSP request/method to use */
1240   STRING_DEVICE,          /* local network interface/address to use */
1241   STRING_ENCODING,        /* Accept-Encoding string */
1242   STRING_FTP_ACCOUNT,     /* ftp account data */
1243   STRING_FTP_ALTERNATIVE_TO_USER, /* command to send if USER/PASS fails */
1244   STRING_FTPPORT,         /* port to send with the FTP PORT command */
1245   STRING_KEY,             /* private key file name */
1246   STRING_KEY_PASSWD,      /* plain text private key password */
1247   STRING_KEY_TYPE,        /* format for private key (default: PEM) */
1248   STRING_KRB_LEVEL,       /* krb security level */
1249   STRING_NETRC_FILE,      /* if not NULL, use this instead of trying to find
1250                              $HOME/.netrc */
1251   STRING_COPYPOSTFIELDS,  /* if POST, set the fields' values here */
1252   STRING_PROXY,           /* proxy to use */
1253   STRING_SET_RANGE,       /* range, if used */
1254   STRING_SET_REFERER,     /* custom string for the HTTP referer field */
1255   STRING_SET_URL,         /* what original URL to work on */
1256   STRING_SSL_CAPATH,      /* CA directory name (doesn't work on windows) */
1257   STRING_SSL_CAFILE,      /* certificate file to verify peer against */
1258   STRING_SSL_CIPHER_LIST, /* list of ciphers to use */
1259   STRING_SSL_EGDSOCKET,   /* path to file containing the EGD daemon socket */
1260   STRING_SSL_RANDOM_FILE, /* path to file containing "random" data */
1261   STRING_USERAGENT,       /* User-Agent string */
1262   STRING_SSL_CRLFILE,     /* crl file to check certificate */
1263   STRING_SSL_ISSUERCERT,  /* issuer cert file to check certificate */
1264   STRING_USERNAME,        /* <username>, if used */
1265   STRING_PASSWORD,        /* <password>, if used */
1266   STRING_PROXYUSERNAME,   /* Proxy <username>, if used */
1267   STRING_PROXYPASSWORD,   /* Proxy <password>, if used */
1268   STRING_NOPROXY,         /* List of hosts which should not use the proxy, if
1269                              used */
1270   STRING_RTSP_SESSION_ID, /* Session ID to use */
1271   STRING_RTSP_STREAM_URI, /* Stream URI for this request */
1272   STRING_RTSP_TRANSPORT,  /* Transport for this session */
1273 #ifdef USE_LIBSSH2
1274   STRING_SSH_PRIVATE_KEY, /* path to the private key file for auth */
1275   STRING_SSH_PUBLIC_KEY,  /* path to the public key file for auth */
1276   STRING_SSH_HOST_PUBLIC_KEY_MD5, /* md5 of host public key in ascii hex */
1277   STRING_SSH_KNOWNHOSTS,  /* file name of knownhosts file */
1278 #endif
1279 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1280   STRING_SOCKS5_GSSAPI_SERVICE,  /* GSSAPI service name */
1281 #endif
1282   STRING_MAIL_FROM,
1283
1284   /* -- end of strings -- */
1285   STRING_LAST /* not used, just an end-of-list marker */
1286 };
1287
1288 struct UserDefined {
1289   FILE *err;         /* the stderr user data goes here */
1290   void *debugdata;   /* the data that will be passed to fdebug */
1291   char *errorbuffer; /* (Static) store failure messages in here */
1292   long proxyport; /* If non-zero, use this port number by default. If the
1293                      proxy string features a ":[port]" that one will override
1294                      this. */
1295   void *out;         /* the fetched file goes here */
1296   void *in;          /* the uploaded file is read from here */
1297   void *writeheader; /* write the header to this if non-NULL */
1298   void *rtp_out;     /* write RTP to this if non-NULL */
1299   long use_port;     /* which port to use (when not using default) */
1300   long httpauth;     /* what kind of HTTP authentication to use (bitmask) */
1301   long proxyauth;    /* what kind of proxy authentication to use (bitmask) */
1302   long followlocation; /* as in HTTP Location: */
1303   long maxredirs;    /* maximum no. of http(s) redirects to follow, set to -1
1304                         for infinity */
1305   bool post301;      /* Obey RFC 2616/10.3.2 and keep POSTs as POSTs after a
1306                         301 */
1307   bool post302;      /* keep POSTs as POSTs after a 302 */
1308   bool free_referer; /* set TRUE if 'referer' points to a string we
1309                         allocated */
1310   void *postfields;  /* if POST, set the fields' values here */
1311   curl_seek_callback seek_func;      /* function that seeks the input */
1312   curl_off_t postfieldsize; /* if POST, this might have a size to use instead
1313                                of strlen(), and then the data *may* be binary
1314                                (contain zero bytes) */
1315   unsigned short localport; /* local port number to bind to */
1316   int localportrange; /* number of additional port numbers to test in case the
1317                          'localport' one can't be bind()ed */
1318   curl_write_callback fwrite_func;   /* function that stores the output */
1319   curl_write_callback fwrite_header; /* function that stores headers */
1320   curl_write_callback fwrite_rtp;    /* function that stores interleaved RTP */
1321   curl_read_callback fread_func;     /* function that reads the input */
1322   int is_fread_set; /* boolean, has read callback been set to non-NULL? */
1323   int is_fwrite_set; /* boolean, has write callback been set to non-NULL? */
1324   curl_progress_callback fprogress;  /* function for progress information */
1325   curl_debug_callback fdebug;      /* function that write informational data */
1326   curl_ioctl_callback ioctl_func;  /* function for I/O control */
1327   curl_sockopt_callback fsockopt;  /* function for setting socket options */
1328   void *sockopt_client; /* pointer to pass to the socket options callback */
1329   curl_opensocket_callback fopensocket; /* function for checking/translating
1330                                            the address and opening the socket */
1331   void* opensocket_client;
1332
1333   void *seek_client;    /* pointer to pass to the seek callback */
1334   /* the 3 curl_conv_callback functions below are used on non-ASCII hosts */
1335   /* function to convert from the network encoding: */
1336   curl_conv_callback convfromnetwork;
1337   /* function to convert to the network encoding: */
1338   curl_conv_callback convtonetwork;
1339   /* function to convert from UTF-8 encoding: */
1340   curl_conv_callback convfromutf8;
1341
1342   void *progress_client; /* pointer to pass to the progress callback */
1343   void *ioctl_client;   /* pointer to pass to the ioctl callback */
1344   long timeout;         /* in milliseconds, 0 means no timeout */
1345   long connecttimeout;  /* in milliseconds, 0 means no timeout */
1346   long server_response_timeout; /* in milliseconds, 0 means no timeout */
1347   long tftp_blksize ; /* in bytes, 0 means use default */
1348   curl_off_t infilesize;      /* size of file to upload, -1 means unknown */
1349   long low_speed_limit; /* bytes/second */
1350   long low_speed_time;  /* number of seconds */
1351   curl_off_t max_send_speed; /* high speed limit in bytes/second for upload */
1352   curl_off_t max_recv_speed; /* high speed limit in bytes/second for download */
1353   curl_off_t set_resume_from;  /* continue [ftp] transfer from here */
1354   struct curl_slist *headers; /* linked list of extra headers */
1355   struct curl_httppost *httppost;  /* linked list of POST data */
1356   bool cookiesession;   /* new cookie session? */
1357   bool crlf;            /* convert crlf on ftp upload(?) */
1358   struct curl_slist *quote;     /* after connection is established */
1359   struct curl_slist *postquote; /* after the transfer */
1360   struct curl_slist *prequote; /* before the transfer, after type */
1361   struct curl_slist *source_quote;  /* 3rd party quote */
1362   struct curl_slist *source_prequote;  /* in 3rd party transfer mode - before
1363                                           the transfer on source host */
1364   struct curl_slist *source_postquote; /* in 3rd party transfer mode - after
1365                                           the transfer on source host */
1366   struct curl_slist *telnet_options; /* linked list of telnet options */
1367   struct curl_slist *resolve;     /* list of names to add/remove from
1368                                      DNS cache */
1369   curl_TimeCond timecondition; /* kind of time/date comparison */
1370   time_t timevalue;       /* what time to compare with */
1371   Curl_HttpReq httpreq;   /* what kind of HTTP request (if any) is this */
1372   long httpversion; /* when non-zero, a specific HTTP version requested to
1373                        be used in the library's request(s) */
1374   struct ssl_config_data ssl;  /* user defined SSL stuff */
1375   curl_proxytype proxytype; /* what kind of proxy that is in use */
1376   long dns_cache_timeout; /* DNS cache timeout */
1377   long buffer_size;      /* size of receive buffer to use */
1378   void *private_data; /* application-private data */
1379
1380   struct Curl_one_easy *one_easy; /* When adding an easy handle to a multi
1381                                      handle, an internal 'Curl_one_easy'
1382                                      struct is created and this is a pointer
1383                                      to the particular struct associated with
1384                                      this SessionHandle */
1385
1386   struct curl_slist *http200aliases; /* linked list of aliases for http200 */
1387
1388   long ipver; /* the CURL_IPRESOLVE_* defines in the public header file
1389                  0 - whatever, 1 - v2, 2 - v6 */
1390
1391   curl_off_t max_filesize; /* Maximum file size to download */
1392
1393   curl_ftpfile ftp_filemethod; /* how to get to a file when FTP is used  */
1394
1395   int ftp_create_missing_dirs; /* 1 - create directories that don't exist
1396                                   2 - the same but also allow MKD to fail once
1397                                */
1398
1399   curl_sshkeycallback ssh_keyfunc; /* key matching callback */
1400   void *ssh_keyfunc_userp;         /* custom pointer to callback */
1401
1402 /* Here follows boolean settings that define how to behave during
1403    this session. They are STATIC, set by libcurl users or at least initially
1404    and they don't change during operations. */
1405
1406   bool printhost;        /* printing host name in debug info */
1407   bool get_filetime;     /* get the time and get of the remote file */
1408   bool tunnel_thru_httpproxy; /* use CONNECT through a HTTP proxy */
1409   bool prefer_ascii;     /* ASCII rather than binary */
1410   bool ftp_append;       /* append, not overwrite, on upload */
1411   bool ftp_list_only;    /* switch FTP command for listing directories */
1412   bool ftp_use_port;     /* use the FTP PORT command */
1413   bool hide_progress;    /* don't use the progress meter */
1414   bool http_fail_on_error;  /* fail on HTTP error codes >= 300 */
1415   bool http_follow_location; /* follow HTTP redirects */
1416   bool http_disable_hostname_check_before_authentication;
1417   bool include_header;   /* include received protocol headers in data output */
1418   bool http_set_referer; /* is a custom referer used */
1419   bool http_auto_referer; /* set "correct" referer when following location: */
1420   bool opt_no_body;      /* as set with CURLOPT_NO_BODY */
1421   bool set_port;         /* custom port number used */
1422   bool upload;           /* upload request */
1423   enum CURL_NETRC_OPTION
1424        use_netrc;        /* defined in include/curl.h */
1425   bool verbose;          /* output verbosity */
1426   bool krb;              /* kerberos connection requested */
1427   bool reuse_forbid;     /* forbidden to be reused, close after use */
1428   bool reuse_fresh;      /* do not re-use an existing connection  */
1429   bool ftp_use_epsv;     /* if EPSV is to be attempted or not */
1430   bool ftp_use_eprt;     /* if EPRT is to be attempted or not */
1431   bool ftp_use_pret;     /* if PRET is to be used before PASV or not */
1432
1433   curl_usessl ftp_ssl;   /* if AUTH TLS is to be attempted etc, for FTP or
1434                             IMAP or POP3 or others! */
1435   curl_ftpauth ftpsslauth; /* what AUTH XXX to be attempted */
1436   curl_ftpccc ftp_ccc;   /* FTP CCC options */
1437   bool no_signal;        /* do not use any signal/alarm handler */
1438   bool global_dns_cache; /* subject for future removal */
1439   bool tcp_nodelay;      /* whether to enable TCP_NODELAY or not */
1440   bool ignorecl;         /* ignore content length */
1441   bool ftp_skip_ip;      /* skip the IP address the FTP server passes on to
1442                             us */
1443   bool connect_only;     /* make connection, let application use the socket */
1444   long ssh_auth_types;   /* allowed SSH auth types */
1445   bool http_te_skip;     /* pass the raw body data to the user, even when
1446                             transfer-encoded (chunked, compressed) */
1447   bool http_ce_skip;     /* pass the raw body data to the user, even when
1448                             content-encoded (chunked, compressed) */
1449   long new_file_perms;    /* Permissions to use when creating remote files */
1450   long new_directory_perms; /* Permissions to use when creating remote dirs */
1451   bool proxy_transfer_mode; /* set transfer mode (;type=<a|i>) when doing FTP
1452                                via an HTTP proxy */
1453   char *str[STRING_LAST]; /* array of strings, pointing to allocated memory */
1454   unsigned int scope;    /* address scope for IPv6 */
1455   long allowed_protocols;
1456   long redir_protocols;
1457 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
1458   long socks5_gssapi_nec; /* flag to support nec socks5 server */
1459 #endif
1460   struct curl_slist *mail_rcpt; /* linked list of mail recipients */
1461   /* Common RTSP header options */
1462   Curl_RtspReq rtspreq; /* RTSP request type */
1463   long rtspversion; /* like httpversion, for RTSP */
1464   bool wildcardmatch; /* enable wildcard matching */
1465   curl_chunk_bgn_callback chunk_bgn; /* called before part of transfer starts */
1466   curl_chunk_end_callback chunk_end; /* called after part transferring
1467                                         stopped */
1468   curl_fnmatch_callback fnmatch; /* callback to decide which file corresponds
1469                                     to pattern (e.g. if WILDCARDMATCH is on) */
1470   void *fnmatch_data;
1471 };
1472
1473 struct Names {
1474   struct curl_hash *hostcache;
1475   enum {
1476     HCACHE_NONE,    /* not pointing to anything */
1477     HCACHE_PRIVATE, /* points to our own */
1478     HCACHE_GLOBAL,  /* points to the (shrug) global one */
1479     HCACHE_MULTI,   /* points to a shared one in the multi handle */
1480     HCACHE_SHARED   /* points to a shared one in a shared object */
1481   } hostcachetype;
1482 };
1483
1484 /*
1485  * The 'connectdata' struct MUST have all the connection oriented stuff as we
1486  * may have several simultaneous connections and connection structs in memory.
1487  *
1488  * The 'struct UserDefined' must only contain data that is set once to go for
1489  * many (perhaps) independent connections. Values that are generated or
1490  * calculated internally for the "session handle" must be defined within the
1491  * 'struct UrlState' instead.
1492  */
1493
1494 struct SessionHandle {
1495   struct Names dns;
1496   struct Curl_multi *multi;    /* if non-NULL, points to the multi handle
1497                                   struct to which this "belongs" */
1498   struct Curl_one_easy *multi_pos; /* if non-NULL, points to its position
1499                                       in multi controlling structure to assist
1500                                       in removal. */
1501   struct Curl_share *share;    /* Share, handles global variable mutexing */
1502   struct SingleRequest req;    /* Request-specific data */
1503   struct UserDefined set;      /* values set by the libcurl user */
1504   struct DynamicStatic change; /* possibly modified userdefined data */
1505   struct CookieInfo *cookies;  /* the cookies, read from files and servers.
1506                                   NOTE that the 'cookie' field in the
1507                                   UserDefined struct defines if the "engine"
1508                                   is to be used or not. */
1509   struct Progress progress;    /* for all the progress meter data */
1510   struct UrlState state;       /* struct for fields used for state info and
1511                                   other dynamic purposes */
1512   struct WildcardData wildcard; /* wildcard download state info */
1513   struct PureInfo info;        /* stats, reports and info data */
1514 #if defined(CURL_DOES_CONVERSIONS) && defined(HAVE_ICONV)
1515   iconv_t outbound_cd;         /* for translating to the network encoding */
1516   iconv_t inbound_cd;          /* for translating from the network encoding */
1517   iconv_t utf8_cd;             /* for translating to UTF8 */
1518 #endif /* CURL_DOES_CONVERSIONS && HAVE_ICONV */
1519   unsigned int magic;          /* set to a CURLEASY_MAGIC_NUMBER */
1520 };
1521
1522 #define LIBCURL_NAME "libcurl"
1523
1524 #endif