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