2 * QEMU block full disk encryption
4 * Copyright (c) 2015-2016 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include "qemu/osdep.h"
23 #include "block/block_int.h"
24 #include "sysemu/block-backend.h"
25 #include "crypto/block.h"
26 #include "qapi/opts-visitor.h"
27 #include "qapi/qapi-visit-crypto.h"
28 #include "qapi/qmp/qdict.h"
29 #include "qapi/qobject-input-visitor.h"
30 #include "qapi/error.h"
31 #include "qemu/option.h"
32 #include "block/crypto.h"
34 typedef struct BlockCrypto BlockCrypto;
41 static int block_crypto_probe_generic(QCryptoBlockFormat format,
46 if (qcrypto_block_has_format(format, buf, buf_size)) {
54 static ssize_t block_crypto_read_func(QCryptoBlock *block,
61 BlockDriverState *bs = opaque;
64 ret = bdrv_pread(bs->file, offset, buf, buflen);
66 error_setg_errno(errp, -ret, "Could not read encryption header");
73 struct BlockCryptoCreateData {
79 static ssize_t block_crypto_write_func(QCryptoBlock *block,
86 struct BlockCryptoCreateData *data = opaque;
89 ret = blk_pwrite(data->blk, offset, buf, buflen, 0);
91 error_setg_errno(errp, -ret, "Could not write encryption header");
98 static ssize_t block_crypto_init_func(QCryptoBlock *block,
103 struct BlockCryptoCreateData *data = opaque;
105 if (data->size > INT64_MAX || headerlen > INT64_MAX - data->size) {
106 error_setg(errp, "The requested file size is too large");
110 /* User provided size should reflect amount of space made
111 * available to the guest, so we must take account of that
112 * which will be used by the crypto header
114 return blk_truncate(data->blk, data->size + headerlen, PREALLOC_MODE_OFF,
119 static QemuOptsList block_crypto_runtime_opts_luks = {
121 .head = QTAILQ_HEAD_INITIALIZER(block_crypto_runtime_opts_luks.head),
123 BLOCK_CRYPTO_OPT_DEF_LUKS_KEY_SECRET(""),
124 { /* end of list */ }
129 static QemuOptsList block_crypto_create_opts_luks = {
131 .head = QTAILQ_HEAD_INITIALIZER(block_crypto_create_opts_luks.head),
134 .name = BLOCK_OPT_SIZE,
135 .type = QEMU_OPT_SIZE,
136 .help = "Virtual disk size"
138 BLOCK_CRYPTO_OPT_DEF_LUKS_KEY_SECRET(""),
139 BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_ALG(""),
140 BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_MODE(""),
141 BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_ALG(""),
142 BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_HASH_ALG(""),
143 BLOCK_CRYPTO_OPT_DEF_LUKS_HASH_ALG(""),
144 BLOCK_CRYPTO_OPT_DEF_LUKS_ITER_TIME(""),
145 { /* end of list */ }
150 QCryptoBlockOpenOptions *
151 block_crypto_open_opts_init(QCryptoBlockFormat format,
156 QCryptoBlockOpenOptions *ret = NULL;
157 Error *local_err = NULL;
159 ret = g_new0(QCryptoBlockOpenOptions, 1);
160 ret->format = format;
162 v = qobject_input_visitor_new_keyval(QOBJECT(opts));
164 visit_start_struct(v, NULL, NULL, 0, &local_err);
170 case Q_CRYPTO_BLOCK_FORMAT_LUKS:
171 visit_type_QCryptoBlockOptionsLUKS_members(
172 v, &ret->u.luks, &local_err);
175 case Q_CRYPTO_BLOCK_FORMAT_QCOW:
176 visit_type_QCryptoBlockOptionsQCow_members(
177 v, &ret->u.qcow, &local_err);
181 error_setg(&local_err, "Unsupported block format %d", format);
185 visit_check_struct(v, &local_err);
188 visit_end_struct(v, NULL);
192 error_propagate(errp, local_err);
193 qapi_free_QCryptoBlockOpenOptions(ret);
201 QCryptoBlockCreateOptions *
202 block_crypto_create_opts_init(QCryptoBlockFormat format,
207 QCryptoBlockCreateOptions *ret = NULL;
208 Error *local_err = NULL;
210 ret = g_new0(QCryptoBlockCreateOptions, 1);
211 ret->format = format;
213 v = qobject_input_visitor_new_keyval(QOBJECT(opts));
215 visit_start_struct(v, NULL, NULL, 0, &local_err);
221 case Q_CRYPTO_BLOCK_FORMAT_LUKS:
222 visit_type_QCryptoBlockCreateOptionsLUKS_members(
223 v, &ret->u.luks, &local_err);
226 case Q_CRYPTO_BLOCK_FORMAT_QCOW:
227 visit_type_QCryptoBlockOptionsQCow_members(
228 v, &ret->u.qcow, &local_err);
232 error_setg(&local_err, "Unsupported block format %d", format);
236 visit_check_struct(v, &local_err);
239 visit_end_struct(v, NULL);
243 error_propagate(errp, local_err);
244 qapi_free_QCryptoBlockCreateOptions(ret);
252 static int block_crypto_open_generic(QCryptoBlockFormat format,
253 QemuOptsList *opts_spec,
254 BlockDriverState *bs,
259 BlockCrypto *crypto = bs->opaque;
260 QemuOpts *opts = NULL;
261 Error *local_err = NULL;
263 QCryptoBlockOpenOptions *open_opts = NULL;
264 unsigned int cflags = 0;
265 QDict *cryptoopts = NULL;
267 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
273 bs->supported_write_flags = BDRV_REQ_FUA &
274 bs->file->bs->supported_write_flags;
276 opts = qemu_opts_create(opts_spec, NULL, 0, &error_abort);
277 qemu_opts_absorb_qdict(opts, options, &local_err);
279 error_propagate(errp, local_err);
283 cryptoopts = qemu_opts_to_qdict(opts, NULL);
285 open_opts = block_crypto_open_opts_init(format, cryptoopts, errp);
290 if (flags & BDRV_O_NO_IO) {
291 cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
293 crypto->block = qcrypto_block_open(open_opts, NULL,
294 block_crypto_read_func,
299 if (!crypto->block) {
304 bs->encrypted = true;
308 qobject_unref(cryptoopts);
309 qapi_free_QCryptoBlockOpenOptions(open_opts);
314 static int block_crypto_co_create_generic(BlockDriverState *bs,
316 QCryptoBlockCreateOptions *opts,
321 QCryptoBlock *crypto = NULL;
322 struct BlockCryptoCreateData data;
324 blk = blk_new(BLK_PERM_WRITE | BLK_PERM_RESIZE, BLK_PERM_ALL);
326 ret = blk_insert_bs(blk, bs, errp);
331 data = (struct BlockCryptoCreateData) {
336 crypto = qcrypto_block_create(opts, NULL,
337 block_crypto_init_func,
338 block_crypto_write_func,
349 qcrypto_block_free(crypto);
354 static int block_crypto_truncate(BlockDriverState *bs, int64_t offset,
355 PreallocMode prealloc, Error **errp)
357 BlockCrypto *crypto = bs->opaque;
358 uint64_t payload_offset =
359 qcrypto_block_get_payload_offset(crypto->block);
361 if (payload_offset > INT64_MAX - offset) {
362 error_setg(errp, "The requested file size is too large");
366 offset += payload_offset;
368 return bdrv_truncate(bs->file, offset, prealloc, errp);
371 static void block_crypto_close(BlockDriverState *bs)
373 BlockCrypto *crypto = bs->opaque;
374 qcrypto_block_free(crypto->block);
377 static int block_crypto_reopen_prepare(BDRVReopenState *state,
378 BlockReopenQueue *queue, Error **errp)
380 /* nothing needs checking */
385 * 1 MB bounce buffer gives good performance / memory tradeoff
386 * when using cache=none|directsync.
388 #define BLOCK_CRYPTO_MAX_IO_SIZE (1024 * 1024)
390 static coroutine_fn int
391 block_crypto_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
392 QEMUIOVector *qiov, int flags)
394 BlockCrypto *crypto = bs->opaque;
395 uint64_t cur_bytes; /* number of bytes in current iteration */
396 uint64_t bytes_done = 0;
397 uint8_t *cipher_data = NULL;
398 QEMUIOVector hd_qiov;
400 uint64_t sector_size = qcrypto_block_get_sector_size(crypto->block);
401 uint64_t payload_offset = qcrypto_block_get_payload_offset(crypto->block);
404 assert(payload_offset < INT64_MAX);
405 assert(QEMU_IS_ALIGNED(offset, sector_size));
406 assert(QEMU_IS_ALIGNED(bytes, sector_size));
408 qemu_iovec_init(&hd_qiov, qiov->niov);
410 /* Bounce buffer because we don't wish to expose cipher text
411 * in qiov which points to guest memory.
414 qemu_try_blockalign(bs->file->bs, MIN(BLOCK_CRYPTO_MAX_IO_SIZE,
416 if (cipher_data == NULL) {
422 cur_bytes = MIN(bytes, BLOCK_CRYPTO_MAX_IO_SIZE);
424 qemu_iovec_reset(&hd_qiov);
425 qemu_iovec_add(&hd_qiov, cipher_data, cur_bytes);
427 ret = bdrv_co_preadv(bs->file, payload_offset + offset + bytes_done,
428 cur_bytes, &hd_qiov, 0);
433 if (qcrypto_block_decrypt(crypto->block, offset + bytes_done,
434 cipher_data, cur_bytes, NULL) < 0) {
439 qemu_iovec_from_buf(qiov, bytes_done, cipher_data, cur_bytes);
442 bytes_done += cur_bytes;
446 qemu_iovec_destroy(&hd_qiov);
447 qemu_vfree(cipher_data);
453 static coroutine_fn int
454 block_crypto_co_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
455 QEMUIOVector *qiov, int flags)
457 BlockCrypto *crypto = bs->opaque;
458 uint64_t cur_bytes; /* number of bytes in current iteration */
459 uint64_t bytes_done = 0;
460 uint8_t *cipher_data = NULL;
461 QEMUIOVector hd_qiov;
463 uint64_t sector_size = qcrypto_block_get_sector_size(crypto->block);
464 uint64_t payload_offset = qcrypto_block_get_payload_offset(crypto->block);
466 assert(!(flags & ~BDRV_REQ_FUA));
467 assert(payload_offset < INT64_MAX);
468 assert(QEMU_IS_ALIGNED(offset, sector_size));
469 assert(QEMU_IS_ALIGNED(bytes, sector_size));
471 qemu_iovec_init(&hd_qiov, qiov->niov);
473 /* Bounce buffer because we're not permitted to touch
474 * contents of qiov - it points to guest memory.
477 qemu_try_blockalign(bs->file->bs, MIN(BLOCK_CRYPTO_MAX_IO_SIZE,
479 if (cipher_data == NULL) {
485 cur_bytes = MIN(bytes, BLOCK_CRYPTO_MAX_IO_SIZE);
487 qemu_iovec_to_buf(qiov, bytes_done, cipher_data, cur_bytes);
489 if (qcrypto_block_encrypt(crypto->block, offset + bytes_done,
490 cipher_data, cur_bytes, NULL) < 0) {
495 qemu_iovec_reset(&hd_qiov);
496 qemu_iovec_add(&hd_qiov, cipher_data, cur_bytes);
498 ret = bdrv_co_pwritev(bs->file, payload_offset + offset + bytes_done,
499 cur_bytes, &hd_qiov, flags);
505 bytes_done += cur_bytes;
509 qemu_iovec_destroy(&hd_qiov);
510 qemu_vfree(cipher_data);
515 static void block_crypto_refresh_limits(BlockDriverState *bs, Error **errp)
517 BlockCrypto *crypto = bs->opaque;
518 uint64_t sector_size = qcrypto_block_get_sector_size(crypto->block);
519 bs->bl.request_alignment = sector_size; /* No sub-sector I/O */
523 static int64_t block_crypto_getlength(BlockDriverState *bs)
525 BlockCrypto *crypto = bs->opaque;
526 int64_t len = bdrv_getlength(bs->file->bs);
528 uint64_t offset = qcrypto_block_get_payload_offset(crypto->block);
529 assert(offset < INT64_MAX);
541 static int block_crypto_probe_luks(const uint8_t *buf,
543 const char *filename) {
544 return block_crypto_probe_generic(Q_CRYPTO_BLOCK_FORMAT_LUKS,
545 buf, buf_size, filename);
548 static int block_crypto_open_luks(BlockDriverState *bs,
553 return block_crypto_open_generic(Q_CRYPTO_BLOCK_FORMAT_LUKS,
554 &block_crypto_runtime_opts_luks,
555 bs, options, flags, errp);
558 static int coroutine_fn
559 block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp)
561 BlockdevCreateOptionsLUKS *luks_opts;
562 BlockDriverState *bs = NULL;
563 QCryptoBlockCreateOptions create_opts;
566 assert(create_options->driver == BLOCKDEV_DRIVER_LUKS);
567 luks_opts = &create_options->u.luks;
569 bs = bdrv_open_blockdev_ref(luks_opts->file, errp);
574 create_opts = (QCryptoBlockCreateOptions) {
575 .format = Q_CRYPTO_BLOCK_FORMAT_LUKS,
576 .u.luks = *qapi_BlockdevCreateOptionsLUKS_base(luks_opts),
579 ret = block_crypto_co_create_generic(bs, luks_opts->size, &create_opts,
591 static int coroutine_fn block_crypto_co_create_opts_luks(const char *filename,
595 QCryptoBlockCreateOptions *create_opts = NULL;
596 BlockDriverState *bs = NULL;
602 size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0);
604 cryptoopts = qemu_opts_to_qdict_filtered(opts, NULL,
605 &block_crypto_create_opts_luks,
608 create_opts = block_crypto_create_opts_init(Q_CRYPTO_BLOCK_FORMAT_LUKS,
615 /* Create protocol layer */
616 ret = bdrv_create_file(filename, opts, errp);
621 bs = bdrv_open(filename, NULL, NULL,
622 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, errp);
628 /* Create format layer */
629 ret = block_crypto_co_create_generic(bs, size, create_opts, errp);
637 qapi_free_QCryptoBlockCreateOptions(create_opts);
638 qobject_unref(cryptoopts);
642 static int block_crypto_get_info_luks(BlockDriverState *bs,
643 BlockDriverInfo *bdi)
645 BlockDriverInfo subbdi;
648 ret = bdrv_get_info(bs->file->bs, &subbdi);
653 bdi->unallocated_blocks_are_zero = false;
654 bdi->cluster_size = subbdi.cluster_size;
659 static ImageInfoSpecific *
660 block_crypto_get_specific_info_luks(BlockDriverState *bs)
662 BlockCrypto *crypto = bs->opaque;
663 ImageInfoSpecific *spec_info;
664 QCryptoBlockInfo *info;
666 info = qcrypto_block_get_info(crypto->block, NULL);
670 if (info->format != Q_CRYPTO_BLOCK_FORMAT_LUKS) {
671 qapi_free_QCryptoBlockInfo(info);
675 spec_info = g_new(ImageInfoSpecific, 1);
676 spec_info->type = IMAGE_INFO_SPECIFIC_KIND_LUKS;
677 spec_info->u.luks.data = g_new(QCryptoBlockInfoLUKS, 1);
678 *spec_info->u.luks.data = info->u.luks;
680 /* Blank out pointers we've just stolen to avoid double free */
681 memset(&info->u.luks, 0, sizeof(info->u.luks));
683 qapi_free_QCryptoBlockInfo(info);
688 BlockDriver bdrv_crypto_luks = {
689 .format_name = "luks",
690 .instance_size = sizeof(BlockCrypto),
691 .bdrv_probe = block_crypto_probe_luks,
692 .bdrv_open = block_crypto_open_luks,
693 .bdrv_close = block_crypto_close,
694 .bdrv_child_perm = bdrv_format_default_perms,
695 .bdrv_co_create = block_crypto_co_create_luks,
696 .bdrv_co_create_opts = block_crypto_co_create_opts_luks,
697 .bdrv_truncate = block_crypto_truncate,
698 .create_opts = &block_crypto_create_opts_luks,
700 .bdrv_reopen_prepare = block_crypto_reopen_prepare,
701 .bdrv_refresh_limits = block_crypto_refresh_limits,
702 .bdrv_co_preadv = block_crypto_co_preadv,
703 .bdrv_co_pwritev = block_crypto_co_pwritev,
704 .bdrv_getlength = block_crypto_getlength,
705 .bdrv_get_info = block_crypto_get_info_luks,
706 .bdrv_get_specific_info = block_crypto_get_specific_info_luks,
709 static void block_crypto_init(void)
711 bdrv_register(&bdrv_crypto_luks);
714 block_init(block_crypto_init);