hppa-softmmu.mak: express dependencies with Kconfig

[qemu.git] / qapi / crypto.json

diff --git a/qapi/crypto.json b/qapi/crypto.json
index 34d2583154c158ee16e7fc82395ff3394ab797f2..b2a4cff683ff62a208c269630212a9a4c1198495 100644 (file)
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -1,9 +1,12 @@
 # -*- Mode: Python -*-
 #
 # -*- Mode: Python -*-
 #

-# QAPI crypto definitions

 
 ##
 
 ##

-# QCryptoTLSCredsEndpoint:
+# = Cryptography
+##
+
+##
+# @QCryptoTLSCredsEndpoint:

 #
 # The type of network endpoint that will be using the credentials.
 # Most types of credential require different setup / structures
 #
 # The type of network endpoint that will be using the credentials.
 # Most types of credential require different setup / structures


@@ -22,7 +25,7 @@
 
 
 ##
 
 
 ##

-# QCryptoSecretFormat:
+# @QCryptoSecretFormat:

 #
 # The data format that the secret is provided in
 #
 #
 # The data format that the secret is provided in
 #


@@ -36,7 +39,7 @@
 
 
 ##
 
 
 ##

-# QCryptoHashAlgorithm:
+# @QCryptoHashAlgorithm:

 #
 # The supported algorithms for computing content digests
 #
 #
 # The supported algorithms for computing content digests
 #


@@ -55,7 +58,7 @@
 
 
 ##
 
 
 ##

-# QCryptoCipherAlgorithm:
+# @QCryptoCipherAlgorithm:

 #
 # The supported algorithms for content encryption ciphers
 #
 #
 # The supported algorithms for content encryption ciphers
 #


@@ -63,6 +66,7 @@
 # @aes-192: AES with 192 bit / 24 byte keys
 # @aes-256: AES with 256 bit / 32 byte keys
 # @des-rfb: RFB specific variant of single DES. Do not use except in VNC.
 # @aes-192: AES with 192 bit / 24 byte keys
 # @aes-256: AES with 256 bit / 32 byte keys
 # @des-rfb: RFB specific variant of single DES. Do not use except in VNC.

+# @3des: 3DES(EDE) with 192 bit / 24 byte keys (since 2.9)

 # @cast5-128: Cast5 with 128 bit / 16 byte keys
 # @serpent-128: Serpent with 128 bit / 16 byte keys
 # @serpent-192: Serpent with 192 bit / 24 byte keys
 # @cast5-128: Cast5 with 128 bit / 16 byte keys
 # @serpent-128: Serpent with 128 bit / 16 byte keys
 # @serpent-192: Serpent with 192 bit / 24 byte keys


@@ -75,29 +79,30 @@
 { 'enum': 'QCryptoCipherAlgorithm',
   'prefix': 'QCRYPTO_CIPHER_ALG',
   'data': ['aes-128', 'aes-192', 'aes-256',
 { 'enum': 'QCryptoCipherAlgorithm',
   'prefix': 'QCRYPTO_CIPHER_ALG',
   'data': ['aes-128', 'aes-192', 'aes-256',

-           'des-rfb',
+           'des-rfb', '3des',

            'cast5-128',
            'serpent-128', 'serpent-192', 'serpent-256',
            'twofish-128', 'twofish-192', 'twofish-256']}
 
 
 ##
            'cast5-128',
            'serpent-128', 'serpent-192', 'serpent-256',
            'twofish-128', 'twofish-192', 'twofish-256']}
 
 
 ##

-# QCryptoCipherMode:
+# @QCryptoCipherMode:

 #
 # The supported modes for content encryption ciphers
 #
 # @ecb: Electronic Code Book
 # @cbc: Cipher Block Chaining
 # @xts: XEX with tweaked code book and ciphertext stealing
 #
 # The supported modes for content encryption ciphers
 #
 # @ecb: Electronic Code Book
 # @cbc: Cipher Block Chaining
 # @xts: XEX with tweaked code book and ciphertext stealing

+# @ctr: Counter (Since 2.8)

 # Since: 2.6
 ##
 { 'enum': 'QCryptoCipherMode',
   'prefix': 'QCRYPTO_CIPHER_MODE',
 # Since: 2.6
 ##
 { 'enum': 'QCryptoCipherMode',
   'prefix': 'QCRYPTO_CIPHER_MODE',

-  'data': ['ecb', 'cbc', 'xts']}
+  'data': ['ecb', 'cbc', 'xts', 'ctr']}

 
 
 ##
 
 
 ##

