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