0f7b008db94cd26e5f120102d462633b60483e1b
[tinc] / src / gcrypt / cipher.c
1 /*
2     cipher.c -- Symmetric block cipher handling
3     Copyright (C) 2007-2012 Guus Sliepen <guus@tinc-vpn.org>
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License along
16     with this program; if not, write to the Free Software Foundation, Inc.,
17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #include "system.h"
21
22 #include "cipher.h"
23 #include "logger.h"
24 #include "xalloc.h"
25
26 static struct {
27         const char *name;
28         int algo;
29         int mode;
30         int nid;
31 } ciphertable[] = {
32         {"none", GCRY_CIPHER_NONE, GCRY_CIPHER_MODE_NONE, 0},
33
34         {NULL, GCRY_CIPHER_BLOWFISH, GCRY_CIPHER_MODE_ECB, 92},
35         {"blowfish", GCRY_CIPHER_BLOWFISH, GCRY_CIPHER_MODE_CBC, 91},
36         {NULL, GCRY_CIPHER_BLOWFISH, GCRY_CIPHER_MODE_CFB, 93},
37         {NULL, GCRY_CIPHER_BLOWFISH, GCRY_CIPHER_MODE_OFB, 94},
38
39         {"aes-128-ecb", GCRY_CIPHER_AES, GCRY_CIPHER_MODE_ECB, 418},
40         {"aes-128-cbc", GCRY_CIPHER_AES, GCRY_CIPHER_MODE_CBC, 419},
41         {"aes-128-cfb", GCRY_CIPHER_AES, GCRY_CIPHER_MODE_CFB, 421},
42         {"aes-128-ofb", GCRY_CIPHER_AES, GCRY_CIPHER_MODE_OFB, 420},
43
44         {"aes-192-ecb", GCRY_CIPHER_AES192, GCRY_CIPHER_MODE_ECB, 422},
45         {"aes-192-cbc", GCRY_CIPHER_AES192, GCRY_CIPHER_MODE_CBC, 423},
46         {"aes-192-cfb", GCRY_CIPHER_AES192, GCRY_CIPHER_MODE_CFB, 425},
47         {"aes-192-ofb", GCRY_CIPHER_AES192, GCRY_CIPHER_MODE_OFB, 424},
48
49         {"aes-256-ecb", GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_ECB, 426},
50         {"aes-256-cbc", GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_CBC, 427},
51         {"aes-256-cfb", GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_CFB, 429},
52         {"aes-256-ofb", GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, 428},
53 };
54
55 static bool nametocipher(const char *name, int *algo, int *mode) {
56         size_t i;
57
58         for(i = 0; i < sizeof(ciphertable) / sizeof(*ciphertable); i++) {
59                 if(ciphertable[i].name && !strcasecmp(name, ciphertable[i].name)) {
60                         *algo = ciphertable[i].algo;
61                         *mode = ciphertable[i].mode;
62                         return true;
63                 }
64         }
65
66         return false;
67 }
68
69 static bool nidtocipher(int nid, int *algo, int *mode) {
70         size_t i;
71
72         for(i = 0; i < sizeof(ciphertable) / sizeof(*ciphertable); i++) {
73                 if(nid == ciphertable[i].nid) {
74                         *algo = ciphertable[i].algo;
75                         *mode = ciphertable[i].mode;
76                         return true;
77                 }
78         }
79
80         return false;
81 }
82
83 static bool ciphertonid(int algo, int mode, int *nid) {
84         size_t i;
85
86         for(i = 0; i < sizeof(ciphertable) / sizeof(*ciphertable); i++) {
87                 if(algo == ciphertable[i].algo && mode == ciphertable[i].mode) {
88                         *nid = ciphertable[i].nid;
89                         return true;
90                 }
91         }
92
93         return false;
94 }
95
96 static bool cipher_open(cipher_t *cipher, int algo, int mode) {
97         gcry_error_t err;
98
99         if(!ciphertonid(algo, mode, &cipher->nid)) {
100                 logger(DEBUG_ALWAYS, LOG_DEBUG, "Cipher %d mode %d has no corresponding nid!", algo, mode);
101                 return false;
102         }
103
104         if((err = gcry_cipher_open(&cipher->handle, algo, mode, 0))) {
105                 logger(DEBUG_ALWAYS, LOG_DEBUG, "Unable to initialise cipher %d mode %d: %s", algo, mode, gcry_strerror(err));
106                 return false;
107         }
108
109         cipher->keylen = gcry_cipher_get_algo_keylen(algo);
110         cipher->blklen = gcry_cipher_get_algo_blklen(algo);
111         cipher->key = xmalloc(cipher->keylen + cipher->blklen);
112         cipher->padding = mode == GCRY_CIPHER_MODE_ECB || mode == GCRY_CIPHER_MODE_CBC;
113
114         return true;
115 }
116
117 bool cipher_open_by_name(cipher_t *cipher, const char *name) {
118         int algo, mode;
119
120         if(!nametocipher(name, &algo, &mode)) {
121                 logger(DEBUG_ALWAYS, LOG_DEBUG, "Unknown cipher name '%s'!", name);
122                 return false;
123         }
124
125         return cipher_open(cipher, algo, mode);
126 }
127
128 bool cipher_open_by_nid(cipher_t *cipher, int nid) {
129         int algo, mode;
130
131         if(!nidtocipher(nid, &algo, &mode)) {
132                 logger(DEBUG_ALWAYS, LOG_DEBUG, "Unknown cipher ID %d!", nid);
133                 return false;
134         }
135
136         return cipher_open(cipher, algo, mode);
137 }
138
139 bool cipher_open_blowfish_ofb(cipher_t *cipher) {
140         return cipher_open(cipher, GCRY_CIPHER_BLOWFISH, GCRY_CIPHER_MODE_OFB);
141 }
142
143 void cipher_close(cipher_t *cipher) {
144         if(cipher->handle) {
145                 gcry_cipher_close(cipher->handle);
146                 cipher->handle = NULL;
147         }
148
149         free(cipher->key);
150
151         memset(cipher, 0, sizeof(*cipher));
152 }
153
154 size_t cipher_keylength(const cipher_t *cipher) {
155         if(!cipher) {
156                 return 0;
157         }
158
159         return cipher->keylen + cipher->blklen;
160 }
161
162 uint64_t cipher_budget(const cipher_t *cipher) {
163         if(!cipher) {
164                 return UINT64_MAX; // NULL cipher
165         }
166
167         size_t ivlen = cipher->blklen;
168         size_t blklen = cipher->blklen;
169
170         size_t len = blklen > 1
171                      ? blklen
172                      : ivlen > 1 ? ivlen : 8;
173         size_t bits = len * 4 - 1;
174
175         return bits < 64
176                ? UINT64_C(1) << bits
177                : UINT64_MAX;
178 }
179
180 size_t cipher_blocksize(const cipher_t *cipher) {
181         if(!cipher || !cipher->blklen) {
182                 return 1;
183         }
184
185         return cipher->blklen;
186 }
187
188 void cipher_get_key(const cipher_t *cipher, void *key) {
189         memcpy(key, cipher->key, cipher->keylen + cipher->blklen);
190 }
191
192 bool cipher_set_key(cipher_t *cipher, void *key, bool encrypt) {
193         memcpy(cipher->key, key, cipher->keylen + cipher->blklen);
194
195         gcry_cipher_setkey(cipher->handle, cipher->key, cipher->keylen);
196         gcry_cipher_setiv(cipher->handle, cipher->key + cipher->keylen, cipher->blklen);
197
198         return true;
199 }
200
201 bool cipher_set_key_from_rsa(cipher_t *cipher, void *key, size_t len, bool encrypt) {
202         memcpy(cipher->key,
203                key + len - cipher->keylen,
204                cipher->keylen);
205         gcry_cipher_setkey(cipher->handle, cipher->key, cipher->keylen);
206
207         memcpy(cipher->key + cipher->keylen,
208                key + len - cipher->blklen - cipher->keylen,
209                cipher->blklen);
210         gcry_cipher_setiv(cipher->handle, cipher->key + cipher->keylen, cipher->blklen);
211
212         return true;
213 }
214
215 bool cipher_regenerate_key(cipher_t *cipher, bool encrypt) {
216         gcry_create_nonce(cipher->key, cipher->keylen + cipher->blklen);
217
218         gcry_cipher_setkey(cipher->handle, cipher->key, cipher->keylen);
219         gcry_cipher_setiv(cipher->handle, cipher->key + cipher->keylen, cipher->blklen);
220
221         return true;
222 }
223
224 bool cipher_encrypt(cipher_t *cipher, const void *indata, size_t inlen, void *outdata, size_t *outlen, bool oneshot) {
225         gcry_error_t err;
226         uint8_t pad[cipher->blklen];
227
228         if(cipher->padding) {
229                 if(!oneshot) {
230                         return false;
231                 }
232
233                 size_t reqlen = ((inlen + cipher->blklen) / cipher->blklen) * cipher->blklen;
234
235                 if(*outlen < reqlen) {
236                         logger(DEBUG_ALWAYS, LOG_ERR, "Error while encrypting: not enough room for padding");
237                         return false;
238                 }
239
240                 uint8_t padbyte = reqlen - inlen;
241                 inlen = reqlen - cipher->blklen;
242
243                 for(int i = 0; i < cipher->blklen; i++)
244                         if(i < cipher->blklen - padbyte) {
245                                 pad[i] = ((uint8_t *)indata)[inlen + i];
246                         } else {
247                                 pad[i] = padbyte;
248                         }
249         }
250
251         if(oneshot) {
252                 gcry_cipher_setiv(cipher->handle, cipher->key + cipher->keylen, cipher->blklen);
253         }
254
255         if((err = gcry_cipher_encrypt(cipher->handle, outdata, *outlen, indata, inlen))) {
256                 logger(DEBUG_ALWAYS, LOG_ERR, "Error while encrypting: %s", gcry_strerror(err));
257                 return false;
258         }
259
260         if(cipher->padding) {
261                 if((err = gcry_cipher_encrypt(cipher->handle, outdata + inlen, cipher->blklen, pad, cipher->blklen))) {
262                         logger(DEBUG_ALWAYS, LOG_ERR, "Error while encrypting: %s", gcry_strerror(err));
263                         return false;
264                 }
265
266                 inlen += cipher->blklen;
267         }
268
269         *outlen = inlen;
270         return true;
271 }
272
273 bool cipher_decrypt(cipher_t *cipher, const void *indata, size_t inlen, void *outdata, size_t *outlen, bool oneshot) {
274         gcry_error_t err;
275
276         if(oneshot) {
277                 gcry_cipher_setiv(cipher->handle, cipher->key + cipher->keylen, cipher->blklen);
278         }
279
280         if((err = gcry_cipher_decrypt(cipher->handle, outdata, *outlen, indata, inlen))) {
281                 logger(DEBUG_ALWAYS, LOG_ERR, "Error while decrypting: %s", gcry_strerror(err));
282                 return false;
283         }
284
285         if(cipher->padding) {
286                 if(!oneshot) {
287                         return false;
288                 }
289
290                 uint8_t padbyte = ((uint8_t *)outdata)[inlen - 1];
291
292                 if(padbyte == 0 || padbyte > cipher->blklen || padbyte > inlen) {
293                         logger(DEBUG_ALWAYS, LOG_ERR, "Error while decrypting: invalid padding");
294                         return false;
295                 }
296
297                 size_t origlen = inlen - padbyte;
298
299                 for(size_t i = inlen - 1; i >= origlen; i--)
300                         if(((uint8_t *)outdata)[i] != padbyte) {
301                                 logger(DEBUG_ALWAYS, LOG_ERR, "Error while decrypting: invalid padding");
302                                 return false;
303                         }
304
305                 *outlen = origlen;
306         } else {
307                 *outlen = inlen;
308         }
309
310         return true;
311 }
312
313 int cipher_get_nid(const cipher_t *cipher) {
314         if(!cipher || !cipher->nid) {
315                 return 0;
316         }
317
318         return cipher->nid;
319 }
320
321 bool cipher_active(const cipher_t *cipher) {
322         return cipher->nid != 0;
323 }