[PATCH v2 34/44] qapi: convert trivial intro sections for crypto.json
John Snow <[email protected]> Thu, 23 Jul 2026 00:47:55 -0400
| Newsgroups | org.nongnu.qemu-trivial,org.kernel.vger.linux-cxl,org.kernel.vger.linux-edac,org.nongnu.qemu-devel |
|---|---|
| Message-ID | <[email protected]> |
(Trivial) Signed-off-by: John Snow <[email protected]> --- qapi/crypto.json | 118 ++++++++++++++++++----------------------------- 1 file changed, 45 insertions(+), 73 deletions(-) diff --git a/qapi/crypto.json b/qapi/crypto.json index 2b55befef97..5c821be1a33 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -10,10 +10,10 @@ ## # @QCryptoTLSCredsEndpoint: -# -# The type of network endpoint that will be using the credentials. -# Most types of credential require different setup / structures -# depending on whether they will be used in a server versus a client. +# The type of network endpoint that will be using the credentials. +# Most types of credential require different setup / structures +# depending on whether they will be used in a server versus a +# client. # # @client: the network endpoint is acting as the client # @@ -26,8 +26,7 @@ ## # @QCryptoSecretFormat: -# -# The data format that the secret is provided in +# The data format that the secret is provided in # # @raw: raw bytes. When encoded in JSON only valid UTF-8 sequences # can be used @@ -41,8 +40,7 @@ ## # @QCryptoHashAlgo: -# -# The supported algorithms for computing content digests +# The supported algorithms for computing content digests # # @md5: MD5. Should not be used in any new code, legacy compat only # @@ -68,8 +66,7 @@ ## # @QCryptoCipherAlgo: -# -# The supported algorithms for content encryption ciphers +# The supported algorithms for content encryption ciphers # # @aes-128: AES with 128 bit / 16 byte keys # @@ -110,8 +107,7 @@ ## # @QCryptoCipherMode: -# -# The supported modes for content encryption ciphers +# The supported modes for content encryption ciphers # # @ecb: Electronic Code Book # @@ -128,11 +124,11 @@ ## # @QCryptoIVGenAlgo: -# -# The supported algorithms for generating initialization vectors for -# full disk encryption. The 'plain' generator should not be used for -# disks with sector numbers larger than 2^32, except where -# compatibility with pre-existing Linux dm-crypt volumes is required. +# The supported algorithms for generating initialization vectors +# for full disk encryption. The 'plain' generator should not be +# used for disks with sector numbers larger than 2^32, except +# where compatibility with pre-existing Linux dm-crypt volumes is +# required. # # @plain: 64-bit sector number truncated to 32-bits # @@ -148,8 +144,7 @@ ## # @QCryptoBlockFormat: -# -# The supported full disk encryption formats +# The supported full disk encryption formats # # @qcow: QCow/QCow2 built-in AES-CBC encryption. Use only for # liberating data from old images. @@ -163,8 +158,8 @@ ## # @QCryptoBlockOptionsBase: -# -# The common options that apply to all full disk encryption formats +# The common options that apply to all full disk encryption +# formats # # @format: the encryption format # @@ -175,8 +170,7 @@ ## # @QCryptoBlockOptionsQCow: -# -# The options that apply to QCow/QCow2 AES-CBC encryption format +# The options that apply to QCow/QCow2 AES-CBC encryption format # # @key-secret: the ID of a QCryptoSecret object providing the # decryption key. Mandatory except when probing image for @@ -189,8 +183,7 @@ ## # @QCryptoBlockOptionsLUKS: -# -# The options that apply to LUKS encryption format +# The options that apply to LUKS encryption format # # @key-secret: the ID of a QCryptoSecret object providing the # decryption key. Mandatory except when probing image for @@ -203,8 +196,7 @@ ## # @QCryptoBlockCreateOptionsLUKS: -# -# The options that apply to LUKS encryption format initialization +# The options that apply to LUKS encryption format initialization # # @cipher-alg: the cipher algorithm for data encryption. Currently # defaults to 'aes-256'. @@ -237,9 +229,8 @@ ## # @QCryptoBlockOpenOptions: -# -# The options that are available for all encryption formats when -# opening an existing volume +# The options that are available for all encryption formats when +# opening an existing volume # # Since: 2.6 ## @@ -251,9 +242,8 @@ ## # @QCryptoBlockCreateOptions: -# -# The options that are available for all encryption formats when -# initializing a new volume +# The options that are available for all encryption formats when +# initializing a new volume # # Since: 2.6 ## @@ -265,9 +255,8 @@ ## # @QCryptoBlockInfoBase: -# -# The common information that applies to all full disk encryption -# formats +# The common information that applies to all full disk encryption +# formats # # @format: the encryption format # @@ -278,8 +267,7 @@ ## # @QCryptoBlockInfoLUKSSlot: -# -# Information about the LUKS block encryption key slot options +# Information about the LUKS block encryption key slot options # # @active: whether the key slot is currently in use # @@ -299,8 +287,7 @@ ## # @QCryptoBlockInfoLUKS: -# -# Information about the LUKS block encryption options +# Information about the LUKS block encryption options # # @cipher-alg: the cipher algorithm for data encryption # @@ -338,8 +325,7 @@ ## # @QCryptoBlockInfo: -# -# Information about the block encryption options +# Information about the block encryption options # # Since: 2.7 ## @@ -350,8 +336,7 @@ ## # @QCryptoBlockLUKSKeyslotState: -# -# Defines state of keyslots that are affected by the update +# Defines state of keyslots that are affected by the update # # @active: The slots contain the given password and marked as active # @@ -365,9 +350,8 @@ ## # @QCryptoBlockAmendOptionsLUKS: -# -# This struct defines the update parameters that activate/de-activate -# set of keyslots +# This struct defines the update parameters that +# activate/de-activate set of keyslots # # @state: the desired state of the keyslots # @@ -407,9 +391,8 @@ ## # @QCryptoBlockAmendOptions: -# -# The options that are available for all encryption formats when -# amending encryption settings +# The options that are available for all encryption formats when +# amending encryption settings # # Since: 5.1 ## @@ -421,8 +404,7 @@ ## # @SecretCommonProperties: -# -# Properties for objects of classes derived from secret-common. +# Properties for objects of classes derived from secret-common. # # @format: the data format that the secret is provided in # (default: raw) @@ -463,8 +445,7 @@ ## # @SecretKeyringProperties: -# -# Properties for secret_keyring objects. +# Properties for secret_keyring objects. # # @serial: serial number that identifies a key to get from the kernel # @@ -477,8 +458,7 @@ ## # @TlsCredsProperties: -# -# Properties for objects of classes derived from tls-creds. +# Properties for objects of classes derived from tls-creds. # # @verify-peer: if true the peer credentials will be verified once the # handshake is completed. This is a no-op for anonymous @@ -503,8 +483,7 @@ ## # @TlsCredsAnonProperties: -# -# Properties for tls-creds-anon objects. +# Properties for tls-creds-anon objects. # # Since: 2.5 ## @@ -514,8 +493,7 @@ ## # @TlsCredsPskProperties: -# -# Properties for tls-creds-psk objects. +# Properties for tls-creds-psk objects. # # @username: the username which will be sent to the server. For # clients only. If absent, "qemu" is sent and the property will @@ -529,8 +507,7 @@ ## # @TlsCredsX509Properties: -# -# Properties for tls-creds-x509 objects. +# Properties for tls-creds-x509 objects. # # @sanity-check: if true, perform some sanity checks before using the # credentials (default: true) @@ -550,8 +527,7 @@ ## # @QCryptoAkCipherAlgo: -# -# The supported algorithms for asymmetric encryption ciphers +# The supported algorithms for asymmetric encryption ciphers # # @rsa: RSA algorithm # @@ -562,8 +538,7 @@ ## # @QCryptoAkCipherKeyType: -# -# The type of asymmetric keys. +# The type of asymmetric keys. # # @public: public key # @@ -576,8 +551,7 @@ ## # @QCryptoRSAPaddingAlgo: -# -# The padding algorithm for RSA. +# The padding algorithm for RSA. # # @raw: no padding used # @@ -590,8 +564,7 @@ ## # @QCryptoAkCipherOptionsRSA: -# -# Specific parameters for RSA algorithm. +# Specific parameters for RSA algorithm. # # @hash-alg: `QCryptoHashAlgo` # @@ -605,9 +578,8 @@ ## # @QCryptoAkCipherOptions: -# -# The options that are available for all asymmetric key algorithms -# when creating a new QCryptoAkCipher. +# The options that are available for all asymmetric key algorithms +# when creating a new QCryptoAkCipher. # # @alg: encryption cipher algorithm # -- 2.55.0