ui/gtk: fix "Copy" menu item segfault
[qemu/ar7.git] / qapi / crypto.json
blob15d296e3c1dea098123a19bbabcd9dbb1417890f
1 # -*- Mode: Python -*-
3 # QAPI crypto definitions
5 ##
6 # @QCryptoTLSCredsEndpoint:
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.
13 # @client: the network endpoint is acting as the client
15 # @server: the network endpoint is acting as the server
17 # Since: 2.5
19 { 'enum': 'QCryptoTLSCredsEndpoint',
20   'prefix': 'QCRYPTO_TLS_CREDS_ENDPOINT',
21   'data': ['client', 'server']}
25 # @QCryptoSecretFormat:
27 # The data format that the secret is provided in
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
33 { 'enum': 'QCryptoSecretFormat',
34   'prefix': 'QCRYPTO_SECRET_FORMAT',
35   'data': ['raw', 'base64']}
39 # @QCryptoHashAlgorithm:
41 # The supported algorithms for computing content digests
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
52 { 'enum': 'QCryptoHashAlgorithm',
53   'prefix': 'QCRYPTO_HASH_ALG',
54   'data': ['md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512', 'ripemd160']}
58 # @QCryptoCipherAlgorithm:
60 # The supported algorithms for content encryption ciphers
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
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']}
85 # @QCryptoCipherMode:
87 # The supported modes for content encryption ciphers
89 # @ecb: Electronic Code Book
90 # @cbc: Cipher Block Chaining
91 # @xts: XEX with tweaked code book and ciphertext stealing
92 # @ctr: Counter (Since 2.8)
93 # Since: 2.6
95 { 'enum': 'QCryptoCipherMode',
96   'prefix': 'QCRYPTO_CIPHER_MODE',
97   'data': ['ecb', 'cbc', 'xts', 'ctr']}
101 # @QCryptoIVGenAlgorithm:
103 # The supported algorithms for generating initialization
104 # vectors for full disk encryption. The 'plain' generator
105 # should not be used for disks with sector numbers larger
106 # than 2^32, except where compatibility with pre-existing
107 # Linux dm-crypt volumes is required.
109 # @plain: 64-bit sector number truncated to 32-bits
110 # @plain64: 64-bit sector number
111 # @essiv: 64-bit sector number encrypted with a hash of the encryption key
112 # Since: 2.6
114 { 'enum': 'QCryptoIVGenAlgorithm',
115   'prefix': 'QCRYPTO_IVGEN_ALG',
116   'data': ['plain', 'plain64', 'essiv']}
119 # @QCryptoBlockFormat:
121 # The supported full disk encryption formats
123 # @qcow: QCow/QCow2 built-in AES-CBC encryption. Use only
124 #        for liberating data from old images.
125 # @luks: LUKS encryption format. Recommended for new images
127 # Since: 2.6
129 { 'enum': 'QCryptoBlockFormat',
130 #  'prefix': 'QCRYPTO_BLOCK_FORMAT',
131   'data': ['qcow', 'luks']}
134 # @QCryptoBlockOptionsBase:
136 # The common options that apply to all full disk
137 # encryption formats
139 # @format: the encryption format
141 # Since: 2.6
143 { 'struct': 'QCryptoBlockOptionsBase',
144   'data': { 'format': 'QCryptoBlockFormat' }}
147 # @QCryptoBlockOptionsQCow:
149 # The options that apply to QCow/QCow2 AES-CBC encryption format
151 # @key-secret: #optional the ID of a QCryptoSecret object providing the
152 #              decryption key. Mandatory except when probing image for
153 #              metadata only.
155 # Since: 2.6
157 { 'struct': 'QCryptoBlockOptionsQCow',
158   'data': { '*key-secret': 'str' }}
161 # @QCryptoBlockOptionsLUKS:
163 # The options that apply to LUKS encryption format
165 # @key-secret: #optional the ID of a QCryptoSecret object providing the
166 #              decryption key. Mandatory except when probing image for
167 #              metadata only.
168 # Since: 2.6
170 { 'struct': 'QCryptoBlockOptionsLUKS',
171   'data': { '*key-secret': 'str' }}
175 # @QCryptoBlockCreateOptionsLUKS:
177 # The options that apply to LUKS encryption format initialization
179 # @cipher-alg: #optional the cipher algorithm for data encryption
180 #              Currently defaults to 'aes'.
181 # @cipher-mode: #optional the cipher mode for data encryption
182 #               Currently defaults to 'cbc'
183 # @ivgen-alg: #optional the initialization vector generator
184 #             Currently defaults to 'essiv'
185 # @ivgen-hash-alg: #optional the initialization vector generator hash
186 #                  Currently defaults to 'sha256'
187 # @hash-alg: #optional the master key hash algorithm
188 #            Currently defaults to 'sha256'
189 # @iter-time: #optional number of milliseconds to spend in
190 #             PBKDF passphrase processing. Currently defaults
191 #             to 2000. (since 2.8)
192 # Since: 2.6
194 { 'struct': 'QCryptoBlockCreateOptionsLUKS',
195   'base': 'QCryptoBlockOptionsLUKS',
196   'data': { '*cipher-alg': 'QCryptoCipherAlgorithm',
197             '*cipher-mode': 'QCryptoCipherMode',
198             '*ivgen-alg': 'QCryptoIVGenAlgorithm',
199             '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
200             '*hash-alg': 'QCryptoHashAlgorithm',
201             '*iter-time': 'int'}}
205 # @QCryptoBlockOpenOptions:
207 # The options that are available for all encryption formats
208 # when opening an existing volume
210 # Since: 2.6
212 { 'union': 'QCryptoBlockOpenOptions',
213   'base': 'QCryptoBlockOptionsBase',
214   'discriminator': 'format',
215   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
216             'luks': 'QCryptoBlockOptionsLUKS' } }
220 # @QCryptoBlockCreateOptions:
222 # The options that are available for all encryption formats
223 # when initializing a new volume
225 # Since: 2.6
227 { 'union': 'QCryptoBlockCreateOptions',
228   'base': 'QCryptoBlockOptionsBase',
229   'discriminator': 'format',
230   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
231             'luks': 'QCryptoBlockCreateOptionsLUKS' } }
235 # @QCryptoBlockInfoBase:
237 # The common information that applies to all full disk
238 # encryption formats
240 # @format: the encryption format
242 # Since: 2.7
244 { 'struct': 'QCryptoBlockInfoBase',
245   'data': { 'format': 'QCryptoBlockFormat' }}
249 # @QCryptoBlockInfoLUKSSlot:
251 # Information about the LUKS block encryption key
252 # slot options
254 # @active: whether the key slot is currently in use
255 # @key-offset: offset to the key material in bytes
256 # @iters: #optional number of PBKDF2 iterations for key material
257 # @stripes: #optional number of stripes for splitting key material
259 # Since: 2.7
261 { 'struct': 'QCryptoBlockInfoLUKSSlot',
262   'data': {'active': 'bool',
263            '*iters': 'int',
264            '*stripes': 'int',
265            'key-offset': 'int' } }
269 # @QCryptoBlockInfoLUKS:
271 # Information about the LUKS block encryption options
273 # @cipher-alg: the cipher algorithm for data encryption
274 # @cipher-mode: the cipher mode for data encryption
275 # @ivgen-alg: the initialization vector generator
276 # @ivgen-hash-alg: #optional the initialization vector generator hash
277 # @hash-alg: the master key hash algorithm
278 # @payload-offset: offset to the payload data in bytes
279 # @master-key-iters: number of PBKDF2 iterations for key material
280 # @uuid: unique identifier for the volume
281 # @slots: information about each key slot
283 # Since: 2.7
285 { 'struct': 'QCryptoBlockInfoLUKS',
286   'data': {'cipher-alg': 'QCryptoCipherAlgorithm',
287            'cipher-mode': 'QCryptoCipherMode',
288            'ivgen-alg': 'QCryptoIVGenAlgorithm',
289            '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
290            'hash-alg': 'QCryptoHashAlgorithm',
291            'payload-offset': 'int',
292            'master-key-iters': 'int',
293            'uuid': 'str',
294            'slots': [ 'QCryptoBlockInfoLUKSSlot' ] }}
297 # @QCryptoBlockInfoQCow:
299 # Information about the QCow block encryption options
301 # Since: 2.7
303 { 'struct': 'QCryptoBlockInfoQCow',
304   'data': { }}
308 # @QCryptoBlockInfo:
310 # Information about the block encryption options
312 # Since: 2.7
314 { 'union': 'QCryptoBlockInfo',
315   'base': 'QCryptoBlockInfoBase',
316   'discriminator': 'format',
317   'data': { 'qcow': 'QCryptoBlockInfoQCow',
318             'luks': 'QCryptoBlockInfoLUKS' } }