-# QCryptoIVGenAlgorithm:
+# @QCryptoIVGenAlgorithm:

 #
 # The supported algorithms for generating initialization
 # vectors for full disk encryption. The 'plain' generator
 #
 # The supported algorithms for generating initialization
 # vectors for full disk encryption. The 'plain' generator


@@ -115,7 +120,7 @@
   'data': ['plain', 'plain64', 'essiv']}
 
 ##
   'data': ['plain', 'plain64', 'essiv']}
 
 ##

-# QCryptoBlockFormat:
+# @QCryptoBlockFormat:

 #
 # The supported full disk encryption formats
 #
 #
 # The supported full disk encryption formats
 #


@@ -130,7 +135,7 @@
   'data': ['qcow', 'luks']}
 
 ##
   'data': ['qcow', 'luks']}
 
 ##

-# QCryptoBlockOptionsBase:
+# @QCryptoBlockOptionsBase:

 #
 # The common options that apply to all full disk
 # encryption formats
 #
 # The common options that apply to all full disk
 # encryption formats


@@ -143,11 +148,11 @@
   'data': { 'format': 'QCryptoBlockFormat' }}
 
 ##
   'data': { 'format': 'QCryptoBlockFormat' }}
 
 ##

-# QCryptoBlockOptionsQCow:
+# @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: #optional the ID of a QCryptoSecret object providing the
+# @key-secret: the ID of a QCryptoSecret object providing the

 #              decryption key. Mandatory except when probing image for
 #              metadata only.
 #
 #              decryption key. Mandatory except when probing image for
 #              metadata only.
 #


@@ -157,11 +162,11 @@
   'data': { '*key-secret': 'str' }}
 
 ##
   'data': { '*key-secret': 'str' }}
 
 ##

-# QCryptoBlockOptionsLUKS:
+# @QCryptoBlockOptionsLUKS:

 #
 # The options that apply to LUKS encryption format
 #
 #
 # The options that apply to LUKS encryption format
 #

-# @key-secret: #optional the ID of a QCryptoSecret object providing the
+# @key-secret: the ID of a QCryptoSecret object providing the

 #              decryption key. Mandatory except when probing image for
 #              metadata only.
 # Since: 2.6
 #              decryption key. Mandatory except when probing image for
 #              metadata only.
 # Since: 2.6


@@ -171,20 +176,23 @@
 
 
 ##
 
 
 ##

-# QCryptoBlockCreateOptionsLUKS:
+# @QCryptoBlockCreateOptionsLUKS:

 #
 # The options that apply to LUKS encryption format initialization
 #
 #
 # The options that apply to LUKS encryption format initialization
 #

-# @cipher-alg: #optional the cipher algorithm for data encryption
-#              Currently defaults to 'aes'.
-# @cipher-mode: #optional the cipher mode for data encryption
-#               Currently defaults to 'cbc'
-# @ivgen-alg: #optional the initialization vector generator
-#             Currently defaults to 'essiv'
-# @ivgen-hash-alg: #optional the initialization vector generator hash
+# @cipher-alg: the cipher algorithm for data encryption
+#              Currently defaults to 'aes-256'.
+# @cipher-mode: the cipher mode for data encryption
+#               Currently defaults to 'xts'
+# @ivgen-alg: the initialization vector generator
+#             Currently defaults to 'plain64'
+# @ivgen-hash-alg: the initialization vector generator hash

 #                  Currently defaults to 'sha256'
 #                  Currently defaults to 'sha256'

-# @hash-alg: #optional the master key hash algorithm
+# @hash-alg: the master key hash algorithm

 #            Currently defaults to 'sha256'
 #            Currently defaults to 'sha256'

