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 | |
Richard Henderson | e46064a | 2020-08-28 10:05:16 -0700 | [diff] [blame] | 28 | static const size_t alg_key_len[QCRYPTO_CIPHER_ALG__MAX] = { |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 29 | [QCRYPTO_CIPHER_ALG_AES_128] = 16, |
| 30 | [QCRYPTO_CIPHER_ALG_AES_192] = 24, |
| 31 | [QCRYPTO_CIPHER_ALG_AES_256] = 32, |
Daniel P. Berrangé | 83bee4b | 2021-06-29 14:25:32 +0100 | [diff] [blame] | 32 | [QCRYPTO_CIPHER_ALG_DES] = 8, |
Longpeng(Mike) | ffb7bf4 | 2016-12-08 10:33:28 +0800 | [diff] [blame] | 33 | [QCRYPTO_CIPHER_ALG_3DES] = 24, |
Daniel P. Berrange | 084a85e | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 34 | [QCRYPTO_CIPHER_ALG_CAST5_128] = 16, |
Daniel P. Berrange | 9431852 | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 35 | [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16, |
| 36 | [QCRYPTO_CIPHER_ALG_SERPENT_192] = 24, |
| 37 | [QCRYPTO_CIPHER_ALG_SERPENT_256] = 32, |
Daniel P. Berrange | 50f6753 | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 38 | [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16, |
| 39 | [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 24, |
| 40 | [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 32, |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 41 | }; |
| 42 | |
Richard Henderson | e46064a | 2020-08-28 10:05:16 -0700 | [diff] [blame] | 43 | static const size_t alg_block_len[QCRYPTO_CIPHER_ALG__MAX] = { |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 44 | [QCRYPTO_CIPHER_ALG_AES_128] = 16, |
| 45 | [QCRYPTO_CIPHER_ALG_AES_192] = 16, |
| 46 | [QCRYPTO_CIPHER_ALG_AES_256] = 16, |
Daniel P. Berrangé | 83bee4b | 2021-06-29 14:25:32 +0100 | [diff] [blame] | 47 | [QCRYPTO_CIPHER_ALG_DES] = 8, |
Longpeng(Mike) | ffb7bf4 | 2016-12-08 10:33:28 +0800 | [diff] [blame] | 48 | [QCRYPTO_CIPHER_ALG_3DES] = 8, |
Daniel P. Berrange | 084a85e | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 49 | [QCRYPTO_CIPHER_ALG_CAST5_128] = 8, |
Daniel P. Berrange | 9431852 | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 50 | [QCRYPTO_CIPHER_ALG_SERPENT_128] = 16, |
| 51 | [QCRYPTO_CIPHER_ALG_SERPENT_192] = 16, |
| 52 | [QCRYPTO_CIPHER_ALG_SERPENT_256] = 16, |
Daniel P. Berrange | 50f6753 | 2016-02-10 17:07:42 +0000 | [diff] [blame] | 53 | [QCRYPTO_CIPHER_ALG_TWOFISH_128] = 16, |
| 54 | [QCRYPTO_CIPHER_ALG_TWOFISH_192] = 16, |
| 55 | [QCRYPTO_CIPHER_ALG_TWOFISH_256] = 16, |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 56 | }; |
| 57 | |
Richard Henderson | e46064a | 2020-08-28 10:05:16 -0700 | [diff] [blame] | 58 | static const bool mode_need_iv[QCRYPTO_CIPHER_MODE__MAX] = { |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 59 | [QCRYPTO_CIPHER_MODE_ECB] = false, |
| 60 | [QCRYPTO_CIPHER_MODE_CBC] = true, |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 61 | [QCRYPTO_CIPHER_MODE_XTS] = true, |
Gonglei | 3c28292 | 2016-09-26 17:23:22 +0800 | [diff] [blame] | 62 | [QCRYPTO_CIPHER_MODE_CTR] = true, |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 63 | }; |
| 64 | |
| 65 | |
| 66 | size_t qcrypto_cipher_get_block_len(QCryptoCipherAlgorithm alg) |
| 67 | { |
Prasad J Pandit | 32c813e | 2017-02-20 16:53:07 +0530 | [diff] [blame] | 68 | assert(alg < G_N_ELEMENTS(alg_key_len)); |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 69 | return alg_block_len[alg]; |
| 70 | } |
| 71 | |
| 72 | |
| 73 | size_t qcrypto_cipher_get_key_len(QCryptoCipherAlgorithm alg) |
| 74 | { |
Prasad J Pandit | 32c813e | 2017-02-20 16:53:07 +0530 | [diff] [blame] | 75 | assert(alg < G_N_ELEMENTS(alg_key_len)); |
Daniel P. Berrange | dd2bf9e | 2015-10-23 16:13:50 +0100 | [diff] [blame] | 76 | return alg_key_len[alg]; |
| 77 | } |
| 78 | |
| 79 | |
| 80 | size_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. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 97 | static bool |
| 98 | qcrypto_cipher_validate_key_length(QCryptoCipherAlgorithm alg, |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 99 | QCryptoCipherMode mode, |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 100 | size_t nkey, |
| 101 | Error **errp) |
| 102 | { |
Daniel P. Berrange | d8c02bc | 2015-11-19 17:09:01 +0000 | [diff] [blame] | 103 | if ((unsigned)alg >= QCRYPTO_CIPHER_ALG__MAX) { |
Daniel P. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 104 | error_setg(errp, "Cipher algorithm %d out of range", |
| 105 | alg); |
| 106 | return false; |
| 107 | } |
| 108 | |
Daniel P. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 109 | if (mode == QCRYPTO_CIPHER_MODE_XTS) { |
Daniel P. Berrangé | 83bee4b | 2021-06-29 14:25:32 +0100 | [diff] [blame] | 110 | 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. Berrange | eaec903 | 2016-02-11 14:05:21 +0000 | [diff] [blame] | 113 | 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. Berrange | ca38a4c | 2015-07-01 18:10:32 +0100 | [diff] [blame] | 131 | } |
| 132 | return true; |
| 133 | } |
| 134 | |
Daniel P. Berrange | 91bfcdb | 2015-10-16 16:36:53 +0100 | [diff] [blame] | 135 | #ifdef CONFIG_GCRYPT |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 136 | #include "cipher-gcrypt.c.inc" |
Daniel P. Berrange | 91bfcdb | 2015-10-16 16:36:53 +0100 | [diff] [blame] | 137 | #elif defined CONFIG_NETTLE |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 138 | #include "cipher-nettle.c.inc" |
Daniel P. Berrangé | 3d2b61f | 2021-06-29 13:25:55 +0100 | [diff] [blame] | 139 | #elif defined CONFIG_GNUTLS_CRYPTO |
| 140 | #include "cipher-gnutls.c.inc" |
Daniel P. Berrange | 62893b6 | 2015-07-01 18:10:33 +0100 | [diff] [blame] | 141 | #else |
Richard Henderson | 6d92bdf | 2020-08-28 10:05:09 -0700 | [diff] [blame] | 142 | #include "cipher-builtin.c.inc" |
Daniel P. Berrange | 62893b6 | 2015-07-01 18:10:33 +0100 | [diff] [blame] | 143 | #endif |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 144 | |
| 145 | QCryptoCipher *qcrypto_cipher_new(QCryptoCipherAlgorithm alg, |
| 146 | QCryptoCipherMode mode, |
| 147 | const uint8_t *key, size_t nkey, |
| 148 | Error **errp) |
| 149 | { |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 150 | QCryptoCipher *cipher = NULL; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 151 | |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 152 | #ifdef CONFIG_AF_ALG |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 153 | cipher = qcrypto_afalg_cipher_ctx_new(alg, mode, key, nkey, NULL); |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 154 | #endif |
| 155 | |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 156 | if (!cipher) { |
| 157 | cipher = qcrypto_cipher_ctx_new(alg, mode, key, nkey, errp); |
| 158 | if (!cipher) { |
Longpeng(Mike) | 25c60df | 2017-07-14 14:04:06 -0400 | [diff] [blame] | 159 | return NULL; |
| 160 | } |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 161 | } |
| 162 | |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 163 | cipher->alg = alg; |
| 164 | cipher->mode = mode; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 165 | |
| 166 | return cipher; |
| 167 | } |
| 168 | |
| 169 | |
| 170 | int qcrypto_cipher_encrypt(QCryptoCipher *cipher, |
| 171 | const void *in, |
| 172 | void *out, |
| 173 | size_t len, |
| 174 | Error **errp) |
| 175 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 176 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 177 | return drv->cipher_encrypt(cipher, in, out, len, errp); |
| 178 | } |
| 179 | |
| 180 | |
| 181 | int qcrypto_cipher_decrypt(QCryptoCipher *cipher, |
| 182 | const void *in, |
| 183 | void *out, |
| 184 | size_t len, |
| 185 | Error **errp) |
| 186 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 187 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 188 | return drv->cipher_decrypt(cipher, in, out, len, errp); |
| 189 | } |
| 190 | |
| 191 | |
| 192 | int qcrypto_cipher_setiv(QCryptoCipher *cipher, |
| 193 | const uint8_t *iv, size_t niv, |
| 194 | Error **errp) |
| 195 | { |
Richard Henderson | 7b5dbfb | 2020-08-28 10:05:13 -0700 | [diff] [blame] | 196 | const QCryptoCipherDriver *drv = cipher->driver; |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 197 | return drv->cipher_setiv(cipher, iv, niv, errp); |
| 198 | } |
| 199 | |
| 200 | |
| 201 | void qcrypto_cipher_free(QCryptoCipher *cipher) |
| 202 | { |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 203 | if (cipher) { |
Richard Henderson | 3eedf5c | 2020-08-28 10:05:14 -0700 | [diff] [blame] | 204 | cipher->driver->cipher_free(cipher); |
Longpeng(Mike) | 75c8007 | 2017-07-14 14:03:58 -0400 | [diff] [blame] | 205 | } |
| 206 | } |