]> git.proxmox.com Git - mirror_qemu.git/blame - backends/cryptodev-builtin.c
cryptodev: remove single-DES support in cryptodev
[mirror_qemu.git] / backends / cryptodev-builtin.c
CommitLineData
1653a5f3
GA
1/*
2 * QEMU Cryptodev backend for QEMU cipher APIs
3 *
4 * Copyright (c) 2016 HUAWEI TECHNOLOGIES CO., LTD.
5 *
6 * Authors:
7 * Gonglei <arei.gonglei@huawei.com>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
13 *
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 *
22 */
23
24#include "qemu/osdep.h"
25#include "sysemu/cryptodev.h"
26#include "hw/boards.h"
27#include "qapi/error.h"
28#include "standard-headers/linux/virtio_crypto.h"
29#include "crypto/cipher.h"
30
31
32/**
33 * @TYPE_CRYPTODEV_BACKEND_BUILTIN:
34 * name of backend that uses QEMU cipher API
35 */
36#define TYPE_CRYPTODEV_BACKEND_BUILTIN "cryptodev-backend-builtin"
37
38#define CRYPTODEV_BACKEND_BUILTIN(obj) \
39 OBJECT_CHECK(CryptoDevBackendBuiltin, \
40 (obj), TYPE_CRYPTODEV_BACKEND_BUILTIN)
41
42typedef struct CryptoDevBackendBuiltin
43 CryptoDevBackendBuiltin;
44
45typedef struct CryptoDevBackendBuiltinSession {
46 QCryptoCipher *cipher;
47 uint8_t direction; /* encryption or decryption */
48 uint8_t type; /* cipher? hash? aead? */
49 QTAILQ_ENTRY(CryptoDevBackendBuiltinSession) next;
50} CryptoDevBackendBuiltinSession;
51
52/* Max number of symmetric sessions */
53#define MAX_NUM_SESSIONS 256
54
55#define CRYPTODEV_BUITLIN_MAX_AUTH_KEY_LEN 512
56#define CRYPTODEV_BUITLIN_MAX_CIPHER_KEY_LEN 64
57
58struct CryptoDevBackendBuiltin {
59 CryptoDevBackend parent_obj;
60
61 CryptoDevBackendBuiltinSession *sessions[MAX_NUM_SESSIONS];
62};
63
64static void cryptodev_builtin_init(
65 CryptoDevBackend *backend, Error **errp)
66{
67 /* Only support one queue */
68 int queues = backend->conf.peers.queues;
69 CryptoDevBackendClient *cc;
70
71 if (queues != 1) {
72 error_setg(errp,
73 "Only support one queue in cryptdov-builtin backend");
74 return;
75 }
76
77 cc = cryptodev_backend_new_client(
78 "cryptodev-builtin", NULL);
79 cc->info_str = g_strdup_printf("cryptodev-builtin0");
80 cc->queue_index = 0;
81 backend->conf.peers.ccs[0] = cc;
82
83 backend->conf.crypto_services =
84 1u << VIRTIO_CRYPTO_SERVICE_CIPHER |
85 1u << VIRTIO_CRYPTO_SERVICE_HASH |
86 1u << VIRTIO_CRYPTO_SERVICE_MAC;
87 backend->conf.cipher_algo_l = 1u << VIRTIO_CRYPTO_CIPHER_AES_CBC;
88 backend->conf.hash_algo = 1u << VIRTIO_CRYPTO_HASH_SHA1;
89 /*
90 * Set the Maximum length of crypto request.
91 * Why this value? Just avoid to overflow when
92 * memory allocation for each crypto request.
93 */
94 backend->conf.max_size = LONG_MAX - sizeof(CryptoDevBackendSymOpInfo);
95 backend->conf.max_cipher_key_len = CRYPTODEV_BUITLIN_MAX_CIPHER_KEY_LEN;
96 backend->conf.max_auth_key_len = CRYPTODEV_BUITLIN_MAX_AUTH_KEY_LEN;
97}
98
99static int
100cryptodev_builtin_get_unused_session_index(
101 CryptoDevBackendBuiltin *builtin)
102{
103 size_t i;
104
105 for (i = 0; i < MAX_NUM_SESSIONS; i++) {
106 if (builtin->sessions[i] == NULL) {
107 return i;
108 }
109 }
110
111 return -1;
112}
113
465f2fed
LM
114#define AES_KEYSIZE_128 16
115#define AES_KEYSIZE_192 24
116#define AES_KEYSIZE_256 32
117#define AES_KEYSIZE_128_XTS AES_KEYSIZE_256
118#define AES_KEYSIZE_256_XTS 64
119
1653a5f3 120static int
465f2fed 121cryptodev_builtin_get_aes_algo(uint32_t key_len, int mode, Error **errp)
1653a5f3
GA
122{
123 int algo;
124
465f2fed 125 if (key_len == AES_KEYSIZE_128) {
1653a5f3 126 algo = QCRYPTO_CIPHER_ALG_AES_128;
465f2fed 127 } else if (key_len == AES_KEYSIZE_192) {
1653a5f3 128 algo = QCRYPTO_CIPHER_ALG_AES_192;
465f2fed
LM
129 } else if (key_len == AES_KEYSIZE_256) { /* equals AES_KEYSIZE_128_XTS */
130 if (mode == QCRYPTO_CIPHER_MODE_XTS) {
131 algo = QCRYPTO_CIPHER_ALG_AES_128;
132 } else {
133 algo = QCRYPTO_CIPHER_ALG_AES_256;
134 }
135 } else if (key_len == AES_KEYSIZE_256_XTS) {
136 if (mode == QCRYPTO_CIPHER_MODE_XTS) {
137 algo = QCRYPTO_CIPHER_ALG_AES_256;
138 } else {
139 goto err;
140 }
1653a5f3 141 } else {
465f2fed 142 goto err;
1653a5f3
GA
143 }
144
145 return algo;
465f2fed
LM
146
147err:
148 error_setg(errp, "Unsupported key length :%u", key_len);
149 return -1;
1653a5f3
GA
150}
151
152static int cryptodev_builtin_create_cipher_session(
153 CryptoDevBackendBuiltin *builtin,
154 CryptoDevBackendSymSessionInfo *sess_info,
155 Error **errp)
156{
157 int algo;
158 int mode;
159 QCryptoCipher *cipher;
160 int index;
161 CryptoDevBackendBuiltinSession *sess;
162
163 if (sess_info->op_type != VIRTIO_CRYPTO_SYM_OP_CIPHER) {
164 error_setg(errp, "Unsupported optype :%u", sess_info->op_type);
165 return -1;
166 }
167
168 index = cryptodev_builtin_get_unused_session_index(builtin);
169 if (index < 0) {
170 error_setg(errp, "Total number of sessions created exceeds %u",
171 MAX_NUM_SESSIONS);
172 return -1;
173 }
174
175 switch (sess_info->cipher_alg) {
176 case VIRTIO_CRYPTO_CIPHER_AES_ECB:
465f2fed 177 mode = QCRYPTO_CIPHER_MODE_ECB;
1653a5f3 178 algo = cryptodev_builtin_get_aes_algo(sess_info->key_len,
465f2fed 179 mode, errp);
1653a5f3
GA
180 if (algo < 0) {
181 return -1;
182 }
1653a5f3
GA
183 break;
184 case VIRTIO_CRYPTO_CIPHER_AES_CBC:
465f2fed 185 mode = QCRYPTO_CIPHER_MODE_CBC;
1653a5f3 186 algo = cryptodev_builtin_get_aes_algo(sess_info->key_len,
465f2fed 187 mode, errp);
1653a5f3
GA
188 if (algo < 0) {
189 return -1;
190 }
1653a5f3
GA
191 break;
192 case VIRTIO_CRYPTO_CIPHER_AES_CTR:
465f2fed 193 mode = QCRYPTO_CIPHER_MODE_CTR;
1653a5f3 194 algo = cryptodev_builtin_get_aes_algo(sess_info->key_len,
465f2fed 195 mode, errp);
1653a5f3
GA
196 if (algo < 0) {
197 return -1;
198 }
1653a5f3 199 break;
eaa57403
LM
200 case VIRTIO_CRYPTO_CIPHER_AES_XTS:
201 mode = QCRYPTO_CIPHER_MODE_XTS;
202 algo = cryptodev_builtin_get_aes_algo(sess_info->key_len,
203 mode, errp);
204 if (algo < 0) {
205 return -1;
206 }
207 break;
1653a5f3
GA
208 default:
209 error_setg(errp, "Unsupported cipher alg :%u",
210 sess_info->cipher_alg);
211 return -1;
212 }
213
214 cipher = qcrypto_cipher_new(algo, mode,
215 sess_info->cipher_key,
216 sess_info->key_len,
217 errp);
218 if (!cipher) {
219 return -1;
220 }
221
222 sess = g_new0(CryptoDevBackendBuiltinSession, 1);
223 sess->cipher = cipher;
224 sess->direction = sess_info->direction;
225 sess->type = sess_info->op_type;
226
227 builtin->sessions[index] = sess;
228
229 return index;
230}
231
232static int64_t cryptodev_builtin_sym_create_session(
233 CryptoDevBackend *backend,
234 CryptoDevBackendSymSessionInfo *sess_info,
235 uint32_t queue_index, Error **errp)
236{
237 CryptoDevBackendBuiltin *builtin =
238 CRYPTODEV_BACKEND_BUILTIN(backend);
239 int64_t session_id = -1;
240 int ret;
241
242 switch (sess_info->op_code) {
243 case VIRTIO_CRYPTO_CIPHER_CREATE_SESSION:
244 ret = cryptodev_builtin_create_cipher_session(
245 builtin, sess_info, errp);
246 if (ret < 0) {
247 return ret;
248 } else {
249 session_id = ret;
250 }
251 break;
252 case VIRTIO_CRYPTO_HASH_CREATE_SESSION:
253 case VIRTIO_CRYPTO_MAC_CREATE_SESSION:
254 default:
255 error_setg(errp, "Unsupported opcode :%" PRIu32 "",
256 sess_info->op_code);
257 return -1;
258 }
259
260 return session_id;
261}
262
263static int cryptodev_builtin_sym_close_session(
264 CryptoDevBackend *backend,
265 uint64_t session_id,
266 uint32_t queue_index, Error **errp)
267{
268 CryptoDevBackendBuiltin *builtin =
269 CRYPTODEV_BACKEND_BUILTIN(backend);
270
271 if (session_id >= MAX_NUM_SESSIONS ||
272 builtin->sessions[session_id] == NULL) {
273 error_setg(errp, "Cannot find a valid session id: %" PRIu64 "",
274 session_id);
275 return -1;
276 }
277
278 qcrypto_cipher_free(builtin->sessions[session_id]->cipher);
279 g_free(builtin->sessions[session_id]);
280 builtin->sessions[session_id] = NULL;
281 return 0;
282}
283
284static int cryptodev_builtin_sym_operation(
285 CryptoDevBackend *backend,
286 CryptoDevBackendSymOpInfo *op_info,
287 uint32_t queue_index, Error **errp)
288{
289 CryptoDevBackendBuiltin *builtin =
290 CRYPTODEV_BACKEND_BUILTIN(backend);
291 CryptoDevBackendBuiltinSession *sess;
292 int ret;
293
294 if (op_info->session_id >= MAX_NUM_SESSIONS ||
295 builtin->sessions[op_info->session_id] == NULL) {
296 error_setg(errp, "Cannot find a valid session id: %" PRIu64 "",
297 op_info->session_id);
298 return -VIRTIO_CRYPTO_INVSESS;
299 }
300
301 if (op_info->op_type == VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING) {
302 error_setg(errp,
303 "Algorithm chain is unsupported for cryptdoev-builtin");
304 return -VIRTIO_CRYPTO_NOTSUPP;
305 }
306
307 sess = builtin->sessions[op_info->session_id];
308
309 ret = qcrypto_cipher_setiv(sess->cipher, op_info->iv,
310 op_info->iv_len, errp);
311 if (ret < 0) {
312 return -VIRTIO_CRYPTO_ERR;
313 }
314
315 if (sess->direction == VIRTIO_CRYPTO_OP_ENCRYPT) {
316 ret = qcrypto_cipher_encrypt(sess->cipher, op_info->src,
317 op_info->dst, op_info->src_len, errp);
318 if (ret < 0) {
319 return -VIRTIO_CRYPTO_ERR;
320 }
321 } else {
322 ret = qcrypto_cipher_decrypt(sess->cipher, op_info->src,
323 op_info->dst, op_info->src_len, errp);
324 if (ret < 0) {
325 return -VIRTIO_CRYPTO_ERR;
326 }
327 }
328 return VIRTIO_CRYPTO_OK;
329}
330
331static void cryptodev_builtin_cleanup(
332 CryptoDevBackend *backend,
333 Error **errp)
334{
335 CryptoDevBackendBuiltin *builtin =
336 CRYPTODEV_BACKEND_BUILTIN(backend);
337 size_t i;
338 int queues = backend->conf.peers.queues;
339 CryptoDevBackendClient *cc;
340
341 for (i = 0; i < MAX_NUM_SESSIONS; i++) {
342 if (builtin->sessions[i] != NULL) {
343 cryptodev_builtin_sym_close_session(
344 backend, i, 0, errp);
345 }
346 }
347
348 assert(queues == 1);
349
350 for (i = 0; i < queues; i++) {
351 cc = backend->conf.peers.ccs[i];
352 if (cc) {
353 cryptodev_backend_free_client(cc);
354 backend->conf.peers.ccs[i] = NULL;
355 }
356 }
357}
358
359static void
360cryptodev_builtin_class_init(ObjectClass *oc, void *data)
361{
362 CryptoDevBackendClass *bc = CRYPTODEV_BACKEND_CLASS(oc);
363
364 bc->init = cryptodev_builtin_init;
365 bc->cleanup = cryptodev_builtin_cleanup;
366 bc->create_session = cryptodev_builtin_sym_create_session;
367 bc->close_session = cryptodev_builtin_sym_close_session;
368 bc->do_sym_op = cryptodev_builtin_sym_operation;
369}
370
371static const TypeInfo cryptodev_builtin_info = {
372 .name = TYPE_CRYPTODEV_BACKEND_BUILTIN,
373 .parent = TYPE_CRYPTODEV_BACKEND,
374 .class_init = cryptodev_builtin_class_init,
375 .instance_size = sizeof(CryptoDevBackendBuiltin),
376};
377
378static void
379cryptodev_builtin_register_types(void)
380{
381 type_register_static(&cryptodev_builtin_info);
382}
383
384type_init(cryptodev_builtin_register_types);