1 #ifndef CURLINC_CURL_H 2 #define CURLINC_CURL_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2020, 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 "system.h" /* determine things run-time */ 39 40 /* 41 * Define CURL_WIN32 when build target is Win32 API 42 */ 43 44 #if (defined(_WIN32) || defined(__WIN32__) || defined(WIN32)) && \ 45 !defined(__SYMBIAN32__) 46 #define CURL_WIN32 47 #endif 48 49 #include <stdio.h> 50 #include <limits.h> 51 52 #if defined(__FreeBSD__) && (__FreeBSD__ >= 2) 53 /* Needed for __FreeBSD_version symbol definition */ 54 #include <osreldate.h> 55 #endif 56 57 /* The include stuff here below is mainly for time_t! */ 58 #include <sys/types.h> 59 #include <time.h> 60 61 #if defined(CURL_WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__) 62 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || \ 63 defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H)) 64 /* The check above prevents the winsock2 inclusion if winsock.h already was 65 included, since they can't co-exist without problems */ 66 #include <winsock2.h> 67 #include <ws2tcpip.h> 68 #endif 69 #endif 70 71 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish 72 libc5-based Linux systems. Only include it on systems that are known to 73 require it! */ 74 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \ 75 defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \ 76 defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \ 77 defined(__CYGWIN__) || \ 78 (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) 79 #include <sys/select.h> 80 #endif 81 82 #if !defined(CURL_WIN32) && !defined(_WIN32_WCE) 83 #include <sys/socket.h> 84 #endif 85 86 #if !defined(CURL_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 /* Compatibility for non-Clang compilers */ 95 #ifndef __has_declspec_attribute 96 # define __has_declspec_attribute(x) 0 97 #endif 98 99 #ifdef __cplusplus 100 extern "C" { 101 #endif 102 103 #if defined(BUILDING_LIBCURL) || defined(CURL_STRICTER) 104 typedef struct Curl_easy CURL; 105 typedef struct Curl_share CURLSH; 106 #else 107 typedef void CURL; 108 typedef void CURLSH; 109 #endif 110 111 /* 112 * libcurl external API function linkage decorations. 113 */ 114 115 #ifdef CURL_STATICLIB 116 # define CURL_EXTERN 117 #elif defined(CURL_WIN32) || defined(__SYMBIAN32__) || \ 118 (__has_declspec_attribute(dllexport) && \ 119 __has_declspec_attribute(dllimport)) 120 # if defined(BUILDING_LIBCURL) 121 # define CURL_EXTERN __declspec(dllexport) 122 # else 123 # define CURL_EXTERN __declspec(dllimport) 124 # endif 125 #elif defined(BUILDING_LIBCURL) && defined(CURL_HIDDEN_SYMBOLS) 126 # define CURL_EXTERN CURL_EXTERN_SYMBOL 127 #else 128 # define CURL_EXTERN 129 #endif 130 131 #ifndef curl_socket_typedef 132 /* socket typedef */ 133 #if defined(CURL_WIN32) && !defined(__LWIP_OPT_H__) && !defined(LWIP_HDR_OPT_H) 134 typedef SOCKET curl_socket_t; 135 #define CURL_SOCKET_BAD INVALID_SOCKET 136 #else 137 typedef int curl_socket_t; 138 #define CURL_SOCKET_BAD -1 139 #endif 140 #define curl_socket_typedef 141 #endif /* curl_socket_typedef */ 142 143 /* enum for the different supported SSL backends */ 144 typedef enum { 145 CURLSSLBACKEND_NONE = 0, 146 CURLSSLBACKEND_OPENSSL = 1, 147 CURLSSLBACKEND_GNUTLS = 2, 148 CURLSSLBACKEND_NSS = 3, 149 CURLSSLBACKEND_OBSOLETE4 = 4, /* Was QSOSSL. */ 150 CURLSSLBACKEND_GSKIT = 5, 151 CURLSSLBACKEND_POLARSSL = 6, 152 CURLSSLBACKEND_WOLFSSL = 7, 153 CURLSSLBACKEND_SCHANNEL = 8, 154 CURLSSLBACKEND_SECURETRANSPORT = 9, 155 CURLSSLBACKEND_AXTLS = 10, /* never used since 7.63.0 */ 156 CURLSSLBACKEND_MBEDTLS = 11, 157 CURLSSLBACKEND_MESALINK = 12, 158 CURLSSLBACKEND_BEARSSL = 13 159 } curl_sslbackend; 160 161 /* aliases for library clones and renames */ 162 #define CURLSSLBACKEND_LIBRESSL CURLSSLBACKEND_OPENSSL 163 #define CURLSSLBACKEND_BORINGSSL CURLSSLBACKEND_OPENSSL 164 165 /* deprecated names: */ 166 #define CURLSSLBACKEND_CYASSL CURLSSLBACKEND_WOLFSSL 167 #define CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_SECURETRANSPORT 168 169 struct curl_httppost { 170 struct curl_httppost *next; /* next entry in the list */ 171 char *name; /* pointer to allocated name */ 172 long namelength; /* length of name length */ 173 char *contents; /* pointer to allocated data contents */ 174 long contentslength; /* length of contents field, see also 175 CURL_HTTPPOST_LARGE */ 176 char *buffer; /* pointer to allocated buffer contents */ 177 long bufferlength; /* length of buffer field */ 178 char *contenttype; /* Content-Type */ 179 struct curl_slist *contentheader; /* list of extra headers for this form */ 180 struct curl_httppost *more; /* if one field name has more than one 181 file, this link should link to following 182 files */ 183 long flags; /* as defined below */ 184 185 /* specified content is a file name */ 186 #define CURL_HTTPPOST_FILENAME (1<<0) 187 /* specified content is a file name */ 188 #define CURL_HTTPPOST_READFILE (1<<1) 189 /* name is only stored pointer do not free in formfree */ 190 #define CURL_HTTPPOST_PTRNAME (1<<2) 191 /* contents is only stored pointer do not free in formfree */ 192 #define CURL_HTTPPOST_PTRCONTENTS (1<<3) 193 /* upload file from buffer */ 194 #define CURL_HTTPPOST_BUFFER (1<<4) 195 /* upload file from pointer contents */ 196 #define CURL_HTTPPOST_PTRBUFFER (1<<5) 197 /* upload file contents by using the regular read callback to get the data and 198 pass the given pointer as custom pointer */ 199 #define CURL_HTTPPOST_CALLBACK (1<<6) 200 /* use size in 'contentlen', added in 7.46.0 */ 201 #define CURL_HTTPPOST_LARGE (1<<7) 202 203 char *showfilename; /* The file name to show. If not set, the 204 actual file name will be used (if this 205 is a file part) */ 206 void *userp; /* custom pointer used for 207 HTTPPOST_CALLBACK posts */ 208 curl_off_t contentlen; /* alternative length of contents 209 field. Used if CURL_HTTPPOST_LARGE is 210 set. Added in 7.46.0 */ 211 }; 212 213 214 /* This is a return code for the progress callback that, when returned, will 215 signal libcurl to continue executing the default progress function */ 216 #define CURL_PROGRESSFUNC_CONTINUE 0x10000001 217 218 /* This is the CURLOPT_PROGRESSFUNCTION callback prototype. It is now 219 considered deprecated but was the only choice up until 7.31.0 */ 220 typedef int (*curl_progress_callback)(void *clientp, 221 double dltotal, 222 double dlnow, 223 double ultotal, 224 double ulnow); 225 226 /* This is the CURLOPT_XFERINFOFUNCTION callback prototype. It was introduced 227 in 7.32.0, avoids the use of floating point numbers and provides more 228 detailed information. */ 229 typedef int (*curl_xferinfo_callback)(void *clientp, 230 curl_off_t dltotal, 231 curl_off_t dlnow, 232 curl_off_t ultotal, 233 curl_off_t ulnow); 234 235 #ifndef CURL_MAX_READ_SIZE 236 /* The maximum receive buffer size configurable via CURLOPT_BUFFERSIZE. */ 237 #define CURL_MAX_READ_SIZE 524288 238 #endif 239 240 #ifndef CURL_MAX_WRITE_SIZE 241 /* Tests have proven that 20K is a very bad buffer size for uploads on 242 Windows, while 16K for some odd reason performed a lot better. 243 We do the ifndef check to allow this value to easier be changed at build 244 time for those who feel adventurous. The practical minimum is about 245 400 bytes since libcurl uses a buffer of this size as a scratch area 246 (unrelated to network send operations). */ 247 #define CURL_MAX_WRITE_SIZE 16384 248 #endif 249 250 #ifndef CURL_MAX_HTTP_HEADER 251 /* The only reason to have a max limit for this is to avoid the risk of a bad 252 server feeding libcurl with a never-ending header that will cause reallocs 253 infinitely */ 254 #define CURL_MAX_HTTP_HEADER (100*1024) 255 #endif 256 257 /* This is a magic return code for the write callback that, when returned, 258 will signal libcurl to pause receiving on the current transfer. */ 259 #define CURL_WRITEFUNC_PAUSE 0x10000001 260 261 typedef size_t (*curl_write_callback)(char *buffer, 262 size_t size, 263 size_t nitems, 264 void *outstream); 265 266 /* This callback will be called when a new resolver request is made */ 267 typedef int (*curl_resolver_start_callback)(void *resolver_state, 268 void *reserved, void *userdata); 269 270 /* enumeration of file types */ 271 typedef enum { 272 CURLFILETYPE_FILE = 0, 273 CURLFILETYPE_DIRECTORY, 274 CURLFILETYPE_SYMLINK, 275 CURLFILETYPE_DEVICE_BLOCK, 276 CURLFILETYPE_DEVICE_CHAR, 277 CURLFILETYPE_NAMEDPIPE, 278 CURLFILETYPE_SOCKET, 279 CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */ 280 281 CURLFILETYPE_UNKNOWN /* should never occur */ 282 } curlfiletype; 283 284 #define CURLFINFOFLAG_KNOWN_FILENAME (1<<0) 285 #define CURLFINFOFLAG_KNOWN_FILETYPE (1<<1) 286 #define CURLFINFOFLAG_KNOWN_TIME (1<<2) 287 #define CURLFINFOFLAG_KNOWN_PERM (1<<3) 288 #define CURLFINFOFLAG_KNOWN_UID (1<<4) 289 #define CURLFINFOFLAG_KNOWN_GID (1<<5) 290 #define CURLFINFOFLAG_KNOWN_SIZE (1<<6) 291 #define CURLFINFOFLAG_KNOWN_HLINKCOUNT (1<<7) 292 293 /* Information about a single file, used when doing FTP wildcard matching */ 294 struct curl_fileinfo { 295 char *filename; 296 curlfiletype filetype; 297 time_t time; /* always zero! */ 298 unsigned int perm; 299 int uid; 300 int gid; 301 curl_off_t size; 302 long int hardlinks; 303 304 struct { 305 /* If some of these fields is not NULL, it is a pointer to b_data. */ 306 char *time; 307 char *perm; 308 char *user; 309 char *group; 310 char *target; /* pointer to the target filename of a symlink */ 311 } strings; 312 313 unsigned int flags; 314 315 /* used internally */ 316 char *b_data; 317 size_t b_size; 318 size_t b_used; 319 }; 320 321 /* return codes for CURLOPT_CHUNK_BGN_FUNCTION */ 322 #define CURL_CHUNK_BGN_FUNC_OK 0 323 #define CURL_CHUNK_BGN_FUNC_FAIL 1 /* tell the lib to end the task */ 324 #define CURL_CHUNK_BGN_FUNC_SKIP 2 /* skip this chunk over */ 325 326 /* if splitting of data transfer is enabled, this callback is called before 327 download of an individual chunk started. Note that parameter "remains" works 328 only for FTP wildcard downloading (for now), otherwise is not used */ 329 typedef long (*curl_chunk_bgn_callback)(const void *transfer_info, 330 void *ptr, 331 int remains); 332 333 /* return codes for CURLOPT_CHUNK_END_FUNCTION */ 334 #define CURL_CHUNK_END_FUNC_OK 0 335 #define CURL_CHUNK_END_FUNC_FAIL 1 /* tell the lib to end the task */ 336 337 /* If splitting of data transfer is enabled this callback is called after 338 download of an individual chunk finished. 339 Note! After this callback was set then it have to be called FOR ALL chunks. 340 Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. 341 This is the reason why we don't need "transfer_info" parameter in this 342 callback and we are not interested in "remains" parameter too. */ 343 typedef long (*curl_chunk_end_callback)(void *ptr); 344 345 /* return codes for FNMATCHFUNCTION */ 346 #define CURL_FNMATCHFUNC_MATCH 0 /* string corresponds to the pattern */ 347 #define CURL_FNMATCHFUNC_NOMATCH 1 /* pattern doesn't match the string */ 348 #define CURL_FNMATCHFUNC_FAIL 2 /* an error occurred */ 349 350 /* callback type for wildcard downloading pattern matching. If the 351 string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */ 352 typedef int (*curl_fnmatch_callback)(void *ptr, 353 const char *pattern, 354 const char *string); 355 356 /* These are the return codes for the seek callbacks */ 357 #define CURL_SEEKFUNC_OK 0 358 #define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ 359 #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can't be done, so 360 libcurl might try other means instead */ 361 typedef int (*curl_seek_callback)(void *instream, 362 curl_off_t offset, 363 int origin); /* 'whence' */ 364 365 /* This is a return code for the read callback that, when returned, will 366 signal libcurl to immediately abort the current transfer. */ 367 #define CURL_READFUNC_ABORT 0x10000000 368 /* This is a return code for the read callback that, when returned, will 369 signal libcurl to pause sending data on the current transfer. */ 370 #define CURL_READFUNC_PAUSE 0x10000001 371 372 /* Return code for when the trailing headers' callback has terminated 373 without any errors*/ 374 #define CURL_TRAILERFUNC_OK 0 375 /* Return code for when was an error in the trailing header's list and we 376 want to abort the request */ 377 #define CURL_TRAILERFUNC_ABORT 1 378 379 typedef size_t (*curl_read_callback)(char *buffer, 380 size_t size, 381 size_t nitems, 382 void *instream); 383 384 typedef int (*curl_trailer_callback)(struct curl_slist **list, 385 void *userdata); 386 387 typedef enum { 388 CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ 389 CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */ 390 CURLSOCKTYPE_LAST /* never use */ 391 } curlsocktype; 392 393 /* The return code from the sockopt_callback can signal information back 394 to libcurl: */ 395 #define CURL_SOCKOPT_OK 0 396 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return 397 CURLE_ABORTED_BY_CALLBACK */ 398 #define CURL_SOCKOPT_ALREADY_CONNECTED 2 399 400 typedef int (*curl_sockopt_callback)(void *clientp, 401 curl_socket_t curlfd, 402 curlsocktype purpose); 403 404 struct curl_sockaddr { 405 int family; 406 int socktype; 407 int protocol; 408 unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it 409 turned really ugly and painful on the systems that 410 lack this type */ 411 struct sockaddr addr; 412 }; 413 414 typedef curl_socket_t 415 (*curl_opensocket_callback)(void *clientp, 416 curlsocktype purpose, 417 struct curl_sockaddr *address); 418 419 typedef int 420 (*curl_closesocket_callback)(void *clientp, curl_socket_t item); 421 422 typedef enum { 423 CURLIOE_OK, /* I/O operation successful */ 424 CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ 425 CURLIOE_FAILRESTART, /* failed to restart the read */ 426 CURLIOE_LAST /* never use */ 427 } curlioerr; 428 429 typedef enum { 430 CURLIOCMD_NOP, /* no operation */ 431 CURLIOCMD_RESTARTREAD, /* restart the read stream from start */ 432 CURLIOCMD_LAST /* never use */ 433 } curliocmd; 434 435 typedef curlioerr (*curl_ioctl_callback)(CURL *handle, 436 int cmd, 437 void *clientp); 438 439 #ifndef CURL_DID_MEMORY_FUNC_TYPEDEFS 440 /* 441 * The following typedef's are signatures of malloc, free, realloc, strdup and 442 * calloc respectively. Function pointers of these types can be passed to the 443 * curl_global_init_mem() function to set user defined memory management 444 * callback routines. 445 */ 446 typedef void *(*curl_malloc_callback)(size_t size); 447 typedef void (*curl_free_callback)(void *ptr); 448 typedef void *(*curl_realloc_callback)(void *ptr, size_t size); 449 typedef char *(*curl_strdup_callback)(const char *str); 450 typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size); 451 452 #define CURL_DID_MEMORY_FUNC_TYPEDEFS 453 #endif 454 455 /* the kind of data that is passed to information_callback*/ 456 typedef enum { 457 CURLINFO_TEXT = 0, 458 CURLINFO_HEADER_IN, /* 1 */ 459 CURLINFO_HEADER_OUT, /* 2 */ 460 CURLINFO_DATA_IN, /* 3 */ 461 CURLINFO_DATA_OUT, /* 4 */ 462 CURLINFO_SSL_DATA_IN, /* 5 */ 463 CURLINFO_SSL_DATA_OUT, /* 6 */ 464 CURLINFO_END 465 } curl_infotype; 466 467 typedef int (*curl_debug_callback) 468 (CURL *handle, /* the handle/transfer this concerns */ 469 curl_infotype type, /* what kind of data */ 470 char *data, /* points to the data */ 471 size_t size, /* size of the data pointed to */ 472 void *userptr); /* whatever the user please */ 473 474 /* All possible error codes from all sorts of curl functions. Future versions 475 may return other values, stay prepared. 476 477 Always add new return codes last. Never *EVER* remove any. The return 478 codes must remain the same! 479 */ 480 481 typedef enum { 482 CURLE_OK = 0, 483 CURLE_UNSUPPORTED_PROTOCOL, /* 1 */ 484 CURLE_FAILED_INIT, /* 2 */ 485 CURLE_URL_MALFORMAT, /* 3 */ 486 CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for 487 7.17.0, reused in April 2011 for 7.21.5] */ 488 CURLE_COULDNT_RESOLVE_PROXY, /* 5 */ 489 CURLE_COULDNT_RESOLVE_HOST, /* 6 */ 490 CURLE_COULDNT_CONNECT, /* 7 */ 491 CURLE_WEIRD_SERVER_REPLY, /* 8 */ 492 CURLE_REMOTE_ACCESS_DENIED, /* 9 a service was denied by the server 493 due to lack of access - when login fails 494 this is not returned. */ 495 CURLE_FTP_ACCEPT_FAILED, /* 10 - [was obsoleted in April 2006 for 496 7.15.4, reused in Dec 2011 for 7.24.0]*/ 497 CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */ 498 CURLE_FTP_ACCEPT_TIMEOUT, /* 12 - timeout occurred accepting server 499 [was obsoleted in August 2007 for 7.17.0, 500 reused in Dec 2011 for 7.24.0]*/ 501 CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */ 502 CURLE_FTP_WEIRD_227_FORMAT, /* 14 */ 503 CURLE_FTP_CANT_GET_HOST, /* 15 */ 504 CURLE_HTTP2, /* 16 - A problem in the http2 framing layer. 505 [was obsoleted in August 2007 for 7.17.0, 506 reused in July 2014 for 7.38.0] */ 507 CURLE_FTP_COULDNT_SET_TYPE, /* 17 */ 508 CURLE_PARTIAL_FILE, /* 18 */ 509 CURLE_FTP_COULDNT_RETR_FILE, /* 19 */ 510 CURLE_OBSOLETE20, /* 20 - NOT USED */ 511 CURLE_QUOTE_ERROR, /* 21 - quote command failure */ 512 CURLE_HTTP_RETURNED_ERROR, /* 22 */ 513 CURLE_WRITE_ERROR, /* 23 */ 514 CURLE_OBSOLETE24, /* 24 - NOT USED */ 515 CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */ 516 CURLE_READ_ERROR, /* 26 - couldn't open/read from file */ 517 CURLE_OUT_OF_MEMORY, /* 27 */ 518 /* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error 519 instead of a memory allocation error if CURL_DOES_CONVERSIONS 520 is defined 521 */ 522 CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */ 523 CURLE_OBSOLETE29, /* 29 - NOT USED */ 524 CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */ 525 CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */ 526 CURLE_OBSOLETE32, /* 32 - NOT USED */ 527 CURLE_RANGE_ERROR, /* 33 - RANGE "command" didn't work */ 528 CURLE_HTTP_POST_ERROR, /* 34 */ 529 CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */ 530 CURLE_BAD_DOWNLOAD_RESUME, /* 36 - couldn't resume download */ 531 CURLE_FILE_COULDNT_READ_FILE, /* 37 */ 532 CURLE_LDAP_CANNOT_BIND, /* 38 */ 533 CURLE_LDAP_SEARCH_FAILED, /* 39 */ 534 CURLE_OBSOLETE40, /* 40 - NOT USED */ 535 CURLE_FUNCTION_NOT_FOUND, /* 41 - NOT USED starting with 7.53.0 */ 536 CURLE_ABORTED_BY_CALLBACK, /* 42 */ 537 CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */ 538 CURLE_OBSOLETE44, /* 44 - NOT USED */ 539 CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */ 540 CURLE_OBSOLETE46, /* 46 - NOT USED */ 541 CURLE_TOO_MANY_REDIRECTS, /* 47 - catch endless re-direct loops */ 542 CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */ 543 CURLE_TELNET_OPTION_SYNTAX, /* 49 - Malformed telnet option */ 544 CURLE_OBSOLETE50, /* 50 - NOT USED */ 545 CURLE_OBSOLETE51, /* 51 - NOT USED */ 546 CURLE_GOT_NOTHING, /* 52 - when this is a specific error */ 547 CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */ 548 CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as 549 default */ 550 CURLE_SEND_ERROR, /* 55 - failed sending network data */ 551 CURLE_RECV_ERROR, /* 56 - failure in receiving network data */ 552 CURLE_OBSOLETE57, /* 57 - NOT IN USE */ 553 CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */ 554 CURLE_SSL_CIPHER, /* 59 - couldn't use specified cipher */ 555 CURLE_PEER_FAILED_VERIFICATION, /* 60 - peer's certificate or fingerprint 556 wasn't verified fine */ 557 CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */ 558 CURLE_LDAP_INVALID_URL, /* 62 - Invalid LDAP URL */ 559 CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */ 560 CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */ 561 CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind 562 that failed */ 563 CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */ 564 CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not 565 accepted and we failed to login */ 566 CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */ 567 CURLE_TFTP_PERM, /* 69 - permission problem on server */ 568 CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */ 569 CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */ 570 CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */ 571 CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */ 572 CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */ 573 CURLE_CONV_FAILED, /* 75 - conversion failed */ 574 CURLE_CONV_REQD, /* 76 - caller must register conversion 575 callbacks using curl_easy_setopt options 576 CURLOPT_CONV_FROM_NETWORK_FUNCTION, 577 CURLOPT_CONV_TO_NETWORK_FUNCTION, and 578 CURLOPT_CONV_FROM_UTF8_FUNCTION */ 579 CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing 580 or wrong format */ 581 CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */ 582 CURLE_SSH, /* 79 - error from the SSH layer, somewhat 583 generic so the error message will be of 584 interest when this has happened */ 585 586 CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL 587 connection */ 588 CURLE_AGAIN, /* 81 - socket is not ready for send/recv, 589 wait till it's ready and try again (Added 590 in 7.18.2) */ 591 CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or 592 wrong format (Added in 7.19.0) */ 593 CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in 594 7.19.0) */ 595 CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */ 596 CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */ 597 CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Ids */ 598 CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */ 599 CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */ 600 CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the 601 session will be queued */ 602 CURLE_SSL_PINNEDPUBKEYNOTMATCH, /* 90 - specified pinned public key did not 603 match */ 604 CURLE_SSL_INVALIDCERTSTATUS, /* 91 - invalid certificate status */ 605 CURLE_HTTP2_STREAM, /* 92 - stream error in HTTP/2 framing layer 606 */ 607 CURLE_RECURSIVE_API_CALL, /* 93 - an api function was called from 608 inside a callback */ 609 CURLE_AUTH_ERROR, /* 94 - an authentication function returned an 610 error */ 611 CURLE_HTTP3, /* 95 - An HTTP/3 layer problem */ 612 CURLE_QUIC_CONNECT_ERROR, /* 96 - QUIC connection error */ 613 CURLE_PROXY, /* 97 - proxy handshake error */ 614 CURL_LAST /* never use! */ 615 } CURLcode; 616 617 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 618 the obsolete stuff removed! */ 619 620 /* Previously obsolete error code re-used in 7.38.0 */ 621 #define CURLE_OBSOLETE16 CURLE_HTTP2 622 623 /* Previously obsolete error codes re-used in 7.24.0 */ 624 #define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED 625 #define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT 626 627 /* compatibility with older names */ 628 #define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING 629 #define CURLE_FTP_WEIRD_SERVER_REPLY CURLE_WEIRD_SERVER_REPLY 630 631 /* The following were added in 7.62.0 */ 632 #define CURLE_SSL_CACERT CURLE_PEER_FAILED_VERIFICATION 633 634 /* The following were added in 7.21.5, April 2011 */ 635 #define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION 636 637 /* The following were added in 7.17.1 */ 638 /* These are scheduled to disappear by 2009 */ 639 #define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION 640 641 /* The following were added in 7.17.0 */ 642 /* These are scheduled to disappear by 2009 */ 643 #define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */ 644 #define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46 645 #define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44 646 #define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10 647 #define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16 648 #define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32 649 #define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29 650 #define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12 651 #define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20 652 #define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40 653 #define CURLE_MALFORMAT_USER CURLE_OBSOLETE24 654 #define CURLE_SHARE_IN_USE CURLE_OBSOLETE57 655 #define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN 656 657 #define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED 658 #define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE 659 #define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR 660 #define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL 661 #define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS 662 #define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR 663 #define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED 664 665 /* The following were added earlier */ 666 667 #define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT 668 669 #define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR 670 #define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED 671 #define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED 672 673 #define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE 674 #define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME 675 676 /* This was the error code 50 in 7.7.3 and a few earlier versions, this 677 is no longer used by libcurl but is instead #defined here only to not 678 make programs break */ 679 #define CURLE_ALREADY_COMPLETE 99999 680 681 /* Provide defines for really old option names */ 682 #define CURLOPT_FILE CURLOPT_WRITEDATA /* name changed in 7.9.7 */ 683 #define CURLOPT_INFILE CURLOPT_READDATA /* name changed in 7.9.7 */ 684 #define CURLOPT_WRITEHEADER CURLOPT_HEADERDATA 685 686 /* Since long deprecated options with no code in the lib that does anything 687 with them. */ 688 #define CURLOPT_WRITEINFO CURLOPT_OBSOLETE40 689 #define CURLOPT_CLOSEPOLICY CURLOPT_OBSOLETE72 690 691 #endif /*!CURL_NO_OLDIES*/ 692 693 /* 694 * Proxy error codes. Returned in CURLINFO_PROXY_ERROR if CURLE_PROXY was 695 * return for the transfers. 696 */ 697 typedef enum { 698 CURLPX_OK, 699 CURLPX_BAD_ADDRESS_TYPE, 700 CURLPX_BAD_VERSION, 701 CURLPX_CLOSED, 702 CURLPX_GSSAPI, 703 CURLPX_GSSAPI_PERMSG, 704 CURLPX_GSSAPI_PROTECTION, 705 CURLPX_IDENTD, 706 CURLPX_IDENTD_DIFFER, 707 CURLPX_LONG_HOSTNAME, 708 CURLPX_LONG_PASSWD, 709 CURLPX_LONG_USER, 710 CURLPX_NO_AUTH, 711 CURLPX_RECV_ADDRESS, 712 CURLPX_RECV_AUTH, 713 CURLPX_RECV_CONNECT, 714 CURLPX_RECV_REQACK, 715 CURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED, 716 CURLPX_REPLY_COMMAND_NOT_SUPPORTED, 717 CURLPX_REPLY_CONNECTION_REFUSED, 718 CURLPX_REPLY_GENERAL_SERVER_FAILURE, 719 CURLPX_REPLY_HOST_UNREACHABLE, 720 CURLPX_REPLY_NETWORK_UNREACHABLE, 721 CURLPX_REPLY_NOT_ALLOWED, 722 CURLPX_REPLY_TTL_EXPIRED, 723 CURLPX_REPLY_UNASSIGNED, 724 CURLPX_REQUEST_FAILED, 725 CURLPX_RESOLVE_HOST, 726 CURLPX_SEND_AUTH, 727 CURLPX_SEND_CONNECT, 728 CURLPX_SEND_REQUEST, 729 CURLPX_UNKNOWN_FAIL, 730 CURLPX_UNKNOWN_MODE, 731 CURLPX_USER_REJECTED, 732 CURLPX_LAST /* never use */ 733 } CURLproxycode; 734 735 /* This prototype applies to all conversion callbacks */ 736 typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length); 737 738 typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl, /* easy handle */ 739 void *ssl_ctx, /* actually an OpenSSL 740 or WolfSSL SSL_CTX, 741 or an mbedTLS 742 mbedtls_ssl_config */ 743 void *userptr); 744 745 typedef enum { 746 CURLPROXY_HTTP = 0, /* added in 7.10, new in 7.19.4 default is to use 747 CONNECT HTTP/1.1 */ 748 CURLPROXY_HTTP_1_0 = 1, /* added in 7.19.4, force to use CONNECT 749 HTTP/1.0 */ 750 CURLPROXY_HTTPS = 2, /* added in 7.52.0 */ 751 CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already 752 in 7.10 */ 753 CURLPROXY_SOCKS5 = 5, /* added in 7.10 */ 754 CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */ 755 CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the 756 host name rather than the IP address. added 757 in 7.18.0 */ 758 } curl_proxytype; /* this enum was added in 7.10 */ 759 760 /* 761 * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options: 762 * 763 * CURLAUTH_NONE - No HTTP authentication 764 * CURLAUTH_BASIC - HTTP Basic authentication (default) 765 * CURLAUTH_DIGEST - HTTP Digest authentication 766 * CURLAUTH_NEGOTIATE - HTTP Negotiate (SPNEGO) authentication 767 * CURLAUTH_GSSNEGOTIATE - Alias for CURLAUTH_NEGOTIATE (deprecated) 768 * CURLAUTH_NTLM - HTTP NTLM authentication 769 * CURLAUTH_DIGEST_IE - HTTP Digest authentication with IE flavour 770 * CURLAUTH_NTLM_WB - HTTP NTLM authentication delegated to winbind helper 771 * CURLAUTH_BEARER - HTTP Bearer token authentication 772 * CURLAUTH_ONLY - Use together with a single other type to force no 773 * authentication or just that single type 774 * CURLAUTH_ANY - All fine types set 775 * CURLAUTH_ANYSAFE - All fine types except Basic 776 */ 777 778 #define CURLAUTH_NONE ((unsigned long)0) 779 #define CURLAUTH_BASIC (((unsigned long)1)<<0) 780 #define CURLAUTH_DIGEST (((unsigned long)1)<<1) 781 #define CURLAUTH_NEGOTIATE (((unsigned long)1)<<2) 782 /* Deprecated since the advent of CURLAUTH_NEGOTIATE */ 783 #define CURLAUTH_GSSNEGOTIATE CURLAUTH_NEGOTIATE 784 /* Used for CURLOPT_SOCKS5_AUTH to stay terminologically correct */ 785 #define CURLAUTH_GSSAPI CURLAUTH_NEGOTIATE 786 #define CURLAUTH_NTLM (((unsigned long)1)<<3) 787 #define CURLAUTH_DIGEST_IE (((unsigned long)1)<<4) 788 #define CURLAUTH_NTLM_WB (((unsigned long)1)<<5) 789 #define CURLAUTH_BEARER (((unsigned long)1)<<6) 790 #define CURLAUTH_ONLY (((unsigned long)1)<<31) 791 #define CURLAUTH_ANY (~CURLAUTH_DIGEST_IE) 792 #define CURLAUTH_ANYSAFE (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE)) 793 794 #define CURLSSH_AUTH_ANY ~0 /* all types supported by the server */ 795 #define CURLSSH_AUTH_NONE 0 /* none allowed, silly but complete */ 796 #define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */ 797 #define CURLSSH_AUTH_PASSWORD (1<<1) /* password */ 798 #define CURLSSH_AUTH_HOST (1<<2) /* host key files */ 799 #define CURLSSH_AUTH_KEYBOARD (1<<3) /* keyboard interactive */ 800 #define CURLSSH_AUTH_AGENT (1<<4) /* agent (ssh-agent, pageant...) */ 801 #define CURLSSH_AUTH_GSSAPI (1<<5) /* gssapi (kerberos, ...) */ 802 #define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY 803 804 #define CURLGSSAPI_DELEGATION_NONE 0 /* no delegation (default) */ 805 #define CURLGSSAPI_DELEGATION_POLICY_FLAG (1<<0) /* if permitted by policy */ 806 #define CURLGSSAPI_DELEGATION_FLAG (1<<1) /* delegate always */ 807 808 #define CURL_ERROR_SIZE 256 809 810 enum curl_khtype { 811 CURLKHTYPE_UNKNOWN, 812 CURLKHTYPE_RSA1, 813 CURLKHTYPE_RSA, 814 CURLKHTYPE_DSS, 815 CURLKHTYPE_ECDSA, 816 CURLKHTYPE_ED25519 817 }; 818 819 struct curl_khkey { 820 const char *key; /* points to a null-terminated string encoded with base64 821 if len is zero, otherwise to the "raw" data */ 822 size_t len; 823 enum curl_khtype keytype; 824 }; 825 826 /* this is the set of return values expected from the curl_sshkeycallback 827 callback */ 828 enum curl_khstat { 829 CURLKHSTAT_FINE_ADD_TO_FILE, 830 CURLKHSTAT_FINE, 831 CURLKHSTAT_REJECT, /* reject the connection, return an error */ 832 CURLKHSTAT_DEFER, /* do not accept it, but we can't answer right now so 833 this causes a CURLE_DEFER error but otherwise the 834 connection will be left intact etc */ 835 CURLKHSTAT_FINE_REPLACE, /* accept and replace the wrong key*/ 836 CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */ 837 }; 838 839 /* this is the set of status codes pass in to the callback */ 840 enum curl_khmatch { 841 CURLKHMATCH_OK, /* match */ 842 CURLKHMATCH_MISMATCH, /* host found, key mismatch! */ 843 CURLKHMATCH_MISSING, /* no matching host/key found */ 844 CURLKHMATCH_LAST /* not for use, only a marker for last-in-list */ 845 }; 846 847 typedef int 848 (*curl_sshkeycallback) (CURL *easy, /* easy handle */ 849 const struct curl_khkey *knownkey, /* known */ 850 const struct curl_khkey *foundkey, /* found */ 851 enum curl_khmatch, /* libcurl's view on the keys */ 852 void *clientp); /* custom pointer passed from app */ 853 854 /* parameter for the CURLOPT_USE_SSL option */ 855 typedef enum { 856 CURLUSESSL_NONE, /* do not attempt to use SSL */ 857 CURLUSESSL_TRY, /* try using SSL, proceed anyway otherwise */ 858 CURLUSESSL_CONTROL, /* SSL for the control connection or fail */ 859 CURLUSESSL_ALL, /* SSL for all communication or fail */ 860 CURLUSESSL_LAST /* not an option, never use */ 861 } curl_usessl; 862 863 /* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */ 864 865 /* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the 866 name of improving interoperability with older servers. Some SSL libraries 867 have introduced work-arounds for this flaw but those work-arounds sometimes 868 make the SSL communication fail. To regain functionality with those broken 869 servers, a user can this way allow the vulnerability back. */ 870 #define CURLSSLOPT_ALLOW_BEAST (1<<0) 871 872 /* - NO_REVOKE tells libcurl to disable certificate revocation checks for those 873 SSL backends where such behavior is present. */ 874 #define CURLSSLOPT_NO_REVOKE (1<<1) 875 876 /* - NO_PARTIALCHAIN tells libcurl to *NOT* accept a partial certificate chain 877 if possible. The OpenSSL backend has this ability. */ 878 #define CURLSSLOPT_NO_PARTIALCHAIN (1<<2) 879 880 /* - REVOKE_BEST_EFFORT tells libcurl to ignore certificate revocation offline 881 checks and ignore missing revocation list for those SSL backends where such 882 behavior is present. */ 883 #define CURLSSLOPT_REVOKE_BEST_EFFORT (1<<3) 884 885 /* - CURLSSLOPT_NATIVE_CA tells libcurl to use standard certificate store of 886 operating system. Currently implemented under MS-Windows. */ 887 #define CURLSSLOPT_NATIVE_CA (1<<4) 888 889 /* The default connection attempt delay in milliseconds for happy eyeballs. 890 CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3 and happy-eyeballs-timeout-ms.d document 891 this value, keep them in sync. */ 892 #define CURL_HET_DEFAULT 200L 893 894 /* The default connection upkeep interval in milliseconds. */ 895 #define CURL_UPKEEP_INTERVAL_DEFAULT 60000L 896 897 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 898 the obsolete stuff removed! */ 899 900 /* Backwards compatibility with older names */ 901 /* These are scheduled to disappear by 2009 */ 902 903 #define CURLFTPSSL_NONE CURLUSESSL_NONE 904 #define CURLFTPSSL_TRY CURLUSESSL_TRY 905 #define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL 906 #define CURLFTPSSL_ALL CURLUSESSL_ALL 907 #define CURLFTPSSL_LAST CURLUSESSL_LAST 908 #define curl_ftpssl curl_usessl 909 #endif /*!CURL_NO_OLDIES*/ 910 911 /* parameter for the CURLOPT_FTP_SSL_CCC option */ 912 typedef enum { 913 CURLFTPSSL_CCC_NONE, /* do not send CCC */ 914 CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */ 915 CURLFTPSSL_CCC_ACTIVE, /* Initiate the shutdown */ 916 CURLFTPSSL_CCC_LAST /* not an option, never use */ 917 } curl_ftpccc; 918 919 /* parameter for the CURLOPT_FTPSSLAUTH option */ 920 typedef enum { 921 CURLFTPAUTH_DEFAULT, /* let libcurl decide */ 922 CURLFTPAUTH_SSL, /* use "AUTH SSL" */ 923 CURLFTPAUTH_TLS, /* use "AUTH TLS" */ 924 CURLFTPAUTH_LAST /* not an option, never use */ 925 } curl_ftpauth; 926 927 /* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */ 928 typedef enum { 929 CURLFTP_CREATE_DIR_NONE, /* do NOT create missing dirs! */ 930 CURLFTP_CREATE_DIR, /* (FTP/SFTP) if CWD fails, try MKD and then CWD 931 again if MKD succeeded, for SFTP this does 932 similar magic */ 933 CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD 934 again even if MKD failed! */ 935 CURLFTP_CREATE_DIR_LAST /* not an option, never use */ 936 } curl_ftpcreatedir; 937 938 /* parameter for the CURLOPT_FTP_FILEMETHOD option */ 939 typedef enum { 940 CURLFTPMETHOD_DEFAULT, /* let libcurl pick */ 941 CURLFTPMETHOD_MULTICWD, /* single CWD operation for each path part */ 942 CURLFTPMETHOD_NOCWD, /* no CWD at all */ 943 CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */ 944 CURLFTPMETHOD_LAST /* not an option, never use */ 945 } curl_ftpmethod; 946 947 /* bitmask defines for CURLOPT_HEADEROPT */ 948 #define CURLHEADER_UNIFIED 0 949 #define CURLHEADER_SEPARATE (1<<0) 950 951 /* CURLALTSVC_* are bits for the CURLOPT_ALTSVC_CTRL option */ 952 #define CURLALTSVC_IMMEDIATELY (1<<0) 953 954 #define CURLALTSVC_READONLYFILE (1<<2) 955 #define CURLALTSVC_H1 (1<<3) 956 #define CURLALTSVC_H2 (1<<4) 957 #define CURLALTSVC_H3 (1<<5) 958 959 /* CURLPROTO_ defines are for the CURLOPT_*PROTOCOLS options */ 960 #define CURLPROTO_HTTP (1<<0) 961 #define CURLPROTO_HTTPS (1<<1) 962 #define CURLPROTO_FTP (1<<2) 963 #define CURLPROTO_FTPS (1<<3) 964 #define CURLPROTO_SCP (1<<4) 965 #define CURLPROTO_SFTP (1<<5) 966 #define CURLPROTO_TELNET (1<<6) 967 #define CURLPROTO_LDAP (1<<7) 968 #define CURLPROTO_LDAPS (1<<8) 969 #define CURLPROTO_DICT (1<<9) 970 #define CURLPROTO_FILE (1<<10) 971 #define CURLPROTO_TFTP (1<<11) 972 #define CURLPROTO_IMAP (1<<12) 973 #define CURLPROTO_IMAPS (1<<13) 974 #define CURLPROTO_POP3 (1<<14) 975 #define CURLPROTO_POP3S (1<<15) 976 #define CURLPROTO_SMTP (1<<16) 977 #define CURLPROTO_SMTPS (1<<17) 978 #define CURLPROTO_RTSP (1<<18) 979 #define CURLPROTO_RTMP (1<<19) 980 #define CURLPROTO_RTMPT (1<<20) 981 #define CURLPROTO_RTMPE (1<<21) 982 #define CURLPROTO_RTMPTE (1<<22) 983 #define CURLPROTO_RTMPS (1<<23) 984 #define CURLPROTO_RTMPTS (1<<24) 985 #define CURLPROTO_GOPHER (1<<25) 986 #define CURLPROTO_SMB (1<<26) 987 #define CURLPROTO_SMBS (1<<27) 988 #define CURLPROTO_MQTT (1<<28) 989 #define CURLPROTO_ALL (~0) /* enable everything */ 990 991 /* long may be 32 or 64 bits, but we should never depend on anything else 992 but 32 */ 993 #define CURLOPTTYPE_LONG 0 994 #define CURLOPTTYPE_OBJECTPOINT 10000 995 #define CURLOPTTYPE_FUNCTIONPOINT 20000 996 #define CURLOPTTYPE_OFF_T 30000 997 #define CURLOPTTYPE_BLOB 40000 998 999 /* *STRINGPOINT is an alias for OBJECTPOINT to allow tools to extract the 1000 string options from the header file */ 1001 1002 1003 #define CURLOPT(na,t,nu) na = t + nu 1004 1005 /* CURLOPT aliases that make no run-time difference */ 1006 1007 /* 'char *' argument to a string with a trailing zero */ 1008 #define CURLOPTTYPE_STRINGPOINT CURLOPTTYPE_OBJECTPOINT 1009 1010 /* 'struct curl_slist *' argument */ 1011 #define CURLOPTTYPE_SLISTPOINT CURLOPTTYPE_OBJECTPOINT 1012 1013 /* 'void *' argument passed untouched to callback */ 1014 #define CURLOPTTYPE_CBPOINT CURLOPTTYPE_OBJECTPOINT 1015 1016 /* 'long' argument with a set of values/bitmask */ 1017 #define CURLOPTTYPE_VALUES CURLOPTTYPE_LONG 1018 1019 /* 1020 * All CURLOPT_* values. 1021 */ 1022 1023 typedef enum { 1024 /* This is the FILE * or void * the regular output should be written to. */ 1025 CURLOPT(CURLOPT_WRITEDATA, CURLOPTTYPE_CBPOINT, 1), 1026 1027 /* The full URL to get/put */ 1028 CURLOPT(CURLOPT_URL, CURLOPTTYPE_STRINGPOINT, 2), 1029 1030 /* Port number to connect to, if other than default. */ 1031 CURLOPT(CURLOPT_PORT, CURLOPTTYPE_LONG, 3), 1032 1033 /* Name of proxy to use. */ 1034 CURLOPT(CURLOPT_PROXY, CURLOPTTYPE_STRINGPOINT, 4), 1035 1036 /* "user:password;options" to use when fetching. */ 1037 CURLOPT(CURLOPT_USERPWD, CURLOPTTYPE_STRINGPOINT, 5), 1038 1039 /* "user:password" to use with proxy. */ 1040 CURLOPT(CURLOPT_PROXYUSERPWD, CURLOPTTYPE_STRINGPOINT, 6), 1041 1042 /* Range to get, specified as an ASCII string. */ 1043 CURLOPT(CURLOPT_RANGE, CURLOPTTYPE_STRINGPOINT, 7), 1044 1045 /* not used */ 1046 1047 /* Specified file stream to upload from (use as input): */ 1048 CURLOPT(CURLOPT_READDATA, CURLOPTTYPE_CBPOINT, 9), 1049 1050 /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE 1051 * bytes big. */ 1052 CURLOPT(CURLOPT_ERRORBUFFER, CURLOPTTYPE_OBJECTPOINT, 10), 1053 1054 /* Function that will be called to store the output (instead of fwrite). The 1055 * parameters will use fwrite() syntax, make sure to follow them. */ 1056 CURLOPT(CURLOPT_WRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 11), 1057 1058 /* Function that will be called to read the input (instead of fread). The 1059 * parameters will use fread() syntax, make sure to follow them. */ 1060 CURLOPT(CURLOPT_READFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 12), 1061 1062 /* Time-out the read operation after this amount of seconds */ 1063 CURLOPT(CURLOPT_TIMEOUT, CURLOPTTYPE_LONG, 13), 1064 1065 /* If the CURLOPT_INFILE is used, this can be used to inform libcurl about 1066 * how large the file being sent really is. That allows better error 1067 * checking and better verifies that the upload was successful. -1 means 1068 * unknown size. 1069 * 1070 * For large file support, there is also a _LARGE version of the key 1071 * which takes an off_t type, allowing platforms with larger off_t 1072 * sizes to handle larger files. See below for INFILESIZE_LARGE. 1073 */ 1074 CURLOPT(CURLOPT_INFILESIZE, CURLOPTTYPE_LONG, 14), 1075 1076 /* POST static input fields. */ 1077 CURLOPT(CURLOPT_POSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 15), 1078 1079 /* Set the referrer page (needed by some CGIs) */ 1080 CURLOPT(CURLOPT_REFERER, CURLOPTTYPE_STRINGPOINT, 16), 1081 1082 /* Set the FTP PORT string (interface name, named or numerical IP address) 1083 Use i.e '-' to use default address. */ 1084 CURLOPT(CURLOPT_FTPPORT, CURLOPTTYPE_STRINGPOINT, 17), 1085 1086 /* Set the User-Agent string (examined by some CGIs) */ 1087 CURLOPT(CURLOPT_USERAGENT, CURLOPTTYPE_STRINGPOINT, 18), 1088 1089 /* If the download receives less than "low speed limit" bytes/second 1090 * during "low speed time" seconds, the operations is aborted. 1091 * You could i.e if you have a pretty high speed connection, abort if 1092 * it is less than 2000 bytes/sec during 20 seconds. 1093 */ 1094 1095 /* Set the "low speed limit" */ 1096 CURLOPT(CURLOPT_LOW_SPEED_LIMIT, CURLOPTTYPE_LONG, 19), 1097 1098 /* Set the "low speed time" */ 1099 CURLOPT(CURLOPT_LOW_SPEED_TIME, CURLOPTTYPE_LONG, 20), 1100 1101 /* Set the continuation offset. 1102 * 1103 * Note there is also a _LARGE version of this key which uses 1104 * off_t types, allowing for large file offsets on platforms which 1105 * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. 1106 */ 1107 CURLOPT(CURLOPT_RESUME_FROM, CURLOPTTYPE_LONG, 21), 1108 1109 /* Set cookie in request: */ 1110 CURLOPT(CURLOPT_COOKIE, CURLOPTTYPE_STRINGPOINT, 22), 1111 1112 /* This points to a linked list of headers, struct curl_slist kind. This 1113 list is also used for RTSP (in spite of its name) */ 1114 CURLOPT(CURLOPT_HTTPHEADER, CURLOPTTYPE_SLISTPOINT, 23), 1115 1116 /* This points to a linked list of post entries, struct curl_httppost */ 1117 CURLOPT(CURLOPT_HTTPPOST, CURLOPTTYPE_OBJECTPOINT, 24), 1118 1119 /* name of the file keeping your private SSL-certificate */ 1120 CURLOPT(CURLOPT_SSLCERT, CURLOPTTYPE_STRINGPOINT, 25), 1121 1122 /* password for the SSL or SSH private key */ 1123 CURLOPT(CURLOPT_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 26), 1124 1125 /* send TYPE parameter? */ 1126 CURLOPT(CURLOPT_CRLF, CURLOPTTYPE_LONG, 27), 1127 1128 /* send linked-list of QUOTE commands */ 1129 CURLOPT(CURLOPT_QUOTE, CURLOPTTYPE_SLISTPOINT, 28), 1130 1131 /* send FILE * or void * to store headers to, if you use a callback it 1132 is simply passed to the callback unmodified */ 1133 CURLOPT(CURLOPT_HEADERDATA, CURLOPTTYPE_CBPOINT, 29), 1134 1135 /* point to a file to read the initial cookies from, also enables 1136 "cookie awareness" */ 1137 CURLOPT(CURLOPT_COOKIEFILE, CURLOPTTYPE_STRINGPOINT, 31), 1138 1139 /* What version to specifically try to use. 1140 See CURL_SSLVERSION defines below. */ 1141 CURLOPT(CURLOPT_SSLVERSION, CURLOPTTYPE_VALUES, 32), 1142 1143 /* What kind of HTTP time condition to use, see defines */ 1144 CURLOPT(CURLOPT_TIMECONDITION, CURLOPTTYPE_VALUES, 33), 1145 1146 /* Time to use with the above condition. Specified in number of seconds 1147 since 1 Jan 1970 */ 1148 CURLOPT(CURLOPT_TIMEVALUE, CURLOPTTYPE_LONG, 34), 1149 1150 /* 35 = OBSOLETE */ 1151 1152 /* Custom request, for customizing the get command like 1153 HTTP: DELETE, TRACE and others 1154 FTP: to use a different list command 1155 */ 1156 CURLOPT(CURLOPT_CUSTOMREQUEST, CURLOPTTYPE_STRINGPOINT, 36), 1157 1158 /* FILE handle to use instead of stderr */ 1159 CURLOPT(CURLOPT_STDERR, CURLOPTTYPE_OBJECTPOINT, 37), 1160 1161 /* 38 is not used */ 1162 1163 /* send linked-list of post-transfer QUOTE commands */ 1164 CURLOPT(CURLOPT_POSTQUOTE, CURLOPTTYPE_SLISTPOINT, 39), 1165 1166 /* OBSOLETE, do not use! */ 1167 CURLOPT(CURLOPT_OBSOLETE40, CURLOPTTYPE_OBJECTPOINT, 40), 1168 1169 /* talk a lot */ 1170 CURLOPT(CURLOPT_VERBOSE, CURLOPTTYPE_LONG, 41), 1171 1172 /* throw the header out too */ 1173 CURLOPT(CURLOPT_HEADER, CURLOPTTYPE_LONG, 42), 1174 1175 /* shut off the progress meter */ 1176 CURLOPT(CURLOPT_NOPROGRESS, CURLOPTTYPE_LONG, 43), 1177 1178 /* use HEAD to get http document */ 1179 CURLOPT(CURLOPT_NOBODY, CURLOPTTYPE_LONG, 44), 1180 1181 /* no output on http error codes >= 400 */ 1182 CURLOPT(CURLOPT_FAILONERROR, CURLOPTTYPE_LONG, 45), 1183 1184 /* this is an upload */ 1185 CURLOPT(CURLOPT_UPLOAD, CURLOPTTYPE_LONG, 46), 1186 1187 /* HTTP POST method */ 1188 CURLOPT(CURLOPT_POST, CURLOPTTYPE_LONG, 47), 1189 1190 /* bare names when listing directories */ 1191 CURLOPT(CURLOPT_DIRLISTONLY, CURLOPTTYPE_LONG, 48), 1192 1193 /* Append instead of overwrite on upload! */ 1194 CURLOPT(CURLOPT_APPEND, CURLOPTTYPE_LONG, 50), 1195 1196 /* Specify whether to read the user+password from the .netrc or the URL. 1197 * This must be one of the CURL_NETRC_* enums below. */ 1198 CURLOPT(CURLOPT_NETRC, CURLOPTTYPE_VALUES, 51), 1199 1200 /* use Location: Luke! */ 1201 CURLOPT(CURLOPT_FOLLOWLOCATION, CURLOPTTYPE_LONG, 52), 1202 1203 /* transfer data in text/ASCII format */ 1204 CURLOPT(CURLOPT_TRANSFERTEXT, CURLOPTTYPE_LONG, 53), 1205 1206 /* HTTP PUT */ 1207 CURLOPT(CURLOPT_PUT, CURLOPTTYPE_LONG, 54), 1208 1209 /* 55 = OBSOLETE */ 1210 1211 /* DEPRECATED 1212 * Function that will be called instead of the internal progress display 1213 * function. This function should be defined as the curl_progress_callback 1214 * prototype defines. */ 1215 CURLOPT(CURLOPT_PROGRESSFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 56), 1216 1217 /* Data passed to the CURLOPT_PROGRESSFUNCTION and CURLOPT_XFERINFOFUNCTION 1218 callbacks */ 1219 CURLOPT(CURLOPT_XFERINFODATA, CURLOPTTYPE_CBPOINT, 57), 1220 #define CURLOPT_PROGRESSDATA CURLOPT_XFERINFODATA 1221 1222 /* We want the referrer field set automatically when following locations */ 1223 CURLOPT(CURLOPT_AUTOREFERER, CURLOPTTYPE_LONG, 58), 1224 1225 /* Port of the proxy, can be set in the proxy string as well with: 1226 "[host]:[port]" */ 1227 CURLOPT(CURLOPT_PROXYPORT, CURLOPTTYPE_LONG, 59), 1228 1229 /* size of the POST input data, if strlen() is not good to use */ 1230 CURLOPT(CURLOPT_POSTFIELDSIZE, CURLOPTTYPE_LONG, 60), 1231 1232 /* tunnel non-http operations through a HTTP proxy */ 1233 CURLOPT(CURLOPT_HTTPPROXYTUNNEL, CURLOPTTYPE_LONG, 61), 1234 1235 /* Set the interface string to use as outgoing network interface */ 1236 CURLOPT(CURLOPT_INTERFACE, CURLOPTTYPE_STRINGPOINT, 62), 1237 1238 /* Set the krb4/5 security level, this also enables krb4/5 awareness. This 1239 * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string 1240 * is set but doesn't match one of these, 'private' will be used. */ 1241 CURLOPT(CURLOPT_KRBLEVEL, CURLOPTTYPE_STRINGPOINT, 63), 1242 1243 /* Set if we should verify the peer in ssl handshake, set 1 to verify. */ 1244 CURLOPT(CURLOPT_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 64), 1245 1246 /* The CApath or CAfile used to validate the peer certificate 1247 this option is used only if SSL_VERIFYPEER is true */ 1248 CURLOPT(CURLOPT_CAINFO, CURLOPTTYPE_STRINGPOINT, 65), 1249 1250 /* 66 = OBSOLETE */ 1251 /* 67 = OBSOLETE */ 1252 1253 /* Maximum number of http redirects to follow */ 1254 CURLOPT(CURLOPT_MAXREDIRS, CURLOPTTYPE_LONG, 68), 1255 1256 /* Pass a long set to 1 to get the date of the requested document (if 1257 possible)! Pass a zero to shut it off. */ 1258 CURLOPT(CURLOPT_FILETIME, CURLOPTTYPE_LONG, 69), 1259 1260 /* This points to a linked list of telnet options */ 1261 CURLOPT(CURLOPT_TELNETOPTIONS, CURLOPTTYPE_SLISTPOINT, 70), 1262 1263 /* Max amount of cached alive connections */ 1264 CURLOPT(CURLOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 71), 1265 1266 /* OBSOLETE, do not use! */ 1267 CURLOPT(CURLOPT_OBSOLETE72, CURLOPTTYPE_LONG, 72), 1268 1269 /* 73 = OBSOLETE */ 1270 1271 /* Set to explicitly use a new connection for the upcoming transfer. 1272 Do not use this unless you're absolutely sure of this, as it makes the 1273 operation slower and is less friendly for the network. */ 1274 CURLOPT(CURLOPT_FRESH_CONNECT, CURLOPTTYPE_LONG, 74), 1275 1276 /* Set to explicitly forbid the upcoming transfer's connection to be re-used 1277 when done. Do not use this unless you're absolutely sure of this, as it 1278 makes the operation slower and is less friendly for the network. */ 1279 CURLOPT(CURLOPT_FORBID_REUSE, CURLOPTTYPE_LONG, 75), 1280 1281 /* Set to a file name that contains random data for libcurl to use to 1282 seed the random engine when doing SSL connects. */ 1283 CURLOPT(CURLOPT_RANDOM_FILE, CURLOPTTYPE_STRINGPOINT, 76), 1284 1285 /* Set to the Entropy Gathering Daemon socket pathname */ 1286 CURLOPT(CURLOPT_EGDSOCKET, CURLOPTTYPE_STRINGPOINT, 77), 1287 1288 /* Time-out connect operations after this amount of seconds, if connects are 1289 OK within this time, then fine... This only aborts the connect phase. */ 1290 CURLOPT(CURLOPT_CONNECTTIMEOUT, CURLOPTTYPE_LONG, 78), 1291 1292 /* Function that will be called to store headers (instead of fwrite). The 1293 * parameters will use fwrite() syntax, make sure to follow them. */ 1294 CURLOPT(CURLOPT_HEADERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 79), 1295 1296 /* Set this to force the HTTP request to get back to GET. Only really usable 1297 if POST, PUT or a custom request have been used first. 1298 */ 1299 CURLOPT(CURLOPT_HTTPGET, CURLOPTTYPE_LONG, 80), 1300 1301 /* Set if we should verify the Common name from the peer certificate in ssl 1302 * handshake, set 1 to check existence, 2 to ensure that it matches the 1303 * provided hostname. */ 1304 CURLOPT(CURLOPT_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 81), 1305 1306 /* Specify which file name to write all known cookies in after completed 1307 operation. Set file name to "-" (dash) to make it go to stdout. */ 1308 CURLOPT(CURLOPT_COOKIEJAR, CURLOPTTYPE_STRINGPOINT, 82), 1309 1310 /* Specify which SSL ciphers to use */ 1311 CURLOPT(CURLOPT_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 83), 1312 1313 /* Specify which HTTP version to use! This must be set to one of the 1314 CURL_HTTP_VERSION* enums set below. */ 1315 CURLOPT(CURLOPT_HTTP_VERSION, CURLOPTTYPE_VALUES, 84), 1316 1317 /* Specifically switch on or off the FTP engine's use of the EPSV command. By 1318 default, that one will always be attempted before the more traditional 1319 PASV command. */ 1320 CURLOPT(CURLOPT_FTP_USE_EPSV, CURLOPTTYPE_LONG, 85), 1321 1322 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */ 1323 CURLOPT(CURLOPT_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 86), 1324 1325 /* name of the file keeping your private SSL-key */ 1326 CURLOPT(CURLOPT_SSLKEY, CURLOPTTYPE_STRINGPOINT, 87), 1327 1328 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */ 1329 CURLOPT(CURLOPT_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 88), 1330 1331 /* crypto engine for the SSL-sub system */ 1332 CURLOPT(CURLOPT_SSLENGINE, CURLOPTTYPE_STRINGPOINT, 89), 1333 1334 /* set the crypto engine for the SSL-sub system as default 1335 the param has no meaning... 1336 */ 1337 CURLOPT(CURLOPT_SSLENGINE_DEFAULT, CURLOPTTYPE_LONG, 90), 1338 1339 /* Non-zero value means to use the global dns cache */ 1340 /* DEPRECATED, do not use! */ 1341 CURLOPT(CURLOPT_DNS_USE_GLOBAL_CACHE, CURLOPTTYPE_LONG, 91), 1342 1343 /* DNS cache timeout */ 1344 CURLOPT(CURLOPT_DNS_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 92), 1345 1346 /* send linked-list of pre-transfer QUOTE commands */ 1347 CURLOPT(CURLOPT_PREQUOTE, CURLOPTTYPE_SLISTPOINT, 93), 1348 1349 /* set the debug function */ 1350 CURLOPT(CURLOPT_DEBUGFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 94), 1351 1352 /* set the data for the debug function */ 1353 CURLOPT(CURLOPT_DEBUGDATA, CURLOPTTYPE_CBPOINT, 95), 1354 1355 /* mark this as start of a cookie session */ 1356 CURLOPT(CURLOPT_COOKIESESSION, CURLOPTTYPE_LONG, 96), 1357 1358 /* The CApath directory used to validate the peer certificate 1359 this option is used only if SSL_VERIFYPEER is true */ 1360 CURLOPT(CURLOPT_CAPATH, CURLOPTTYPE_STRINGPOINT, 97), 1361 1362 /* Instruct libcurl to use a smaller receive buffer */ 1363 CURLOPT(CURLOPT_BUFFERSIZE, CURLOPTTYPE_LONG, 98), 1364 1365 /* Instruct libcurl to not use any signal/alarm handlers, even when using 1366 timeouts. This option is useful for multi-threaded applications. 1367 See libcurl-the-guide for more background information. */ 1368 CURLOPT(CURLOPT_NOSIGNAL, CURLOPTTYPE_LONG, 99), 1369 1370 /* Provide a CURLShare for mutexing non-ts data */ 1371 CURLOPT(CURLOPT_SHARE, CURLOPTTYPE_OBJECTPOINT, 100), 1372 1373 /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default), 1374 CURLPROXY_HTTPS, CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and 1375 CURLPROXY_SOCKS5. */ 1376 CURLOPT(CURLOPT_PROXYTYPE, CURLOPTTYPE_VALUES, 101), 1377 1378 /* Set the Accept-Encoding string. Use this to tell a server you would like 1379 the response to be compressed. Before 7.21.6, this was known as 1380 CURLOPT_ENCODING */ 1381 CURLOPT(CURLOPT_ACCEPT_ENCODING, CURLOPTTYPE_STRINGPOINT, 102), 1382 1383 /* Set pointer to private data */ 1384 CURLOPT(CURLOPT_PRIVATE, CURLOPTTYPE_OBJECTPOINT, 103), 1385 1386 /* Set aliases for HTTP 200 in the HTTP Response header */ 1387 CURLOPT(CURLOPT_HTTP200ALIASES, CURLOPTTYPE_SLISTPOINT, 104), 1388 1389 /* Continue to send authentication (user+password) when following locations, 1390 even when hostname changed. This can potentially send off the name 1391 and password to whatever host the server decides. */ 1392 CURLOPT(CURLOPT_UNRESTRICTED_AUTH, CURLOPTTYPE_LONG, 105), 1393 1394 /* Specifically switch on or off the FTP engine's use of the EPRT command ( 1395 it also disables the LPRT attempt). By default, those ones will always be 1396 attempted before the good old traditional PORT command. */ 1397 CURLOPT(CURLOPT_FTP_USE_EPRT, CURLOPTTYPE_LONG, 106), 1398 1399 /* Set this to a bitmask value to enable the particular authentications 1400 methods you like. Use this in combination with CURLOPT_USERPWD. 1401 Note that setting multiple bits may cause extra network round-trips. */ 1402 CURLOPT(CURLOPT_HTTPAUTH, CURLOPTTYPE_VALUES, 107), 1403 1404 /* Set the ssl context callback function, currently only for OpenSSL or 1405 WolfSSL ssl_ctx, or mbedTLS mbedtls_ssl_config in the second argument. 1406 The function must match the curl_ssl_ctx_callback prototype. */ 1407 CURLOPT(CURLOPT_SSL_CTX_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 108), 1408 1409 /* Set the userdata for the ssl context callback function's third 1410 argument */ 1411 CURLOPT(CURLOPT_SSL_CTX_DATA, CURLOPTTYPE_CBPOINT, 109), 1412 1413 /* FTP Option that causes missing dirs to be created on the remote server. 1414 In 7.19.4 we introduced the convenience enums for this option using the 1415 CURLFTP_CREATE_DIR prefix. 1416 */ 1417 CURLOPT(CURLOPT_FTP_CREATE_MISSING_DIRS, CURLOPTTYPE_LONG, 110), 1418 1419 /* Set this to a bitmask value to enable the particular authentications 1420 methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. 1421 Note that setting multiple bits may cause extra network round-trips. */ 1422 CURLOPT(CURLOPT_PROXYAUTH, CURLOPTTYPE_VALUES, 111), 1423 1424 /* FTP option that changes the timeout, in seconds, associated with 1425 getting a response. This is different from transfer timeout time and 1426 essentially places a demand on the FTP server to acknowledge commands 1427 in a timely manner. */ 1428 CURLOPT(CURLOPT_FTP_RESPONSE_TIMEOUT, CURLOPTTYPE_LONG, 112), 1429 #define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT 1430 1431 /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to 1432 tell libcurl to resolve names to those IP versions only. This only has 1433 affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */ 1434 CURLOPT(CURLOPT_IPRESOLVE, CURLOPTTYPE_VALUES, 113), 1435 1436 /* Set this option to limit the size of a file that will be downloaded from 1437 an HTTP or FTP server. 1438 1439 Note there is also _LARGE version which adds large file support for 1440 platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */ 1441 CURLOPT(CURLOPT_MAXFILESIZE, CURLOPTTYPE_LONG, 114), 1442 1443 /* See the comment for INFILESIZE above, but in short, specifies 1444 * the size of the file being uploaded. -1 means unknown. 1445 */ 1446 CURLOPT(CURLOPT_INFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 115), 1447 1448 /* Sets the continuation offset. There is also a CURLOPTTYPE_LONG version 1449 * of this; look above for RESUME_FROM. 1450 */ 1451 CURLOPT(CURLOPT_RESUME_FROM_LARGE, CURLOPTTYPE_OFF_T, 116), 1452 1453 /* Sets the maximum size of data that will be downloaded from 1454 * an HTTP or FTP server. See MAXFILESIZE above for the LONG version. 1455 */ 1456 CURLOPT(CURLOPT_MAXFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 117), 1457 1458 /* Set this option to the file name of your .netrc file you want libcurl 1459 to parse (using the CURLOPT_NETRC option). If not set, libcurl will do 1460 a poor attempt to find the user's home directory and check for a .netrc 1461 file in there. */ 1462 CURLOPT(CURLOPT_NETRC_FILE, CURLOPTTYPE_STRINGPOINT, 118), 1463 1464 /* Enable SSL/TLS for FTP, pick one of: 1465 CURLUSESSL_TRY - try using SSL, proceed anyway otherwise 1466 CURLUSESSL_CONTROL - SSL for the control connection or fail 1467 CURLUSESSL_ALL - SSL for all communication or fail 1468 */ 1469 CURLOPT(CURLOPT_USE_SSL, CURLOPTTYPE_VALUES, 119), 1470 1471 /* The _LARGE version of the standard POSTFIELDSIZE option */ 1472 CURLOPT(CURLOPT_POSTFIELDSIZE_LARGE, CURLOPTTYPE_OFF_T, 120), 1473 1474 /* Enable/disable the TCP Nagle algorithm */ 1475 CURLOPT(CURLOPT_TCP_NODELAY, CURLOPTTYPE_LONG, 121), 1476 1477 /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1478 /* 123 OBSOLETE. Gone in 7.16.0 */ 1479 /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1480 /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1481 /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ 1482 /* 127 OBSOLETE. Gone in 7.16.0 */ 1483 /* 128 OBSOLETE. Gone in 7.16.0 */ 1484 1485 /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option 1486 can be used to change libcurl's default action which is to first try 1487 "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK 1488 response has been received. 1489 1490 Available parameters are: 1491 CURLFTPAUTH_DEFAULT - let libcurl decide 1492 CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS 1493 CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL 1494 */ 1495 CURLOPT(CURLOPT_FTPSSLAUTH, CURLOPTTYPE_VALUES, 129), 1496 1497 CURLOPT(CURLOPT_IOCTLFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 130), 1498 CURLOPT(CURLOPT_IOCTLDATA, CURLOPTTYPE_CBPOINT, 131), 1499 1500 /* 132 OBSOLETE. Gone in 7.16.0 */ 1501 /* 133 OBSOLETE. Gone in 7.16.0 */ 1502 1503 /* null-terminated string for pass on to the FTP server when asked for 1504 "account" info */ 1505 CURLOPT(CURLOPT_FTP_ACCOUNT, CURLOPTTYPE_STRINGPOINT, 134), 1506 1507 /* feed cookie into cookie engine */ 1508 CURLOPT(CURLOPT_COOKIELIST, CURLOPTTYPE_STRINGPOINT, 135), 1509 1510 /* ignore Content-Length */ 1511 CURLOPT(CURLOPT_IGNORE_CONTENT_LENGTH, CURLOPTTYPE_LONG, 136), 1512 1513 /* Set to non-zero to skip the IP address received in a 227 PASV FTP server 1514 response. Typically used for FTP-SSL purposes but is not restricted to 1515 that. libcurl will then instead use the same IP address it used for the 1516 control connection. */ 1517 CURLOPT(CURLOPT_FTP_SKIP_PASV_IP, CURLOPTTYPE_LONG, 137), 1518 1519 /* Select "file method" to use when doing FTP, see the curl_ftpmethod 1520 above. */ 1521 CURLOPT(CURLOPT_FTP_FILEMETHOD, CURLOPTTYPE_VALUES, 138), 1522 1523 /* Local port number to bind the socket to */ 1524 CURLOPT(CURLOPT_LOCALPORT, CURLOPTTYPE_LONG, 139), 1525 1526 /* Number of ports to try, including the first one set with LOCALPORT. 1527 Thus, setting it to 1 will make no additional attempts but the first. 1528 */ 1529 CURLOPT(CURLOPT_LOCALPORTRANGE, CURLOPTTYPE_LONG, 140), 1530 1531 /* no transfer, set up connection and let application use the socket by 1532 extracting it with CURLINFO_LASTSOCKET */ 1533 CURLOPT(CURLOPT_CONNECT_ONLY, CURLOPTTYPE_LONG, 141), 1534 1535 /* Function that will be called to convert from the 1536 network encoding (instead of using the iconv calls in libcurl) */ 1537 CURLOPT(CURLOPT_CONV_FROM_NETWORK_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 142), 1538 1539 /* Function that will be called to convert to the 1540 network encoding (instead of using the iconv calls in libcurl) */ 1541 CURLOPT(CURLOPT_CONV_TO_NETWORK_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 143), 1542 1543 /* Function that will be called to convert from UTF8 1544 (instead of using the iconv calls in libcurl) 1545 Note that this is used only for SSL certificate processing */ 1546 CURLOPT(CURLOPT_CONV_FROM_UTF8_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 144), 1547 1548 /* if the connection proceeds too quickly then need to slow it down */ 1549 /* limit-rate: maximum number of bytes per second to send or receive */ 1550 CURLOPT(CURLOPT_MAX_SEND_SPEED_LARGE, CURLOPTTYPE_OFF_T, 145), 1551 CURLOPT(CURLOPT_MAX_RECV_SPEED_LARGE, CURLOPTTYPE_OFF_T, 146), 1552 1553 /* Pointer to command string to send if USER/PASS fails. */ 1554 CURLOPT(CURLOPT_FTP_ALTERNATIVE_TO_USER, CURLOPTTYPE_STRINGPOINT, 147), 1555 1556 /* callback function for setting socket options */ 1557 CURLOPT(CURLOPT_SOCKOPTFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 148), 1558 CURLOPT(CURLOPT_SOCKOPTDATA, CURLOPTTYPE_CBPOINT, 149), 1559 1560 /* set to 0 to disable session ID re-use for this transfer, default is 1561 enabled (== 1) */ 1562 CURLOPT(CURLOPT_SSL_SESSIONID_CACHE, CURLOPTTYPE_LONG, 150), 1563 1564 /* allowed SSH authentication methods */ 1565 CURLOPT(CURLOPT_SSH_AUTH_TYPES, CURLOPTTYPE_VALUES, 151), 1566 1567 /* Used by scp/sftp to do public/private key authentication */ 1568 CURLOPT(CURLOPT_SSH_PUBLIC_KEYFILE, CURLOPTTYPE_STRINGPOINT, 152), 1569 CURLOPT(CURLOPT_SSH_PRIVATE_KEYFILE, CURLOPTTYPE_STRINGPOINT, 153), 1570 1571 /* Send CCC (Clear Command Channel) after authentication */ 1572 CURLOPT(CURLOPT_FTP_SSL_CCC, CURLOPTTYPE_LONG, 154), 1573 1574 /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */ 1575 CURLOPT(CURLOPT_TIMEOUT_MS, CURLOPTTYPE_LONG, 155), 1576 CURLOPT(CURLOPT_CONNECTTIMEOUT_MS, CURLOPTTYPE_LONG, 156), 1577 1578 /* set to zero to disable the libcurl's decoding and thus pass the raw body 1579 data to the application even when it is encoded/compressed */ 1580 CURLOPT(CURLOPT_HTTP_TRANSFER_DECODING, CURLOPTTYPE_LONG, 157), 1581 CURLOPT(CURLOPT_HTTP_CONTENT_DECODING, CURLOPTTYPE_LONG, 158), 1582 1583 /* Permission used when creating new files and directories on the remote 1584 server for protocols that support it, SFTP/SCP/FILE */ 1585 CURLOPT(CURLOPT_NEW_FILE_PERMS, CURLOPTTYPE_LONG, 159), 1586 CURLOPT(CURLOPT_NEW_DIRECTORY_PERMS, CURLOPTTYPE_LONG, 160), 1587 1588 /* Set the behaviour of POST when redirecting. Values must be set to one 1589 of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */ 1590 CURLOPT(CURLOPT_POSTREDIR, CURLOPTTYPE_VALUES, 161), 1591 1592 /* used by scp/sftp to verify the host's public key */ 1593 CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_MD5, CURLOPTTYPE_STRINGPOINT, 162), 1594 1595 /* Callback function for opening socket (instead of socket(2)). Optionally, 1596 callback is able change the address or refuse to connect returning 1597 CURL_SOCKET_BAD. The callback should have type 1598 curl_opensocket_callback */ 1599 CURLOPT(CURLOPT_OPENSOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 163), 1600 CURLOPT(CURLOPT_OPENSOCKETDATA, CURLOPTTYPE_CBPOINT, 164), 1601 1602 /* POST volatile input fields. */ 1603 CURLOPT(CURLOPT_COPYPOSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 165), 1604 1605 /* set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy */ 1606 CURLOPT(CURLOPT_PROXY_TRANSFER_MODE, CURLOPTTYPE_LONG, 166), 1607 1608 /* Callback function for seeking in the input stream */ 1609 CURLOPT(CURLOPT_SEEKFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 167), 1610 CURLOPT(CURLOPT_SEEKDATA, CURLOPTTYPE_CBPOINT, 168), 1611 1612 /* CRL file */ 1613 CURLOPT(CURLOPT_CRLFILE, CURLOPTTYPE_STRINGPOINT, 169), 1614 1615 /* Issuer certificate */ 1616 CURLOPT(CURLOPT_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 170), 1617 1618 /* (IPv6) Address scope */ 1619 CURLOPT(CURLOPT_ADDRESS_SCOPE, CURLOPTTYPE_LONG, 171), 1620 1621 /* Collect certificate chain info and allow it to get retrievable with 1622 CURLINFO_CERTINFO after the transfer is complete. */ 1623 CURLOPT(CURLOPT_CERTINFO, CURLOPTTYPE_LONG, 172), 1624 1625 /* "name" and "pwd" to use when fetching. */ 1626 CURLOPT(CURLOPT_USERNAME, CURLOPTTYPE_STRINGPOINT, 173), 1627 CURLOPT(CURLOPT_PASSWORD, CURLOPTTYPE_STRINGPOINT, 174), 1628 1629 /* "name" and "pwd" to use with Proxy when fetching. */ 1630 CURLOPT(CURLOPT_PROXYUSERNAME, CURLOPTTYPE_STRINGPOINT, 175), 1631 CURLOPT(CURLOPT_PROXYPASSWORD, CURLOPTTYPE_STRINGPOINT, 176), 1632 1633 /* Comma separated list of hostnames defining no-proxy zones. These should 1634 match both hostnames directly, and hostnames within a domain. For 1635 example, local.com will match local.com and www.local.com, but NOT 1636 notlocal.com or www.notlocal.com. For compatibility with other 1637 implementations of this, .local.com will be considered to be the same as 1638 local.com. A single * is the only valid wildcard, and effectively 1639 disables the use of proxy. */ 1640 CURLOPT(CURLOPT_NOPROXY, CURLOPTTYPE_STRINGPOINT, 177), 1641 1642 /* block size for TFTP transfers */ 1643 CURLOPT(CURLOPT_TFTP_BLKSIZE, CURLOPTTYPE_LONG, 178), 1644 1645 /* Socks Service */ 1646 /* DEPRECATED, do not use! */ 1647 CURLOPT(CURLOPT_SOCKS5_GSSAPI_SERVICE, CURLOPTTYPE_STRINGPOINT, 179), 1648 1649 /* Socks Service */ 1650 CURLOPT(CURLOPT_SOCKS5_GSSAPI_NEC, CURLOPTTYPE_LONG, 180), 1651 1652 /* set the bitmask for the protocols that are allowed to be used for the 1653 transfer, which thus helps the app which takes URLs from users or other 1654 external inputs and want to restrict what protocol(s) to deal 1655 with. Defaults to CURLPROTO_ALL. */ 1656 CURLOPT(CURLOPT_PROTOCOLS, CURLOPTTYPE_LONG, 181), 1657 1658 /* set the bitmask for the protocols that libcurl is allowed to follow to, 1659 as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs 1660 to be set in both bitmasks to be allowed to get redirected to. */ 1661 CURLOPT(CURLOPT_REDIR_PROTOCOLS, CURLOPTTYPE_LONG, 182), 1662 1663 /* set the SSH knownhost file name to use */ 1664 CURLOPT(CURLOPT_SSH_KNOWNHOSTS, CURLOPTTYPE_STRINGPOINT, 183), 1665 1666 /* set the SSH host key callback, must point to a curl_sshkeycallback 1667 function */ 1668 CURLOPT(CURLOPT_SSH_KEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 184), 1669 1670 /* set the SSH host key callback custom pointer */ 1671 CURLOPT(CURLOPT_SSH_KEYDATA, CURLOPTTYPE_CBPOINT, 185), 1672 1673 /* set the SMTP mail originator */ 1674 CURLOPT(CURLOPT_MAIL_FROM, CURLOPTTYPE_STRINGPOINT, 186), 1675 1676 /* set the list of SMTP mail receiver(s) */ 1677 CURLOPT(CURLOPT_MAIL_RCPT, CURLOPTTYPE_SLISTPOINT, 187), 1678 1679 /* FTP: send PRET before PASV */ 1680 CURLOPT(CURLOPT_FTP_USE_PRET, CURLOPTTYPE_LONG, 188), 1681 1682 /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */ 1683 CURLOPT(CURLOPT_RTSP_REQUEST, CURLOPTTYPE_VALUES, 189), 1684 1685 /* The RTSP session identifier */ 1686 CURLOPT(CURLOPT_RTSP_SESSION_ID, CURLOPTTYPE_STRINGPOINT, 190), 1687 1688 /* The RTSP stream URI */ 1689 CURLOPT(CURLOPT_RTSP_STREAM_URI, CURLOPTTYPE_STRINGPOINT, 191), 1690 1691 /* The Transport: header to use in RTSP requests */ 1692 CURLOPT(CURLOPT_RTSP_TRANSPORT, CURLOPTTYPE_STRINGPOINT, 192), 1693 1694 /* Manually initialize the client RTSP CSeq for this handle */ 1695 CURLOPT(CURLOPT_RTSP_CLIENT_CSEQ, CURLOPTTYPE_LONG, 193), 1696 1697 /* Manually initialize the server RTSP CSeq for this handle */ 1698 CURLOPT(CURLOPT_RTSP_SERVER_CSEQ, CURLOPTTYPE_LONG, 194), 1699 1700 /* The stream to pass to INTERLEAVEFUNCTION. */ 1701 CURLOPT(CURLOPT_INTERLEAVEDATA, CURLOPTTYPE_CBPOINT, 195), 1702 1703 /* Let the application define a custom write method for RTP data */ 1704 CURLOPT(CURLOPT_INTERLEAVEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 196), 1705 1706 /* Turn on wildcard matching */ 1707 CURLOPT(CURLOPT_WILDCARDMATCH, CURLOPTTYPE_LONG, 197), 1708 1709 /* Directory matching callback called before downloading of an 1710 individual file (chunk) started */ 1711 CURLOPT(CURLOPT_CHUNK_BGN_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 198), 1712 1713 /* Directory matching callback called after the file (chunk) 1714 was downloaded, or skipped */ 1715 CURLOPT(CURLOPT_CHUNK_END_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 199), 1716 1717 /* Change match (fnmatch-like) callback for wildcard matching */ 1718 CURLOPT(CURLOPT_FNMATCH_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 200), 1719 1720 /* Let the application define custom chunk data pointer */ 1721 CURLOPT(CURLOPT_CHUNK_DATA, CURLOPTTYPE_CBPOINT, 201), 1722 1723 /* FNMATCH_FUNCTION user pointer */ 1724 CURLOPT(CURLOPT_FNMATCH_DATA, CURLOPTTYPE_CBPOINT, 202), 1725 1726 /* send linked-list of name:port:address sets */ 1727 CURLOPT(CURLOPT_RESOLVE, CURLOPTTYPE_SLISTPOINT, 203), 1728 1729 /* Set a username for authenticated TLS */ 1730 CURLOPT(CURLOPT_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 204), 1731 1732 /* Set a password for authenticated TLS */ 1733 CURLOPT(CURLOPT_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 205), 1734 1735 /* Set authentication type for authenticated TLS */ 1736 CURLOPT(CURLOPT_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 206), 1737 1738 /* Set to 1 to enable the "TE:" header in HTTP requests to ask for 1739 compressed transfer-encoded responses. Set to 0 to disable the use of TE: 1740 in outgoing requests. The current default is 0, but it might change in a 1741 future libcurl release. 1742 1743 libcurl will ask for the compressed methods it knows of, and if that 1744 isn't any, it will not ask for transfer-encoding at all even if this 1745 option is set to 1. 1746 1747 */ 1748 CURLOPT(CURLOPT_TRANSFER_ENCODING, CURLOPTTYPE_LONG, 207), 1749 1750 /* Callback function for closing socket (instead of close(2)). The callback 1751 should have type curl_closesocket_callback */ 1752 CURLOPT(CURLOPT_CLOSESOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 208), 1753 CURLOPT(CURLOPT_CLOSESOCKETDATA, CURLOPTTYPE_CBPOINT, 209), 1754 1755 /* allow GSSAPI credential delegation */ 1756 CURLOPT(CURLOPT_GSSAPI_DELEGATION, CURLOPTTYPE_VALUES, 210), 1757 1758 /* Set the name servers to use for DNS resolution */ 1759 CURLOPT(CURLOPT_DNS_SERVERS, CURLOPTTYPE_STRINGPOINT, 211), 1760 1761 /* Time-out accept operations (currently for FTP only) after this amount 1762 of milliseconds. */ 1763 CURLOPT(CURLOPT_ACCEPTTIMEOUT_MS, CURLOPTTYPE_LONG, 212), 1764 1765 /* Set TCP keepalive */ 1766 CURLOPT(CURLOPT_TCP_KEEPALIVE, CURLOPTTYPE_LONG, 213), 1767 1768 /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */ 1769 CURLOPT(CURLOPT_TCP_KEEPIDLE, CURLOPTTYPE_LONG, 214), 1770 CURLOPT(CURLOPT_TCP_KEEPINTVL, CURLOPTTYPE_LONG, 215), 1771 1772 /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */ 1773 CURLOPT(CURLOPT_SSL_OPTIONS, CURLOPTTYPE_VALUES, 216), 1774 1775 /* Set the SMTP auth originator */ 1776 CURLOPT(CURLOPT_MAIL_AUTH, CURLOPTTYPE_STRINGPOINT, 217), 1777 1778 /* Enable/disable SASL initial response */ 1779 CURLOPT(CURLOPT_SASL_IR, CURLOPTTYPE_LONG, 218), 1780 1781 /* Function that will be called instead of the internal progress display 1782 * function. This function should be defined as the curl_xferinfo_callback 1783 * prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */ 1784 CURLOPT(CURLOPT_XFERINFOFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 219), 1785 1786 /* The XOAUTH2 bearer token */ 1787 CURLOPT(CURLOPT_XOAUTH2_BEARER, CURLOPTTYPE_STRINGPOINT, 220), 1788 1789 /* Set the interface string to use as outgoing network 1790 * interface for DNS requests. 1791 * Only supported by the c-ares DNS backend */ 1792 CURLOPT(CURLOPT_DNS_INTERFACE, CURLOPTTYPE_STRINGPOINT, 221), 1793 1794 /* Set the local IPv4 address to use for outgoing DNS requests. 1795 * Only supported by the c-ares DNS backend */ 1796 CURLOPT(CURLOPT_DNS_LOCAL_IP4, CURLOPTTYPE_STRINGPOINT, 222), 1797 1798 /* Set the local IPv6 address to use for outgoing DNS requests. 1799 * Only supported by the c-ares DNS backend */ 1800 CURLOPT(CURLOPT_DNS_LOCAL_IP6, CURLOPTTYPE_STRINGPOINT, 223), 1801 1802 /* Set authentication options directly */ 1803 CURLOPT(CURLOPT_LOGIN_OPTIONS, CURLOPTTYPE_STRINGPOINT, 224), 1804 1805 /* Enable/disable TLS NPN extension (http2 over ssl might fail without) */ 1806 CURLOPT(CURLOPT_SSL_ENABLE_NPN, CURLOPTTYPE_LONG, 225), 1807 1808 /* Enable/disable TLS ALPN extension (http2 over ssl might fail without) */ 1809 CURLOPT(CURLOPT_SSL_ENABLE_ALPN, CURLOPTTYPE_LONG, 226), 1810 1811 /* Time to wait for a response to a HTTP request containing an 1812 * Expect: 100-continue header before sending the data anyway. */ 1813 CURLOPT(CURLOPT_EXPECT_100_TIMEOUT_MS, CURLOPTTYPE_LONG, 227), 1814 1815 /* This points to a linked list of headers used for proxy requests only, 1816 struct curl_slist kind */ 1817 CURLOPT(CURLOPT_PROXYHEADER, CURLOPTTYPE_SLISTPOINT, 228), 1818 1819 /* Pass in a bitmask of "header options" */ 1820 CURLOPT(CURLOPT_HEADEROPT, CURLOPTTYPE_VALUES, 229), 1821 1822 /* The public key in DER form used to validate the peer public key 1823 this option is used only if SSL_VERIFYPEER is true */ 1824 CURLOPT(CURLOPT_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 230), 1825 1826 /* Path to Unix domain socket */ 1827 CURLOPT(CURLOPT_UNIX_SOCKET_PATH, CURLOPTTYPE_STRINGPOINT, 231), 1828 1829 /* Set if we should verify the certificate status. */ 1830 CURLOPT(CURLOPT_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 232), 1831 1832 /* Set if we should enable TLS false start. */ 1833 CURLOPT(CURLOPT_SSL_FALSESTART, CURLOPTTYPE_LONG, 233), 1834 1835 /* Do not squash dot-dot sequences */ 1836 CURLOPT(CURLOPT_PATH_AS_IS, CURLOPTTYPE_LONG, 234), 1837 1838 /* Proxy Service Name */ 1839 CURLOPT(CURLOPT_PROXY_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 235), 1840 1841 /* Service Name */ 1842 CURLOPT(CURLOPT_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 236), 1843 1844 /* Wait/don't wait for pipe/mutex to clarify */ 1845 CURLOPT(CURLOPT_PIPEWAIT, CURLOPTTYPE_LONG, 237), 1846 1847 /* Set the protocol used when curl is given a URL without a protocol */ 1848 CURLOPT(CURLOPT_DEFAULT_PROTOCOL, CURLOPTTYPE_STRINGPOINT, 238), 1849 1850 /* Set stream weight, 1 - 256 (default is 16) */ 1851 CURLOPT(CURLOPT_STREAM_WEIGHT, CURLOPTTYPE_LONG, 239), 1852 1853 /* Set stream dependency on another CURL handle */ 1854 CURLOPT(CURLOPT_STREAM_DEPENDS, CURLOPTTYPE_OBJECTPOINT, 240), 1855 1856 /* Set E-xclusive stream dependency on another CURL handle */ 1857 CURLOPT(CURLOPT_STREAM_DEPENDS_E, CURLOPTTYPE_OBJECTPOINT, 241), 1858 1859 /* Do not send any tftp option requests to the server */ 1860 CURLOPT(CURLOPT_TFTP_NO_OPTIONS, CURLOPTTYPE_LONG, 242), 1861 1862 /* Linked-list of host:port:connect-to-host:connect-to-port, 1863 overrides the URL's host:port (only for the network layer) */ 1864 CURLOPT(CURLOPT_CONNECT_TO, CURLOPTTYPE_SLISTPOINT, 243), 1865 1866 /* Set TCP Fast Open */ 1867 CURLOPT(CURLOPT_TCP_FASTOPEN, CURLOPTTYPE_LONG, 244), 1868 1869 /* Continue to send data if the server responds early with an 1870 * HTTP status code >= 300 */ 1871 CURLOPT(CURLOPT_KEEP_SENDING_ON_ERROR, CURLOPTTYPE_LONG, 245), 1872 1873 /* The CApath or CAfile used to validate the proxy certificate 1874 this option is used only if PROXY_SSL_VERIFYPEER is true */ 1875 CURLOPT(CURLOPT_PROXY_CAINFO, CURLOPTTYPE_STRINGPOINT, 246), 1876 1877 /* The CApath directory used to validate the proxy certificate 1878 this option is used only if PROXY_SSL_VERIFYPEER is true */ 1879 CURLOPT(CURLOPT_PROXY_CAPATH, CURLOPTTYPE_STRINGPOINT, 247), 1880 1881 /* Set if we should verify the proxy in ssl handshake, 1882 set 1 to verify. */ 1883 CURLOPT(CURLOPT_PROXY_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 248), 1884 1885 /* Set if we should verify the Common name from the proxy certificate in ssl 1886 * handshake, set 1 to check existence, 2 to ensure that it matches 1887 * the provided hostname. */ 1888 CURLOPT(CURLOPT_PROXY_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 249), 1889 1890 /* What version to specifically try to use for proxy. 1891 See CURL_SSLVERSION defines below. */ 1892 CURLOPT(CURLOPT_PROXY_SSLVERSION, CURLOPTTYPE_VALUES, 250), 1893 1894 /* Set a username for authenticated TLS for proxy */ 1895 CURLOPT(CURLOPT_PROXY_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 251), 1896 1897 /* Set a password for authenticated TLS for proxy */ 1898 CURLOPT(CURLOPT_PROXY_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 252), 1899 1900 /* Set authentication type for authenticated TLS for proxy */ 1901 CURLOPT(CURLOPT_PROXY_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 253), 1902 1903 /* name of the file keeping your private SSL-certificate for proxy */ 1904 CURLOPT(CURLOPT_PROXY_SSLCERT, CURLOPTTYPE_STRINGPOINT, 254), 1905 1906 /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") for 1907 proxy */ 1908 CURLOPT(CURLOPT_PROXY_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 255), 1909 1910 /* name of the file keeping your private SSL-key for proxy */ 1911 CURLOPT(CURLOPT_PROXY_SSLKEY, CURLOPTTYPE_STRINGPOINT, 256), 1912 1913 /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") for 1914 proxy */ 1915 CURLOPT(CURLOPT_PROXY_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 257), 1916 1917 /* password for the SSL private key for proxy */ 1918 CURLOPT(CURLOPT_PROXY_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 258), 1919 1920 /* Specify which SSL ciphers to use for proxy */ 1921 CURLOPT(CURLOPT_PROXY_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 259), 1922 1923 /* CRL file for proxy */ 1924 CURLOPT(CURLOPT_PROXY_CRLFILE, CURLOPTTYPE_STRINGPOINT, 260), 1925 1926 /* Enable/disable specific SSL features with a bitmask for proxy, see 1927 CURLSSLOPT_* */ 1928 CURLOPT(CURLOPT_PROXY_SSL_OPTIONS, CURLOPTTYPE_LONG, 261), 1929 1930 /* Name of pre proxy to use. */ 1931 CURLOPT(CURLOPT_PRE_PROXY, CURLOPTTYPE_STRINGPOINT, 262), 1932 1933 /* The public key in DER form used to validate the proxy public key 1934 this option is used only if PROXY_SSL_VERIFYPEER is true */ 1935 CURLOPT(CURLOPT_PROXY_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 263), 1936 1937 /* Path to an abstract Unix domain socket */ 1938 CURLOPT(CURLOPT_ABSTRACT_UNIX_SOCKET, CURLOPTTYPE_STRINGPOINT, 264), 1939 1940 /* Suppress proxy CONNECT response headers from user callbacks */ 1941 CURLOPT(CURLOPT_SUPPRESS_CONNECT_HEADERS, CURLOPTTYPE_LONG, 265), 1942 1943 /* The request target, instead of extracted from the URL */ 1944 CURLOPT(CURLOPT_REQUEST_TARGET, CURLOPTTYPE_STRINGPOINT, 266), 1945 1946 /* bitmask of allowed auth methods for connections to SOCKS5 proxies */ 1947 CURLOPT(CURLOPT_SOCKS5_AUTH, CURLOPTTYPE_LONG, 267), 1948 1949 /* Enable/disable SSH compression */ 1950 CURLOPT(CURLOPT_SSH_COMPRESSION, CURLOPTTYPE_LONG, 268), 1951 1952 /* Post MIME data. */ 1953 CURLOPT(CURLOPT_MIMEPOST, CURLOPTTYPE_OBJECTPOINT, 269), 1954 1955 /* Time to use with the CURLOPT_TIMECONDITION. Specified in number of 1956 seconds since 1 Jan 1970. */ 1957 CURLOPT(CURLOPT_TIMEVALUE_LARGE, CURLOPTTYPE_OFF_T, 270), 1958 1959 /* Head start in milliseconds to give happy eyeballs. */ 1960 CURLOPT(CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, CURLOPTTYPE_LONG, 271), 1961 1962 /* Function that will be called before a resolver request is made */ 1963 CURLOPT(CURLOPT_RESOLVER_START_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 272), 1964 1965 /* User data to pass to the resolver start callback. */ 1966 CURLOPT(CURLOPT_RESOLVER_START_DATA, CURLOPTTYPE_CBPOINT, 273), 1967 1968 /* send HAProxy PROXY protocol header? */ 1969 CURLOPT(CURLOPT_HAPROXYPROTOCOL, CURLOPTTYPE_LONG, 274), 1970 1971 /* shuffle addresses before use when DNS returns multiple */ 1972 CURLOPT(CURLOPT_DNS_SHUFFLE_ADDRESSES, CURLOPTTYPE_LONG, 275), 1973 1974 /* Specify which TLS 1.3 ciphers suites to use */ 1975 CURLOPT(CURLOPT_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 276), 1976 CURLOPT(CURLOPT_PROXY_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 277), 1977 1978 /* Disallow specifying username/login in URL. */ 1979 CURLOPT(CURLOPT_DISALLOW_USERNAME_IN_URL, CURLOPTTYPE_LONG, 278), 1980 1981 /* DNS-over-HTTPS URL */ 1982 CURLOPT(CURLOPT_DOH_URL, CURLOPTTYPE_STRINGPOINT, 279), 1983 1984 /* Preferred buffer size to use for uploads */ 1985 CURLOPT(CURLOPT_UPLOAD_BUFFERSIZE, CURLOPTTYPE_LONG, 280), 1986 1987 /* Time in ms between connection upkeep calls for long-lived connections. */ 1988 CURLOPT(CURLOPT_UPKEEP_INTERVAL_MS, CURLOPTTYPE_LONG, 281), 1989 1990 /* Specify URL using CURL URL API. */ 1991 CURLOPT(CURLOPT_CURLU, CURLOPTTYPE_OBJECTPOINT, 282), 1992 1993 /* add trailing data just after no more data is available */ 1994 CURLOPT(CURLOPT_TRAILERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 283), 1995 1996 /* pointer to be passed to HTTP_TRAILER_FUNCTION */ 1997 CURLOPT(CURLOPT_TRAILERDATA, CURLOPTTYPE_CBPOINT, 284), 1998 1999 /* set this to 1L to allow HTTP/0.9 responses or 0L to disallow */ 2000 CURLOPT(CURLOPT_HTTP09_ALLOWED, CURLOPTTYPE_LONG, 285), 2001 2002 /* alt-svc control bitmask */ 2003 CURLOPT(CURLOPT_ALTSVC_CTRL, CURLOPTTYPE_LONG, 286), 2004 2005 /* alt-svc cache file name to possibly read from/write to */ 2006 CURLOPT(CURLOPT_ALTSVC, CURLOPTTYPE_STRINGPOINT, 287), 2007 2008 /* maximum age of a connection to consider it for reuse (in seconds) */ 2009 CURLOPT(CURLOPT_MAXAGE_CONN, CURLOPTTYPE_LONG, 288), 2010 2011 /* SASL authorisation identity */ 2012 CURLOPT(CURLOPT_SASL_AUTHZID, CURLOPTTYPE_STRINGPOINT, 289), 2013 2014 /* allow RCPT TO command to fail for some recipients */ 2015 CURLOPT(CURLOPT_MAIL_RCPT_ALLLOWFAILS, CURLOPTTYPE_LONG, 290), 2016 2017 /* the private SSL-certificate as a "blob" */ 2018 CURLOPT(CURLOPT_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 291), 2019 CURLOPT(CURLOPT_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 292), 2020 CURLOPT(CURLOPT_PROXY_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 293), 2021 CURLOPT(CURLOPT_PROXY_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 294), 2022 CURLOPT(CURLOPT_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 295), 2023 2024 /* Issuer certificate for proxy */ 2025 CURLOPT(CURLOPT_PROXY_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 296), 2026 CURLOPT(CURLOPT_PROXY_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 297), 2027 2028 /* the EC curves requested by the TLS client (RFC 8422, 5.1); 2029 * OpenSSL support via 'set_groups'/'set_curves': 2030 * https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set1_groups.html 2031 */ 2032 CURLOPT(CURLOPT_SSL_EC_CURVES, CURLOPTTYPE_STRINGPOINT, 298), 2033 2034 CURLOPT_LASTENTRY /* the last unused */ 2035 } CURLoption; 2036 2037 #ifndef CURL_NO_OLDIES /* define this to test if your app builds with all 2038 the obsolete stuff removed! */ 2039 2040 /* Backwards compatibility with older names */ 2041 /* These are scheduled to disappear by 2011 */ 2042 2043 /* This was added in version 7.19.1 */ 2044 #define CURLOPT_POST301 CURLOPT_POSTREDIR 2045 2046 /* These are scheduled to disappear by 2009 */ 2047 2048 /* The following were added in 7.17.0 */ 2049 #define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD 2050 #define CURLOPT_FTPAPPEND CURLOPT_APPEND 2051 #define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY 2052 #define CURLOPT_FTP_SSL CURLOPT_USE_SSL 2053 2054 /* The following were added earlier */ 2055 2056 #define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD 2057 #define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL 2058 2059 #else 2060 /* This is set if CURL_NO_OLDIES is defined at compile-time */ 2061 #undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */ 2062 #endif 2063 2064 2065 /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host 2066 name resolves addresses using more than one IP protocol version, this 2067 option might be handy to force libcurl to use a specific IP version. */ 2068 #define CURL_IPRESOLVE_WHATEVER 0 /* default, resolves addresses to all IP 2069 versions that your system allows */ 2070 #define CURL_IPRESOLVE_V4 1 /* resolve to IPv4 addresses */ 2071 #define CURL_IPRESOLVE_V6 2 /* resolve to IPv6 addresses */ 2072 2073 /* three convenient "aliases" that follow the name scheme better */ 2074 #define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER 2075 2076 /* These enums are for use with the CURLOPT_HTTP_VERSION option. */ 2077 enum { 2078 CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd 2079 like the library to choose the best possible 2080 for us! */ 2081 CURL_HTTP_VERSION_1_0, /* please use HTTP 1.0 in the request */ 2082 CURL_HTTP_VERSION_1_1, /* please use HTTP 1.1 in the request */ 2083 CURL_HTTP_VERSION_2_0, /* please use HTTP 2 in the request */ 2084 CURL_HTTP_VERSION_2TLS, /* use version 2 for HTTPS, version 1.1 for HTTP */ 2085 CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE, /* please use HTTP 2 without HTTP/1.1 2086 Upgrade */ 2087 CURL_HTTP_VERSION_3 = 30, /* Makes use of explicit HTTP/3 without fallback. 2088 Use CURLOPT_ALTSVC to enable HTTP/3 upgrade */ 2089 CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */ 2090 }; 2091 2092 /* Convenience definition simple because the name of the version is HTTP/2 and 2093 not 2.0. The 2_0 version of the enum name was set while the version was 2094 still planned to be 2.0 and we stick to it for compatibility. */ 2095 #define CURL_HTTP_VERSION_2 CURL_HTTP_VERSION_2_0 2096 2097 /* 2098 * Public API enums for RTSP requests 2099 */ 2100 enum { 2101 CURL_RTSPREQ_NONE, /* first in list */ 2102 CURL_RTSPREQ_OPTIONS, 2103 CURL_RTSPREQ_DESCRIBE, 2104 CURL_RTSPREQ_ANNOUNCE, 2105 CURL_RTSPREQ_SETUP, 2106 CURL_RTSPREQ_PLAY, 2107 CURL_RTSPREQ_PAUSE, 2108 CURL_RTSPREQ_TEARDOWN, 2109 CURL_RTSPREQ_GET_PARAMETER, 2110 CURL_RTSPREQ_SET_PARAMETER, 2111 CURL_RTSPREQ_RECORD, 2112 CURL_RTSPREQ_RECEIVE, 2113 CURL_RTSPREQ_LAST /* last in list */ 2114 }; 2115 2116 /* These enums are for use with the CURLOPT_NETRC option. */ 2117 enum CURL_NETRC_OPTION { 2118 CURL_NETRC_IGNORED, /* The .netrc will never be read. 2119 * This is the default. */ 2120 CURL_NETRC_OPTIONAL, /* A user:password in the URL will be preferred 2121 * to one in the .netrc. */ 2122 CURL_NETRC_REQUIRED, /* A user:password in the URL will be ignored. 2123 * Unless one is set programmatically, the .netrc 2124 * will be queried. */ 2125 CURL_NETRC_LAST 2126 }; 2127 2128 enum { 2129 CURL_SSLVERSION_DEFAULT, 2130 CURL_SSLVERSION_TLSv1, /* TLS 1.x */ 2131 CURL_SSLVERSION_SSLv2, 2132 CURL_SSLVERSION_SSLv3, 2133 CURL_SSLVERSION_TLSv1_0, 2134 CURL_SSLVERSION_TLSv1_1, 2135 CURL_SSLVERSION_TLSv1_2, 2136 CURL_SSLVERSION_TLSv1_3, 2137 2138 CURL_SSLVERSION_LAST /* never use, keep last */ 2139 }; 2140 2141 enum { 2142 CURL_SSLVERSION_MAX_NONE = 0, 2143 CURL_SSLVERSION_MAX_DEFAULT = (CURL_SSLVERSION_TLSv1 << 16), 2144 CURL_SSLVERSION_MAX_TLSv1_0 = (CURL_SSLVERSION_TLSv1_0 << 16), 2145 CURL_SSLVERSION_MAX_TLSv1_1 = (CURL_SSLVERSION_TLSv1_1 << 16), 2146 CURL_SSLVERSION_MAX_TLSv1_2 = (CURL_SSLVERSION_TLSv1_2 << 16), 2147 CURL_SSLVERSION_MAX_TLSv1_3 = (CURL_SSLVERSION_TLSv1_3 << 16), 2148 2149 /* never use, keep last */ 2150 CURL_SSLVERSION_MAX_LAST = (CURL_SSLVERSION_LAST << 16) 2151 }; 2152 2153 enum CURL_TLSAUTH { 2154 CURL_TLSAUTH_NONE, 2155 CURL_TLSAUTH_SRP, 2156 CURL_TLSAUTH_LAST /* never use, keep last */ 2157 }; 2158 2159 /* symbols to use with CURLOPT_POSTREDIR. 2160 CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303 2161 can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302 2162 | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */ 2163 2164 #define CURL_REDIR_GET_ALL 0 2165 #define CURL_REDIR_POST_301 1 2166 #define CURL_REDIR_POST_302 2 2167 #define CURL_REDIR_POST_303 4 2168 #define CURL_REDIR_POST_ALL \ 2169 (CURL_REDIR_POST_301|CURL_REDIR_POST_302|CURL_REDIR_POST_303) 2170 2171 typedef enum { 2172 CURL_TIMECOND_NONE, 2173 2174 CURL_TIMECOND_IFMODSINCE, 2175 CURL_TIMECOND_IFUNMODSINCE, 2176 CURL_TIMECOND_LASTMOD, 2177 2178 CURL_TIMECOND_LAST 2179 } curl_TimeCond; 2180 2181 /* Special size_t value signaling a null-terminated string. */ 2182 #define CURL_ZERO_TERMINATED ((size_t) -1) 2183 2184 /* curl_strequal() and curl_strnequal() are subject for removal in a future 2185 release */ 2186 CURL_EXTERN int curl_strequal(const char *s1, const char *s2); 2187 CURL_EXTERN int curl_strnequal(const char *s1, const char *s2, size_t n); 2188 2189 /* Mime/form handling support. */ 2190 typedef struct curl_mime curl_mime; /* Mime context. */ 2191 typedef struct curl_mimepart curl_mimepart; /* Mime part context. */ 2192 2193 /* 2194 * NAME curl_mime_init() 2195 * 2196 * DESCRIPTION 2197 * 2198 * Create a mime context and return its handle. The easy parameter is the 2199 * target handle. 2200 */ 2201 CURL_EXTERN curl_mime *curl_mime_init(CURL *easy); 2202 2203 /* 2204 * NAME curl_mime_free() 2205 * 2206 * DESCRIPTION 2207 * 2208 * release a mime handle and its substructures. 2209 */ 2210 CURL_EXTERN void curl_mime_free(curl_mime *mime); 2211 2212 /* 2213 * NAME curl_mime_addpart() 2214 * 2215 * DESCRIPTION 2216 * 2217 * Append a new empty part to the given mime context and return a handle to 2218 * the created part. 2219 */ 2220 CURL_EXTERN curl_mimepart *curl_mime_addpart(curl_mime *mime); 2221 2222 /* 2223 * NAME curl_mime_name() 2224 * 2225 * DESCRIPTION 2226 * 2227 * Set mime/form part name. 2228 */ 2229 CURL_EXTERN CURLcode curl_mime_name(curl_mimepart *part, const char *name); 2230 2231 /* 2232 * NAME curl_mime_filename() 2233 * 2234 * DESCRIPTION 2235 * 2236 * Set mime part remote file name. 2237 */ 2238 CURL_EXTERN CURLcode curl_mime_filename(curl_mimepart *part, 2239 const char *filename); 2240 2241 /* 2242 * NAME curl_mime_type() 2243 * 2244 * DESCRIPTION 2245 * 2246 * Set mime part type. 2247 */ 2248 CURL_EXTERN CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype); 2249 2250 /* 2251 * NAME curl_mime_encoder() 2252 * 2253 * DESCRIPTION 2254 * 2255 * Set mime data transfer encoder. 2256 */ 2257 CURL_EXTERN CURLcode curl_mime_encoder(curl_mimepart *part, 2258 const char *encoding); 2259 2260 /* 2261 * NAME curl_mime_data() 2262 * 2263 * DESCRIPTION 2264 * 2265 * Set mime part data source from memory data, 2266 */ 2267 CURL_EXTERN CURLcode curl_mime_data(curl_mimepart *part, 2268 const char *data, size_t datasize); 2269 2270 /* 2271 * NAME curl_mime_filedata() 2272 * 2273 * DESCRIPTION 2274 * 2275 * Set mime part data source from named file. 2276 */ 2277 CURL_EXTERN CURLcode curl_mime_filedata(curl_mimepart *part, 2278 const char *filename); 2279 2280 /* 2281 * NAME curl_mime_data_cb() 2282 * 2283 * DESCRIPTION 2284 * 2285 * Set mime part data source from callback function. 2286 */ 2287 CURL_EXTERN CURLcode curl_mime_data_cb(curl_mimepart *part, 2288 curl_off_t datasize, 2289 curl_read_callback readfunc, 2290 curl_seek_callback seekfunc, 2291 curl_free_callback freefunc, 2292 void *arg); 2293 2294 /* 2295 * NAME curl_mime_subparts() 2296 * 2297 * DESCRIPTION 2298 * 2299 * Set mime part data source from subparts. 2300 */ 2301 CURL_EXTERN CURLcode curl_mime_subparts(curl_mimepart *part, 2302 curl_mime *subparts); 2303 /* 2304 * NAME curl_mime_headers() 2305 * 2306 * DESCRIPTION 2307 * 2308 * Set mime part headers. 2309 */ 2310 CURL_EXTERN CURLcode curl_mime_headers(curl_mimepart *part, 2311 struct curl_slist *headers, 2312 int take_ownership); 2313 2314 typedef enum { 2315 CURLFORM_NOTHING, /********* the first one is unused ************/ 2316 CURLFORM_COPYNAME, 2317 CURLFORM_PTRNAME, 2318 CURLFORM_NAMELENGTH, 2319 CURLFORM_COPYCONTENTS, 2320 CURLFORM_PTRCONTENTS, 2321 CURLFORM_CONTENTSLENGTH, 2322 CURLFORM_FILECONTENT, 2323 CURLFORM_ARRAY, 2324 CURLFORM_OBSOLETE, 2325 CURLFORM_FILE, 2326 2327 CURLFORM_BUFFER, 2328 CURLFORM_BUFFERPTR, 2329 CURLFORM_BUFFERLENGTH, 2330 2331 CURLFORM_CONTENTTYPE, 2332 CURLFORM_CONTENTHEADER, 2333 CURLFORM_FILENAME, 2334 CURLFORM_END, 2335 CURLFORM_OBSOLETE2, 2336 2337 CURLFORM_STREAM, 2338 CURLFORM_CONTENTLEN, /* added in 7.46.0, provide a curl_off_t length */ 2339 2340 CURLFORM_LASTENTRY /* the last unused */ 2341 } CURLformoption; 2342 2343 /* structure to be used as parameter for CURLFORM_ARRAY */ 2344 struct curl_forms { 2345 CURLformoption option; 2346 const char *value; 2347 }; 2348 2349 /* use this for multipart formpost building */ 2350 /* Returns code for curl_formadd() 2351 * 2352 * Returns: 2353 * CURL_FORMADD_OK on success 2354 * CURL_FORMADD_MEMORY if the FormInfo allocation fails 2355 * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form 2356 * CURL_FORMADD_NULL if a null pointer was given for a char 2357 * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed 2358 * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used 2359 * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) 2360 * CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated 2361 * CURL_FORMADD_MEMORY if some allocation for string copying failed. 2362 * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array 2363 * 2364 ***************************************************************************/ 2365 typedef enum { 2366 CURL_FORMADD_OK, /* first, no error */ 2367 2368 CURL_FORMADD_MEMORY, 2369 CURL_FORMADD_OPTION_TWICE, 2370 CURL_FORMADD_NULL, 2371 CURL_FORMADD_UNKNOWN_OPTION, 2372 CURL_FORMADD_INCOMPLETE, 2373 CURL_FORMADD_ILLEGAL_ARRAY, 2374 CURL_FORMADD_DISABLED, /* libcurl was built with this disabled */ 2375 2376 CURL_FORMADD_LAST /* last */ 2377 } CURLFORMcode; 2378 2379 /* 2380 * NAME curl_formadd() 2381 * 2382 * DESCRIPTION 2383 * 2384 * Pretty advanced function for building multi-part formposts. Each invoke 2385 * adds one part that together construct a full post. Then use 2386 * CURLOPT_HTTPPOST to send it off to libcurl. 2387 */ 2388 CURL_EXTERN CURLFORMcode curl_formadd(struct curl_httppost **httppost, 2389 struct curl_httppost **last_post, 2390 ...); 2391 2392 /* 2393 * callback function for curl_formget() 2394 * The void *arg pointer will be the one passed as second argument to 2395 * curl_formget(). 2396 * The character buffer passed to it must not be freed. 2397 * Should return the buffer length passed to it as the argument "len" on 2398 * success. 2399 */ 2400 typedef size_t (*curl_formget_callback)(void *arg, const char *buf, 2401 size_t len); 2402 2403 /* 2404 * NAME curl_formget() 2405 * 2406 * DESCRIPTION 2407 * 2408 * Serialize a curl_httppost struct built with curl_formadd(). 2409 * Accepts a void pointer as second argument which will be passed to 2410 * the curl_formget_callback function. 2411 * Returns 0 on success. 2412 */ 2413 CURL_EXTERN int curl_formget(struct curl_httppost *form, void *arg, 2414 curl_formget_callback append); 2415 /* 2416 * NAME curl_formfree() 2417 * 2418 * DESCRIPTION 2419 * 2420 * Free a multipart formpost previously built with curl_formadd(). 2421 */ 2422 CURL_EXTERN void curl_formfree(struct curl_httppost *form); 2423 2424 /* 2425 * NAME curl_getenv() 2426 * 2427 * DESCRIPTION 2428 * 2429 * Returns a malloc()'ed string that MUST be curl_free()ed after usage is 2430 * complete. DEPRECATED - see lib/README.curlx 2431 */ 2432 CURL_EXTERN char *curl_getenv(const char *variable); 2433 2434 /* 2435 * NAME curl_version() 2436 * 2437 * DESCRIPTION 2438 * 2439 * Returns a static ascii string of the libcurl version. 2440 */ 2441 CURL_EXTERN char *curl_version(void); 2442 2443 /* 2444 * NAME curl_easy_escape() 2445 * 2446 * DESCRIPTION 2447 * 2448 * Escapes URL strings (converts all letters consider illegal in URLs to their 2449 * %XX versions). This function returns a new allocated string or NULL if an 2450 * error occurred. 2451 */ 2452 CURL_EXTERN char *curl_easy_escape(CURL *handle, 2453 const char *string, 2454 int length); 2455 2456 /* the previous version: */ 2457 CURL_EXTERN char *curl_escape(const char *string, 2458 int length); 2459 2460 2461 /* 2462 * NAME curl_easy_unescape() 2463 * 2464 * DESCRIPTION 2465 * 2466 * Unescapes URL encoding in strings (converts all %XX codes to their 8bit 2467 * versions). This function returns a new allocated string or NULL if an error 2468 * occurred. 2469 * Conversion Note: On non-ASCII platforms the ASCII %XX codes are 2470 * converted into the host encoding. 2471 */ 2472 CURL_EXTERN char *curl_easy_unescape(CURL *handle, 2473 const char *string, 2474 int length, 2475 int *outlength); 2476 2477 /* the previous version */ 2478 CURL_EXTERN char *curl_unescape(const char *string, 2479 int length); 2480 2481 /* 2482 * NAME curl_free() 2483 * 2484 * DESCRIPTION 2485 * 2486 * Provided for de-allocation in the same translation unit that did the 2487 * allocation. Added in libcurl 7.10 2488 */ 2489 CURL_EXTERN void curl_free(void *p); 2490 2491 /* 2492 * NAME curl_global_init() 2493 * 2494 * DESCRIPTION 2495 * 2496 * curl_global_init() should be invoked exactly once for each application that 2497 * uses libcurl and before any call of other libcurl functions. 2498 * 2499 * This function is not thread-safe! 2500 */ 2501 CURL_EXTERN CURLcode curl_global_init(long flags); 2502 2503 /* 2504 * NAME curl_global_init_mem() 2505 * 2506 * DESCRIPTION 2507 * 2508 * curl_global_init() or curl_global_init_mem() should be invoked exactly once 2509 * for each application that uses libcurl. This function can be used to 2510 * initialize libcurl and set user defined memory management callback 2511 * functions. Users can implement memory management routines to check for 2512 * memory leaks, check for mis-use of the curl library etc. User registered 2513 * callback routines will be invoked by this library instead of the system 2514 * memory management routines like malloc, free etc. 2515 */ 2516 CURL_EXTERN CURLcode curl_global_init_mem(long flags, 2517 curl_malloc_callback m, 2518 curl_free_callback f, 2519 curl_realloc_callback r, 2520 curl_strdup_callback s, 2521 curl_calloc_callback c); 2522 2523 /* 2524 * NAME curl_global_cleanup() 2525 * 2526 * DESCRIPTION 2527 * 2528 * curl_global_cleanup() should be invoked exactly once for each application 2529 * that uses libcurl 2530 */ 2531 CURL_EXTERN void curl_global_cleanup(void); 2532 2533 /* linked-list structure for the CURLOPT_QUOTE option (and other) */ 2534 struct curl_slist { 2535 char *data; 2536 struct curl_slist *next; 2537 }; 2538 2539 /* 2540 * NAME curl_global_sslset() 2541 * 2542 * DESCRIPTION 2543 * 2544 * When built with multiple SSL backends, curl_global_sslset() allows to 2545 * choose one. This function can only be called once, and it must be called 2546 * *before* curl_global_init(). 2547 * 2548 * The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The 2549 * backend can also be specified via the name parameter (passing -1 as id). 2550 * If both id and name are specified, the name will be ignored. If neither id 2551 * nor name are specified, the function will fail with 2552 * CURLSSLSET_UNKNOWN_BACKEND and set the "avail" pointer to the 2553 * NULL-terminated list of available backends. 2554 * 2555 * Upon success, the function returns CURLSSLSET_OK. 2556 * 2557 * If the specified SSL backend is not available, the function returns 2558 * CURLSSLSET_UNKNOWN_BACKEND and sets the "avail" pointer to a NULL-terminated 2559 * list of available SSL backends. 2560 * 2561 * The SSL backend can be set only once. If it has already been set, a 2562 * subsequent attempt to change it will result in a CURLSSLSET_TOO_LATE. 2563 */ 2564 2565 struct curl_ssl_backend { 2566 curl_sslbackend id; 2567 const char *name; 2568 }; 2569 typedef struct curl_ssl_backend curl_ssl_backend; 2570 2571 typedef enum { 2572 CURLSSLSET_OK = 0, 2573 CURLSSLSET_UNKNOWN_BACKEND, 2574 CURLSSLSET_TOO_LATE, 2575 CURLSSLSET_NO_BACKENDS /* libcurl was built without any SSL support */ 2576 } CURLsslset; 2577 2578 CURL_EXTERN CURLsslset curl_global_sslset(curl_sslbackend id, const char *name, 2579 const curl_ssl_backend ***avail); 2580 2581 /* 2582 * NAME curl_slist_append() 2583 * 2584 * DESCRIPTION 2585 * 2586 * Appends a string to a linked list. If no list exists, it will be created 2587 * first. Returns the new list, after appending. 2588 */ 2589 CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *, 2590 const char *); 2591 2592 /* 2593 * NAME curl_slist_free_all() 2594 * 2595 * DESCRIPTION 2596 * 2597 * free a previously built curl_slist. 2598 */ 2599 CURL_EXTERN void curl_slist_free_all(struct curl_slist *); 2600 2601 /* 2602 * NAME curl_getdate() 2603 * 2604 * DESCRIPTION 2605 * 2606 * Returns the time, in seconds since 1 Jan 1970 of the time string given in 2607 * the first argument. The time argument in the second parameter is unused 2608 * and should be set to NULL. 2609 */ 2610 CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused); 2611 2612 /* info about the certificate chain, only for OpenSSL, GnuTLS, Schannel, NSS 2613 and GSKit builds. Asked for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */ 2614 struct curl_certinfo { 2615 int num_of_certs; /* number of certificates with information */ 2616 struct curl_slist **certinfo; /* for each index in this array, there's a 2617 linked list with textual information in the 2618 format "name: value" */ 2619 }; 2620 2621 /* Information about the SSL library used and the respective internal SSL 2622 handle, which can be used to obtain further information regarding the 2623 connection. Asked for with CURLINFO_TLS_SSL_PTR or CURLINFO_TLS_SESSION. */ 2624 struct curl_tlssessioninfo { 2625 curl_sslbackend backend; 2626 void *internals; 2627 }; 2628 2629 #define CURLINFO_STRING 0x100000 2630 #define CURLINFO_LONG 0x200000 2631 #define CURLINFO_DOUBLE 0x300000 2632 #define CURLINFO_SLIST 0x400000 2633 #define CURLINFO_PTR 0x400000 /* same as SLIST */ 2634 #define CURLINFO_SOCKET 0x500000 2635 #define CURLINFO_OFF_T 0x600000 2636 #define CURLINFO_MASK 0x0fffff 2637 #define CURLINFO_TYPEMASK 0xf00000 2638 2639 typedef enum { 2640 CURLINFO_NONE, /* first, never use this */ 2641 CURLINFO_EFFECTIVE_URL = CURLINFO_STRING + 1, 2642 CURLINFO_RESPONSE_CODE = CURLINFO_LONG + 2, 2643 CURLINFO_TOTAL_TIME = CURLINFO_DOUBLE + 3, 2644 CURLINFO_NAMELOOKUP_TIME = CURLINFO_DOUBLE + 4, 2645 CURLINFO_CONNECT_TIME = CURLINFO_DOUBLE + 5, 2646 CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6, 2647 CURLINFO_SIZE_UPLOAD = CURLINFO_DOUBLE + 7, 2648 CURLINFO_SIZE_UPLOAD_T = CURLINFO_OFF_T + 7, 2649 CURLINFO_SIZE_DOWNLOAD = CURLINFO_DOUBLE + 8, 2650 CURLINFO_SIZE_DOWNLOAD_T = CURLINFO_OFF_T + 8, 2651 CURLINFO_SPEED_DOWNLOAD = CURLINFO_DOUBLE + 9, 2652 CURLINFO_SPEED_DOWNLOAD_T = CURLINFO_OFF_T + 9, 2653 CURLINFO_SPEED_UPLOAD = CURLINFO_DOUBLE + 10, 2654 CURLINFO_SPEED_UPLOAD_T = CURLINFO_OFF_T + 10, 2655 CURLINFO_HEADER_SIZE = CURLINFO_LONG + 11, 2656 CURLINFO_REQUEST_SIZE = CURLINFO_LONG + 12, 2657 CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG + 13, 2658 CURLINFO_FILETIME = CURLINFO_LONG + 14, 2659 CURLINFO_FILETIME_T = CURLINFO_OFF_T + 14, 2660 CURLINFO_CONTENT_LENGTH_DOWNLOAD = CURLINFO_DOUBLE + 15, 2661 CURLINFO_CONTENT_LENGTH_DOWNLOAD_T = CURLINFO_OFF_T + 15, 2662 CURLINFO_CONTENT_LENGTH_UPLOAD = CURLINFO_DOUBLE + 16, 2663 CURLINFO_CONTENT_LENGTH_UPLOAD_T = CURLINFO_OFF_T + 16, 2664 CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17, 2665 CURLINFO_CONTENT_TYPE = CURLINFO_STRING + 18, 2666 CURLINFO_REDIRECT_TIME = CURLINFO_DOUBLE + 19, 2667 CURLINFO_REDIRECT_COUNT = CURLINFO_LONG + 20, 2668 CURLINFO_PRIVATE = CURLINFO_STRING + 21, 2669 CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG + 22, 2670 CURLINFO_HTTPAUTH_AVAIL = CURLINFO_LONG + 23, 2671 CURLINFO_PROXYAUTH_AVAIL = CURLINFO_LONG + 24, 2672 CURLINFO_OS_ERRNO = CURLINFO_LONG + 25, 2673 CURLINFO_NUM_CONNECTS = CURLINFO_LONG + 26, 2674 CURLINFO_SSL_ENGINES = CURLINFO_SLIST + 27, 2675 CURLINFO_COOKIELIST = CURLINFO_SLIST + 28, 2676 CURLINFO_LASTSOCKET = CURLINFO_LONG + 29, 2677 CURLINFO_FTP_ENTRY_PATH = CURLINFO_STRING + 30, 2678 CURLINFO_REDIRECT_URL = CURLINFO_STRING + 31, 2679 CURLINFO_PRIMARY_IP = CURLINFO_STRING + 32, 2680 CURLINFO_APPCONNECT_TIME = CURLINFO_DOUBLE + 33, 2681 CURLINFO_CERTINFO = CURLINFO_PTR + 34, 2682 CURLINFO_CONDITION_UNMET = CURLINFO_LONG + 35, 2683 CURLINFO_RTSP_SESSION_ID = CURLINFO_STRING + 36, 2684 CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG + 37, 2685 CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG + 38, 2686 CURLINFO_RTSP_CSEQ_RECV = CURLINFO_LONG + 39, 2687 CURLINFO_PRIMARY_PORT = CURLINFO_LONG + 40, 2688 CURLINFO_LOCAL_IP = CURLINFO_STRING + 41, 2689 CURLINFO_LOCAL_PORT = CURLINFO_LONG + 42, 2690 CURLINFO_TLS_SESSION = CURLINFO_PTR + 43, 2691 CURLINFO_ACTIVESOCKET = CURLINFO_SOCKET + 44, 2692 CURLINFO_TLS_SSL_PTR = CURLINFO_PTR + 45, 2693 CURLINFO_HTTP_VERSION = CURLINFO_LONG + 46, 2694 CURLINFO_PROXY_SSL_VERIFYRESULT = CURLINFO_LONG + 47, 2695 CURLINFO_PROTOCOL = CURLINFO_LONG + 48, 2696 CURLINFO_SCHEME = CURLINFO_STRING + 49, 2697 CURLINFO_TOTAL_TIME_T = CURLINFO_OFF_T + 50, 2698 CURLINFO_NAMELOOKUP_TIME_T = CURLINFO_OFF_T + 51, 2699 CURLINFO_CONNECT_TIME_T = CURLINFO_OFF_T + 52, 2700 CURLINFO_PRETRANSFER_TIME_T = CURLINFO_OFF_T + 53, 2701 CURLINFO_STARTTRANSFER_TIME_T = CURLINFO_OFF_T + 54, 2702 CURLINFO_REDIRECT_TIME_T = CURLINFO_OFF_T + 55, 2703 CURLINFO_APPCONNECT_TIME_T = CURLINFO_OFF_T + 56, 2704 CURLINFO_RETRY_AFTER = CURLINFO_OFF_T + 57, 2705 CURLINFO_EFFECTIVE_METHOD = CURLINFO_STRING + 58, 2706 CURLINFO_PROXY_ERROR = CURLINFO_LONG + 59, 2707 2708 CURLINFO_LASTONE = 59 2709 } CURLINFO; 2710 2711 /* CURLINFO_RESPONSE_CODE is the new name for the option previously known as 2712 CURLINFO_HTTP_CODE */ 2713 #define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE 2714 2715 typedef enum { 2716 CURLCLOSEPOLICY_NONE, /* first, never use this */ 2717 2718 CURLCLOSEPOLICY_OLDEST, 2719 CURLCLOSEPOLICY_LEAST_RECENTLY_USED, 2720 CURLCLOSEPOLICY_LEAST_TRAFFIC, 2721 CURLCLOSEPOLICY_SLOWEST, 2722 CURLCLOSEPOLICY_CALLBACK, 2723 2724 CURLCLOSEPOLICY_LAST /* last, never use this */ 2725 } curl_closepolicy; 2726 2727 #define CURL_GLOBAL_SSL (1<<0) /* no purpose since since 7.57.0 */ 2728 #define CURL_GLOBAL_WIN32 (1<<1) 2729 #define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32) 2730 #define CURL_GLOBAL_NOTHING 0 2731 #define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL 2732 #define CURL_GLOBAL_ACK_EINTR (1<<2) 2733 2734 2735 /***************************************************************************** 2736 * Setup defines, protos etc for the sharing stuff. 2737 */ 2738 2739 /* Different data locks for a single share */ 2740 typedef enum { 2741 CURL_LOCK_DATA_NONE = 0, 2742 /* CURL_LOCK_DATA_SHARE is used internally to say that 2743 * the locking is just made to change the internal state of the share 2744 * itself. 2745 */ 2746 CURL_LOCK_DATA_SHARE, 2747 CURL_LOCK_DATA_COOKIE, 2748 CURL_LOCK_DATA_DNS, 2749 CURL_LOCK_DATA_SSL_SESSION, 2750 CURL_LOCK_DATA_CONNECT, 2751 CURL_LOCK_DATA_PSL, 2752 CURL_LOCK_DATA_LAST 2753 } curl_lock_data; 2754 2755 /* Different lock access types */ 2756 typedef enum { 2757 CURL_LOCK_ACCESS_NONE = 0, /* unspecified action */ 2758 CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */ 2759 CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */ 2760 CURL_LOCK_ACCESS_LAST /* never use */ 2761 } curl_lock_access; 2762 2763 typedef void (*curl_lock_function)(CURL *handle, 2764 curl_lock_data data, 2765 curl_lock_access locktype, 2766 void *userptr); 2767 typedef void (*curl_unlock_function)(CURL *handle, 2768 curl_lock_data data, 2769 void *userptr); 2770 2771 2772 typedef enum { 2773 CURLSHE_OK, /* all is fine */ 2774 CURLSHE_BAD_OPTION, /* 1 */ 2775 CURLSHE_IN_USE, /* 2 */ 2776 CURLSHE_INVALID, /* 3 */ 2777 CURLSHE_NOMEM, /* 4 out of memory */ 2778 CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */ 2779 CURLSHE_LAST /* never use */ 2780 } CURLSHcode; 2781 2782 typedef enum { 2783 CURLSHOPT_NONE, /* don't use */ 2784 CURLSHOPT_SHARE, /* specify a data type to share */ 2785 CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */ 2786 CURLSHOPT_LOCKFUNC, /* pass in a 'curl_lock_function' pointer */ 2787 CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */ 2788 CURLSHOPT_USERDATA, /* pass in a user data pointer used in the lock/unlock 2789 callback functions */ 2790 CURLSHOPT_LAST /* never use */ 2791 } CURLSHoption; 2792 2793 CURL_EXTERN CURLSH *curl_share_init(void); 2794 CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option, ...); 2795 CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *); 2796 2797 /**************************************************************************** 2798 * Structures for querying information about the curl library at runtime. 2799 */ 2800 2801 typedef enum { 2802 CURLVERSION_FIRST, 2803 CURLVERSION_SECOND, 2804 CURLVERSION_THIRD, 2805 CURLVERSION_FOURTH, 2806 CURLVERSION_FIFTH, 2807 CURLVERSION_SIXTH, 2808 CURLVERSION_SEVENTH, 2809 CURLVERSION_EIGHTH, 2810 CURLVERSION_LAST /* never actually use this */ 2811 } CURLversion; 2812 2813 /* The 'CURLVERSION_NOW' is the symbolic name meant to be used by 2814 basically all programs ever that want to get version information. It is 2815 meant to be a built-in version number for what kind of struct the caller 2816 expects. If the struct ever changes, we redefine the NOW to another enum 2817 from above. */ 2818 #define CURLVERSION_NOW CURLVERSION_EIGHTH 2819 2820 struct curl_version_info_data { 2821 CURLversion age; /* age of the returned struct */ 2822 const char *version; /* LIBCURL_VERSION */ 2823 unsigned int version_num; /* LIBCURL_VERSION_NUM */ 2824 const char *host; /* OS/host/cpu/machine when configured */ 2825 int features; /* bitmask, see defines below */ 2826 const char *ssl_version; /* human readable string */ 2827 long ssl_version_num; /* not used anymore, always 0 */ 2828 const char *libz_version; /* human readable string */ 2829 /* protocols is terminated by an entry with a NULL protoname */ 2830 const char * const *protocols; 2831 2832 /* The fields below this were added in CURLVERSION_SECOND */ 2833 const char *ares; 2834 int ares_num; 2835 2836 /* This field was added in CURLVERSION_THIRD */ 2837 const char *libidn; 2838 2839 /* These field were added in CURLVERSION_FOURTH */ 2840 2841 /* Same as '_libiconv_version' if built with HAVE_ICONV */ 2842 int iconv_ver_num; 2843 2844 const char *libssh_version; /* human readable string */ 2845 2846 /* These fields were added in CURLVERSION_FIFTH */ 2847 unsigned int brotli_ver_num; /* Numeric Brotli version 2848 (MAJOR << 24) | (MINOR << 12) | PATCH */ 2849 const char *brotli_version; /* human readable string. */ 2850 2851 /* These fields were added in CURLVERSION_SIXTH */ 2852 unsigned int nghttp2_ver_num; /* Numeric nghttp2 version 2853 (MAJOR << 16) | (MINOR << 8) | PATCH */ 2854 const char *nghttp2_version; /* human readable string. */ 2855 const char *quic_version; /* human readable quic (+ HTTP/3) library + 2856 version or NULL */ 2857 2858 /* These fields were added in CURLVERSION_SEVENTH */ 2859 const char *cainfo; /* the built-in default CURLOPT_CAINFO, might 2860 be NULL */ 2861 const char *capath; /* the built-in default CURLOPT_CAPATH, might 2862 be NULL */ 2863 2864 /* These fields were added in CURLVERSION_EIGHTH */ 2865 unsigned int zstd_ver_num; /* Numeric Zstd version 2866 (MAJOR << 24) | (MINOR << 12) | PATCH */ 2867 const char *zstd_version; /* human readable string. */ 2868 2869 }; 2870 typedef struct curl_version_info_data curl_version_info_data; 2871 2872 #define CURL_VERSION_IPV6 (1<<0) /* IPv6-enabled */ 2873 #define CURL_VERSION_KERBEROS4 (1<<1) /* Kerberos V4 auth is supported 2874 (deprecated) */ 2875 #define CURL_VERSION_SSL (1<<2) /* SSL options are present */ 2876 #define CURL_VERSION_LIBZ (1<<3) /* libz features are present */ 2877 #define CURL_VERSION_NTLM (1<<4) /* NTLM auth is supported */ 2878 #define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth is supported 2879 (deprecated) */ 2880 #define CURL_VERSION_DEBUG (1<<6) /* Built with debug capabilities */ 2881 #define CURL_VERSION_ASYNCHDNS (1<<7) /* Asynchronous DNS resolves */ 2882 #define CURL_VERSION_SPNEGO (1<<8) /* SPNEGO auth is supported */ 2883 #define CURL_VERSION_LARGEFILE (1<<9) /* Supports files larger than 2GB */ 2884 #define CURL_VERSION_IDN (1<<10) /* Internationized Domain Names are 2885 supported */ 2886 #define CURL_VERSION_SSPI (1<<11) /* Built against Windows SSPI */ 2887 #define CURL_VERSION_CONV (1<<12) /* Character conversions supported */ 2888 #define CURL_VERSION_CURLDEBUG (1<<13) /* Debug memory tracking supported */ 2889 #define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */ 2890 #define CURL_VERSION_NTLM_WB (1<<15) /* NTLM delegation to winbind helper 2891 is supported */ 2892 #define CURL_VERSION_HTTP2 (1<<16) /* HTTP2 support built-in */ 2893 #define CURL_VERSION_GSSAPI (1<<17) /* Built against a GSS-API library */ 2894 #define CURL_VERSION_KERBEROS5 (1<<18) /* Kerberos V5 auth is supported */ 2895 #define CURL_VERSION_UNIX_SOCKETS (1<<19) /* Unix domain sockets support */ 2896 #define CURL_VERSION_PSL (1<<20) /* Mozilla's Public Suffix List, used 2897 for cookie domain verification */ 2898 #define CURL_VERSION_HTTPS_PROXY (1<<21) /* HTTPS-proxy support built-in */ 2899 #define CURL_VERSION_MULTI_SSL (1<<22) /* Multiple SSL backends available */ 2900 #define CURL_VERSION_BROTLI (1<<23) /* Brotli features are present. */ 2901 #define CURL_VERSION_ALTSVC (1<<24) /* Alt-Svc handling built-in */ 2902 #define CURL_VERSION_HTTP3 (1<<25) /* HTTP3 support built-in */ 2903 #define CURL_VERSION_ZSTD (1<<26) /* zstd features are present */ 2904 #define CURL_VERSION_UNICODE (1<<27) /* Unicode support on Windows */ 2905 2906 /* 2907 * NAME curl_version_info() 2908 * 2909 * DESCRIPTION 2910 * 2911 * This function returns a pointer to a static copy of the version info 2912 * struct. See above. 2913 */ 2914 CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion); 2915 2916 /* 2917 * NAME curl_easy_strerror() 2918 * 2919 * DESCRIPTION 2920 * 2921 * The curl_easy_strerror function may be used to turn a CURLcode value 2922 * into the equivalent human readable error string. This is useful 2923 * for printing meaningful error messages. 2924 */ 2925 CURL_EXTERN const char *curl_easy_strerror(CURLcode); 2926 2927 /* 2928 * NAME curl_share_strerror() 2929 * 2930 * DESCRIPTION 2931 * 2932 * The curl_share_strerror function may be used to turn a CURLSHcode value 2933 * into the equivalent human readable error string. This is useful 2934 * for printing meaningful error messages. 2935 */ 2936 CURL_EXTERN const char *curl_share_strerror(CURLSHcode); 2937 2938 /* 2939 * NAME curl_easy_pause() 2940 * 2941 * DESCRIPTION 2942 * 2943 * The curl_easy_pause function pauses or unpauses transfers. Select the new 2944 * state by setting the bitmask, use the convenience defines below. 2945 * 2946 */ 2947 CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask); 2948 2949 #define CURLPAUSE_RECV (1<<0) 2950 #define CURLPAUSE_RECV_CONT (0) 2951 2952 #define CURLPAUSE_SEND (1<<2) 2953 #define CURLPAUSE_SEND_CONT (0) 2954 2955 #define CURLPAUSE_ALL (CURLPAUSE_RECV|CURLPAUSE_SEND) 2956 #define CURLPAUSE_CONT (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT) 2957 2958 #ifdef __cplusplus 2959 } 2960 #endif 2961 2962 /* unfortunately, the easy.h and multi.h include files need options and info 2963 stuff before they can be included! */ 2964 #include "easy.h" /* nothing in curl is fun without the easy stuff */ 2965 #include "multi.h" 2966 #include "urlapi.h" 2967 #include "options.h" 2968 2969 /* the typechecker doesn't work in C++ (yet) */ 2970 #if defined(__GNUC__) && defined(__GNUC_MINOR__) && \ 2971 ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \ 2972 !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK) 2973 #include "typecheck-gcc.h" 2974 #else 2975 #if defined(__STDC__) && (__STDC__ >= 1) 2976 /* This preprocessor magic that replaces a call with the exact same call is 2977 only done to make sure application authors pass exactly three arguments 2978 to these functions. */ 2979 #define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param) 2980 #define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg) 2981 #define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) 2982 #define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) 2983 #endif /* __STDC__ >= 1 */ 2984 #endif /* gcc >= 4.3 && !__cplusplus */ 2985 2986 #endif /* CURLINC_CURL_H */ 2987