1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 * 'pingpong' is for generic back-and-forth support functions used by FTP,
22 * IMAP, POP3, SMTP and whatever more that likes them.
24 ***************************************************************************/
26 #include "curl_setup.h"
32 #include "speedcheck.h"
35 #include "non-ascii.h"
36 #include "vtls/vtls.h"
38 /* The last 3 #include files should be in this order */
39 #include "curl_printf.h"
40 #include "curl_memory.h"
45 /* Returns timeout in ms. 0 or negative number means the timeout has already
47 time_t Curl_pp_state_timeout(struct pingpong *pp)
49 struct connectdata *conn = pp->conn;
50 struct Curl_easy *data = conn->data;
51 time_t timeout_ms; /* in milliseconds */
52 time_t timeout2_ms; /* in milliseconds */
53 long response_time = (data->set.server_response_timeout)?
54 data->set.server_response_timeout: pp->response_time;
56 /* if CURLOPT_SERVER_RESPONSE_TIMEOUT is set, use that to determine
57 remaining time, or use pp->response because SERVER_RESPONSE_TIMEOUT is
58 supposed to govern the response for any given server response, not for
59 the time from connect to the given server response. */
61 /* Without a requested timeout, we only wait 'response_time' seconds for the
62 full response to arrive before we bail out */
63 timeout_ms = response_time -
64 Curl_timediff(Curl_now(), pp->response); /* spent time */
66 if(data->set.timeout) {
67 /* if timeout is requested, find out how much remaining time we have */
68 timeout2_ms = data->set.timeout - /* timeout time */
69 Curl_timediff(Curl_now(), conn->now); /* spent time */
71 /* pick the lowest number */
72 timeout_ms = CURLMIN(timeout_ms, timeout2_ms);
81 CURLcode Curl_pp_statemach(struct pingpong *pp, bool block)
83 struct connectdata *conn = pp->conn;
84 curl_socket_t sock = conn->sock[FIRSTSOCKET];
87 time_t timeout_ms = Curl_pp_state_timeout(pp);
88 struct Curl_easy *data = conn->data;
89 CURLcode result = CURLE_OK;
92 failf(data, "server response timeout");
93 return CURLE_OPERATION_TIMEDOUT; /* already too little time */
97 interval_ms = 1000; /* use 1 second timeout intervals */
98 if(timeout_ms < interval_ms)
99 interval_ms = timeout_ms;
102 interval_ms = 0; /* immediate */
104 if(Curl_ssl_data_pending(conn, FIRSTSOCKET))
106 else if(Curl_pp_moredata(pp))
107 /* We are receiving and there is data in the cache so just read it */
109 else if(!pp->sendleft && Curl_ssl_data_pending(conn, FIRSTSOCKET))
110 /* We are receiving and there is data ready in the SSL library */
113 rc = Curl_socket_check(pp->sendleft?CURL_SOCKET_BAD:sock, /* reading */
115 pp->sendleft?sock:CURL_SOCKET_BAD, /* writing */
119 /* if we didn't wait, we don't have to spend time on this now */
120 if(Curl_pgrsUpdate(conn))
121 result = CURLE_ABORTED_BY_CALLBACK;
123 result = Curl_speedcheck(data, Curl_now());
130 failf(data, "select/poll error");
131 result = CURLE_OUT_OF_MEMORY;
134 result = pp->statemach_act(conn);
139 /* initialize stuff to prepare for reading a fresh new response */
140 void Curl_pp_init(struct pingpong *pp)
142 struct connectdata *conn = pp->conn;
144 pp->linestart_resp = conn->data->state.buffer;
145 pp->pending_resp = TRUE;
146 pp->response = Curl_now(); /* start response time-out now! */
151 /***********************************************************************
155 * Send the formatted string as a command to a pingpong server. Note that
156 * the string should not have any CRLF appended, as this function will
157 * append the necessary things itself.
159 * made to never block
161 CURLcode Curl_pp_vsendf(struct pingpong *pp,
165 ssize_t bytes_written;
170 struct connectdata *conn = pp->conn;
171 struct Curl_easy *data;
174 enum protection_level data_sec;
177 DEBUGASSERT(pp->sendleft == 0);
178 DEBUGASSERT(pp->sendsize == 0);
179 DEBUGASSERT(pp->sendthis == NULL);
182 /* can't send without a connection! */
183 return CURLE_SEND_ERROR;
187 fmt_crlf = aprintf("%s\r\n", fmt); /* append a trailing CRLF */
189 return CURLE_OUT_OF_MEMORY;
191 s = vaprintf(fmt_crlf, args); /* trailing CRLF appended */
194 return CURLE_OUT_OF_MEMORY;
197 write_len = strlen(s);
201 result = Curl_convert_to_network(data, s, write_len);
202 /* Curl_convert_to_network calls failf if unsuccessful */
209 conn->data_prot = PROT_CMD;
211 result = Curl_write(conn, conn->sock[FIRSTSOCKET], s, write_len,
214 data_sec = conn->data_prot;
215 DEBUGASSERT(data_sec > PROT_NONE && data_sec < PROT_LAST);
216 conn->data_prot = data_sec;
224 if(conn->data->set.verbose)
225 Curl_debug(conn->data, CURLINFO_HEADER_OUT,
226 s, (size_t)bytes_written, conn);
228 if(bytes_written != (ssize_t)write_len) {
229 /* the whole chunk was not sent, keep it around and adjust sizes */
231 pp->sendsize = write_len;
232 pp->sendleft = write_len - bytes_written;
237 pp->sendleft = pp->sendsize = 0;
238 pp->response = Curl_now();
245 /***********************************************************************
249 * Send the formatted string as a command to a pingpong server. Note that
250 * the string should not have any CRLF appended, as this function will
251 * append the necessary things itself.
253 * made to never block
255 CURLcode Curl_pp_sendf(struct pingpong *pp,
256 const char *fmt, ...)
262 result = Curl_pp_vsendf(pp, fmt, ap);
272 * Reads a piece of a server response.
274 CURLcode Curl_pp_readresp(curl_socket_t sockfd,
276 int *code, /* return the server code if done */
277 size_t *size) /* size of the response */
279 ssize_t perline; /* count bytes per line */
283 struct connectdata *conn = pp->conn;
284 struct Curl_easy *data = conn->data;
285 char * const buf = data->state.buffer;
286 CURLcode result = CURLE_OK;
288 *code = 0; /* 0 for errors or not done */
291 ptr = buf + pp->nread_resp;
293 /* number of bytes in the current line, so far */
294 perline = (ssize_t)(ptr-pp->linestart_resp);
296 while((pp->nread_resp < (size_t)data->set.buffer_size) &&
297 (keepon && !result)) {
300 /* we had data in the "cache", copy that instead of doing an actual
303 * pp->cache_size is cast to ssize_t here. This should be safe, because
304 * it would have been populated with something of size int to begin
305 * with, even though its datatype may be larger than an int.
307 DEBUGASSERT((ptr + pp->cache_size) <= (buf + data->set.buffer_size + 1));
308 memcpy(ptr, pp->cache, pp->cache_size);
309 gotbytes = (ssize_t)pp->cache_size;
310 free(pp->cache); /* free the cache */
311 pp->cache = NULL; /* clear the pointer */
312 pp->cache_size = 0; /* zero the size just in case */
316 enum protection_level prot = conn->data_prot;
317 conn->data_prot = PROT_CLEAR;
319 DEBUGASSERT((ptr + data->set.buffer_size - pp->nread_resp) <=
320 (buf + data->set.buffer_size + 1));
321 result = Curl_read(conn, sockfd, ptr,
322 data->set.buffer_size - pp->nread_resp,
325 DEBUGASSERT(prot > PROT_NONE && prot < PROT_LAST);
326 conn->data_prot = prot;
328 if(result == CURLE_AGAIN)
329 return CURLE_OK; /* return */
331 if(!result && (gotbytes > 0))
332 /* convert from the network encoding */
333 result = Curl_convert_from_network(data, ptr, gotbytes);
334 /* Curl_convert_from_network calls failf if unsuccessful */
337 /* Set outer result variable to this error. */
343 else if(gotbytes <= 0) {
345 result = CURLE_RECV_ERROR;
346 failf(data, "response reading failed");
349 /* we got a whole chunk of data, which can be anything from one
350 * byte to a set of lines and possible just a piece of the last
353 ssize_t clipamount = 0;
354 bool restart = FALSE;
356 data->req.headerbytecount += (long)gotbytes;
358 pp->nread_resp += gotbytes;
359 for(i = 0; i < gotbytes; ptr++, i++) {
362 /* a newline is CRLF in pp-talk, so the CR is ignored as
363 the line isn't really terminated until the LF comes */
365 /* output debug output if that is requested */
367 if(!conn->sec_complete)
369 if(data->set.verbose)
370 Curl_debug(data, CURLINFO_HEADER_IN,
371 pp->linestart_resp, (size_t)perline, conn);
374 * We pass all response-lines to the callback function registered
375 * for "headers". The response lines can be seen as a kind of
378 result = Curl_client_write(conn, CLIENTWRITE_HEADER,
379 pp->linestart_resp, perline);
383 if(pp->endofresp(conn, pp->linestart_resp, perline, code)) {
384 /* This is the end of the last line, copy the last line to the
385 start of the buffer and zero terminate, for old times sake */
386 size_t n = ptr - pp->linestart_resp;
387 memmove(buf, pp->linestart_resp, n);
388 buf[n] = 0; /* zero terminate */
390 pp->linestart_resp = ptr + 1; /* advance pointer */
391 i++; /* skip this before getting out */
393 *size = pp->nread_resp; /* size of the response */
394 pp->nread_resp = 0; /* restart */
397 perline = 0; /* line starts over here */
398 pp->linestart_resp = ptr + 1;
402 if(!keepon && (i != gotbytes)) {
403 /* We found the end of the response lines, but we didn't parse the
404 full chunk of data we have read from the server. We therefore need
405 to store the rest of the data to be checked on the next invoke as
406 it may actually contain another end of response already! */
407 clipamount = gotbytes - i;
409 DEBUGF(infof(data, "Curl_pp_readresp_ %d bytes of trailing "
410 "server response left\n",
415 if((perline == gotbytes) && (gotbytes > data->set.buffer_size/2)) {
416 /* We got an excessive line without newlines and we need to deal
417 with it. We keep the first bytes of the line then we throw
419 infof(data, "Excessive server response line length received, "
420 "%zd bytes. Stripping\n", gotbytes);
423 /* we keep 40 bytes since all our pingpong protocols are only
424 interested in the first piece */
427 else if(pp->nread_resp > (size_t)data->set.buffer_size/2) {
428 /* We got a large chunk of data and there's potentially still
429 trailing data to take care of, so we put any such part in the
430 "cache", clear the buffer to make space and restart. */
431 clipamount = perline;
435 else if(i == gotbytes)
439 pp->cache_size = clipamount;
440 pp->cache = malloc(pp->cache_size);
442 memcpy(pp->cache, pp->linestart_resp, pp->cache_size);
444 return CURLE_OUT_OF_MEMORY;
447 /* now reset a few variables to start over nicely from the start of
449 pp->nread_resp = 0; /* start over from scratch in the buffer */
450 ptr = pp->linestart_resp = buf;
454 } /* there was data */
456 } /* while there's buffer left and loop is requested */
458 pp->pending_resp = FALSE;
463 int Curl_pp_getsock(struct pingpong *pp,
464 curl_socket_t *socks,
467 struct connectdata *conn = pp->conn;
470 return GETSOCK_BLANK;
472 socks[0] = conn->sock[FIRSTSOCKET];
476 return GETSOCK_WRITESOCK(0);
480 return GETSOCK_READSOCK(0);
483 CURLcode Curl_pp_flushsend(struct pingpong *pp)
485 /* we have a piece of a command still left to send */
486 struct connectdata *conn = pp->conn;
488 curl_socket_t sock = conn->sock[FIRSTSOCKET];
489 CURLcode result = Curl_write(conn, sock, pp->sendthis + pp->sendsize -
490 pp->sendleft, pp->sendleft, &written);
494 if(written != (ssize_t)pp->sendleft) {
495 /* only a fraction was sent */
496 pp->sendleft -= written;
501 pp->sendleft = pp->sendsize = 0;
502 pp->response = Curl_now();
507 CURLcode Curl_pp_disconnect(struct pingpong *pp)
514 bool Curl_pp_moredata(struct pingpong *pp)
516 return (!pp->sendleft && pp->cache && pp->nread_resp < pp->cache_size) ?