linux-user: Use safe_syscall for execve syscall
[qemu.git] / 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 # @sha256: SHA-256. Current recommended strong hash.
46 # Since: 2.6
47 ##
48 { 'enum': 'QCryptoHashAlgorithm',
49   'prefix': 'QCRYPTO_HASH_ALG',
50   'data': ['md5', 'sha1', 'sha256']}
51
52
53 ##
54 # QCryptoCipherAlgorithm:
55 #
56 # The supported algorithms for content encryption ciphers
57 #
58 # @aes-128: AES with 128 bit / 16 byte keys
59 # @aes-192: AES with 192 bit / 24 byte keys
60 # @aes-256: AES with 256 bit / 32 byte keys
61 # @des-rfb: RFB specific variant of single DES. Do not use except in VNC.
62 # @cast5-128: Cast5 with 128 bit / 16 byte keys
63 # @serpent-128: Serpent with 128 bit / 16 byte keys
64 # @serpent-192: Serpent with 192 bit / 24 byte keys
65 # @serpent-256: Serpent with 256 bit / 32 byte keys
66 # @twofish-128: Twofish with 128 bit / 16 byte keys
67 # @twofish-192: Twofish with 192 bit / 24 byte keys
68 # @twofish-256: Twofish with 256 bit / 32 byte keys
69 # Since: 2.6
70 ##
71 { 'enum': 'QCryptoCipherAlgorithm',
72   'prefix': 'QCRYPTO_CIPHER_ALG',
73   'data': ['aes-128', 'aes-192', 'aes-256',
74            'des-rfb',
75            'cast5-128',
76            'serpent-128', 'serpent-192', 'serpent-256',
77            'twofish-128', 'twofish-192', 'twofish-256']}
78
79
80 ##
81 # QCryptoCipherMode:
82 #
83 # The supported modes for content encryption ciphers
84 #
85 # @ecb: Electronic Code Book
86 # @cbc: Cipher Block Chaining
87 # @xts: XEX with tweaked code book and ciphertext stealing
88 # Since: 2.6
89 ##
90 { 'enum': 'QCryptoCipherMode',
91   'prefix': 'QCRYPTO_CIPHER_MODE',
92   'data': ['ecb', 'cbc', 'xts']}
93
94
95 ##
96 # QCryptoIVGenAlgorithm:
97 #
98 # The supported algorithms for generating initialization
99 # vectors for full disk encryption. The 'plain' generator
100 # should not be used for disks with sector numbers larger
101 # than 2^32, except where compatibility with pre-existing
102 # Linux dm-crypt volumes is required.
103 #
104 # @plain: 64-bit sector number truncated to 32-bits
105 # @plain64: 64-bit sector number
106 # @essiv: 64-bit sector number encrypted with a hash of the encryption key
107 # Since: 2.6
108 ##
109 { 'enum': 'QCryptoIVGenAlgorithm',
110   'prefix': 'QCRYPTO_IVGEN_ALG',
111   'data': ['plain', 'plain64', 'essiv']}
112
113 ##
114 # QCryptoBlockFormat:
115 #
116 # The supported full disk encryption formats
117 #
118 # @qcow: QCow/QCow2 built-in AES-CBC encryption. Use only
119 #        for liberating data from old images.
120 # @luks: LUKS encryption format. Recommended for new images
121 #
122 # Since: 2.6
123 ##
124 { 'enum': 'QCryptoBlockFormat',
125 #  'prefix': 'QCRYPTO_BLOCK_FORMAT',
126   'data': ['qcow', 'luks']}
127
128 ##
129 # QCryptoBlockOptionsBase:
130 #
131 # The common options that apply to all full disk
132 # encryption formats
133 #
134 # @format: the encryption format
135 #
136 # Since: 2.6
137 ##
138 { 'struct': 'QCryptoBlockOptionsBase',
139   'data': { 'format': 'QCryptoBlockFormat' }}
140
141 ##
142 # QCryptoBlockOptionsQCow:
143 #
144 # The options that apply to QCow/QCow2 AES-CBC encryption format
145 #
146 # @key-secret: #optional the ID of a QCryptoSecret object providing the
147 #              decryption key. Mandatory except when probing image for
148 #              metadata only.
149 #
150 # Since: 2.6
151 ##
152 { 'struct': 'QCryptoBlockOptionsQCow',
153   'data': { '*key-secret': 'str' }}
154
155 ##
156 # QCryptoBlockOptionsLUKS:
157 #
158 # The options that apply to LUKS encryption format
159 #
160 # @key-secret: #optional the ID of a QCryptoSecret object providing the
161 #              decryption key. Mandatory except when probing image for
162 #              metadata only.
163 # Since: 2.6
164 ##
165 { 'struct': 'QCryptoBlockOptionsLUKS',
166   'data': { '*key-secret': 'str' }}
167
168
169 ##
170 # QCryptoBlockCreateOptionsLUKS:
171 #
172 # The options that apply to LUKS encryption format initialization
173 #
174 # @cipher-alg: #optional the cipher algorithm for data encryption
175 #              Currently defaults to 'aes'.
176 # @cipher-mode: #optional the cipher mode for data encryption
177 #               Currently defaults to 'cbc'
178 # @ivgen-alg: #optional the initialization vector generator
179 #             Currently defaults to 'essiv'
180 # @ivgen-hash-alg: #optional the initialization vector generator hash
181 #                  Currently defaults to 'sha256'
182 # @hash-alg: #optional the master key hash algorithm
183 #            Currently defaults to 'sha256'
184 # Since: 2.6
185 ##
186 { 'struct': 'QCryptoBlockCreateOptionsLUKS',
187   'base': 'QCryptoBlockOptionsLUKS',
188   'data': { '*cipher-alg': 'QCryptoCipherAlgorithm',
189             '*cipher-mode': 'QCryptoCipherMode',
190             '*ivgen-alg': 'QCryptoIVGenAlgorithm',
191             '*ivgen-hash-alg': 'QCryptoHashAlgorithm',
192             '*hash-alg': 'QCryptoHashAlgorithm'}}
193
194
195 ##
196 # QCryptoBlockOpenOptions:
197 #
198 # The options that are available for all encryption formats
199 # when opening an existing volume
200 #
201 # Since: 2.6
202 ##
203 { 'union': 'QCryptoBlockOpenOptions',
204   'base': 'QCryptoBlockOptionsBase',
205   'discriminator': 'format',
206   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
207             'luks': 'QCryptoBlockOptionsLUKS' } }
208
209
210 ##
211 # QCryptoBlockCreateOptions:
212 #
213 # The options that are available for all encryption formats
214 # when initializing a new volume
215 #
216 # Since: 2.6
217 ##
218 { 'union': 'QCryptoBlockCreateOptions',
219   'base': 'QCryptoBlockOptionsBase',
220   'discriminator': 'format',
221   'data': { 'qcow': 'QCryptoBlockOptionsQCow',
222             'luks': 'QCryptoBlockCreateOptionsLUKS' } }