engines/http: Add support for Swift storage backend
[fio.git] / engines / http.c
1 /*
2  * HTTP GET/PUT IO engine
3  *
4  * IO engine to perform HTTP(S) GET/PUT requests via libcurl-easy.
5  *
6  * Copyright (C) 2018 SUSE LLC
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License,
10  * version 2 as published by the Free Software Foundation..
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public
18  * License along with this program; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include <pthread.h>
24 #include <time.h>
25 #include <curl/curl.h>
26 #include <openssl/hmac.h>
27 #include <openssl/sha.h>
28 #include <openssl/md5.h>
29 #include "fio.h"
30 #include "../optgroup.h"
31
32
33 enum {
34         FIO_HTTP_WEBDAV     = 0,
35         FIO_HTTP_S3         = 1,
36         FIO_HTTP_SWIFT      = 2,
37
38         FIO_HTTPS_OFF       = 0,
39         FIO_HTTPS_ON        = 1,
40         FIO_HTTPS_INSECURE  = 2,
41 };
42
43 struct http_data {
44         CURL *curl;
45 };
46
47 struct http_options {
48         void *pad;
49         unsigned int https;
50         char *host;
51         char *user;
52         char *pass;
53         char *s3_key;
54         char *s3_keyid;
55         char *s3_region;
56         char *swift_auth_token;
57         int verbose;
58         unsigned int mode;
59 };
60
61 struct http_curl_stream {
62         char *buf;
63         size_t pos;
64         size_t max;
65 };
66
67 static struct fio_option options[] = {
68         {
69                 .name     = "https",
70                 .lname    = "https",
71                 .type     = FIO_OPT_STR,
72                 .help     = "Enable https",
73                 .off1     = offsetof(struct http_options, https),
74                 .def      = "off",
75                 .posval = {
76                           { .ival = "off",
77                             .oval = FIO_HTTPS_OFF,
78                             .help = "No HTTPS",
79                           },
80                           { .ival = "on",
81                             .oval = FIO_HTTPS_ON,
82                             .help = "Enable HTTPS",
83                           },
84                           { .ival = "insecure",
85                             .oval = FIO_HTTPS_INSECURE,
86                             .help = "Enable HTTPS, disable peer verification",
87                           },
88                 },
89                 .category = FIO_OPT_C_ENGINE,
90                 .group    = FIO_OPT_G_HTTP,
91         },
92         {
93                 .name     = "http_host",
94                 .lname    = "http_host",
95                 .type     = FIO_OPT_STR_STORE,
96                 .help     = "Hostname (S3 bucket)",
97                 .off1     = offsetof(struct http_options, host),
98                 .def      = "localhost",
99                 .category = FIO_OPT_C_ENGINE,
100                 .group    = FIO_OPT_G_HTTP,
101         },
102         {
103                 .name     = "http_user",
104                 .lname    = "http_user",
105                 .type     = FIO_OPT_STR_STORE,
106                 .help     = "HTTP user name",
107                 .off1     = offsetof(struct http_options, user),
108                 .category = FIO_OPT_C_ENGINE,
109                 .group    = FIO_OPT_G_HTTP,
110         },
111         {
112                 .name     = "http_pass",
113                 .lname    = "http_pass",
114                 .type     = FIO_OPT_STR_STORE,
115                 .help     = "HTTP password",
116                 .off1     = offsetof(struct http_options, pass),
117                 .category = FIO_OPT_C_ENGINE,
118                 .group    = FIO_OPT_G_HTTP,
119         },
120         {
121                 .name     = "http_s3_key",
122                 .lname    = "S3 secret key",
123                 .type     = FIO_OPT_STR_STORE,
124                 .help     = "S3 secret key",
125                 .off1     = offsetof(struct http_options, s3_key),
126                 .def      = "",
127                 .category = FIO_OPT_C_ENGINE,
128                 .group    = FIO_OPT_G_HTTP,
129         },
130         {
131                 .name     = "http_s3_keyid",
132                 .lname    = "S3 key id",
133                 .type     = FIO_OPT_STR_STORE,
134                 .help     = "S3 key id",
135                 .off1     = offsetof(struct http_options, s3_keyid),
136                 .def      = "",
137                 .category = FIO_OPT_C_ENGINE,
138                 .group    = FIO_OPT_G_HTTP,
139         },
140         {
141                 .name     = "http_swift_auth_token",
142                 .lname    = "Swift auth token",
143                 .type     = FIO_OPT_STR_STORE,
144                 .help     = "OpenStack Swift auth token",
145                 .off1     = offsetof(struct http_options, swift_auth_token),
146                 .def      = "",
147                 .category = FIO_OPT_C_ENGINE,
148                 .group    = FIO_OPT_G_HTTP,
149         },
150         {
151                 .name     = "http_s3_region",
152                 .lname    = "S3 region",
153                 .type     = FIO_OPT_STR_STORE,
154                 .help     = "S3 region",
155                 .off1     = offsetof(struct http_options, s3_region),
156                 .def      = "us-east-1",
157                 .category = FIO_OPT_C_ENGINE,
158                 .group    = FIO_OPT_G_HTTP,
159         },
160         {
161                 .name     = "http_mode",
162                 .lname    = "Request mode to use",
163                 .type     = FIO_OPT_STR,
164                 .help     = "Whether to use WebDAV, Swift, or S3",
165                 .off1     = offsetof(struct http_options, mode),
166                 .def      = "webdav",
167                 .posval = {
168                           { .ival = "webdav",
169                             .oval = FIO_HTTP_WEBDAV,
170                             .help = "WebDAV server",
171                           },
172                           { .ival = "s3",
173                             .oval = FIO_HTTP_S3,
174                             .help = "S3 storage backend",
175                           },
176                           { .ival = "swift",
177                             .oval = FIO_HTTP_SWIFT,
178                             .help = "OpenStack Swift storage",
179                           },
180                 },
181                 .category = FIO_OPT_C_ENGINE,
182                 .group    = FIO_OPT_G_HTTP,
183         },
184         {
185                 .name     = "http_verbose",
186                 .lname    = "HTTP verbosity level",
187                 .type     = FIO_OPT_INT,
188                 .help     = "increase http engine verbosity",
189                 .off1     = offsetof(struct http_options, verbose),
190                 .def      = "0",
191                 .category = FIO_OPT_C_ENGINE,
192                 .group    = FIO_OPT_G_HTTP,
193         },
194         {
195                 .name     = NULL,
196         },
197 };
198
199 static char *_aws_uriencode(const char *uri)
200 {
201         size_t bufsize = 1024;
202         char *r = malloc(bufsize);
203         char c;
204         int i, n;
205         const char *hex = "0123456789ABCDEF";
206
207         if (!r) {
208                 log_err("malloc failed\n");
209                 return NULL;
210         }
211
212         n = 0;
213         for (i = 0; (c = uri[i]); i++) {
214                 if (n > bufsize-5) {
215                         log_err("encoding the URL failed\n");
216                         return NULL;
217                 }
218
219                 if ( (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z')
220                 || (c >= '0' && c <= '9') || c == '_' || c == '-'
221                 || c == '~' || c == '.' || c == '/')
222                         r[n++] = c;
223                 else {
224                         r[n++] = '%';
225                         r[n++] = hex[(c >> 4 ) & 0xF];
226                         r[n++] = hex[c & 0xF];
227                 }
228         }
229         r[n++] = 0;
230         return r;
231 }
232
233 static char *_conv_hex(const unsigned char *p, size_t len)
234 {
235         char *r;
236         int i,n;
237         const char *hex = "0123456789abcdef";
238         r = malloc(len * 2 + 1);
239         n = 0;
240         for (i = 0; i < len; i++) {
241                 r[n++] = hex[(p[i] >> 4 ) & 0xF];
242                 r[n++] = hex[p[i] & 0xF];
243         }
244         r[n] = 0;
245
246         return r;
247 }
248
249 static char *_gen_hex_sha256(const char *p, size_t len)
250 {
251         unsigned char hash[SHA256_DIGEST_LENGTH];
252
253         SHA256((unsigned char*)p, len, hash);
254         return _conv_hex(hash, SHA256_DIGEST_LENGTH);
255 }
256
257 static char *_gen_hex_md5(const char *p, size_t len)
258 {
259         unsigned char hash[MD5_DIGEST_LENGTH];
260
261         MD5((unsigned char*)p, len, hash);
262         return _conv_hex(hash, MD5_DIGEST_LENGTH);
263 }
264
265 static void _hmac(unsigned char *md, void *key, int key_len, char *data) {
266         HMAC_CTX *ctx;
267         unsigned int hmac_len;
268
269         ctx = HMAC_CTX_new();
270         HMAC_Init_ex(ctx, key, key_len, EVP_sha256(), NULL);
271         HMAC_Update(ctx, (unsigned char*)data, strlen(data));
272         HMAC_Final(ctx, md, &hmac_len);
273         HMAC_CTX_free(ctx);
274 }
275
276 static int _curl_trace(CURL *handle, curl_infotype type,
277              char *data, size_t size,
278              void *userp)
279 {
280         const char *text;
281         (void)handle; /* prevent compiler warning */
282         (void)userp;
283
284         switch (type) {
285         case CURLINFO_TEXT:
286         fprintf(stderr, "== Info: %s", data);
287         default:
288         case CURLINFO_SSL_DATA_OUT:
289         case CURLINFO_SSL_DATA_IN:
290                 return 0;
291
292         case CURLINFO_HEADER_OUT:
293                 text = "=> Send header";
294                 break;
295         case CURLINFO_DATA_OUT:
296                 text = "=> Send data";
297                 break;
298         case CURLINFO_HEADER_IN:
299                 text = "<= Recv header";
300                 break;
301         case CURLINFO_DATA_IN:
302                 text = "<= Recv data";
303                 break;
304         }
305
306         log_info("%s: %s", text, data);
307         return 0;
308 }
309
310 /* https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html
311  * https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html#signing-request-intro
312  */
313 static void _add_aws_auth_header(CURL *curl, struct curl_slist *slist, struct http_options *o,
314                 int op, const char *uri, char *buf, size_t len)
315 {
316         char date_short[16];
317         char date_iso[32];
318         char method[8];
319         char dkey[128];
320         char creq[512];
321         char sts[256];
322         char s[512];
323         char *uri_encoded = NULL;
324         char *dsha = NULL;
325         char *csha = NULL;
326         char *signature = NULL;
327         const char *service = "s3";
328         const char *aws = "aws4_request";
329         unsigned char md[SHA256_DIGEST_LENGTH];
330
331         time_t t = time(NULL);
332         struct tm *gtm = gmtime(&t);
333
334         strftime (date_short, sizeof(date_short), "%Y%m%d", gtm);
335         strftime (date_iso, sizeof(date_iso), "%Y%m%dT%H%M%SZ", gtm);
336         uri_encoded = _aws_uriencode(uri);
337
338         if (op == DDIR_WRITE) {
339                 dsha = _gen_hex_sha256(buf, len);
340                 sprintf(method, "PUT");
341         } else {
342                 /* DDIR_READ && DDIR_TRIM supply an empty body */
343                 if (op == DDIR_READ)
344                         sprintf(method, "GET");
345                 else
346                         sprintf(method, "DELETE");
347                 dsha = _gen_hex_sha256("", 0);
348         }
349
350         /* Create the canonical request first */
351         snprintf(creq, sizeof(creq),
352         "%s\n"
353         "%s\n"
354         "\n"
355         "host:%s\n"
356         "x-amz-content-sha256:%s\n"
357         "x-amz-date:%s\n"
358         "\n"
359         "host;x-amz-content-sha256;x-amz-date\n"
360         "%s"
361         , method
362         , uri_encoded, o->host, dsha, date_iso, dsha);
363
364         csha = _gen_hex_sha256(creq, strlen(creq));
365         snprintf(sts, sizeof(sts), "AWS4-HMAC-SHA256\n%s\n%s/%s/%s/%s\n%s",
366                 date_iso, date_short, o->s3_region, service, aws, csha);
367
368         snprintf((char *)dkey, sizeof(dkey), "AWS4%s", o->s3_key);
369         _hmac(md, dkey, strlen(dkey), date_short);
370         _hmac(md, md, SHA256_DIGEST_LENGTH, o->s3_region);
371         _hmac(md, md, SHA256_DIGEST_LENGTH, (char*) service);
372         _hmac(md, md, SHA256_DIGEST_LENGTH, (char*) aws);
373         _hmac(md, md, SHA256_DIGEST_LENGTH, sts);
374
375         signature = _conv_hex(md, SHA256_DIGEST_LENGTH);
376
377         /* Surpress automatic Accept: header */
378         slist = curl_slist_append(slist, "Accept:");
379
380         snprintf(s, sizeof(s), "x-amz-content-sha256: %s", dsha);
381         slist = curl_slist_append(slist, s);
382
383         snprintf(s, sizeof(s), "x-amz-date: %s", date_iso);
384         slist = curl_slist_append(slist, s);
385
386         snprintf(s, sizeof(s), "Authorization: AWS4-HMAC-SHA256 Credential=%s/%s/%s/s3/aws4_request,"
387         "SignedHeaders=host;x-amz-content-sha256;x-amz-date,Signature=%s",
388         o->s3_keyid, date_short, o->s3_region, signature);
389         slist = curl_slist_append(slist, s);
390
391         curl_easy_setopt(curl, CURLOPT_HTTPHEADER, slist);
392
393         free(uri_encoded);
394         free(csha);
395         free(dsha);
396         free(signature);
397 }
398
399 static void _add_swift_header(CURL *curl, struct curl_slist *slist, struct http_options *o,
400                 int op, const char *uri, char *buf, size_t len)
401 {
402         char *dsha = NULL;
403         char s[512];
404
405         if (op == DDIR_WRITE) {
406                 dsha = _gen_hex_md5(buf, len);
407         }
408         /* Surpress automatic Accept: header */
409         slist = curl_slist_append(slist, "Accept:");
410
411         snprintf(s, sizeof(s), "etag: %s", dsha);
412         slist = curl_slist_append(slist, s);
413
414         snprintf(s, sizeof(s), "x-auth-token: %s", o->swift_auth_token);
415         slist = curl_slist_append(slist, s);
416
417         curl_easy_setopt(curl, CURLOPT_HTTPHEADER, slist);
418
419         free(dsha);
420 }
421
422 static void fio_http_cleanup(struct thread_data *td)
423 {
424         struct http_data *http = td->io_ops_data;
425
426         if (http) {
427                 curl_easy_cleanup(http->curl);
428                 free(http);
429         }
430 }
431
432 static size_t _http_read(void *ptr, size_t size, size_t nmemb, void *stream)
433 {
434         struct http_curl_stream *state = stream;
435         size_t len = size * nmemb;
436         /* We're retrieving; nothing is supposed to be read locally */
437         if (!stream)
438                 return 0;
439         if (len+state->pos > state->max)
440                 len = state->max - state->pos;
441         memcpy(ptr, &state->buf[state->pos], len);
442         state->pos += len;
443         return len;
444 }
445
446 static size_t _http_write(void *ptr, size_t size, size_t nmemb, void *stream)
447 {
448         struct http_curl_stream *state = stream;
449         /* We're just discarding the returned body after a PUT */
450         if (!stream)
451                 return nmemb;
452         if (size != 1)
453                 return CURLE_WRITE_ERROR;
454         if (nmemb + state->pos > state->max)
455                 return CURLE_WRITE_ERROR;
456         memcpy(&state->buf[state->pos], ptr, nmemb);
457         state->pos += nmemb;
458         return nmemb;
459 }
460
461 static int _http_seek(void *stream, curl_off_t offset, int origin)
462 {
463         struct http_curl_stream *state = stream;
464         if (offset < state->max && origin == SEEK_SET) {
465                 state->pos = offset;
466                 return CURL_SEEKFUNC_OK;
467         } else
468                 return CURL_SEEKFUNC_FAIL;
469 }
470
471 static enum fio_q_status fio_http_queue(struct thread_data *td,
472                                          struct io_u *io_u)
473 {
474         struct http_data *http = td->io_ops_data;
475         struct http_options *o = td->eo;
476         struct http_curl_stream _curl_stream;
477         struct curl_slist *slist = NULL;
478         char object[512];
479         char url[1024];
480         long status;
481         CURLcode res;
482         int r = -1;
483
484         fio_ro_check(td, io_u);
485         memset(&_curl_stream, 0, sizeof(_curl_stream));
486         snprintf(object, sizeof(object), "%s_%llu_%llu", td->files[0]->file_name,
487                 io_u->offset, io_u->xfer_buflen);
488         if (o->https == FIO_HTTPS_OFF)
489                 snprintf(url, sizeof(url), "http://%s%s", o->host, object);
490         else
491                 snprintf(url, sizeof(url), "https://%s%s", o->host, object);
492         curl_easy_setopt(http->curl, CURLOPT_URL, url);
493         _curl_stream.buf = io_u->xfer_buf;
494         _curl_stream.max = io_u->xfer_buflen;
495         curl_easy_setopt(http->curl, CURLOPT_SEEKDATA, &_curl_stream);
496         curl_easy_setopt(http->curl, CURLOPT_INFILESIZE_LARGE, (curl_off_t)io_u->xfer_buflen);
497
498         if (o->mode == FIO_HTTP_S3)
499                 _add_aws_auth_header(http->curl, slist, o, io_u->ddir, object,
500                         io_u->xfer_buf, io_u->xfer_buflen);
501         else if (o->mode == FIO_HTTP_SWIFT)
502                 _add_swift_header(http->curl, slist, o, io_u->ddir, object,
503                         io_u->xfer_buf, io_u->xfer_buflen);
504
505         if (io_u->ddir == DDIR_WRITE) {
506                 curl_easy_setopt(http->curl, CURLOPT_READDATA, &_curl_stream);
507                 curl_easy_setopt(http->curl, CURLOPT_WRITEDATA, NULL);
508                 curl_easy_setopt(http->curl, CURLOPT_UPLOAD, 1L);
509                 res = curl_easy_perform(http->curl);
510                 if (res == CURLE_OK) {
511                         curl_easy_getinfo(http->curl, CURLINFO_RESPONSE_CODE, &status);
512                         if (status == 100 || (status >= 200 && status <= 204))
513                                 goto out;
514                         log_err("DDIR_WRITE failed with HTTP status code %ld\n", status);
515                         goto err;
516                 }
517         } else if (io_u->ddir == DDIR_READ) {
518                 curl_easy_setopt(http->curl, CURLOPT_READDATA, NULL);
519                 curl_easy_setopt(http->curl, CURLOPT_WRITEDATA, &_curl_stream);
520                 curl_easy_setopt(http->curl, CURLOPT_HTTPGET, 1L);
521                 res = curl_easy_perform(http->curl);
522                 if (res == CURLE_OK) {
523                         curl_easy_getinfo(http->curl, CURLINFO_RESPONSE_CODE, &status);
524                         if (status == 200)
525                                 goto out;
526                         else if (status == 404) {
527                                 /* Object doesn't exist. Pretend we read
528                                  * zeroes */
529                                 memset(io_u->xfer_buf, 0, io_u->xfer_buflen);
530                                 goto out;
531                         }
532                         log_err("DDIR_READ failed with HTTP status code %ld\n", status);
533                 }
534                 goto err;
535         } else if (io_u->ddir == DDIR_TRIM) {
536                 curl_easy_setopt(http->curl, CURLOPT_HTTPGET, 1L);
537                 curl_easy_setopt(http->curl, CURLOPT_CUSTOMREQUEST, "DELETE");
538                 curl_easy_setopt(http->curl, CURLOPT_INFILESIZE_LARGE, 0);
539                 curl_easy_setopt(http->curl, CURLOPT_READDATA, NULL);
540                 curl_easy_setopt(http->curl, CURLOPT_WRITEDATA, NULL);
541                 res = curl_easy_perform(http->curl);
542                 if (res == CURLE_OK) {
543                         curl_easy_getinfo(http->curl, CURLINFO_RESPONSE_CODE, &status);
544                         if (status == 200 || status == 202 || status == 204 || status == 404)
545                                 goto out;
546                         log_err("DDIR_TRIM failed with HTTP status code %ld\n", status);
547                 }
548                 goto err;
549         }
550
551         log_err("WARNING: Only DDIR_READ/DDIR_WRITE/DDIR_TRIM are supported!\n");
552
553 err:
554         io_u->error = r;
555         td_verror(td, io_u->error, "transfer");
556 out:
557         curl_slist_free_all(slist);
558         return FIO_Q_COMPLETED;
559 }
560
561 static struct io_u *fio_http_event(struct thread_data *td, int event)
562 {
563         /* sync IO engine - never any outstanding events */
564         return NULL;
565 }
566
567 int fio_http_getevents(struct thread_data *td, unsigned int min,
568         unsigned int max, const struct timespec *t)
569 {
570         /* sync IO engine - never any outstanding events */
571         return 0;
572 }
573
574 static int fio_http_setup(struct thread_data *td)
575 {
576         struct http_data *http = NULL;
577         struct http_options *o = td->eo;
578         int r;
579         /* allocate engine specific structure to deal with libhttp. */
580         http = calloc(1, sizeof(*http));
581         if (!http) {
582                 log_err("calloc failed.\n");
583                 goto cleanup;
584         }
585
586         http->curl = curl_easy_init();
587         if (o->verbose)
588                 curl_easy_setopt(http->curl, CURLOPT_VERBOSE, 1L);
589         if (o->verbose > 1)
590                 curl_easy_setopt(http->curl, CURLOPT_DEBUGFUNCTION, &_curl_trace);
591         curl_easy_setopt(http->curl, CURLOPT_NOPROGRESS, 1L);
592         curl_easy_setopt(http->curl, CURLOPT_FOLLOWLOCATION, 1L);
593         curl_easy_setopt(http->curl, CURLOPT_PROTOCOLS, CURLPROTO_HTTP|CURLPROTO_HTTPS);
594         if (o->https == FIO_HTTPS_INSECURE) {
595                 curl_easy_setopt(http->curl, CURLOPT_SSL_VERIFYPEER, 0L);
596                 curl_easy_setopt(http->curl, CURLOPT_SSL_VERIFYHOST, 0L);
597         }
598         curl_easy_setopt(http->curl, CURLOPT_READFUNCTION, _http_read);
599         curl_easy_setopt(http->curl, CURLOPT_WRITEFUNCTION, _http_write);
600         curl_easy_setopt(http->curl, CURLOPT_SEEKFUNCTION, _http_seek);
601         if (o->user && o->pass) {
602                 curl_easy_setopt(http->curl, CURLOPT_USERNAME, o->user);
603                 curl_easy_setopt(http->curl, CURLOPT_PASSWORD, o->pass);
604                 curl_easy_setopt(http->curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
605         }
606
607         td->io_ops_data = http;
608
609         /* Force single process mode. */
610         td->o.use_thread = 1;
611
612         return 0;
613 cleanup:
614         fio_http_cleanup(td);
615         return r;
616 }
617
618 static int fio_http_open(struct thread_data *td, struct fio_file *f)
619 {
620         return 0;
621 }
622 static int fio_http_invalidate(struct thread_data *td, struct fio_file *f)
623 {
624         return 0;
625 }
626
627 static struct ioengine_ops ioengine = {
628         .name = "http",
629         .version                = FIO_IOOPS_VERSION,
630         .flags                  = FIO_DISKLESSIO,
631         .setup                  = fio_http_setup,
632         .queue                  = fio_http_queue,
633         .getevents              = fio_http_getevents,
634         .event                  = fio_http_event,
635         .cleanup                = fio_http_cleanup,
636         .open_file              = fio_http_open,
637         .invalidate             = fio_http_invalidate,
638         .options                = options,
639         .option_struct_size     = sizeof(struct http_options),
640 };
641
642 static void fio_init fio_http_register(void)
643 {
644         register_ioengine(&ioengine);
645 }
646
647 static void fio_exit fio_http_unregister(void)
648 {
649         unregister_ioengine(&ioengine);
650 }