Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 1 | /* |
| 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 Huth | b7cbb87 | 2019-02-13 16:54:59 +0100 | [diff] [blame] | 9 | * version 2.1 of the License, or (at your option) any later version. |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 10 | * |
| 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 Maydell | 42f7a44 | 2016-01-26 18:16:55 +0000 | [diff] [blame] | 21 | #include "qemu/osdep.h" |
Richard Henderson | eba2977 | 2020-08-28 10:05:08 -0700 | [diff] [blame] | 22 | #include "qemu/host-utils.h" |
Markus Armbruster | da34e65 | 2016-03-14 09:01:28 +0100 | [diff] [blame] | 23 | #include "qapi/error.h" |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 24 | #include "crypto/cipher.h" |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 25 | #include "cipherpriv.h" |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 26 | |
Daniel P. Berrange | 62893b6 | 2015-07-01 18:10:33 +0100 | [diff] [blame] | 27 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 28 | static 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 Huang | 52ed9f4 | 2023-12-07 23:47:35 +0800 | [diff] [blame] | 41 | #ifdef CONFIG_CRYPTO_SM4 |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 42 | [QCRYPTO_CIPHER_ALGO_SM4] = 16, |
Hyman Huang | 52ed9f4 | 2023-12-07 23:47:35 +0800 | [diff] [blame] | 43 | #endif |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 44 | }; |
| 45 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 46 | static 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 Huang | 52ed9f4 | 2023-12-07 23:47:35 +0800 | [diff] [blame] | 59 | #ifdef CONFIG_CRYPTO_SM4 |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 60 | [QCRYPTO_CIPHER_ALGO_SM4] = 16, |
Hyman Huang | 52ed9f4 | 2023-12-07 23:47:35 +0800 | [diff] [blame] | 61 | #endif |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 62 | }; |
| 63 | |
Richard Henderson | e46064a | 2020-08-28 10:05:16 -0700 | [diff] [blame] | 64 | static const bool mode_need_iv[QCRYPTO_CIPHER_MODE__MAX] = { |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 65 | [QCRYPTO_CIPHER_MODE_ECB] = false, |
| 66 | [QCRYPTO_CIPHER_MODE_CBC] = true, |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 67 | [QCRYPTO_CIPHER_MODE_XTS] = true, |
Gonglei | 3c28292 | 2016-09-26 17:23:22 +0800 | [diff] [blame] | 68 | [QCRYPTO_CIPHER_MODE_CTR] = true, |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 69 | }; |
| 70 | |
| 71 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 72 | size_t qcrypto_cipher_get_block_len(QCryptoCipherAlgo alg) |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 73 | { |
Prasad J Pandit | 32c813e | 2017-02-20 16:53:07 +0530 | [diff] [blame] | 74 | assert(alg < G_N_ELEMENTS(alg_key_len)); |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 75 | return alg_block_len[alg]; |
| 76 | } |
| 77 | |
| 78 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 79 | size_t qcrypto_cipher_get_key_len(QCryptoCipherAlgo alg) |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 80 | { |
Prasad J Pandit | 32c813e | 2017-02-20 16:53:07 +0530 | [diff] [blame] | 81 | assert(alg < G_N_ELEMENTS(alg_key_len)); |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 82 | return alg_key_len[alg]; |
| 83 | } |
| 84 | |
| 85 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 86 | size_t qcrypto_cipher_get_iv_len(QCryptoCipherAlgo alg, |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 87 | 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. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 103 | static bool |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 104 | qcrypto_cipher_validate_key_length(QCryptoCipherAlgo alg, |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 105 | QCryptoCipherMode mode, |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 106 | size_t nkey, |
| 107 | Error **errp) |
| 108 | { |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 109 | if ((unsigned)alg >= QCRYPTO_CIPHER_ALGO__MAX) { |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 110 | error_setg(errp, "Cipher algorithm %d out of range", |
| 111 | alg); |
| 112 | return false; |
| 113 | } |
| 114 | |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 115 | if (mode == QCRYPTO_CIPHER_MODE_XTS) { |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 116 | if (alg == QCRYPTO_CIPHER_ALGO_DES || |
| 117 | alg == QCRYPTO_CIPHER_ALGO_3DES) { |
Daniel P. Berrangé | 83bee4b | 2021-06-29 14:25:32 +0100 | [diff] [blame] | 118 | error_setg(errp, "XTS mode not compatible with DES/3DES"); |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 119 | 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. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 137 | } |
| 138 | return true; |
| 139 | } |
| 140 | |
Daniel P. Berrange | 91bfcdb | 2015-10-16 16:36:53 +0100 | [diff] [blame] | 141 | #ifdef CONFIG_GCRYPT |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 142 | #include "cipher-gcrypt.c.inc" |
Daniel P. Berrange | 91bfcdb | 2015-10-16 16:36:53 +0100 | [diff] [blame] | 143 | #elif defined CONFIG_NETTLE |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 144 | #include "cipher-nettle.c.inc" |
Daniel P. Berrangé | 3d2b61f | 2021-06-29 13:25:55 +0100 | [diff] [blame] | 145 | #elif defined CONFIG_GNUTLS_CRYPTO |
| 146 | #include "cipher-gnutls.c.inc" |
Daniel P. Berrange | 62893b6 | 2015-07-01 18:10:33 +0100 | [diff] [blame] | 147 | #else |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 148 | #include "cipher-builtin.c.inc" |
Daniel P. Berrange | 62893b6 | 2015-07-01 18:10:33 +0100 | [diff] [blame] | 149 | #endif |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 150 | |
Markus Armbruster | a092c51 | 2024-09-04 13:18:29 +0200 | [diff] [blame] | 151 | QCryptoCipher *qcrypto_cipher_new(QCryptoCipherAlgo alg, |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 152 | QCryptoCipherMode mode, |
| 153 | const uint8_t *key, size_t nkey, |
| 154 | Error **errp) |
| 155 | { |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 156 | QCryptoCipher *cipher = NULL; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 157 | |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 158 | #ifdef CONFIG_AF_ALG |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 159 | cipher = qcrypto_afalg_cipher_ctx_new(alg, mode, key, nkey, NULL); |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 160 | #endif |
| 161 | |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 162 | if (!cipher) { |
| 163 | cipher = qcrypto_cipher_ctx_new(alg, mode, key, nkey, errp); |
| 164 | if (!cipher) { |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 165 | return NULL; |
| 166 | } |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 167 | } |
| 168 | |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 169 | cipher->alg = alg; |
| 170 | cipher->mode = mode; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 171 | |
| 172 | return cipher; |
| 173 | } |
| 174 | |
| 175 | |
| 176 | int qcrypto_cipher_encrypt(QCryptoCipher *cipher, |
| 177 | const void *in, |
| 178 | void *out, |
| 179 | size_t len, |
| 180 | Error **errp) |
| 181 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 182 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 183 | return drv->cipher_encrypt(cipher, in, out, len, errp); |
| 184 | } |
| 185 | |
| 186 | |
| 187 | int qcrypto_cipher_decrypt(QCryptoCipher *cipher, |
| 188 | const void *in, |
| 189 | void *out, |
| 190 | size_t len, |
| 191 | Error **errp) |
| 192 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 193 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 194 | return drv->cipher_decrypt(cipher, in, out, len, errp); |
| 195 | } |
| 196 | |
| 197 | |
| 198 | int qcrypto_cipher_setiv(QCryptoCipher *cipher, |
| 199 | const uint8_t *iv, size_t niv, |
| 200 | Error **errp) |
| 201 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 202 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 203 | return drv->cipher_setiv(cipher, iv, niv, errp); |
| 204 | } |
| 205 | |
| 206 | |
| 207 | void qcrypto_cipher_free(QCryptoCipher *cipher) |
| 208 | { |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 209 | if (cipher) { |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 210 | cipher->driver->cipher_free(cipher); |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 211 | } |
| 212 | } |