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