blob: 0fdb6d39acfe8f49d4a7eb2e74c00641ce1b52b2 [file] [log] [blame]
Alexander Graf769ce762009-05-11 17:41:42 +02001/*
2 * QEMU Block driver for CURL images
3 *
4 * Copyright (c) 2009 Alexander Graf <agraf@suse.de>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010026#include "qapi/error.h"
Richard W.M. Jones796a0602015-07-08 14:37:48 +010027#include "qemu/error-report.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020028#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010029#include "qemu/option.h"
Markus Armbrustere2c1c342022-12-21 14:35:49 +010030#include "block/block-io.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010031#include "block/block_int.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010032#include "qapi/qmp/qdict.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010033#include "qapi/qmp/qstring.h"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000034#include "crypto/secret.h"
Alexander Graf769ce762009-05-11 17:41:42 +020035#include <curl/curl.h>
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020036#include "qemu/cutils.h"
Laurent Viviered2a66d2018-12-13 17:27:25 +010037#include "trace.h"
Alexander Graf769ce762009-05-11 17:41:42 +020038
Alexander Graf769ce762009-05-11 17:41:42 +020039// #define DEBUG_VERBOSE
40
Anton Johanssone7b8d9d2023-01-23 21:14:31 +010041/* CURL 7.85.0 switches to a string based API for specifying
42 * the desired protocols.
43 */
44#if LIBCURL_VERSION_NUM >= 0x075500
45#define PROTOCOLS "HTTP,HTTPS,FTP,FTPS"
46#else
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010047#define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
Max Reitz23dce382016-11-02 18:55:37 +010048 CURLPROTO_FTP | CURLPROTO_FTPS)
Anton Johanssone7b8d9d2023-01-23 21:14:31 +010049#endif
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010050
Alexander Graf769ce762009-05-11 17:41:42 +020051#define CURL_NUM_STATES 8
52#define CURL_NUM_ACB 8
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +000053#define CURL_TIMEOUT_MAX 10000
Alexander Graf769ce762009-05-11 17:41:42 +020054
Matthew Boothe3542c62014-05-14 19:28:41 -040055#define CURL_BLOCK_OPT_URL "url"
56#define CURL_BLOCK_OPT_READAHEAD "readahead"
Matthew Booth97a3ea52014-05-14 19:28:42 -040057#define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -030058#define CURL_BLOCK_OPT_TIMEOUT "timeout"
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +010059#define CURL_BLOCK_OPT_COOKIE "cookie"
Peter Krempa327c8eb2017-05-04 16:00:06 +020060#define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000061#define CURL_BLOCK_OPT_USERNAME "username"
62#define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
63#define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
64#define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
Matthew Boothe3542c62014-05-14 19:28:41 -040065
Max Reitz712b64e2019-02-01 20:29:31 +010066#define CURL_BLOCK_OPT_READAHEAD_DEFAULT (256 * 1024)
67#define CURL_BLOCK_OPT_SSLVERIFY_DEFAULT true
68#define CURL_BLOCK_OPT_TIMEOUT_DEFAULT 5
69
Alexander Graf769ce762009-05-11 17:41:42 +020070struct BDRVCURLState;
Max Reitz04878612019-09-10 14:41:30 +020071struct CURLState;
Alexander Graf769ce762009-05-11 17:41:42 +020072
Jeff Cody2d259642017-11-07 17:27:22 -050073static bool libcurl_initialized;
74
Alexander Graf769ce762009-05-11 17:41:42 +020075typedef struct CURLAIOCB {
Paolo Bonzini28256d82017-05-15 12:00:58 +020076 Coroutine *co;
Alexander Graf769ce762009-05-11 17:41:42 +020077 QEMUIOVector *qiov;
Nick Thomas363c3c82011-09-21 11:55:50 +010078
Paolo Bonzini2125e5e2017-05-15 12:00:57 +020079 uint64_t offset;
80 uint64_t bytes;
Paolo Bonzini28256d82017-05-15 12:00:58 +020081 int ret;
Nick Thomas363c3c82011-09-21 11:55:50 +010082
Alexander Graf769ce762009-05-11 17:41:42 +020083 size_t start;
84 size_t end;
85} CURLAIOCB;
86
Max Reitzff5ca162016-10-25 04:54:30 +020087typedef struct CURLSocket {
88 int fd;
Max Reitz3663dca2021-03-09 14:05:40 +010089 struct BDRVCURLState *s;
Max Reitzff5ca162016-10-25 04:54:30 +020090} CURLSocket;
91
Alexander Graf769ce762009-05-11 17:41:42 +020092typedef struct CURLState
93{
94 struct BDRVCURLState *s;
95 CURLAIOCB *acb[CURL_NUM_ACB];
96 CURL *curl;
97 char *orig_buf;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +020098 uint64_t buf_start;
Alexander Graf769ce762009-05-11 17:41:42 +020099 size_t buf_off;
100 size_t buf_len;
101 char range[128];
102 char errmsg[CURL_ERROR_SIZE];
103 char in_use;
104} CURLState;
105
106typedef struct BDRVCURLState {
107 CURLM *multi;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100108 QEMUTimer timer;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200109 uint64_t len;
Alexander Graf769ce762009-05-11 17:41:42 +0200110 CURLState states[CURL_NUM_STATES];
Max Reitz0f418a22021-03-09 14:05:41 +0100111 GHashTable *sockets; /* GINT_TO_POINTER(fd) -> socket */
Alexander Graf769ce762009-05-11 17:41:42 +0200112 char *url;
Nolanc76f4952009-07-01 17:16:52 -0700113 size_t readahead_size;
Matthew Booth97a3ea52014-05-14 19:28:42 -0400114 bool sslverify;
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000115 uint64_t timeout;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100116 char *cookie;
Fam Zheng3494d652013-07-02 15:19:21 +0800117 bool accept_range;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200118 AioContext *aio_context;
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100119 QemuMutex mutex;
Paolo Bonzini709f2132018-02-03 10:39:35 -0500120 CoQueue free_state_waitq;
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000121 char *username;
122 char *password;
123 char *proxyusername;
124 char *proxypassword;
Alexander Graf769ce762009-05-11 17:41:42 +0200125} BDRVCURLState;
126
127static void curl_clean_state(CURLState *s);
128static void curl_multi_do(void *arg);
129
Max Reitz0f418a22021-03-09 14:05:41 +0100130static gboolean curl_drop_socket(void *key, void *value, void *opaque)
131{
132 CURLSocket *socket = value;
133 BDRVCURLState *s = socket->s;
134
Stefan Hajnoczi60f782b2023-05-16 15:02:38 -0400135 aio_set_fd_handler(s->aio_context, socket->fd,
Stefan Hajnoczi826cc322021-12-07 13:23:31 +0000136 NULL, NULL, NULL, NULL, NULL);
Max Reitz0f418a22021-03-09 14:05:41 +0100137 return true;
138}
139
140static void curl_drop_all_sockets(GHashTable *sockets)
141{
142 g_hash_table_foreach_remove(sockets, curl_drop_socket, NULL);
143}
144
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200145/* Called from curl_multi_do_locked, with s->mutex held. */
Peter Maydell031fd1b2014-01-24 14:56:17 +0100146static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
147{
148 BDRVCURLState *s = opaque;
149
Laurent Viviered2a66d2018-12-13 17:27:25 +0100150 trace_curl_timer_cb(timeout_ms);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100151 if (timeout_ms == -1) {
152 timer_del(&s->timer);
153 } else {
154 int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
155 timer_mod(&s->timer,
156 qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
157 }
158 return 0;
159}
Peter Maydell031fd1b2014-01-24 14:56:17 +0100160
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200161/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200162static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200163 void *userp, void *sp)
Alexander Graf769ce762009-05-11 17:41:42 +0200164{
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200165 BDRVCURLState *s;
Matthew Booth838ef602014-04-29 16:03:30 +0100166 CURLState *state = NULL;
Max Reitzff5ca162016-10-25 04:54:30 +0200167 CURLSocket *socket;
168
Matthew Booth838ef602014-04-29 16:03:30 +0100169 curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200170 s = state->s;
Matthew Booth838ef602014-04-29 16:03:30 +0100171
Max Reitz0f418a22021-03-09 14:05:41 +0100172 socket = g_hash_table_lookup(s->sockets, GINT_TO_POINTER(fd));
Max Reitzff5ca162016-10-25 04:54:30 +0200173 if (!socket) {
174 socket = g_new0(CURLSocket, 1);
175 socket->fd = fd;
Max Reitz3663dca2021-03-09 14:05:40 +0100176 socket->s = s;
Max Reitz0f418a22021-03-09 14:05:41 +0100177 g_hash_table_insert(s->sockets, GINT_TO_POINTER(fd), socket);
Max Reitzff5ca162016-10-25 04:54:30 +0200178 }
Max Reitzff5ca162016-10-25 04:54:30 +0200179
Laurent Viviered2a66d2018-12-13 17:27:25 +0100180 trace_curl_sock_cb(action, (int)fd);
Alexander Graf769ce762009-05-11 17:41:42 +0200181 switch (action) {
182 case CURL_POLL_IN:
Stefan Hajnoczi60f782b2023-05-16 15:02:38 -0400183 aio_set_fd_handler(s->aio_context, fd,
Stefan Hajnoczi826cc322021-12-07 13:23:31 +0000184 curl_multi_do, NULL, NULL, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200185 break;
186 case CURL_POLL_OUT:
Stefan Hajnoczi60f782b2023-05-16 15:02:38 -0400187 aio_set_fd_handler(s->aio_context, fd,
Stefan Hajnoczi826cc322021-12-07 13:23:31 +0000188 NULL, curl_multi_do, NULL, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200189 break;
190 case CURL_POLL_INOUT:
Stefan Hajnoczi60f782b2023-05-16 15:02:38 -0400191 aio_set_fd_handler(s->aio_context, fd,
Stefan Hajnoczi826cc322021-12-07 13:23:31 +0000192 curl_multi_do, curl_multi_do,
193 NULL, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200194 break;
195 case CURL_POLL_REMOVE:
Stefan Hajnoczi60f782b2023-05-16 15:02:38 -0400196 aio_set_fd_handler(s->aio_context, fd,
Stefan Hajnoczi826cc322021-12-07 13:23:31 +0000197 NULL, NULL, NULL, NULL, NULL);
Alexander Graf769ce762009-05-11 17:41:42 +0200198 break;
199 }
200
Max Reitz007f3392019-09-10 14:41:31 +0200201 if (action == CURL_POLL_REMOVE) {
Max Reitz0f418a22021-03-09 14:05:41 +0100202 g_hash_table_remove(s->sockets, GINT_TO_POINTER(fd));
Max Reitz007f3392019-09-10 14:41:31 +0200203 }
204
Alexander Graf769ce762009-05-11 17:41:42 +0200205 return 0;
206}
207
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200208/* Called from curl_multi_do_locked, with s->mutex held. */
Fam Zheng3494d652013-07-02 15:19:21 +0800209static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
Alexander Graf769ce762009-05-11 17:41:42 +0200210{
Fam Zheng3494d652013-07-02 15:19:21 +0800211 BDRVCURLState *s = opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200212 size_t realsize = size * nmemb;
Michael Tokarev2abc22e2024-06-29 16:27:00 +0300213 const char *p = ptr;
214 const char *end = p + realsize;
215 const char *t = "accept-ranges : bytes "; /* A lowercase template */
Alexander Graf769ce762009-05-11 17:41:42 +0200216
Michael Tokarev2abc22e2024-06-29 16:27:00 +0300217 /* check if header matches the "t" template */
218 for (;;) {
219 if (*t == ' ') { /* space in t matches any amount of isspace in p */
220 if (p < end && g_ascii_isspace(*p)) {
221 ++p;
222 } else {
223 ++t;
David Edmondson7788a312020-02-24 10:13:09 +0000224 }
Michael Tokarev2abc22e2024-06-29 16:27:00 +0300225 } else if (*t && p < end && *t == g_ascii_tolower(*p)) {
226 ++p, ++t;
227 } else {
228 break;
David Edmondson7788a312020-02-24 10:13:09 +0000229 }
Blue Swirl0bfcd592010-05-22 08:02:12 +0000230 }
Alexander Graf769ce762009-05-11 17:41:42 +0200231
Michael Tokarev2abc22e2024-06-29 16:27:00 +0300232 if (!*t && p == end) { /* if we managed to reach ends of both strings */
233 s->accept_range = true;
234 }
235
Alexander Graf769ce762009-05-11 17:41:42 +0200236 return realsize;
237}
238
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200239/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200240static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
241{
242 CURLState *s = ((CURLState*)opaque);
243 size_t realsize = size * nmemb;
Alexander Graf769ce762009-05-11 17:41:42 +0200244
Laurent Viviered2a66d2018-12-13 17:27:25 +0100245 trace_curl_read_cb(realsize);
Alexander Graf769ce762009-05-11 17:41:42 +0200246
Max Reitz4e767652016-10-25 04:54:29 +0200247 if (!s || !s->orig_buf) {
248 goto read_end;
249 }
Alexander Graf769ce762009-05-11 17:41:42 +0200250
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100251 if (s->buf_off >= s->buf_len) {
252 /* buffer full, read nothing */
Max Reitz4e767652016-10-25 04:54:29 +0200253 goto read_end;
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100254 }
255 realsize = MIN(realsize, s->buf_len - s->buf_off);
Alexander Graf769ce762009-05-11 17:41:42 +0200256 memcpy(s->orig_buf + s->buf_off, ptr, realsize);
257 s->buf_off += realsize;
258
Max Reitz4e767652016-10-25 04:54:29 +0200259read_end:
260 /* curl will error out if we do not return this value */
261 return size * nmemb;
Alexander Graf769ce762009-05-11 17:41:42 +0200262}
263
Paolo Bonzini456af342017-05-15 12:00:55 +0200264/* Called with s->mutex held. */
Paolo Bonzini28256d82017-05-15 12:00:58 +0200265static bool curl_find_buf(BDRVCURLState *s, uint64_t start, uint64_t len,
266 CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200267{
268 int i;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200269 uint64_t end = start + len;
270 uint64_t clamped_end = MIN(end, s->len);
271 uint64_t clamped_len = clamped_end - start;
Alexander Graf769ce762009-05-11 17:41:42 +0200272
273 for (i=0; i<CURL_NUM_STATES; i++) {
274 CURLState *state = &s->states[i];
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200275 uint64_t buf_end = (state->buf_start + state->buf_off);
276 uint64_t buf_fend = (state->buf_start + state->buf_len);
Alexander Graf769ce762009-05-11 17:41:42 +0200277
278 if (!state->orig_buf)
279 continue;
280 if (!state->buf_off)
281 continue;
282
283 // Does the existing buffer cover our section?
284 if ((start >= state->buf_start) &&
285 (start <= buf_end) &&
Max Reitz4e504532016-10-25 04:54:31 +0200286 (clamped_end >= state->buf_start) &&
287 (clamped_end <= buf_end))
Alexander Graf769ce762009-05-11 17:41:42 +0200288 {
289 char *buf = state->orig_buf + (start - state->buf_start);
290
Max Reitz4e504532016-10-25 04:54:31 +0200291 qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
292 if (clamped_len < len) {
293 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
294 }
Paolo Bonzini28256d82017-05-15 12:00:58 +0200295 acb->ret = 0;
296 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200297 }
298
299 // Wait for unfinished chunks
Matthew Boothb7079df2014-04-29 16:03:32 +0100300 if (state->in_use &&
301 (start >= state->buf_start) &&
Alexander Graf769ce762009-05-11 17:41:42 +0200302 (start <= buf_fend) &&
Max Reitz4e504532016-10-25 04:54:31 +0200303 (clamped_end >= state->buf_start) &&
304 (clamped_end <= buf_fend))
Alexander Graf769ce762009-05-11 17:41:42 +0200305 {
306 int j;
307
308 acb->start = start - state->buf_start;
Max Reitz4e504532016-10-25 04:54:31 +0200309 acb->end = acb->start + clamped_len;
Alexander Graf769ce762009-05-11 17:41:42 +0200310
311 for (j=0; j<CURL_NUM_ACB; j++) {
312 if (!state->acb[j]) {
313 state->acb[j] = acb;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200314 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200315 }
316 }
317 }
318 }
319
Paolo Bonzini28256d82017-05-15 12:00:58 +0200320 return false;
Alexander Graf769ce762009-05-11 17:41:42 +0200321}
322
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100323/* Called with s->mutex held. */
Matthew Booth838ef602014-04-29 16:03:30 +0100324static void curl_multi_check_completion(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200325{
Alexander Graf769ce762009-05-11 17:41:42 +0200326 int msgs_in_queue;
327
Alexander Graf769ce762009-05-11 17:41:42 +0200328 /* Try to find done transfers, so we can free the easy
329 * handle again. */
Matthew Booth1f2cead2014-04-29 16:03:31 +0100330 for (;;) {
Alexander Graf769ce762009-05-11 17:41:42 +0200331 CURLMsg *msg;
332 msg = curl_multi_info_read(s->multi, &msgs_in_queue);
333
Matthew Booth1f2cead2014-04-29 16:03:31 +0100334 /* Quit when there are no more completions */
Alexander Graf769ce762009-05-11 17:41:42 +0200335 if (!msg)
336 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200337
Matthew Booth1f2cead2014-04-29 16:03:31 +0100338 if (msg->msg == CURLMSG_DONE) {
Max Reitzbfb23b42019-09-10 14:41:35 +0200339 int i;
Matthew Booth1f2cead2014-04-29 16:03:31 +0100340 CURLState *state = NULL;
Max Reitzbfb23b42019-09-10 14:41:35 +0200341 bool error = msg->data.result != CURLE_OK;
342
Matthew Booth1f2cead2014-04-29 16:03:31 +0100343 curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
344 (char **)&state);
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100345
Max Reitzbfb23b42019-09-10 14:41:35 +0200346 if (error) {
Richard W.M. Jones796a0602015-07-08 14:37:48 +0100347 static int errcount = 100;
348
349 /* Don't lose the original error message from curl, since
350 * it contains extra data.
351 */
352 if (errcount > 0) {
353 error_report("curl: %s", state->errmsg);
354 if (--errcount == 0) {
355 error_report("curl: further errors suppressed");
356 }
357 }
Max Reitzbfb23b42019-09-10 14:41:35 +0200358 }
Richard W.M. Jones796a0602015-07-08 14:37:48 +0100359
Max Reitzbfb23b42019-09-10 14:41:35 +0200360 for (i = 0; i < CURL_NUM_ACB; i++) {
361 CURLAIOCB *acb = state->acb[i];
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100362
Max Reitzbfb23b42019-09-10 14:41:35 +0200363 if (acb == NULL) {
364 continue;
Matthew Booth1f2cead2014-04-29 16:03:31 +0100365 }
Max Reitzbfb23b42019-09-10 14:41:35 +0200366
367 if (!error) {
368 /* Assert that we have read all data */
369 assert(state->buf_off >= acb->end);
370
371 qemu_iovec_from_buf(acb->qiov, 0,
372 state->orig_buf + acb->start,
373 acb->end - acb->start);
374
375 if (acb->end - acb->start < acb->bytes) {
376 size_t offset = acb->end - acb->start;
377 qemu_iovec_memset(acb->qiov, offset, 0,
378 acb->bytes - offset);
379 }
380 }
381
382 acb->ret = error ? -EIO : 0;
383 state->acb[i] = NULL;
384 qemu_mutex_unlock(&s->mutex);
385 aio_co_wake(acb->co);
386 qemu_mutex_lock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200387 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100388
389 curl_clean_state(state);
390 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200391 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100392 }
Alexander Graf769ce762009-05-11 17:41:42 +0200393}
394
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100395/* Called with s->mutex held. */
Max Reitz9abaf9f2019-09-10 14:41:34 +0200396static void curl_multi_do_locked(CURLSocket *socket)
Peter Maydell031fd1b2014-01-24 14:56:17 +0100397{
Max Reitz3663dca2021-03-09 14:05:40 +0100398 BDRVCURLState *s = socket->s;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100399 int running;
400 int r;
401
Max Reitz9abaf9f2019-09-10 14:41:34 +0200402 if (!s->multi) {
Peter Maydell031fd1b2014-01-24 14:56:17 +0100403 return;
404 }
405
Max Reitz9abaf9f2019-09-10 14:41:34 +0200406 do {
407 r = curl_multi_socket_action(s->multi, socket->fd, 0, &running);
408 } while (r == CURLM_CALL_MULTI_PERFORM);
Matthew Booth838ef602014-04-29 16:03:30 +0100409}
410
Paolo Bonzini9d456652017-02-13 14:52:30 +0100411static void curl_multi_do(void *arg)
412{
Max Reitz9dbad872019-09-10 14:41:33 +0200413 CURLSocket *socket = arg;
Max Reitz3663dca2021-03-09 14:05:40 +0100414 BDRVCURLState *s = socket->s;
Paolo Bonzini9d456652017-02-13 14:52:30 +0100415
Max Reitz9dbad872019-09-10 14:41:33 +0200416 qemu_mutex_lock(&s->mutex);
417 curl_multi_do_locked(socket);
418 curl_multi_check_completion(s);
419 qemu_mutex_unlock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100420}
421
422static void curl_multi_timeout_do(void *arg)
423{
Peter Maydell031fd1b2014-01-24 14:56:17 +0100424 BDRVCURLState *s = (BDRVCURLState *)arg;
425 int running;
426
427 if (!s->multi) {
428 return;
429 }
430
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100431 qemu_mutex_lock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100432 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
433
Matthew Booth838ef602014-04-29 16:03:30 +0100434 curl_multi_check_completion(s);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100435 qemu_mutex_unlock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100436}
437
Paolo Bonzini456af342017-05-15 12:00:55 +0200438/* Called with s->mutex held. */
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200439static CURLState *curl_find_state(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200440{
441 CURLState *state = NULL;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200442 int i;
Alexander Graf769ce762009-05-11 17:41:42 +0200443
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200444 for (i = 0; i < CURL_NUM_STATES; i++) {
445 if (!s->states[i].in_use) {
Alexander Graf769ce762009-05-11 17:41:42 +0200446 state = &s->states[i];
447 state->in_use = 1;
448 break;
449 }
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200450 }
451 return state;
452}
Alexander Graf769ce762009-05-11 17:41:42 +0200453
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200454static int curl_init_state(BDRVCURLState *s, CURLState *state)
455{
Matthew Booth9e550b32014-04-29 16:03:26 +0100456 if (!state->curl) {
457 state->curl = curl_easy_init();
458 if (!state->curl) {
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200459 return -EIO;
Matthew Booth9e550b32014-04-29 16:03:26 +0100460 }
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000461 if (curl_easy_setopt(state->curl, CURLOPT_URL, s->url) ||
462 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
463 (long) s->sslverify) ||
464 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYHOST,
465 s->sslverify ? 2L : 0L)) {
466 goto err;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100467 }
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000468 if (s->cookie) {
469 if (curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie)) {
470 goto err;
471 }
472 }
473 if (curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout) ||
474 curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
475 (void *)curl_read_cb) ||
476 curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state) ||
477 curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state) ||
478 curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1) ||
479 curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1) ||
480 curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1) ||
481 curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg) ||
482 curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1)) {
483 goto err;
484 }
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000485 if (s->username) {
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000486 if (curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username)) {
487 goto err;
488 }
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000489 }
490 if (s->password) {
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000491 if (curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password)) {
492 goto err;
493 }
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000494 }
495 if (s->proxyusername) {
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000496 if (curl_easy_setopt(state->curl,
497 CURLOPT_PROXYUSERNAME, s->proxyusername)) {
498 goto err;
499 }
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000500 }
501 if (s->proxypassword) {
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000502 if (curl_easy_setopt(state->curl,
503 CURLOPT_PROXYPASSWORD, s->proxypassword)) {
504 goto err;
505 }
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000506 }
507
Matthew Booth9e550b32014-04-29 16:03:26 +0100508 /* Restrict supported protocols to avoid security issues in the more
509 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
510 * CVE-2013-0249.
511 *
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100512 * Restricting protocols is only supported from 7.19.4 upwards. Note:
513 * version 7.85.0 deprecates CURLOPT_*PROTOCOLS in favour of a string
514 * based CURLOPT_*PROTOCOLS_STR API.
Matthew Booth9e550b32014-04-29 16:03:26 +0100515 */
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100516#if LIBCURL_VERSION_NUM >= 0x075500
517 if (curl_easy_setopt(state->curl,
518 CURLOPT_PROTOCOLS_STR, PROTOCOLS) ||
519 curl_easy_setopt(state->curl,
520 CURLOPT_REDIR_PROTOCOLS_STR, PROTOCOLS)) {
521 goto err;
522 }
523#elif LIBCURL_VERSION_NUM >= 0x071304
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000524 if (curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS) ||
525 curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS)) {
526 goto err;
527 }
Stefan Hajnoczi8a8f5842013-02-13 09:25:34 +0100528#endif
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +0100529
Alexander Graf769ce762009-05-11 17:41:42 +0200530#ifdef DEBUG_VERBOSE
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000531 if (curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1)) {
532 goto err;
533 }
Alexander Graf769ce762009-05-11 17:41:42 +0200534#endif
Matthew Booth9e550b32014-04-29 16:03:26 +0100535 }
Alexander Graf769ce762009-05-11 17:41:42 +0200536
537 state->s = s;
538
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200539 return 0;
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000540
541err:
542 curl_easy_cleanup(state->curl);
543 state->curl = NULL;
544 return -EIO;
Alexander Graf769ce762009-05-11 17:41:42 +0200545}
546
Paolo Bonzini456af342017-05-15 12:00:55 +0200547/* Called with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200548static void curl_clean_state(CURLState *s)
549{
Paolo Bonzini675a7752017-05-15 12:00:53 +0200550 int j;
551 for (j = 0; j < CURL_NUM_ACB; j++) {
552 assert(!s->acb[j]);
553 }
554
Alexander Graf769ce762009-05-11 17:41:42 +0200555 if (s->s->multi)
556 curl_multi_remove_handle(s->s->multi, s->curl);
Max Reitzff5ca162016-10-25 04:54:30 +0200557
Alexander Graf769ce762009-05-11 17:41:42 +0200558 s->in_use = 0;
Paolo Bonzini2bb5c932017-05-15 12:00:59 +0200559
Paolo Bonzini709f2132018-02-03 10:39:35 -0500560 qemu_co_enter_next(&s->s->free_state_waitq, &s->s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200561}
562
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200563static void curl_parse_filename(const char *filename, QDict *options,
564 Error **errp)
Alexander Graf769ce762009-05-11 17:41:42 +0200565{
Eric Blake46f5ac22017-04-27 16:58:17 -0500566 qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200567}
568
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200569static void curl_detach_aio_context(BlockDriverState *bs)
570{
571 BDRVCURLState *s = bs->opaque;
572 int i;
573
Gan Qixinf5056b72020-12-03 15:50:53 +0800574 WITH_QEMU_LOCK_GUARD(&s->mutex) {
Max Reitz0f418a22021-03-09 14:05:41 +0100575 curl_drop_all_sockets(s->sockets);
Gan Qixinf5056b72020-12-03 15:50:53 +0800576 for (i = 0; i < CURL_NUM_STATES; i++) {
577 if (s->states[i].in_use) {
578 curl_clean_state(&s->states[i]);
579 }
580 if (s->states[i].curl) {
581 curl_easy_cleanup(s->states[i].curl);
582 s->states[i].curl = NULL;
583 }
584 g_free(s->states[i].orig_buf);
585 s->states[i].orig_buf = NULL;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200586 }
Gan Qixinf5056b72020-12-03 15:50:53 +0800587 if (s->multi) {
588 curl_multi_cleanup(s->multi);
589 s->multi = NULL;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200590 }
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200591 }
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200592
593 timer_del(&s->timer);
594}
595
596static void curl_attach_aio_context(BlockDriverState *bs,
597 AioContext *new_context)
598{
599 BDRVCURLState *s = bs->opaque;
600
601 aio_timer_init(new_context, &s->timer,
602 QEMU_CLOCK_REALTIME, SCALE_NS,
603 curl_multi_timeout_do, s);
604
605 assert(!s->multi);
606 s->multi = curl_multi_init();
607 s->aio_context = new_context;
608 curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200609 curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
610 curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200611}
612
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200613static QemuOptsList runtime_opts = {
614 .name = "curl",
615 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
616 .desc = {
617 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400618 .name = CURL_BLOCK_OPT_URL,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200619 .type = QEMU_OPT_STRING,
620 .help = "URL to open",
621 },
622 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400623 .name = CURL_BLOCK_OPT_READAHEAD,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200624 .type = QEMU_OPT_SIZE,
625 .help = "Readahead size",
626 },
Matthew Booth97a3ea52014-05-14 19:28:42 -0400627 {
628 .name = CURL_BLOCK_OPT_SSLVERIFY,
629 .type = QEMU_OPT_BOOL,
630 .help = "Verify SSL certificate"
631 },
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300632 {
633 .name = CURL_BLOCK_OPT_TIMEOUT,
634 .type = QEMU_OPT_NUMBER,
635 .help = "Curl timeout"
636 },
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100637 {
638 .name = CURL_BLOCK_OPT_COOKIE,
639 .type = QEMU_OPT_STRING,
640 .help = "Pass the cookie or list of cookies with each request"
641 },
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000642 {
Peter Krempa327c8eb2017-05-04 16:00:06 +0200643 .name = CURL_BLOCK_OPT_COOKIE_SECRET,
644 .type = QEMU_OPT_STRING,
645 .help = "ID of secret used as cookie passed with each request"
646 },
647 {
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000648 .name = CURL_BLOCK_OPT_USERNAME,
649 .type = QEMU_OPT_STRING,
650 .help = "Username for HTTP auth"
651 },
652 {
653 .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
654 .type = QEMU_OPT_STRING,
655 .help = "ID of secret used as password for HTTP auth",
656 },
657 {
658 .name = CURL_BLOCK_OPT_PROXY_USERNAME,
659 .type = QEMU_OPT_STRING,
660 .help = "Username for HTTP proxy auth"
661 },
662 {
663 .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
664 .type = QEMU_OPT_STRING,
665 .help = "ID of secret used as password for HTTP proxy auth",
666 },
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200667 { /* end of list */ }
668 },
669};
670
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000671
Max Reitz015a1032013-09-05 14:22:29 +0200672static int curl_open(BlockDriverState *bs, QDict *options, int flags,
673 Error **errp)
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200674{
675 BDRVCURLState *s = bs->opaque;
676 CURLState *state = NULL;
677 QemuOpts *opts;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200678 const char *file;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100679 const char *cookie;
Peter Krempa327c8eb2017-05-04 16:00:06 +0200680 const char *cookie_secret;
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100681 /* CURL >= 7.55.0 uses curl_off_t for content length instead of a double */
682#if LIBCURL_VERSION_NUM >= 0x073700
683 curl_off_t cl;
684#else
685 double cl;
686#endif
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000687 const char *secretid;
Max Reitz34634ca2017-03-31 14:04:31 +0200688 const char *protocol_delimiter;
Jeff Cody2d259642017-11-07 17:27:22 -0500689 int ret;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200690
Kevin Wolf018f9de2023-09-29 16:51:53 +0200691 bdrv_graph_rdlock_main_loop();
Kevin Wolf6ceef362018-10-08 17:27:18 +0200692 ret = bdrv_apply_auto_read_only(bs, "curl driver does not support writes",
693 errp);
Kevin Wolf018f9de2023-09-29 16:51:53 +0200694 bdrv_graph_rdunlock_main_loop();
Kevin Wolf6ceef362018-10-08 17:27:18 +0200695 if (ret < 0) {
696 return ret;
Richard W.M. Jonesa7cea2b2013-06-10 12:38:43 +0100697 }
698
Jeff Cody2d259642017-11-07 17:27:22 -0500699 if (!libcurl_initialized) {
700 ret = curl_global_init(CURL_GLOBAL_ALL);
701 if (ret) {
702 error_setg(errp, "libcurl initialization failed with %d", ret);
703 return -EIO;
704 }
705 libcurl_initialized = true;
706 }
707
Paolo Bonzini456af342017-05-15 12:00:55 +0200708 qemu_mutex_init(&s->mutex);
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800709 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
Markus Armbruster668f62e2020-07-07 18:06:02 +0200710 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200711 goto out_noclean;
712 }
713
Matthew Boothe3542c62014-05-14 19:28:41 -0400714 s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
Max Reitz712b64e2019-02-01 20:29:31 +0100715 CURL_BLOCK_OPT_READAHEAD_DEFAULT);
Nolanc76f4952009-07-01 17:16:52 -0700716 if ((s->readahead_size & 0x1ff) != 0) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100717 error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
718 s->readahead_size);
Nolanc76f4952009-07-01 17:16:52 -0700719 goto out_noclean;
720 }
721
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300722 s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
Max Reitz712b64e2019-02-01 20:29:31 +0100723 CURL_BLOCK_OPT_TIMEOUT_DEFAULT);
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000724 if (s->timeout > CURL_TIMEOUT_MAX) {
725 error_setg(errp, "timeout parameter is too large or negative");
726 goto out_noclean;
727 }
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300728
Max Reitz712b64e2019-02-01 20:29:31 +0100729 s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY,
730 CURL_BLOCK_OPT_SSLVERIFY_DEFAULT);
Matthew Booth97a3ea52014-05-14 19:28:42 -0400731
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100732 cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
Peter Krempa327c8eb2017-05-04 16:00:06 +0200733 cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
734
735 if (cookie && cookie_secret) {
736 error_setg(errp,
737 "curl driver cannot handle both cookie and cookie secret");
738 goto out_noclean;
739 }
740
741 if (cookie_secret) {
742 s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
743 if (!s->cookie) {
744 goto out_noclean;
745 }
746 } else {
747 s->cookie = g_strdup(cookie);
748 }
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100749
Matthew Boothe3542c62014-05-14 19:28:41 -0400750 file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200751 if (file == NULL) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100752 error_setg(errp, "curl block driver requires an 'url' option");
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200753 goto out_noclean;
754 }
755
Max Reitz34634ca2017-03-31 14:04:31 +0200756 if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
757 !strstart(protocol_delimiter, "://", NULL))
758 {
759 error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
760 "start with '%s://')", bs->drv->protocol_name, file,
761 bs->drv->protocol_name);
762 goto out_noclean;
763 }
764
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000765 s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
766 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
767
768 if (secretid) {
769 s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
770 if (!s->password) {
771 goto out_noclean;
772 }
773 }
774
775 s->proxyusername = g_strdup(
776 qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
777 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
778 if (secretid) {
779 s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
780 if (!s->proxypassword) {
781 goto out_noclean;
782 }
783 }
784
Laurent Viviered2a66d2018-12-13 17:27:25 +0100785 trace_curl_open(file);
Paolo Bonzini709f2132018-02-03 10:39:35 -0500786 qemu_co_queue_init(&s->free_state_waitq);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200787 s->aio_context = bdrv_get_aio_context(bs);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200788 s->url = g_strdup(file);
Max Reitz0f418a22021-03-09 14:05:41 +0100789 s->sockets = g_hash_table_new_full(NULL, NULL, NULL, g_free);
Paolo Bonzini456af342017-05-15 12:00:55 +0200790 qemu_mutex_lock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200791 state = curl_find_state(s);
Paolo Bonzini456af342017-05-15 12:00:55 +0200792 qemu_mutex_unlock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200793 if (!state) {
Alexander Graf769ce762009-05-11 17:41:42 +0200794 goto out_noclean;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200795 }
Alexander Graf769ce762009-05-11 17:41:42 +0200796
797 // Get file size
798
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200799 if (curl_init_state(s, state) < 0) {
Peter Maydell2ea7dfc2022-02-22 15:23:40 +0000800 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
801 "curl library initialization failed.");
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200802 goto out;
803 }
804
Fam Zheng3494d652013-07-02 15:19:21 +0800805 s->accept_range = false;
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000806 if (curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1) ||
807 curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION, curl_header_cb) ||
808 curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s)) {
809 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
810 "curl library initialization failed.");
811 goto out;
812 }
Alexander Graf769ce762009-05-11 17:41:42 +0200813 if (curl_easy_perform(state->curl))
814 goto out;
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100815 /* CURL 7.55.0 deprecates CURLINFO_CONTENT_LENGTH_DOWNLOAD in favour of
816 * the *_T version which returns a more sensible type for content length.
817 */
818#if LIBCURL_VERSION_NUM >= 0x073700
819 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &cl)) {
Alexander Graf769ce762009-05-11 17:41:42 +0200820 goto out;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200821 }
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100822#else
823 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &cl)) {
824 goto out;
825 }
826#endif
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200827 /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
828 * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
Stefan Weil50d6a8a2018-07-12 21:51:20 +0200829 * known and zero if it is really zero-length file. */
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200830#if LIBCURL_VERSION_NUM >= 0x071304
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100831 if (cl < 0) {
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200832 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
833 "Server didn't report file size.");
834 goto out;
835 }
836#else
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100837 if (cl <= 0) {
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200838 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
839 "Unknown file size or zero-length file.");
840 goto out;
841 }
842#endif
843
Anton Johanssone7b8d9d2023-01-23 21:14:31 +0100844 s->len = cl;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200845
Fam Zheng3494d652013-07-02 15:19:21 +0800846 if ((!strncasecmp(s->url, "http://", strlen("http://"))
847 || !strncasecmp(s->url, "https://", strlen("https://")))
848 && !s->accept_range) {
849 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
850 "Server does not support 'range' (byte ranges).");
851 goto out;
852 }
Laurent Viviered2a66d2018-12-13 17:27:25 +0100853 trace_curl_open_size(s->len);
Alexander Graf769ce762009-05-11 17:41:42 +0200854
Paolo Bonzini456af342017-05-15 12:00:55 +0200855 qemu_mutex_lock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200856 curl_clean_state(state);
Paolo Bonzini456af342017-05-15 12:00:55 +0200857 qemu_mutex_unlock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200858 curl_easy_cleanup(state->curl);
859 state->curl = NULL;
860
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200861 curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
Alexander Graf769ce762009-05-11 17:41:42 +0200862
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200863 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200864 return 0;
865
866out:
Maria Kustovaacd7fdc2014-03-18 09:59:18 +0400867 error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
Alexander Graf769ce762009-05-11 17:41:42 +0200868 curl_easy_cleanup(state->curl);
869 state->curl = NULL;
870out_noclean:
Paolo Bonzini456af342017-05-15 12:00:55 +0200871 qemu_mutex_destroy(&s->mutex);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100872 g_free(s->cookie);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200873 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500874 g_free(s->username);
875 g_free(s->proxyusername);
876 g_free(s->proxypassword);
Hanna Czenczek1e84cf72023-02-06 14:29:49 +0100877 if (s->sockets) {
878 curl_drop_all_sockets(s->sockets);
879 g_hash_table_destroy(s->sockets);
880 }
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200881 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200882 return -EINVAL;
883}
884
Paolo Bonzini9bae2ac2022-09-22 10:49:14 +0200885static void coroutine_fn curl_setup_preadv(BlockDriverState *bs, CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200886{
Alexander Graf769ce762009-05-11 17:41:42 +0200887 CURLState *state;
Matthew Boothb69cdef2014-04-29 16:03:29 +0100888 int running;
Alexander Graf769ce762009-05-11 17:41:42 +0200889
Paolo Bonzini19196312017-02-13 14:52:31 +0100890 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200891
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200892 uint64_t start = acb->offset;
893 uint64_t end;
Alexander Graf769ce762009-05-11 17:41:42 +0200894
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100895 qemu_mutex_lock(&s->mutex);
Paolo Bonzini19196312017-02-13 14:52:31 +0100896
Alexander Graf769ce762009-05-11 17:41:42 +0200897 // In case we have the requested data already (e.g. read-ahead),
898 // we can just call the callback and be done.
Paolo Bonzini28256d82017-05-15 12:00:58 +0200899 if (curl_find_buf(s, start, acb->bytes, acb)) {
900 goto out;
Alexander Graf769ce762009-05-11 17:41:42 +0200901 }
902
903 // No cache found, so let's start a new request
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200904 for (;;) {
905 state = curl_find_state(s);
906 if (state) {
907 break;
908 }
Paolo Bonzini709f2132018-02-03 10:39:35 -0500909 qemu_co_queue_wait(&s->free_state_waitq, &s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200910 }
911
912 if (curl_init_state(s, state) < 0) {
913 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200914 acb->ret = -EIO;
Paolo Bonzini19196312017-02-13 14:52:31 +0100915 goto out;
Nick Thomas363c3c82011-09-21 11:55:50 +0100916 }
Alexander Graf769ce762009-05-11 17:41:42 +0200917
918 acb->start = 0;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200919 acb->end = MIN(acb->bytes, s->len - start);
Alexander Graf769ce762009-05-11 17:41:42 +0200920
921 state->buf_off = 0;
Markus Armbrusterf7047c22014-06-06 18:25:12 +0200922 g_free(state->orig_buf);
Alexander Graf769ce762009-05-11 17:41:42 +0200923 state->buf_start = start;
Max Reitz4e504532016-10-25 04:54:31 +0200924 state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
925 end = start + state->buf_len - 1;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200926 state->orig_buf = g_try_malloc(state->buf_len);
927 if (state->buf_len && state->orig_buf == NULL) {
928 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200929 acb->ret = -ENOMEM;
Paolo Bonzini19196312017-02-13 14:52:31 +0100930 goto out;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200931 }
Alexander Graf769ce762009-05-11 17:41:42 +0200932 state->acb[0] = acb;
933
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200934 snprintf(state->range, 127, "%" PRIu64 "-%" PRIu64, start, end);
Laurent Viviered2a66d2018-12-13 17:27:25 +0100935 trace_curl_setup_preadv(acb->bytes, start, state->range);
Peter Maydellb0ea6c92022-02-22 15:23:41 +0000936 if (curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range) ||
937 curl_multi_add_handle(s->multi, state->curl) != CURLM_OK) {
Max Reitzc34dc072019-09-10 14:41:36 +0200938 state->acb[0] = NULL;
939 acb->ret = -EIO;
940
941 curl_clean_state(state);
942 goto out;
943 }
Alexander Graf769ce762009-05-11 17:41:42 +0200944
Matthew Boothb69cdef2014-04-29 16:03:29 +0100945 /* Tell curl it needs to kick things off */
946 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
Paolo Bonzini19196312017-02-13 14:52:31 +0100947
948out:
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100949 qemu_mutex_unlock(&s->mutex);
Nick Thomas363c3c82011-09-21 11:55:50 +0100950}
951
Paolo Bonzini28256d82017-05-15 12:00:58 +0200952static int coroutine_fn curl_co_preadv(BlockDriverState *bs,
Vladimir Sementsov-Ogievskiyf7ef38d2021-09-03 13:27:59 +0300953 int64_t offset, int64_t bytes, QEMUIOVector *qiov,
954 BdrvRequestFlags flags)
Nick Thomas363c3c82011-09-21 11:55:50 +0100955{
Paolo Bonzini28256d82017-05-15 12:00:58 +0200956 CURLAIOCB acb = {
957 .co = qemu_coroutine_self(),
958 .ret = -EINPROGRESS,
959 .qiov = qiov,
960 .offset = offset,
961 .bytes = bytes
962 };
Nick Thomas363c3c82011-09-21 11:55:50 +0100963
Paolo Bonzini28256d82017-05-15 12:00:58 +0200964 curl_setup_preadv(bs, &acb);
965 while (acb.ret == -EINPROGRESS) {
966 qemu_coroutine_yield();
967 }
968 return acb.ret;
Alexander Graf769ce762009-05-11 17:41:42 +0200969}
970
Alexander Graf769ce762009-05-11 17:41:42 +0200971static void curl_close(BlockDriverState *bs)
972{
973 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200974
Laurent Viviered2a66d2018-12-13 17:27:25 +0100975 trace_curl_close();
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200976 curl_detach_aio_context(bs);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100977 qemu_mutex_destroy(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100978
Max Reitz0f418a22021-03-09 14:05:41 +0100979 g_hash_table_destroy(s->sockets);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100980 g_free(s->cookie);
Stefan Weil45724d62012-09-01 11:06:45 +0200981 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500982 g_free(s->username);
983 g_free(s->proxyusername);
984 g_free(s->proxypassword);
Alexander Graf769ce762009-05-11 17:41:42 +0200985}
986
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +0100987static int64_t coroutine_fn curl_co_getlength(BlockDriverState *bs)
Alexander Graf769ce762009-05-11 17:41:42 +0200988{
989 BDRVCURLState *s = bs->opaque;
990 return s->len;
991}
992
Max Reitz937c0072019-02-01 20:29:32 +0100993static void curl_refresh_filename(BlockDriverState *bs)
994{
995 BDRVCURLState *s = bs->opaque;
996
997 /* "readahead" and "timeout" do not change the guest-visible data,
998 * so ignore them */
999 if (s->sslverify != CURL_BLOCK_OPT_SSLVERIFY_DEFAULT ||
1000 s->cookie || s->username || s->password || s->proxyusername ||
1001 s->proxypassword)
1002 {
1003 return;
1004 }
1005
1006 pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), s->url);
1007}
1008
1009
Max Reitz26542672019-02-01 20:29:25 +01001010static const char *const curl_strong_runtime_opts[] = {
1011 CURL_BLOCK_OPT_URL,
1012 CURL_BLOCK_OPT_SSLVERIFY,
1013 CURL_BLOCK_OPT_COOKIE,
1014 CURL_BLOCK_OPT_COOKIE_SECRET,
1015 CURL_BLOCK_OPT_USERNAME,
1016 CURL_BLOCK_OPT_PASSWORD_SECRET,
1017 CURL_BLOCK_OPT_PROXY_USERNAME,
1018 CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
1019
1020 NULL
1021};
1022
Alexander Graf769ce762009-05-11 17:41:42 +02001023static BlockDriver bdrv_http = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001024 .format_name = "http",
1025 .protocol_name = "http",
Alexander Graf769ce762009-05-11 17:41:42 +02001026
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001027 .instance_size = sizeof(BDRVCURLState),
1028 .bdrv_parse_filename = curl_parse_filename,
Paolo Bonzini44b424d2022-11-24 16:22:22 +01001029 .bdrv_open = curl_open,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001030 .bdrv_close = curl_close,
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +01001031 .bdrv_co_getlength = curl_co_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001032
Paolo Bonzini28256d82017-05-15 12:00:58 +02001033 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001034
1035 .bdrv_detach_aio_context = curl_detach_aio_context,
1036 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001037
Max Reitz937c0072019-02-01 20:29:32 +01001038 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001039 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001040};
1041
1042static BlockDriver bdrv_https = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001043 .format_name = "https",
1044 .protocol_name = "https",
Alexander Graf769ce762009-05-11 17:41:42 +02001045
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001046 .instance_size = sizeof(BDRVCURLState),
1047 .bdrv_parse_filename = curl_parse_filename,
Paolo Bonzini44b424d2022-11-24 16:22:22 +01001048 .bdrv_open = curl_open,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001049 .bdrv_close = curl_close,
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +01001050 .bdrv_co_getlength = curl_co_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001051
Paolo Bonzini28256d82017-05-15 12:00:58 +02001052 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001053
1054 .bdrv_detach_aio_context = curl_detach_aio_context,
1055 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001056
Max Reitz937c0072019-02-01 20:29:32 +01001057 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001058 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001059};
1060
1061static BlockDriver bdrv_ftp = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001062 .format_name = "ftp",
1063 .protocol_name = "ftp",
Alexander Graf769ce762009-05-11 17:41:42 +02001064
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001065 .instance_size = sizeof(BDRVCURLState),
1066 .bdrv_parse_filename = curl_parse_filename,
Paolo Bonzini44b424d2022-11-24 16:22:22 +01001067 .bdrv_open = curl_open,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001068 .bdrv_close = curl_close,
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +01001069 .bdrv_co_getlength = curl_co_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001070
Paolo Bonzini28256d82017-05-15 12:00:58 +02001071 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001072
1073 .bdrv_detach_aio_context = curl_detach_aio_context,
1074 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001075
Max Reitz937c0072019-02-01 20:29:32 +01001076 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001077 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001078};
1079
1080static BlockDriver bdrv_ftps = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001081 .format_name = "ftps",
1082 .protocol_name = "ftps",
Alexander Graf769ce762009-05-11 17:41:42 +02001083
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001084 .instance_size = sizeof(BDRVCURLState),
1085 .bdrv_parse_filename = curl_parse_filename,
Paolo Bonzini44b424d2022-11-24 16:22:22 +01001086 .bdrv_open = curl_open,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001087 .bdrv_close = curl_close,
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +01001088 .bdrv_co_getlength = curl_co_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001089
Paolo Bonzini28256d82017-05-15 12:00:58 +02001090 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001091
1092 .bdrv_detach_aio_context = curl_detach_aio_context,
1093 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001094
Max Reitz937c0072019-02-01 20:29:32 +01001095 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001096 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001097};
1098
Alexander Graf769ce762009-05-11 17:41:42 +02001099static void curl_block_init(void)
1100{
1101 bdrv_register(&bdrv_http);
1102 bdrv_register(&bdrv_https);
1103 bdrv_register(&bdrv_ftp);
1104 bdrv_register(&bdrv_ftps);
Alexander Graf769ce762009-05-11 17:41:42 +02001105}
1106
1107block_init(curl_block_init);