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