docs/libcurl/libcurl-errors.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH libcurl-errors 3 "1 Jan 2010" "libcurl 7.20.0" "libcurl errors"
  24 .SH NAME
  25 libcurl-errors \- error codes in libcurl
  26 .SH DESCRIPTION
  27 This man page includes most, if not all, available error codes in libcurl.
  28 Why they occur and possibly what you can do to fix the problem are also included.
  29 .SH "CURLcode"
  30 Almost all "easy" interface functions return a CURLcode error code. No matter
  31 what, using the \fIcurl_easy_setopt(3)\fP option \fICURLOPT_ERRORBUFFER(3)\fP
  32 is a good idea as it will give you a human readable error string that may
  33 offer more details about the cause of the error than just the error code.
  34 \fIcurl_easy_strerror(3)\fP can be called to get an error string from a given
  35 CURLcode number.
  36
  37 CURLcode is one of the following:
  38 .IP "CURLE_OK (0)"
  39 All fine. Proceed as usual.
  40 .IP "CURLE_UNSUPPORTED_PROTOCOL (1)"
  41 The URL you passed to libcurl used a protocol that this libcurl does not
  42 support. The support might be a compile-time option that you didn't use, it
  43 can be a misspelled protocol string or just a protocol libcurl has no code
  44 for.
  45 .IP "CURLE_FAILED_INIT (2)"
  46 Very early initialization code failed. This is likely to be an internal error
  47 or problem, or a resource problem where something fundamental couldn't get
  48 done at init time.
  49 .IP "CURLE_URL_MALFORMAT (3)"
  50 The URL was not properly formatted.
  51 .IP "CURLE_NOT_BUILT_IN (4)"
  52 A requested feature, protocol or option was not found built-in in this libcurl
  53 due to a build-time decision. This means that a feature or option was not
  54 enabled or explicitly disabled when libcurl was built and in order to get it
  55 to function you have to get a rebuilt libcurl.
  56 .IP "CURLE_COULDNT_RESOLVE_PROXY (5)"
  57 Couldn't resolve proxy. The given proxy host could not be resolved.
  58 .IP "CURLE_COULDNT_RESOLVE_HOST (6)"
  59 Couldn't resolve host. The given remote host was not resolved.
  60 .IP "CURLE_COULDNT_CONNECT (7)"
  61 Failed to connect() to host or proxy.
  62 .IP "CURLE_FTP_WEIRD_SERVER_REPLY (8)"
  63 After connecting to a FTP server, libcurl expects to get a certain reply
  64 back. This error code implies that it got a strange or bad reply. The given
  65 remote server is probably not an OK FTP server.
  66 .IP "CURLE_REMOTE_ACCESS_DENIED (9)"
  67 We were denied access to the resource given in the URL.  For FTP, this occurs
  68 while trying to change to the remote directory.
  69 .IP "CURLE_FTP_ACCEPT_FAILED (10)"
  70 While waiting for the server to connect back when an active FTP session is
  71 used, an error code was sent over the control connection or similar.
  72 .IP "CURLE_FTP_WEIRD_PASS_REPLY (11)"
  73 After having sent the FTP password to the server, libcurl expects a proper
  74 reply. This error code indicates that an unexpected code was returned.
  75 .IP "CURLE_FTP_ACCEPT_TIMEOUT (12)"
  76 During an active FTP session while waiting for the server to connect, the
  77 \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP (or the internal default) timeout expired.
  78 .IP "CURLE_FTP_WEIRD_PASV_REPLY (13)"
  79 libcurl failed to get a sensible result back from the server as a response to
  80 either a PASV or a EPSV command. The server is flawed.
  81 .IP "CURLE_FTP_WEIRD_227_FORMAT (14)"
  82 FTP servers return a 227-line as a response to a PASV command. If libcurl
  83 fails to parse that line, this return code is passed back.
  84 .IP "CURLE_FTP_CANT_GET_HOST (15)"
  85 An internal failure to lookup the host used for the new connection.
  86 .IP "CURLE_HTTP2 (16)"
  87 A problem was detected in the HTTP2 framing layer. This is somewhat generic
  88 and can be one out of several problems, see the error buffer for details.
  89 .IP "CURLE_FTP_COULDNT_SET_TYPE (17)"
  90 Received an error when trying to set the transfer mode to binary or ASCII.
  91 .IP "CURLE_PARTIAL_FILE (18)"
  92 A file transfer was shorter or larger than expected. This happens when the
  93 server first reports an expected transfer size, and then delivers data that
  94 doesn't match the previously given size.
  95 .IP "CURLE_FTP_COULDNT_RETR_FILE (19)"
  96 This was either a weird reply to a 'RETR' command or a zero byte transfer
  97 complete.
  98 .IP "CURLE_QUOTE_ERROR (21)"
  99 When sending custom "QUOTE" commands to the remote server, one of the commands
 100 returned an error code that was 400 or higher (for FTP) or otherwise
 101 indicated unsuccessful completion of the command.
 102 .IP "CURLE_HTTP_RETURNED_ERROR (22)"
 103 This is returned if \fICURLOPT_FAILONERROR(3)\fP is set TRUE and the HTTP
 104 server returns an error code that is >= 400.
 105 .IP "CURLE_WRITE_ERROR (23)"
 106 An error occurred when writing received data to a local file, or an error was
 107 returned to libcurl from a write callback.
 108 .IP "CURLE_UPLOAD_FAILED (25)"
 109 Failed starting the upload. For FTP, the server typically denied the STOR
 110 command. The error buffer usually contains the server's explanation for this.
 111 .IP "CURLE_READ_ERROR (26)"
 112 There was a problem reading a local file or an error returned by the read
 113 callback.
 114 .IP "CURLE_OUT_OF_MEMORY (27)"
 115 A memory allocation request failed. This is serious badness and
 116 things are severely screwed up if this ever occurs.
 117 .IP "CURLE_OPERATION_TIMEDOUT (28)"
 118 Operation timeout. The specified time-out period was reached according to the
 119 conditions.
 120 .IP "CURLE_FTP_PORT_FAILED (30)"
 121 The FTP PORT command returned error. This mostly happens when you haven't
 122 specified a good enough address for libcurl to use. See
 123 \fICURLOPT_FTPPORT(3)\fP.
 124 .IP "CURLE_FTP_COULDNT_USE_REST (31)"
 125 The FTP REST command returned error. This should never happen if the server is
 126 sane.
 127 .IP "CURLE_RANGE_ERROR (33)"
 128 The server does not support or accept range requests.
 129 .IP "CURLE_HTTP_POST_ERROR (34)"
 130 This is an odd error that mainly occurs due to internal confusion.
 131 .IP "CURLE_SSL_CONNECT_ERROR (35)"
 132 A problem occurred somewhere in the SSL/TLS handshake. You really want the
 133 error buffer and read the message there as it pinpoints the problem slightly
 134 more. Could be certificates (file formats, paths, permissions), passwords, and
 135 others.
 136 .IP "CURLE_BAD_DOWNLOAD_RESUME (36)"
 137 The download could not be resumed because the specified offset was out of the
 138 file boundary.
 139 .IP "CURLE_FILE_COULDNT_READ_FILE (37)"
 140 A file given with FILE:// couldn't be opened. Most likely because the file
 141 path doesn't identify an existing file. Did you check file permissions?
 142 .IP "CURLE_LDAP_CANNOT_BIND (38)"
 143 LDAP cannot bind. LDAP bind operation failed.
 144 .IP "CURLE_LDAP_SEARCH_FAILED (39)"
 145 LDAP search failed.
 146 .IP "CURLE_FUNCTION_NOT_FOUND (41)"
 147 Function not found. A required zlib function was not found.
 148 .IP "CURLE_ABORTED_BY_CALLBACK (42)"
 149 Aborted by callback. A callback returned "abort" to libcurl.
 150 .IP "CURLE_BAD_FUNCTION_ARGUMENT (43)"
 151 Internal error. A function was called with a bad parameter.
 152 .IP "CURLE_INTERFACE_FAILED (45)"
 153 Interface error. A specified outgoing interface could not be used. Set which
 154 interface to use for outgoing connections' source IP address with
 155 \fICURLOPT_INTERFACE(3)\fP.
 156 .IP "CURLE_TOO_MANY_REDIRECTS (47)"
 157 Too many redirects. When following redirects, libcurl hit the maximum amount.
 158 Set your limit with \fICURLOPT_MAXREDIRS(3)\fP.
 159 .IP "CURLE_UNKNOWN_OPTION (48)"
 160 An option passed to libcurl is not recognized/known. Refer to the appropriate
 161 documentation. This is most likely a problem in the program that uses
 162 libcurl. The error buffer might contain more specific information about which
 163 exact option it concerns.
 164 .IP "CURLE_TELNET_OPTION_SYNTAX (49)"
 165 A telnet option string was Illegally formatted.
 166 .IP "CURLE_PEER_FAILED_VERIFICATION (51)"
 167 The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.
 168 .IP "CURLE_GOT_NOTHING (52)"
 169 Nothing was returned from the server, and under the circumstances, getting
 170 nothing is considered an error.
 171 .IP "CURLE_SSL_ENGINE_NOTFOUND (53)"
 172 The specified crypto engine wasn't found.
 173 .IP "CURLE_SSL_ENGINE_SETFAILED (54)"
 174 Failed setting the selected SSL crypto engine as default!
 175 .IP "CURLE_SEND_ERROR (55)"
 176 Failed sending network data.
 177 .IP "CURLE_RECV_ERROR (56)"
 178 Failure with receiving network data.
 179 .IP "CURLE_SSL_CERTPROBLEM (58)"
 180 problem with the local client certificate.
 181 .IP "CURLE_SSL_CIPHER (59)"
 182 Couldn't use specified cipher.
 183 .IP "CURLE_SSL_CACERT (60)"
 184 Peer certificate cannot be authenticated with known CA certificates.
 185 .IP "CURLE_BAD_CONTENT_ENCODING (61)"
 186 Unrecognized transfer encoding.
 187 .IP "CURLE_LDAP_INVALID_URL (62)"
 188 Invalid LDAP URL.
 189 .IP "CURLE_FILESIZE_EXCEEDED (63)"
 190 Maximum file size exceeded.
 191 .IP "CURLE_USE_SSL_FAILED (64)"
 192 Requested FTP SSL level failed.
 193 .IP "CURLE_SEND_FAIL_REWIND (65)"
 194 When doing a send operation curl had to rewind the data to retransmit, but the
 195 rewinding operation failed.
 196 .IP "CURLE_SSL_ENGINE_INITFAILED (66)"
 197 Initiating the SSL Engine failed.
 198 .IP "CURLE_LOGIN_DENIED (67)"
 199 The remote server denied curl to login (Added in 7.13.1)
 200 .IP "CURLE_TFTP_NOTFOUND (68)"
 201 File not found on TFTP server.
 202 .IP "CURLE_TFTP_PERM (69)"
 203 Permission problem on TFTP server.
 204 .IP "CURLE_REMOTE_DISK_FULL (70)"
 205 Out of disk space on the server.
 206 .IP "CURLE_TFTP_ILLEGAL (71)"
 207 Illegal TFTP operation.
 208 .IP "CURLE_TFTP_UNKNOWNID (72)"
 209 Unknown TFTP transfer ID.
 210 .IP "CURLE_REMOTE_FILE_EXISTS (73)"
 211 File already exists and will not be overwritten.
 212 .IP "CURLE_TFTP_NOSUCHUSER (74)"
 213 This error should never be returned by a properly functioning TFTP server.
 214 .IP "CURLE_CONV_FAILED (75)"
 215 Character conversion failed.
 216 .IP "CURLE_CONV_REQD (76)"
 217 Caller must register conversion callbacks.
 218 .IP "CURLE_SSL_CACERT_BADFILE (77)"
 219 Problem with reading the SSL CA cert (path? access rights?)
 220 .IP "CURLE_REMOTE_FILE_NOT_FOUND (78)"
 221 The resource referenced in the URL does not exist.
 222 .IP "CURLE_SSH (79)"
 223 An unspecified error occurred during the SSH session.
 224 .IP "CURLE_SSL_SHUTDOWN_FAILED (80)"
 225 Failed to shut down the SSL connection.
 226 .IP "CURLE_AGAIN (81)"
 227 Socket is not ready for send/recv wait till it's ready and try again. This
 228 return code is only returned from \fIcurl_easy_recv(3)\fP and
 229 \fIcurl_easy_send(3)\fP (Added in 7.18.2)
 230 .IP "CURLE_SSL_CRL_BADFILE (82)"
 231 Failed to load CRL file (Added in 7.19.0)
 232 .IP "CURLE_SSL_ISSUER_ERROR (83)"
 233 Issuer check failed (Added in 7.19.0)
 234 .IP "CURLE_FTP_PRET_FAILED (84)"
 235 The FTP server does not understand the PRET command at all or does not support
 236 the given argument. Be careful when using \fICURLOPT_CUSTOMREQUEST(3)\fP, a
 237 custom LIST command will be sent with PRET CMD before PASV as well. (Added in
 238 7.20.0)
 239 .IP "CURLE_RTSP_CSEQ_ERROR (85)"
 240 Mismatch of RTSP CSeq numbers.
 241 .IP "CURLE_RTSP_SESSION_ERROR (86)"
 242 Mismatch of RTSP Session Identifiers.
 243 .IP "CURLE_FTP_BAD_FILE_LIST (87)"
 244 Unable to parse FTP file list (during FTP wildcard downloading).
 245 .IP "CURLE_CHUNK_FAILED (88)"
 246 Chunk callback reported error.
 247 .IP "CURLE_NO_CONNECTION_AVAILABLE (89)"
 248 (For internal use only, will never be returned by libcurl) No connection
 249 available, the session will be queued. (added in 7.30.0)
 250 .IP "CURLE_SSL_PINNEDPUBKEYNOTMATCH (90)"
 251 Failed to match the pinned key specified with \fICURLOPT_PINNEDPUBLICKEY(3)\fP.
 252 .IP "CURLE_SSL_INVALIDCERTSTATUS (91)"
 253 Status returned failure when asked with \fICURLOPT_SSL_VERIFYSTATUS(3)\fP.
 254 .IP "CURLE_OBSOLETE*"
 255 These error codes will never be returned. They were used in an old libcurl
 256 version and are currently unused.
 257 .SH "CURLMcode"
 258 This is the generic return code used by functions in the libcurl multi
 259 interface. Also consider \fIcurl_multi_strerror(3)\fP.
 260 .IP "CURLM_CALL_MULTI_PERFORM (-1)"
 261 This is not really an error. It means you should call
 262 \fIcurl_multi_perform(3)\fP again without doing select() or similar in
 263 between. Before version 7.20.0 this could be returned by
 264 \fIcurl_multi_perform(3)\fP, but in later versions this return code is never
 265 used.
 266 .IP "CURLM_OK (0)"
 267 Things are fine.
 268 .IP "CURLM_BAD_HANDLE (1)"
 269 The passed-in handle is not a valid CURLM handle.
 270 .IP "CURLM_BAD_EASY_HANDLE (2)"
 271 An easy handle was not good/valid. It could mean that it isn't an easy handle
 272 at all, or possibly that the handle already is in used by this or another
 273 multi handle.
 274 .IP "CURLM_OUT_OF_MEMORY (3)"
 275 You are doomed.
 276 .IP "CURLM_INTERNAL_ERROR (4)"
 277 This can only be returned if libcurl bugs. Please report it to us!
 278 .IP "CURLM_BAD_SOCKET (5)"
 279 The passed-in socket is not a valid one that libcurl already knows about.
 280 (Added in 7.15.4)
 281 .IP "CURLM_UNKNOWN_OPTION (6)"
 282 curl_multi_setopt() with unsupported option
 283 (Added in 7.15.4)
 284 .IP "CURLM_ADDED_ALREADY (7)"
 285 An easy handle already added to a multi handle was attempted to get added a
 286 second time. (Added in 7.32.1)
 287 .SH "CURLSHcode"
 288 The "share" interface will return a CURLSHcode to indicate when an error has
 289 occurred.  Also consider \fIcurl_share_strerror(3)\fP.
 290 .IP "CURLSHE_OK (0)"
 291 All fine. Proceed as usual.
 292 .IP "CURLSHE_BAD_OPTION (1)"
 293 An invalid option was passed to the function.
 294 .IP "CURLSHE_IN_USE (2)"
 295 The share object is currently in use.
 296 .IP "CURLSHE_INVALID (3)"
 297 An invalid share object was passed to the function.
 298 .IP "CURLSHE_NOMEM (4)"
 299 Not enough memory was available.
 300 (Added in 7.12.0)
 301 .IP "CURLSHE_NOT_BUILT_IN (5)"
 302 The requested sharing could not be done because the library you use don't have
 303 that particular feature enabled. (Added in 7.23.0)
 304 .SH "SEE ALSO"
 305 .BR curl_easy_strerror "(3), " curl_multi_strerror "(3), "
 306 .BR curl_share_strerror "(3), " CURLOPT_ERRORBUFFER "(3), "
 307 .BR CURLOPT_VERBOSE "(3), " CURLOPT_DEBUGFUNCTION "(3) "