Commit 6e2c32c3 authored by Hadi Moshayedi's avatar Hadi Moshayedi Committed by Konrad Sztyber
Browse files

doc: fix the example in docs for accel_crypto_key_create. 



1. Shorthand flag for `--key2` is `-e`. We were using `-k2`, which
errored out.

2. `spdk_accel_crypto_key_create` errors out if key lengths for AES_XTS
are not the same. Previously the weren't same, which errored out.

Change-Id: Id6ac90443bd189b347d3fdde5b425f43ab3b4b5e
Signed-off-by: default avatarHadi Moshayedi <hadi@ubicloud.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24379


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
parent e1aecaaa

doc/bdev.md

+3 −3
Original line number Diff line number Diff line
@@ -214,12 +214,12 @@ rpc.py must be twice as long than the key length in binary form. 


#### Example command



`rpc.py accel_crypto_key_create -c AES_XTS -k2 7859243a027411e581e0c40a35c8228f -k d16a2f3a9e9f5b32daefacd7f5984f4578add84425be4a0baa489b9de8884b09 -n sample_key`

`rpc.py accel_crypto_key_create -c AES_XTS -e 7859243a027411e581e0c40a35c8228f -k 10fee72b3d47553e065affdb48c54a81 -n sample_key`



This command will create a key called `sample_key`, the AES key

'd16a2f3a9e9f5b32daefacd7f5984f4578add84425be4a0baa489b9de8884b09' and the XTS key

'10fee72b3d47553e065affdb48c54a81' and the XTS key

'7859243a027411e581e0c40a35c8228f'. In other words, the compound AES_XTS key to be used is

'd16a2f3a9e9f5b32daefacd7f5984f4578add84425be4a0baa489b9de8884b097859243a027411e581e0c40a35c8228f'

'10fee72b3d47553e065affdb48c54a817859243a027411e581e0c40a35c8228f'



### Delete the virtual crypto block device