blob: 74b09a5b261bae00c01afa788dbca99017f4110e [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
Richard Hendersone46064a2020-08-28 10:05:16 -070028static const size_t alg_key_len[QCRYPTO_CIPHER_ALG__MAX] = {
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010029 [QCRYPTO_CIPHER_ALG_AES_128] = 16,
30 [QCRYPTO_CIPHER_ALG_AES_192] = 24,
31 [QCRYPTO_CIPHER_ALG_AES_256] = 32,
Daniel P. Berrangé83bee4b2021-06-29 14:25:32 +010032 [QCRYPTO_CIPHER_ALG_DES] = 8,
Longpeng(Mike)ffb7bf42016-12-08 10:33:28 +080033 [QCRYPTO_CIPHER_ALG_3DES] = 24,
Daniel P. Berrange084a85e2016-02-10 17:07:42 +000034 [QCRYPTO_CIPHER_ALG_CAST5_128] = 16,
Daniel P. Berrange94318522016-02-10 17:07:42 +000035 [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16,
36 [QCRYPTO_CIPHER_ALG_SERPENT_192] = 24,
37 [QCRYPTO_CIPHER_ALG_SERPENT_256] = 32,
Daniel P. Berrange50f67532016-02-10 17:07:42 +000038 [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16,
39 [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 24,
40 [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 32,
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010041};
42
Richard Hendersone46064a2020-08-28 10:05:16 -070043static const size_t alg_block_len[QCRYPTO_CIPHER_ALG__MAX] = {
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010044 [QCRYPTO_CIPHER_ALG_AES_128] = 16,
45 [QCRYPTO_CIPHER_ALG_AES_192] = 16,
46 [QCRYPTO_CIPHER_ALG_AES_256] = 16,
Daniel P. Berrangé83bee4b2021-06-29 14:25:32 +010047 [QCRYPTO_CIPHER_ALG_DES] = 8,
Longpeng(Mike)ffb7bf42016-12-08 10:33:28 +080048 [QCRYPTO_CIPHER_ALG_3DES] = 8,
Daniel P. Berrange084a85e2016-02-10 17:07:42 +000049 [QCRYPTO_CIPHER_ALG_CAST5_128] = 8,
Daniel P. Berrange94318522016-02-10 17:07:42 +000050 [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16,
51 [QCRYPTO_CIPHER_ALG_SERPENT_192] = 16,
52 [QCRYPTO_CIPHER_ALG_SERPENT_256] = 16,
Daniel P. Berrange50f67532016-02-10 17:07:42 +000053 [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16,
54 [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 16,
55 [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 16,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010056};
57
Richard Hendersone46064a2020-08-28 10:05:16 -070058static const bool mode_need_iv[QCRYPTO_CIPHER_MODE__MAX] = {
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010059 [QCRYPTO_CIPHER_MODE_ECB] = false,
60 [QCRYPTO_CIPHER_MODE_CBC] = true,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +000061 [QCRYPTO_CIPHER_MODE_XTS] = true,
Gonglei3c282922016-09-26 17:23:22 +080062 [QCRYPTO_CIPHER_MODE_CTR] = true,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010063};
64
65
66size_t qcrypto_cipher_get_block_len(QCryptoCipherAlgorithm alg)
67{
Prasad J Pandit32c813e2017-02-20 16:53:07 +053068 assert(alg < G_N_ELEMENTS(alg_key_len));
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010069 return alg_block_len[alg];
70}
71
72
73size_t qcrypto_cipher_get_key_len(QCryptoCipherAlgorithm alg)
74{
Prasad J Pandit32c813e2017-02-20 16:53:07 +053075 assert(alg < G_N_ELEMENTS(alg_key_len));
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010076 return alg_key_len[alg];
77}
78
79
80size_t qcrypto_cipher_get_iv_len(QCryptoCipherAlgorithm alg,
81 QCryptoCipherMode mode)
82{
83 if (alg >= G_N_ELEMENTS(alg_block_len)) {
84 return 0;
85 }
86 if (mode >= G_N_ELEMENTS(mode_need_iv)) {
87 return 0;
88 }
89
90 if (mode_need_iv[mode]) {
91 return alg_block_len[alg];
92 }
93 return 0;
94}
95
96
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010097static bool
98qcrypto_cipher_validate_key_length(QCryptoCipherAlgorithm alg,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +000099 QCryptoCipherMode mode,
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100100 size_t nkey,
101 Error **errp)
102{
Daniel P. Berranged8c02bc2015-11-19 17:09:01 +0000103 if ((unsigned)alg >= QCRYPTO_CIPHER_ALG__MAX) {
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100104 error_setg(errp, "Cipher algorithm %d out of range",
105 alg);
106 return false;
107 }
108
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000109 if (mode == QCRYPTO_CIPHER_MODE_XTS) {
Daniel P. Berrangé83bee4b2021-06-29 14:25:32 +0100110 if (alg == QCRYPTO_CIPHER_ALG_DES ||
111 alg == QCRYPTO_CIPHER_ALG_3DES) {
112 error_setg(errp, "XTS mode not compatible with DES/3DES");
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000113 return false;
114 }
115 if (nkey % 2) {
116 error_setg(errp, "XTS cipher key length should be a multiple of 2");
117 return false;
118 }
119
120 if (alg_key_len[alg] != (nkey / 2)) {
121 error_setg(errp, "Cipher key length %zu should be %zu",
122 nkey, alg_key_len[alg] * 2);
123 return false;
124 }
125 } else {
126 if (alg_key_len[alg] != nkey) {
127 error_setg(errp, "Cipher key length %zu should be %zu",
128 nkey, alg_key_len[alg]);
129 return false;
130 }
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100131 }
132 return true;
133}
134
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100135#ifdef CONFIG_GCRYPT
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700136#include "cipher-gcrypt.c.inc"
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100137#elif defined CONFIG_NETTLE
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700138#include "cipher-nettle.c.inc"
Daniel P. Berrangé3d2b61f2021-06-29 13:25:55 +0100139#elif defined CONFIG_GNUTLS_CRYPTO
140#include "cipher-gnutls.c.inc"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100141#else
Richard Henderson6d92bdf2020-08-28 10:05:09 -0700142#include "cipher-builtin.c.inc"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100143#endif
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400144
145QCryptoCipher *qcrypto_cipher_new(QCryptoCipherAlgorithm alg,
146 QCryptoCipherMode mode,
147 const uint8_t *key, size_t nkey,
148 Error **errp)
149{
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700150 QCryptoCipher *cipher = NULL;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400151
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400152#ifdef CONFIG_AF_ALG
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700153 cipher = qcrypto_afalg_cipher_ctx_new(alg, mode, key, nkey, NULL);
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400154#endif
155
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700156 if (!cipher) {
157 cipher = qcrypto_cipher_ctx_new(alg, mode, key, nkey, errp);
158 if (!cipher) {
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400159 return NULL;
160 }
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400161 }
162
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400163 cipher->alg = alg;
164 cipher->mode = mode;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400165
166 return cipher;
167}
168
169
170int qcrypto_cipher_encrypt(QCryptoCipher *cipher,
171 const void *in,
172 void *out,
173 size_t len,
174 Error **errp)
175{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700176 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400177 return drv->cipher_encrypt(cipher, in, out, len, errp);
178}
179
180
181int qcrypto_cipher_decrypt(QCryptoCipher *cipher,
182 const void *in,
183 void *out,
184 size_t len,
185 Error **errp)
186{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700187 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400188 return drv->cipher_decrypt(cipher, in, out, len, errp);
189}
190
191
192int qcrypto_cipher_setiv(QCryptoCipher *cipher,
193 const uint8_t *iv, size_t niv,
194 Error **errp)
195{
Richard Henderson7b5dbfb2020-08-28 10:05:13 -0700196 const QCryptoCipherDriver *drv = cipher->driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400197 return drv->cipher_setiv(cipher, iv, niv, errp);
198}
199
200
201void qcrypto_cipher_free(QCryptoCipher *cipher)
202{
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400203 if (cipher) {
Richard Henderson3eedf5c2020-08-28 10:05:14 -0700204 cipher->driver->cipher_free(cipher);
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400205 }
206}