qapi/crypto.json

   1 # -*- Mode: Python -*-
   2 #
   3 # QAPI crypto definitions
   4
   5 ##
   6 # QCryptoTLSCredsEndpoint:
   7 #
   8 # The type of network endpoint that will be using the credentials.
   9 # Most types of credential require different setup / structures
  10 # depending on whether they will be used in a server versus a
  11 # client.
  12 #
  13 # @client: the network endpoint is acting as the client
  14 #
  15 # @server: the network endpoint is acting as the server
  16 #
  17 # Since: 2.5
  18 ##
  19 { 'enum': 'QCryptoTLSCredsEndpoint',
  20   'prefix': 'QCRYPTO_TLS_CREDS_ENDPOINT',
  21   'data': ['client', 'server']}
  22
  23
  24 ##
  25 # QCryptoSecretFormat:
  26 #
  27 # The data format that the secret is provided in
  28 #
  29 # @raw: raw bytes. When encoded in JSON only valid UTF-8 sequences can be used
  30 # @base64: arbitrary base64 encoded binary data
  31 # Since: 2.6
  32 ##
  33 { 'enum': 'QCryptoSecretFormat',
  34   'prefix': 'QCRYPTO_SECRET_FORMAT',
  35   'data': ['raw', 'base64']}
  36
  37
  38 ##
  39 # QCryptoHashAlgorithm:
  40 #
  41 # The supported algorithms for computing content digests
  42 #
  43 # @md5: MD5. Should not be used in any new code, legacy compat only
  44 # @sha1: SHA-1. Should not be used in any new code, legacy compat only
  45 # @sha224: SHA-224. (since 2.7)
  46 # @sha256: SHA-256. Current recommended strong hash.
  47 # @sha384: SHA-384. (since 2.7)
  48 # @sha512: SHA-512. (since 2.7)
  49 # @ripemd160: RIPEMD-160. (since 2.7)
  50 # Since: 2.6
  51 ##
  52 { 'enum': 'QCryptoHashAlgorithm',
  53   'prefix': 'QCRYPTO_HASH_ALG',
  54   'data': ['md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512', 'ripemd160']}
  55
  56
  57 ##
  58 # QCryptoCipherAlgorithm:
  59 #
  60 # The supported algorithms for content encryption ciphers
  61 #
  62 # @aes-128: AES with 128 bit / 16 byte keys
  63 # @aes-192: AES with 192 bit / 24 byte keys
  64 # @aes-256: AES with 256 bit / 32 byte keys
  65 # @des-rfb: RFB specific variant of single DES. Do not use except in VNC.
  66 # @cast5-128: Cast5 with 128 bit / 16 byte keys
  67 # @serpent-128: Serpent with 128 bit / 16 byte keys
  68 # @serpent-192: Serpent with 192 bit / 24 byte keys
  69 # @serpent-256: Serpent with 256 bit / 32 byte keys
  70 # @twofish-128: Twofish with 128 bit / 16 byte keys
  71 # @twofish-192: Twofish with 192 bit / 24 byte keys
  72 # @twofish-256: Twofish with 256 bit / 32 byte keys
  73 # Since: 2.6
  74 ##
  75 { 'enum': 'QCryptoCipherAlgorithm',
  76   'prefix': 'QCRYPTO_CIPHER_ALG',
  77   'data': ['aes-128', 'aes-192', 'aes-256',
  78            'des-rfb',
  79            'cast5-128',
  80            'serpent-128', 'serpent-192', 'serpent-256',
  81            'twofish-128', 'twofish-192', 'twofish-256']}
  82
  83
  84 ##
  85 # QCryptoCipherMode:
  86 #
  87 # The supported modes for content encryption ciphers
  88 #
  89 # @ecb: Electronic Code Book
  90 # @cbc: Cipher Block Chaining
  91 # @xts: XEX with tweaked code book and ciphertext stealing
  92 # Since: 2.6
  93 ##
  94 { 'enum': 'QCryptoCipherMode',
  95   'prefix': 'QCRYPTO_CIPHER_MODE',
  96   'data': ['ecb', 'cbc', 'xts']}
  97
  98
  99 ##
 100 # QCryptoIVGenAlgorithm:
 101 #
 102 # The supported algorithms for generating initialization
 103 # vectors for full disk encryption. The 'plain' generator
 104 # should not be used for disks with sector numbers larger
 105 # than 2^32, except where compatibility with pre-existing
 106 # Linux dm-crypt volumes is required.
 107 #
 108 # @plain: 64-bit sector number truncated to 32-bits
 109 # @plain64: 64-bit sector number
 110 # @essiv: 64-bit sector number encrypted with a hash of the encryption key
 111 # Since: 2.6
 112 ##
 113 { 'enum': 'QCryptoIVGenAlgorithm',
 114   'prefix': 'QCRYPTO_IVGEN_ALG',
 115   'data': ['plain', 'plain64', 'essiv']}
 116
 117 ##
 118 # QCryptoBlockFormat:
 119 #
 120 # The supported full disk encryption formats
 121 #
 122 # @qcow: QCow/QCow2 built-in AES-CBC encryption. Use only
 123 #        for liberating data from old images.
 124 # @luks: LUKS encryption format. Recommended for new images
 125 #
 126 # Since: 2.6
 127 ##
 128 { 'enum': 'QCryptoBlockFormat',
 129 #  'prefix': 'QCRYPTO_BLOCK_FORMAT',
 130   'data': ['qcow', 'luks']}
 131
 132 ##
 133 # QCryptoBlockOptionsBase:
 134 #
 135 # The common options that apply to all full disk
 136 # encryption formats
 137 #
 138 # @format: the encryption format
 139 #
 140 # Since: 2.6
 141 ##
 142 { 'struct': 'QCryptoBlockOptionsBase',
 143   'data': { 'format': 'QCryptoBlockFormat' }}
 144
 145 ##
 146 # QCryptoBlockOptionsQCow:
 147 #
 148 # The options that apply to QCow/QCow2 AES-CBC encryption format
 149 #
 150 # @key-secret: #optional the ID of a QCryptoSecret object providing the
 151 #              decryption key. Mandatory except when probing image for
 152 #              metadata only.
 153 #
 154 # Since: 2.6
 155 ##
 156 { 'struct': 'QCryptoBlockOptionsQCow',
 157   'data': { '*key-secret': 'str' }}
 158
 159 ##
 160 # QCryptoBlockOptionsLUKS:
 161 #
 162 # The options that apply to LUKS encryption format
 163 #
 164 # @key-secret: #optional the ID of a QCryptoSecret object providing the
 165 #              decryption key. Mandatory except when probing image for
 166 #              metadata only.
 167 # Since: 2.6
 168 ##
 169 { 'struct': 'QCryptoBlockOptionsLUKS',
 170   'data': { '*key-secret': 'str' }}
 171
 172
 173 ##
 174 # QCryptoBlockCreateOptionsLUKS:
 175 #
 176 # The options that apply to LUKS encryption format initialization
 177 #
 178 # @cipher-alg: #optional the cipher algorithm for data encryption
 179 #              Currently defaults to 'aes'.
 180 # @cipher-mode: #optional the cipher mode for data encryption
 181 #               Currently defaults to 'cbc'
 182 # @ivgen-alg: #optional the initialization vector generator
 183 #             Currently defaults to 'essiv'
 184 # @ivgen-hash-alg: #optional the initialization vector generator hash
 185 #                  Currently defaults to 'sha256'
 186 # @hash-alg: #optional the master key hash algorithm
 187 #            Currently defaults to 'sha256'
 188 # Since: 2.6
 189 ##
 190 { 'struct': 'QCryptoBlockCreateOptionsLUKS',
 191   'base': 'QCryptoBlockOptionsLUKS',
 192   'data': { '*cipher-alg': 'QCryptoCipherAlgorithm',
 193             '*cipher-mode': 'QCryptoCipherMode',
 194             '*ivgen-alg': 'QCryptoIVGenAlgorithm',
 195             '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
 196             '*hash-alg': 'QCryptoHashAlgorithm'}}
 197
 198
 199 ##
 200 # QCryptoBlockOpenOptions:
 201 #
 202 # The options that are available for all encryption formats
 203 # when opening an existing volume
 204 #
 205 # Since: 2.6
 206 ##
 207 { 'union': 'QCryptoBlockOpenOptions',
 208   'base': 'QCryptoBlockOptionsBase',
 209   'discriminator': 'format',
 210   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
 211             'luks': 'QCryptoBlockOptionsLUKS' } }
 212
 213
 214 ##
 215 # QCryptoBlockCreateOptions:
 216 #
 217 # The options that are available for all encryption formats
 218 # when initializing a new volume
 219 #
 220 # Since: 2.6
 221 ##
 222 { 'union': 'QCryptoBlockCreateOptions',
 223   'base': 'QCryptoBlockOptionsBase',
 224   'discriminator': 'format',
 225   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
 226             'luks': 'QCryptoBlockCreateOptionsLUKS' } }
 227
 228
 229 ##
 230 # QCryptoBlockInfoBase:
 231 #
 232 # The common information that applies to all full disk
 233 # encryption formats
 234 #
 235 # @format: the encryption format
 236 #
 237 # Since: 2.7
 238 ##
 239 { 'struct': 'QCryptoBlockInfoBase',
 240   'data': { 'format': 'QCryptoBlockFormat' }}
 241
 242
 243 ##
 244 # QCryptoBlockInfoLUKSSlot:
 245 #
 246 # Information about the LUKS block encryption key
 247 # slot options
 248 #
 249 # @active: whether the key slot is currently in use
 250 # @key-offset: offset to the key material in bytes
 251 # @iters: #optional number of PBKDF2 iterations for key material
 252 # @stripes: #optional number of stripes for splitting key material
 253 #
 254 # Since: 2.7
 255 ##
 256 { 'struct': 'QCryptoBlockInfoLUKSSlot',
 257   'data': {'active': 'bool',
 258            '*iters': 'int',
 259            '*stripes': 'int',
 260            'key-offset': 'int' } }
 261
 262
 263 ##
 264 # QCryptoBlockInfoLUKS:
 265 #
 266 # Information about the LUKS block encryption options
 267 #
 268 # @cipher-alg: the cipher algorithm for data encryption
 269 # @cipher-mode: the cipher mode for data encryption
 270 # @ivgen-alg: the initialization vector generator
 271 # @ivgen-hash-alg: #optional the initialization vector generator hash
 272 # @hash-alg: the master key hash algorithm
 273 # @payload-offset: offset to the payload data in bytes
 274 # @master-key-iters: number of PBKDF2 iterations for key material
 275 # @uuid: unique identifier for the volume
 276 # @slots: information about each key slot
 277 #
 278 # Since: 2.7
 279 ##
 280 { 'struct': 'QCryptoBlockInfoLUKS',
 281   'data': {'cipher-alg': 'QCryptoCipherAlgorithm',
 282            'cipher-mode': 'QCryptoCipherMode',
 283            'ivgen-alg': 'QCryptoIVGenAlgorithm',
 284            '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
 285            'hash-alg': 'QCryptoHashAlgorithm',
 286            'payload-offset': 'int',
 287            'master-key-iters': 'int',
 288            'uuid': 'str',
 289            'slots': [ 'QCryptoBlockInfoLUKSSlot' ] }}
 290
 291 ##
 292 # QCryptoBlockInfoQCow:
 293 #
 294 # Information about the QCow block encryption options
 295 #
 296 # Since: 2.7
 297 ##
 298 { 'struct': 'QCryptoBlockInfoQCow',
 299   'data': { }}
 300
 301
 302 ##
 303 # QCryptoBlockInfo:
 304 #
 305 # Information about the block encryption options
 306 #
 307 # Since: 2.7
 308 ##
 309 { 'union': 'QCryptoBlockInfo',
 310   'base': 'QCryptoBlockInfoBase',
 311   'discriminator': 'format',
 312   'data': { 'qcow': 'QCryptoBlockInfoQCow',
 313             'luks': 'QCryptoBlockInfoLUKS' } }