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