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