]> git.ipfire.org Git - thirdparty/qemu.git/blame - backends/cryptodev-builtin.c
cryptodev: add xts(aes) support
[thirdparty/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 208 case VIRTIO_CRYPTO_CIPHER_DES_ECB:
1653a5f3 209 mode = QCRYPTO_CIPHER_MODE_ECB;
465f2fed 210 algo = QCRYPTO_CIPHER_ALG_DES_RFB;
1653a5f3
GA
211 break;
212 default:
213 error_setg(errp, "Unsupported cipher alg :%u",
214 sess_info->cipher_alg);
215 return -1;
216 }
217
218 cipher = qcrypto_cipher_new(algo, mode,
219 sess_info->cipher_key,
220 sess_info->key_len,
221 errp);
222 if (!cipher) {
223 return -1;
224 }
225
226 sess = g_new0(CryptoDevBackendBuiltinSession, 1);
227 sess->cipher = cipher;
228 sess->direction = sess_info->direction;
229 sess->type = sess_info->op_type;
230
231 builtin->sessions[index] = sess;
232
233 return index;
234}
235
236static int64_t cryptodev_builtin_sym_create_session(
237 CryptoDevBackend *backend,
238 CryptoDevBackendSymSessionInfo *sess_info,
239 uint32_t queue_index, Error **errp)
240{
241 CryptoDevBackendBuiltin *builtin =
242 CRYPTODEV_BACKEND_BUILTIN(backend);
243 int64_t session_id = -1;
244 int ret;
245
246 switch (sess_info->op_code) {
247 case VIRTIO_CRYPTO_CIPHER_CREATE_SESSION:
248 ret = cryptodev_builtin_create_cipher_session(
249 builtin, sess_info, errp);
250 if (ret < 0) {
251 return ret;
252 } else {
253 session_id = ret;
254 }
255 break;
256 case VIRTIO_CRYPTO_HASH_CREATE_SESSION:
257 case VIRTIO_CRYPTO_MAC_CREATE_SESSION:
258 default:
259 error_setg(errp, "Unsupported opcode :%" PRIu32 "",
260 sess_info->op_code);
261 return -1;
262 }
263
264 return session_id;
265}
266
267static int cryptodev_builtin_sym_close_session(
268 CryptoDevBackend *backend,
269 uint64_t session_id,
270 uint32_t queue_index, Error **errp)
271{
272 CryptoDevBackendBuiltin *builtin =
273 CRYPTODEV_BACKEND_BUILTIN(backend);
274
275 if (session_id >= MAX_NUM_SESSIONS ||
276 builtin->sessions[session_id] == NULL) {
277 error_setg(errp, "Cannot find a valid session id: %" PRIu64 "",
278 session_id);
279 return -1;
280 }
281
282 qcrypto_cipher_free(builtin->sessions[session_id]->cipher);
283 g_free(builtin->sessions[session_id]);
284 builtin->sessions[session_id] = NULL;
285 return 0;
286}
287
288static int cryptodev_builtin_sym_operation(
289 CryptoDevBackend *backend,
290 CryptoDevBackendSymOpInfo *op_info,
291 uint32_t queue_index, Error **errp)
292{
293 CryptoDevBackendBuiltin *builtin =
294 CRYPTODEV_BACKEND_BUILTIN(backend);
295 CryptoDevBackendBuiltinSession *sess;
296 int ret;
297
298 if (op_info->session_id >= MAX_NUM_SESSIONS ||
299 builtin->sessions[op_info->session_id] == NULL) {
300 error_setg(errp, "Cannot find a valid session id: %" PRIu64 "",
301 op_info->session_id);
302 return -VIRTIO_CRYPTO_INVSESS;
303 }
304
305 if (op_info->op_type == VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING) {
306 error_setg(errp,
307 "Algorithm chain is unsupported for cryptdoev-builtin");
308 return -VIRTIO_CRYPTO_NOTSUPP;
309 }
310
311 sess = builtin->sessions[op_info->session_id];
312
313 ret = qcrypto_cipher_setiv(sess->cipher, op_info->iv,
314 op_info->iv_len, errp);
315 if (ret < 0) {
316 return -VIRTIO_CRYPTO_ERR;
317 }
318
319 if (sess->direction == VIRTIO_CRYPTO_OP_ENCRYPT) {
320 ret = qcrypto_cipher_encrypt(sess->cipher, op_info->src,
321 op_info->dst, op_info->src_len, errp);
322 if (ret < 0) {
323 return -VIRTIO_CRYPTO_ERR;
324 }
325 } else {
326 ret = qcrypto_cipher_decrypt(sess->cipher, op_info->src,
327 op_info->dst, op_info->src_len, errp);
328 if (ret < 0) {
329 return -VIRTIO_CRYPTO_ERR;
330 }
331 }
332 return VIRTIO_CRYPTO_OK;
333}
334
335static void cryptodev_builtin_cleanup(
336 CryptoDevBackend *backend,
337 Error **errp)
338{
339 CryptoDevBackendBuiltin *builtin =
340 CRYPTODEV_BACKEND_BUILTIN(backend);
341 size_t i;
342 int queues = backend->conf.peers.queues;
343 CryptoDevBackendClient *cc;
344
345 for (i = 0; i < MAX_NUM_SESSIONS; i++) {
346 if (builtin->sessions[i] != NULL) {
347 cryptodev_builtin_sym_close_session(
348 backend, i, 0, errp);
349 }
350 }
351
352 assert(queues == 1);
353
354 for (i = 0; i < queues; i++) {
355 cc = backend->conf.peers.ccs[i];
356 if (cc) {
357 cryptodev_backend_free_client(cc);
358 backend->conf.peers.ccs[i] = NULL;
359 }
360 }
361}
362
363static void
364cryptodev_builtin_class_init(ObjectClass *oc, void *data)
365{
366 CryptoDevBackendClass *bc = CRYPTODEV_BACKEND_CLASS(oc);
367
368 bc->init = cryptodev_builtin_init;
369 bc->cleanup = cryptodev_builtin_cleanup;
370 bc->create_session = cryptodev_builtin_sym_create_session;
371 bc->close_session = cryptodev_builtin_sym_close_session;
372 bc->do_sym_op = cryptodev_builtin_sym_operation;
373}
374
375static const TypeInfo cryptodev_builtin_info = {
376 .name = TYPE_CRYPTODEV_BACKEND_BUILTIN,
377 .parent = TYPE_CRYPTODEV_BACKEND,
378 .class_init = cryptodev_builtin_class_init,
379 .instance_size = sizeof(CryptoDevBackendBuiltin),
380};
381
382static void
383cryptodev_builtin_register_types(void)
384{
385 type_register_static(&cryptodev_builtin_info);
386}
387
388type_init(cryptodev_builtin_register_types);