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