blob: c14a8b8a11540dc8d943c3c66ca230212413949b [file] [log] [blame]
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +01001/*
2 * QEMU Crypto cipher algorithms
3 *
4 * Copyright (c) 2015 Red Hat, Inc.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
Thomas Huthb7cbb872019-02-13 16:54:59 +01009 * version 2.1 of the License, or (at your option) any later version.
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010010 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 *
19 */
20
Peter Maydell42f7a442016-01-26 18:16:55 +000021#include "qemu/osdep.h"
Richard Hendersoneba29772020-08-28 10:05:08 -070022#include "qemu/host-utils.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010023#include "qapi/error.h"
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010024#include "crypto/cipher.h"
Longpeng(Mike)75c80072017-07-14 14:03:58 -040025#include "cipherpriv.h"
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010026
Daniel P. Berrange62893b62015-07-01 18:10:33 +010027
Markus Armbrustera092c512024-09-04 13:18:29 +020028static const size_t alg_key_len[QCRYPTO_CIPHER_ALGO__MAX] = {
29 [QCRYPTO_CIPHER_ALGO_AES_128] = 16,
30 [QCRYPTO_CIPHER_ALGO_AES_192] = 24,
31 [QCRYPTO_CIPHER_ALGO_AES_256] = 32,
32 [QCRYPTO_CIPHER_ALGO_DES] = 8,
33 [QCRYPTO_CIPHER_ALGO_3DES] = 24,
34 [QCRYPTO_CIPHER_ALGO_CAST5_128] = 16,
35 [QCRYPTO_CIPHER_ALGO_SERPENT_128] = 16,
36 [QCRYPTO_CIPHER_ALGO_SERPENT_192] = 24,
37 [QCRYPTO_CIPHER_ALGO_SERPENT_256] = 32,
38 [QCRYPTO_CIPHER_ALGO_TWOFISH_128] = 16,
39 [QCRYPTO_CIPHER_ALGO_TWOFISH_192] = 24,
40 [QCRYPTO_CIPHER_ALGO_TWOFISH_256] = 32,
Hyman Huang52ed9f42023-12-07 23:47:35 +080041#ifdef CONFIG_CRYPTO_SM4
Markus Armbrustera092c512024-09-04 13:18:29 +020042 [QCRYPTO_CIPHER_ALGO_SM4] = 16,
Hyman Huang52ed9f42023-12-07 23:47:35 +080043#endif
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010044};
45
Markus Armbrustera092c512024-09-04 13:18:29 +020046static const size_t alg_block_len[QCRYPTO_CIPHER_ALGO__MAX] = {
47 [QCRYPTO_CIPHER_ALGO_AES_128] = 16,
48 [QCRYPTO_CIPHER_ALGO_AES_192] = 16,
49 [QCRYPTO_CIPHER_ALGO_AES_256] = 16,
50 [QCRYPTO_CIPHER_ALGO_DES] = 8,
51 [QCRYPTO_CIPHER_ALGO_3DES] = 8,
52 [QCRYPTO_CIPHER_ALGO_CAST5_128] = 8,
53 [QCRYPTO_CIPHER_ALGO_SERPENT_128] = 16,
54 [QCRYPTO_CIPHER_ALGO_SERPENT_192] = 16,
55 [QCRYPTO_CIPHER_ALGO_SERPENT_256] = 16,
56 [QCRYPTO_CIPHER_ALGO_TWOFISH_128] = 16,
57 [QCRYPTO_CIPHER_ALGO_TWOFISH_192] = 16,
58 [QCRYPTO_CIPHER_ALGO_TWOFISH_256] = 16,
Hyman Huang52ed9f42023-12-07 23:47:35 +080059#ifdef CONFIG_CRYPTO_SM4
Markus Armbrustera092c512024-09-04 13:18:29 +020060 [QCRYPTO_CIPHER_ALGO_SM4] = 16,
Hyman Huang52ed9f42023-12-07 23:47:35 +080061#endif
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010062};
63
Richard Hendersone46064a2020-08-28 10:05:16 -070064static const bool mode_need_iv[QCRYPTO_CIPHER_MODE__MAX] = {
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010065 [QCRYPTO_CIPHER_MODE_ECB] = false,
66 [QCRYPTO_CIPHER_MODE_CBC] = true,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +000067 [QCRYPTO_CIPHER_MODE_XTS] = true,
Gonglei3c282922016-09-26 17:23:22 +080068 [QCRYPTO_CIPHER_MODE_CTR] = true,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010069};
70
71
Markus Armbrustera092c512024-09-04 13:18:29 +020072size_t qcrypto_cipher_get_block_len(QCryptoCipherAlgo alg)
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010073{
Prasad J Pandit32c813e2017-02-20 16:53:07 +053074 assert(alg < G_N_ELEMENTS(alg_key_len));
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010075 return alg_block_len[alg];
76}
77
78
Markus Armbrustera092c512024-09-04 13:18:29 +020079size_t qcrypto_cipher_get_key_len(QCryptoCipherAlgo alg)
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010080{
Prasad J Pandit32c813e2017-02-20 16:53:07 +053081 assert(alg < G_N_ELEMENTS(alg_key_len));
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010082 return alg_key_len[alg];
83}
84
85
Markus Armbrustera092c512024-09-04 13:18:29 +020086size_t qcrypto_cipher_get_iv_len(QCryptoCipherAlgo alg,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010087 QCryptoCipherMode mode)
88{
89 if (alg >= G_N_ELEMENTS(alg_block_len)) {
90 return 0;
91 }
92 if (mode >= G_N_ELEMENTS(mode_need_iv)) {
93 return 0;
94 }
95
96 if (mode_need_iv[mode]) {
97 return alg_block_len[alg];
98 }
99 return 0;
100}
101
102
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100103static bool
Markus Armbrustera092c512024-09-04 13:18:29 +0200104qcrypto_cipher_validate_key_length(QCryptoCipherAlgo alg,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000105 QCryptoCipherMode mode,
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100106 size_t nkey,
107 Error **errp)
108{
Markus Armbrustera092c512024-09-04 13:18:29 +0200109 if ((unsigned)alg >= QCRYPTO_CIPHER_ALGO__MAX) {
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100110 error_setg(errp, "Cipher algorithm %d out of range",
111 alg);
112 return false;
113 }
114
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000115 if (mode == QCRYPTO_CIPHER_MODE_XTS) {
Markus Armbrustera092c512024-09-04 13:18:29 +0200116 if (alg == QCRYPTO_CIPHER_ALGO_DES ||
117 alg == QCRYPTO_CIPHER_ALGO_3DES) {
Daniel P. Berrangé83bee4b2021-06-29 14:25:32 +0100118 error_setg(errp, "XTS mode not compatible with DES/3DES");
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000119 return false;
120 }
121 if (nkey % 2) {
122 error_setg(errp, "XTS cipher key length should be a multiple of 2");
123 return false;
124 }
125
126 if (alg_key_len[alg] != (nkey / 2)) {
127 error_setg(errp, "Cipher key length %zu should be %zu",
128 nkey, alg_key_len[alg] * 2);
129 return false;
130 }
131 } else {
132 if (alg_key_len[alg] != nkey) {
133 error_setg(errp, "Cipher key length %zu should be %zu",
134 nkey, alg_key_len[alg]);
135 return false;
136 }
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100137 }
138 return true;
139}
140
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100141#ifdef CONFIG_GCRYPT
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700142#include "cipher-gcrypt.c.inc"
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100143#elif defined CONFIG_NETTLE
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700144#include "cipher-nettle.c.inc"
Daniel P. Berrangé3d2b61f2021-06-29 13:25:55 +0100145#elif defined CONFIG_GNUTLS_CRYPTO
146#include "cipher-gnutls.c.inc"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100147#else
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700148#include "cipher-builtin.c.inc"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100149#endif
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400150
Markus Armbrustera092c512024-09-04 13:18:29 +0200151QCryptoCipher *qcrypto_cipher_new(QCryptoCipherAlgo alg,
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400152 QCryptoCipherMode mode,
153 const uint8_t *key, size_t nkey,
154 Error **errp)
155{
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700156 QCryptoCipher *cipher = NULL;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400157
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400158#ifdef CONFIG_AF_ALG
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700159 cipher = qcrypto_afalg_cipher_ctx_new(alg, mode, key, nkey, NULL);
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400160#endif
161
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700162 if (!cipher) {
163 cipher = qcrypto_cipher_ctx_new(alg, mode, key, nkey, errp);
164 if (!cipher) {
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400165 return NULL;
166 }
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400167 }
168
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400169 cipher->alg = alg;
170 cipher->mode = mode;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400171
172 return cipher;
173}
174
175
176int qcrypto_cipher_encrypt(QCryptoCipher *cipher,
177 const void *in,
178 void *out,
179 size_t len,
180 Error **errp)
181{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700182 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400183 return drv->cipher_encrypt(cipher, in, out, len, errp);
184}
185
186
187int qcrypto_cipher_decrypt(QCryptoCipher *cipher,
188 const void *in,
189 void *out,
190 size_t len,
191 Error **errp)
192{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700193 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400194 return drv->cipher_decrypt(cipher, in, out, len, errp);
195}
196
197
198int qcrypto_cipher_setiv(QCryptoCipher *cipher,
199 const uint8_t *iv, size_t niv,
200 Error **errp)
201{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700202 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400203 return drv->cipher_setiv(cipher, iv, niv, errp);
204}
205
206
207void qcrypto_cipher_free(QCryptoCipher *cipher)
208{
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400209 if (cipher) {
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700210 cipher->driver->cipher_free(cipher);
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400211 }
212}