+# @iter-time: number of milliseconds to spend in
+#             PBKDF passphrase processing. Currently defaults
+#             to 2000. (since 2.8)

 # Since: 2.6
 ##
 { 'struct': 'QCryptoBlockCreateOptionsLUKS',
 # Since: 2.6
 ##
 { 'struct': 'QCryptoBlockCreateOptionsLUKS',


@@ -193,11 +201,12 @@
             '*cipher-mode': 'QCryptoCipherMode',
             '*ivgen-alg': 'QCryptoIVGenAlgorithm',
             '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
             '*cipher-mode': 'QCryptoCipherMode',
             '*ivgen-alg': 'QCryptoIVGenAlgorithm',
             '*ivgen-hash-alg': 'QCryptoHashAlgorithm',

-            '*hash-alg': 'QCryptoHashAlgorithm'}}
+            '*hash-alg': 'QCryptoHashAlgorithm',
+            '*iter-time': 'int'}}

 
 
 ##
 
 
 ##

-# QCryptoBlockOpenOptions:
+# @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


@@ -212,7 +221,7 @@
 
 
 ##
 
 
 ##

-# QCryptoBlockCreateOptions:
+# @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


@@ -227,7 +236,7 @@
 
 
 ##
 
 
 ##

-# QCryptoBlockInfoBase:
+# @QCryptoBlockInfoBase:

 #
 # The common information that applies to all full disk
 # encryption formats
 #
 # The common information that applies to all full disk
 # encryption formats


@@ -241,15 +250,15 @@
 
 
 ##
 
 
 ##

-# QCryptoBlockInfoLUKSSlot:
+# @QCryptoBlockInfoLUKSSlot:

 #
 # Information about the LUKS block encryption key
 # slot options
 #
 # @active: whether the key slot is currently in use
 # @key-offset: offset to the key material in bytes
 #
 # Information about the LUKS block encryption key
 # slot options
 #
 # @active: whether the key slot is currently in use
 # @key-offset: offset to the key material in bytes

-# @iters: #optional number of PBKDF2 iterations for key material
-# @stripes: #optional number of stripes for splitting key material
+# @iters: number of PBKDF2 iterations for key material
+# @stripes: number of stripes for splitting key material

 #
 # Since: 2.7
 ##
 #
 # Since: 2.7
 ##


@@ -261,14 +270,14 @@
 
 
 ##
 
 
 ##

-# QCryptoBlockInfoLUKS:
+# @QCryptoBlockInfoLUKS:

 #
 # Information about the LUKS block encryption options
 #
 # @cipher-alg: the cipher algorithm for data encryption
 # @cipher-mode: the cipher mode for data encryption
 # @ivgen-alg: the initialization vector generator
 #
 # Information about the LUKS block encryption options
 #
 # @cipher-alg: the cipher algorithm for data encryption
 # @cipher-mode: the cipher mode for data encryption
 # @ivgen-alg: the initialization vector generator

-# @ivgen-hash-alg: #optional the initialization vector generator hash
+# @ivgen-hash-alg: the initialization vector generator hash

 # @hash-alg: the master key hash algorithm
 # @payload-offset: offset to the payload data in bytes
 # @master-key-iters: number of PBKDF2 iterations for key material
 # @hash-alg: the master key hash algorithm
 # @payload-offset: offset to the payload data in bytes
 # @master-key-iters: number of PBKDF2 iterations for key material


@@ -288,19 +297,9 @@
            'uuid': 'str',
            'slots': [ 'QCryptoBlockInfoLUKSSlot' ] }}
 
            'uuid': 'str',
            'slots': [ 'QCryptoBlockInfoLUKSSlot' ] }}
 

-##
-# QCryptoBlockInfoQCow:
-#
-# Information about the QCow block encryption options
-#
-# Since: 2.7
-##
-{ 'struct': 'QCryptoBlockInfoQCow',
-  'data': { }}
-

 
 ##
 
 ##

-# QCryptoBlockInfo:
+# @QCryptoBlockInfo:

 #
 # Information about the block encryption options
 #
 #
 # Information about the block encryption options
 #


@@ -309,5 +308,4 @@
 { 'union': 'QCryptoBlockInfo',
   'base': 'QCryptoBlockInfoBase',
   'discriminator': 'format',
 { 'union': 'QCryptoBlockInfo',
   'base': 'QCryptoBlockInfoBase',
   'discriminator': 'format',

-  'data': { 'qcow': 'QCryptoBlockInfoQCow',
-            'luks': 'QCryptoBlockInfoLUKS' } }
+  'data': { 'luks': 'QCryptoBlockInfoLUKS' } }