Section 3: library functions
CURLOPT_SSLENGINE_DEFAULT – make SSL engine default Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val); DescriptionPass a long set to 1 as parameter. Sets the actual crypto engine as the default for (asymmetric) crypto operations. If the crypto device cannot be set, CURLE_SSL_ENGINE_SETFAILED is returned. DefaultNone ProtocolsAll TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc….
CURLOPT_SSLENGINE – set SSL engine identifier Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id); DescriptionPass a pointer to a zero terminated string as parameter. It will be used as the identifier for the crypto engine you want to use for your private key. If the crypto device cannot be loaded, CURLE_SSL_ENGINE_NOTFOUND is returned. DefaultNULL ProtocolsAll…
CURLOPT_SSLCERTTYPE – specify type of the client SSL certificate Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERTTYPE, char *type); DescriptionPass a pointer to a zero terminated string as parameter. The string should be the format of your certificate. Supported formats are "PEM" and "DER", except with Secure Transport. OpenSSL (versions 0.9.3 and later) and Secure Transport (on…
CURLOPT_SSLCERT – set SSL client certificate Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert); DescriptionPass a pointer to a zero terminated string as parameter. The string should be the file name of your client certificate. The default format is "P12" on Secure Transport and "PEM" on other engines, and can be changed with CURLOPT_SSLCERTTYPE(3). With…
CURLOPT_SSH_PUBLIC_KEYFILE – set public key file for SSH auth Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PUBLIC_KEYFILE, char *filename);DescriptionPass a char * pointing to a filename for your public key. If not used, libcurl defaults to $HOME/.ssh/id_dsa.pub if the HOME environment variable is set, and just "id_dsa.pub" in the current directory if HOME is not set. If…
CURLOPT_SSH_PRIVATE_KEYFILE – set private key file for SSH auth Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE, char *filename);DescriptionPass a char * pointing to a filename for your private key. If not used, libcurl defaults to $HOME/.ssh/id_dsa if the HOME environment variable is set, and just "id_dsa" in the current directory if HOME is not set. If…
CURLOPT_SSH_KNOWNHOSTS – file name holding the SSH known hosts Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KNOWNHOSTS, char *fname); DescriptionPass a pointer to a zero terminated string holding the file name of the known_host file to use. The known_hosts file should use the OpenSSH file format as supported by libssh2. If this file is specified, libcurl will…
CURLOPT_SSH_KEYFUNCTION – callback for known host matching logic Synopsis#include <curl/curl.h> enum curl_khstat { CURLKHSTAT_FINE_ADD_TO_FILE, CURLKHSTAT_FINE, CURLKHSTAT_REJECT, /* reject the connection, return an error */ CURLKHSTAT_DEFER, /* do not accept it, but we can’t answer right now so this causes a CURLE_DEFER error but otherwise the connection will be left intact etc */ }; enum curl_khmatch…
CURLOPT_SSH_KEYDATA – pointer to pass to the SSH key callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KEYDATA, void *pointer); DescriptionPass a void * as parameter. This pointer will be passed along verbatim to the callback set with CURLOPT_SSH_KEYFUNCTION(3). DefaultNULL ProtocolsSFTP and SCP ExampleTODO AvailabilityAdded in 7.19.6 Return ValueReturns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION…
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 – checksum of SSH server public key Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOST_PUBLIC_KEY_MD5, char *md5);DescriptionPass a char * pointing to a string containing 32 hexadecimal digits. The string should be the 128 bit MD5 checksum of the remote host’s public key, and libcurl will reject the connection to the host unless the md5sums match….
CURLOPT_SSH_AUTH_TYPES – set desired auth types for SFTP and SCP Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask); DescriptionPass a long set to a bitmask consisting of one or more of CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, CURLSSH_AUTH_KEYBOARD and CURLSSH_AUTH_AGENT. Set CURLSSH_AUTH_ANY to let libcurl pick a suitable one. Currently CURLSSH_AUTH_HOST has no effect. If CURLSSH_AUTH_AGENT is used,…
CURLOPT_SOCKS5_GSSAPI_SERVICE – proxy socks gssapi service name Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE, char *name); DescriptionPass a char * as parameter to a string holding the name of the service. The default service name for a SOCKS5 server is rcmd/server-fqdn. This option allows you to change it. DefaultSee above ProtocolsMost ExampleTODO AvailabilityAdded in 7.19.4 Return…
CURLOPT_SOCKS5_GSSAPI_NEC – set socks proxy gssapi negotiation protection Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_NEC, long nec); DescriptionPass a long set to 1 to enable or 0 to disable. As part of the gssapi negotiation a protection mode is negotiated. The RFC1961 says in section 4.3/4.4 it should be protected, but the NEC reference implementation does…
CURLOPT_SOCKOPTFUNCTION – set callback for setting socket options Synopsis#include <curl/curl.h> typedef enum { CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */ CURLSOCKTYPE_LAST /* never use */ } curlsocktype; #define CURL_SOCKOPT_OK 0 #define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return CURLE_ABORTED_BY_CALLBACK */ #define CURL_SOCKOPT_ALREADY_CONNECTED…
CURLOPT_SOCKOPTDATA – custom pointer to pass to sockopt callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTDATA, void *pointer); DescriptionPass a pointer that will be untouched by libcurl and passed as the first argument in the sockopt callback set with CURLOPT_SOCKOPTFUNCTION(3). DefaultThe default value of this parameter is NULL. ProtocolsAll ExampleTODO AvailabilityAdded in 7.16.0 Return ValueReturns CURLE_OK…
CURLOPT_SHARE – specify share handle to use Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SHARE, CURLSH *share); DescriptionPass a share handle as a parameter. The share handle must have been created by a previous call to curl_share_init(3). Setting this option, will make this curl handle use the data from the shared handle instead of keeping the data…
CURLOPT_SEEKFUNCTION – user callback for seeking in input stream Synopsis#include <curl/curl.h> /* These are the return codes for the seek callbacks */ #define CURL_SEEKFUNC_OK 0 #define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ #define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can’t be done, so libcurl might try other means instead */ int seek_callback(void *userp,…
CURLOPT_SEEKDATA – custom pointer passed to the seek callback Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SEEKDATA, void *pointer); DescriptionData pointer to pass to the seek callback function. If you use the CURLOPT_SEEKFUNCTION(3) option, this is the pointer you’ll get as input. DefaultIf you don’t set this, NULL is passed to the callback. ProtocolsHTTP, FTP, SFTP ExampleAvailabilityAdded…
CURLOPT_SASL_IR – enable sending initial response in first packet Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_IR, long enable); DescriptionPass a long. If the value is 1, curl will send the initial response to the server in the first authentication packet in order to reduce the number of ping pong requests. Only applicable to the following supporting…
CURLOPT_RTSP_TRANSPORT – set RTSP Transport: header Synopsis#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_TRANSPORT, char *transport);DescriptionPass a char * to tell libcurl what to pass for the Transport: header for this RTSP session. This is mainly a convenience method to avoid needing to set a custom Transport: header for every SETUP request. The application must set a…