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