include/curl/curl.h

   1 #ifndef __CURL_CURL_H
   2 #define __CURL_CURL_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2014, 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 /*
  26  * If you have libcurl problems, all docs and details are found here:
  27  *   http://curl.haxx.se/libcurl/
  28  *
  29  * curl-library mailing list subscription and unsubscription web interface:
  30  *   http://cool.haxx.se/mailman/listinfo/curl-library/
  31  */
  32
  33 #include "curlver.h"         /* libcurl version defines   */
  34 #include "curlbuild.h"       /* libcurl build definitions */
  35 #include "curlrules.h"       /* libcurl rules enforcement */
  36
  37 /*
  38  * Define WIN32 when build target is Win32 API
  39  */
  40
  41 #if (defined(_WIN32) || defined(__WIN32__)) && \
  42      !defined(WIN32) && !defined(__SYMBIAN32__)
  43 #define WIN32
  44 #endif
  45
  46 #include <stdio.h>
  47 #include <limits.h>
  48
  49 #if defined(__FreeBSD__) && (__FreeBSD__ >= 2)
  50 /* Needed for __FreeBSD_version symbol definition */
  51 #include <osreldate.h>
  52 #endif
  53
  54 /* The include stuff here below is mainly for time_t! */
  55 #include <sys/types.h>
  56 #include <time.h>
  57
  58 #if defined(WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__)
  59 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || defined(__LWIP_OPT_H__))
  60 /* The check above prevents the winsock2 inclusion if winsock.h already was
  61    included, since they can't co-exist without problems */
  62 #include <winsock2.h>
  63 #include <ws2tcpip.h>
  64 #endif
  65 #endif
  66
  67 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
  68    libc5-based Linux systems. Only include it on systems that are known to
  69    require it! */
  70 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
  71     defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \
  72     defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \
  73    (defined(__FreeBSD_version) && (__FreeBSD_version < 800000))
  74 #include <sys/select.h>
  75 #endif
  76
  77 #if !defined(WIN32) && !defined(_WIN32_WCE)
  78 #include <sys/socket.h>
  79 #endif
  80
  81 #if !defined(WIN32) && !defined(__WATCOMC__) && !defined(__VXWORKS__)
  82 #include <sys/time.h>
  83 #endif
  84
  85 #ifdef __BEOS__
  86 #include <support/SupportDefs.h>
  87 #endif
  88
  89 #ifdef  __cplusplus
  90 extern "C" {
  91 #endif
  92
  93 typedef void CURL;
  94
  95 /*
  96  * libcurl external API function linkage decorations.
  97  */
  98
  99 #ifdef CURL_STATICLIB
 100 #  define CURL_EXTERN
 101 #elif defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
 102 #  if defined(BUILDING_LIBCURL)
 103 #    define CURL_EXTERN  __declspec(dllexport)
 104 #  else
 105 #    define CURL_EXTERN  __declspec(dllimport)
 106 #  endif
 107 #elif defined(BUILDING_LIBCURL) && defined(CURL_HIDDEN_SYMBOLS)
 108 #  define CURL_EXTERN CURL_EXTERN_SYMBOL
 109 #else
 110 #  define CURL_EXTERN
 111 #endif
 112
 113 #ifndef curl_socket_typedef
 114 /* socket typedef */
 115 #if defined(WIN32) && !defined(__LWIP_OPT_H__)
 116 typedef SOCKET curl_socket_t;
 117 #define CURL_SOCKET_BAD INVALID_SOCKET
 118 #else
 119 typedef int curl_socket_t;
 120 #define CURL_SOCKET_BAD -1
 121 #endif
 122 #define curl_socket_typedef
 123 #endif /* curl_socket_typedef */
 124
 125 struct curl_httppost {
 126   struct curl_httppost *next;       /* next entry in the list */
 127   char *name;                       /* pointer to allocated name */
 128   long namelength;                  /* length of name length */
 129   char *contents;                   /* pointer to allocated data contents */
 130   long contentslength;              /* length of contents field */
 131   char *buffer;                     /* pointer to allocated buffer contents */
 132   long bufferlength;                /* length of buffer field */
 133   char *contenttype;                /* Content-Type */
 134   struct curl_slist* contentheader; /* list of extra headers for this form */
 135   struct curl_httppost *more;       /* if one field name has more than one
 136                                        file, this link should link to following
 137                                        files */
 138   long flags;                       /* as defined below */
 139 #define HTTPPOST_FILENAME (1<<0)    /* specified content is a file name */
 140 #define HTTPPOST_READFILE (1<<1)    /* specified content is a file name */
 141 #define HTTPPOST_PTRNAME (1<<2)     /* name is only stored pointer
 142                                        do not free in formfree */
 143 #define HTTPPOST_PTRCONTENTS (1<<3) /* contents is only stored pointer
 144                                        do not free in formfree */
 145 #define HTTPPOST_BUFFER (1<<4)      /* upload file from buffer */
 146 #define HTTPPOST_PTRBUFFER (1<<5)   /* upload file from pointer contents */
 147 #define HTTPPOST_CALLBACK (1<<6)    /* upload file contents by using the
 148                                        regular read callback to get the data
 149                                        and pass the given pointer as custom
 150                                        pointer */
 151
 152   char *showfilename;               /* The file name to show. If not set, the
 153                                        actual file name will be used (if this
 154                                        is a file part) */
 155   void *userp;                      /* custom pointer used for
 156                                        HTTPPOST_CALLBACK posts */
 157 };
 158
 159 /* This is the CURLOPT_PROGRESSFUNCTION callback proto. It is now considered
 160    deprecated but was the only choice up until 7.31.0 */
 161 typedef int (*curl_progress_callback)(void *clientp,
 162                                       double dltotal,
 163                                       double dlnow,
 164                                       double ultotal,
 165                                       double ulnow);
 166
 167 /* This is the CURLOPT_XFERINFOFUNCTION callback proto. It was introduced in
 168    7.32.0, it avoids floating point and provides more detailed information. */
 169 typedef int (*curl_xferinfo_callback)(void *clientp,
 170                                       curl_off_t dltotal,
 171                                       curl_off_t dlnow,
 172                                       curl_off_t ultotal,
 173                                       curl_off_t ulnow);
 174
 175 #ifndef CURL_MAX_WRITE_SIZE
 176   /* Tests have proven that 20K is a very bad buffer size for uploads on
 177      Windows, while 16K for some odd reason performed a lot better.
 178      We do the ifndef check to allow this value to easier be changed at build
 179      time for those who feel adventurous. The practical minimum is about
 180      400 bytes since libcurl uses a buffer of this size as a scratch area
 181      (unrelated to network send operations). */
 182 #define CURL_MAX_WRITE_SIZE 16384
 183 #endif
 184
 185 #ifndef CURL_MAX_HTTP_HEADER
 186 /* The only reason to have a max limit for this is to avoid the risk of a bad
 187    server feeding libcurl with a never-ending header that will cause reallocs
 188    infinitely */
 189 #define CURL_MAX_HTTP_HEADER (100*1024)
 190 #endif
 191
 192 /* This is a magic return code for the write callback that, when returned,
 193    will signal libcurl to pause receiving on the current transfer. */
 194 #define CURL_WRITEFUNC_PAUSE 0x10000001
 195
 196 typedef size_t (*curl_write_callback)(char *buffer,
 197                                       size_t size,
 198                                       size_t nitems,
 199                                       void *outstream);
 200
 201
 202
 203 /* enumeration of file types */
 204 typedef enum {
 205   CURLFILETYPE_FILE = 0,
 206   CURLFILETYPE_DIRECTORY,
 207   CURLFILETYPE_SYMLINK,
 208   CURLFILETYPE_DEVICE_BLOCK,
 209   CURLFILETYPE_DEVICE_CHAR,
 210   CURLFILETYPE_NAMEDPIPE,
 211   CURLFILETYPE_SOCKET,
 212   CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */
 213
 214   CURLFILETYPE_UNKNOWN /* should never occur */
 215 } curlfiletype;
 216
 217 #define CURLFINFOFLAG_KNOWN_FILENAME    (1<<0)
 218 #define CURLFINFOFLAG_KNOWN_FILETYPE    (1<<1)
 219 #define CURLFINFOFLAG_KNOWN_TIME        (1<<2)
 220 #define CURLFINFOFLAG_KNOWN_PERM        (1<<3)
 221 #define CURLFINFOFLAG_KNOWN_UID         (1<<4)
 222 #define CURLFINFOFLAG_KNOWN_GID         (1<<5)
 223 #define CURLFINFOFLAG_KNOWN_SIZE        (1<<6)
 224 #define CURLFINFOFLAG_KNOWN_HLINKCOUNT  (1<<7)
 225
 226 /* Content of this structure depends on information which is known and is
 227    achievable (e.g. by FTP LIST parsing). Please see the url_easy_setopt(3) man
 228    page for callbacks returning this structure -- some fields are mandatory,
 229    some others are optional. The FLAG field has special meaning. */
 230 struct curl_fileinfo {
 231   char *filename;
 232   curlfiletype filetype;
 233   time_t time;
 234   unsigned int perm;
 235   int uid;
 236   int gid;
 237   curl_off_t size;
 238   long int hardlinks;
 239
 240   struct {
 241     /* If some of these fields is not NULL, it is a pointer to b_data. */
 242     char *time;
 243     char *perm;
 244     char *user;
 245     char *group;
 246     char *target; /* pointer to the target filename of a symlink */
 247   } strings;
 248
 249   unsigned int flags;
 250
 251   /* used internally */
 252   char * b_data;
 253   size_t b_size;
 254   size_t b_used;
 255 };
 256
 257 /* return codes for CURLOPT_CHUNK_BGN_FUNCTION */
 258 #define CURL_CHUNK_BGN_FUNC_OK      0
 259 #define CURL_CHUNK_BGN_FUNC_FAIL    1 /* tell the lib to end the task */
 260 #define CURL_CHUNK_BGN_FUNC_SKIP    2 /* skip this chunk over */
 261
 262 /* if splitting of data transfer is enabled, this callback is called before
 263    download of an individual chunk started. Note that parameter "remains" works
 264    only for FTP wildcard downloading (for now), otherwise is not used */
 265 typedef long (*curl_chunk_bgn_callback)(const void *transfer_info,
 266                                         void *ptr,
 267                                         int remains);
 268
 269 /* return codes for CURLOPT_CHUNK_END_FUNCTION */
 270 #define CURL_CHUNK_END_FUNC_OK      0
 271 #define CURL_CHUNK_END_FUNC_FAIL    1 /* tell the lib to end the task */
 272
 273 /* If splitting of data transfer is enabled this callback is called after
 274    download of an individual chunk finished.
 275    Note! After this callback was set then it have to be called FOR ALL chunks.
 276    Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC.
 277    This is the reason why we don't need "transfer_info" parameter in this
 278    callback and we are not interested in "remains" parameter too. */
 279 typedef long (*curl_chunk_end_callback)(void *ptr);
 280
 281 /* return codes for FNMATCHFUNCTION */
 282 #define CURL_FNMATCHFUNC_MATCH    0 /* string corresponds to the pattern */
 283 #define CURL_FNMATCHFUNC_NOMATCH  1 /* pattern doesn't match the string */
 284 #define CURL_FNMATCHFUNC_FAIL     2 /* an error occurred */
 285
 286 /* callback type for wildcard downloading pattern matching. If the
 287    string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */
 288 typedef int (*curl_fnmatch_callback)(void *ptr,
 289                                      const char *pattern,
 290                                      const char *string);
 291
 292 /* These are the return codes for the seek callbacks */
 293 #define CURL_SEEKFUNC_OK       0
 294 #define CURL_SEEKFUNC_FAIL     1 /* fail the entire transfer */
 295 #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can't be done, so
 296                                     libcurl might try other means instead */
 297 typedef int (*curl_seek_callback)(void *instream,
 298                                   curl_off_t offset,
 299                                   int origin); /* 'whence' */
 300
 301 /* This is a return code for the read callback that, when returned, will
 302    signal libcurl to immediately abort the current transfer. */
 303 #define CURL_READFUNC_ABORT 0x10000000
 304 /* This is a return code for the read callback that, when returned, will
 305    signal libcurl to pause sending data on the current transfer. */
 306 #define CURL_READFUNC_PAUSE 0x10000001
 307
 308 typedef size_t (*curl_read_callback)(char *buffer,
 309                                       size_t size,
 310                                       size_t nitems,
 311                                       void *instream);
 312
 313 typedef enum  {
 314   CURLSOCKTYPE_IPCXN,  /* socket created for a specific IP connection */
 315   CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */
 316   CURLSOCKTYPE_LAST    /* never use */
 317 } curlsocktype;
 318
 319 /* The return code from the sockopt_callback can signal information back
 320    to libcurl: */
 321 #define CURL_SOCKOPT_OK 0
 322 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return
 323                                 CURLE_ABORTED_BY_CALLBACK */
 324 #define CURL_SOCKOPT_ALREADY_CONNECTED 2
 325
 326 typedef int (*curl_sockopt_callback)(void *clientp,
 327                                      curl_socket_t curlfd,
 328                                      curlsocktype purpose);
 329
 330 struct curl_sockaddr {
 331   int family;
 332   int socktype;
 333   int protocol;
 334   unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it
 335                            turned really ugly and painful on the systems that
 336                            lack this type */
 337   struct sockaddr addr;
 338 };
 339
 340 typedef curl_socket_t
 341 (*curl_opensocket_callback)(void *clientp,
 342                             curlsocktype purpose,
 343                             struct curl_sockaddr *address);
 344
 345 typedef int
 346 (*curl_closesocket_callback)(void *clientp, curl_socket_t item);
 347
 348 typedef enum {
 349   CURLIOE_OK,            /* I/O operation successful */
 350   CURLIOE_UNKNOWNCMD,    /* command was unknown to callback */
 351   CURLIOE_FAILRESTART,   /* failed to restart the read */
 352   CURLIOE_LAST           /* never use */
 353 } curlioerr;
 354
 355 typedef enum  {
 356   CURLIOCMD_NOP,         /* no operation */
 357   CURLIOCMD_RESTARTREAD, /* restart the read stream from start */
 358   CURLIOCMD_LAST         /* never use */
 359 } curliocmd;
 360
 361 typedef curlioerr (*curl_ioctl_callback)(CURL *handle,
 362                                          int cmd,
 363                                          void *clientp);
 364
 365 /*
 366  * The following typedef's are signatures of malloc, free, realloc, strdup and
 367  * calloc respectively.  Function pointers of these types can be passed to the
 368  * curl_global_init_mem() function to set user defined memory management
 369  * callback routines.
 370  */
 371 typedef void *(*curl_malloc_callback)(size_t size);
 372 typedef void (*curl_free_callback)(void *ptr);
 373 typedef void *(*curl_realloc_callback)(void *ptr, size_t size);
 374 typedef char *(*curl_strdup_callback)(const char *str);
 375 typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size);
 376
 377 /* the kind of data that is passed to information_callback*/
 378 typedef enum {
 379   CURLINFO_TEXT = 0,
 380   CURLINFO_HEADER_IN,    /* 1 */
 381   CURLINFO_HEADER_OUT,   /* 2 */
 382   CURLINFO_DATA_IN,      /* 3 */
 383   CURLINFO_DATA_OUT,     /* 4 */
 384   CURLINFO_SSL_DATA_IN,  /* 5 */
 385   CURLINFO_SSL_DATA_OUT, /* 6 */
 386   CURLINFO_END
 387 } curl_infotype;
 388
 389 typedef int (*curl_debug_callback)
 390        (CURL *handle,      /* the handle/transfer this concerns */
 391         curl_infotype type, /* what kind of data */
 392         char *data,        /* points to the data */
 393         size_t size,       /* size of the data pointed to */
 394         void *userptr);    /* whatever the user please */
 395
 396 /* All possible error codes from all sorts of curl functions. Future versions
 397    may return other values, stay prepared.
 398
 399    Always add new return codes last. Never *EVER* remove any. The return
 400    codes must remain the same!
 401  */
 402
 403 typedef enum {
 404   CURLE_OK = 0,
 405   CURLE_UNSUPPORTED_PROTOCOL,    /* 1 */
 406   CURLE_FAILED_INIT,             /* 2 */
 407   CURLE_URL_MALFORMAT,           /* 3 */
 408   CURLE_NOT_BUILT_IN,            /* 4 - [was obsoleted in August 2007 for
 409                                     7.17.0, reused in April 2011 for 7.21.5] */
 410   CURLE_COULDNT_RESOLVE_PROXY,   /* 5 */
 411   CURLE_COULDNT_RESOLVE_HOST,    /* 6 */
 412   CURLE_COULDNT_CONNECT,         /* 7 */
 413   CURLE_FTP_WEIRD_SERVER_REPLY,  /* 8 */
 414   CURLE_REMOTE_ACCESS_DENIED,    /* 9 a service was denied by the server
 415                                     due to lack of access - when login fails
 416                                     this is not returned. */
 417   CURLE_FTP_ACCEPT_FAILED,       /* 10 - [was obsoleted in April 2006 for
 418                                     7.15.4, reused in Dec 2011 for 7.24.0]*/
 419   CURLE_FTP_WEIRD_PASS_REPLY,    /* 11 */
 420   CURLE_FTP_ACCEPT_TIMEOUT,      /* 12 - timeout occurred accepting server
 421                                     [was obsoleted in August 2007 for 7.17.0,
 422                                     reused in Dec 2011 for 7.24.0]*/
 423   CURLE_FTP_WEIRD_PASV_REPLY,    /* 13 */
 424   CURLE_FTP_WEIRD_227_FORMAT,    /* 14 */
 425   CURLE_FTP_CANT_GET_HOST,       /* 15 */
 426   CURLE_OBSOLETE16,              /* 16 - NOT USED */
 427   CURLE_FTP_COULDNT_SET_TYPE,    /* 17 */
 428   CURLE_PARTIAL_FILE,            /* 18 */
 429   CURLE_FTP_COULDNT_RETR_FILE,   /* 19 */
 430   CURLE_OBSOLETE20,              /* 20 - NOT USED */
 431   CURLE_QUOTE_ERROR,             /* 21 - quote command failure */
 432   CURLE_HTTP_RETURNED_ERROR,     /* 22 */
 433   CURLE_WRITE_ERROR,             /* 23 */
 434   CURLE_OBSOLETE24,              /* 24 - NOT USED */
 435   CURLE_UPLOAD_FAILED,           /* 25 - failed upload "command" */
 436   CURLE_READ_ERROR,              /* 26 - couldn't open/read from file */
 437   CURLE_OUT_OF_MEMORY,           /* 27 */
 438   /* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error
 439            instead of a memory allocation error if CURL_DOES_CONVERSIONS
 440            is defined
 441   */
 442   CURLE_OPERATION_TIMEDOUT,      /* 28 - the timeout time was reached */
 443   CURLE_OBSOLETE29,              /* 29 - NOT USED */
 444   CURLE_FTP_PORT_FAILED,         /* 30 - FTP PORT operation failed */
 445   CURLE_FTP_COULDNT_USE_REST,    /* 31 - the REST command failed */
 446   CURLE_OBSOLETE32,              /* 32 - NOT USED */
 447   CURLE_RANGE_ERROR,             /* 33 - RANGE "command" didn't work */
 448   CURLE_HTTP_POST_ERROR,         /* 34 */
 449   CURLE_SSL_CONNECT_ERROR,       /* 35 - wrong when connecting with SSL */
 450   CURLE_BAD_DOWNLOAD_RESUME,     /* 36 - couldn't resume download */
 451   CURLE_FILE_COULDNT_READ_FILE,  /* 37 */
 452   CURLE_LDAP_CANNOT_BIND,        /* 38 */
 453   CURLE_LDAP_SEARCH_FAILED,      /* 39 */
 454   CURLE_OBSOLETE40,              /* 40 - NOT USED */
 455   CURLE_FUNCTION_NOT_FOUND,      /* 41 */
 456   CURLE_ABORTED_BY_CALLBACK,     /* 42 */
 457   CURLE_BAD_FUNCTION_ARGUMENT,   /* 43 */
 458   CURLE_OBSOLETE44,              /* 44 - NOT USED */
 459   CURLE_INTERFACE_FAILED,        /* 45 - CURLOPT_INTERFACE failed */
 460   CURLE_OBSOLETE46,              /* 46 - NOT USED */
 461   CURLE_TOO_MANY_REDIRECTS ,     /* 47 - catch endless re-direct loops */
 462   CURLE_UNKNOWN_OPTION,          /* 48 - User specified an unknown option */
 463   CURLE_TELNET_OPTION_SYNTAX ,   /* 49 - Malformed telnet option */
 464   CURLE_OBSOLETE50,              /* 50 - NOT USED */
 465   CURLE_PEER_FAILED_VERIFICATION, /* 51 - peer's certificate or fingerprint
 466                                      wasn't verified fine */
 467   CURLE_GOT_NOTHING,             /* 52 - when this is a specific error */
 468   CURLE_SSL_ENGINE_NOTFOUND,     /* 53 - SSL crypto engine not found */
 469   CURLE_SSL_ENGINE_SETFAILED,    /* 54 - can not set SSL crypto engine as
 470                                     default */
 471   CURLE_SEND_ERROR,              /* 55 - failed sending network data */
 472   CURLE_RECV_ERROR,              /* 56 - failure in receiving network data */
 473   CURLE_OBSOLETE57,              /* 57 - NOT IN USE */
 474   CURLE_SSL_CERTPROBLEM,         /* 58 - problem with the local certificate */
 475   CURLE_SSL_CIPHER,              /* 59 - couldn't use specified cipher */
 476   CURLE_SSL_CACERT,              /* 60 - problem with the CA cert (path?) */
 477   CURLE_BAD_CONTENT_ENCODING,    /* 61 - Unrecognized/bad encoding */
 478   CURLE_LDAP_INVALID_URL,        /* 62 - Invalid LDAP URL */
 479   CURLE_FILESIZE_EXCEEDED,       /* 63 - Maximum file size exceeded */
 480   CURLE_USE_SSL_FAILED,          /* 64 - Requested FTP SSL level failed */
 481   CURLE_SEND_FAIL_REWIND,        /* 65 - Sending the data requires a rewind
 482                                     that failed */
 483   CURLE_SSL_ENGINE_INITFAILED,   /* 66 - failed to initialise ENGINE */
 484   CURLE_LOGIN_DENIED,            /* 67 - user, password or similar was not
 485                                     accepted and we failed to login */
 486   CURLE_TFTP_NOTFOUND,           /* 68 - file not found on server */
 487   CURLE_TFTP_PERM,               /* 69 - permission problem on server */
 488   CURLE_REMOTE_DISK_FULL,        /* 70 - out of disk space on server */
 489   CURLE_TFTP_ILLEGAL,            /* 71 - Illegal TFTP operation */
 490   CURLE_TFTP_UNKNOWNID,          /* 72 - Unknown transfer ID */
 491   CURLE_REMOTE_FILE_EXISTS,      /* 73 - File already exists */
 492   CURLE_TFTP_NOSUCHUSER,         /* 74 - No such user */
 493   CURLE_CONV_FAILED,             /* 75 - conversion failed */
 494   CURLE_CONV_REQD,               /* 76 - caller must register conversion
 495                                     callbacks using curl_easy_setopt options
 496                                     CURLOPT_CONV_FROM_NETWORK_FUNCTION,
 497                                     CURLOPT_CONV_TO_NETWORK_FUNCTION, and
 498                                     CURLOPT_CONV_FROM_UTF8_FUNCTION */
 499   CURLE_SSL_CACERT_BADFILE,      /* 77 - could not load CACERT file, missing
 500                                     or wrong format */
 501   CURLE_REMOTE_FILE_NOT_FOUND,   /* 78 - remote file not found */
 502   CURLE_SSH,                     /* 79 - error from the SSH layer, somewhat
 503                                     generic so the error message will be of
 504                                     interest when this has happened */
 505
 506   CURLE_SSL_SHUTDOWN_FAILED,     /* 80 - Failed to shut down the SSL
 507                                     connection */
 508   CURLE_AGAIN,                   /* 81 - socket is not ready for send/recv,
 509                                     wait till it's ready and try again (Added
 510                                     in 7.18.2) */
 511   CURLE_SSL_CRL_BADFILE,         /* 82 - could not load CRL file, missing or
 512                                     wrong format (Added in 7.19.0) */
 513   CURLE_SSL_ISSUER_ERROR,        /* 83 - Issuer check failed.  (Added in
 514                                     7.19.0) */
 515   CURLE_FTP_PRET_FAILED,         /* 84 - a PRET command failed */
 516   CURLE_RTSP_CSEQ_ERROR,         /* 85 - mismatch of RTSP CSeq numbers */
 517   CURLE_RTSP_SESSION_ERROR,      /* 86 - mismatch of RTSP Session Ids */
 518   CURLE_FTP_BAD_FILE_LIST,       /* 87 - unable to parse FTP file list */
 519   CURLE_CHUNK_FAILED,            /* 88 - chunk callback reported error */
 520   CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the
 521                                     session will be queued */
 522   CURL_LAST /* never use! */
 523 } CURLcode;
 524
 525 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
 526                           the obsolete stuff removed! */
 527
 528 /* Previously obsoletes error codes re-used in 7.24.0 */
 529 #define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED
 530 #define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT
 531
 532 /*  compatibility with older names */
 533 #define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING
 534
 535 /* The following were added in 7.21.5, April 2011 */
 536 #define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION
 537
 538 /* The following were added in 7.17.1 */
 539 /* These are scheduled to disappear by 2009 */
 540 #define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION
 541
 542 /* The following were added in 7.17.0 */
 543 /* These are scheduled to disappear by 2009 */
 544 #define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */
 545 #define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46
 546 #define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44
 547 #define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10
 548 #define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16
 549 #define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32
 550 #define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29
 551 #define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12
 552 #define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20
 553 #define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40
 554 #define CURLE_MALFORMAT_USER CURLE_OBSOLETE24
 555 #define CURLE_SHARE_IN_USE CURLE_OBSOLETE57
 556 #define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN
 557
 558 #define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED
 559 #define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE
 560 #define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR
 561 #define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL
 562 #define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS
 563 #define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR
 564 #define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED
 565
 566 /* The following were added earlier */
 567
 568 #define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT
 569
 570 #define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR
 571 #define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED
 572 #define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED
 573
 574 #define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE
 575 #define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME
 576
 577 /* This was the error code 50 in 7.7.3 and a few earlier versions, this
 578    is no longer used by libcurl but is instead #defined here only to not
 579    make programs break */
 580 #define CURLE_ALREADY_COMPLETE 99999
 581
 582 /* Provide defines for really old option names */
 583 #define CURLOPT_FILE CURLOPT_WRITEDATA /* name changed in 7.9.7 */
 584 #define CURLOPT_INFILE CURLOPT_READDATA /* name changed in 7.9.7 */
 585 #define CURLOPT_WRITEHEADER CURLOPT_HEADERDATA
 586
 587 #endif /*!CURL_NO_OLDIES*/
 588
 589 /* This prototype applies to all conversion callbacks */
 590 typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length);
 591
 592 typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl,    /* easy handle */
 593                                           void *ssl_ctx, /* actually an
 594                                                             OpenSSL SSL_CTX */
 595                                           void *userptr);
 596
 597 typedef enum {
 598   CURLPROXY_HTTP = 0,   /* added in 7.10, new in 7.19.4 default is to use
 599                            CONNECT HTTP/1.1 */
 600   CURLPROXY_HTTP_1_0 = 1,   /* added in 7.19.4, force to use CONNECT
 601                                HTTP/1.0  */
 602   CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already
 603                            in 7.10 */
 604   CURLPROXY_SOCKS5 = 5, /* added in 7.10 */
 605   CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */
 606   CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the
 607                                    host name rather than the IP address. added
 608                                    in 7.18.0 */
 609 } curl_proxytype;  /* this enum was added in 7.10 */
 610
 611 /*
 612  * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options:
 613  *
 614  * CURLAUTH_NONE         - No HTTP authentication
 615  * CURLAUTH_BASIC        - HTTP Basic authentication (default)
 616  * CURLAUTH_DIGEST       - HTTP Digest authentication
 617  * CURLAUTH_GSSNEGOTIATE - HTTP GSS-Negotiate authentication
 618  * CURLAUTH_NTLM         - HTTP NTLM authentication
 619  * CURLAUTH_DIGEST_IE    - HTTP Digest authentication with IE flavour
 620  * CURLAUTH_NTLM_WB      - HTTP NTLM authentication delegated to winbind helper
 621  * CURLAUTH_ONLY         - Use together with a single other type to force no
 622  *                         authentication or just that single type
 623  * CURLAUTH_ANY          - All fine types set
 624  * CURLAUTH_ANYSAFE      - All fine types except Basic
 625  */
 626
 627 #define CURLAUTH_NONE         ((unsigned long)0)
 628 #define CURLAUTH_BASIC        (((unsigned long)1)<<0)
 629 #define CURLAUTH_DIGEST       (((unsigned long)1)<<1)
 630 #define CURLAUTH_GSSNEGOTIATE (((unsigned long)1)<<2)
 631 #define CURLAUTH_NTLM         (((unsigned long)1)<<3)
 632 #define CURLAUTH_DIGEST_IE    (((unsigned long)1)<<4)
 633 #define CURLAUTH_NTLM_WB      (((unsigned long)1)<<5)
 634 #define CURLAUTH_ONLY         (((unsigned long)1)<<31)
 635 #define CURLAUTH_ANY          (~CURLAUTH_DIGEST_IE)
 636 #define CURLAUTH_ANYSAFE      (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE))
 637
 638 #define CURLSSH_AUTH_ANY       ~0     /* all types supported by the server */
 639 #define CURLSSH_AUTH_NONE      0      /* none allowed, silly but complete */
 640 #define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */
 641 #define CURLSSH_AUTH_PASSWORD  (1<<1) /* password */
 642 #define CURLSSH_AUTH_HOST      (1<<2) /* host key files */
 643 #define CURLSSH_AUTH_KEYBOARD  (1<<3) /* keyboard interactive */
 644 #define CURLSSH_AUTH_AGENT     (1<<4) /* agent (ssh-agent, pageant...) */
 645 #define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY
 646
 647 #define CURLGSSAPI_DELEGATION_NONE        0      /* no delegation (default) */
 648 #define CURLGSSAPI_DELEGATION_POLICY_FLAG (1<<0) /* if permitted by policy */
 649 #define CURLGSSAPI_DELEGATION_FLAG        (1<<1) /* delegate always */
 650
 651 #define CURL_ERROR_SIZE 256
 652
 653 enum curl_khtype {
 654   CURLKHTYPE_UNKNOWN,
 655   CURLKHTYPE_RSA1,
 656   CURLKHTYPE_RSA,
 657   CURLKHTYPE_DSS
 658 };
 659
 660 struct curl_khkey {
 661   const char *key; /* points to a zero-terminated string encoded with base64
 662                       if len is zero, otherwise to the "raw" data */
 663   size_t len;
 664   enum curl_khtype keytype;
 665 };
 666
 667 /* this is the set of return values expected from the curl_sshkeycallback
 668    callback */
 669 enum curl_khstat {
 670   CURLKHSTAT_FINE_ADD_TO_FILE,
 671   CURLKHSTAT_FINE,
 672   CURLKHSTAT_REJECT, /* reject the connection, return an error */
 673   CURLKHSTAT_DEFER,  /* do not accept it, but we can't answer right now so
 674                         this causes a CURLE_DEFER error but otherwise the
 675                         connection will be left intact etc */
 676   CURLKHSTAT_LAST    /* not for use, only a marker for last-in-list */
 677 };
 678
 679 /* this is the set of status codes pass in to the callback */
 680 enum curl_khmatch {
 681   CURLKHMATCH_OK,       /* match */
 682   CURLKHMATCH_MISMATCH, /* host found, key mismatch! */
 683   CURLKHMATCH_MISSING,  /* no matching host/key found */
 684   CURLKHMATCH_LAST      /* not for use, only a marker for last-in-list */
 685 };
 686
 687 typedef int
 688   (*curl_sshkeycallback) (CURL *easy,     /* easy handle */
 689                           const struct curl_khkey *knownkey, /* known */
 690                           const struct curl_khkey *foundkey, /* found */
 691                           enum curl_khmatch, /* libcurl's view on the keys */
 692                           void *clientp); /* custom pointer passed from app */
 693
 694 /* parameter for the CURLOPT_USE_SSL option */
 695 typedef enum {
 696   CURLUSESSL_NONE,    /* do not attempt to use SSL */
 697   CURLUSESSL_TRY,     /* try using SSL, proceed anyway otherwise */
 698   CURLUSESSL_CONTROL, /* SSL for the control connection or fail */
 699   CURLUSESSL_ALL,     /* SSL for all communication or fail */
 700   CURLUSESSL_LAST     /* not an option, never use */
 701 } curl_usessl;
 702
 703 /* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */
 704
 705 /* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the
 706    name of improving interoperability with older servers. Some SSL libraries
 707    have introduced work-arounds for this flaw but those work-arounds sometimes
 708    make the SSL communication fail. To regain functionality with those broken
 709    servers, a user can this way allow the vulnerability back. */
 710 #define CURLSSLOPT_ALLOW_BEAST (1<<0)
 711
 712 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
 713                           the obsolete stuff removed! */
 714
 715 /* Backwards compatibility with older names */
 716 /* These are scheduled to disappear by 2009 */
 717
 718 #define CURLFTPSSL_NONE CURLUSESSL_NONE
 719 #define CURLFTPSSL_TRY CURLUSESSL_TRY
 720 #define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL
 721 #define CURLFTPSSL_ALL CURLUSESSL_ALL
 722 #define CURLFTPSSL_LAST CURLUSESSL_LAST
 723 #define curl_ftpssl curl_usessl
 724 #endif /*!CURL_NO_OLDIES*/
 725
 726 /* parameter for the CURLOPT_FTP_SSL_CCC option */
 727 typedef enum {
 728   CURLFTPSSL_CCC_NONE,    /* do not send CCC */
 729   CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */
 730   CURLFTPSSL_CCC_ACTIVE,  /* Initiate the shutdown */
 731   CURLFTPSSL_CCC_LAST     /* not an option, never use */
 732 } curl_ftpccc;
 733
 734 /* parameter for the CURLOPT_FTPSSLAUTH option */
 735 typedef enum {
 736   CURLFTPAUTH_DEFAULT, /* let libcurl decide */
 737   CURLFTPAUTH_SSL,     /* use "AUTH SSL" */
 738   CURLFTPAUTH_TLS,     /* use "AUTH TLS" */
 739   CURLFTPAUTH_LAST /* not an option, never use */
 740 } curl_ftpauth;
 741
 742 /* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */
 743 typedef enum {
 744   CURLFTP_CREATE_DIR_NONE,  /* do NOT create missing dirs! */
 745   CURLFTP_CREATE_DIR,       /* (FTP/SFTP) if CWD fails, try MKD and then CWD
 746                                again if MKD succeeded, for SFTP this does
 747                                similar magic */
 748   CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD
 749                                again even if MKD failed! */
 750   CURLFTP_CREATE_DIR_LAST   /* not an option, never use */
 751 } curl_ftpcreatedir;
 752
 753 /* parameter for the CURLOPT_FTP_FILEMETHOD option */
 754 typedef enum {
 755   CURLFTPMETHOD_DEFAULT,   /* let libcurl pick */
 756   CURLFTPMETHOD_MULTICWD,  /* single CWD operation for each path part */
 757   CURLFTPMETHOD_NOCWD,     /* no CWD at all */
 758   CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */
 759   CURLFTPMETHOD_LAST       /* not an option, never use */
 760 } curl_ftpmethod;
 761
 762 /* bitmask defines for CURLOPT_HEADEROPT */
 763 #define CURLHEADER_UNIFIED  0
 764 #define CURLHEADER_SEPARATE (1<<0)
 765
 766 /* CURLPROTO_ defines are for the CURLOPT_*PROTOCOLS options */
 767 #define CURLPROTO_HTTP   (1<<0)
 768 #define CURLPROTO_HTTPS  (1<<1)
 769 #define CURLPROTO_FTP    (1<<2)
 770 #define CURLPROTO_FTPS   (1<<3)
 771 #define CURLPROTO_SCP    (1<<4)
 772 #define CURLPROTO_SFTP   (1<<5)
 773 #define CURLPROTO_TELNET (1<<6)
 774 #define CURLPROTO_LDAP   (1<<7)
 775 #define CURLPROTO_LDAPS  (1<<8)
 776 #define CURLPROTO_DICT   (1<<9)
 777 #define CURLPROTO_FILE   (1<<10)
 778 #define CURLPROTO_TFTP   (1<<11)
 779 #define CURLPROTO_IMAP   (1<<12)
 780 #define CURLPROTO_IMAPS  (1<<13)
 781 #define CURLPROTO_POP3   (1<<14)
 782 #define CURLPROTO_POP3S  (1<<15)
 783 #define CURLPROTO_SMTP   (1<<16)
 784 #define CURLPROTO_SMTPS  (1<<17)
 785 #define CURLPROTO_RTSP   (1<<18)
 786 #define CURLPROTO_RTMP   (1<<19)
 787 #define CURLPROTO_RTMPT  (1<<20)
 788 #define CURLPROTO_RTMPE  (1<<21)
 789 #define CURLPROTO_RTMPTE (1<<22)
 790 #define CURLPROTO_RTMPS  (1<<23)
 791 #define CURLPROTO_RTMPTS (1<<24)
 792 #define CURLPROTO_GOPHER (1<<25)
 793 #define CURLPROTO_ALL    (~0) /* enable everything */
 794
 795 /* long may be 32 or 64 bits, but we should never depend on anything else
 796    but 32 */
 797 #define CURLOPTTYPE_LONG          0
 798 #define CURLOPTTYPE_OBJECTPOINT   10000
 799 #define CURLOPTTYPE_FUNCTIONPOINT 20000
 800 #define CURLOPTTYPE_OFF_T         30000
 801
 802 /* name is uppercase CURLOPT_<name>,
 803    type is one of the defined CURLOPTTYPE_<type>
 804    number is unique identifier */
 805 #ifdef CINIT
 806 #undef CINIT
 807 #endif
 808
 809 #ifdef CURL_ISOCPP
 810 #define CINIT(na,t,nu) CURLOPT_ ## na = CURLOPTTYPE_ ## t + nu
 811 #else
 812 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */
 813 #define LONG          CURLOPTTYPE_LONG
 814 #define OBJECTPOINT   CURLOPTTYPE_OBJECTPOINT
 815 #define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT
 816 #define OFF_T         CURLOPTTYPE_OFF_T
 817 #define CINIT(name,type,number) CURLOPT_/**/name = type + number
 818 #endif
 819
 820 /*
 821  * This macro-mania below setups the CURLOPT_[what] enum, to be used with
 822  * curl_easy_setopt(). The first argument in the CINIT() macro is the [what]
 823  * word.
 824  */
 825
 826 typedef enum {
 827   /* This is the FILE * or void * the regular output should be written to. */
 828   CINIT(WRITEDATA, OBJECTPOINT, 1),
 829
 830   /* The full URL to get/put */
 831   CINIT(URL,  OBJECTPOINT, 2),
 832
 833   /* Port number to connect to, if other than default. */
 834   CINIT(PORT, LONG, 3),
 835
 836   /* Name of proxy to use. */
 837   CINIT(PROXY, OBJECTPOINT, 4),
 838
 839   /* "user:password;options" to use when fetching. */
 840   CINIT(USERPWD, OBJECTPOINT, 5),
 841
 842   /* "user:password" to use with proxy. */
 843   CINIT(PROXYUSERPWD, OBJECTPOINT, 6),
 844
 845   /* Range to get, specified as an ASCII string. */
 846   CINIT(RANGE, OBJECTPOINT, 7),
 847
 848   /* not used */
 849
 850   /* Specified file stream to upload from (use as input): */
 851   CINIT(READDATA, OBJECTPOINT, 9),
 852
 853   /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE
 854    * bytes big. If this is not used, error messages go to stderr instead: */
 855   CINIT(ERRORBUFFER, OBJECTPOINT, 10),
 856
 857   /* Function that will be called to store the output (instead of fwrite). The
 858    * parameters will use fwrite() syntax, make sure to follow them. */
 859   CINIT(WRITEFUNCTION, FUNCTIONPOINT, 11),
 860
 861   /* Function that will be called to read the input (instead of fread). The
 862    * parameters will use fread() syntax, make sure to follow them. */
 863   CINIT(READFUNCTION, FUNCTIONPOINT, 12),
 864
 865   /* Time-out the read operation after this amount of seconds */
 866   CINIT(TIMEOUT, LONG, 13),
 867
 868   /* If the CURLOPT_INFILE is used, this can be used to inform libcurl about
 869    * how large the file being sent really is. That allows better error
 870    * checking and better verifies that the upload was successful. -1 means
 871    * unknown size.
 872    *
 873    * For large file support, there is also a _LARGE version of the key
 874    * which takes an off_t type, allowing platforms with larger off_t
 875    * sizes to handle larger files.  See below for INFILESIZE_LARGE.
 876    */
 877   CINIT(INFILESIZE, LONG, 14),
 878
 879   /* POST static input fields. */
 880   CINIT(POSTFIELDS, OBJECTPOINT, 15),
 881
 882   /* Set the referrer page (needed by some CGIs) */
 883   CINIT(REFERER, OBJECTPOINT, 16),
 884
 885   /* Set the FTP PORT string (interface name, named or numerical IP address)
 886      Use i.e '-' to use default address. */
 887   CINIT(FTPPORT, OBJECTPOINT, 17),
 888
 889   /* Set the User-Agent string (examined by some CGIs) */
 890   CINIT(USERAGENT, OBJECTPOINT, 18),
 891
 892   /* If the download receives less than "low speed limit" bytes/second
 893    * during "low speed time" seconds, the operations is aborted.
 894    * You could i.e if you have a pretty high speed connection, abort if
 895    * it is less than 2000 bytes/sec during 20 seconds.
 896    */
 897
 898   /* Set the "low speed limit" */
 899   CINIT(LOW_SPEED_LIMIT, LONG, 19),
 900
 901   /* Set the "low speed time" */
 902   CINIT(LOW_SPEED_TIME, LONG, 20),
 903
 904   /* Set the continuation offset.
 905    *
 906    * Note there is also a _LARGE version of this key which uses
 907    * off_t types, allowing for large file offsets on platforms which
 908    * use larger-than-32-bit off_t's.  Look below for RESUME_FROM_LARGE.
 909    */
 910   CINIT(RESUME_FROM, LONG, 21),
 911
 912   /* Set cookie in request: */
 913   CINIT(COOKIE, OBJECTPOINT, 22),
 914
 915   /* This points to a linked list of headers, struct curl_slist kind. This
 916      list is also used for RTSP (in spite of its name) */
 917   CINIT(HTTPHEADER, OBJECTPOINT, 23),
 918
 919   /* This points to a linked list of post entries, struct curl_httppost */
 920   CINIT(HTTPPOST, OBJECTPOINT, 24),
 921
 922   /* name of the file keeping your private SSL-certificate */
 923   CINIT(SSLCERT, OBJECTPOINT, 25),
 924
 925   /* password for the SSL or SSH private key */
 926   CINIT(KEYPASSWD, OBJECTPOINT, 26),
 927
 928   /* send TYPE parameter? */
 929   CINIT(CRLF, LONG, 27),
 930
 931   /* send linked-list of QUOTE commands */
 932   CINIT(QUOTE, OBJECTPOINT, 28),
 933
 934   /* send FILE * or void * to store headers to, if you use a callback it
 935      is simply passed to the callback unmodified */
 936   CINIT(HEADERDATA, OBJECTPOINT, 29),
 937
 938   /* point to a file to read the initial cookies from, also enables
 939      "cookie awareness" */
 940   CINIT(COOKIEFILE, OBJECTPOINT, 31),
 941
 942   /* What version to specifically try to use.
 943      See CURL_SSLVERSION defines below. */
 944   CINIT(SSLVERSION, LONG, 32),
 945
 946   /* What kind of HTTP time condition to use, see defines */
 947   CINIT(TIMECONDITION, LONG, 33),
 948
 949   /* Time to use with the above condition. Specified in number of seconds
 950      since 1 Jan 1970 */
 951   CINIT(TIMEVALUE, LONG, 34),
 952
 953   /* 35 = OBSOLETE */
 954
 955   /* Custom request, for customizing the get command like
 956      HTTP: DELETE, TRACE and others
 957      FTP: to use a different list command
 958      */
 959   CINIT(CUSTOMREQUEST, OBJECTPOINT, 36),
 960
 961   /* HTTP request, for odd commands like DELETE, TRACE and others */
 962   CINIT(STDERR, OBJECTPOINT, 37),
 963
 964   /* 38 is not used */
 965
 966   /* send linked-list of post-transfer QUOTE commands */
 967   CINIT(POSTQUOTE, OBJECTPOINT, 39),
 968
 969   CINIT(WRITEINFO, OBJECTPOINT, 40), /* DEPRECATED, do not use! */
 970
 971   CINIT(VERBOSE, LONG, 41),      /* talk a lot */
 972   CINIT(HEADER, LONG, 42),       /* throw the header out too */
 973   CINIT(NOPROGRESS, LONG, 43),   /* shut off the progress meter */
 974   CINIT(NOBODY, LONG, 44),       /* use HEAD to get http document */
 975   CINIT(FAILONERROR, LONG, 45),  /* no output on http error codes >= 300 */
 976   CINIT(UPLOAD, LONG, 46),       /* this is an upload */
 977   CINIT(POST, LONG, 47),         /* HTTP POST method */
 978   CINIT(DIRLISTONLY, LONG, 48),  /* bare names when listing directories */
 979
 980   CINIT(APPEND, LONG, 50),       /* Append instead of overwrite on upload! */
 981
 982   /* Specify whether to read the user+password from the .netrc or the URL.
 983    * This must be one of the CURL_NETRC_* enums below. */
 984   CINIT(NETRC, LONG, 51),
 985
 986   CINIT(FOLLOWLOCATION, LONG, 52),  /* use Location: Luke! */
 987
 988   CINIT(TRANSFERTEXT, LONG, 53), /* transfer data in text/ASCII format */
 989   CINIT(PUT, LONG, 54),          /* HTTP PUT */
 990
 991   /* 55 = OBSOLETE */
 992
 993   /* DEPRECATED
 994    * Function that will be called instead of the internal progress display
 995    * function. This function should be defined as the curl_progress_callback
 996    * prototype defines. */
 997   CINIT(PROGRESSFUNCTION, FUNCTIONPOINT, 56),
 998
 999   /* Data passed to the CURLOPT_PROGRESSFUNCTION and CURLOPT_XFERINFOFUNCTION
1000      callbacks */
1001   CINIT(PROGRESSDATA, OBJECTPOINT, 57),
1002 #define CURLOPT_XFERINFODATA CURLOPT_PROGRESSDATA
1003
1004   /* We want the referrer field set automatically when following locations */
1005   CINIT(AUTOREFERER, LONG, 58),
1006
1007   /* Port of the proxy, can be set in the proxy string as well with:
1008      "[host]:[port]" */
1009   CINIT(PROXYPORT, LONG, 59),
1010
1011   /* size of the POST input data, if strlen() is not good to use */
1012   CINIT(POSTFIELDSIZE, LONG, 60),
1013
1014   /* tunnel non-http operations through a HTTP proxy */
1015   CINIT(HTTPPROXYTUNNEL, LONG, 61),
1016
1017   /* Set the interface string to use as outgoing network interface */
1018   CINIT(INTERFACE, OBJECTPOINT, 62),
1019
1020   /* Set the krb4/5 security level, this also enables krb4/5 awareness.  This
1021    * is a string, 'clear', 'safe', 'confidential' or 'private'.  If the string
1022    * is set but doesn't match one of these, 'private' will be used.  */
1023   CINIT(KRBLEVEL, OBJECTPOINT, 63),
1024
1025   /* Set if we should verify the peer in ssl handshake, set 1 to verify. */
1026   CINIT(SSL_VERIFYPEER, LONG, 64),
1027
1028   /* The CApath or CAfile used to validate the peer certificate
1029      this option is used only if SSL_VERIFYPEER is true */
1030   CINIT(CAINFO, OBJECTPOINT, 65),
1031
1032   /* 66 = OBSOLETE */
1033   /* 67 = OBSOLETE */
1034
1035   /* Maximum number of http redirects to follow */
1036   CINIT(MAXREDIRS, LONG, 68),
1037
1038   /* Pass a long set to 1 to get the date of the requested document (if
1039      possible)! Pass a zero to shut it off. */
1040   CINIT(FILETIME, LONG, 69),
1041
1042   /* This points to a linked list of telnet options */
1043   CINIT(TELNETOPTIONS, OBJECTPOINT, 70),
1044
1045   /* Max amount of cached alive connections */
1046   CINIT(MAXCONNECTS, LONG, 71),
1047
1048   CINIT(CLOSEPOLICY, LONG, 72), /* DEPRECATED, do not use! */
1049
1050   /* 73 = OBSOLETE */
1051
1052   /* Set to explicitly use a new connection for the upcoming transfer.
1053      Do not use this unless you're absolutely sure of this, as it makes the
1054      operation slower and is less friendly for the network. */
1055   CINIT(FRESH_CONNECT, LONG, 74),
1056
1057   /* Set to explicitly forbid the upcoming transfer's connection to be re-used
1058      when done. Do not use this unless you're absolutely sure of this, as it
1059      makes the operation slower and is less friendly for the network. */
1060   CINIT(FORBID_REUSE, LONG, 75),
1061
1062   /* Set to a file name that contains random data for libcurl to use to
1063      seed the random engine when doing SSL connects. */
1064   CINIT(RANDOM_FILE, OBJECTPOINT, 76),
1065
1066   /* Set to the Entropy Gathering Daemon socket pathname */
1067   CINIT(EGDSOCKET, OBJECTPOINT, 77),
1068
1069   /* Time-out connect operations after this amount of seconds, if connects are
1070      OK within this time, then fine... This only aborts the connect phase. */
1071   CINIT(CONNECTTIMEOUT, LONG, 78),
1072
1073   /* Function that will be called to store headers (instead of fwrite). The
1074    * parameters will use fwrite() syntax, make sure to follow them. */
1075   CINIT(HEADERFUNCTION, FUNCTIONPOINT, 79),
1076
1077   /* Set this to force the HTTP request to get back to GET. Only really usable
1078      if POST, PUT or a custom request have been used first.
1079    */
1080   CINIT(HTTPGET, LONG, 80),
1081
1082   /* Set if we should verify the Common name from the peer certificate in ssl
1083    * handshake, set 1 to check existence, 2 to ensure that it matches the
1084    * provided hostname. */
1085   CINIT(SSL_VERIFYHOST, LONG, 81),
1086
1087   /* Specify which file name to write all known cookies in after completed
1088      operation. Set file name to "-" (dash) to make it go to stdout. */
1089   CINIT(COOKIEJAR, OBJECTPOINT, 82),
1090
1091   /* Specify which SSL ciphers to use */
1092   CINIT(SSL_CIPHER_LIST, OBJECTPOINT, 83),
1093
1094   /* Specify which HTTP version to use! This must be set to one of the
1095      CURL_HTTP_VERSION* enums set below. */
1096   CINIT(HTTP_VERSION, LONG, 84),
1097
1098   /* Specifically switch on or off the FTP engine's use of the EPSV command. By
1099      default, that one will always be attempted before the more traditional
1100      PASV command. */
1101   CINIT(FTP_USE_EPSV, LONG, 85),
1102
1103   /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */
1104   CINIT(SSLCERTTYPE, OBJECTPOINT, 86),
1105
1106   /* name of the file keeping your private SSL-key */
1107   CINIT(SSLKEY, OBJECTPOINT, 87),
1108
1109   /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */
1110   CINIT(SSLKEYTYPE, OBJECTPOINT, 88),
1111
1112   /* crypto engine for the SSL-sub system */
1113   CINIT(SSLENGINE, OBJECTPOINT, 89),
1114
1115   /* set the crypto engine for the SSL-sub system as default
1116      the param has no meaning...
1117    */
1118   CINIT(SSLENGINE_DEFAULT, LONG, 90),
1119
1120   /* Non-zero value means to use the global dns cache */
1121   CINIT(DNS_USE_GLOBAL_CACHE, LONG, 91), /* DEPRECATED, do not use! */
1122
1123   /* DNS cache timeout */
1124   CINIT(DNS_CACHE_TIMEOUT, LONG, 92),
1125
1126   /* send linked-list of pre-transfer QUOTE commands */
1127   CINIT(PREQUOTE, OBJECTPOINT, 93),
1128
1129   /* set the debug function */
1130   CINIT(DEBUGFUNCTION, FUNCTIONPOINT, 94),
1131
1132   /* set the data for the debug function */
1133   CINIT(DEBUGDATA, OBJECTPOINT, 95),
1134
1135   /* mark this as start of a cookie session */
1136   CINIT(COOKIESESSION, LONG, 96),
1137
1138   /* The CApath directory used to validate the peer certificate
1139      this option is used only if SSL_VERIFYPEER is true */
1140   CINIT(CAPATH, OBJECTPOINT, 97),
1141
1142   /* Instruct libcurl to use a smaller receive buffer */
1143   CINIT(BUFFERSIZE, LONG, 98),
1144
1145   /* Instruct libcurl to not use any signal/alarm handlers, even when using
1146      timeouts. This option is useful for multi-threaded applications.
1147      See libcurl-the-guide for more background information. */
1148   CINIT(NOSIGNAL, LONG, 99),
1149
1150   /* Provide a CURLShare for mutexing non-ts data */
1151   CINIT(SHARE, OBJECTPOINT, 100),
1152
1153   /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default),
1154      CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */
1155   CINIT(PROXYTYPE, LONG, 101),
1156
1157   /* Set the Accept-Encoding string. Use this to tell a server you would like
1158      the response to be compressed. Before 7.21.6, this was known as
1159      CURLOPT_ENCODING */
1160   CINIT(ACCEPT_ENCODING, OBJECTPOINT, 102),
1161
1162   /* Set pointer to private data */
1163   CINIT(PRIVATE, OBJECTPOINT, 103),
1164
1165   /* Set aliases for HTTP 200 in the HTTP Response header */
1166   CINIT(HTTP200ALIASES, OBJECTPOINT, 104),
1167
1168   /* Continue to send authentication (user+password) when following locations,
1169      even when hostname changed. This can potentially send off the name
1170      and password to whatever host the server decides. */
1171   CINIT(UNRESTRICTED_AUTH, LONG, 105),
1172
1173   /* Specifically switch on or off the FTP engine's use of the EPRT command (
1174      it also disables the LPRT attempt). By default, those ones will always be
1175      attempted before the good old traditional PORT command. */
1176   CINIT(FTP_USE_EPRT, LONG, 106),
1177
1178   /* Set this to a bitmask value to enable the particular authentications
1179      methods you like. Use this in combination with CURLOPT_USERPWD.
1180      Note that setting multiple bits may cause extra network round-trips. */
1181   CINIT(HTTPAUTH, LONG, 107),
1182
1183   /* Set the ssl context callback function, currently only for OpenSSL ssl_ctx
1184      in second argument. The function must be matching the
1185      curl_ssl_ctx_callback proto. */
1186   CINIT(SSL_CTX_FUNCTION, FUNCTIONPOINT, 108),
1187
1188   /* Set the userdata for the ssl context callback function's third
1189      argument */
1190   CINIT(SSL_CTX_DATA, OBJECTPOINT, 109),
1191
1192   /* FTP Option that causes missing dirs to be created on the remote server.
1193      In 7.19.4 we introduced the convenience enums for this option using the
1194      CURLFTP_CREATE_DIR prefix.
1195   */
1196   CINIT(FTP_CREATE_MISSING_DIRS, LONG, 110),
1197
1198   /* Set this to a bitmask value to enable the particular authentications
1199      methods you like. Use this in combination with CURLOPT_PROXYUSERPWD.
1200      Note that setting multiple bits may cause extra network round-trips. */
1201   CINIT(PROXYAUTH, LONG, 111),
1202
1203   /* FTP option that changes the timeout, in seconds, associated with
1204      getting a response.  This is different from transfer timeout time and
1205      essentially places a demand on the FTP server to acknowledge commands
1206      in a timely manner. */
1207   CINIT(FTP_RESPONSE_TIMEOUT, LONG, 112),
1208 #define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT
1209
1210   /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to
1211      tell libcurl to resolve names to those IP versions only. This only has
1212      affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */
1213   CINIT(IPRESOLVE, LONG, 113),
1214
1215   /* Set this option to limit the size of a file that will be downloaded from
1216      an HTTP or FTP server.
1217
1218      Note there is also _LARGE version which adds large file support for
1219      platforms which have larger off_t sizes.  See MAXFILESIZE_LARGE below. */
1220   CINIT(MAXFILESIZE, LONG, 114),
1221
1222   /* See the comment for INFILESIZE above, but in short, specifies
1223    * the size of the file being uploaded.  -1 means unknown.
1224    */
1225   CINIT(INFILESIZE_LARGE, OFF_T, 115),
1226
1227   /* Sets the continuation offset.  There is also a LONG version of this;
1228    * look above for RESUME_FROM.
1229    */
1230   CINIT(RESUME_FROM_LARGE, OFF_T, 116),
1231
1232   /* Sets the maximum size of data that will be downloaded from
1233    * an HTTP or FTP server.  See MAXFILESIZE above for the LONG version.
1234    */
1235   CINIT(MAXFILESIZE_LARGE, OFF_T, 117),
1236
1237   /* Set this option to the file name of your .netrc file you want libcurl
1238      to parse (using the CURLOPT_NETRC option). If not set, libcurl will do
1239      a poor attempt to find the user's home directory and check for a .netrc
1240      file in there. */
1241   CINIT(NETRC_FILE, OBJECTPOINT, 118),
1242
1243   /* Enable SSL/TLS for FTP, pick one of:
1244      CURLUSESSL_TRY     - try using SSL, proceed anyway otherwise
1245      CURLUSESSL_CONTROL - SSL for the control connection or fail
1246      CURLUSESSL_ALL     - SSL for all communication or fail
1247   */
1248   CINIT(USE_SSL, LONG, 119),
1249
1250   /* The _LARGE version of the standard POSTFIELDSIZE option */
1251   CINIT(POSTFIELDSIZE_LARGE, OFF_T, 120),
1252
1253   /* Enable/disable the TCP Nagle algorithm */
1254   CINIT(TCP_NODELAY, LONG, 121),
1255
1256   /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1257   /* 123 OBSOLETE. Gone in 7.16.0 */
1258   /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1259   /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1260   /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
1261   /* 127 OBSOLETE. Gone in 7.16.0 */
1262   /* 128 OBSOLETE. Gone in 7.16.0 */
1263
1264   /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option
1265      can be used to change libcurl's default action which is to first try
1266      "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK
1267      response has been received.
1268
1269      Available parameters are:
1270      CURLFTPAUTH_DEFAULT - let libcurl decide
1271      CURLFTPAUTH_SSL     - try "AUTH SSL" first, then TLS
1272      CURLFTPAUTH_TLS     - try "AUTH TLS" first, then SSL
1273   */
1274   CINIT(FTPSSLAUTH, LONG, 129),
1275
1276   CINIT(IOCTLFUNCTION, FUNCTIONPOINT, 130),
1277   CINIT(IOCTLDATA, OBJECTPOINT, 131),
1278
1279   /* 132 OBSOLETE. Gone in 7.16.0 */
1280   /* 133 OBSOLETE. Gone in 7.16.0 */
1281
1282   /* zero terminated string for pass on to the FTP server when asked for
1283      "account" info */
1284   CINIT(FTP_ACCOUNT, OBJECTPOINT, 134),
1285
1286   /* feed cookies into cookie engine */
1287   CINIT(COOKIELIST, OBJECTPOINT, 135),
1288
1289   /* ignore Content-Length */
1290   CINIT(IGNORE_CONTENT_LENGTH, LONG, 136),
1291
1292   /* Set to non-zero to skip the IP address received in a 227 PASV FTP server
1293      response. Typically used for FTP-SSL purposes but is not restricted to
1294      that. libcurl will then instead use the same IP address it used for the
1295      control connection. */
1296   CINIT(FTP_SKIP_PASV_IP, LONG, 137),
1297
1298   /* Select "file method" to use when doing FTP, see the curl_ftpmethod
1299      above. */
1300   CINIT(FTP_FILEMETHOD, LONG, 138),
1301
1302   /* Local port number to bind the socket to */
1303   CINIT(LOCALPORT, LONG, 139),
1304
1305   /* Number of ports to try, including the first one set with LOCALPORT.
1306      Thus, setting it to 1 will make no additional attempts but the first.
1307   */
1308   CINIT(LOCALPORTRANGE, LONG, 140),
1309
1310   /* no transfer, set up connection and let application use the socket by
1311      extracting it with CURLINFO_LASTSOCKET */
1312   CINIT(CONNECT_ONLY, LONG, 141),
1313
1314   /* Function that will be called to convert from the
1315      network encoding (instead of using the iconv calls in libcurl) */
1316   CINIT(CONV_FROM_NETWORK_FUNCTION, FUNCTIONPOINT, 142),
1317
1318   /* Function that will be called to convert to the
1319      network encoding (instead of using the iconv calls in libcurl) */
1320   CINIT(CONV_TO_NETWORK_FUNCTION, FUNCTIONPOINT, 143),
1321
1322   /* Function that will be called to convert from UTF8
1323      (instead of using the iconv calls in libcurl)
1324      Note that this is used only for SSL certificate processing */
1325   CINIT(CONV_FROM_UTF8_FUNCTION, FUNCTIONPOINT, 144),
1326
1327   /* if the connection proceeds too quickly then need to slow it down */
1328   /* limit-rate: maximum number of bytes per second to send or receive */
1329   CINIT(MAX_SEND_SPEED_LARGE, OFF_T, 145),
1330   CINIT(MAX_RECV_SPEED_LARGE, OFF_T, 146),
1331
1332   /* Pointer to command string to send if USER/PASS fails. */
1333   CINIT(FTP_ALTERNATIVE_TO_USER, OBJECTPOINT, 147),
1334
1335   /* callback function for setting socket options */
1336   CINIT(SOCKOPTFUNCTION, FUNCTIONPOINT, 148),
1337   CINIT(SOCKOPTDATA, OBJECTPOINT, 149),
1338
1339   /* set to 0 to disable session ID re-use for this transfer, default is
1340      enabled (== 1) */
1341   CINIT(SSL_SESSIONID_CACHE, LONG, 150),
1342
1343   /* allowed SSH authentication methods */
1344   CINIT(SSH_AUTH_TYPES, LONG, 151),
1345
1346   /* Used by scp/sftp to do public/private key authentication */
1347   CINIT(SSH_PUBLIC_KEYFILE, OBJECTPOINT, 152),
1348   CINIT(SSH_PRIVATE_KEYFILE, OBJECTPOINT, 153),
1349
1350   /* Send CCC (Clear Command Channel) after authentication */
1351   CINIT(FTP_SSL_CCC, LONG, 154),
1352
1353   /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */
1354   CINIT(TIMEOUT_MS, LONG, 155),
1355   CINIT(CONNECTTIMEOUT_MS, LONG, 156),
1356
1357   /* set to zero to disable the libcurl's decoding and thus pass the raw body
1358      data to the application even when it is encoded/compressed */
1359   CINIT(HTTP_TRANSFER_DECODING, LONG, 157),
1360   CINIT(HTTP_CONTENT_DECODING, LONG, 158),
1361
1362   /* Permission used when creating new files and directories on the remote
1363      server for protocols that support it, SFTP/SCP/FILE */
1364   CINIT(NEW_FILE_PERMS, LONG, 159),
1365   CINIT(NEW_DIRECTORY_PERMS, LONG, 160),
1366
1367   /* Set the behaviour of POST when redirecting. Values must be set to one
1368      of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */
1369   CINIT(POSTREDIR, LONG, 161),
1370
1371   /* used by scp/sftp to verify the host's public key */
1372   CINIT(SSH_HOST_PUBLIC_KEY_MD5, OBJECTPOINT, 162),
1373
1374   /* Callback function for opening socket (instead of socket(2)). Optionally,
1375      callback is able change the address or refuse to connect returning
1376      CURL_SOCKET_BAD.  The callback should have type
1377      curl_opensocket_callback */
1378   CINIT(OPENSOCKETFUNCTION, FUNCTIONPOINT, 163),
1379   CINIT(OPENSOCKETDATA, OBJECTPOINT, 164),
1380
1381   /* POST volatile input fields. */
1382   CINIT(COPYPOSTFIELDS, OBJECTPOINT, 165),
1383
1384   /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */
1385   CINIT(PROXY_TRANSFER_MODE, LONG, 166),
1386
1387   /* Callback function for seeking in the input stream */
1388   CINIT(SEEKFUNCTION, FUNCTIONPOINT, 167),
1389   CINIT(SEEKDATA, OBJECTPOINT, 168),
1390
1391   /* CRL file */
1392   CINIT(CRLFILE, OBJECTPOINT, 169),
1393
1394   /* Issuer certificate */
1395   CINIT(ISSUERCERT, OBJECTPOINT, 170),
1396
1397   /* (IPv6) Address scope */
1398   CINIT(ADDRESS_SCOPE, LONG, 171),
1399
1400   /* Collect certificate chain info and allow it to get retrievable with
1401      CURLINFO_CERTINFO after the transfer is complete. */
1402   CINIT(CERTINFO, LONG, 172),
1403
1404   /* "name" and "pwd" to use when fetching. */
1405   CINIT(USERNAME, OBJECTPOINT, 173),
1406   CINIT(PASSWORD, OBJECTPOINT, 174),
1407
1408     /* "name" and "pwd" to use with Proxy when fetching. */
1409   CINIT(PROXYUSERNAME, OBJECTPOINT, 175),
1410   CINIT(PROXYPASSWORD, OBJECTPOINT, 176),
1411
1412   /* Comma separated list of hostnames defining no-proxy zones. These should
1413      match both hostnames directly, and hostnames within a domain. For
1414      example, local.com will match local.com and www.local.com, but NOT
1415      notlocal.com or www.notlocal.com. For compatibility with other
1416      implementations of this, .local.com will be considered to be the same as
1417      local.com. A single * is the only valid wildcard, and effectively
1418      disables the use of proxy. */
1419   CINIT(NOPROXY, OBJECTPOINT, 177),
1420
1421   /* block size for TFTP transfers */
1422   CINIT(TFTP_BLKSIZE, LONG, 178),
1423
1424   /* Socks Service */
1425   CINIT(SOCKS5_GSSAPI_SERVICE, OBJECTPOINT, 179),
1426
1427   /* Socks Service */
1428   CINIT(SOCKS5_GSSAPI_NEC, LONG, 180),
1429
1430   /* set the bitmask for the protocols that are allowed to be used for the
1431      transfer, which thus helps the app which takes URLs from users or other
1432      external inputs and want to restrict what protocol(s) to deal
1433      with. Defaults to CURLPROTO_ALL. */
1434   CINIT(PROTOCOLS, LONG, 181),
1435
1436   /* set the bitmask for the protocols that libcurl is allowed to follow to,
1437      as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs
1438      to be set in both bitmasks to be allowed to get redirected to. Defaults
1439      to all protocols except FILE and SCP. */
1440   CINIT(REDIR_PROTOCOLS, LONG, 182),
1441
1442   /* set the SSH knownhost file name to use */
1443   CINIT(SSH_KNOWNHOSTS, OBJECTPOINT, 183),
1444
1445   /* set the SSH host key callback, must point to a curl_sshkeycallback
1446      function */
1447   CINIT(SSH_KEYFUNCTION, FUNCTIONPOINT, 184),
1448
1449   /* set the SSH host key callback custom pointer */
1450   CINIT(SSH_KEYDATA, OBJECTPOINT, 185),
1451
1452   /* set the SMTP mail originator */
1453   CINIT(MAIL_FROM, OBJECTPOINT, 186),
1454
1455   /* set the SMTP mail receiver(s) */
1456   CINIT(MAIL_RCPT, OBJECTPOINT, 187),
1457
1458   /* FTP: send PRET before PASV */
1459   CINIT(FTP_USE_PRET, LONG, 188),
1460
1461   /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */
1462   CINIT(RTSP_REQUEST, LONG, 189),
1463
1464   /* The RTSP session identifier */
1465   CINIT(RTSP_SESSION_ID, OBJECTPOINT, 190),
1466
1467   /* The RTSP stream URI */
1468   CINIT(RTSP_STREAM_URI, OBJECTPOINT, 191),
1469
1470   /* The Transport: header to use in RTSP requests */
1471   CINIT(RTSP_TRANSPORT, OBJECTPOINT, 192),
1472
1473   /* Manually initialize the client RTSP CSeq for this handle */
1474   CINIT(RTSP_CLIENT_CSEQ, LONG, 193),
1475
1476   /* Manually initialize the server RTSP CSeq for this handle */
1477   CINIT(RTSP_SERVER_CSEQ, LONG, 194),
1478
1479   /* The stream to pass to INTERLEAVEFUNCTION. */
1480   CINIT(INTERLEAVEDATA, OBJECTPOINT, 195),
1481
1482   /* Let the application define a custom write method for RTP data */
1483   CINIT(INTERLEAVEFUNCTION, FUNCTIONPOINT, 196),
1484
1485   /* Turn on wildcard matching */
1486   CINIT(WILDCARDMATCH, LONG, 197),
1487
1488   /* Directory matching callback called before downloading of an
1489      individual file (chunk) started */
1490   CINIT(CHUNK_BGN_FUNCTION, FUNCTIONPOINT, 198),
1491
1492   /* Directory matching callback called after the file (chunk)
1493      was downloaded, or skipped */
1494   CINIT(CHUNK_END_FUNCTION, FUNCTIONPOINT, 199),
1495
1496   /* Change match (fnmatch-like) callback for wildcard matching */
1497   CINIT(FNMATCH_FUNCTION, FUNCTIONPOINT, 200),
1498
1499   /* Let the application define custom chunk data pointer */
1500   CINIT(CHUNK_DATA, OBJECTPOINT, 201),
1501
1502   /* FNMATCH_FUNCTION user pointer */
1503   CINIT(FNMATCH_DATA, OBJECTPOINT, 202),
1504
1505   /* send linked-list of name:port:address sets */
1506   CINIT(RESOLVE, OBJECTPOINT, 203),
1507
1508   /* Set a username for authenticated TLS */
1509   CINIT(TLSAUTH_USERNAME, OBJECTPOINT, 204),
1510
1511   /* Set a password for authenticated TLS */
1512   CINIT(TLSAUTH_PASSWORD, OBJECTPOINT, 205),
1513
1514   /* Set authentication type for authenticated TLS */
1515   CINIT(TLSAUTH_TYPE, OBJECTPOINT, 206),
1516
1517   /* Set to 1 to enable the "TE:" header in HTTP requests to ask for
1518      compressed transfer-encoded responses. Set to 0 to disable the use of TE:
1519      in outgoing requests. The current default is 0, but it might change in a
1520      future libcurl release.
1521
1522      libcurl will ask for the compressed methods it knows of, and if that
1523      isn't any, it will not ask for transfer-encoding at all even if this
1524      option is set to 1.
1525
1526   */
1527   CINIT(TRANSFER_ENCODING, LONG, 207),
1528
1529   /* Callback function for closing socket (instead of close(2)). The callback
1530      should have type curl_closesocket_callback */
1531   CINIT(CLOSESOCKETFUNCTION, FUNCTIONPOINT, 208),
1532   CINIT(CLOSESOCKETDATA, OBJECTPOINT, 209),
1533
1534   /* allow GSSAPI credential delegation */
1535   CINIT(GSSAPI_DELEGATION, LONG, 210),
1536
1537   /* Set the name servers to use for DNS resolution */
1538   CINIT(DNS_SERVERS, OBJECTPOINT, 211),
1539
1540   /* Time-out accept operations (currently for FTP only) after this amount
1541      of miliseconds. */
1542   CINIT(ACCEPTTIMEOUT_MS, LONG, 212),
1543
1544   /* Set TCP keepalive */
1545   CINIT(TCP_KEEPALIVE, LONG, 213),
1546
1547   /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */
1548   CINIT(TCP_KEEPIDLE, LONG, 214),
1549   CINIT(TCP_KEEPINTVL, LONG, 215),
1550
1551   /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */
1552   CINIT(SSL_OPTIONS, LONG, 216),
1553
1554   /* Set the SMTP auth originator */
1555   CINIT(MAIL_AUTH, OBJECTPOINT, 217),
1556
1557   /* Enable/disable SASL initial response */
1558   CINIT(SASL_IR, LONG, 218),
1559
1560   /* Function that will be called instead of the internal progress display
1561    * function. This function should be defined as the curl_xferinfo_callback
1562    * prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */
1563   CINIT(XFERINFOFUNCTION, FUNCTIONPOINT, 219),
1564
1565   /* The XOAUTH2 bearer token */
1566   CINIT(XOAUTH2_BEARER, OBJECTPOINT, 220),
1567
1568   /* Set the interface string to use as outgoing network
1569    * interface for DNS requests.
1570    * Only supported by the c-ares DNS backend */
1571   CINIT(DNS_INTERFACE, OBJECTPOINT, 221),
1572
1573   /* Set the local IPv4 address to use for outgoing DNS requests.
1574    * Only supported by the c-ares DNS backend */
1575   CINIT(DNS_LOCAL_IP4, OBJECTPOINT, 222),
1576
1577   /* Set the local IPv4 address to use for outgoing DNS requests.
1578    * Only supported by the c-ares DNS backend */
1579   CINIT(DNS_LOCAL_IP6, OBJECTPOINT, 223),
1580
1581   /* Set authentication options directly */
1582   CINIT(LOGIN_OPTIONS, OBJECTPOINT, 224),
1583
1584   /* Enable/disable TLS NPN extension (http2 over ssl might fail without) */
1585   CINIT(SSL_ENABLE_NPN, LONG, 225),
1586
1587   /* Enable/disable TLS ALPN extension (http2 over ssl might fail without) */
1588   CINIT(SSL_ENABLE_ALPN, LONG, 226),
1589
1590   /* Time to wait for a response to a HTTP request containing an
1591    * Expect: 100-continue header before sending the data anyway. */
1592   CINIT(EXPECT_100_TIMEOUT_MS, LONG, 227),
1593
1594   /* This points to a linked list of headers used for proxy requests only,
1595      struct curl_slist kind */
1596   CINIT(PROXYHEADER, OBJECTPOINT, 228),
1597
1598   /* Pass in a bitmask of "header options" */
1599   CINIT(HEADEROPT, LONG, 229),
1600
1601   CURLOPT_LASTENTRY /* the last unused */
1602 } CURLoption;
1603
1604 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all
1605                           the obsolete stuff removed! */
1606
1607 /* Backwards compatibility with older names */
1608 /* These are scheduled to disappear by 2011 */
1609
1610 /* This was added in version 7.19.1 */
1611 #define CURLOPT_POST301 CURLOPT_POSTREDIR
1612
1613 /* These are scheduled to disappear by 2009 */
1614
1615 /* The following were added in 7.17.0 */
1616 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD
1617 #define CURLOPT_FTPAPPEND CURLOPT_APPEND
1618 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY
1619 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL
1620
1621 /* The following were added earlier */
1622
1623 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD
1624 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL
1625
1626 #else
1627 /* This is set if CURL_NO_OLDIES is defined at compile-time */
1628 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */
1629 #endif
1630
1631
1632   /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host
1633      name resolves addresses using more than one IP protocol version, this
1634      option might be handy to force libcurl to use a specific IP version. */
1635 #define CURL_IPRESOLVE_WHATEVER 0 /* default, resolves addresses to all IP
1636                                      versions that your system allows */
1637 #define CURL_IPRESOLVE_V4       1 /* resolve to ipv4 addresses */
1638 #define CURL_IPRESOLVE_V6       2 /* resolve to ipv6 addresses */
1639
1640   /* three convenient "aliases" that follow the name scheme better */
1641 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER
1642
1643   /* These enums are for use with the CURLOPT_HTTP_VERSION option. */
1644 enum {
1645   CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd
1646                              like the library to choose the best possible
1647                              for us! */
1648   CURL_HTTP_VERSION_1_0,  /* please use HTTP 1.0 in the request */
1649   CURL_HTTP_VERSION_1_1,  /* please use HTTP 1.1 in the request */
1650   CURL_HTTP_VERSION_2_0,  /* please use HTTP 2.0 in the request */
1651
1652   CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */
1653 };
1654
1655 /*
1656  * Public API enums for RTSP requests
1657  */
1658 enum {
1659     CURL_RTSPREQ_NONE, /* first in list */
1660     CURL_RTSPREQ_OPTIONS,
1661     CURL_RTSPREQ_DESCRIBE,
1662     CURL_RTSPREQ_ANNOUNCE,
1663     CURL_RTSPREQ_SETUP,
1664     CURL_RTSPREQ_PLAY,
1665     CURL_RTSPREQ_PAUSE,
1666     CURL_RTSPREQ_TEARDOWN,
1667     CURL_RTSPREQ_GET_PARAMETER,
1668     CURL_RTSPREQ_SET_PARAMETER,
1669     CURL_RTSPREQ_RECORD,
1670     CURL_RTSPREQ_RECEIVE,
1671     CURL_RTSPREQ_LAST /* last in list */
1672 };
1673
1674   /* These enums are for use with the CURLOPT_NETRC option. */
1675 enum CURL_NETRC_OPTION {
1676   CURL_NETRC_IGNORED,     /* The .netrc will never be read.
1677                            * This is the default. */
1678   CURL_NETRC_OPTIONAL,    /* A user:password in the URL will be preferred
1679                            * to one in the .netrc. */
1680   CURL_NETRC_REQUIRED,    /* A user:password in the URL will be ignored.
1681                            * Unless one is set programmatically, the .netrc
1682                            * will be queried. */
1683   CURL_NETRC_LAST
1684 };
1685
1686 enum {
1687   CURL_SSLVERSION_DEFAULT,
1688   CURL_SSLVERSION_TLSv1, /* TLS 1.x */
1689   CURL_SSLVERSION_SSLv2,
1690   CURL_SSLVERSION_SSLv3,
1691   CURL_SSLVERSION_TLSv1_0,
1692   CURL_SSLVERSION_TLSv1_1,
1693   CURL_SSLVERSION_TLSv1_2,
1694
1695   CURL_SSLVERSION_LAST /* never use, keep last */
1696 };
1697
1698 enum CURL_TLSAUTH {
1699   CURL_TLSAUTH_NONE,
1700   CURL_TLSAUTH_SRP,
1701   CURL_TLSAUTH_LAST /* never use, keep last */
1702 };
1703
1704 /* symbols to use with CURLOPT_POSTREDIR.
1705    CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303
1706    can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302
1707    | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */
1708
1709 #define CURL_REDIR_GET_ALL  0
1710 #define CURL_REDIR_POST_301 1
1711 #define CURL_REDIR_POST_302 2
1712 #define CURL_REDIR_POST_303 4
1713 #define CURL_REDIR_POST_ALL \
1714     (CURL_REDIR_POST_301|CURL_REDIR_POST_302|CURL_REDIR_POST_303)
1715
1716 typedef enum {
1717   CURL_TIMECOND_NONE,
1718
1719   CURL_TIMECOND_IFMODSINCE,
1720   CURL_TIMECOND_IFUNMODSINCE,
1721   CURL_TIMECOND_LASTMOD,
1722
1723   CURL_TIMECOND_LAST
1724 } curl_TimeCond;
1725
1726
1727 /* curl_strequal() and curl_strnequal() are subject for removal in a future
1728    libcurl, see lib/README.curlx for details */
1729 CURL_EXTERN int (curl_strequal)(const char *s1, const char *s2);
1730 CURL_EXTERN int (curl_strnequal)(const char *s1, const char *s2, size_t n);
1731
1732 /* name is uppercase CURLFORM_<name> */
1733 #ifdef CFINIT
1734 #undef CFINIT
1735 #endif
1736
1737 #ifdef CURL_ISOCPP
1738 #define CFINIT(name) CURLFORM_ ## name
1739 #else
1740 /* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */
1741 #define CFINIT(name) CURLFORM_/**/name
1742 #endif
1743
1744 typedef enum {
1745   CFINIT(NOTHING),        /********* the first one is unused ************/
1746
1747   /*  */
1748   CFINIT(COPYNAME),
1749   CFINIT(PTRNAME),
1750   CFINIT(NAMELENGTH),
1751   CFINIT(COPYCONTENTS),
1752   CFINIT(PTRCONTENTS),
1753   CFINIT(CONTENTSLENGTH),
1754   CFINIT(FILECONTENT),
1755   CFINIT(ARRAY),
1756   CFINIT(OBSOLETE),
1757   CFINIT(FILE),
1758
1759   CFINIT(BUFFER),
1760   CFINIT(BUFFERPTR),
1761   CFINIT(BUFFERLENGTH),
1762
1763   CFINIT(CONTENTTYPE),
1764   CFINIT(CONTENTHEADER),
1765   CFINIT(FILENAME),
1766   CFINIT(END),
1767   CFINIT(OBSOLETE2),
1768
1769   CFINIT(STREAM),
1770
1771   CURLFORM_LASTENTRY /* the last unused */
1772 } CURLformoption;
1773
1774 #undef CFINIT /* done */
1775
1776 /* structure to be used as parameter for CURLFORM_ARRAY */
1777 struct curl_forms {
1778   CURLformoption option;
1779   const char     *value;
1780 };
1781
1782 /* use this for multipart formpost building */
1783 /* Returns code for curl_formadd()
1784  *
1785  * Returns:
1786  * CURL_FORMADD_OK             on success
1787  * CURL_FORMADD_MEMORY         if the FormInfo allocation fails
1788  * CURL_FORMADD_OPTION_TWICE   if one option is given twice for one Form
1789  * CURL_FORMADD_NULL           if a null pointer was given for a char
1790  * CURL_FORMADD_MEMORY         if the allocation of a FormInfo struct failed
1791  * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used
1792  * CURL_FORMADD_INCOMPLETE     if the some FormInfo is not complete (or error)
1793  * CURL_FORMADD_MEMORY         if a curl_httppost struct cannot be allocated
1794  * CURL_FORMADD_MEMORY         if some allocation for string copying failed.
1795  * CURL_FORMADD_ILLEGAL_ARRAY  if an illegal option is used in an array
1796  *
1797  ***************************************************************************/
1798 typedef enum {
1799   CURL_FORMADD_OK, /* first, no error */
1800
1801   CURL_FORMADD_MEMORY,
1802   CURL_FORMADD_OPTION_TWICE,
1803   CURL_FORMADD_NULL,
1804   CURL_FORMADD_UNKNOWN_OPTION,
1805   CURL_FORMADD_INCOMPLETE,
1806   CURL_FORMADD_ILLEGAL_ARRAY,
1807   CURL_FORMADD_DISABLED, /* libcurl was built with this disabled */
1808
1809   CURL_FORMADD_LAST /* last */
1810 } CURLFORMcode;
1811
1812 /*
1813  * NAME curl_formadd()
1814  *
1815  * DESCRIPTION
1816  *
1817  * Pretty advanced function for building multi-part formposts. Each invoke
1818  * adds one part that together construct a full post. Then use
1819  * CURLOPT_HTTPPOST to send it off to libcurl.
1820  */
1821 CURL_EXTERN CURLFORMcode curl_formadd(struct curl_httppost **httppost,
1822                                       struct curl_httppost **last_post,
1823                                       ...);
1824
1825 /*
1826  * callback function for curl_formget()
1827  * The void *arg pointer will be the one passed as second argument to
1828  *   curl_formget().
1829  * The character buffer passed to it must not be freed.
1830  * Should return the buffer length passed to it as the argument "len" on
1831  *   success.
1832  */
1833 typedef size_t (*curl_formget_callback)(void *arg, const char *buf,
1834                                         size_t len);
1835
1836 /*
1837  * NAME curl_formget()
1838  *
1839  * DESCRIPTION
1840  *
1841  * Serialize a curl_httppost struct built with curl_formadd().
1842  * Accepts a void pointer as second argument which will be passed to
1843  * the curl_formget_callback function.
1844  * Returns 0 on success.
1845  */
1846 CURL_EXTERN int curl_formget(struct curl_httppost *form, void *arg,
1847                              curl_formget_callback append);
1848 /*
1849  * NAME curl_formfree()
1850  *
1851  * DESCRIPTION
1852  *
1853  * Free a multipart formpost previously built with curl_formadd().
1854  */
1855 CURL_EXTERN void curl_formfree(struct curl_httppost *form);
1856
1857 /*
1858  * NAME curl_getenv()
1859  *
1860  * DESCRIPTION
1861  *
1862  * Returns a malloc()'ed string that MUST be curl_free()ed after usage is
1863  * complete. DEPRECATED - see lib/README.curlx
1864  */
1865 CURL_EXTERN char *curl_getenv(const char *variable);
1866
1867 /*
1868  * NAME curl_version()
1869  *
1870  * DESCRIPTION
1871  *
1872  * Returns a static ascii string of the libcurl version.
1873  */
1874 CURL_EXTERN char *curl_version(void);
1875
1876 /*
1877  * NAME curl_easy_escape()
1878  *
1879  * DESCRIPTION
1880  *
1881  * Escapes URL strings (converts all letters consider illegal in URLs to their
1882  * %XX versions). This function returns a new allocated string or NULL if an
1883  * error occurred.
1884  */
1885 CURL_EXTERN char *curl_easy_escape(CURL *handle,
1886                                    const char *string,
1887                                    int length);
1888
1889 /* the previous version: */
1890 CURL_EXTERN char *curl_escape(const char *string,
1891                               int length);
1892
1893
1894 /*
1895  * NAME curl_easy_unescape()
1896  *
1897  * DESCRIPTION
1898  *
1899  * Unescapes URL encoding in strings (converts all %XX codes to their 8bit
1900  * versions). This function returns a new allocated string or NULL if an error
1901  * occurred.
1902  * Conversion Note: On non-ASCII platforms the ASCII %XX codes are
1903  * converted into the host encoding.
1904  */
1905 CURL_EXTERN char *curl_easy_unescape(CURL *handle,
1906                                      const char *string,
1907                                      int length,
1908                                      int *outlength);
1909
1910 /* the previous version */
1911 CURL_EXTERN char *curl_unescape(const char *string,
1912                                 int length);
1913
1914 /*
1915  * NAME curl_free()
1916  *
1917  * DESCRIPTION
1918  *
1919  * Provided for de-allocation in the same translation unit that did the
1920  * allocation. Added in libcurl 7.10
1921  */
1922 CURL_EXTERN void curl_free(void *p);
1923
1924 /*
1925  * NAME curl_global_init()
1926  *
1927  * DESCRIPTION
1928  *
1929  * curl_global_init() should be invoked exactly once for each application that
1930  * uses libcurl and before any call of other libcurl functions.
1931  *
1932  * This function is not thread-safe!
1933  */
1934 CURL_EXTERN CURLcode curl_global_init(long flags);
1935
1936 /*
1937  * NAME curl_global_init_mem()
1938  *
1939  * DESCRIPTION
1940  *
1941  * curl_global_init() or curl_global_init_mem() should be invoked exactly once
1942  * for each application that uses libcurl.  This function can be used to
1943  * initialize libcurl and set user defined memory management callback
1944  * functions.  Users can implement memory management routines to check for
1945  * memory leaks, check for mis-use of the curl library etc.  User registered
1946  * callback routines with be invoked by this library instead of the system
1947  * memory management routines like malloc, free etc.
1948  */
1949 CURL_EXTERN CURLcode curl_global_init_mem(long flags,
1950                                           curl_malloc_callback m,
1951                                           curl_free_callback f,
1952                                           curl_realloc_callback r,
1953                                           curl_strdup_callback s,
1954                                           curl_calloc_callback c);
1955
1956 /*
1957  * NAME curl_global_cleanup()
1958  *
1959  * DESCRIPTION
1960  *
1961  * curl_global_cleanup() should be invoked exactly once for each application
1962  * that uses libcurl
1963  */
1964 CURL_EXTERN void curl_global_cleanup(void);
1965
1966 /* linked-list structure for the CURLOPT_QUOTE option (and other) */
1967 struct curl_slist {
1968   char *data;
1969   struct curl_slist *next;
1970 };
1971
1972 /*
1973  * NAME curl_slist_append()
1974  *
1975  * DESCRIPTION
1976  *
1977  * Appends a string to a linked list. If no list exists, it will be created
1978  * first. Returns the new list, after appending.
1979  */
1980 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *,
1981                                                  const char *);
1982
1983 /*
1984  * NAME curl_slist_free_all()
1985  *
1986  * DESCRIPTION
1987  *
1988  * free a previously built curl_slist.
1989  */
1990 CURL_EXTERN void curl_slist_free_all(struct curl_slist *);
1991
1992 /*
1993  * NAME curl_getdate()
1994  *
1995  * DESCRIPTION
1996  *
1997  * Returns the time, in seconds since 1 Jan 1970 of the time string given in
1998  * the first argument. The time argument in the second parameter is unused
1999  * and should be set to NULL.
2000  */
2001 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused);
2002
2003 /* info about the certificate chain, only for OpenSSL builds. Asked
2004    for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */
2005 struct curl_certinfo {
2006   int num_of_certs;             /* number of certificates with information */
2007   struct curl_slist **certinfo; /* for each index in this array, there's a
2008                                    linked list with textual information in the
2009                                    format "name: value" */
2010 };
2011
2012 /* enum for the different supported SSL backends */
2013 typedef enum {
2014   CURLSSLBACKEND_NONE = 0,
2015   CURLSSLBACKEND_OPENSSL = 1,
2016   CURLSSLBACKEND_GNUTLS = 2,
2017   CURLSSLBACKEND_NSS = 3,
2018   CURLSSLBACKEND_QSOSSL = 4,
2019   CURLSSLBACKEND_GSKIT = 5,
2020   CURLSSLBACKEND_POLARSSL = 6,
2021   CURLSSLBACKEND_CYASSL = 7,
2022   CURLSSLBACKEND_SCHANNEL = 8,
2023   CURLSSLBACKEND_DARWINSSL = 9
2024 } curl_sslbackend;
2025
2026 /* Information about the SSL library used and the respective internal SSL
2027    handle, which can be used to obtain further information regarding the
2028    connection. Asked for with CURLINFO_TLS_SESSION. */
2029 struct curl_tlssessioninfo {
2030   curl_sslbackend backend;
2031   void *internals;
2032 };
2033
2034 #define CURLINFO_STRING   0x100000
2035 #define CURLINFO_LONG     0x200000
2036 #define CURLINFO_DOUBLE   0x300000
2037 #define CURLINFO_SLIST    0x400000
2038 #define CURLINFO_MASK     0x0fffff
2039 #define CURLINFO_TYPEMASK 0xf00000
2040
2041 typedef enum {
2042   CURLINFO_NONE, /* first, never use this */
2043   CURLINFO_EFFECTIVE_URL    = CURLINFO_STRING + 1,
2044   CURLINFO_RESPONSE_CODE    = CURLINFO_LONG   + 2,
2045   CURLINFO_TOTAL_TIME       = CURLINFO_DOUBLE + 3,
2046   CURLINFO_NAMELOOKUP_TIME  = CURLINFO_DOUBLE + 4,
2047   CURLINFO_CONNECT_TIME     = CURLINFO_DOUBLE + 5,
2048   CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6,
2049   CURLINFO_SIZE_UPLOAD      = CURLINFO_DOUBLE + 7,
2050   CURLINFO_SIZE_DOWNLOAD    = CURLINFO_DOUBLE + 8,
2051   CURLINFO_SPEED_DOWNLOAD   = CURLINFO_DOUBLE + 9,
2052   CURLINFO_SPEED_UPLOAD     = CURLINFO_DOUBLE + 10,
2053   CURLINFO_HEADER_SIZE      = CURLINFO_LONG   + 11,
2054   CURLINFO_REQUEST_SIZE     = CURLINFO_LONG   + 12,
2055   CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG   + 13,
2056   CURLINFO_FILETIME         = CURLINFO_LONG   + 14,
2057   CURLINFO_CONTENT_LENGTH_DOWNLOAD   = CURLINFO_DOUBLE + 15,
2058   CURLINFO_CONTENT_LENGTH_UPLOAD     = CURLINFO_DOUBLE + 16,
2059   CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17,
2060   CURLINFO_CONTENT_TYPE     = CURLINFO_STRING + 18,
2061   CURLINFO_REDIRECT_TIME    = CURLINFO_DOUBLE + 19,
2062   CURLINFO_REDIRECT_COUNT   = CURLINFO_LONG   + 20,
2063   CURLINFO_PRIVATE          = CURLINFO_STRING + 21,
2064   CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG   + 22,
2065   CURLINFO_HTTPAUTH_AVAIL   = CURLINFO_LONG   + 23,
2066   CURLINFO_PROXYAUTH_AVAIL  = CURLINFO_LONG   + 24,
2067   CURLINFO_OS_ERRNO         = CURLINFO_LONG   + 25,
2068   CURLINFO_NUM_CONNECTS     = CURLINFO_LONG   + 26,
2069   CURLINFO_SSL_ENGINES      = CURLINFO_SLIST  + 27,
2070   CURLINFO_COOKIELIST       = CURLINFO_SLIST  + 28,
2071   CURLINFO_LASTSOCKET       = CURLINFO_LONG   + 29,
2072   CURLINFO_FTP_ENTRY_PATH   = CURLINFO_STRING + 30,
2073   CURLINFO_REDIRECT_URL     = CURLINFO_STRING + 31,
2074   CURLINFO_PRIMARY_IP       = CURLINFO_STRING + 32,
2075   CURLINFO_APPCONNECT_TIME  = CURLINFO_DOUBLE + 33,
2076   CURLINFO_CERTINFO         = CURLINFO_SLIST  + 34,
2077   CURLINFO_CONDITION_UNMET  = CURLINFO_LONG   + 35,
2078   CURLINFO_RTSP_SESSION_ID  = CURLINFO_STRING + 36,
2079   CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG   + 37,
2080   CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG   + 38,
2081   CURLINFO_RTSP_CSEQ_RECV   = CURLINFO_LONG   + 39,
2082   CURLINFO_PRIMARY_PORT     = CURLINFO_LONG   + 40,
2083   CURLINFO_LOCAL_IP         = CURLINFO_STRING + 41,
2084   CURLINFO_LOCAL_PORT       = CURLINFO_LONG   + 42,
2085   CURLINFO_TLS_SESSION      = CURLINFO_SLIST  + 43,
2086   /* Fill in new entries below here! */
2087
2088   CURLINFO_LASTONE          = 43
2089 } CURLINFO;
2090
2091 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as
2092    CURLINFO_HTTP_CODE */
2093 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE
2094
2095 typedef enum {
2096   CURLCLOSEPOLICY_NONE, /* first, never use this */
2097
2098   CURLCLOSEPOLICY_OLDEST,
2099   CURLCLOSEPOLICY_LEAST_RECENTLY_USED,
2100   CURLCLOSEPOLICY_LEAST_TRAFFIC,
2101   CURLCLOSEPOLICY_SLOWEST,
2102   CURLCLOSEPOLICY_CALLBACK,
2103
2104   CURLCLOSEPOLICY_LAST /* last, never use this */
2105 } curl_closepolicy;
2106
2107 #define CURL_GLOBAL_SSL (1<<0)
2108 #define CURL_GLOBAL_WIN32 (1<<1)
2109 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32)
2110 #define CURL_GLOBAL_NOTHING 0
2111 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL
2112 #define CURL_GLOBAL_ACK_EINTR (1<<2)
2113
2114
2115 /*****************************************************************************
2116  * Setup defines, protos etc for the sharing stuff.
2117  */
2118
2119 /* Different data locks for a single share */
2120 typedef enum {
2121   CURL_LOCK_DATA_NONE = 0,
2122   /*  CURL_LOCK_DATA_SHARE is used internally to say that
2123    *  the locking is just made to change the internal state of the share
2124    *  itself.
2125    */
2126   CURL_LOCK_DATA_SHARE,
2127   CURL_LOCK_DATA_COOKIE,
2128   CURL_LOCK_DATA_DNS,
2129   CURL_LOCK_DATA_SSL_SESSION,
2130   CURL_LOCK_DATA_CONNECT,
2131   CURL_LOCK_DATA_LAST
2132 } curl_lock_data;
2133
2134 /* Different lock access types */
2135 typedef enum {
2136   CURL_LOCK_ACCESS_NONE = 0,   /* unspecified action */
2137   CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */
2138   CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */
2139   CURL_LOCK_ACCESS_LAST        /* never use */
2140 } curl_lock_access;
2141
2142 typedef void (*curl_lock_function)(CURL *handle,
2143                                    curl_lock_data data,
2144                                    curl_lock_access locktype,
2145                                    void *userptr);
2146 typedef void (*curl_unlock_function)(CURL *handle,
2147                                      curl_lock_data data,
2148                                      void *userptr);
2149
2150 typedef void CURLSH;
2151
2152 typedef enum {
2153   CURLSHE_OK,  /* all is fine */
2154   CURLSHE_BAD_OPTION, /* 1 */
2155   CURLSHE_IN_USE,     /* 2 */
2156   CURLSHE_INVALID,    /* 3 */
2157   CURLSHE_NOMEM,      /* 4 out of memory */
2158   CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */
2159   CURLSHE_LAST        /* never use */
2160 } CURLSHcode;
2161
2162 typedef enum {
2163   CURLSHOPT_NONE,  /* don't use */
2164   CURLSHOPT_SHARE,   /* specify a data type to share */
2165   CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */
2166   CURLSHOPT_LOCKFUNC,   /* pass in a 'curl_lock_function' pointer */
2167   CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */
2168   CURLSHOPT_USERDATA,   /* pass in a user data pointer used in the lock/unlock
2169                            callback functions */
2170   CURLSHOPT_LAST  /* never use */
2171 } CURLSHoption;
2172
2173 CURL_EXTERN CURLSH *curl_share_init(void);
2174 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option, ...);
2175 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *);
2176
2177 /****************************************************************************
2178  * Structures for querying information about the curl library at runtime.
2179  */
2180
2181 typedef enum {
2182   CURLVERSION_FIRST,
2183   CURLVERSION_SECOND,
2184   CURLVERSION_THIRD,
2185   CURLVERSION_FOURTH,
2186   CURLVERSION_LAST /* never actually use this */
2187 } CURLversion;
2188
2189 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by
2190    basically all programs ever that want to get version information. It is
2191    meant to be a built-in version number for what kind of struct the caller
2192    expects. If the struct ever changes, we redefine the NOW to another enum
2193    from above. */
2194 #define CURLVERSION_NOW CURLVERSION_FOURTH
2195
2196 typedef struct {
2197   CURLversion age;          /* age of the returned struct */
2198   const char *version;      /* LIBCURL_VERSION */
2199   unsigned int version_num; /* LIBCURL_VERSION_NUM */
2200   const char *host;         /* OS/host/cpu/machine when configured */
2201   int features;             /* bitmask, see defines below */
2202   const char *ssl_version;  /* human readable string */
2203   long ssl_version_num;     /* not used anymore, always 0 */
2204   const char *libz_version; /* human readable string */
2205   /* protocols is terminated by an entry with a NULL protoname */
2206   const char * const *protocols;
2207
2208   /* The fields below this were added in CURLVERSION_SECOND */
2209   const char *ares;
2210   int ares_num;
2211
2212   /* This field was added in CURLVERSION_THIRD */
2213   const char *libidn;
2214
2215   /* These field were added in CURLVERSION_FOURTH */
2216
2217   /* Same as '_libiconv_version' if built with HAVE_ICONV */
2218   int iconv_ver_num;
2219
2220   const char *libssh_version; /* human readable string */
2221
2222 } curl_version_info_data;
2223
2224 #define CURL_VERSION_IPV6      (1<<0)  /* IPv6-enabled */
2225 #define CURL_VERSION_KERBEROS4 (1<<1)  /* kerberos auth is supported */
2226 #define CURL_VERSION_SSL       (1<<2)  /* SSL options are present */
2227 #define CURL_VERSION_LIBZ      (1<<3)  /* libz features are present */
2228 #define CURL_VERSION_NTLM      (1<<4)  /* NTLM auth is supported */
2229 #define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth support */
2230 #define CURL_VERSION_DEBUG     (1<<6)  /* built with debug capabilities */
2231 #define CURL_VERSION_ASYNCHDNS (1<<7)  /* asynchronous dns resolves */
2232 #define CURL_VERSION_SPNEGO    (1<<8)  /* SPNEGO auth */
2233 #define CURL_VERSION_LARGEFILE (1<<9)  /* supports files bigger than 2GB */
2234 #define CURL_VERSION_IDN       (1<<10) /* International Domain Names support */
2235 #define CURL_VERSION_SSPI      (1<<11) /* SSPI is supported */
2236 #define CURL_VERSION_CONV      (1<<12) /* character conversions supported */
2237 #define CURL_VERSION_CURLDEBUG (1<<13) /* debug memory tracking supported */
2238 #define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */
2239 #define CURL_VERSION_NTLM_WB   (1<<15) /* NTLM delegating to winbind helper */
2240 #define CURL_VERSION_HTTP2     (1<<16) /* HTTP2 support built-in */
2241
2242  /*
2243  * NAME curl_version_info()
2244  *
2245  * DESCRIPTION
2246  *
2247  * This function returns a pointer to a static copy of the version info
2248  * struct. See above.
2249  */
2250 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion);
2251
2252 /*
2253  * NAME curl_easy_strerror()
2254  *
2255  * DESCRIPTION
2256  *
2257  * The curl_easy_strerror function may be used to turn a CURLcode value
2258  * into the equivalent human readable error string.  This is useful
2259  * for printing meaningful error messages.
2260  */
2261 CURL_EXTERN const char *curl_easy_strerror(CURLcode);
2262
2263 /*
2264  * NAME curl_share_strerror()
2265  *
2266  * DESCRIPTION
2267  *
2268  * The curl_share_strerror function may be used to turn a CURLSHcode value
2269  * into the equivalent human readable error string.  This is useful
2270  * for printing meaningful error messages.
2271  */
2272 CURL_EXTERN const char *curl_share_strerror(CURLSHcode);
2273
2274 /*
2275  * NAME curl_easy_pause()
2276  *
2277  * DESCRIPTION
2278  *
2279  * The curl_easy_pause function pauses or unpauses transfers. Select the new
2280  * state by setting the bitmask, use the convenience defines below.
2281  *
2282  */
2283 CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask);
2284
2285 #define CURLPAUSE_RECV      (1<<0)
2286 #define CURLPAUSE_RECV_CONT (0)
2287
2288 #define CURLPAUSE_SEND      (1<<2)
2289 #define CURLPAUSE_SEND_CONT (0)
2290
2291 #define CURLPAUSE_ALL       (CURLPAUSE_RECV|CURLPAUSE_SEND)
2292 #define CURLPAUSE_CONT      (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT)
2293
2294 #ifdef  __cplusplus
2295 }
2296 #endif
2297
2298 /* unfortunately, the easy.h and multi.h include files need options and info
2299   stuff before they can be included! */
2300 #include "easy.h" /* nothing in curl is fun without the easy stuff */
2301 #include "multi.h"
2302
2303 /* the typechecker doesn't work in C++ (yet) */
2304 #if defined(__GNUC__) && defined(__GNUC_MINOR__) && \
2305     ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \
2306     !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK)
2307 #include "typecheck-gcc.h"
2308 #else
2309 #if defined(__STDC__) && (__STDC__ >= 1)
2310 /* This preprocessor magic that replaces a call with the exact same call is
2311    only done to make sure application authors pass exactly three arguments
2312    to these functions. */
2313 #define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param)
2314 #define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg)
2315 #define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param)
2316 #define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param)
2317 #endif /* __STDC__ >= 1 */
2318 #endif /* gcc >= 4.3 && !__cplusplus */
2319
2320 #endif /* __CURL_CURL_H */