blob: e5adb56271e0612a6b62eb87abcb108be04980fc [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"
Markus Armbrusterda34e652016-03-14 09:01:28 +010022#include "qapi/error.h"
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010023#include "crypto/cipher.h"
Longpeng(Mike)75c80072017-07-14 14:03:58 -040024#include "cipherpriv.h"
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010025
Daniel P. Berrange62893b62015-07-01 18:10:33 +010026
Daniel P. Berranged8c02bc2015-11-19 17:09:01 +000027static size_t alg_key_len[QCRYPTO_CIPHER_ALG__MAX] = {
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010028 [QCRYPTO_CIPHER_ALG_AES_128] = 16,
29 [QCRYPTO_CIPHER_ALG_AES_192] = 24,
30 [QCRYPTO_CIPHER_ALG_AES_256] = 32,
31 [QCRYPTO_CIPHER_ALG_DES_RFB] = 8,
Longpeng(Mike)ffb7bf42016-12-08 10:33:28 +080032 [QCRYPTO_CIPHER_ALG_3DES] = 24,
Daniel P. Berrange084a85e2016-02-10 17:07:42 +000033 [QCRYPTO_CIPHER_ALG_CAST5_128] = 16,
Daniel P. Berrange94318522016-02-10 17:07:42 +000034 [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16,
35 [QCRYPTO_CIPHER_ALG_SERPENT_192] = 24,
36 [QCRYPTO_CIPHER_ALG_SERPENT_256] = 32,
Daniel P. Berrange50f67532016-02-10 17:07:42 +000037 [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16,
38 [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 24,
39 [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 32,
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010040};
41
Daniel P. Berranged8c02bc2015-11-19 17:09:01 +000042static size_t alg_block_len[QCRYPTO_CIPHER_ALG__MAX] = {
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010043 [QCRYPTO_CIPHER_ALG_AES_128] = 16,
44 [QCRYPTO_CIPHER_ALG_AES_192] = 16,
45 [QCRYPTO_CIPHER_ALG_AES_256] = 16,
46 [QCRYPTO_CIPHER_ALG_DES_RFB] = 8,
Longpeng(Mike)ffb7bf42016-12-08 10:33:28 +080047 [QCRYPTO_CIPHER_ALG_3DES] = 8,
Daniel P. Berrange084a85e2016-02-10 17:07:42 +000048 [QCRYPTO_CIPHER_ALG_CAST5_128] = 8,
Daniel P. Berrange94318522016-02-10 17:07:42 +000049 [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16,
50 [QCRYPTO_CIPHER_ALG_SERPENT_192] = 16,
51 [QCRYPTO_CIPHER_ALG_SERPENT_256] = 16,
Daniel P. Berrange50f67532016-02-10 17:07:42 +000052 [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16,
53 [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 16,
54 [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 16,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010055};
56
Daniel P. Berranged8c02bc2015-11-19 17:09:01 +000057static bool mode_need_iv[QCRYPTO_CIPHER_MODE__MAX] = {
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010058 [QCRYPTO_CIPHER_MODE_ECB] = false,
59 [QCRYPTO_CIPHER_MODE_CBC] = true,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +000060 [QCRYPTO_CIPHER_MODE_XTS] = true,
Gonglei3c282922016-09-26 17:23:22 +080061 [QCRYPTO_CIPHER_MODE_CTR] = true,
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010062};
63
64
65size_t qcrypto_cipher_get_block_len(QCryptoCipherAlgorithm alg)
66{
Prasad J Pandit32c813e2017-02-20 16:53:07 +053067 assert(alg < G_N_ELEMENTS(alg_key_len));
Daniel P. Berrangedd2bf9e2015-10-23 16:13:50 +010068 return alg_block_len[alg];
69}
70
71
72size_t qcrypto_cipher_get_key_len(QCryptoCipherAlgorithm alg)
73{
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_key_len[alg];
76}
77
78
79size_t qcrypto_cipher_get_iv_len(QCryptoCipherAlgorithm alg,
80 QCryptoCipherMode mode)
81{
82 if (alg >= G_N_ELEMENTS(alg_block_len)) {
83 return 0;
84 }
85 if (mode >= G_N_ELEMENTS(mode_need_iv)) {
86 return 0;
87 }
88
89 if (mode_need_iv[mode]) {
90 return alg_block_len[alg];
91 }
92 return 0;
93}
94
95
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010096static bool
97qcrypto_cipher_validate_key_length(QCryptoCipherAlgorithm alg,
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +000098 QCryptoCipherMode mode,
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +010099 size_t nkey,
100 Error **errp)
101{
Daniel P. Berranged8c02bc2015-11-19 17:09:01 +0000102 if ((unsigned)alg >= QCRYPTO_CIPHER_ALG__MAX) {
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100103 error_setg(errp, "Cipher algorithm %d out of range",
104 alg);
105 return false;
106 }
107
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000108 if (mode == QCRYPTO_CIPHER_MODE_XTS) {
Longpeng(Mike)ffb7bf42016-12-08 10:33:28 +0800109 if (alg == QCRYPTO_CIPHER_ALG_DES_RFB
110 || alg == QCRYPTO_CIPHER_ALG_3DES) {
111 error_setg(errp, "XTS mode not compatible with DES-RFB/3DES");
Daniel P. Berrangeeaec9032016-02-11 14:05:21 +0000112 return false;
113 }
114 if (nkey % 2) {
115 error_setg(errp, "XTS cipher key length should be a multiple of 2");
116 return false;
117 }
118
119 if (alg_key_len[alg] != (nkey / 2)) {
120 error_setg(errp, "Cipher key length %zu should be %zu",
121 nkey, alg_key_len[alg] * 2);
122 return false;
123 }
124 } else {
125 if (alg_key_len[alg] != nkey) {
126 error_setg(errp, "Cipher key length %zu should be %zu",
127 nkey, alg_key_len[alg]);
128 return false;
129 }
Daniel P. Berrangeca38a4c2015-07-01 18:10:32 +0100130 }
131 return true;
132}
133
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100134#if defined(CONFIG_GCRYPT) || defined(CONFIG_NETTLE)
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100135static uint8_t *
136qcrypto_cipher_munge_des_rfb_key(const uint8_t *key,
137 size_t nkey)
138{
139 uint8_t *ret = g_new0(uint8_t, nkey);
140 size_t i;
141 for (i = 0; i < nkey; i++) {
142 uint8_t r = key[i];
143 r = (r & 0xf0) >> 4 | (r & 0x0f) << 4;
144 r = (r & 0xcc) >> 2 | (r & 0x33) << 2;
145 r = (r & 0xaa) >> 1 | (r & 0x55) << 1;
146 ret[i] = r;
147 }
148 return ret;
149}
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100150#endif /* CONFIG_GCRYPT || CONFIG_NETTLE */
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100151
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100152#ifdef CONFIG_GCRYPT
Michael S. Tsirkin986bc8d2018-05-03 22:50:23 +0300153#include "cipher-gcrypt.c"
Daniel P. Berrange91bfcdb2015-10-16 16:36:53 +0100154#elif defined CONFIG_NETTLE
Michael S. Tsirkin986bc8d2018-05-03 22:50:23 +0300155#include "cipher-nettle.c"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100156#else
Michael S. Tsirkin986bc8d2018-05-03 22:50:23 +0300157#include "cipher-builtin.c"
Daniel P. Berrange62893b62015-07-01 18:10:33 +0100158#endif
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400159
160QCryptoCipher *qcrypto_cipher_new(QCryptoCipherAlgorithm alg,
161 QCryptoCipherMode mode,
162 const uint8_t *key, size_t nkey,
163 Error **errp)
164{
165 QCryptoCipher *cipher;
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400166 void *ctx = NULL;
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400167 QCryptoCipherDriver *drv = NULL;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400168
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400169#ifdef CONFIG_AF_ALG
Longpengf1710632017-11-07 19:32:06 +0800170 ctx = qcrypto_afalg_cipher_ctx_new(alg, mode, key, nkey, NULL);
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400171 if (ctx) {
172 drv = &qcrypto_cipher_afalg_driver;
173 }
174#endif
175
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400176 if (!ctx) {
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400177 ctx = qcrypto_cipher_ctx_new(alg, mode, key, nkey, errp);
178 if (!ctx) {
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400179 return NULL;
180 }
181
182 drv = &qcrypto_cipher_lib_driver;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400183 }
184
185 cipher = g_new0(QCryptoCipher, 1);
186 cipher->alg = alg;
187 cipher->mode = mode;
188 cipher->opaque = ctx;
Longpeng(Mike)25c60df2017-07-14 14:04:06 -0400189 cipher->driver = (void *)drv;
Longpeng(Mike)75c80072017-07-14 14:03:58 -0400190
191 return cipher;
192}
193
194
195int qcrypto_cipher_encrypt(QCryptoCipher *cipher,
196 const void *in,
197 void *out,
198 size_t len,
199 Error **errp)
200{
201 QCryptoCipherDriver *drv = cipher->driver;
202 return drv->cipher_encrypt(cipher, in, out, len, errp);
203}
204
205
206int qcrypto_cipher_decrypt(QCryptoCipher *cipher,
207 const void *in,
208 void *out,
209 size_t len,
210 Error **errp)
211{
212 QCryptoCipherDriver *drv = cipher->driver;
213 return drv->cipher_decrypt(cipher, in, out, len, errp);
214}
215
216
217int qcrypto_cipher_setiv(QCryptoCipher *cipher,
218 const uint8_t *iv, size_t niv,
219 Error **errp)
220{
221 QCryptoCipherDriver *drv = cipher->driver;
222 return drv->cipher_setiv(cipher, iv, niv, errp);
223}
224
225
226void qcrypto_cipher_free(QCryptoCipher *cipher)
227{
228 QCryptoCipherDriver *drv;
229 if (cipher) {
230 drv = cipher->driver;
231 drv->cipher_free(cipher);
232 g_free(cipher);
233 }
234}