Support generic Luks encryption
Subsystems (2)
v2 cover Support generic Luks encryption
v2:
- Simplify the design by reusing the LUKS driver to implement the generic Luks encryption, thank Daniel for the insightful advice.
- rebase on master.
This functionality was motivated by the following to-do list seen in crypto documents:
https://wiki.qemu.org/Features/Block/Crypto
The last chapter says we should "separate header volume":
The LUKS format has ability to store the header in a separate volume from the payload. We should extend the LUKS driver in QEMU to support this use case.
By enhancing the LUKS driver, it is possible to enable the detachable LUKS header and, as a result, achieve general encryption for any disk format that QEMU has supported.
Take the qcow2 as an example, the usage of the generic LUKS encryption as follows:
1. add a protocol blockdev node of data disk
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/test_disk.qcow2"}}'
2. add a protocol blockdev node of LUKS header as above.
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-2-storage", "driver":"file", "filename": "/path/to/cipher.gluks" }}'
3. add the secret for decrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type":"secret", "id":
"libvirt-2-storage-secret0", "data":"abc123"}}'
4. add the qcow2-drived blockdev format node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-format", "driver":"qcow2", "file":"libvirt-1-storage"}}'
5. add the luks-drived blockdev to link the qcow2 disk with LUKS header by specifying the field "header"
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 3 lines
"arguments":{"node-name":"libvirt-2-format", "driver":"luks", "file":"libvirt-1-format", "header":"libvirt-2-storage", "key-secret":"libvirt-2-format-secret0"}}'
6. add the virtio-blk device finally
$ virsh qemu-monitor-command vm '{"execute":"device_add",Quoted 2 lines
"arguments": {"num-queues":"1", "driver":"virtio-blk-pci", "drive": "libvirt-2-format", "id":"virtio-disk2"}}'
The generic LUKS encryption method of starting a virtual machine (VM) is somewhat similar to hot-plug in that both maintaining the same json command while the starting VM changes the "blockdev-add/device_add" parameters to "blockdev/device".
Please review, thanks
Best regared,
Yong
Hyman Huang (4):
crypto: Introduce option and structure for detached LUKS header
crypto: Introduce payload offset set function
crypto: Support generic LUKS encryption
block: Support detached LUKS header creation for blockdev-create
block/crypto.c | 47 ++++++++++++++++++++++++++++++++++++++++-- crypto/block.c | 4 ++++ include/crypto/block.h | 1 + qapi/block-core.json | 11 ++++++++-- 4 files changed, 59 insertions(+), 4 deletions(-)
Signature · 1 line
2.39.1
PATCH v2 1/4 crypto: Introduce option and structure for detached LUKS header
Add the "header" option for the LUKS format. This field would be used to identify the blockdev's position where a detachable LUKS header is stored.
In addition, introduce header field in struct BlockCrypto
--- block/crypto.c | 1 + qapi/block-core.json | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-)
block/crypto.c +1 -0
@@ -39,6 +39,7 @@ typedef struct BlockCrypto BlockCrypto;struct BlockCrypto {QCryptoBlock *block;bool updating_keys; +BdrvChild *header;/* Reference to the detached LUKS header */ };
qapi/block-core.json +5 -1
@@ -3352,11 +3352,15 @@ # decryption key (since 2.6). Mandatory except when doing a # metadata-only probe of the image. # +# @header: optional reference to the location of a blockdev +# storing a detached LUKS header. (since 9.0) +# # Since: 2.9 ## { 'struct': 'BlockdevOptionsLUKS', 'base': 'BlockdevOptionsGenericFormat', - 'data': { '*key-secret': 'str' } } + 'data': { '*key-secret': 'str', + '*header': 'BlockdevRef'} } ## # @BlockdevOptionsGenericCOWFormat:
Signature · 1 line
2.39.1
Re: [v2 1/4] crypto: Introduce option and structure for detached LUKS header
Quoted 11 lines · Hyman Huang
Add the "header" option for the LUKS format. This field would be used to identify the blockdev's position where a detachable LUKS header is stored.
In addition, introduce header field in struct BlockCrypto
Signed-off-by Hyman Huang <[email protected]>--- block/crypto.c | 1 + qapi/block-core.json | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-)
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH v2 2/4 crypto: Introduce payload offset set function
In reply to Hyman Huang--- crypto/block.c | 4 ++++ include/crypto/block.h | 1 + 2 files changed, 5 insertions(+)
crypto/block.c +4 -0
@@ -319,6 +319,10 @@ QCryptoHashAlgorithm qcrypto_block_get_kdf_hash(QCryptoBlock *block)return block->kdfhash; } +void qcrypto_block_set_payload_offset (QCryptoBlock *block,uint64_t offset) +{ + block->payload_offset = offset; +}uint64_t qcrypto_block_get_payload_offset (QCryptoBlock *block) {
include/crypto/block.h +1 -0
@@ -312,4 +312,5 @@ void qcrypto_block_free(QCryptoBlock *block); G_DEFINE_AUTOPTR_CLEANUP_FUNC(QCryptoBlock, qcrypto_block_free) +void qcrypto_block_set_payload_offset (QCryptoBlock *block,uint64_t offset);#endif /* QCRYPTO_BLOCK_H */
Signature · 1 line
2.39.1
Re: [v2 2/4] crypto: Introduce payload offset set function
Quoted 5 lines · Hyman Huang
Signed-off-by Hyman Huang <[email protected]>--- crypto/block.c | 4 ++++ include/crypto/block.h | 1 + 2 files changed, 5 insertions(+)
however, based on my comment in patch #3, I'm not convinced this method is needed
Quoted 29 lines
crypto/block.c +4
-0@@ -319,6 +319,10 @@ QCryptoHashAlgorithm qcrypto_block_get_kdf_hash(QCryptoBlock *block)return block->kdfhash; } +void qcrypto_block_set_payload_offset (QCryptoBlock *block,uint64_t offset) +{ + block->payload_offset = offset; +}uint64_t qcrypto_block_get_payload_offset (QCryptoBlock *block) {include/crypto/block.h +1
-0@@ -312,4 +312,5 @@ void qcrypto_block_free(QCryptoBlock *block); G_DEFINE_AUTOPTR_CLEANUP_FUNC(QCryptoBlock, qcrypto_block_free) +void qcrypto_block_set_payload_offset (QCryptoBlock *block,uint64_t offset);#endif /* QCRYPTO_BLOCK_H */ Signature · 1 line
2.39.1
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH v2 3/4 crypto: Support generic LUKS encryption
In reply to Hyman HuangBy enhancing the LUKS driver, it is possible to enable the detachable LUKS header and, as a result, achieve general encryption for any disk format that QEMU has supported.
Take the qcow2 as an example, the usage of the generic LUKS encryption as follows:
1. add a protocol blockdev node of data disk
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/test_disk.qcow2"}}'
2. add a protocol blockdev node of LUKS header as above.
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-2-storage", "driver":"file", "filename": "/path/to/cipher.gluks" }}'
3. add the secret for decrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type":"secret", "id":
"libvirt-2-storage-secret0", "data":"abc123"}}'
4. add the qcow2-drived blockdev format node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-format", "driver":"qcow2", "file":"libvirt-1-storage"}}'
5. add the luks-drived blockdev to link the qcow2 disk with LUKS header by specifying the field "header"
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 3 lines
"arguments":{"node-name":"libvirt-2-format", "driver":"luks", "file":"libvirt-1-format", "header":"libvirt-2-storage", "key-secret":"libvirt-2-format-secret0"}}'
6. add the virtio-blk device finally
$ virsh qemu-monitor-command vm '{"execute":"device_add",Quoted 2 lines
"arguments": {"num-queues":"1", "driver":"virtio-blk-pci", "drive": "libvirt-2-format", "id":"virtio-disk2"}}'
The generic LUKS encryption method of starting a virtual machine (VM) is somewhat similar to hot-plug in that both maintaining the same json command while the starting VM changes the "blockdev-add/device_add" parameters to "blockdev/device".
--- block/crypto.c | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-)
block/crypto.c +37 -1
@@ -40,6 +40,7 @@ struct BlockCrypto {QCryptoBlock *block;bool updating_keys;BdrvChild *header;/* Reference to the detached LUKS header */ +bool detached_mode;/* If true, LUKS plays a detached header role */ };
@@ -64,12 +65,16 @@ static int block_crypto_read_func(QCryptoBlock *block, Error **errp) {BlockDriverState *bs = opaque; +BlockCrypto *crypto = bs->opaque;ssize_t ret;GLOBAL_STATE_CODE ();GRAPH_RDLOCK_GUARD_MAINLOOP (); - ret =bdrv_pread (bs->file, offset, buflen, buf,0 ); +if (crypto->detached_mode) + ret =bdrv_pread (crypto->header, offset, buflen, buf,0 ); +else + ret =bdrv_pread (bs->file, offset, buflen, buf,0 );if (ret <0 ) {error_setg_errno (errp, -ret,"Could not read encryption header" );return ret;
@@ -269,6 +274,8 @@ static int block_crypto_open_generic(QCryptoBlockFormat format,QCryptoBlockOpenOptions *open_opts =NULL ;unsigned int cflags =0 ;QDict *cryptoopts =NULL ; +const char *header_bdref = +qdict_get_try_str (options,"header" );GLOBAL_STATE_CODE ();
@@ -277,6 +284,16 @@ static int block_crypto_open_generic(QCryptoBlockFormat format,return ret; } +if (header_bdref) { + crypto->detached_mode = true; + crypto->header =bdrv_open_child (NULL , options,"header" , bs, + &child_of_bds,BDRV_CHILD_METADATA , + false, errp); +if (!crypto->header) { +return -EINVAL ; + } + } +GRAPH_RDLOCK_GUARD_MAINLOOP (); bs->supported_write_flags = BDRV_REQ_FUA &
@@ -312,6 +329,14 @@ static int block_crypto_open_generic(QCryptoBlockFormat format, goto cleanup; } +if (crypto->detached_mode) { +/* +* Set payload offset to zero as the file bdref has no LUKS +* header under detached mode. +*/ +qcrypto_block_set_payload_offset (crypto->block,0 ); + } + bs->encrypted = true; ret =0 ;
@@ -903,6 +928,17 @@ block_crypto_child_perms(BlockDriverState *bs, BdrvChild *c,BlockCrypto *crypto = bs->opaque; +if (role == (role &BDRV_CHILD_METADATA )) { +/* Assign read permission only */ + perm |=BLK_PERM_CONSISTENT_READ ; +/* Share all permissions */ + shared |=BLK_PERM_ALL ; + + *nperm = perm; + *nshared = shared; +return ; + } +bdrv_default_perms (bs, c, role, reopen_queue, perm, shared, nperm, nshared);/*
Signature · 1 line
2.39.1
Re: [v2 3/4] crypto: Support generic LUKS encryption
Quoted 69 lines · Hyman Huang
By enhancing the LUKS driver, it is possible to enable the detachable LUKS header and, as a result, achieve general encryption for any disk format that QEMU has supported.
Take the qcow2 as an example, the usage of the generic LUKS encryption as follows:
1. add a protocol blockdev node of data disk
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/test_disk.qcow2"}}'
2. add a protocol blockdev node of LUKS header as above.
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-2-storage", "driver":"file", "filename": "/path/to/cipher.gluks" }}'
3. add the secret for decrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type":"secret", "id":
"libvirt-2-storage-secret0", "data":"abc123"}}'4. add the qcow2-drived blockdev format node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-format", "driver":"qcow2", "file":"libvirt-1-storage"}}'
5. add the luks-drived blockdev to link the qcow2 disk with LUKS header by specifying the field "header"
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 3 lines
"arguments":{"node-name":"libvirt-2-format", "driver":"luks", "file":"libvirt-1-format", "header":"libvirt-2-storage", "key-secret":"libvirt-2-format-secret0"}}'
6. add the virtio-blk device finally
$ virsh qemu-monitor-command vm '{"execute":"device_add",Quoted 2 lines
"arguments": {"num-queues":"1", "driver":"virtio-blk-pci", "drive": "libvirt-2-format", "id":"virtio-disk2"}}'
The generic LUKS encryption method of starting a virtual machine (VM) is somewhat similar to hot-plug in that both maintaining the same json command while the starting VM changes the "blockdev-add/device_add" parameters to "blockdev/device".
Signed-off-by Hyman Huang <[email protected]>--- block/crypto.c | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-)block/crypto.c +2
-0@@ -40,6 +40,7 @@ struct BlockCrypto {QCryptoBlock *block;bool updating_keys;BdrvChild *header;/* Reference to the detached LUKS header */ +bool detached_mode;/* If true, LUKS plays a detached header role */ };@@ -64,12 +65,16 @@ static int block_crypto_read_func(QCryptoBlock *block, Error **errp) {BlockDriverState *bs = opaque; +BlockCrypto *crypto = bs->opaque;
block/crypto.c static int block_crypto_read_func(QCryptoBlock *block, · line 77
Quoted 10 lines
block/crypto.c +4
-1ssize_t ret;GLOBAL_STATE_CODE ();GRAPH_RDLOCK_GUARD_MAINLOOP (); - ret =bdrv_pread (bs->file, offset, buflen, buf,0 ); +if (crypto->detached_mode) + ret =bdrv_pread (crypto->header, offset, buflen, buf,0 ); +else + ret =bdrv_pread (bs->file, offset, buflen, buf,0 );
This can be simplified to:
ret = bdrv_pread(bs->header ? bs->header : file, offset, buflen, buf, 0);
Quoted 13 lines
block/crypto.c +2
-0if (ret <0 ) {error_setg_errno (errp, -ret,"Could not read encryption header" );return ret;@@ -269,6 +274,8 @@ static int block_crypto_open_generic(QCryptoBlockFormat format,QCryptoBlockOpenOptions *open_opts =NULL ;unsigned int cflags =0 ;QDict *cryptoopts =NULL ; +const char *header_bdref = +qdict_get_try_str (options,"header" );GLOBAL_STATE_CODE ();
block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 288
Quoted 5 lines
block/crypto.c +2
-0@@ -277,6 +284,16 @@ static int block_crypto_open_generic(QCryptoBlockFormat format,return ret; } +if (header_bdref) { + crypto->detached_mode = true;
Drop this flag since it has no benefit.
Quoted 12 lines
block/crypto.c +8
-0+ crypto->header =bdrv_open_child (NULL , options,"header" , bs, + &child_of_bds,BDRV_CHILD_METADATA , + false, errp); +if (!crypto->header) { +return -EINVAL ; + } + } +GRAPH_RDLOCK_GUARD_MAINLOOP (); bs->supported_write_flags = BDRV_REQ_FUA &
block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 332
Quoted 4 lines
block/crypto.c +1
-0@@ -312,6 +329,14 @@ static int block_crypto_open_generic(QCryptoBlockFormat format, goto cleanup; } +if (crypto->detached_mode) {
if (crypto->header != NULL)
block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 337
Quoted 5 lines
block/crypto.c +5
-0+/* +* Set payload offset to zero as the file bdref has no LUKS +* header under detached mode. +*/ +qcrypto_block_set_payload_offset (crypto->block,0 );
The LUKS header stores the payload offset. If someone creates the LUKS volume with a detached header, they may still choose to put the payload at a non-zero offset.
So AFAICT, we should always honour the payload offset from the header,
even when detached. When formatting the header, we should default to
a zero offset though
Quoted 9 lines
block/crypto.c +2
-0+ } + bs->encrypted = true; ret =0 ;@@ -903,6 +928,17 @@ block_crypto_child_perms(BlockDriverState *bs, BdrvChild *c,BlockCrypto *crypto = bs->opaque;
block/crypto.c block_crypto_child_perms(BlockDriverState *bs, BdrvChild *c, · line 940
Quoted 10 lines
block/crypto.c +10
-0+if (role == (role &BDRV_CHILD_METADATA )) { +/* Assign read permission only */ + perm |=BLK_PERM_CONSISTENT_READ ; +/* Share all permissions */ + shared |=BLK_PERM_ALL ; + + *nperm = perm; + *nshared = shared; +return ; + }
What is code doing ? You've set BDRV_CHILD_METADATA role on the crypto->header object, but how does this block_crypto_child_perms method get run against crypto->header ?
Quoted 7 lines
block/crypto.c +1
-0+bdrv_default_perms (bs, c, role, reopen_queue, perm, shared, nperm, nshared);/* Signature · 1 line
2.39.1
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [v2 3/4] crypto: Support generic LUKS encryption
Quoted 82 lines · Daniel P. Berrangé
block/crypto.c static int block_crypto_read_func(QCryptoBlock
Quoted 65 lines · Hyman Huang
By enhancing the LUKS driver, it is possible to enable the detachable LUKS header and, as a result, achieve general encryption for any disk format that QEMU has supported.
Take the qcow2 as an example, the usage of the generic LUKS encryption as follows:
1. add a protocol blockdev node of data disk
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/test_disk.qcow2"}}'
2. add a protocol blockdev node of LUKS header as above.
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-2-storage", "driver":"file", "filename": "/path/to/cipher.gluks" }}'
3. add the secret for decrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type":"secret", "id":
"libvirt-2-storage-secret0", "data":"abc123"}}'4. add the qcow2-drived blockdev format node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-format", "driver":"qcow2", "file":"libvirt-1-storage"}}'
5. add the luks-drived blockdev to link the qcow2 disk with LUKS header by specifying the field "header"
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 3 lines
"arguments":{"node-name":"libvirt-2-format", "driver":"luks", "file":"libvirt-1-format", "header":"libvirt-2-storage", "key-secret":"libvirt-2-format-secret0"}}'
6. add the virtio-blk device finally
$ virsh qemu-monitor-command vm '{"execute":"device_add",Quoted 2 lines
"arguments": {"num-queues":"1", "driver":"virtio-blk-pci", "drive": "libvirt-2-format", "id":"virtio-disk2"}}'
The generic LUKS encryption method of starting a virtual machine (VM) is somewhat similar to hot-plug in that both maintaining the same json command while the starting VM changes the "blockdev-add/device_add" parameters to "blockdev/device".
Signed-off-by Hyman Huang <[email protected]>--- block/crypto.c | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-)block/crypto.c +1
-0@@ -40,6 +40,7 @@ struct BlockCrypto {QCryptoBlock *block;bool updating_keys;BdrvChild *header;/* Reference to the detached LUKS header */ +bool detached_mode;/* If true, LUKS plays a detached header role */ };@@ -64,12 +65,16 @@ static int block_crypto_read_func(QCryptoBlock*block,
Quoted 4 lines
block/crypto.c +1
-0Error **errp) {BlockDriverState *bs = opaque; +BlockCrypto *crypto = bs->opaque;block/crypto.c static int block_crypto_read_func(QCryptoBlock *block, · line 77
Quoted 10 lines
block/crypto.c +4
-1ssize_t ret;GLOBAL_STATE_CODE ();GRAPH_RDLOCK_GUARD_MAINLOOP (); - ret =bdrv_pread (bs->file, offset, buflen, buf,0 ); +if (crypto->detached_mode) + ret =bdrv_pread (crypto->header, offset, buflen, buf,0 ); +else + ret =bdrv_pread (bs->file, offset, buflen, buf,0 );
Quoted 5 lines
This can be simplified to:
ret = bdrv_pread(bs->header ? bs->header : file, offset, buflen, buf,0);
Ok.
Quoted 52 lines
block/crypto.c static int block_crypto_read_func(QCryptoBlock · line 79
Quoted 3 lines
block/crypto.c +0
-0if (ret <0 ) { error_setg_errno(errp, -ret, "Could not read encryptionheader");
block/crypto.c static int
Quoted 2 lines
block/crypto.c +0
-0return ret;@@ -269,6 +274,8 @@ static intblock_crypto_open_generic(QCryptoBlockFormat format,
block/crypto.c static int
Quoted 9 lines
block/crypto.c +2
-0QCryptoBlockOpenOptions *open_opts =NULL ;unsigned int cflags =0 ;QDict *cryptoopts =NULL ; +const char *header_bdref = +qdict_get_try_str (options,"header" );GLOBAL_STATE_CODE ();@@ -277,6 +284,16 @@ static intblock_crypto_open_generic(QCryptoBlockFormat format,
block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 288
Quoted 5 lines
block/crypto.c +2
-0return ret; } +if (header_bdref) { + crypto->detached_mode = true;Drop this flag since it has no benefit.
block/crypto.c static int · line 290
Quoted 2 lines
block/crypto.c +2
-0+ crypto->header = bdrv_open_child(NULL, options, "header", bs, + &child_of_bds,
BDRV_CHILD_METADATA,block/crypto.c static int
Quoted 10 lines
block/crypto.c +6
-0+ false, errp); +if (!crypto->header) { +return -EINVAL ; + } + } +GRAPH_RDLOCK_GUARD_MAINLOOP (); bs->supported_write_flags = BDRV_REQ_FUA &@@ -312,6 +329,14 @@ static intblock_crypto_open_generic(QCryptoBlockFormat format,
block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 332
Quoted 4 lines
block/crypto.c +1
-0goto cleanup; } +if (crypto->detached_mode) {if (
crypto->header!= NULL)block/crypto.c static int block_crypto_open_generic(QCryptoBlockFormat format, · line 337
Quoted 5 lines
block/crypto.c +5
-0+/* +* Set payload offset to zero as the file bdref has no LUKS +* header under detached mode. +*/ +qcrypto_block_set_payload_offset (crypto->block,0 );
Quoted 8 lines
The LUKS header stores the payload offset. If someone creates the LUKS volume with a detached header, they may still choose to put the payload at a non-zero offset.
So AFAICT, we should always honour the payload offset from the header,
even when detached. When formatting the header, we should default to
a zero offset though
Agree, I'll code in that way in the next version.
Quoted 22 lines
block/crypto.c block_crypto_child_perms(BlockDriverState *bs,
Quoted 7 lines
block/crypto.c +2
-0+ } + bs->encrypted = true; ret =0 ;@@ -903,6 +928,17 @@ block_crypto_child_perms(BlockDriverState *bs,BdrvChild *c,
block/crypto.c block_crypto_child_perms(BlockDriverState *bs, BdrvChild *c, · line 940
Quoted 13 lines
block/crypto.c +10
-0BlockCrypto *crypto = bs->opaque; +if (role == (role &BDRV_CHILD_METADATA )) { +/* Assign read permission only */ + perm |=BLK_PERM_CONSISTENT_READ ; +/* Share all permissions */ + shared |=BLK_PERM_ALL ; + + *nperm = perm; + *nshared = shared; +return ; + }
Quoted 4 lines
What is code doing ? You've set
BDRV_CHILD_METADATArole on thecrypto->headerobject, but how does thisblock_crypto_child_permsmethod get run againstcrypto->header?
This paragraph originally aims to provide a function that multiple disks could share
the same LUKS header (with read-only permission).
But I've found that it may not work when updating the detached header after reviewing the patch recently :(.
Should it be a separate commit, Since it kind of has nothing to do with the basic
function?
Quoted 24 lines
Quoted 6 lines
patchset.
+
bdrv_default_perms(bs, c, role,reopen_queue, perm, shared, nperm,nshared);
Quoted 5 lines
/*--
2.39.1With regards,
Daniel
--
|: https://berrange.com -o-
https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o-
https://fstop138.berrange.com :|
|: https://entangle-photo.org -o-
https://www.instagram.com/dberrange :|
Signature · 1 line
Best regards
Re: [v2 3/4] crypto: Support generic LUKS encryption
Quoted 29 lines · Yong Huang
Quoted 16 lines · Daniel P. Berrangé
Review block_crypto_child_perms(BlockDriverState *bs,
Quoted 1 line
(quoted diff) +0
-0@@ -903,6 +928,17 @@ block_crypto_child_perms(BlockDriverState *bs,BdrvChild *c,
block/crypto.c block_crypto_child_perms(BlockDriverState *bs, BdrvChild *c, · line 940
Quoted 13 lines
block/crypto.c +10
-0BlockCrypto *crypto = bs->opaque; +if (role == (role &BDRV_CHILD_METADATA )) { +/* Assign read permission only */ + perm |=BLK_PERM_CONSISTENT_READ ; +/* Share all permissions */ + shared |=BLK_PERM_ALL ; + + *nperm = perm; + *nshared = shared; +return ; + }Quoted 4 lines
What is code doing ? You've set
BDRV_CHILD_METADATArole on thecrypto->headerobject, but how does thisblock_crypto_child_permsmethod get run againstcrypto->header?This paragraph originally aims to provide a function that multiple disks could share
the same LUKS header (with read-only permission).
But I've found that it may not work when updating the detached header after reviewing the patch recently :(.
Quoted 3 lines
Should it be a separate commit, Since it kind of has nothing to do with the basic
function?
Yes, that would be better as a separate commit.
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH v2 4/4 block: Support detached LUKS header creation for blockdev-create
In reply to Hyman HuangProvide the "detached-mode" option for detached LUKS header formatting.
To format the LUKS header on the pre-creating disk, example as follows:
1. add a protocol blockdev node of LUKS header
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/cipher.gluks" }}'
2. add the secret for encrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type": "secret", "id":
"libvirt-1-storage-secret0", "data": "abc123"}}'
3. format the disk node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-create",Quoted 4 lines
"arguments":{"job-id":"job0", "options":{"driver":"luks", "size":0, "file":"libvirt-1-storage", "detached-mode":true, "cipher-alg":"aes-256", "key-secret":"libvirt-3-storage-encryption-secret0"}}}'
--- block/crypto.c | 8 +++++++- qapi/block-core.json | 5 ++++- 2 files changed, 11 insertions(+), 2 deletions(-)
block/crypto.c +7 -1
@@ -667,10 +667,12 @@ block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp)BlockDriverState *bs =NULL ;QCryptoBlockCreateOptions create_opts;PreallocMode preallocation =PREALLOC_MODE_OFF ; +int64_t size;int ret;assert (create_options->driver ==BLOCKDEV_DRIVER_LUKS ); luks_opts = &create_options->u.luks; + size = luks_opts->size; bs =bdrv_co_open_blockdev_ref (luks_opts->file, errp);if (bs ==NULL ) {
@@ -686,7 +688,11 @@ block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp) preallocation = luks_opts->preallocation; } - ret =block_crypto_co_create_generic (bs, luks_opts->size, &create_opts, +if (luks_opts->detached_mode) { + size =0 ; + } + + ret =block_crypto_co_create_generic (bs, size, &create_opts, preallocation, errp);if (ret <0 ) { goto fail;
qapi/block-core.json +4 -1
@@ -4952,13 +4952,16 @@ # @preallocation: Preallocation mode for the new image (since: 4.2) # (default: off; allowed values: off, metadata, falloc, full) # +# @detached-mode: create a detached LUKS header. (since 9.0) +# # Since: 2.12 ## { 'struct': 'BlockdevCreateOptionsLUKS', 'base': 'QCryptoBlockCreateOptionsLUKS', 'data': { 'file': 'BlockdevRef', 'size': 'size', - '*preallocation': 'PreallocMode' } } + '*preallocation': 'PreallocMode', + '*detached-mode': 'bool'}} ## # @BlockdevCreateOptionsNfs:
Signature · 1 line
2.39.1
Re: [v2 4/4] block: Support detached LUKS header creation for blockdev-create
Quoted 69 lines · Hyman Huang
Provide the "detached-mode" option for detached LUKS header formatting.
To format the LUKS header on the pre-creating disk, example as follows:
1. add a protocol blockdev node of LUKS header
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/cipher.gluks" }}'
2. add the secret for encrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type": "secret", "id":
"libvirt-1-storage-secret0", "data": "abc123"}}'3. format the disk node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-create",Quoted 4 lines
"arguments":{"job-id":"job0", "options":{"driver":"luks", "size":0, "file":"libvirt-1-storage", "detached-mode":true, "cipher-alg":"aes-256", "key-secret":"libvirt-3-storage-encryption-secret0"}}}'
Signed-off-by Hyman Huang <[email protected]>--- block/crypto.c | 8 +++++++- qapi/block-core.json | 5 ++++- 2 files changed, 11 insertions(+), 2 deletions(-)block/crypto.c +7
-1@@ -667,10 +667,12 @@ block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp)BlockDriverState *bs =NULL ;QCryptoBlockCreateOptions create_opts;PreallocMode preallocation =PREALLOC_MODE_OFF ; +int64_t size;int ret;assert (create_options->driver ==BLOCKDEV_DRIVER_LUKS ); luks_opts = &create_options->u.luks; + size = luks_opts->size; bs =bdrv_co_open_blockdev_ref (luks_opts->file, errp);if (bs ==NULL ) {@@ -686,7 +688,11 @@ block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp) preallocation = luks_opts->preallocation; } - ret =block_crypto_co_create_generic (bs, luks_opts->size, &create_opts, +if (luks_opts->detached_mode) { + size =0 ; + } + + ret =block_crypto_co_create_generic (bs, size, &create_opts, preallocation, errp);if (ret <0 ) { goto fail;qapi/block-core.json +1
-0@@ -4952,13 +4952,16 @@ # @preallocation: Preallocation mode for the new image (since: 4.2) # (default: off; allowed values: off, metadata, falloc, full) # +# @detached-mode: create a detached LUKS header. (since 9.0)
qapi/block-core.json line 4964
Quoted 10 lines
qapi/block-core.json +3
-1+# # Since: 2.12 ## { 'struct': 'BlockdevCreateOptionsLUKS', 'base': 'QCryptoBlockCreateOptionsLUKS', 'data': { 'file': 'BlockdevRef', 'size': 'size', - '*preallocation': 'PreallocMode' } } + '*preallocation': 'PreallocMode', + '*detached-mode': 'bool'}}
Using a bool flag here is insufficiently flexible. We need to be able to honour preallocation of the payload device, while using a separate header.
You need to make the existing 'file' optional, while also adding an extra optional 'header' field. ie
{ 'struct': 'BlockdevCreateOptionsLUKS',
'base': 'QCryptoBlockCreateOptionsLUKS',
'data': { '*file': 'BlockdevRef',
'*header': 'BlockdevRef',
'size': 'size',
'*preallocation': 'PreallocMode' } }
If 'preallocation' is requested, then we must enforce that 'file' is non-NULL in the code.
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [v2 4/4] block: Support detached LUKS header creation for blockdev-create
Quoted 99 lines · Daniel P. Berrangé
block/crypto.c block_crypto_co_create_luks(BlockdevCreateOptions
Quoted 35 lines · Hyman Huang
Provide the "detached-mode" option for detached LUKS header formatting.
To format the LUKS header on the pre-creating disk, example as follows:
1. add a protocol blockdev node of LUKS header
$ virsh qemu-monitor-command vm '{"execute":"blockdev-add",Quoted 2 lines
"arguments":{"node-name":"libvirt-1-storage", "driver":"file", "filename":"/path/to/cipher.gluks" }}'
2. add the secret for encrypting the cipher stored in LUKS header above
$ virsh qemu-monitor-command vm '{"execute":"object-add",Quoted 2 lines
"arguments":{"qom-type": "secret", "id":
"libvirt-1-storage-secret0", "data": "abc123"}}'3. format the disk node
$ virsh qemu-monitor-command vm '{"execute":"blockdev-create",Quoted 4 lines
"arguments":{"job-id":"job0", "options":{"driver":"luks", "size":0, "file":"libvirt-1-storage", "detached-mode":true, "cipher-alg":"aes-256", "key-secret":"libvirt-3-storage-encryption-secret0"}}}'
Signed-off-by Hyman Huang <[email protected]>--- block/crypto.c | 8 +++++++- qapi/block-core.json | 5 ++++- 2 files changed, 11 insertions(+), 2 deletions(-)block/crypto.c +0
-0@@ -667,10 +667,12 @@ block_crypto_co_create_luks(BlockdevCreateOptions
*create_options, Error **errp)block/crypto.c block_crypto_co_create_luks(BlockdevCreateOptions
Quoted 13 lines
block/crypto.c +2
-0BlockDriverState *bs =NULL ;QCryptoBlockCreateOptions create_opts;PreallocMode preallocation =PREALLOC_MODE_OFF ; +int64_t size;int ret;assert (create_options->driver ==BLOCKDEV_DRIVER_LUKS ); luks_opts = &create_options->u.luks; + size = luks_opts->size; bs =bdrv_co_open_blockdev_ref (luks_opts->file, errp);if (bs ==NULL ) {@@ -686,7 +688,11 @@ block_crypto_co_create_luks(BlockdevCreateOptions
*create_options, Error **errp)block/crypto.c block_crypto_co_create_luks(BlockdevCreateOptions *create_options, Error **errp)
Quoted 4 lines
block/crypto.c +0
-1preallocation = luks_opts->preallocation; } - ret = block_crypto_co_create_generic(bs, luks_opts->size,
&create_opts,Quoted 17 lines
block/crypto.c +5
-0+if (luks_opts->detached_mode) { + size =0 ; + } + + ret =block_crypto_co_create_generic (bs, size, &create_opts, preallocation, errp);if (ret <0 ) { goto fail;qapi/block-core.json +1
-0@@ -4952,13 +4952,16 @@ # @preallocation: Preallocation mode for the new image (since: 4.2) # (default: off; allowed values: off, metadata, falloc, full) # +# @detached-mode: create a detached LUKS header. (since 9.0)qapi/block-core.json line 4964
Quoted 10 lines
qapi/block-core.json +3
-1+# # Since: 2.12 ## { 'struct': 'BlockdevCreateOptionsLUKS', 'base': 'QCryptoBlockCreateOptionsLUKS', 'data': { 'file': 'BlockdevRef', 'size': 'size', - '*preallocation': 'PreallocMode' } } + '*preallocation': 'PreallocMode', + '*detached-mode': 'bool'}}Using a bool flag here is insufficiently flexible. We need to be able to honour preallocation of the payload device, while using a separate header.
You need to make the existing 'file' optional, while also adding an extra optional 'header' field. ie
{ 'struct': 'BlockdevCreateOptionsLUKS',
'base': 'QCryptoBlockCreateOptionsLUKS',
'data': { '*file': 'BlockdevRef',
'*header': 'BlockdevRef',
'size': 'size',
'*preallocation': 'PreallocMode' } }
Quoted 3 lines
If 'preallocation' is requested, then we must enforce that 'file' is non-NULL in the code.
Ok, thanks for the advice, I'll modify it in the next version.
Quoted 12 lines
With regards,
Daniel
--
|: https://berrange.com -o-
https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o-
https://fstop138.berrange.com :|
|: https://entangle-photo.org -o-
https://www.instagram.com/dberrange :|
Signature · 1 line
Best regards
Quoted 13 lines · Hyman Huang
v2:
- Simplify the design by reusing the LUKS driver to implement the generic Luks encryption, thank Daniel for the insightful advice.
- rebase on master.Hyman Huang (4):
crypto: Introduce option and structure for detached LUKS header
crypto: Introduce payload offset set function
crypto: Support generic LUKS encryption
block: Support detached LUKS header creation for blockdev-create
Quoted 5 lines
block/crypto.c | 47 ++++++++++++++++++++++++++++++++++++++++-- crypto/block.c | 4 ++++ include/crypto/block.h | 1 + qapi/block-core.json | 11 ++++++++-- 4 files changed, 59 insertions(+), 4 deletions(-)
Could you add a scenario tests/qemu-iotests/tests/luks-detached-header to provide coverage of this method feature.
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Quoted 14 lines · Daniel P. Berrangé
Quoted 13 lines · Hyman Huang
v2:
- Simplify the design by reusing the LUKS driver to implement the generic Luks encryption, thank Daniel for the insightful advice.
- rebase on master.Hyman Huang (4):
crypto: Introduce option and structure for detached LUKS header
crypto: Introduce payload offset set function
crypto: Support generic LUKS encryption
block: Support detached LUKS header creation for blockdev-create
Quoted 9 lines
Quoted 5 lines
block/crypto.c | 47 ++++++++++++++++++++++++++++++++++++++++-- crypto/block.c | 4 ++++ include/crypto/block.h | 1 + qapi/block-core.json | 11 ++++++++-- 4 files changed, 59 insertions(+), 4 deletions(-)Could you add a scenario tests/qemu-iotests/tests/luks-detached-header to provide coverage of this method feature.
Sure, of course.
Quoted 12 lines
With regards,
Daniel
--
|: https://berrange.com -o-
https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o-
https://fstop138.berrange.com :|
|: https://entangle-photo.org -o-
https://www.instagram.com/dberrange :|
Signature · 1 line
Best regards