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